|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthep.aida.tdouble.ref.DoubleHistogram2D
public class DoubleHistogram2D
A reference implementation of hep.aida.IHistogram2D. The goal is to provide a clear implementation rather than the most efficient implementation. However, performance seems fine - filling 6 * 10^5 points/sec, both using FixedAxis or VariableAxis.
Field Summary |
---|
Fields inherited from interface hep.aida.tdouble.DoubleIHistogram |
---|
OVERFLOW, UNDERFLOW |
Constructor Summary | |
---|---|
DoubleHistogram2D(String title,
double[] xEdges,
double[] yEdges)
Creates a variable-width histogram. |
|
DoubleHistogram2D(String title,
DoubleIAxis xAxis,
DoubleIAxis yAxis)
Creates a histogram with the given axis binning. |
|
DoubleHistogram2D(String title,
int xBins,
double xMin,
double xMax,
int yBins,
double yMin,
double yMax)
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)
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). |
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)
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. |
DoubleIHistogram1D |
projectionX()
Create a projection parallel to the X axis. |
DoubleIHistogram1D |
projectionY()
Create a projection parallel to the Y axis. |
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. |
DoubleIHistogram1D |
sliceX(int indexY)
Slice parallel to the Y axis at bin indexY and one bin wide. |
DoubleIHistogram1D |
sliceX(int indexY1,
int indexY2)
Create a slice parallel to the axis X axis, between "indexY1" and "indexY2" (inclusive). |
DoubleIHistogram1D |
sliceY(int indexX)
Slice parallel to the X axis at bin indexX and one bin wide. |
DoubleIHistogram1D |
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. |
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface hep.aida.tdouble.DoubleIHistogram2D |
---|
binEntriesX, binEntriesY, binHeightX, binHeightY, minMaxBins, projectionX, projectionY, sliceX, sliceX, sliceY, sliceY, xAxis, yAxis |
Methods inherited from interface hep.aida.tdouble.DoubleIHistogram |
---|
dimensions, entries, extraEntries, sumBinHeights, sumExtraBinHeights, title |
Constructor Detail |
---|
public DoubleHistogram2D(String title, double[] xEdges, double[] 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 DoubleHistogram2D(String title, int xBins, double xMin, double xMax, int yBins, double yMin, double 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 DoubleHistogram2D(String title, DoubleIAxis xAxis, DoubleIAxis 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.Method Detail |
---|
public int allEntries()
DoubleIHistogram
allEntries
in interface DoubleIHistogram
public int binEntries(int indexX, int indexY)
DoubleIHistogram2D
binEntries
in interface DoubleIHistogram2D
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double binError(int indexX, int indexY)
DoubleIHistogram2D
binError
in interface DoubleIHistogram2D
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double binHeight(int indexX, int indexY)
DoubleIHistogram2D
binHeight
in interface DoubleIHistogram2D
indexX
- the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.indexY
- the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.public double equivalentBinEntries()
DoubleIHistogram
equivalentBinEntries
in interface DoubleIHistogram
public void fill(double x, double y)
DoubleIHistogram2D
fill
in interface DoubleIHistogram2D
public void fill(double x, double y, double weight)
DoubleIHistogram2D
fill
in interface DoubleIHistogram2D
public double meanX()
DoubleIHistogram2D
meanX
in interface DoubleIHistogram2D
public double meanY()
DoubleIHistogram2D
meanY
in interface DoubleIHistogram2D
public void reset()
DoubleIHistogram
reset
in interface DoubleIHistogram
public double rmsX()
DoubleIHistogram2D
rmsX
in interface DoubleIHistogram2D
public double rmsY()
DoubleIHistogram2D
rmsY
in interface DoubleIHistogram2D
public double sumAllBinHeights()
DoubleIHistogram
sumAllBinHeights
in interface DoubleIHistogram
public int binEntriesX(int indexX)
DoubleIHistogram2D
binEntriesX
in interface DoubleIHistogram2D
public int binEntriesY(int indexY)
DoubleIHistogram2D
binEntriesY
in interface DoubleIHistogram2D
public double binHeightX(int indexX)
DoubleIHistogram2D
binHeightX
in interface DoubleIHistogram2D
public double binHeightY(int indexY)
DoubleIHistogram2D
binHeightY
in interface DoubleIHistogram2D
public int dimensions()
DoubleIHistogram
dimensions
in interface DoubleIHistogram
public int entries()
DoubleIHistogram
entries
in interface DoubleIHistogram
public int extraEntries()
DoubleIHistogram
extraEntries
in interface DoubleIHistogram
public int[] minMaxBins()
DoubleIHistogram2D
minMaxBins
in interface DoubleIHistogram2D
public DoubleIHistogram1D projectionX()
DoubleIHistogram2D
projectionX
in interface DoubleIHistogram2D
public DoubleIHistogram1D projectionY()
DoubleIHistogram2D
projectionY
in interface DoubleIHistogram2D
public DoubleIHistogram1D sliceX(int indexY)
DoubleIHistogram2D
sliceX
in interface DoubleIHistogram2D
public DoubleIHistogram1D sliceX(int indexY1, int indexY2)
DoubleIHistogram2D
sliceX
in interface DoubleIHistogram2D
public DoubleIHistogram1D sliceY(int indexX)
DoubleIHistogram2D
sliceY
in interface DoubleIHistogram2D
public DoubleIHistogram1D sliceY(int indexX1, int indexX2)
DoubleIHistogram2D
sliceY
in interface DoubleIHistogram2D
public double sumBinHeights()
DoubleIHistogram
sumBinHeights
in interface DoubleIHistogram
public double sumExtraBinHeights()
DoubleIHistogram
sumExtraBinHeights
in interface DoubleIHistogram
public DoubleIAxis xAxis()
DoubleIHistogram2D
xAxis
in interface DoubleIHistogram2D
public DoubleIAxis yAxis()
DoubleIHistogram2D
yAxis
in interface DoubleIHistogram2D
public String title()
DoubleIHistogram
title
in interface DoubleIHistogram
|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |