hep.aida

Interface IHistogram

All Superinterfaces:

IBaseHistogram

All Known Subinterfaces:

IHistogram1D, IHistogram2D, IHistogram3D

All Known Implementing Classes:

H3D, Histogram, Histogram1D, Histogram2D, Histogram3D

public interface IHistogram
extends IBaseHistogram

User level interface to Histogram.

Method Summary

Modifier and Type	Method and Description
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.
double	minBinHeight() Minimum height of the in-range bins, i.e.
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

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

int extraEntries()

Number of entries in the UNDERFLOW and OVERFLOW bins.

Returns:

The number of entries outside the range of the IHistogram.

equivalentBinEntries

double equivalentBinEntries()

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

Returns:

The number of equivalent entries.

sumBinHeights

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

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

double sumExtraBinHeights()

Sum of heights in the UNDERFLOW and OVERFLOW bins.

Returns:

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

minBinHeight

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

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

void scale(double scaleFactor)
    throws java.lang.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:

java.lang.IllegalArgumentException - If the scale factor is negative.