|
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 3D Histogram.
Method Summary | |
void |
add(IHistogram3D hist)
Add to this IHistogram3D the contents of another IHistogram3D. |
int |
binEntries(int indexX,
int indexY,
int indexZ)
Number of entries in the corresponding bin (ie the number of times fill was called for this bin). |
int |
binEntriesX(int index)
Sum of all the entries of the bins along a given x bin. |
int |
binEntriesY(int index)
Sum of all the entries of the bins along a given y bin. |
int |
binEntriesZ(int index)
Sum of all the entries of the bins along a given z bin. |
double |
binError(int indexX,
int indexY,
int indexZ)
The error of a given bin. |
double |
binHeight(int indexX,
int indexY,
int indexZ)
Total height of a give bin (ie the sum of the weights in this bin). |
double |
binHeightX(int index)
Sum of all the heights of the bins along a given x bin. |
double |
binHeightY(int index)
Sum of all the heights of the bins along a given y bin. |
double |
binHeightZ(int index)
Sum of all the heights of the bins along a given z bin. |
double |
binMeanX(int indexX,
int indexY,
int indexZ)
The weighted mean along the x axis of a given bin. |
double |
binMeanY(int indexX,
int indexY,
int indexZ)
The weighted mean the y axis of a given bin. |
double |
binMeanZ(int indexX,
int indexY,
int indexZ)
The weighted mean the z axis of a given bin. |
int |
coordToIndexX(double coord)
Get the bin number corresponding to a given coordinate along the x axis. |
int |
coordToIndexY(double coord)
Get the bin number corresponding to a given coordinate along the y axis. |
int |
coordToIndexZ(double coord)
Get the bin number corresponding to a given coordinate along the z axis. |
void |
fill(double x,
double y,
double z)
Fill the IHistogram3D with a triplet of values and the corresponding weight. |
void |
fill(double x,
double y,
double z,
double weight)
Fill the IHistogram3D with a triplet of values and the corresponding weight. |
double |
meanX()
The mean of the IHistogram3D along the x axis. |
double |
meanY()
The mean of the IHistogram3D along the y axis. |
double |
meanZ()
The mean of the IHistogram3D along the z axis. |
double |
rmsX()
The RMS of the IHistogram3D along the x axis. |
double |
rmsY()
The RMS of the IHistogram3D along the y axis. |
double |
rmsZ()
The RMS of the IHistogram3D along the z axis. |
IAxis |
xAxis()
Get the x axis of the IHistogram3D. |
IAxis |
yAxis()
Get the y axis of the IHistogram3D. |
IAxis |
zAxis()
Get the z axis of the IHistogram3D. |
Methods inherited from interface hep.aida.IHistogram |
allEntries, equivalentBinEntries, extraEntries, maxBinHeight, minBinHeight, scale, 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
x
- The x value to be filled in.y
- The y value to be filled in.z
- The z value to be filled in.
IllegalArgumentException
- If the weight is <0 or >1 (?).public void fill(double x, double y, double z, double weight) throws IllegalArgumentException
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).
IllegalArgumentException
- If the weight is <0 or >1 (?).public double binMeanX(int indexX, int indexY, int indexZ) 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.indexZ
- The z 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, int indexZ) 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.indexZ
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public double binMeanZ(int indexX, int indexY, int indexZ) 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.indexZ
- The z 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, int indexZ) 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.indexZ
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public int binEntriesX(int index) throws IllegalArgumentException
index
- The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public int binEntriesY(int index) throws IllegalArgumentException
index
- The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public int binEntriesZ(int index) throws IllegalArgumentException
index
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public double binHeight(int indexX, int indexY, int indexZ) 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.indexZ
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public double binHeightX(int index) throws IllegalArgumentException
index
- The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public double binHeightY(int index) throws IllegalArgumentException
index
- The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public double binHeightZ(int index) throws IllegalArgumentException
index
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the index id not a valid bin number.public double binError(int indexX, int indexY, int indexZ) 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.indexZ
- The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If the indexes are not a valid bin number.public double meanX()
public double meanY()
public double meanZ()
public double rmsX()
public double rmsY()
public double rmsZ()
public IAxis xAxis()
public IAxis yAxis()
public IAxis zAxis()
public int coordToIndexX(double coord)
coord
- The coordinalte along the x axis.
IAxis.coordToIndex(double)
public int coordToIndexY(double coord)
coord
- The coordinalte along the y axis.
IAxis.coordToIndex(double)
public int coordToIndexZ(double coord)
coord
- The coordinalte along the z axis.
IAxis.coordToIndex(double)
public void add(IHistogram3D hist) throws IllegalArgumentException
hist
- The IHistogram3D to be added to this IHistogram3D.
IllegalArgumentException
- If the IHistogram3Ds binnings are incompatible.
|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |