public class FloatHistogram3D extends Object implements FloatIHistogram3D
OVERFLOW, UNDERFLOW| Constructor and Description |
|---|
FloatHistogram3D(String title,
float[] xEdges,
float[] yEdges,
float[] zEdges)
Creates a variable-width histogram.
|
FloatHistogram3D(String title,
FloatIAxis xAxis,
FloatIAxis yAxis,
FloatIAxis zAxis)
Creates a histogram with the given axis binning.
|
FloatHistogram3D(String title,
int xBins,
float xMin,
float xMax,
int yBins,
float yMin,
float yMax,
int zBins,
float zMin,
float 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).
|
float |
binError(int indexX,
int indexY,
int indexZ)
The error on this bin.
|
float |
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.
|
float |
equivalentBinEntries()
Number of equivalent entries.
|
int |
extraEntries()
Number of under and overflow entries in the histogram.
|
void |
fill(float x,
float y,
float z)
Fill the histogram with weight 1; equivalent to fill(x,y,z,1)..
|
void |
fill(float x,
float y,
float z,
float weight)
Fill the histogram with specified weight.
|
float |
meanX()
Returns the mean of the histogram, as calculated on filling-time
projected on the X axis.
|
float |
meanY()
Returns the mean of the histogram, as calculated on filling-time
projected on the Y axis.
|
float |
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.
|
FloatIHistogram2D |
projectionXY()
Create a projection parallel to the XY plane.
|
FloatIHistogram2D |
projectionXZ()
Create a projection parallel to the XZ plane.
|
FloatIHistogram2D |
projectionYZ()
Create a projection parallel to the YZ plane.
|
void |
reset()
Reset contents; as if just constructed.
|
float |
rmsX()
Returns the rms of the histogram as calculated on filling-time projected
on the X axis.
|
float |
rmsY()
Returns the rms of the histogram as calculated on filling-time projected
on the Y axis.
|
float |
rmsZ()
Returns the rms of the histogram as calculated on filling-time projected
on the Z axis.
|
FloatIHistogram2D |
sliceXY(int indexZ)
Create a slice parallel to the XY plane at bin indexZ and one bin wide.
|
FloatIHistogram2D |
sliceXY(int indexZ1,
int indexZ2)
Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2"
(inclusive).
|
FloatIHistogram2D |
sliceXZ(int indexY)
Create a slice parallel to the XZ plane at bin indexY and one bin wide.
|
FloatIHistogram2D |
sliceXZ(int indexY1,
int indexY2)
Create a slice parallel to the XZ plane, between "indexY1" and "indexY2"
(inclusive).
|
FloatIHistogram2D |
sliceYZ(int indexX)
Create a slice parallel to the YZ plane at bin indexX and one bin wide.
|
FloatIHistogram2D |
sliceYZ(int indexX1,
int indexX2)
Create a slice parallel to the YZ plane, between "indexX1" and "indexX2"
(inclusive).
|
float |
sumAllBinHeights()
Sum of all (both in-range and under/overflow) bin heights in the
histogram.
|
float |
sumBinHeights()
Sum of in-range bin heights in the histogram.
|
float |
sumExtraBinHeights()
Sum of under/overflow bin heights in the histogram.
|
String |
title()
Title of the histogram (will be set only in the constructor).
|
FloatIAxis |
xAxis()
Return the X axis.
|
FloatIAxis |
yAxis()
Return the Y axis.
|
FloatIAxis |
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 FloatHistogram3D(String title, float[] xEdges, float[] yEdges, float[] 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 FloatHistogram3D(String title, int xBins, float xMin, float xMax, int yBins, float yMin, float yMax, int zBins, float zMin, float 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 FloatHistogram3D(String title, FloatIAxis xAxis, FloatIAxis yAxis, FloatIAxis 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()
FloatIHistogramallEntries in interface FloatIHistogrampublic int binEntries(int indexX,
int indexY,
int indexZ)
FloatIHistogram3DbinEntries in interface FloatIHistogram3DindexX - 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 float binError(int indexX,
int indexY,
int indexZ)
FloatIHistogram3DbinError in interface FloatIHistogram3DindexX - 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 float binHeight(int indexX,
int indexY,
int indexZ)
FloatIHistogram3DbinHeight in interface FloatIHistogram3DindexX - 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 float equivalentBinEntries()
FloatIHistogramequivalentBinEntries in interface FloatIHistogrampublic void fill(float x,
float y,
float z)
FloatIHistogram3Dfill in interface FloatIHistogram3Dpublic void fill(float x,
float y,
float z,
float weight)
FloatIHistogram3Dfill in interface FloatIHistogram3Dpublic float meanX()
FloatIHistogram3DmeanX in interface FloatIHistogram3Dpublic float meanY()
FloatIHistogram3DmeanY in interface FloatIHistogram3Dpublic float meanZ()
FloatIHistogram3DmeanZ in interface FloatIHistogram3Dpublic void reset()
FloatIHistogramreset in interface FloatIHistogrampublic float rmsX()
FloatIHistogram3DrmsX in interface FloatIHistogram3Dpublic float rmsY()
FloatIHistogram3DrmsY in interface FloatIHistogram3Dpublic float rmsZ()
FloatIHistogram3DrmsZ in interface FloatIHistogram3Dpublic float sumAllBinHeights()
FloatIHistogramsumAllBinHeights in interface FloatIHistogrampublic int dimensions()
FloatIHistogramdimensions in interface FloatIHistogrampublic int entries()
FloatIHistogramentries in interface FloatIHistogrampublic int extraEntries()
FloatIHistogramextraEntries in interface FloatIHistogrampublic int[] minMaxBins()
FloatIHistogram3DminMaxBins in interface FloatIHistogram3Dpublic FloatIHistogram2D projectionXY()
FloatIHistogram3DprojectionXY in interface FloatIHistogram3Dpublic FloatIHistogram2D projectionXZ()
FloatIHistogram3DprojectionXZ in interface FloatIHistogram3Dpublic FloatIHistogram2D projectionYZ()
FloatIHistogram3DprojectionYZ in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceXY(int indexZ)
FloatIHistogram3DsliceXY in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceXY(int indexZ1, int indexZ2)
FloatIHistogram3DsliceXY in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceXZ(int indexY)
FloatIHistogram3DsliceXZ in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceXZ(int indexY1, int indexY2)
FloatIHistogram3DsliceXZ in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceYZ(int indexX)
FloatIHistogram3DsliceYZ in interface FloatIHistogram3Dpublic FloatIHistogram2D sliceYZ(int indexX1, int indexX2)
FloatIHistogram3DsliceYZ in interface FloatIHistogram3Dpublic float sumBinHeights()
FloatIHistogramsumBinHeights in interface FloatIHistogrampublic float sumExtraBinHeights()
FloatIHistogramsumExtraBinHeights in interface FloatIHistogrampublic FloatIAxis xAxis()
FloatIHistogram3DxAxis in interface FloatIHistogram3Dpublic FloatIAxis yAxis()
FloatIHistogram3DyAxis in interface FloatIHistogram3Dpublic FloatIAxis zAxis()
FloatIHistogram3DzAxis in interface FloatIHistogram3Dpublic String title()
FloatIHistogramtitle in interface FloatIHistogramJump to the Parallel Colt Homepage