RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::ICloud3D Class Referenceabstract

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

#include <ICloud3D.h>

Inheritance diagram for AIDA::ICloud3D:
AIDA::ICloud AIDA::IBaseHistogram AIDA::ICloud3DROOT

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 IHistogram3Dhistogram () 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
nBinsXThe number of bins of the x axis.
lowerEdgeXThe lower edge of bins of the x axis.
upperEdgeXThe upper edge of bins of the x axis.
nBinsYThe number of bins of the y axis.
lowerEdgeYThe lower edge of bins of the y axis.
upperEdgeYThe upper edge of bins of the y axis.
nBinsZThe number of bins of the z axis.
lowerEdgeZThe lower edge of bins of the z axis.
upperEdgeZThe 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
xThe x value.
yThe y value.
zThe z value.
weightThe 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
histThe 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
binEdgesXThe bins edges of the x axis.
binEdgesYThe bins edges of the y axis.
binEdgesZThe 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.

Returns
The lower edge along the x axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::lowerEdgeY ( ) const
pure virtual

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

Returns
The lower edge along the y axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::lowerEdgeZ ( ) const
pure virtual

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

Returns
The lower edge along the z axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::meanX ( ) const
pure virtual

Get the mean of the ICloud3D along the x axis.

Returns
The mean along the x axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::meanY ( ) const
pure virtual

Get the mean of the ICloud3D along the y axis.

Returns
The mean along the y axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::meanZ ( ) const
pure virtual

Get the mean of the ICloud3D along the z axis.

Returns
The mean along the z axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::rmsX ( ) const
pure virtual

Get the RMS of the ICloud3D along the x axis.

Returns
The RMS along the x axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::rmsY ( ) const
pure virtual

Get the RMS of the ICloud3D along the y axis.

Returns
The RMS along the y axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::rmsZ ( ) const
pure virtual

Get the RMS of the ICloud3D along the z axis.

Returns
The RMS along the z axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::upperEdgeX ( ) const
pure virtual

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

Returns
The upper edge along the x axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::upperEdgeY ( ) const
pure virtual

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

Returns
The upper edge along the y axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::upperEdgeZ ( ) const
pure virtual

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

Returns
The upper edge along the z axis.

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::valueX ( int  index) const
pure virtual

Get the x value corresponding to a given entry.

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

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::valueY ( int  index) const
pure virtual

Get the y value corresponding to a given entry.

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

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::valueZ ( int  index) const
pure virtual

Get the z value corresponding to a given entry.

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

Implemented in AIDA::ICloud3DROOT.

virtual double AIDA::ICloud3D::weight ( int  index) const
pure virtual

Get the weight corresponding to a given entry.

Parameters
indexThe entry's index.
Returns
The weight of the index-th entry. If the ICloud3D has already been converted, 0 is returned.

Implemented in AIDA::ICloud3DROOT.


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