User level interface to a 2-dimensional profile histogram. More...

#include <IProfile2DROOT.h>

Inheritance diagram for AIDA::IProfile2DROOT:

Public Member Functions
virtual	~IProfile2DROOT ()
	Destructor.

	IProfile2DROOT ()
	constructor

	IProfile2DROOT (const std::string &name, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, const std::string &options="")

	IProfile2DROOT (const std::string &name, const std::string &title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, const std::string &options="")

	IProfile2DROOT (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, const std::string &options="")

	IProfile2DROOT (const std::string &name, const std::string &title, const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY, double lowerValue, double upperValue, const std::string &options="")

	IProfile2DROOT (const std::string &name, const IProfile2DROOT &profile)

virtual bool	fill (double x, double y, double z, double weight=1)
	Fill the IProfile2D.

virtual double	binMeanX (int indexX, int indexY) const
	The weighted mean along x of a given bin. More...

virtual double	binMeanY (int indexX, int indexY) const
	The weighted mean along y of a given bin. More...

virtual int	binEntries (int indexX, int indexY) const
	The number of entries (ie the number of times fill was called for this bin). More...

virtual int	binEntriesX (int indexX) const
	Equivalent to `projectionX().binEntries(indexX)`.

virtual int	binEntriesY (int indexY) const
	Equivalent to `projectionY().binEntries(indexY)`.

virtual double	binHeight (int indexX, int indexY) const
	Total height of the corresponding bin (ie the sum of the weights in this bin). More...

virtual double	binHeightX (int indexX) const
	Equivalent to `projectionX().binHeight(indexX)`.

virtual double	binHeightY (int indexY) const
	Equivalent to `projectionY().binHeight(indexY)`.

virtual double	binError (int indexX, int indexY) const
	The error on this bin. More...

virtual double	binRms (int indexX, int indexY) const
	The spread (RMS) of this bin. More...

virtual double	meanX () const
	Returns the mean of the profile, as calculated on filling-time projected on the X axis.

virtual double	meanY () const
	Returns the mean of the profile, as calculated on filling-time projected on the Y axis.

virtual double	rmsX () const
	Returns the rms of the profile as calculated on filling-time projected on the X axis.

virtual double	rmsY () const
	Returns the rms of the profile as calculated on filling-time projected on the Y axis.

virtual const IAxis &	xAxis () const
	Return the X axis.

virtual const IAxis &	yAxis () const
	Return the Y axis.

virtual int	coordToIndexX (double coordX) const
	Convenience method, equivalent to `xAxis().coordToIndex(coord)`. More...

virtual int	coordToIndexY (double coordY) const
	Convenience method, equivalent to `yAxis().coordToIndex(coord)`. More...

virtual int	allEntries () const
	Modifies this profile by adding the contents of profile to it. More...

virtual int	extraEntries () const
	Get the number of entries in the underflow and overflow bins. More...

virtual double	sumBinHeights () const
	Get the sum of in range bin heights in the IProfile. More...

virtual double	sumAllBinHeights () const
	Get the sum of all the bins heights (including underflow and overflow bin). More...

virtual double	sumExtraBinHeights () const
	Get the sum of the underflow and overflow bin height. More...

virtual double	minBinHeight () const
	Get the minimum height of the in-range bins. More...

virtual double	maxBinHeight () const
	Get the maximum height of the in-range bins. More...

virtual std::string	title () const
	Get the Histogram's title. More...

virtual bool	setTitle (const std::string &title)
	Set the histogram title. More...

virtual int	dimension () const
	Get the IAnnotation associated with the Histogram. More...

virtual bool	reset ()
	Reset the Histogram; as if just created. More...

virtual int	entries () const
	Get the number of in-range entries in the Histogram. More...

Public Member Functions inherited from AIDA::IProfile2D
virtual	~IProfile2D ()
	Destructor.

Public Member Functions inherited from AIDA::IProfile
virtual	~IProfile ()
	Destructor.

Public Member Functions inherited from AIDA::IBaseHistogram
virtual	~IBaseHistogram ()
	Destructor.

Detailed Description

User level interface to a 2-dimensional profile histogram.

Author: T. Kraemer, DESY

Version

Id:: IProfile2DROOT.h,v 1.7 2007-03-23 14:41:36 tkraemer Exp

Member Function Documentation

int IProfile2DROOT::allEntries ( ) const

virtual

Modifies this profile by adding the contents of profile to it.

Parameters

profile The IProfile2D to be added to this IProfile2D

Returns: false if the profile binnings are incompatiblevirtual bool add(const IProfile2D & h) ; Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.; The sum of all the entries.

Implements AIDA::IProfile.

int IProfile2DROOT::binEntries	(	int	indexX,
		int	indexY
	)		const

virtual

The number of entries (ie the number of times fill was called for this bin).

Parameters

indexX	the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
indexY	the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile2D.

double IProfile2DROOT::binError	(	int	indexX,
		int	indexY
	)		const

virtual

The error on this bin.

Parameters

indexX	the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
indexY	the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile2D.

double IProfile2DROOT::binHeight	(	int	indexX,
		int	indexY
	)		const

virtual

Total height of the corresponding bin (ie the sum of the weights in this bin).

Parameters

indexX	the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
indexY	the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile2D.

double IProfile2DROOT::binMeanX	(	int	indexX,
		int	indexY
	)		const

virtual

The weighted mean along x of a given bin.

Parameters

indexX	The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
indexY	The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The mean of the corresponding bin along the x axis.

Implements AIDA::IProfile2D.

double IProfile2DROOT::binMeanY	(	int	indexX,
		int	indexY
	)		const

virtual

The weighted mean along y of a given bin.

Parameters

indexX	The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
indexY	The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The mean of the corresponding bin along the x axis.

Implements AIDA::IProfile2D.

double IProfile2DROOT::binRms	(	int	indexX,
		int	indexY
	)		const

virtual

The spread (RMS) of this bin.

Parameters

indexX	the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
indexY	the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile2D.

int IProfile2DROOT::coordToIndexX ( double coordX ) const

virtual

Convenience method, equivalent to xAxis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Implements AIDA::IProfile2D.

int IProfile2DROOT::coordToIndexY ( double coordY ) const

virtual

Convenience method, equivalent to yAxis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Implements AIDA::IProfile2D.

int IProfile2DROOT::dimension ( ) const

virtual

Get the IAnnotation associated with the Histogram.

Returns: The IAnnotation.virtual IAnnotation & annotation() ; virtual const IAnnotation & annotation() const ; Get the Histogram's dimension.; The Histogram's dimension.

Implements AIDA::IBaseHistogram.

int IProfile2DROOT::entries ( ) const

virtual

Get the number of in-range entries in the Histogram.