hep.aida
public interface IHistogram2D extends IHistogram
Note All methods that accept a bin number as an argument will also accept the constants OVERFLOW or UNDERFLOW as the argument, and as a result give the contents of the resulting OVERFLOW or UNDERFLOW bin.
OVERFLOW, serialVersionUID, UNDERFLOW
Modifier and Type | Method and Description |
---|---|
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).
|
void |
fill(double x,
double y)
Fill the histogram with weight 1.
|
void |
fill(double x,
double y,
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.
|
int[] |
minMaxBins()
Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
|
IHistogram1D |
projectionX()
Create a projection parallel to the X axis.
|
IHistogram1D |
projectionY()
Create a projection parallel to the Y 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.
|
IHistogram1D |
sliceX(int indexY)
Slice parallel to the Y axis at bin indexY and one bin wide.
|
IHistogram1D |
sliceX(int indexY1,
int indexY2)
Create a slice parallel to the axis X axis, between "indexY1" and "indexY2" (inclusive).
|
IHistogram1D |
sliceY(int indexX)
Slice parallel to the X axis at bin indexX and one bin wide.
|
IHistogram1D |
sliceY(int indexX1,
int indexX2)
Create a slice parallel to the axis Y axis, between "indexX1" and "indexX2" (inclusive)
The returned IHistogram1D represents an instantaneous snapshot of the
histogram at the time the slice was created.
|
IAxis |
xAxis()
Return the X axis.
|
IAxis |
yAxis()
Return the Y axis.
|
allEntries, dimensions, entries, equivalentBinEntries, extraEntries, reset, sumAllBinHeights, sumBinHeights, sumExtraBinHeights, title
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.int binEntriesX(int indexX)
int binEntriesY(int indexY)
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.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.double binHeightX(int indexX)
double binHeightY(int indexY)
void fill(double x, double y)
void fill(double x, double y, double weight)
double meanX()
double meanY()
int[] minMaxBins()
IHistogram1D projectionX()
IHistogram1D projectionY()
double rmsX()
double rmsY()
IHistogram1D sliceX(int indexY)
IHistogram1D sliceX(int indexY1, int indexY2)
IHistogram1D sliceY(int indexX)
IHistogram1D sliceY(int indexX1, int indexX2)
IAxis xAxis()
IAxis yAxis()
Jump to the Colt Homepage