Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::IHistogram Class Reference

#include <IHistogram.h>

Inheritance diagram for Anaphe::IHistogram:

Anaphe::IHistogram1D Anaphe::IHistogram2D Anaphe::IHistogram3D Anaphe::IProfileHistogram List of all members.

Public Types

enum  { UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 }
 Constant specifying the underflow and overflow bin (can be passed to any method expecting a bin index). More...


Public Methods

virtual ~IHistogram ()
virtual std::string title () const=0
 Title of the histogram (will be set only in the constructor).

virtual IAnnotationannotation ()=0
 Annotation of the histogram.

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
 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 = .

virtual double sumBinHeights () const=0
 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
 

Enumeration values:
UNDERFLOW_BIN 
OVERFLOW_BIN 


Constructor & Destructor Documentation

virtual Anaphe::IHistogram::~IHistogram   [inline, virtual]
 


Member Function Documentation

virtual int Anaphe::IHistogram::allEntries   const [pure virtual]
 

virtual IAnnotation* Anaphe::IHistogram::annotation   [pure virtual]
 

virtual int Anaphe::IHistogram::dimensions   const [pure virtual]
 

virtual int Anaphe::IHistogram::entries   const [pure virtual]
 

virtual double Anaphe::IHistogram::equivalentBinEntries   const [pure virtual]
 

virtual int Anaphe::IHistogram::extraEntries   const [pure virtual]
 

virtual void Anaphe::IHistogram::reset   [pure virtual]
 

virtual double Anaphe::IHistogram::sumAllBinHeights   const [pure virtual]
 

virtual double Anaphe::IHistogram::sumBinHeights   const [pure virtual]
 

virtual double Anaphe::IHistogram::sumExtraBinHeights   const [pure virtual]
 

virtual std::string Anaphe::IHistogram::title   const [pure virtual]
 


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

Anaphe documentation generated by Doxygen (www.doxygen.org)