public class DoubleHistogram3D extends Object implements DoubleIHistogram3D
OVERFLOW, UNDERFLOW| Constructor and Description |
|---|
DoubleHistogram3D(String title,
double[] xEdges,
double[] yEdges,
double[] zEdges)
Creates a variable-width histogram.
|
DoubleHistogram3D(String title,
DoubleIAxis xAxis,
DoubleIAxis yAxis,
DoubleIAxis zAxis)
Creates a histogram with the given axis binning.
|
DoubleHistogram3D(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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
DoubleIHistogram2D |
projectionXY()
Create a projection parallel to the XY plane.
|
DoubleIHistogram2D |
projectionXZ()
Create a projection parallel to the XZ plane.
|
DoubleIHistogram2D |
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.
|
DoubleIHistogram2D |
sliceXY(int indexZ)
Create a slice parallel to the XY plane at bin indexZ and one bin wide.
|
DoubleIHistogram2D |
sliceXY(int indexZ1,
int indexZ2)
Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2"
(inclusive).
|
DoubleIHistogram2D |
sliceXZ(int indexY)
Create a slice parallel to the XZ plane at bin indexY and one bin wide.
|
DoubleIHistogram2D |
sliceXZ(int indexY1,
int indexY2)
Create a slice parallel to the XZ plane, between "indexY1" and "indexY2"
(inclusive).
|
DoubleIHistogram2D |
sliceYZ(int indexX)
Create a slice parallel to the YZ plane at bin indexX and one bin wide.
|
DoubleIHistogram2D |
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).
|
DoubleIAxis |
xAxis()
Return the X axis.
|
DoubleIAxis |
yAxis()
Return the Y axis.
|
DoubleIAxis |
zAxis()
Return the Z axis.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitminMaxBins, projectionXY, projectionXZ, projectionYZ, sliceXY, sliceXY, sliceXZ, sliceXZ, sliceYZ, sliceYZ, xAxis, yAxis, zAxisdimensions, entries, extraEntries, sumBinHeights, sumExtraBinHeights, titlepublic DoubleHistogram3D(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 DoubleHistogram3D(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 DoubleHistogram3D(String title, DoubleIAxis xAxis, DoubleIAxis yAxis, DoubleIAxis 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.public int allEntries()
DoubleIHistogramallEntries in interface DoubleIHistogrampublic int binEntries(int indexX,
int indexY,
int indexZ)
DoubleIHistogram3DbinEntries in interface DoubleIHistogram3DindexX - 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)
DoubleIHistogram3DbinError in interface DoubleIHistogram3DindexX - 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)
DoubleIHistogram3DbinHeight in interface DoubleIHistogram3DindexX - 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()
DoubleIHistogramequivalentBinEntries in interface DoubleIHistogrampublic void fill(double x,
double y,
double z)
DoubleIHistogram3Dfill in interface DoubleIHistogram3Dpublic void fill(double x,
double y,
double z,
double weight)
DoubleIHistogram3Dfill in interface DoubleIHistogram3Dpublic double meanX()
DoubleIHistogram3DmeanX in interface DoubleIHistogram3Dpublic double meanY()
DoubleIHistogram3DmeanY in interface DoubleIHistogram3Dpublic double meanZ()
DoubleIHistogram3DmeanZ in interface DoubleIHistogram3Dpublic void reset()
DoubleIHistogramreset in interface DoubleIHistogrampublic double rmsX()
DoubleIHistogram3DrmsX in interface DoubleIHistogram3Dpublic double rmsY()
DoubleIHistogram3DrmsY in interface DoubleIHistogram3Dpublic double rmsZ()
DoubleIHistogram3DrmsZ in interface DoubleIHistogram3Dpublic double sumAllBinHeights()
DoubleIHistogramsumAllBinHeights in interface DoubleIHistogrampublic int dimensions()
DoubleIHistogramdimensions in interface DoubleIHistogrampublic int entries()
DoubleIHistogramentries in interface DoubleIHistogrampublic int extraEntries()
DoubleIHistogramextraEntries in interface DoubleIHistogrampublic int[] minMaxBins()
DoubleIHistogram3DminMaxBins in interface DoubleIHistogram3Dpublic DoubleIHistogram2D projectionXY()
DoubleIHistogram3DprojectionXY in interface DoubleIHistogram3Dpublic DoubleIHistogram2D projectionXZ()
DoubleIHistogram3DprojectionXZ in interface DoubleIHistogram3Dpublic DoubleIHistogram2D projectionYZ()
DoubleIHistogram3DprojectionYZ in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceXY(int indexZ)
DoubleIHistogram3DsliceXY in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceXY(int indexZ1, int indexZ2)
DoubleIHistogram3DsliceXY in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceXZ(int indexY)
DoubleIHistogram3DsliceXZ in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceXZ(int indexY1, int indexY2)
DoubleIHistogram3DsliceXZ in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceYZ(int indexX)
DoubleIHistogram3DsliceYZ in interface DoubleIHistogram3Dpublic DoubleIHistogram2D sliceYZ(int indexX1, int indexX2)
DoubleIHistogram3DsliceYZ in interface DoubleIHistogram3Dpublic double sumBinHeights()
DoubleIHistogramsumBinHeights in interface DoubleIHistogrampublic double sumExtraBinHeights()
DoubleIHistogramsumExtraBinHeights in interface DoubleIHistogrampublic DoubleIAxis xAxis()
DoubleIHistogram3DxAxis in interface DoubleIHistogram3Dpublic DoubleIAxis yAxis()
DoubleIHistogram3DyAxis in interface DoubleIHistogram3Dpublic DoubleIAxis zAxis()
DoubleIHistogram3DzAxis in interface DoubleIHistogram3Dpublic String title()
DoubleIHistogramtitle in interface DoubleIHistogramJump to the Parallel Colt Homepage