hep.aida
Interface IHistogram

All Superinterfaces:

IBaseHistogram

All Known Subinterfaces:

IHistogram1D, IHistogram2D, IHistogram3D

public interface IHistogram

extends IBaseHistogram

User level interface to Histogram.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

int	allEntries() Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.
double	equivalentBinEntries() Number of equivalent entries, i.e.
int	extraEntries() Number of entries in the UNDERFLOW and OVERFLOW bins.
double	maxBinHeight() Maximum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.
double	minBinHeight() Minimum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.
void	scale(double scaleFactor) Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.
double	sumAllBinHeights() Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.
double	sumBinHeights() Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.
double	sumExtraBinHeights() Sum of heights in the UNDERFLOW and OVERFLOW bins.

Methods inherited from interface hep.aida.IBaseHistogram

annotation, dimension, entries, nanEntries, reset, setTitle, title

Method Detail

allEntries

public int allEntries()

Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. This is equivalent to the number of times the method fill was invoked, including the entries containing NaN.

Returns:

The sum of all the entries.

extraEntries

public int extraEntries()

Number of entries in the UNDERFLOW and OVERFLOW bins.

Returns:

The number of entries outside the range of the IHistogram.

equivalentBinEntries

public double equivalentBinEntries()

Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ]

Returns:

The number of equivalent entries.

sumBinHeights

public double sumBinHeights()

Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.

Returns:

The sum of the in-range bins heights.

sumAllBinHeights

public double sumAllBinHeights()

Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.

Returns:

The sum of all the bins heights.

sumExtraBinHeights

public double sumExtraBinHeights()

Sum of heights in the UNDERFLOW and OVERFLOW bins.

Returns:

The sum of the heights of the out-of-range bins.

minBinHeight

public double minBinHeight()

Minimum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.

Returns:

The minimum height among the in-range bins.

maxBinHeight

public double maxBinHeight()

Maximum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.

Returns:

The maximum height among the in-range bins.

scale

public void scale(double scaleFactor)
           throws IllegalArgumentException

Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.

Parameters:

scaleFactor - The scale factor.

Throws:

IllegalArgumentException - If the scale factor is negative.