User level interface to Histogram. More...

#include <IHistogram.h>

Inheritance diagram for AIDA::IHistogram:

Public Member Functions
virtual	~IHistogram ()
	Destructor.

virtual int	allEntries () const =0
	Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. More...

virtual int	extraEntries () const =0
	Number of entries in the UNDERFLOW and OVERFLOW bins. More...

virtual double	sumBinHeights () const =0
	Number of equivalent entries, i.e. More...

virtual double	sumAllBinHeights () const =0
	Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. More...

virtual double	sumExtraBinHeights () const =0
	Sum of heights in the UNDERFLOW and OVERFLOW bins. More...

virtual double	minBinHeight () const =0
	Minimum height of the in-range bins, i.e. More...

virtual double	maxBinHeight () const =0
	Maximum height of the in-range bins, i.e. More...

virtual bool	scale (double scaleFactor)=0
	Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor. 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 Histogram.

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

Member Function Documentation

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

pure virtual

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.

Returns: The sum of all the entries.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

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

pure virtual

Number of entries in the UNDERFLOW and OVERFLOW bins.

Returns: The number of entries outside the range of the IHistogram.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

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

pure virtual

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.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

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

pure virtual

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.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

virtual bool AIDA::IHistogram::scale ( double scaleFactor )

pure virtual

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.

Returns: false If the scale factor is negative.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

Referenced by AIDA::ICloud1DROOT::scale(), AIDA::ICloud2DROOT::scale(), and AIDA::ICloud3DROOT::scale().

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

pure virtual

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.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

Referenced by AIDA::ICloud1DROOT::sumOfWeights(), AIDA::ICloud2DROOT::sumOfWeights(), and AIDA::ICloud3DROOT::sumOfWeights().

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

pure virtual

Number of equivalent entries, i.e.

SUM[ weight ] ^ 2 / SUM[ weight^2 ]

Returns: The number of equivalent entries.virtual double equivalentBinEntries() const = 0; Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.; The sum of the in-range bins heights.

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

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

pure virtual

Sum of heights in the UNDERFLOW and OVERFLOW bins.

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

Implemented in AIDA::IHistogram3DROOT, AIDA::IHistogram2DROOT, and AIDA::IHistogram1DROOT.

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

IHistogram.h

Public Member Functions

Detailed Description

Member Function Documentation