CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IHistogram Class Reference

#include <IHistogram.h>

Inheritance diagram for AIDA::IHistogram::

List of all members.

Public Methods
virtual	~IHistogram ()
	Destructor. More...
virtual int	allEntries () const=0
virtual int	extraEntries () const=0
virtual double	equivalentBinEntries () const=0
virtual double	sumBinHeights () const=0
virtual double	sumAllBinHeights () const=0
virtual double	sumExtraBinHeights () const=0
virtual double	minBinHeight () const=0
virtual double	maxBinHeight () const=0
virtual bool	scale (double scaleFactor)=0

---

Detailed Description

User level interface to Histogram.

Author:

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

Definition at line 26 of file IHistogram.h.

---

Constructor & Destructor Documentation

AIDA::IHistogram::~IHistogram ( ) [inline, virtual]

Definition at line 30 of file IHistogram.h.

---

Member Function Documentation

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.

double AIDA::IHistogram::equivalentBinEntries ( ) const [pure virtual]

Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ] Returns: The number of equivalent entries.

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.

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.

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.

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.

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.

double AIDA::IHistogram::sumBinHeights ( ) const [pure virtual]

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

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.

---

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

• IHistogram.h

---