#include <IHistogram3DROOT.h>

Inheritance diagram for AIDA::IHistogram3DROOT:

Public Member Functions
virtual	~IHistogram3DROOT ()
	Destructor.

	IHistogram3DROOT ()
	Constructor.

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

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

	IHistogram3DROOT (const std::string &name, const IHistogram3DROOT &hist)

virtual bool	fill (double x, double y, double z, double weight=1.)
	Fill the IHistogram3D with a triplet of values and the corresponding weight. More...

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

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

virtual double	binMeanZ (int indexX, int indexY, int indexZ) const
	The weighted mean the z axis of a given bin. More...

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

virtual int	binEntriesX (int index) const
	Sum of all the entries of the bins along a given x bin. More...

virtual int	binEntriesY (int index) const
	Sum of all the entries of the bins along a given y bin. More...

virtual int	binEntriesZ (int index) const
	Sum of all the entries of the bins along a given z bin. More...

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

virtual double	binHeightX (int index) const
	Sum of all the heights of the bins along a given x bin. More...

virtual double	binHeightY (int index) const
	Sum of all the heights of the bins along a given y bin. More...

virtual double	binHeightZ (int index) const
	Sum of all the heights of the bins along a given z bin. More...

virtual double	binError (int indexX, int indexY, int indexZ) const
	The error of a given bin. More...

virtual double	meanX () const
	The mean of the IHistogram3D along the x axis. More...

virtual double	meanY () const
	The mean of the IHistogram3D along the y axis. More...

virtual double	meanZ () const
	The mean of the IHistogram3D along the z axis. More...

virtual double	rmsX () const
	The RMS of the IHistogram3D along the x axis. More...

virtual double	rmsY () const
	The RMS of the IHistogram3D along the y axis. More...

virtual double	rmsZ () const
	The RMS of the IHistogram3D along the z axis. More...

virtual const IAxis &	xAxis () const
	Get the x axis of the IHistogram3D. More...

virtual const IAxis &	yAxis () const
	Get the y axis of the IHistogram3D. More...

virtual const IAxis &	zAxis () const
	Get the z axis of the IHistogram3D. More...

virtual int	coordToIndexX (double coord) const
	Get the bin number corresponding to a given coordinate along the x axis. More...

virtual int	coordToIndexY (double coord) const
	Get the bin number corresponding to a given coordinate along the y axis. More...

virtual int	coordToIndexZ (double coord) const
	Get the bin number corresponding to a given coordinate along the z axis. More...

virtual bool	add (const IHistogram3D &hist)
	Add to this IHistogram3D the contents of another IHistogram3D. More...

virtual bool	subtract (const IHistogram3D &hist)

virtual bool	multiply (const IHistogram3D &hist)

virtual bool	divide (const IHistogram3D &hist)

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

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

virtual bool	setName (const std::string &name)

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...

virtual int	allEntries () const
	See IManagedObject for a description. More...

virtual int	extraEntries () const
	Number of entries in the UNDERFLOW and OVERFLOW bins. More...

virtual double	sumBinHeights () const
	Number of equivalent entries, i.e. More...

virtual double	sumAllBinHeights () const
	Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. More...

virtual double	sumExtraBinHeights () const
	Sum of heights in the UNDERFLOW and OVERFLOW bins. More...

virtual double	minBinHeight () const
	Minimum height of the in-range bins, i.e. More...

virtual double	maxBinHeight () const
	Maximum height of the in-range bins, i.e. More...

virtual bool	scale (double scaleFactor)
	Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor. More...

virtual void	printContents () const
	Print out the contents of a histogram to the screen. More...

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

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

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

Friends
class	IHistogramFactoryROOT

class	IHistogram2DROOT

Detailed Description

class IAxis;

User level interface to 3D Histogram.

Author: T. Kraemer, DESY

Version

Id:: IHistogram3DROOT.h,v 1.11 2008-01-30 17:42:20 killenberg Exp

Member Function Documentation

bool IHistogram3DROOT::add ( const IHistogram3D & hist )

virtual

Add to this IHistogram3D the contents of another IHistogram3D.

Parameters

hist	The IHistogram3D to be added to this IHistogram3D.

Returns: false If the IHistogram3Ds binnings are incompatible.

Implements AIDA::IHistogram3D.

References AIDA::IAxis::bins(), AIDA::IHistogram3D::xAxis(), xAxis(), AIDA::IHistogram3D::yAxis(), yAxis(), AIDA::IHistogram3D::zAxis(), and zAxis().

int IHistogram3DROOT::allEntries ( ) const

virtual

See IManagedObject for a description.

Parameters

className The name of the class to cast on.

Returns: The right pointer. Return 0 if failure.virtual void * cast(const std::string & className) const ; Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. This is equivalent to the number of times the method fill was invoked.; The sum of all the entries.

Implements AIDA::IHistogram.

Referenced by printContents().

int IHistogram3DROOT::binEntries	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

Number of entries in the corresponding bin (ie the number of times fill was called for this 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The number of entries in the corresponding bin.

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

int IHistogram3DROOT::binEntriesX ( int index ) const

virtual

Sum of all the entries of the bins along a given x bin.

This is equivalent to projectionXY().binEntriesX(index).

Parameters

index The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The number of entries in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References xAxis().

Referenced by printContents().

int IHistogram3DROOT::binEntriesY ( int index ) const

virtual

Sum of all the entries of the bins along a given y bin.

This is equivalent to projectionXY().binEntriesY(index).

Parameters

index The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The number of entries in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References yAxis().

Referenced by printContents().

int IHistogram3DROOT::binEntriesZ ( int index ) const

virtual

Sum of all the entries of the bins along a given z bin.

This is equivalent to projectionXZ().binEntriesZ(index).

Parameters

index The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The number of entries in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References zAxis().

Referenced by printContents().

double IHistogram3DROOT::binError	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

The error 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The error on the corresponding bin.

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

double IHistogram3DROOT::binHeight	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

Total height of a give bin (ie the sum of the weights in this 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The height of the corresponding bin.

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

double IHistogram3DROOT::binHeightX ( int index ) const

virtual

Sum of all the heights of the bins along a given x bin.

This is equivalent to projectionXY().binHeightX(index).

Parameters

index The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The sum of the heights in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References xAxis().

Referenced by printContents().

double IHistogram3DROOT::binHeightY ( int index ) const

virtual

Sum of all the heights of the bins along a given y bin.

This is equivalent to projectionXY().binHeightY(index).

Parameters

index The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The sum of the heights in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References yAxis().

Referenced by printContents().

double IHistogram3DROOT::binHeightZ ( int index ) const

virtual

Sum of all the heights of the bins along a given z bin.

This is equivalent to projectionXZ().binHeightZ(index).

Parameters

index The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The sum of the heights in the corresponding set of bins.

Implements AIDA::IHistogram3D.

References zAxis().

Referenced by printContents().

double IHistogram3DROOT::binMeanX	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

The weighted mean along the x axis 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

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

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

double IHistogram3DROOT::binMeanY	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

The weighted mean the y axis 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

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

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

double IHistogram3DROOT::binMeanZ	(	int	indexX,
		int	indexY,
		int	indexZ
	)		const

virtual

The weighted mean the z axis 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.
indexZ	The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.

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

Implements AIDA::IHistogram3D.

References xAxis(), yAxis(), and zAxis().

Referenced by printContents().

int IHistogram3DROOT::coordToIndexX ( double coord ) const

virtual

Get the bin number corresponding to a given coordinate along the x axis.

This is a convenience method, equivalent to xAxis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Parameters

coord The coordinalte along the x axis.

Returns: The corresponding bin number.

Implements AIDA::IHistogram3D.

References xAxis().

int IHistogram3DROOT::coordToIndexY ( double coord ) const

virtual

Get the bin number corresponding to a given coordinate along the y axis.

This is a convenience method, equivalent to yAxis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Parameters

coord The coordinalte along the y axis.

Returns: The corresponding bin number.

Implements AIDA::IHistogram3D.

References yAxis().

int IHistogram3DROOT::coordToIndexZ ( double coord ) const

virtual

Get the bin number corresponding to a given coordinate along the z axis.

This is a convenience method, equivalent to zAxis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Parameters

coord The coordinalte along the z axis.

Returns: The corresponding bin number.

Implements AIDA::IHistogram3D.

References zAxis().

int IHistogram3DROOT::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 IHistogram3DROOT::entries ( ) const

virtual

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

Returns: The number of in-range entries.

Implements AIDA::IBaseHistogram.

Referenced by printContents().

int IHistogram3DROOT::extraEntries ( ) const

virtual

Number of entries in the UNDERFLOW and OVERFLOW bins.

Returns: The number of entries outside the range of the IHistogram.

Implements AIDA::IHistogram.

Referenced by printContents().

bool IHistogram3DROOT::fill	(	double	x,
		double	y,
		double	z,
		double	weight = `1.`
	)

virtual

Fill the IHistogram3D with a triplet of values and the corresponding weight.

Parameters

x	The x value to be filled in.
y	The y value to be filled in.
z	The z value to be filled in.
weight	The corresponding weight (by default 1).

Returns: false If the weight is <0 or >1 (?).

Implements AIDA::IHistogram3D.

double IHistogram3DROOT::maxBinHeight ( ) const

virtual

Maximum height of the in-range bins, i.e.

not considering the UNDERFLOW and OVERFLOW bins.

Returns: The maximum height among the in-range bins.

Implements AIDA::IHistogram.

Referenced by printContents().

double IHistogram3DROOT::meanX ( ) const

virtual

The mean of the IHistogram3D along the x axis.

Returns: The mean of the IHistogram3D along the x axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

double IHistogram3DROOT::meanY ( ) const

virtual

The mean of the IHistogram3D along the y axis.

Returns: The mean of the IHistogram3D along the y axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

double IHistogram3DROOT::meanZ ( ) const

virtual

The mean of the IHistogram3D along the z axis.

Returns: The mean of the IHistogram3D along the z axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

double IHistogram3DROOT::minBinHeight ( ) const

virtual

Minimum height of the in-range bins, i.e.

not considering the UNDERFLOW and OVERFLOW bins.

Returns: The minimum height among the in-range bins.

Implements AIDA::IHistogram.

Referenced by printContents().

void IHistogram3DROOT::printContents ( ) const

virtual

Print out the contents of a histogram to the screen.

This method is made for debugging purposes. It is not part of the AIDA Interface!

References allEntries(), binEntries(), binEntriesX(), binEntriesY(), binEntriesZ(), binError(), binHeight(), binHeightX(), binHeightY(), binHeightZ(), AIDA::IAxis::binLowerEdge(), binMeanX(), binMeanY(), binMeanZ(), AIDA::IAxis::bins(), entries(), extraEntries(), AIDA::IAxis::lowerEdge(), maxBinHeight(), meanX(), meanY(), meanZ(), minBinHeight(), rmsX(), rmsY(), rmsZ(), sumAllBinHeights(), sumBinHeights(), sumExtraBinHeights(), title(), AIDA::IAxis::upperEdge(), xAxis(), yAxis(), and zAxis().

bool IHistogram3DROOT::reset ( )

virtual

Reset the Histogram; as if just created.

Returns: false If something goes wrong.

Implements AIDA::IBaseHistogram.

double IHistogram3DROOT::rmsX ( ) const

virtual

The RMS of the IHistogram3D along the x axis.

Returns: The RMS if the IHistogram3D along the x axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

double IHistogram3DROOT::rmsY ( ) const

virtual

The RMS of the IHistogram3D along the y axis.

Returns: The RMS if the IHistogram3D along the y axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

double IHistogram3DROOT::rmsZ ( ) const

virtual

The RMS of the IHistogram3D along the z axis.

Returns: The RMS if the IHistogram3D along the z axis.

Implements AIDA::IHistogram3D.

Referenced by printContents().

bool IHistogram3DROOT::scale ( double scaleFactor )

virtual

Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.

Parameters

scaleFactor The scale factor.

Returns: false If the scale factor is negative.

FIXME! richtige beruecksichtigung der Fehler im Zusammenhang mit dcale!

Implements AIDA::IHistogram.

bool IHistogram3DROOT::setTitle ( const std::string & title )

virtual

Set the histogram title.

Parameters

title The title.

Returns: false If title cannot be changed.

Implements AIDA::IBaseHistogram.

double IHistogram3DROOT::sumAllBinHeights ( ) const

virtual

Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.

Returns: The sum of all the bins heights.

Implements AIDA::IHistogram.

Referenced by printContents().

double IHistogram3DROOT::sumBinHeights ( ) const

virtual

Number of equivalent entries, i.e.

SUM[ weight ] ^ 2 / SUM[ weight^2 ]

Returns: The number of equivalent entries.virtual double equivalentBinEntries() const ; Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.; The sum of the in-range bins heights.

Implements AIDA::IHistogram.

Referenced by printContents().

double IHistogram3DROOT::sumExtraBinHeights ( ) const

virtual

Sum of heights in the UNDERFLOW and OVERFLOW bins.