Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::IHistogram3D Class Reference

#include <IHistogram3D.h>

Inheritance diagram for Anaphe::IHistogram3D:

Anaphe::IHistogram List of all members.

Public Methods

virtual ~IHistogram3D ()
virtual void fill (double x, double y, double z, double weight=1.)=0
 Fill histogram.

virtual int binEntries (int indexX, int indexY, int indexZ) const=0
 Number of entries in a specific in-range bin (number of fills).

virtual double binHeight (int indexX, int indexY, int indexZ) const=0
 Height of a specific in-range bin (height respects weights of entries).

virtual double binError (int indexX, int indexY, int indexZ) const=0
 Bin contents error.

virtual double meanX () const=0
 mean[X|Y|Z]() returns the mean of the whole histogram as calculated on filling-time projected on the axis X, Y and Z

virtual double meanY () const=0
virtual double meanZ () const=0
virtual double rmsX () const=0
 rms[X|Y|Z]() returns the rms of the whole histogram as calculated on filling-time projected on the axis X, Y and Z

virtual double rmsY () const=0
virtual double rmsZ () const=0
virtual double minBinHeight () const=0
 Min height of in-range bins in the whole histogram.

virtual int minBinX () const=0
 IndexX, indexY or indexZ of the in-range bin containing the minBinHeight().

virtual int minBinY () const=0
virtual int minBinZ () const=0
virtual double maxBinHeight () const=0
 Max height of in-range bins in the whole histogram.

virtual int maxBinX () const=0
 IndexX, indexY or indexZ of the in-range bin containing the maxBinHeight().

virtual int maxBinY () const=0
virtual int maxBinZ () const=0
virtual IAxisxAxis () const=0
 Get the pointer to X, Y or Z axis.

virtual IAxisyAxis () const=0
virtual IAxiszAxis () const=0
virtual int coordToIndexX (double coordX) const=0
virtual int coordToIndexY (double coordY) const=0
virtual int coordToIndexZ (double coordZ) const=0
virtual IHistogram2DprojectionXY () const=0
 Create a projection parallel to the X axis. Equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

virtual IHistogram2DprojectionXZ () const=0
 Create a projection parallel to the Z axis. Equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

virtual IHistogram2DprojectionYZ () const=0
 Create a projection parallel to the Y axis. Equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

virtual IHistogram2DsliceXY (int indexZ1, int indexZ2) const=0
 Slice parallel to the XY plane, range from bin indexZ1 to indexZ2 (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Y axis of this histogram.

virtual IHistogram2DsliceXZ (int indexY1, int indexY2) const=0
 Slice parallel to the XZ plane, range from bin indexY1 to indexY2 (inclusive). The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.

virtual IHistogram2DsliceYZ (int indexX1, int indexX2) const=0
 Slice parallel to the YZ plane, range from bin indexX1 to indexX2 (inclusive). The X axis of the returned histogram corresponds to the Y axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.


Constructor & Destructor Documentation

virtual Anaphe::IHistogram3D::~IHistogram3D   [inline, virtual]
 


Member Function Documentation

virtual int Anaphe::IHistogram3D::binEntries int    indexX,
int    indexY,
int    indexZ
const [pure virtual]
 

virtual double Anaphe::IHistogram3D::binError int    indexX,
int    indexY,
int    indexZ
const [pure virtual]
 

virtual double Anaphe::IHistogram3D::binHeight int    indexX,
int    indexY,
int    indexZ
const [pure virtual]
 

virtual int Anaphe::IHistogram3D::coordToIndexX double    coordX const [pure virtual]
 

virtual int Anaphe::IHistogram3D::coordToIndexY double    coordY const [pure virtual]
 

virtual int Anaphe::IHistogram3D::coordToIndexZ double    coordZ const [pure virtual]
 

virtual void Anaphe::IHistogram3D::fill double    x,
double    y,
double    z,
double    weight = 1.
[pure virtual]
 

virtual double Anaphe::IHistogram3D::maxBinHeight   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::maxBinX   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::maxBinY   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::maxBinZ   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::meanX   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::meanY   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::meanZ   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::minBinHeight   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::minBinX   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::minBinY   const [pure virtual]
 

virtual int Anaphe::IHistogram3D::minBinZ   const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::projectionXY   const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::projectionXZ   const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::projectionYZ   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::rmsX   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::rmsY   const [pure virtual]
 

virtual double Anaphe::IHistogram3D::rmsZ   const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::sliceXY int    indexZ1,
int    indexZ2
const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::sliceXZ int    indexY1,
int    indexY2
const [pure virtual]
 

virtual IHistogram2D* Anaphe::IHistogram3D::sliceYZ int    indexX1,
int    indexX2
const [pure virtual]
 

virtual IAxis* Anaphe::IHistogram3D::xAxis   const [pure virtual]
 

virtual IAxis* Anaphe::IHistogram3D::yAxis   const [pure virtual]
 

virtual IAxis* Anaphe::IHistogram3D::zAxis   const [pure virtual]
 


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

Anaphe documentation generated by Doxygen (www.doxygen.org)