---

IHistogram Class Reference

#include <IHistogram.h>

Inheritance diagram for IHistogram:

List of all members.

Public Types
enum	{ UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 }
	========================================================================== Underflow and overflow bins ========================================================================== Constant specifying the underflow and overflow bin (can be passed to any method expecting a bin index). More...
Public Methods
virtual std::string	title () const = 0
	========================================================================== Histogram characteristics ========================================================================== -------------------------------------------------------------------------- Title of the histogram (temporary functions, as the title will be part od the annotation, and there will be general accessors for any pair stored there).
virtual void	setTitle ( std::string value ) = 0
virtual int	dimensions () const = 0
	-------------------------------------------------------------------------- Number of dimensions (1 for 1D histogram, 2 for 2D histogram, etc.).
virtual void	reset () = 0
	-------------------------------------------------------------------------- Reset contents.
virtual int	entries () const = 0
	========================================================================== Total number of entries in the whole histogram (number of fills) ========================================================================== Number of in-range entries in the whole histogram.
virtual int	allEntries () const = 0
	Number of all entries in all (both in-range and extra) bins in the whole histogram.
virtual int	extraEntries () const = 0
	Number of extra entries in the whole histogram.
virtual double	equivalentBinEntries () const = 0
	Number of equivalent entries SUM[ weight ] ^ 2 / SUM[ weight^2 ].
virtual double	sumBinHeights () const = 0
	========================================================================== Sums of bin heights (height respects weights of entries) ========================================================================== Sum of in-range bin heights in the whole histogram.
virtual double	sumAllBinHeights () const = 0
	Sum of all (both in-range and extra) bin heights in the whole histogram.
virtual double	sumExtraBinHeights () const = 0
	Sum of extra bin heights in the whole histogram.

---

Member Enumeration Documentation

anonymous enum

========================================================================== Underflow and overflow bins ========================================================================== Constant specifying the underflow and overflow bin (can be passed to any method expecting a bin index). Enumeration values: UNDERFLOW_BIN   OVERFLOW_BIN   Definition at line 59 of file IHistogram.h.

---

Member Function Documentation

int IHistogram::allEntries ( ) const [pure virtual]

Number of all entries in all (both in-range and extra) bins in the whole histogram.

int IHistogram::dimensions ( ) const [pure virtual]

-------------------------------------------------------------------------- Number of dimensions (1 for 1D histogram, 2 for 2D histogram, etc.).

int IHistogram::entries ( ) const [pure virtual]

========================================================================== Total number of entries in the whole histogram (number of fills) ========================================================================== Number of in-range entries in the whole histogram.

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

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

int IHistogram::extraEntries ( ) const [pure virtual]

Number of extra entries in the whole histogram.

void IHistogram::reset ( ) [pure virtual]

-------------------------------------------------------------------------- Reset contents.

virtual void IHistogram::setTitle ( std::string value ) [pure virtual]

double IHistogram::sumAllBinHeights ( ) const [pure virtual]

Sum of all (both in-range and extra) bin heights in the whole histogram.

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

========================================================================== Sums of bin heights (height respects weights of entries) ========================================================================== Sum of in-range bin heights in the whole histogram.

double IHistogram::sumExtraBinHeights ( ) const [pure virtual]

Sum of extra bin heights in the whole histogram.

std::string IHistogram::title ( ) const [pure virtual]

========================================================================== Histogram characteristics ========================================================================== -------------------------------------------------------------------------- Title of the histogram (temporary functions, as the title will be part od the annotation, and there will be general accessors for any pair stored there).

---

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

• IHistogram.h

---