User level interface to a 1D Cloud. More...

#include <ICloud1DROOT.h>

Inheritance diagram for AIDA::ICloud1DROOT:

Public Member Functions
virtual	~ICloud1DROOT ()
	Destructor.

	ICloud1DROOT (const std::string &path, const std::string &title, int nMax, ITree *usedTree, const std::string &options="")
	Constructor.

	ICloud1DROOT (const std::string &path, ITree *usedTree, const ICloud1DROOT &cloud)

virtual bool	fill (double x, double weight=1.)
	Fill the ICloud1D with a value and a corresponding weight. More...

virtual double	lowerEdge () const
	Get the lower edge of the ICloud1D. More...

virtual double	upperEdge () const
	Get the upper edge of the ICloud1D. More...

virtual double	value (int index) const
	Get the value corresponding to a given entry. More...

virtual double	weight (int index) const
	Get the weight corresponding to a given entry. More...

virtual double	mean () const
	Get the mean of the ICloud1D. More...

virtual double	rms () const
	Get the RMS of the ICloud1D. More...

virtual bool	myConvert (int nBins, double lowerEdge, double upperEdge) const
	Convert internally the ICloud1D to an IHistogram1D with given number of bins, upper edge and lower edge. More...

virtual bool	convert (int nBins, double lowerEdge, double upperEdge)
	Convert internally the ICloud1D to an IHistogram1D with given number of bins, upper edge and lower edge. More...

virtual const IHistogram1D &	histogram () const
	Convert internally the ICloud1D to an IHistogram1D with given bin edges. More...

virtual bool	fillHistogram (IHistogram1D &hist) const
	Project the ICloud1D on an IHistogram1D. More...

virtual double	sumOfWeights () const
	Get the sum of weights of all the entries. More...

virtual bool	myConvertToHistogram () const
	Convert the ICloud to an IHistogram using the default number of bins. More...

virtual bool	convertToHistogram ()
	Convert the ICloud to an IHistogram using the default number of bins. More...

virtual bool	isConverted () const
	Check if the ICloud has been converted to an IHistogram. More...

virtual int	maxEntries () const
	Get the number of entries after which the cloud will be converted to an IHistogram. More...

virtual bool	scale (double scaleFactor)
	Scale the weights by a given factor. 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::ICloud1D
virtual	~ICloud1D ()
	Destructor.

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

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

Detailed Description

User level interface to a 1D Cloud.

Author: T. Kraemer, DESY

Version

Id:: ICloud1DROOT.h,v 1.3 2006-12-04 17:24:06 tkraemer Exp

Member Function Documentation

bool ICloud1DROOT::convert	(	int	nBins,
		double	lowerEdge,
		double	upperEdge
	)

virtual

Convert internally the ICloud1D to an IHistogram1D with given number of bins, upper edge and lower edge.

Parameters

nBins	The number of bins.
lowerEdge	The lower edge.
upperEdge	The upper edge.

Returns: false If the ICloud1D has already been converted.

Implements AIDA::ICloud1D.

References myConvert().

Referenced by fill().

bool ICloud1DROOT::convertToHistogram ( )

virtual

Convert the ICloud to an IHistogram using the default number of bins.

Returns: false If the ICloud has already been converted.

Implements AIDA::ICloud.

References myConvertToHistogram().

int ICloud1DROOT::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 ICloud1DROOT::entries ( ) const

virtual

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

Returns: The number of in-range entries.

Implements AIDA::IBaseHistogram.

References AIDA::IBaseHistogram::entries().

bool ICloud1DROOT::fill	(	double	x,
		double	weight = `1.`
	)

virtual

Fill the ICloud1D with a value and a corresponding weight.

Parameters

x	The value.
weight	The corresponding weight. By default it is 1.

Returns: false If the ICloud1D is full, if the weight's value is is not between 0 and 1.

Implements AIDA::ICloud1D.

References convert(), AIDA::IHistogram1D::fill(), and weight().

bool ICloud1DROOT::fillHistogram ( IHistogram1D & hist ) const

virtual

Project the ICloud1D on an IHistogram1D.

Parameters

hist	The IHistogram1D to be filled.

Returns: false If the ICloud1D is already converted.

Implements AIDA::ICloud1D.

References AIDA::IHistogram1D::fill(), and weight().

const IHistogram1D & ICloud1DROOT::histogram ( ) const

virtual

Convert internally the ICloud1D to an IHistogram1D with given bin edges.

Parameters

binEdges The bins edges.

Returns: false If the ICloud1D has already been converted.virtual bool convert(const std::vector<double> & binEdges) ; Get the internal IHistogram1D in which the ICloud1D converted to.; The histogram. or because of a convert() method invocation.

Implements AIDA::ICloud1D.

References myConvertToHistogram().

bool ICloud1DROOT::isConverted ( ) const

virtual

Check if the ICloud has been converted to an IHistogram.