CERN Accelerating science

• Sign in
• Directory

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

               

---

AIDA::ICloud1D Class Reference

#include <ICloud1D.h>

Inheritance diagram for AIDA::ICloud1D::

List of all members.

Public Methods
virtual	~ICloud1D ()
	Destructor. More...
virtual bool	fill (double x, double weight=1.)=0
virtual double	lowerEdge () const=0
virtual double	upperEdge () const=0
virtual double	value (int index) const=0
virtual double	weight (int index) const=0
virtual double	mean () const=0
virtual double	rms () const=0
virtual bool	convert (int nBins, double lowerEdge, double upperEdge)=0
virtual bool	convert (const std::vector< double > &binEdges)=0
virtual const IHistogram1D&	histogram () const=0
virtual bool	fillHistogram (IHistogram1D &hist) const=0

---

Detailed Description

User level interface to a 1D Cloud.

Author:

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

Definition at line 30 of file ICloud1D.h.

---

Constructor & Destructor Documentation

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

Definition at line 34 of file ICloud1D.h.

---

Member Function Documentation

bool AIDA::ICloud1D::convert ( const std::vector< double > & binEdges ) [pure virtual]

Convert internally the ICloud1D to an IHistogram1D with given bin edges. Parameters: binEdges   The bins edges. Returns: false If the ICloud1D has already been converted.

bool AIDA::ICloud1D::convert ( int nBins, double lowerEdge, double upperEdge ) [pure virtual]

Convert internally the ICloud1D to an IHistogram1D with given number of bins, upper edge and lower edge. Parameters: nBins   The number of bins. lowerEdge   The lower edge. upperEdge   The upper edge. Returns: false If the ICloud1D has already been converted.

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

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

bool AIDA::ICloud1D::fillHistogram ( IHistogram1D & hist ) const [pure virtual]

Project the ICloud1D on an IHistogram1D. Parameters: hist   The IHistogram1D to be filled. Returns: false If the ICloud1D is already converted.

const IHistogram1D & AIDA::ICloud1D::histogram ( ) const [pure virtual]

Get the internal IHistogram1D in which the ICloud1D converted to. Returns: The histogram. or because of a convert() method invocation.

double AIDA::ICloud1D::lowerEdge ( ) const [pure virtual]

Get the lower edge of the ICloud1D. Returns: The lower edge.

double AIDA::ICloud1D::mean ( ) const [pure virtual]

Get the mean of the ICloud1D. Returns: The mean.

double AIDA::ICloud1D::rms ( ) const [pure virtual]

Get the RMS of the ICloud1D. Returns: The RMS.

double AIDA::ICloud1D::upperEdge ( ) const [pure virtual]

Get the upper edge of the ICloud1D. Returns: The upper edge.

double AIDA::ICloud1D::value ( int index ) const [pure virtual]

Get the value corresponding to a given entry. Parameters: index   The entry's index. Returns: The value of the index-th entry. If the ICloud1D has already been converted, 0 is returned.

double AIDA::ICloud1D::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 ICloud1D has already been converted, 0 is returned.

---

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

• ICloud1D.h

---