AIDA::IHistogram3D Class Reference

User level interface to 3D Histogram. More...

#include <IHistogram3D.h>

Inheritance diagram for AIDA::IHistogram3D:

Public Member Functions
virtual	~IHistogram3D ()
	Destructor.
virtual bool	fill (double x, double y, double z, double weight=1.)=0
	Fill the IHistogram3D with a triplet of values and the corresponding weight. More...
virtual double	binMeanX (int indexX, int indexY, int indexZ) const =0
	The weighted mean along the x axis of a given bin. More...
virtual double	binMeanY (int indexX, int indexY, int indexZ) const =0
	The weighted mean the y axis of a given bin. More...
virtual double	binMeanZ (int indexX, int indexY, int indexZ) const =0
	The weighted mean the z axis of a given bin. More...
virtual int	binEntries (int indexX, int indexY, int indexZ) const =0
	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 =0
	Sum of all the entries of the bins along a given x bin. More...
virtual int	binEntriesY (int index) const =0
	Sum of all the entries of the bins along a given y bin. More...
virtual int	binEntriesZ (int index) const =0
	Sum of all the entries of the bins along a given z bin. More...
virtual double	binHeight (int indexX, int indexY, int indexZ) const =0
	Total height of a give bin (ie the sum of the weights in this bin). More...
virtual double	binHeightX (int index) const =0
	Sum of all the heights of the bins along a given x bin. More...
virtual double	binHeightY (int index) const =0
	Sum of all the heights of the bins along a given y bin. More...
virtual double	binHeightZ (int index) const =0
	Sum of all the heights of the bins along a given z bin. More...
virtual double	binError (int indexX, int indexY, int indexZ) const =0
	The error of a given bin. More...
virtual double	meanX () const =0
	The mean of the IHistogram3D along the x axis. More...
virtual double	meanY () const =0
	The mean of the IHistogram3D along the y axis. More...
virtual double	meanZ () const =0
	The mean of the IHistogram3D along the z axis. More...
virtual double	rmsX () const =0
	The RMS of the IHistogram3D along the x axis. More...
virtual double	rmsY () const =0
	The RMS of the IHistogram3D along the y axis. More...
virtual double	rmsZ () const =0
	The RMS of the IHistogram3D along the z axis. More...
virtual const IAxis &	xAxis () const =0
	Get the x axis of the IHistogram3D. More...
virtual const IAxis &	yAxis () const =0
	Get the y axis of the IHistogram3D. More...
virtual const IAxis &	zAxis () const =0
	Get the z axis of the IHistogram3D. More...
virtual int	coordToIndexX (double coord) const =0
	Get the bin number corresponding to a given coordinate along the x axis. More...
virtual int	coordToIndexY (double coord) const =0
	Get the bin number corresponding to a given coordinate along the y axis. More...
virtual int	coordToIndexZ (double coord) const =0
	Get the bin number corresponding to a given coordinate along the z axis. More...
virtual bool	add (const IHistogram3D &hist)=0
	Add to this IHistogram3D the contents of another IHistogram3D. More...
Public Member Functions inherited from AIDA::IHistogram
virtual	~IHistogram ()
	Destructor.
virtual int	allEntries () const =0
	Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. More...
virtual int	extraEntries () const =0
	Number of entries in the UNDERFLOW and OVERFLOW bins. More...
virtual double	sumBinHeights () const =0
	Number of equivalent entries, i.e. More...
virtual double	sumAllBinHeights () const =0
	Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. More...
virtual double	sumExtraBinHeights () const =0
	Sum of heights in the UNDERFLOW and OVERFLOW bins. More...
virtual double	minBinHeight () const =0
	Minimum height of the in-range bins, i.e. More...
virtual double	maxBinHeight () const =0
	Maximum height of the in-range bins, i.e. More...
virtual bool	scale (double scaleFactor)=0
	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...
Public Member Functions inherited from AIDA::IBaseHistogram
virtual	~IBaseHistogram ()
	Destructor.
virtual std::string	title () const =0
	Get the Histogram's title. More...
virtual bool	setTitle (const std::string &title)=0
	Set the histogram title. More...
virtual int	dimension () const =0
	Get the IAnnotation associated with the Histogram. More...
virtual bool	reset ()=0
	Reset the Histogram; as if just created. More...
virtual int	entries () const =0
	Get the number of in-range entries in the Histogram. More...

Detailed Description

User level interface to 3D Histogram.

Author

The AIDA team (http://aida.freehep.org/)

Member Function Documentation

virtual bool AIDA::IHistogram3D::add ( const IHistogram3D &  hist )

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

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::IHistogramFactoryROOT::add().

virtual int AIDA::IHistogram3D::binEntries ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::binEntriesX ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::binEntriesY ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::binEntriesZ ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binError ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binHeight ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binHeightX ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binHeightY ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binHeightZ ( int  index ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binMeanX ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binMeanY ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual double AIDA::IHistogram3D::binMeanZ ( int  indexX, int  indexY, int  indexZ  ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::coordToIndexX ( double  coord ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::coordToIndexY ( double  coord ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual int AIDA::IHistogram3D::coordToIndexZ ( double  coord ) const

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

Implemented in AIDA::IHistogram3DROOT.

virtual bool AIDA::IHistogram3D::fill ( double  x, double  y, double  z, double  weight = 1.  )

pure 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 (?).

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::fill(), and AIDA::ICloud3DROOT::fillHistogram().

virtual double AIDA::IHistogram3D::meanX ( ) const

pure virtual

The mean of the IHistogram3D along the x axis.

Returns

The mean of the IHistogram3D along the x axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::meanX().

virtual double AIDA::IHistogram3D::meanY ( ) const

pure virtual

The mean of the IHistogram3D along the y axis.

Returns

The mean of the IHistogram3D along the y axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::meanY().

virtual double AIDA::IHistogram3D::meanZ ( ) const

pure virtual

The mean of the IHistogram3D along the z axis.

Returns

The mean of the IHistogram3D along the z axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::meanZ().

virtual double AIDA::IHistogram3D::rmsX ( ) const

pure virtual

The RMS of the IHistogram3D along the x axis.

Returns

The RMS if the IHistogram3D along the x axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::rmsX().

virtual double AIDA::IHistogram3D::rmsY ( ) const

pure virtual

The RMS of the IHistogram3D along the y axis.

Returns

The RMS if the IHistogram3D along the y axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::rmsY().

virtual double AIDA::IHistogram3D::rmsZ ( ) const

pure virtual

The RMS of the IHistogram3D along the z axis.

Returns

The RMS if the IHistogram3D along the z axis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::ICloud3DROOT::rmsZ().

virtual const IAxis& AIDA::IHistogram3D::xAxis ( ) const

pure virtual

Get the x axis of the IHistogram3D.

Returns

The x coordinate IAxis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::IHistogram3DROOT::add(), AIDA::IHistogramFactoryROOT::add(), AIDA::IHistogramFactoryROOT::createCopy(), AIDA::IHistogramFactoryROOT::divide(), AIDA::IHistogramFactoryROOT::multiply(), and AIDA::IHistogramFactoryROOT::subtract().

virtual const IAxis& AIDA::IHistogram3D::yAxis ( ) const

pure virtual

Get the y axis of the IHistogram3D.

Returns

The y coordinate IAxis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::IHistogram3DROOT::add(), AIDA::IHistogramFactoryROOT::add(), AIDA::IHistogramFactoryROOT::createCopy(), AIDA::IHistogramFactoryROOT::divide(), AIDA::IHistogramFactoryROOT::multiply(), and AIDA::IHistogramFactoryROOT::subtract().

virtual const IAxis& AIDA::IHistogram3D::zAxis ( ) const

pure virtual

Get the z axis of the IHistogram3D.

Returns

The z coordinate IAxis.

Implemented in AIDA::IHistogram3DROOT.

Referenced by AIDA::IHistogram3DROOT::add(), AIDA::IHistogramFactoryROOT::add(), AIDA::IHistogramFactoryROOT::createCopy(), AIDA::IHistogramFactoryROOT::divide(), AIDA::IHistogramFactoryROOT::multiply(), and AIDA::IHistogramFactoryROOT::subtract().

---

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

• IHistogram3D.h