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

#include <ICloud3D.h>

Inheritance diagram for AIDA::ICloud3D:

Public Member Functions
virtual	~ICloud3D ()
	Destructor.

virtual bool	fill (double x, double y, double z, double weight=1.)=0
	Fill the ICloud3D with a triplet of values and a corresponding weight. More...

virtual double	lowerEdgeX () const =0
	Get the lower edge of the ICloud3D along the x axis. More...

virtual double	lowerEdgeY () const =0
	Get the lower edge of the ICloud3D along the y axis. More...

virtual double	lowerEdgeZ () const =0
	Get the lower edge of the ICloud3D along the z axis. More...

virtual double	upperEdgeX () const =0
	Get the upper edge of the ICloud3D along the x axis. More...

virtual double	upperEdgeY () const =0
	Get the upper edge of the ICloud3D along the y axis. More...

virtual double	upperEdgeZ () const =0
	Get the upper edge of the ICloud3D along the z axis. More...

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

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

virtual double	valueZ (int index) const =0
	Get the z 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	meanX () const =0
	Get the mean of the ICloud3D along the x axis. More...

virtual double	meanY () const =0
	Get the mean of the ICloud3D along the y axis. More...

virtual double	meanZ () const =0
	Get the mean of the ICloud3D along the z axis. More...

virtual double	rmsX () const =0
	Get the RMS of the ICloud3D along the x axis. More...

virtual double	rmsY () const =0
	Get the RMS of the ICloud3D along the y axis. More...

virtual double	rmsZ () const =0
	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)=0
	Convert internally the ICloud3D to an IHistogram3D with given number of bins, upper edge and lower edge. More...

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

virtual bool	fillHistogram (IHistogram3D &hist) const =0
	Project the ICloud3D on an IHistogram3D. 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 3D Cloud.

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

Member Function Documentation

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

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

Implemented in AIDA::ICloud3DROOT.

virtual bool AIDA::ICloud3D::fill	(	double	x,
		double	y,
		double	z,
		double	weight = `1.`
	)

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

Implemented in AIDA::ICloud3DROOT.

virtual bool AIDA::ICloud3D::fillHistogram ( IHistogram3D & hist ) const

pure virtual

Project the ICloud3D on an IHistogram3D.

Parameters

hist	The IHistogram3D to be filled.

Returns: false If the ICloud3D is already converted.

Implemented in AIDA::ICloud3DROOT.

virtual const IHistogram3D& AIDA::ICloud3D::histogram ( ) const

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

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::lowerEdgeX ( ) const

pure virtual

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