User level interface to a 2-dimensional profile histogram. More...
#include <IProfile2D.h>
Inheritance diagram for AIDA::IProfile2D:
Public Member Functions | |
| virtual | ~IProfile2D () |
| Destructor. | |
| virtual bool | fill (double x, double y, double z, double weight=1)=0 |
| Fill the IProfile2D. | |
| virtual double | binMeanX (int indexX, int indexY) const =0 |
| The weighted mean along x of a given bin. More... | |
| virtual double | binMeanY (int indexX, int indexY) const =0 |
| The weighted mean along y of a given bin. More... | |
| virtual int | binEntries (int indexX, int indexY) const =0 |
| The number of entries (ie the number of times fill was called for this bin). More... | |
| virtual int | binEntriesX (int indexX) const =0 |
Equivalent to projectionX().binEntries(indexX). | |
| virtual int | binEntriesY (int indexY) const =0 |
Equivalent to projectionY().binEntries(indexY). | |
| virtual double | binHeight (int indexX, int indexY) const =0 |
| Total height of the corresponding bin (ie the sum of the weights in this bin). More... | |
| virtual double | binHeightX (int indexX) const =0 |
Equivalent to projectionX().binHeight(indexX). | |
| virtual double | binHeightY (int indexY) const =0 |
Equivalent to projectionY().binHeight(indexY). | |
| virtual double | binError (int indexX, int indexY) const =0 |
| The error on this bin. More... | |
| virtual double | binRms (int indexX, int indexY) const =0 |
| The spread (RMS) of this bin. More... | |
| virtual double | meanX () const =0 |
| Returns the mean of the profile, as calculated on filling-time projected on the X axis. | |
| virtual double | meanY () const =0 |
| Returns the mean of the profile, as calculated on filling-time projected on the Y axis. | |
| virtual double | rmsX () const =0 |
| Returns the rms of the profile as calculated on filling-time projected on the X axis. | |
| virtual double | rmsY () const =0 |
| Returns the rms of the profile as calculated on filling-time projected on the Y axis. | |
| virtual const IAxis & | xAxis () const =0 |
| Return the X axis. | |
| virtual const IAxis & | yAxis () const =0 |
| Return the Y axis. | |
| virtual int | coordToIndexX (double coordX) const =0 |
Convenience method, equivalent to xAxis().coordToIndex(coord). More... | |
| virtual int | coordToIndexY (double coordY) const =0 |
Convenience method, equivalent to yAxis().coordToIndex(coord). More... | |
 Public Member Functions inherited from AIDA::IProfile | |
| virtual | ~IProfile () |
| Destructor. | |
| virtual int | allEntries () const =0 |
| Get the number or all the entries, both in range and underflow/overflow bins of the IProfile. More... | |
| virtual int | extraEntries () const =0 |
| Get the number of entries in the underflow and overflow bins. More... | |
| virtual double | sumBinHeights () const =0 |
| Get the sum of in range bin heights in the IProfile. More... | |
| virtual double | sumAllBinHeights () const =0 |
| Get the sum of all the bins heights (including underflow and overflow bin). More... | |
| virtual double | sumExtraBinHeights () const =0 |
| Get the sum of the underflow and overflow bin height. More... | |
| virtual double | minBinHeight () const =0 |
| Get the minimum height of the in-range bins. More... | |
| virtual double | maxBinHeight () const =0 |
| Get the maximum height of the in-range bins. 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 a 2-dimensional profile histogram.
Member Function Documentation
|
pure virtual |
The number of entries (ie the number of times fill was called for this bin).
- Parameters
-
indexX the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
The error on this bin.
- Parameters
-
indexX the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
Total height of the corresponding bin (ie the sum of the weights in this bin).
- Parameters
-
indexX the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
The weighted mean along x 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.
- Returns
- The mean of the corresponding bin along the x axis.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
The weighted mean along y 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.
- Returns
- The mean of the corresponding bin along the x axis.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
The spread (RMS) of this bin.
- Parameters
-
indexX the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
Convenience method, equivalent to xAxis().coordToIndex(coord).
- See Also
- IAxis::coordToIndex(double)
Implemented in AIDA::IProfile2DROOT.
|
pure virtual |
Convenience method, equivalent to yAxis().coordToIndex(coord).
- See Also
- IAxis::coordToIndex(double)
Implemented in AIDA::IProfile2DROOT.
The documentation for this class was generated from the following file:
