hep.aida.tfloat

Interface FloatIAxis

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FloatFixedAxis, FloatVariableAxis

public interface FloatIAxis
extends java.io.Serializable

An IAxis represents a binned histogram axis. A 1D Histogram would have one Axis representing the X axis, while a 2D Histogram would have two axes representing the X and Y Axis.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
float	binCentre(int index) Centre of the bin specified.
float	binLowerEdge(int index) Lower edge of the specified bin.
int	bins() The number of bins (excluding underflow and overflow) on the axis.
float	binUpperEdge(int index) Upper edge of the specified bin.
float	binWidth(int index) Width of the bin specified.
int	coordToIndex(float coord) Converts a coordinate on the axis to a bin number.
float	lowerEdge() Lower axis edge.
float	upperEdge() Upper axis edge.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

binCentre

float binCentre(int index)

Centre of the bin specified.

Parameters:

index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

binLowerEdge

float binLowerEdge(int index)

Lower edge of the specified bin.

Parameters:

index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

Returns:

the lower edge of the bin; for the underflow bin this is Float.NEGATIVE_INFINITY.

bins

int bins()

The number of bins (excluding underflow and overflow) on the axis.

binUpperEdge

float binUpperEdge(int index)

Upper edge of the specified bin.

Parameters:

index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

Returns:

the upper edge of the bin; for the overflow bin this is Float.POSITIVE_INFINITY.

binWidth

float binWidth(int index)

Width of the bin specified.

Parameters:

index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

coordToIndex

int coordToIndex(float coord)

Converts a coordinate on the axis to a bin number. If the coordinate is < lowerEdge returns UNDERFLOW, and if the coordinate is >= upperEdge returns OVERFLOW.

lowerEdge

float lowerEdge()

Lower axis edge.

upperEdge

float upperEdge()

Upper axis edge.