AIDA::IProfile Class Reference

User level interface to a Profile histogram. More...

#include <IProfile.h>

Inheritance diagram for AIDA::IProfile:

Public Member Functions
virtual	~IProfile ()
	Destructor.
virtual int	allEntries () const =0
	Get the number or all the entries, both in range and underflow/overflow bins of the IProfile. More...
virtual int	extraEntries () const =0
	Get the number of entries in the underflow and overflow bins. More...
virtual double	sumBinHeights () const =0
	Get the sum of in range bin heights in the IProfile. More...
virtual double	sumAllBinHeights () const =0
	Get the sum of all the bins heights (including underflow and overflow bin). More...
virtual double	sumExtraBinHeights () const =0
	Get the sum of the underflow and overflow bin height. More...
virtual double	minBinHeight () const =0
	Get the minimum height of the in-range bins. More...
virtual double	maxBinHeight () const =0
	Get the maximum height of the in-range bins. More...
Public Member Functions inherited from AIDA::IBaseHistogram
virtual	~IBaseHistogram ()
	Destructor.
virtual std::string	title () const =0
	Get the Histogram's title. More...
virtual bool	setTitle (const std::string &title)=0
	Set the histogram title. More...
virtual int	dimension () const =0
	Get the IAnnotation associated with the Histogram. More...
virtual bool	reset ()=0
	Reset the Histogram; as if just created. More...
virtual int	entries () const =0
	Get the number of in-range entries in the Histogram. More...

Detailed Description

User level interface to a Profile histogram.

Author

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

Member Function Documentation

virtual int AIDA::IProfile::allEntries ( ) const

pure virtual

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

Returns

The sum of all the entries.

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual int AIDA::IProfile::extraEntries ( ) const

pure virtual

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

Returns

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

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual double AIDA::IProfile::maxBinHeight ( ) const

pure virtual

Get the maximum height of the in-range bins.

Returns

The maximum height among the in-range bins.

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual double AIDA::IProfile::minBinHeight ( ) const

pure virtual

Get the minimum height of the in-range bins.

Returns

The minimum height among the in-range bins.

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual double AIDA::IProfile::sumAllBinHeights ( ) const

pure virtual

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

Returns

The sum of all the bins heights.

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual double AIDA::IProfile::sumBinHeights ( ) const

pure virtual

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

Returns

The sum of all the in-range bins heights.

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

virtual double AIDA::IProfile::sumExtraBinHeights ( ) const

pure virtual

Get the sum of the underflow and overflow bin height.

Returns

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

Implemented in AIDA::IProfile2DROOT, and AIDA::IProfile1DROOT.

---

The documentation for this class was generated from the following file:

• IProfile.h