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

#include <IProfile1D.h>

Inheritance diagram for AIDA::IProfile1D::

List of all members.

Public Methods
virtual	~IProfile1D ()
	Destructor. More...
virtual bool	fill (double x, double y, double weight=1)=0
virtual double	binMean (int index) const=0
virtual int	binEntries (int index) const=0
virtual double	binHeight (int index) const=0
virtual double	binError (int index) const=0
virtual double	binRms (int index) const=0
virtual double	mean () const=0
virtual double	rms () const=0
virtual const IAxis&	axis () const=0
virtual int	coordToIndex (double coord) const=0
virtual bool	add (const IProfile1D &profile)=0

---

Detailed Description

User level interface to a 1-dimensional profile histogram

Author:

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

Definition at line 28 of file IProfile1D.h.

---

Constructor & Destructor Documentation

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

Definition at line 32 of file IProfile1D.h.

---

Member Function Documentation

bool AIDA::IProfile1D::add ( const IProfile1D & profile ) [pure virtual]

Modifies this IProfile1D by adding the contents of profile to it. Parameters: profile   The IProfile1D to be added to this IProfile1D Returns: false if profile binnings are incompatible

const IAxis & AIDA::IProfile1D::axis ( ) const [pure virtual]

Returns the X axis.

int AIDA::IProfile1D::binEntries ( int index ) const [pure virtual]

Number of entries in the corresponding bin (ie the number of times fill was called for this bin). Parameters: index   the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

double AIDA::IProfile1D::binError ( int index ) const [pure virtual]

The error on this bin. Parameters: index   the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

double AIDA::IProfile1D::binHeight ( int index ) const [pure virtual]

Total height of the corresponding bin (ie the sum of the weights in this bin). Parameters: index   the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

double AIDA::IProfile1D::binMean ( int index ) const [pure virtual]

The weighted mean of the corresponding bin. Parameters: index   the bin number (0...N-1) or OVERFLOW or UNDERFLOW. Returns: The mean of the corresponding bin along the x axis.

double AIDA::IProfile1D::binRms ( int index ) const [pure virtual]

The spread (RMS) of a bin. Parameters: index   the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

int AIDA::IProfile1D::coordToIndex ( double coord ) const [pure virtual]

Convenience method, equivalent to axis().coordToIndex(coord). See also: IAxis::coordToIndex(double)

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

Fill the IProfile1D.

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

Returns the mean of the whole profile as calculated on filling-time.

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

Returns the rms of the whole profile as calculated on filling-time.

---

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

• IProfile1D.h

---