|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
User level interface to a 2-dimensional profile histogram
Method Summary | |
void |
add(IProfile2D h)
Modifies this profile by adding the contents of profile to it. |
int |
binEntries(int indexX,
int indexY)
The number of entries (ie the number of times fill was called for this bin). |
int |
binEntriesX(int indexX)
Equivalent to projectionX().binEntries(indexX). |
int |
binEntriesY(int indexY)
Equivalent to projectionY().binEntries(indexY). |
double |
binError(int indexX,
int indexY)
The error on this bin. |
double |
binHeight(int indexX,
int indexY)
Total height of the corresponding bin (ie the sum of the weights in this bin). |
double |
binHeightX(int indexX)
Equivalent to projectionX().binHeight(indexX). |
double |
binHeightY(int indexY)
Equivalent to projectionY().binHeight(indexY). |
double |
binMeanX(int indexX,
int indexY)
The weighted mean along x of a given bin. |
double |
binMeanY(int indexX,
int indexY)
The weighted mean along y of a given bin. |
double |
binRms(int indexX,
int indexY)
The spread (RMS) of this bin. |
int |
coordToIndexX(double coordX)
Convenience method, equivalent to xAxis().coordToIndex(coord). |
int |
coordToIndexY(double coordY)
Convenience method, equivalent to yAxis().coordToIndex(coord). |
void |
fill(double x,
double y,
double z)
Fill the IProfile2D. |
void |
fill(double x,
double y,
double z,
double weight)
Fill the IProfile2D. |
double |
meanX()
Returns the mean of the profile, as calculated on filling-time projected on the X axis. |
double |
meanY()
Returns the mean of the profile, as calculated on filling-time projected on the Y axis. |
double |
rmsX()
Returns the rms of the profile as calculated on filling-time projected on the X axis. |
double |
rmsY()
Returns the rms of the profile as calculated on filling-time projected on the Y axis. |
IAxis |
xAxis()
Return the X axis. |
IAxis |
yAxis()
Return the Y axis. |
Methods inherited from interface hep.aida.IProfile |
allEntries, extraEntries, maxBinHeight, minBinHeight, sumAllBinHeights, sumBinHeights, sumExtraBinHeights |
Methods inherited from interface hep.aida.IBaseHistogram |
annotation, dimension, entries, reset, setTitle, title |
Method Detail |
public void fill(double x, double y, double z) throws IllegalArgumentException
IllegalArgumentException
public void fill(double x, double y, double z, double weight) throws IllegalArgumentException
IllegalArgumentException
public double binMeanX(int indexX, int indexY) throws IllegalArgumentException
indexX
- The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.indexY
- The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public double binMeanY(int indexX, int indexY) throws IllegalArgumentException
indexX
- The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.indexY
- The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public int binEntries(int indexX, int indexY)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public int binEntriesX(int indexX)
public int binEntriesY(int indexY)
public double binHeight(int indexX, int indexY)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double binHeightX(int indexX)
public double binHeightY(int indexY)
public double binError(int indexX, int indexY)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double binRms(int indexX, int indexY)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double meanX()
public double meanY()
public double rmsX()
public double rmsY()
public IAxis xAxis()
public IAxis yAxis()
public int coordToIndexX(double coordX)
IAxis.coordToIndex(double)
public int coordToIndexY(double coordY)
IAxis.coordToIndex(double)
public void add(IProfile2D h) throws IllegalArgumentException
IllegalArgumentException
- if the profile binnings are incompatible
|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |