hep.aida.tfloat.ref

Class FloatVariableAxis

java.lang.Object

hep.aida.tfloat.ref.FloatVariableAxis

All Implemented Interfaces:

FloatIAxis, Serializable

public class FloatVariableAxis
extends Object
implements FloatIAxis

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

Version:

1.0, 23/03/2000

Author:

Wolfgang Hoschek, Tony Johnson, and others.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FloatVariableAxis(float[] edges) Constructs and returns an axis with the given bin edges.

Method Summary

Methods

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

FloatVariableAxis

public FloatVariableAxis(float[] edges)

Constructs and returns an axis with the given bin edges. Example: edges = (0.2, 1.0, 5.0) yields an axis with 2 in-range bins [0.2,1.0), [1.0,5.0) and 2 extra bins [-inf,0.2), [5.0,inf].

Parameters:

edges - the bin boundaries the partition shall have; must be sorted ascending and must not contain multiple identical elements.

Throws:

IllegalArgumentException - if edges.length < 1.

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