User level interface to a 1-dimensional profile histogram. More...

#include <IProfile1DROOT.h>

Inheritance diagram for AIDA::IProfile1DROOT:

Public Member Functions
virtual	~IProfile1DROOT ()
	Destructor.

	IProfile1DROOT ()
	constructor

	IProfile1DROOT (const std::string &name, const std::string &title, int nBins, double lowerEdge, double upperEdge, const std::string &options="")

	IProfile1DROOT (const std::string &name, const std::string &title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, const std::string &options="")

	IProfile1DROOT (const std::string &name, const std::string &title, const std::vector< double > &binEdges, const std::string &options="")

	IProfile1DROOT (const std::string &name, const std::string &title, const std::vector< double > &binEdges, double lowerValue, double upperValue, const std::string &options="")

	IProfile1DROOT (const std::string &name, const IProfile1DROOT &profile)

virtual bool	fill (double x, double y, double weight=1)
	Fill the IProfile1D.

virtual double	binMean (int index) const
	The weighted mean of the corresponding bin. More...

virtual int	binEntries (int index) const
	Number of entries in the corresponding bin (ie the number of times fill was called for this bin). More...

virtual double	binHeight (int index) const
	Total height of the corresponding bin (ie the sum of the weights in this bin). More...

virtual double	binError (int index) const
	The error on this bin. More...

virtual double	binRms (int index) const
	The spread (RMS) of a bin. More...

virtual double	mean () const
	Returns the mean of the whole profile as calculated on filling-time.

virtual double	rms () const
	Returns the rms of the whole profile as calculated on filling-time.

virtual const IAxis &	axis () const
	Returns the X axis.

virtual int	coordToIndex (double coord) const
	Convenience method, equivalent to `axis().coordToIndex(coord)`. More...

virtual int	allEntries () const
	Modifies this IProfile1D by adding the contents of profile to it. More...

virtual int	extraEntries () const
	Get the number of entries in the underflow and overflow bins. More...

virtual double	sumBinHeights () const
	Get the sum of in range bin heights in the IProfile. More...

virtual double	sumAllBinHeights () const
	Get the sum of all the bins heights (including underflow and overflow bin). More...

virtual double	sumExtraBinHeights () const
	Get the sum of the underflow and overflow bin height. More...

virtual double	minBinHeight () const
	Get the minimum height of the in-range bins. More...

virtual double	maxBinHeight () const
	Get the maximum height of the in-range bins. More...

virtual std::string	title () const
	Get the Histogram's title. More...

virtual bool	setTitle (const std::string &title)
	Set the histogram title. More...

virtual int	dimension () const
	Get the IAnnotation associated with the Histogram. More...

virtual bool	reset ()
	Reset the Histogram; as if just created. More...

virtual int	entries () const
	Get the number of in-range entries in the Histogram. More...

Public Member Functions inherited from AIDA::IProfile1D
virtual	~IProfile1D ()
	Destructor.

Public Member Functions inherited from AIDA::IProfile
virtual	~IProfile ()
	Destructor.

Public Member Functions inherited from AIDA::IBaseHistogram
virtual	~IBaseHistogram ()
	Destructor.

Detailed Description

User level interface to a 1-dimensional profile histogram.

Author: T. Kraemer, DESY

Version

Id:: IProfile1DROOT.h,v 1.7 2007-03-23 14:41:36 tkraemer Exp

Member Function Documentation

int IProfile1DROOT::allEntries ( ) const

virtual

Modifies this IProfile1D by adding the contents of profile to it.

Parameters

profile The IProfile1D to be added to this IProfile1D

Returns: false if profile binnings are incompatiblevirtual bool add(const IProfile1D & profile) ; Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.; The sum of all the entries.

Implements AIDA::IProfile.

int IProfile1DROOT::binEntries ( int index ) const

virtual

Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

Parameters

index the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile1D.

double IProfile1DROOT::binError ( int index ) const

virtual

The error on this bin.

Parameters

index the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile1D.

double IProfile1DROOT::binHeight ( int index ) const

virtual

Total height of the corresponding bin (ie the sum of the weights in this bin).

Parameters

index the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile1D.

double IProfile1DROOT::binMean ( int index ) const

virtual

The weighted mean of the corresponding bin.

Parameters

index the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Returns: The mean of the corresponding bin along the x axis.

Implements AIDA::IProfile1D.

double IProfile1DROOT::binRms ( int index ) const

virtual

The spread (RMS) of a bin.

Parameters

index the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

Implements AIDA::IProfile1D.

int IProfile1DROOT::coordToIndex ( double coord ) const

virtual

Convenience method, equivalent to axis().coordToIndex(coord).

See Also: IAxis::coordToIndex(double)

Implements AIDA::IProfile1D.

int IProfile1DROOT::dimension ( ) const

virtual

Get the IAnnotation associated with the Histogram.

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

Implements AIDA::IBaseHistogram.

int IProfile1DROOT::entries ( ) const

virtual

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