AIDA::ICloud Class Reference

User level interface to a Cloud. More...

#include <ICloud.h>

Inheritance diagram for AIDA::ICloud:

Public Member Functions
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 Cloud.

A Cloud is an unbinned collection of points. It can be used to represent scatter plots or dynamically rebinnable histograms. If they number of entries in the cloud exceeds some threshold they may be automatically converted to a binned histogram.

Author

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

Member Function Documentation

virtual bool AIDA::ICloud::convertToHistogram ( )

pure virtual

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

Returns

false If the ICloud has already been converted.

Implemented in AIDA::ICloud3DROOT, AIDA::ICloud2DROOT, and AIDA::ICloud1DROOT.

virtual bool AIDA::ICloud::isConverted ( ) const

pure virtual

Check if the ICloud has been converted to an IHistogram.

Returns

true if it has been converted.

Implemented in AIDA::ICloud3DROOT, AIDA::ICloud2DROOT, and AIDA::ICloud1DROOT.

virtual int AIDA::ICloud::maxEntries ( ) const

pure virtual

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

Returns

The number of entries.

Implemented in AIDA::ICloud3DROOT, AIDA::ICloud2DROOT, and AIDA::ICloud1DROOT.

Referenced by AIDA::IHistogramFactoryROOT::createCopy().

virtual bool AIDA::ICloud::scale ( double  scaleFactor )

pure virtual

Scale the weights by a given factor.

Parameters

scaleFactor

The scale factor.

Returns

false If a non-positive scale factor is provided.

Implemented in AIDA::ICloud3DROOT, AIDA::ICloud2DROOT, and AIDA::ICloud1DROOT.

virtual double AIDA::ICloud::sumOfWeights ( ) const

pure virtual

Get the sum of weights of all the entries.

Returns

The sum of the weights of all the entries.

Implemented in AIDA::ICloud3DROOT, AIDA::ICloud2DROOT, and AIDA::ICloud1DROOT.

---

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

• ICloud.h