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

#include <ICloud1D.h>

Inheritance diagram for AIDA::ICloud1D:

Public Member Functions
virtual	~ICloud1D ()
	Destructor.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	scale (double scaleFactor)=0
	Scale the weights by a given factor. More...

Public Member Functions inherited from AIDA::IBaseHistogram
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

User level interface to a 1D Cloud.

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

Member Function Documentation

virtual bool AIDA::ICloud1D::convert	(	int	nBins,
		double	lowerEdge,
		double	upperEdge
	)

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

Implemented in AIDA::ICloud1DROOT.

virtual bool AIDA::ICloud1D::fill	(	double	x,
		double	weight = `1.`
	)

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

Implemented in AIDA::ICloud1DROOT.

virtual bool AIDA::ICloud1D::fillHistogram ( IHistogram1D & hist ) const

pure virtual

Project the ICloud1D on an IHistogram1D.

Parameters

hist	The IHistogram1D to be filled.

Returns: false If the ICloud1D is already converted.

Implemented in AIDA::ICloud1DROOT.

virtual const IHistogram1D& AIDA::ICloud1D::histogram ( ) const

pure 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) = 0; Get the internal IHistogram1D in which the ICloud1D converted to.; The histogram. or because of a convert() method invocation.

Implemented in AIDA::ICloud1DROOT.

virtual double AIDA::ICloud1D::lowerEdge ( ) const

pure virtual

Get the lower edge of the ICloud1D.