ForIA::IHistogrammer Class Reference

Abstract interface to book and fill histograms. Analyses talk to this interface *NOT* RootHistogrammer. More...

#include <IHistogrammer.hh>

Inheritance diagram for ForIA::IHistogrammer:

List of all members.

Public Member Functions
virtual	~IHistogrammer ()
virtual const string &	outputName () const =0
	The name of the output file etc. associated with this histogrammer.
void	bookHistogram1D (const string &name, const string &title, int nBins, double xMin, double xMax)
	Book a histogram to be stored at location "/" in the histogram tree.
void	bookHistogram1D (const string &name, const string &title, int nBins, double xMin, double xMax, bool divideBinWidths)
	Book a histogram to be stored at location "/" in the histogram tree.
void	bookHistogram1D (const string &path, const string &name, const string &title, int nBins, double xMin, double xMax)
	Book a histogram to be stored at location in the histogram tree.
virtual void	bookHistogram1D (const string &path, const string &name, const string &title, int nBins, double xMin, double xMax, bool divideBinWidths)=0
	Book a histogram to be stored at location in the histogram tree.
void	bookHistogram1D (const string &name, const string &title, const vector< double > &bins)
	Book a variable bin histogram to be stored at location "/" in the histogram tree.
void	bookHistogram1D (const string &name, const string &title, const vector< double > &bins, bool divideBinWidths)
	Book a variable bin histogram to be stored at location "/" in the histogram tree.
void	bookHistogram1D (const string &path, const string &name, const string &title, const vector< double > &bins)
	Book a variable bin histogram to be stored at location in the histogram tree.
virtual void	bookHistogram1D (const string &path, const string &name, const string &title, const vector< double > &bins, bool divideBinWidths)=0
	Book a variable bin histogram to be stored at location in the histogram tree.
void	bookProfile1D (const string &name, const string &title, int nBins, double xMin, double xMax)
	Book a profile to be stored at location "/" in the histogram tree.
virtual void	bookProfile1D (const string &path, const string &name, const string &title, int nBins, double xMin, double xMax)=0
	Book a profile to be stored at location in the histogram tree.
void	bookHistogram2D (const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax)
	Book a 2D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram2D (const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, bool divideBinWidths)
	Book a 2D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram2D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax)
	Book a 2D histogram to be stored at location in the histogram tree.
virtual void	bookHistogram2D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, bool divideBinWidths)=0
	Book a 2D histogram to be stored at location in the histogram tree.
void	bookHistogram2D (const string &name, const string &title, const vector< double > &xbins, const vector< double > &ybins)
	Book a variable bin 2D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram2D (const string &name, const string &title, const vector< double > &xbins, const vector< double > &ybins, bool divideBinWidths)
	Book a variable bin 2D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram2D (const string &path, const string &name, const string &title, const vector< double > &xbins, const vector< double > &ybins)
	Book a variable bin 2D histogram to be stored at location in the histogram tree.
virtual void	bookHistogram2D (const string &path, const string &name, const string &title, const vector< double > &xbins, const vector< double > &ybins, bool divideBinWidths)=0
	Book a variable bin 2D histogram to be stored at location in the histogram tree.
void	bookHistogram3D (const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, int nBinsZ, double zMin, double zMax)
	Book a 3D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram3D (const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, int nBinsZ, double zMin, double zMax, bool divideBinWidths)
	Book a 3D histogram to be stored at location "/" in the histogram tree.
void	bookHistogram3D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, int nBinsZ, double zMin, double zMax)
	Book a 3D histogram to be stored at location in the histogram tree.
virtual void	bookHistogram3D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, int nBinsZ, double zMin, double zMax, bool divideBinWidths)=0
	Book a 3D histogram to be stored at location in the histogram tree.
virtual void	fillHistogram1D (const string &path, const string &name, double value, double weight)=0
	Book a profile at location "/" in the tree.
void	fillHistogram1D (const string &name, double value, double weight)
	Fill the histogram name at location "/".
virtual void	fillProfile1D (const string &path, const string &name, double xVal, double yVal, double weight)=0
	Fill the profile name at path.
void	fillProfile1D (const string &name, double xVal, double yVal, double weight)
	Fill the profile name at location "/".
virtual void	fillHistogram2D (const string &path, const string &name, double xVal, double yVal, double weight)=0
	Fill 2D histogram name at path.
void	fillHistogram2D (const string &name, double xVal, double yVal, double weight)
	Fill the 2D histogram name at location "/".
at @path
Fill the histogram
virtual void	fillHistogram3D (const string &path, const string &name, double xVal, double yVal, double zVal, double weight)=0
at "/"
Fill the histogram
void	fillHistogram3D (const string &name, double xVal, double yVal, double zVal, double weight)
virtual void	finalise ()=0
	Finish the histograms (write them to file etc.)
virtual void	normaliseHistogram1D (const string &path, const string &name, double norm=1.)=0
	Normalise a 1D histogram name at path to a given area (default 1)
void	normaliseHistogram1D (const string &name, double norm=1.)
	Normalise a 1D histogram name at location "/" to a given area (default 1)
virtual void	scaleHistogram1D (const string &path, const string &name, double scale=1.)=0
	Scale a 1D histogram name at path by a given amount.
void	scaleHistogram1D (const string &name, double scale=1.)
	Scale a 1D histogram name at location "/" by a given amount.
virtual void	normaliseHistogram2D (const string &path, const string &name, double norm=1.)=0
	Normalise a 2D histogram name at path to a given area (default 1)
void	normaliseHistogram2D (const string &name, double norm=1.)
	Normalise a 2D histogram name at location "/" to a given ares (default 1)
virtual void	scaleHistogram2D (const string &path, const string &name, double scale=1.)=0
	Scale a 2D histogram name at path by a given amount.
void	scaleHistogram2D (const string &name, double scale=1.)
	Scale a 2D histogram name at location "/" by a given amount.
virtual void	showHistograms (std::ostream &out) const =0
	Print to the screen a list of all of the histograms that exist.

---

Detailed Description

Abstract interface to book and fill histograms. Analyses talk to this interface *NOT* RootHistogrammer.

Definition at line 27 of file IHistogrammer.hh.

---

Constructor & Destructor Documentation

virtual ForIA::IHistogrammer::~IHistogrammer

(

)

[inline, virtual]

Definition at line 31 of file IHistogrammer.hh.

---

Member Function Documentation

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax
	)

Book a histogram to be stored at location "/" in the histogram tree.

Definition at line 5 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax
	)

Book a histogram to be stored at location in the histogram tree.

Definition at line 18 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	path,
		const string &	name,
		const string &	title,
		const vector< double > &	bins
	)

Book a variable bin histogram to be stored at location in the histogram tree.

Definition at line 37 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::bookHistogram1D	(	const string &	path,
		const string &	name,
		const string &	title,
		const vector< double > &	bins,
		bool	divideBinWidths
	)		[pure virtual]

Book a variable bin histogram to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

virtual void ForIA::IHistogrammer::bookHistogram1D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax,
		bool	divideBinWidths
	)		[pure virtual]

Book a histogram to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax,
		bool	divideBinWidths
	)

Book a histogram to be stored at location "/" in the histogram tree.

Definition at line 11 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	name,
		const string &	title,
		const vector< double > &	bins
	)

Book a variable bin histogram to be stored at location "/" in the histogram tree.

Definition at line 25 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram1D	(	const string &	name,
		const string &	title,
		const vector< double > &	bins,
		bool	divideBinWidths
	)

Book a variable bin histogram to be stored at location "/" in the histogram tree.

Definition at line 31 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	name,
		const string &	title,
		const vector< double > &	xbins,
		const vector< double > &	ybins
	)

Book a variable bin 2D histogram to be stored at location "/" in the histogram tree.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	name,
		const string &	title,
		const vector< double > &	xbins,
		const vector< double > &	ybins,
		bool	divideBinWidths
	)

Book a variable bin 2D histogram to be stored at location "/" in the histogram tree.

Definition at line 94 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	path,
		const string &	name,
		const string &	title,
		const vector< double > &	xbins,
		const vector< double > &	ybins
	)

Book a variable bin 2D histogram to be stored at location in the histogram tree.

virtual void ForIA::IHistogrammer::bookHistogram2D	(	const string &	path,
		const string &	name,
		const string &	title,
		const vector< double > &	xbins,
		const vector< double > &	ybins,
		bool	divideBinWidths
	)		[pure virtual]

Book a variable bin 2D histogram to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax
	)

Book a 2D histogram to be stored at location "/" in the histogram tree.

Definition at line 61 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		bool	divideBinWidths
	)

Book a 2D histogram to be stored at location "/" in the histogram tree.

Definition at line 71 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram2D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax
	)

Book a 2D histogram to be stored at location in the histogram tree.

Definition at line 82 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::bookHistogram2D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		bool	divideBinWidths
	)		[pure virtual]

Book a 2D histogram to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::bookHistogram3D	(	const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		int	nBinsZ,
		double	zMin,
		double	zMax
	)

Book a 3D histogram to be stored at location "/" in the histogram tree.

Definition at line 127 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram3D	(	const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		int	nBinsZ,
		double	zMin,
		double	zMax,
		bool	divideBinWidths
	)

Book a 3D histogram to be stored at location "/" in the histogram tree.

Definition at line 139 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::bookHistogram3D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		int	nBinsZ,
		double	zMin,
		double	zMax
	)

Book a 3D histogram to be stored at location in the histogram tree.

Definition at line 152 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::bookHistogram3D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBinsX,
		double	xMin,
		double	xMax,
		int	nBinsY,
		double	yMin,
		double	yMax,
		int	nBinsZ,
		double	zMin,
		double	zMax,
		bool	divideBinWidths
	)		[pure virtual]

Book a 3D histogram to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::bookProfile1D	(	const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax
	)

Book a profile to be stored at location "/" in the histogram tree.

Definition at line 44 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::bookProfile1D	(	const string &	path,
		const string &	name,
		const string &	title,
		int	nBins,
		double	xMin,
		double	xMax
	)		[pure virtual]

Book a profile to be stored at location in the histogram tree.

Implemented in ForIA::RootHistogrammer.

virtual void ForIA::IHistogrammer::fillHistogram1D	(	const string &	path,
		const string &	name,
		double	value,
		double	weight
	)		[pure virtual]

Book a profile at location "/" in the tree.

Book a profile at location path in the tree Fill histogram name at path

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::fillHistogram1D	(	const string &	name,
		double	value,
		double	weight
	)

Fill the histogram name at location "/".

Definition at line 51 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::fillHistogram2D	(	const string &	path,
		const string &	name,
		double	xVal,
		double	yVal,
		double	weight
	)		[pure virtual]

Fill 2D histogram name at path.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::fillHistogram2D	(	const string &	name,
		double	xVal,
		double	yVal,
		double	weight
	)

Fill the 2D histogram name at location "/".

Definition at line 101 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::fillHistogram3D	(	const string &	name,
		double	xVal,
		double	yVal,
		double	zVal,
		double	weight
	)

Definition at line 167 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::fillHistogram3D	(	const string &	path,
		const string &	name,
		double	xVal,
		double	yVal,
		double	zVal,
		double	weight
	)		[pure virtual]

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::fillProfile1D	(	const string &	name,
		double	xVal,
		double	yVal,
		double	weight
	)

Fill the profile name at location "/".

Definition at line 56 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::fillProfile1D	(	const string &	path,
		const string &	name,
		double	xVal,
		double	yVal,
		double	weight
	)		[pure virtual]

Fill the profile name at path.

Implemented in ForIA::RootHistogrammer.

virtual void ForIA::IHistogrammer::finalise

(

)

[pure virtual]

Finish the histograms (write them to file etc.)

Implemented in ForIA::RootHistogrammer.

virtual void ForIA::IHistogrammer::normaliseHistogram1D	(	const string &	path,
		const string &	name,
		double	norm = 1.
	)		[pure virtual]

Normalise a 1D histogram name at path to a given area (default 1)

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::normaliseHistogram1D	(	const string &	name,
		double	norm = 1.
	)

Normalise a 1D histogram name at location "/" to a given area (default 1)

Definition at line 106 of file IHistogrammer.cxx.

void ForIA::IHistogrammer::normaliseHistogram2D	(	const string &	name,
		double	norm = 1.
	)

Normalise a 2D histogram name at location "/" to a given ares (default 1)

Definition at line 116 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::normaliseHistogram2D	(	const string &	path,
		const string &	name,
		double	norm = 1.
	)		[pure virtual]

Normalise a 2D histogram name at path to a given area (default 1)

Implemented in ForIA::RootHistogrammer.

virtual const string& ForIA::IHistogrammer::outputName

(

)

const [pure virtual]

The name of the output file etc. associated with this histogrammer.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::scaleHistogram1D	(	const string &	name,
		double	scale = 1.
	)

Scale a 1D histogram name at location "/" by a given amount.

Definition at line 111 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::scaleHistogram1D	(	const string &	path,
		const string &	name,
		double	scale = 1.
	)		[pure virtual]

Scale a 1D histogram name at path by a given amount.

Implemented in ForIA::RootHistogrammer.

virtual void ForIA::IHistogrammer::scaleHistogram2D	(	const string &	path,
		const string &	name,
		double	scale = 1.
	)		[pure virtual]

Scale a 2D histogram name at path by a given amount.

Implemented in ForIA::RootHistogrammer.

void ForIA::IHistogrammer::scaleHistogram2D	(	const string &	name,
		double	scale = 1.
	)

Scale a 2D histogram name at location "/" by a given amount.

Definition at line 121 of file IHistogrammer.cxx.

virtual void ForIA::IHistogrammer::showHistograms

(

std::ostream &

out )

const [pure virtual]

Print to the screen a list of all of the histograms that exist.

Implemented in ForIA::RootHistogrammer.

---

The documentation for this class was generated from the following files:

• /Users/jmonk/Physics/ForIA/ForIA/IHistogrammer.hh
• /Users/jmonk/Physics/ForIA/src/IHistogrammer.cxx