CERN Accelerating science

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

AIDA::ICloud Class Reference

#include <ICloud.h>

Inheritance diagram for AIDA::ICloud::

AIDA::IBaseHistogram AIDA::ICloud1D AIDA::ICloud2D AIDA::ICloud3D List of all members.

Public Methods

virtual ~ICloud ()
 Destructor. More...

virtual double sumOfWeights () const=0
virtual bool convertToHistogram ()=0
virtual bool isConverted () const=0
virtual bool scale (double scaleFactor)=0

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/)

Definition at line 30 of file ICloud.h.


Constructor & Destructor Documentation

AIDA::ICloud::~ICloud ( ) [inline, virtual]
 

Definition at line 34 of file ICloud.h.


Member Function Documentation

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.

bool AIDA::ICloud::isConverted ( ) const [pure virtual]
 

Check if the ICloud has been converted to an IHistogram.

Returns:
true if it has been converted.

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.

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.


The documentation for this class was generated from the following file:
Generated at Tue Feb 18 15:48:24 2003 for AIDA_Interfaces by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001