hep.aida.dev
Interface IGristogram

public interface IGristogram

extends IConstants

Version:

2.0, 06-02-2001

Author:

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

Source Code:

IGristogram.java

Fields inherited from interface hep.aida.IConstants

OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR

Method Summary

IAnnotation	annotation() to be defined
IAxis	axis(int axis) Returns the axis.
double	binError(int[] index) The error on this bin.
double	binHeight(int[] index) Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
int	dimension() Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
String	label() Label of the histogram (will be set only in the constructor).
double	maxBinHeight() Maximum height of in-range bins in the histogram.
double	mean(int axis) Returns the mean of the whole histogram as calculated on filling-time.
double	minBinHeight() Minimum height of in-range bins in the histogram.
double	rms(int axis) Returns the rms of the whole histogram as calculated on filling-time.
double	sumAllBinHeights() Sum of all (both in-range and under/overflow) bin heights in the histogram.
double	sumBinHeights() Sum of in-range bin heights in the histogram.
double	sumExtraBinHeights() Sum of under/overflow bin heights in the histogram.

Method Detail

label

public String label()

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

annotation

public IAnnotation annotation()

to be defined

dimension

public int dimension()

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

sumBinHeights

public double sumBinHeights()

Sum of in-range bin heights in the histogram.

sumAllBinHeights

public double sumAllBinHeights()

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

sumExtraBinHeights

public double sumExtraBinHeights()

Sum of under/overflow bin heights in the histogram.

minBinHeight

public double minBinHeight()

Minimum height of in-range bins in the histogram.

maxBinHeight

public double maxBinHeight()

Maximum height of in-range bins in the histogram.

binHeight

public double binHeight(int[] index)

Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

Parameters:

index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

binError

public double binError(int[] index)

The error on this bin.

Parameters:

index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

mean

public double mean(int axis)

Returns the mean of the whole histogram as calculated on filling-time.

rms

public double rms(int axis)

Returns the rms of the whole histogram as calculated on filling-time.

axis

public IAxis axis(int axis)

Returns the axis.