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::ICloud2D Class Reference

#include <ICloud2D.h>

Inheritance diagram for AIDA::ICloud2D::

AIDA::ICloud AIDA::IBaseHistogram List of all members.

Public Methods

virtual ~ICloud2D ()
 Destructor. More...

virtual bool fill (double x, double y, double weight=1.)=0
virtual double lowerEdgeX () const=0
virtual double lowerEdgeY () const=0
virtual double upperEdgeX () const=0
virtual double upperEdgeY () const=0
virtual double valueX (int index) const=0
virtual double valueY (int index) const=0
virtual double weight (int index) const=0
virtual double meanX () const=0
virtual double meanY () const=0
virtual double rmsX () const=0
virtual double rmsY () const=0
virtual bool convert (int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)=0
virtual bool convert (const std::vector< double > &binEdgesX, const std::vector< double > &binEdgesY)=0
virtual const IHistogram2D& histogram () const=0
virtual bool fillHistogram (IHistogram2D &hist) const=0

Detailed Description

User level interface to a 2D Cloud.

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

Definition at line 30 of file ICloud2D.h.

Constructor & Destructor Documentation

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

Definition at line 34 of file ICloud2D.h.

Member Function Documentation

bool AIDA::ICloud2D::convert ( const std::vector< double > & binEdgesX,
const std::vector< double > & binEdgesY ) [pure virtual]
 

Convert internally the ICloud2D to an IHistogram2D with given bin edges.

Parameters:
binEdgesX   The bins edges of the x axis.
binEdgesY   The bins edges of the y axis.
Returns:
false If the ICloud2D has already been converted.

bool AIDA::ICloud2D::convert ( int nBinsX,
double lowerEdgeX,
double upperEdgeX,
int nBinsY,
double lowerEdgeY,
double upperEdgeY ) [pure virtual]
 

Convert internally the ICloud2D to an IHistogram2D 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.
Returns:
false If the ICloud2D has already been converted.

bool AIDA::ICloud2D::fill ( double x,
double y,
double weight = 1. ) [pure virtual]
 

Fill the ICloud2D with a couple of values and a corresponding weight.

Parameters:
x   The x value.
y   The y value.
weight   The corresponding weight. By default it is 1.
Returns:
false If the ICloud2D is full, if the weight's value is is not between 0 and 1.

bool AIDA::ICloud2D::fillHistogram ( IHistogram2D & hist ) const [pure virtual]
 

Project the ICloud2D on an IHistogram2D.

Parameters:
hist   The IHistogram2D to be filled.
Returns:
false If the ICloud2D is already converted.

const IHistogram2D & AIDA::ICloud2D::histogram ( ) const [pure virtual]
 

Get the internal IHistogram2D in which the ICloud2D converted to.

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

double AIDA::ICloud2D::lowerEdgeX ( ) const [pure virtual]
 

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

Returns:
The lower edge along the x axis.

double AIDA::ICloud2D::lowerEdgeY ( ) const [pure virtual]
 

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

Returns:
The lower edge along the y axis.

double AIDA::ICloud2D::meanX ( ) const [pure virtual]
 

Get the mean of the ICloud2D along the x axis.

Returns:
The mean along the x axis.

double AIDA::ICloud2D::meanY ( ) const [pure virtual]
 

Get the mean of the ICloud2D along the y axis.

Returns:
The mean along the y axis.

double AIDA::ICloud2D::rmsX ( ) const [pure virtual]
 

Get the RMS of the ICloud2D along the x axis.

Returns:
The RMS along the x axis.

double AIDA::ICloud2D::rmsY ( ) const [pure virtual]
 

Get the RMS of the ICloud2D along the y axis.

Returns:
The RMS along the y axis.

double AIDA::ICloud2D::upperEdgeX ( ) const [pure virtual]
 

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

Returns:
The upper edge along the x axis.

double AIDA::ICloud2D::upperEdgeY ( ) const [pure virtual]
 

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

Returns:
The upper edge along the y axis.

double AIDA::ICloud2D::valueX ( int index ) const [pure 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 ICloud2D has already been converted, 0 is returned.

double AIDA::ICloud2D::valueY ( int index ) const [pure 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 ICloud2D has already been converted, 0 is returned.

double AIDA::ICloud2D::weight ( int index ) const [pure 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 ICloud2D has already been converted, 0 is returned.

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