|
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 1D Histogram.
Method Summary | |
void |
add(IHistogram1D hist)
Add to this IHistogram1D the contents of another IHistogram1D. |
IAxis |
axis()
Get the x axis of the IHistogram1D. |
int |
binEntries(int index)
Number of entries in the corresponding bin (ie the number of times fill was called for this bin). |
double |
binError(int index)
The error of a given bin. |
double |
binHeight(int index)
Total height of the corresponding bin (ie the sum of the weights in this bin). |
double |
binMean(int index)
The weighted mean of a bin. |
int |
coordToIndex(double coord)
Get the bin number corresponding to a given coordinate along the x axis. |
void |
fill(double x)
Fill the IHistogram1D with a value and the corresponding weight. |
void |
fill(double x,
double weight)
Fill the IHistogram1D with a value and the corresponding weight. |
double |
mean()
The mean of the whole IHistogram1D. |
double |
rms()
The RMS of the whole IHistogram1D. |
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) throws IllegalArgumentException
x
- The value to be filled in.
IllegalArgumentException
- If the weight is <0 or >1 (?).public void fill(double x, double weight) throws IllegalArgumentException
x
- The value to be filled in.weight
- The corresponding weight (by default 1).
IllegalArgumentException
- If the weight is <0 or >1 (?).public double binMean(int index) throws IllegalArgumentException
index
- The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If index is not a valid bin number.public int binEntries(int index) throws IllegalArgumentException
index
- The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If index is not a valid bin number.public double binHeight(int index) throws IllegalArgumentException
index
- The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If index is not a valid bin number.public double binError(int index) throws IllegalArgumentException
index
- The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
IllegalArgumentException
- If index is not a valid bin number.public double mean()
public double rms()
public IAxis axis()
public int coordToIndex(double coord)
coord
- The coordinalte along the x axis.
IAxis.coordToIndex(double)
public void add(IHistogram1D hist) throws IllegalArgumentException
hist
- The IHistogram1D to be added to this IHistogram1D.
IllegalArgumentException
- If the IHistogram1Ds binnings are incompatible.
|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |