public class FloatHistogram2D extends Object implements FloatIHistogram2D
OVERFLOW, UNDERFLOW| Constructor and Description |
|---|
FloatHistogram2D(String title,
float[] xEdges,
float[] yEdges)
Creates a variable-width histogram.
|
FloatHistogram2D(String title,
FloatIAxis xAxis,
FloatIAxis yAxis)
Creates a histogram with the given axis binning.
|
FloatHistogram2D(String title,
int xBins,
float xMin,
float xMax,
int yBins,
float yMin,
float yMax)
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)
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).
|
float |
binError(int indexX,
int indexY)
The error on this bin.
|
float |
binHeight(int indexX,
int indexY)
Total height of the corresponding bin (ie the sum of the weights in this
bin).
|
float |
binHeightX(int indexX)
Equivalent to projectionX().binHeight(indexX).
|
float |
binHeightY(int indexY)
Equivalent to projectionY().binHeight(indexY).
|
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)
Fill the histogram with weight 1.
|
void |
fill(float x,
float y,
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.
|
int[] |
minMaxBins()
Indexes of the in-range bins containing the smallest and largest
binHeight(), respectively.
|
FloatIHistogram1D |
projectionX()
Create a projection parallel to the X axis.
|
FloatIHistogram1D |
projectionY()
Create a projection parallel to the Y axis.
|
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.
|
FloatIHistogram1D |
sliceX(int indexY)
Slice parallel to the Y axis at bin indexY and one bin wide.
|
FloatIHistogram1D |
sliceX(int indexY1,
int indexY2)
Create a slice parallel to the axis X axis, between "indexY1" and
"indexY2" (inclusive).
|
FloatIHistogram1D |
sliceY(int indexX)
Slice parallel to the X axis at bin indexX and one bin wide.
|
FloatIHistogram1D |
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.
|
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.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbinEntriesX, binEntriesY, binHeightX, binHeightY, minMaxBins, projectionX, projectionY, sliceX, sliceX, sliceY, sliceY, xAxis, yAxisdimensions, entries, extraEntries, sumBinHeights, sumExtraBinHeights, titlepublic FloatHistogram2D(String title, float[] xEdges, float[] yEdges)
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.IllegalArgumentException - if xEdges.length < 1 || yEdges.length < 1.public FloatHistogram2D(String title, int xBins, float xMin, float xMax, int yBins, float yMin, float yMax)
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.public FloatHistogram2D(String title, FloatIAxis xAxis, FloatIAxis yAxis)
title - The histogram title.xAxis - The x-axis description to be used for binning.yAxis - The y-axis description to be used for binning.public int allEntries()
FloatIHistogramallEntries in interface FloatIHistogrampublic int binEntries(int indexX,
int indexY)
FloatIHistogram2DbinEntries in interface FloatIHistogram2DindexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public float binError(int indexX,
int indexY)
FloatIHistogram2DbinError in interface FloatIHistogram2DindexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public float binHeight(int indexX,
int indexY)
FloatIHistogram2DbinHeight in interface FloatIHistogram2DindexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public float equivalentBinEntries()
FloatIHistogramequivalentBinEntries in interface FloatIHistogrampublic void fill(float x,
float y)
FloatIHistogram2Dfill in interface FloatIHistogram2Dpublic void fill(float x,
float y,
float weight)
FloatIHistogram2Dfill in interface FloatIHistogram2Dpublic float meanX()
FloatIHistogram2DmeanX in interface FloatIHistogram2Dpublic float meanY()
FloatIHistogram2DmeanY in interface FloatIHistogram2Dpublic void reset()
FloatIHistogramreset in interface FloatIHistogrampublic float rmsX()
FloatIHistogram2DrmsX in interface FloatIHistogram2Dpublic float rmsY()
FloatIHistogram2DrmsY in interface FloatIHistogram2Dpublic float sumAllBinHeights()
FloatIHistogramsumAllBinHeights in interface FloatIHistogrampublic int binEntriesX(int indexX)
FloatIHistogram2DbinEntriesX in interface FloatIHistogram2Dpublic int binEntriesY(int indexY)
FloatIHistogram2DbinEntriesY in interface FloatIHistogram2Dpublic float binHeightX(int indexX)
FloatIHistogram2DbinHeightX in interface FloatIHistogram2Dpublic float binHeightY(int indexY)
FloatIHistogram2DbinHeightY in interface FloatIHistogram2Dpublic int dimensions()
FloatIHistogramdimensions in interface FloatIHistogrampublic int entries()
FloatIHistogramentries in interface FloatIHistogrampublic int extraEntries()
FloatIHistogramextraEntries in interface FloatIHistogrampublic int[] minMaxBins()
FloatIHistogram2DminMaxBins in interface FloatIHistogram2Dpublic FloatIHistogram1D projectionX()
FloatIHistogram2DprojectionX in interface FloatIHistogram2Dpublic FloatIHistogram1D projectionY()
FloatIHistogram2DprojectionY in interface FloatIHistogram2Dpublic FloatIHistogram1D sliceX(int indexY)
FloatIHistogram2DsliceX in interface FloatIHistogram2Dpublic FloatIHistogram1D sliceX(int indexY1, int indexY2)
FloatIHistogram2DsliceX in interface FloatIHistogram2Dpublic FloatIHistogram1D sliceY(int indexX)
FloatIHistogram2DsliceY in interface FloatIHistogram2Dpublic FloatIHistogram1D sliceY(int indexX1, int indexX2)
FloatIHistogram2DsliceY in interface FloatIHistogram2Dpublic float sumBinHeights()
FloatIHistogramsumBinHeights in interface FloatIHistogrampublic float sumExtraBinHeights()
FloatIHistogramsumExtraBinHeights in interface FloatIHistogrampublic FloatIAxis xAxis()
FloatIHistogram2DxAxis in interface FloatIHistogram2Dpublic FloatIAxis yAxis()
FloatIHistogram2DyAxis in interface FloatIHistogram2Dpublic String title()
FloatIHistogramtitle in interface FloatIHistogramJump to the Parallel Colt Homepage