hep.aida
Interface IProfile

All Superinterfaces:

IBaseHistogram

All Known Subinterfaces:

IProfile1D, IProfile2D

public interface IProfile

extends IBaseHistogram

User level interface to a Profile histogram

Author:

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

Method Summary

int	allEntries() Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.
int	extraEntries() Get the number of entries in the underflow and overflow bins.
double	maxBinHeight() Get the maximum height of the in-range bins.
double	minBinHeight() Get the minimum height of the in-range bins.
double	sumAllBinHeights() Get the sum of all the bins heights (including underflow and overflow bin).
double	sumBinHeights() Get the sum of in range bin heights in the IProfile.
double	sumExtraBinHeights() Get the sum of the underflow and overflow bin height.

Methods inherited from interface hep.aida.IBaseHistogram

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

Method Detail

allEntries

public int allEntries()

Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.

Returns:

The sum of all the entries.

extraEntries

public int extraEntries()

Get the number of entries in the underflow and overflow bins.

Returns:

The numer of entries in the out-of-range bins.

sumBinHeights

public double sumBinHeights()

Get the sum of in range bin heights in the IProfile.

Returns:

The sum of all the in-range bins heights.

sumAllBinHeights

public double sumAllBinHeights()

Get the sum of all the bins heights (including underflow and overflow bin).

Returns:

The sum of all the bins heights.

sumExtraBinHeights

public double sumExtraBinHeights()

Get the sum of the underflow and overflow bin height.

Returns:

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

minBinHeight

public double minBinHeight()

Get the minimum height of the in-range bins.

Returns:

The minimum height among the in-range bins.

maxBinHeight

public double maxBinHeight()

Get the maximum height of the in-range bins.

Returns:

The maximum height among the in-range bins.