CERN Accelerating science

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

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

AIDA::IHistogram3D Class Reference

#include <IHistogram3D.h>

Inheritance diagram for AIDA::IHistogram3D::

AIDA::IHistogram AIDA::IBaseHistogram List of all members.

Public Methods

virtual ~IHistogram3D ()
 Destructor. More...

virtual bool fill (double x, double y, double z, double weight=1.)=0
virtual double binMeanX (int indexX, int indexY, int indexZ) const=0
virtual double binMeanY (int indexX, int indexY, int indexZ) const=0
virtual double binMeanZ (int indexX, int indexY, int indexZ) const=0
virtual int binEntries (int indexX, int indexY, int indexZ) const=0
virtual int binEntriesX (int index) const=0
virtual int binEntriesY (int index) const=0
virtual int binEntriesZ (int index) const=0
virtual double binHeight (int indexX, int indexY, int indexZ) const=0
virtual double binHeightX (int index) const=0
virtual double binHeightY (int index) const=0
virtual double binHeightZ (int index) const=0
virtual double binError (int indexX, int indexY, int indexZ) const=0
virtual double meanX () const=0
virtual double meanY () const=0
virtual double meanZ () const=0
virtual double rmsX () const=0
virtual double rmsY () const=0
virtual double rmsZ () const=0
virtual const IAxis& xAxis () const=0
virtual const IAxis& yAxis () const=0
virtual const IAxis& zAxis () const=0
virtual int coordToIndexX (double coord) const=0
virtual int coordToIndexY (double coord) const=0
virtual int coordToIndexZ (double coord) const=0
virtual bool add (const IHistogram3D &hist)=0

Detailed Description

User level interface to 3D Histogram.

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

Definition at line 28 of file IHistogram3D.h.

Constructor & Destructor Documentation

AIDA::IHistogram3D::~IHistogram3D ( ) [inline, virtual]
 

Definition at line 32 of file IHistogram3D.h.

Member Function Documentation

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

const IAxis & AIDA::IHistogram3D::xAxis ( ) const [pure virtual]
 

Get the x axis of the IHistogram3D.

Returns:
The x coordinate IAxis.

const IAxis & AIDA::IHistogram3D::yAxis ( ) const [pure virtual]
 

Get the y axis of the IHistogram3D.

Returns:
The y coordinate IAxis.

const IAxis & AIDA::IHistogram3D::zAxis ( ) const [pure virtual]
 

Get the z axis of the IHistogram3D.

Returns:
The z coordinate IAxis.

The documentation for this class was generated from the following file:
Generated at Tue Feb 18 15:48:24 2003 for AIDA_Interfaces by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001