hep.aida.tfloat.ref
Class FloatHistogram2D

java.lang.Object
  hep.aida.tfloat.ref.FloatHistogram2D

All Implemented Interfaces:

FloatIHistogram, FloatIHistogram2D, Serializable

public class FloatHistogram2D
extends Object
implements FloatIHistogram2D

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.

Version:

1.0, 23/03/2000

Author:

Wolfgang Hoschek, Tony Johnson, and others.

See Also:

Serialized Form

Field Summary

Fields inherited from interface hep.aida.tfloat.FloatIHistogram

OVERFLOW, UNDERFLOW

Constructor Summary

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.

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).
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hep.aida.tfloat.FloatIHistogram2D

binEntriesX, binEntriesY, binHeightX, binHeightY, minMaxBins, projectionX, projectionY, sliceX, sliceX, sliceY, sliceY, xAxis, yAxis

Methods inherited from interface hep.aida.tfloat.FloatIHistogram

dimensions, entries, extraEntries, sumBinHeights, sumExtraBinHeights, title

Constructor Detail

FloatHistogram2D

public FloatHistogram2D(String title,
                        float[] xEdges,
                        float[] yEdges)

Creates a variable-width histogram. Example: xEdges = (0.2, 1.0, 5.0, 6.0), yEdges = (-5, 0, 7) yields 3*2 in-range bins.

Parameters:

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.

Throws:

IllegalArgumentException - if xEdges.length < 1 || yEdges.length < 1.

FloatHistogram2D

public FloatHistogram2D(String title,
                        int xBins,
                        float xMin,
                        float xMax,
                        int yBins,
                        float yMin,
                        float yMax)

Creates a fixed-width histogram.

Parameters:

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.

FloatHistogram2D

public FloatHistogram2D(String title,
                        FloatIAxis xAxis,
                        FloatIAxis yAxis)

Creates a histogram with the given axis binning.

Parameters:

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

allEntries

public int allEntries()

Description copied from interface: FloatIHistogram

Number of all entries in all (both in-range and under/overflow) bins in the histogram.

Specified by:

allEntries in interface FloatIHistogram

binEntries

public int binEntries(int indexX,
                      int indexY)

Description copied from interface: FloatIHistogram2D

The number of entries (ie the number of times fill was called for this bin).

Specified by:

binEntries in interface FloatIHistogram2D

Parameters:

indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.

indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

binError

public float binError(int indexX,
                      int indexY)

Description copied from interface: FloatIHistogram2D

The error on this bin.

Specified by:

binError in interface FloatIHistogram2D

Parameters:

indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.

indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

binHeight

public float binHeight(int indexX,
                       int indexY)

Description copied from interface: FloatIHistogram2D

Total height of the corresponding bin (ie the sum of the weights in this bin).

Specified by:

binHeight in interface FloatIHistogram2D

Parameters:

indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.

indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

equivalentBinEntries

public float equivalentBinEntries()

Description copied from interface: FloatIHistogram

Number of equivalent entries.

Specified by:

equivalentBinEntries in interface FloatIHistogram

Returns:

SUM[ weight ] ^ 2 / SUM[ weight^2 ].

fill

public void fill(float x,
                 float y)

Description copied from interface: FloatIHistogram2D

Fill the histogram with weight 1.

Specified by:

fill in interface FloatIHistogram2D

fill

public void fill(float x,
                 float y,
                 float weight)

Description copied from interface: FloatIHistogram2D

Fill the histogram with specified weight.

Specified by:

fill in interface FloatIHistogram2D

meanX

public float meanX()

Description copied from interface: FloatIHistogram2D

Returns the mean of the histogram, as calculated on filling-time projected on the X axis.

Specified by:

meanX in interface FloatIHistogram2D

meanY

public float meanY()

Description copied from interface: FloatIHistogram2D

Returns the mean of the histogram, as calculated on filling-time projected on the Y axis.

Specified by:

meanY in interface FloatIHistogram2D

reset

public void reset()

Description copied from interface: FloatIHistogram

Reset contents; as if just constructed.

Specified by:

reset in interface FloatIHistogram

rmsX

public float rmsX()

Description copied from interface: FloatIHistogram2D

Returns the rms of the histogram as calculated on filling-time projected on the X axis.

Specified by:

rmsX in interface FloatIHistogram2D

rmsY

public float rmsY()

Description copied from interface: FloatIHistogram2D

Returns the rms of the histogram as calculated on filling-time projected on the Y axis.

Specified by:

rmsY in interface FloatIHistogram2D

sumAllBinHeights

public float sumAllBinHeights()

Description copied from interface: FloatIHistogram

Sum of all (both in-range and under/overflow) bin heights in the histogram.

Specified by:

sumAllBinHeights in interface FloatIHistogram

binEntriesX

public int binEntriesX(int indexX)

Description copied from interface: FloatIHistogram2D

Equivalent to projectionX().binEntries(indexX).

Specified by:

binEntriesX in interface FloatIHistogram2D

binEntriesY

public int binEntriesY(int indexY)

Description copied from interface: FloatIHistogram2D

Equivalent to projectionY().binEntries(indexY).

Specified by:

binEntriesY in interface FloatIHistogram2D

binHeightX

public float binHeightX(int indexX)

Description copied from interface: FloatIHistogram2D

Equivalent to projectionX().binHeight(indexX).

Specified by:

binHeightX in interface FloatIHistogram2D

binHeightY

public float binHeightY(int indexY)

Description copied from interface: FloatIHistogram2D

Equivalent to projectionY().binHeight(indexY).

Specified by:

binHeightY in interface FloatIHistogram2D

dimensions

public int dimensions()

Description copied from interface: FloatIHistogram

Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.

Specified by:

dimensions in interface FloatIHistogram

entries

public int entries()

Description copied from interface: FloatIHistogram

Number of in-range entries in the histogram.

Specified by:

entries in interface FloatIHistogram

extraEntries

public int extraEntries()

Description copied from interface: FloatIHistogram

Number of under and overflow entries in the histogram.

Specified by:

extraEntries in interface FloatIHistogram

minMaxBins

public int[] minMaxBins()

Description copied from interface: FloatIHistogram2D

Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.

Specified by:

minMaxBins in interface FloatIHistogram2D

Returns:

{minBinX,minBinY, maxBinX,maxBinY}.

projectionX

public FloatIHistogram1D projectionX()

Description copied from interface: FloatIHistogram2D

Create a projection parallel to the X axis. Equivalent to sliceX(UNDERFLOW,OVERFLOW).

Specified by:

projectionX in interface FloatIHistogram2D

projectionY

public FloatIHistogram1D projectionY()

Description copied from interface: FloatIHistogram2D

Create a projection parallel to the Y axis. Equivalent to sliceY(UNDERFLOW,OVERFLOW).

Specified by:

projectionY in interface FloatIHistogram2D

sliceX

public FloatIHistogram1D sliceX(int indexY)

Description copied from interface: FloatIHistogram2D

Slice parallel to the Y axis at bin indexY and one bin wide. Equivalent to sliceX(indexY,indexY).

Specified by:

sliceX in interface FloatIHistogram2D

sliceX

public FloatIHistogram1D sliceX(int indexY1,
                                int indexY2)

Description copied from interface: FloatIHistogram2D

Create a slice parallel to the axis X axis, between "indexY1" and "indexY2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

Specified by:

sliceX in interface FloatIHistogram2D

sliceY

public FloatIHistogram1D sliceY(int indexX)

Description copied from interface: FloatIHistogram2D

Slice parallel to the X axis at bin indexX and one bin wide. Equivalent to sliceY(indexX,indexX).

Specified by:

sliceY in interface FloatIHistogram2D

sliceY

public FloatIHistogram1D sliceY(int indexX1,
                                int indexX2)

Description copied from interface: FloatIHistogram2D

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.

Specified by:

sliceY in interface FloatIHistogram2D

sumBinHeights

public float sumBinHeights()

Description copied from interface: FloatIHistogram

Sum of in-range bin heights in the histogram.

Specified by:

sumBinHeights in interface FloatIHistogram

sumExtraBinHeights

public float sumExtraBinHeights()

Description copied from interface: FloatIHistogram

Sum of under/overflow bin heights in the histogram.

Specified by:

sumExtraBinHeights in interface FloatIHistogram

xAxis

public FloatIAxis xAxis()

Description copied from interface: FloatIHistogram2D

Return the X axis.

Specified by:

xAxis in interface FloatIHistogram2D

yAxis

public FloatIAxis yAxis()

Description copied from interface: FloatIHistogram2D

Return the Y axis.

Specified by:

yAxis in interface FloatIHistogram2D

title

public String title()

Description copied from interface: FloatIHistogram

Title of the histogram (will be set only in the constructor).

Specified by:

title in interface FloatIHistogram