AIDA::ICloud3DROOT Class Reference

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

#include <ICloud3DROOT.h>

Inheritance diagram for AIDA::ICloud3DROOT:

Public Member Functions
virtual	~ICloud3DROOT ()
	Destructor.
	ICloud3DROOT (const std::string &path, const std::string &title, int nMax, ITree *usedTree, const std::string &options="")
	Constructor.
	ICloud3DROOT (const std::string &path, ITree *usedTree, const ICloud3DROOT &cloud)
virtual bool	fill (double x, double y, double z, double weight=1.)
	Fill the ICloud3D with a triplet of values and a corresponding weight. More...
virtual double	lowerEdgeX () const
	Get the lower edge of the ICloud3D along the x axis. More...
virtual double	lowerEdgeY () const
	Get the lower edge of the ICloud3D along the y axis. More...
virtual double	lowerEdgeZ () const
	Get the lower edge of the ICloud3D along the z axis. More...
virtual double	upperEdgeX () const
	Get the upper edge of the ICloud3D along the x axis. More...
virtual double	upperEdgeY () const
	Get the upper edge of the ICloud3D along the y axis. More...
virtual double	upperEdgeZ () const
	Get the upper edge of the ICloud3D along the z axis. More...
virtual double	valueX (int index) const
	Get the x value corresponding to a given entry. More...
virtual double	valueY (int index) const
	Get the y value corresponding to a given entry. More...
virtual double	valueZ (int index) const
	Get the z value corresponding to a given entry. More...
virtual double	weight (int index) const
	Get the weight corresponding to a given entry. More...
virtual double	meanX () const
	Get the mean of the ICloud3D along the x axis. More...
virtual double	meanY () const
	Get the mean of the ICloud3D along the y axis. More...
virtual double	meanZ () const
	Get the mean of the ICloud3D along the z axis. More...
virtual double	rmsX () const
	Get the RMS of the ICloud3D along the x axis. More...
virtual double	rmsY () const
	Get the RMS of the ICloud3D along the y axis. More...
virtual double	rmsZ () const
	Get the RMS of the ICloud3D along the z axis. More...
virtual bool	convert (int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
	Convert internally the ICloud3D to an IHistogram3D with given number of bins, upper edge and lower edge. More...
virtual bool	myConvert (int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) const
virtual const IHistogram3D &	histogram () const
	Convert internally the ICloud3D to an IHistogram3D with given bin edges. More...
virtual bool	fillHistogram (IHistogram3D &hist) const
	Project the ICloud3D on an IHistogram3D. More...
virtual double	sumOfWeights () const
	Get the sum of weights of all the entries. More...
virtual bool	convertToHistogram ()
	Convert the ICloud to an IHistogram using the default number of bins. More...
virtual bool	myConvertToHistogram () const
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::ICloud3D
virtual	~ICloud3D ()
	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 3D Cloud.

Author

T. Kraemer, DESY

Version

Id:

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

Member Function Documentation

bool ICloud3DROOT::convert ( int  nBinsX, double  lowerEdgeX, double  upperEdgeX, int  nBinsY, double  lowerEdgeY, double  upperEdgeY, int  nBinsZ, double  lowerEdgeZ, double  upperEdgeZ  )

virtual

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

Parameters

nBinsX	The number of bins of the x axis.
lowerEdgeX	The lower edge of bins of the x axis.
upperEdgeX	The upper edge of bins of the x axis.
nBinsY	The number of bins of the y axis.
lowerEdgeY	The lower edge of bins of the y axis.
upperEdgeY	The upper edge of bins of the y axis.
nBinsZ	The number of bins of the z axis.
lowerEdgeZ	The lower edge of bins of the z axis.
upperEdgeZ	The upper edge of bins of the z axis.

Returns

false If the ICloud3D has already been converted.

Implements AIDA::ICloud3D.

Referenced by fill().

bool ICloud3DROOT::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.

int ICloud3DROOT::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 ICloud3DROOT::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 ICloud3DROOT::fill ( double  x, double  y, double  z, double  weight = 1.  )

virtual

Fill the ICloud3D with a triplet of values and a corresponding weight.

Parameters

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

Returns

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

Implements AIDA::ICloud3D.

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

bool ICloud3DROOT::fillHistogram ( IHistogram3D &  hist ) const

virtual

Project the ICloud3D on an IHistogram3D.

Parameters

hist	The IHistogram3D to be filled.

Returns

false If the ICloud3D is already converted.

Implements AIDA::ICloud3D.

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

const IHistogram3D & ICloud3DROOT::histogram ( ) const

virtual

Convert internally the ICloud3D to an IHistogram3D with given bin edges.

Parameters

binEdgesX	The bins edges of the x axis.
binEdgesY	The bins edges of the y axis.
binEdgesZ	The bins edges of the z axis.

Returns

false If the ICloud3D has already been converted.virtual bool convert(const std::vector<double> & binEdgesX, const std::vector<double> & binEdgesY, const std::vector<double> & binEdgesZ) ; Get the internal IHistogram3D in which the ICloud3D converted to.

The histogram. or because of a convert() method invocation.

Implements AIDA::ICloud3D.

bool ICloud3DROOT::isConverted ( ) const

virtual

Check if the ICloud has been converted to an IHistogram.

Returns

true if it has been converted.

Implements AIDA::ICloud.

double ICloud3DROOT::lowerEdgeX ( ) const

virtual

Get the lower edge of the ICloud3D along the x axis.

Returns

The lower edge along the x axis.

Implements AIDA::ICloud3D.

double ICloud3DROOT::lowerEdgeY ( ) const

virtual

Get the lower edge of the ICloud3D along the y axis.

Returns

The lower edge along the y axis.

Implements AIDA::ICloud3D.

double ICloud3DROOT::lowerEdgeZ ( ) const

virtual

Get the lower edge of the ICloud3D along the z axis.

Returns

The lower edge along the z axis.

Implements AIDA::ICloud3D.

int ICloud3DROOT::maxEntries ( ) const

virtual

Get the number of entries after which the cloud will be converted to an IHistogram.

Returns

The number of entries.

Implements AIDA::ICloud.

double ICloud3DROOT::meanX ( ) const

virtual

Get the mean of the ICloud3D along the x axis.

Returns

The mean along the x axis.

Implements AIDA::ICloud3D.

References AIDA::IHistogram3D::meanX(), and weight().

Referenced by rmsX().

double ICloud3DROOT::meanY ( ) const

virtual

Get the mean of the ICloud3D along the y axis.

Returns

The mean along the y axis.

Implements AIDA::ICloud3D.

References AIDA::IHistogram3D::meanY(), and weight().

Referenced by rmsY().

double ICloud3DROOT::meanZ ( ) const

virtual

Get the mean of the ICloud3D along the z axis.

Returns

The mean along the z axis.

Implements AIDA::ICloud3D.

References AIDA::IHistogram3D::meanZ(), and weight().

Referenced by rmsZ().

bool ICloud3DROOT::reset ( )

virtual

Reset the Histogram; as if just created.

Returns

false If something goes wrong.

Implements AIDA::IBaseHistogram.

double ICloud3DROOT::rmsX ( ) const

virtual

Get the RMS of the ICloud3D along the x axis.

Returns

The RMS along the x axis.

Implements AIDA::ICloud3D.

References meanX(), AIDA::IHistogram3D::rmsX(), and weight().

double ICloud3DROOT::rmsY ( ) const

virtual

Get the RMS of the ICloud3D along the y axis.

Returns

The RMS along the y axis.

Implements AIDA::ICloud3D.

References meanY(), AIDA::IHistogram3D::rmsY(), and weight().

double ICloud3DROOT::rmsZ ( ) const

virtual

Get the RMS of the ICloud3D along the z axis.

Returns

The RMS along the z axis.

Implements AIDA::ICloud3D.

References meanZ(), AIDA::IHistogram3D::rmsZ(), and weight().

bool ICloud3DROOT::scale ( double  scaleFactor )

virtual

Scale the weights by a given factor.

Parameters

scaleFactor

The scale factor.

Returns

false If a non-positive scale factor is provided.

Implements AIDA::ICloud.

References AIDA::ITree::cd(), AIDA::ITree::pwd(), AIDA::IHistogram::scale(), title(), and weight().

bool ICloud3DROOT::setTitle ( const std::string &  title )

virtual

Set the histogram title.

Parameters

title

The title.

Returns

false If title cannot be changed.

Implements AIDA::IBaseHistogram.

References AIDA::IBaseHistogram::setTitle().

double ICloud3DROOT::sumOfWeights ( ) const

virtual

Get the sum of weights of all the entries.

Returns

The sum of the weights of all the entries.

Implements AIDA::ICloud.

References AIDA::IHistogram::sumAllBinHeights(), and weight().

std::string ICloud3DROOT::title ( ) const

virtual

Get the Histogram's title.

Returns

The Histogram's title.

Implements AIDA::IBaseHistogram.

References AIDA::IBaseHistogram::title().

Referenced by scale().

double ICloud3DROOT::upperEdgeX ( ) const

virtual

Get the upper edge of the ICloud3D along the x axis.

Returns

The upper edge along the x axis.

Implements AIDA::ICloud3D.

double ICloud3DROOT::upperEdgeY ( ) const

virtual

Get the upper edge of the ICloud3D along the y axis.

Returns

The upper edge along the y axis.

Implements AIDA::ICloud3D.

double ICloud3DROOT::upperEdgeZ ( ) const

virtual

Get the upper edge of the ICloud3D along the z axis.

Returns

The upper edge along the z axis.

Implements AIDA::ICloud3D.

double ICloud3DROOT::valueX ( int  index ) const

virtual

Get the x value corresponding to a given entry.

Parameters

index

The entry's index.

Returns

The x value of the index-th entry. If the ICloud3D has already been converted, 0 is returned.

Implements AIDA::ICloud3D.

References weight().

double ICloud3DROOT::valueY ( int  index ) const

virtual

Get the y value corresponding to a given entry.

Parameters

index

The entry's index.

Returns

The y value of the index-th entry. If the ICloud3D has already been converted, 0 is returned.

Implements AIDA::ICloud3D.

References weight().

double ICloud3DROOT::valueZ ( int  index ) const

virtual

Get the z value corresponding to a given entry.

Parameters

index

The entry's index.

Returns

The z value of the index-th entry. If the ICloud3D has already been converted, 0 is returned.

Implements AIDA::ICloud3D.

References weight().

double ICloud3DROOT::weight ( int  index ) const

virtual

Get the weight corresponding to a given entry.

Parameters

index

The entry's index.

Returns

The weight of the index-th entry. If the ICloud3D has already been converted, 0 is returned.

Implements AIDA::ICloud3D.

Referenced by fill(), fillHistogram(), meanX(), meanY(), meanZ(), rmsX(), rmsY(), rmsZ(), scale(), sumOfWeights(), valueX(), valueY(), and valueZ().

---

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

• ICloud3DROOT.h
• ICloud3DROOT.cc