Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

IHistogram2D Class Reference

#include <IHistogram2D.h>

Inheritance diagram for IHistogram2D:

IHistogram List of all members.

Public Methods

virtual void fill ( double x, double y, double weight = 1 ) = 0
 -------------------------------------------------------------------------- Histogram characteristics -------------------------------------------------------------------------- Fill histogram.

virtual int binEntries ( int indexX, int indexY ) const = 0
 -------------------------------------------------------------------------- Entries The indexX accepts UNDERFLOW_BIN, values from 0 to Nx-1, or OVERFLOW_BIN The indexY accepts UNDERFLOW_BIN, values from 0 to Ny-1, or OVERFLOW_BIN NW | N | NE ---------------------------- W | in-range bins | E -------------------------- SW | S | SE -------------------------------------------------------------------------- Number of entries in a specific in-range bin (number of fills).

virtual int binEntriesX ( int indexX ) const = 0
 Total number of entries in the projected slice to the axis X Equivalent to projectionX().binEntries( indexX );.

virtual int binEntriesY ( int indexY ) const = 0
 Total number of entries in the projected slice to the axis X Equivalent to projectionY().binEntries( indexY );.

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

virtual double binHeightX ( int indexX ) const = 0
 Total number of bin heights in the projected slice to the axis X Equivalent to projectionX().binHeight( indexX );.

virtual double binHeightY ( int indexY ) const = 0
 Total number of bin heights in the projected slice to the axis Y Equivalent to projectionY().binHeight( indexY );.

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

virtual double meanX () const = 0
 -------------------------------------------------------------------------- Statistics -------------------------------------------------------------------------- meanX() returns the mean of the whole histogram as calculated on filling-time projected on the axis X.

virtual double meanY () const = 0
 meanY() returns the mean of the whole histogram as calculated on filling-time projected on the axis Y.

virtual double rmsX () const = 0
 rmsX() returns the rms of the whole histogram as calculated on filling-time projected on the axis X.

virtual double rmsY () const = 0
 rmsY() returns the rms of the whole histogram as calculated on filling-time projected on the axis Y.

virtual double minBinHeight () const = 0
 -------------------------------------------------------------------------- Minimum and maximum heights and bins -------------------------------------------------------------------------- Min height of in-range bins in the whole histogram.

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

virtual int minBinY () const = 0
 IndexY of the in-range bin containing the minBinHeight().

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

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

virtual int maxBinY () const = 0
 IndexY of the in-range bin containing the maxBinHeight().

virtual IAxis* xAxis () const = 0
 -------------------------------------------------------------------------- Axis -------------------------------------------------------------------------- Get the X axis.

virtual IAxis* yAxis () const = 0
 Get the Y axis.

virtual int coordToIndexX ( double coordX ) const = 0
 -------------------------------------------------------------------------- Conversions between coordinates and bin indices -------------------------------------------------------------------------- Equivalent to xAxis().coordToIndex( coordX );.

virtual int coordToIndexY ( double coordY ) const = 0
 Equivalent to yAxis().coordToIndex( coordY );.

virtual IHistogram1D* projectionX () const = 0
 -------------------------------------------------------------------------- Projections -------------------------------------------------------------------------- Projection on axis X Equivalent to sliceX( UNDERFLOW_BIN, OVERFLOW_BIN );.

virtual IHistogram1D* projectionY () const = 0
 Projection on axis Y Equivalent to sliceY( UNDERFLOW_BIN, OVERFLOW_BIN );.

virtual IHistogram1D* sliceX ( int indexY ) const = 0
 -------------------------------------------------------------------------- Slices -------------------------------------------------------------------------- Slice parallel with the axis X, identified by bin indexY Equivalent to sliceX( indexY, indexY );.

virtual IHistogram1D* sliceY ( int indexX ) const = 0
 Slice parallel with the axis Y, identified by bin indexX Equivalent to sliceY( indexX, indexX );.

virtual IHistogram1D* sliceX ( int indexY1, int indexY2 ) const = 0
 Slice parallel with the axis X, between indexY1 and indexY2.

virtual IHistogram1D* sliceY ( int indexX1, int indexX2 ) const = 0
 Slice parallel with the axis Y, between indexX1 and indexX2.

Member Function Documentation

int IHistogram2D::binEntries ( int indexX,
int indexY ) const [pure virtual]
 

-------------------------------------------------------------------------- Entries The indexX accepts UNDERFLOW_BIN, values from 0 to Nx-1, or OVERFLOW_BIN The indexY accepts UNDERFLOW_BIN, values from 0 to Ny-1, or OVERFLOW_BIN NW | N | NE ---------------------------- W | in-range bins | E -------------------------- SW | S | SE -------------------------------------------------------------------------- Number of entries in a specific in-range bin (number of fills).

int IHistogram2D::binEntriesX ( int indexX ) const [pure virtual]
 

Total number of entries in the projected slice to the axis X Equivalent to projectionX().binEntries( indexX );.

int IHistogram2D::binEntriesY ( int indexY ) const [pure virtual]
 

Total number of entries in the projected slice to the axis X Equivalent to projectionY().binEntries( indexY );.

double IHistogram2D::binError ( int indexX,
int indexY ) const [pure virtual]
 

Bin contents error.

double IHistogram2D::binHeight ( int indexX,
int indexY ) const [pure virtual]
 

Height of a specific in-range bin (height respects weights of entries).

double IHistogram2D::binHeightX ( int indexX ) const [pure virtual]
 

Total number of bin heights in the projected slice to the axis X Equivalent to projectionX().binHeight( indexX );.

double IHistogram2D::binHeightY ( int indexY ) const [pure virtual]
 

Total number of bin heights in the projected slice to the axis Y Equivalent to projectionY().binHeight( indexY );.

int IHistogram2D::coordToIndexX ( double coordX ) const [pure virtual]
 

-------------------------------------------------------------------------- Conversions between coordinates and bin indices -------------------------------------------------------------------------- Equivalent to xAxis().coordToIndex( coordX );.

int IHistogram2D::coordToIndexY ( double coordY ) const [pure virtual]
 

Equivalent to yAxis().coordToIndex( coordY );.

void IHistogram2D::fill ( double x,
double y,
double weight = 1 ) [pure virtual]
 

-------------------------------------------------------------------------- Histogram characteristics -------------------------------------------------------------------------- Fill histogram.

double IHistogram2D::maxBinHeight ( ) const [pure virtual]
 

Max height of in-range bins in the whole histogram.

int IHistogram2D::maxBinX ( ) const [pure virtual]
 

IndexX of the in-range bin containing the maxBinHeight().

int IHistogram2D::maxBinY ( ) const [pure virtual]
 

IndexY of the in-range bin containing the maxBinHeight().

double IHistogram2D::meanX ( ) const [pure virtual]
 

-------------------------------------------------------------------------- Statistics -------------------------------------------------------------------------- meanX() returns the mean of the whole histogram as calculated on filling-time projected on the axis X.

double IHistogram2D::meanY ( ) const [pure virtual]
 

meanY() returns the mean of the whole histogram as calculated on filling-time projected on the axis Y.

double IHistogram2D::minBinHeight ( ) const [pure virtual]
 

-------------------------------------------------------------------------- Minimum and maximum heights and bins -------------------------------------------------------------------------- Min height of in-range bins in the whole histogram.

int IHistogram2D::minBinX ( ) const [pure virtual]
 

IndexX of the in-range bin containing the minBinHeight().

int IHistogram2D::minBinY ( ) const [pure virtual]
 

IndexY of the in-range bin containing the minBinHeight().

IHistogram1D * IHistogram2D::projectionX ( ) const [pure virtual]
 

-------------------------------------------------------------------------- Projections -------------------------------------------------------------------------- Projection on axis X Equivalent to sliceX( UNDERFLOW_BIN, OVERFLOW_BIN );.

IHistogram1D * IHistogram2D::projectionY ( ) const [pure virtual]
 

Projection on axis Y Equivalent to sliceY( UNDERFLOW_BIN, OVERFLOW_BIN );.

double IHistogram2D::rmsX ( ) const [pure virtual]
 

rmsX() returns the rms of the whole histogram as calculated on filling-time projected on the axis X.

double IHistogram2D::rmsY ( ) const [pure virtual]
 

rmsY() returns the rms of the whole histogram as calculated on filling-time projected on the axis Y.

IHistogram1D * IHistogram2D::sliceX ( int indexY1,
int indexY2 ) const [pure virtual]
 

Slice parallel with the axis X, between indexY1 and indexY2.

IHistogram1D * IHistogram2D::sliceX ( int indexY ) const [pure virtual]
 

-------------------------------------------------------------------------- Slices -------------------------------------------------------------------------- Slice parallel with the axis X, identified by bin indexY Equivalent to sliceX( indexY, indexY );.

IHistogram1D * IHistogram2D::sliceY ( int indexX1,
int indexX2 ) const [pure virtual]
 

Slice parallel with the axis Y, between indexX1 and indexX2.

IHistogram1D * IHistogram2D::sliceY ( int indexX ) const [pure virtual]
 

Slice parallel with the axis Y, identified by bin indexX Equivalent to sliceY( indexX, indexX );.

IAxis * IHistogram2D::xAxis ( ) const [pure virtual]
 

-------------------------------------------------------------------------- Axis -------------------------------------------------------------------------- Get the X axis.

IAxis * IHistogram2D::yAxis ( ) const [pure virtual]
 

Get the Y axis.

The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:11 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000