|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
User level interface to 3D Histogram.
Fields inherited from interface hep.aida.IConstants |
OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR |
Method Summary | |
void |
add(IHistogram3D h)
Modifies this histogram by adding the contents of h to it. |
double |
binCentreX(int indexX)
Centre along x, y or z of the corresponding bin. |
double |
binCentreY(int indexY)
|
double |
binCentreZ(int indexZ)
|
int |
binEntries(int indexX,
int indexY,
int indexZ)
The number of entries (ie the number of times fill was called for this bin). |
int |
binEntriesX(int indexX)
Equivalent to projectionXY().binEntriesX(indexX). |
int |
binEntriesY(int indexY)
Equivalent to projectionXY().binEntriesY(indexY). |
int |
binEntriesZ(int indexZ)
Equivalent to projectionXZ().binEntriesY(indexZ). |
double |
binError(int indexX,
int indexY,
int indexZ)
The error on this bin. |
double |
binHeight(int indexX,
int indexY,
int indexZ)
Total height of the corresponding bin (ie the sum of the weights in this bin). |
double |
binHeightX(int indexX)
Equivalent to projectionXY().binHeightX(indexX). |
double |
binHeightY(int indexY)
Equivalent to projectionXY().binHeightY(indexY). |
double |
binHeightZ(int indexZ)
Equivalent to projectionXZ().binHeightY(indexZ). |
int |
coordToIndexX(double coordX)
Convenience method, equivalent to xAxis().coordToIndex(coord). |
int |
coordToIndexY(double coordY)
Convenience method, equivalent to yAxis().coordToIndex(coord). |
int |
coordToIndexZ(double coordZ)
Convenience method, equivalent to zAxis().coordToIndex(coord). |
void |
fill(double x,
double y,
double z)
Fill the histogram with weight 1. |
void |
fill(double x,
double y,
double z,
double weight)
Fill the histogram with specified weight. |
double |
meanX()
Returns the mean of the histogram, as calculated on filling-time projected on the X axis. |
double |
meanY()
Returns the mean of the histogram, as calculated on filling-time projected on the Y axis. |
double |
meanZ()
Returns the mean of the histogram, as calculated on filling-time projected on the Z axis. |
double |
rmsX()
Returns the rms of the histogram as calculated on filling-time projected on the X axis. |
double |
rmsY()
Returns the rms of the histogram as calculated on filling-time projected on the Y axis. |
double |
rmsZ()
Returns the rms of the histogram as calculated on filling-time projected on the Z axis. |
IAxis |
xAxis()
Return the X axis. |
IAxis |
yAxis()
Return the Y axis. |
IAxis |
zAxis()
Return the Z axis. |
Methods inherited from interface hep.aida.IHistogram |
allEntries, annotation, dimension, entries, equivalentBinEntries, extraEntries, label, maxBinHeight, minBinHeight, reset, setLabel, sumAllBinHeights, sumBinHeights, sumExtraBinHeights, title |
Method Detail |
public void fill(double x, double y, double z)
public void fill(double x, double y, double z, double weight)
public double binCentreX(int indexX)
index
- the x (and y, z, resp.) bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.public double binCentreY(int indexY)
public double binCentreZ(int indexZ)
public int binEntries(int indexX, int indexY, int indexZ)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.indexZ
- the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.public int binEntriesX(int indexX)
public int binEntriesY(int indexY)
public int binEntriesZ(int indexZ)
public double binHeight(int indexX, int indexY, int indexZ)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.indexZ
- the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.public double binHeightX(int indexX)
public double binHeightY(int indexY)
public double binHeightZ(int indexZ)
public double binError(int indexX, int indexY, int indexZ)
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.indexZ
- the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.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 coordX)
IAxis.coordToIndex(double)
public int coordToIndexY(double coordY)
IAxis.coordToIndex(double)
public int coordToIndexZ(double coordZ)
IAxis.coordToIndex(double)
public void add(IHistogram3D h) throws IllegalArgumentException
h
- The histogram to be added to this histogramIllegalArgumentException
- if histogram binnings are incompatible
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |