hep.aida
Interface IAxis

public interface IAxis

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.

Version:

$Id: IAxis.html,v 1.1 2002/10/08 00:51:17 tonyj Exp $

Author:

Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson, Andreas Pfeiffer, Mark Donszelmann, Guy Barrand

Source Code:

IAxis.java

Method Summary

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

Method Detail

lowerEdge

public double lowerEdge()

Lower axis edge.

upperEdge

public double upperEdge()

Upper axis edge.

bins

public int bins()

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

binLowerEdge

public double 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 Double.NEGATIVE_INFINITY.

binUpperEdge

public double 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 Double.POSITIVE_INFINITY.

binWidth

public double binWidth(int index)

Width of the bin specified.

Parameters:

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

coordToIndex

public int coordToIndex(double 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.