AIDA::IBaseHistogram Class Reference

class IAnnotation; More...

#include <IBaseHistogram.h>

Inheritance diagram for AIDA::IBaseHistogram:

Public Member Functions
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

class IAnnotation;

User level interface to Histogram. Provides the common functionality of the histogram-like classes.

Author

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

Member Function Documentation

virtual int AIDA::IBaseHistogram::dimension ( ) const

pure virtual

Get the IAnnotation associated with the Histogram.

Returns

The IAnnotation.virtual IAnnotation & annotation() = 0; virtual const IAnnotation & annotation() const = 0; Get the Histogram's dimension.

The Histogram's dimension.

Implemented in AIDA::IHistogram3DROOT, AIDA::ICloud3DROOT, AIDA::IProfile2DROOT, AIDA::ICloud2DROOT, AIDA::IHistogram2DROOT, AIDA::IProfile1DROOT, AIDA::ICloud1DROOT, and AIDA::IHistogram1DROOT.

virtual int AIDA::IBaseHistogram::entries ( ) const

pure virtual

Get the number of in-range entries in the Histogram.

Returns

The number of in-range entries.

Implemented in AIDA::IHistogram3DROOT, AIDA::ICloud3DROOT, AIDA::IProfile2DROOT, AIDA::ICloud2DROOT, AIDA::IHistogram2DROOT, AIDA::IProfile1DROOT, AIDA::ICloud1DROOT, and AIDA::IHistogram1DROOT.

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

virtual bool AIDA::IBaseHistogram::reset ( )

pure virtual

Reset the Histogram; as if just created.

Returns

false If something goes wrong.

Implemented in AIDA::IHistogram3DROOT, AIDA::ICloud3DROOT, AIDA::IProfile2DROOT, AIDA::ICloud2DROOT, AIDA::IHistogram2DROOT, AIDA::IProfile1DROOT, AIDA::ICloud1DROOT, and AIDA::IHistogram1DROOT.

virtual bool AIDA::IBaseHistogram::setTitle ( const std::string &  title )

pure virtual

Set the histogram title.

Parameters

title

The title.

Returns

false If title cannot be changed.

Implemented in AIDA::IHistogram3DROOT, AIDA::ICloud3DROOT, AIDA::IProfile2DROOT, AIDA::ICloud2DROOT, AIDA::IHistogram2DROOT, AIDA::IProfile1DROOT, AIDA::ICloud1DROOT, and AIDA::IHistogram1DROOT.

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

virtual std::string AIDA::IBaseHistogram::title ( ) const

pure virtual

Get the Histogram's title.

Returns

The Histogram's title.

Implemented in AIDA::IHistogram3DROOT, AIDA::ICloud3DROOT, AIDA::IProfile2DROOT, AIDA::ICloud2DROOT, AIDA::IHistogram2DROOT, AIDA::IProfile1DROOT, AIDA::ICloud1DROOT, and AIDA::IHistogram1DROOT.

Referenced by AIDA::IHistogramFactoryROOT::add(), AIDA::IHistogramFactoryROOT::createCopy(), AIDA::IHistogramFactoryROOT::divide(), AIDA::IHistogramFactoryROOT::multiply(), AIDA::IHistogramFactoryROOT::sliceX(), AIDA::IHistogramFactoryROOT::sliceXY(), AIDA::IHistogramFactoryROOT::sliceXZ(), AIDA::IHistogramFactoryROOT::sliceY(), AIDA::IHistogramFactoryROOT::sliceYZ(), AIDA::IHistogramFactoryROOT::subtract(), AIDA::ICloud1DROOT::title(), AIDA::ICloud2DROOT::title(), and AIDA::ICloud3DROOT::title().

---

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

• IBaseHistogram.h