|
Colt 1.2.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objecthep.aida.ref.Histogram
hep.aida.ref.AbstractHistogram3D
hep.aida.ref.Histogram3D
A reference implementation of hep.aida.IHistogram3D. The goal is to provide a clear implementation rather than the most efficient implementation. However, performance seems fine - filling 3 * 10^5 points/sec, both using FixedAxis or VariableAxis.
| Field Summary |
| Fields inherited from interface hep.aida.IHistogram |
OVERFLOW, serialVersionUID, UNDERFLOW |
| Constructor Summary | |
Histogram3D(String title,
double[] xEdges,
double[] yEdges,
double[] zEdges)
Creates a variable-width histogram. |
|
Histogram3D(String title,
IAxis xAxis,
IAxis yAxis,
IAxis zAxis)
Creates a histogram with the given axis binning. |
|
Histogram3D(String title,
int xBins,
double xMin,
double xMax,
int yBins,
double yMin,
double yMax,
int zBins,
double zMin,
double zMax)
Creates a fixed-width histogram. |
|
| Method Summary | |
int |
allEntries()
Number of all entries in all (both in-range and under/overflow) bins in the histogram. |
int |
binEntries(int indexX,
int indexY,
int indexZ)
The number of entries (ie the number of times fill was called for this bin). |
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). |
int |
dimensions()
Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on. |
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,
double y,
double z)
Fill the histogram with weight 1; equivalent to fill(x,y,z,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. |
int[] |
minMaxBins()
Indexes of the in-range bins containing the smallest and largest binHeight(), respectively. |
IHistogram2D |
projectionXY()
Create a projection parallel to the XY plane. |
IHistogram2D |
projectionXZ()
Create a projection parallel to the XZ plane. |
IHistogram2D |
projectionYZ()
Create a projection parallel to the YZ plane. |
void |
reset()
Reset contents; as if just constructed. |
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. |
IHistogram2D |
sliceXY(int indexZ)
Create a slice parallel to the XY plane at bin indexZ and one bin wide. |
IHistogram2D |
sliceXY(int indexZ1,
int indexZ2)
Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2" (inclusive). |
IHistogram2D |
sliceXZ(int indexY)
Create a slice parallel to the XZ plane at bin indexY and one bin wide. |
IHistogram2D |
sliceXZ(int indexY1,
int indexY2)
Create a slice parallel to the XZ plane, between "indexY1" and "indexY2" (inclusive). |
IHistogram2D |
sliceYZ(int indexX)
Create a slice parallel to the YZ plane at bin indexX and one bin wide. |
IHistogram2D |
sliceYZ(int indexX1,
int indexX2)
Create a slice parallel to the YZ plane, between "indexX1" and "indexX2" (inclusive). |
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. |
String |
title()
Title of the histogram (will be set only in the constructor). |
IAxis |
xAxis()
Return the X axis. |
IAxis |
yAxis()
Return the Y axis. |
IAxis |
zAxis()
Return the Z axis. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface hep.aida.IHistogram3D |
minMaxBins, projectionXY, projectionXZ, projectionYZ, sliceXY, sliceXY, sliceXZ, sliceXZ, sliceYZ, sliceYZ, xAxis, yAxis, zAxis |
| Methods inherited from interface hep.aida.IHistogram |
dimensions, entries, extraEntries, sumBinHeights, sumExtraBinHeights, title |
| Constructor Detail |
public Histogram3D(String title,
double[] xEdges,
double[] yEdges,
double[] zEdges)
title - The histogram title.xEdges - the bin boundaries the x-axis shall have;
must be sorted ascending and must not contain multiple identical elements.yEdges - the bin boundaries the y-axis shall have;
must be sorted ascending and must not contain multiple identical elements.zEdges - the bin boundaries the z-axis shall have;
must be sorted ascending and must not contain multiple identical elements.
IllegalArgumentException - if xEdges.length < 1 || yEdges.length < 1|| zEdges.length < 1.
public Histogram3D(String title,
int xBins,
double xMin,
double xMax,
int yBins,
double yMin,
double yMax,
int zBins,
double zMin,
double zMax)
title - The histogram title.xBins - The number of bins on the X axis.xMin - The minimum value on the X axis.xMax - The maximum value on the X axis.yBins - The number of bins on the Y axis.yMin - The minimum value on the Y axis.yMax - The maximum value on the Y axis.zBins - The number of bins on the Z axis.zMin - The minimum value on the Z axis.zMax - The maximum value on the Z axis.
public Histogram3D(String title,
IAxis xAxis,
IAxis yAxis,
IAxis zAxis)
title - The histogram title.xAxis - The x-axis description to be used for binning.yAxis - The y-axis description to be used for binning.zAxis - The z-axis description to be used for binning.| Method Detail |
public int allEntries()
IHistogram
allEntries in interface IHistogram
public int binEntries(int indexX,
int indexY,
int indexZ)
IHistogram3D
binEntries in interface IHistogram3DindexX - 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 binError(int indexX,
int indexY,
int indexZ)
IHistogram3D
binError in interface IHistogram3DindexX - 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 binHeight(int indexX,
int indexY,
int indexZ)
IHistogram3D
binHeight in interface IHistogram3DindexX - 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 equivalentBinEntries()
IHistogram
equivalentBinEntries in interface IHistogram
public void fill(double x,
double y,
double z)
IHistogram3D
fill in interface IHistogram3D
public void fill(double x,
double y,
double z,
double weight)
IHistogram3D
fill in interface IHistogram3Dpublic double meanX()
IHistogram3D
meanX in interface IHistogram3Dpublic double meanY()
IHistogram3D
meanY in interface IHistogram3Dpublic double meanZ()
IHistogram3D
meanZ in interface IHistogram3Dpublic void reset()
IHistogram
reset in interface IHistogrampublic double rmsX()
IHistogram3D
rmsX in interface IHistogram3Dpublic double rmsY()
IHistogram3D
rmsY in interface IHistogram3Dpublic double rmsZ()
IHistogram3D
rmsZ in interface IHistogram3Dpublic double sumAllBinHeights()
IHistogram
sumAllBinHeights in interface IHistogrampublic int dimensions()
IHistogram
dimensions in interface IHistogrampublic int entries()
IHistogram
entries in interface IHistogrampublic int extraEntries()
IHistogram
extraEntries in interface IHistogrampublic int[] minMaxBins()
IHistogram3D
minMaxBins in interface IHistogram3Dpublic IHistogram2D projectionXY()
IHistogram3D
projectionXY in interface IHistogram3Dpublic IHistogram2D projectionXZ()
IHistogram3D
projectionXZ in interface IHistogram3Dpublic IHistogram2D projectionYZ()
IHistogram3D
projectionYZ in interface IHistogram3Dpublic IHistogram2D sliceXY(int indexZ)
IHistogram3D
sliceXY in interface IHistogram3D
public IHistogram2D sliceXY(int indexZ1,
int indexZ2)
IHistogram3D
sliceXY in interface IHistogram3Dpublic IHistogram2D sliceXZ(int indexY)
IHistogram3D
sliceXZ in interface IHistogram3D
public IHistogram2D sliceXZ(int indexY1,
int indexY2)
IHistogram3D
sliceXZ in interface IHistogram3Dpublic IHistogram2D sliceYZ(int indexX)
IHistogram3D
sliceYZ in interface IHistogram3D
public IHistogram2D sliceYZ(int indexX1,
int indexX2)
IHistogram3D
sliceYZ in interface IHistogram3Dpublic double sumBinHeights()
IHistogram
sumBinHeights in interface IHistogrampublic double sumExtraBinHeights()
IHistogram
sumExtraBinHeights in interface IHistogrampublic IAxis xAxis()
IHistogram3D
xAxis in interface IHistogram3Dpublic IAxis yAxis()
IHistogram3D
yAxis in interface IHistogram3Dpublic IAxis zAxis()
IHistogram3D
zAxis in interface IHistogram3Dpublic String title()
IHistogram
title in interface IHistogram
|
Colt 1.2.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||