|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class for N-dimensional Histograms. One of the 4 fill/fillWeighted methods is called, depending on the dimension of the histogram. The split of these 4 fill/fillWeighted methods was done for performance reasons.
Fields inherited from interface hep.aida.IConstants |
OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR |
Method Summary | |
int |
allEntries()
Number of all entries in all (both in-range and under/overflow) bins in the histogram. |
IAnnotation |
annotation()
to be defined |
IAxis |
axis(int axis)
Returns the axis. |
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 on this bin. |
double |
binHeight(int[] index)
Total height of the corresponding bin (ie the sum of the weights in this bin). |
int |
dimension()
Returns the dimension of the histogram. |
int |
entries()
Number of in-range entries in the histogram. |
double |
equivalentBinEntries()
Number of equivalent entries. |
int |
extraEntries()
Number of under and overflow entries in the histogram. |
void |
fill(double x)
Fill histogram with weight 1. |
void |
fill(double[] x)
Fill histogram with weight 1. |
void |
fill(double x,
double y)
Fill histogram with weight 1. |
void |
fill(double x,
double y,
double z)
Fill histogram with weight 1. |
void |
fillWeighted(double[] x,
double weight)
Fill histogram with specified weight. |
void |
fillWeighted(double x,
double weight)
Fill histogram with specified weight. |
void |
fillWeighted(double x,
double y,
double weight)
Fill histogram with specified weight. |
void |
fillWeighted(double x,
double y,
double z,
double weight)
Fill histogram with specified weight. |
String |
label()
Label of the histogram (will be set only in the constructor). |
double |
maxBinHeight()
Maximum height of in-range bins in the histogram. |
double |
mean(int axis)
Returns the mean of the whole histogram as calculated on filling-time. |
double |
minBinHeight()
Minimum height of in-range bins in the histogram. |
void |
reset()
Reset contents; as if just constructed. |
double |
rms(int axis)
Returns the rms of the whole histogram as calculated on filling-time. |
double |
sumAllBinHeights()
Sum of all (both in-range and under/overflow) bin heights in the histogram. |
double |
sumBinHeights()
Sum of in-range bin heights in the histogram. |
double |
sumExtraBinHeights()
Sum of under/overflow bin heights in the histogram. |
Method Detail |
public void fill(double x)
public void fillWeighted(double x, double weight)
public void fill(double x, double y)
public void fillWeighted(double x, double y, double weight)
public void fill(double x, double y, double z)
public void fillWeighted(double x, double y, double z, double weight)
public void fill(double[] x)
public void fillWeighted(double[] x, double weight)
public String label()
public IAnnotation annotation()
public int dimension()
public void reset()
public int entries()
public int allEntries()
public int extraEntries()
public double equivalentBinEntries()
public double sumBinHeights()
public double sumAllBinHeights()
public double sumExtraBinHeights()
public double minBinHeight()
public double maxBinHeight()
public int binEntries(int[] index)
index
- the bin number (0...N-1) or OVERFLOW or UNDERFLOW.public double binHeight(int[] index)
index
- the bin number (0...N-1) or OVERFLOW or UNDERFLOW.public double binError(int[] index)
index
- the bin number (0...N-1) or OVERFLOW or UNDERFLOW.public double mean(int axis)
public double rms(int axis)
public IAxis axis(int axis)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |