hep.aida.tfloat.ref

Class FloatFixedAxis

java.lang.Object

hep.aida.tfloat.ref.FloatFixedAxis

All Implemented Interfaces:

FloatIAxis, java.io.Serializable

public class FloatFixedAxis
extends java.lang.Object
implements FloatIAxis

Fixed-width axis; A reference implementation of hep.aida.IAxis.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FloatFixedAxis(int bins, float min, float max) Create an Axis

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatFixedAxis

public FloatFixedAxis(int bins,
                      float min,
                      float max)

Create an Axis

Parameters:

bins - Number of bins

min - Minimum for axis

max - Maximum for axis

Method Detail

binCentre

public float binCentre(int index)

Description copied from interface: FloatIAxis

Centre of the bin specified.

Specified by:

binCentre in interface FloatIAxis

Parameters:

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

binLowerEdge

public float binLowerEdge(int index)

Description copied from interface: FloatIAxis

Lower edge of the specified bin.

Specified by:

binLowerEdge in interface FloatIAxis

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

public int bins()

Description copied from interface: FloatIAxis

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

Specified by:

bins in interface FloatIAxis

binUpperEdge

public float binUpperEdge(int index)

Description copied from interface: FloatIAxis

Upper edge of the specified bin.

Specified by:

binUpperEdge in interface FloatIAxis

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

public float binWidth(int index)

Description copied from interface: FloatIAxis

Width of the bin specified.

Specified by:

binWidth in interface FloatIAxis

Parameters:

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

coordToIndex

public int coordToIndex(float coord)

Description copied from interface: FloatIAxis

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.

Specified by:

coordToIndex in interface FloatIAxis

lowerEdge

public float lowerEdge()

Description copied from interface: FloatIAxis

Lower axis edge.

Specified by:

lowerEdge in interface FloatIAxis

upperEdge

public float upperEdge()

Description copied from interface: FloatIAxis

Upper axis edge.

Specified by:

upperEdge in interface FloatIAxis