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

#include <IProfile2D.h>

Inheritance diagram for AIDA::IProfile2D::

List of all members.

Public Methods
virtual	~IProfile2D ()
	Destructor. More...
virtual bool	fill (double x, double y, double z, double weight=1)=0
virtual double	binMeanX (int indexX, int indexY) const=0
virtual double	binMeanY (int indexX, int indexY) const=0
virtual int	binEntries (int indexX, int indexY) const=0
virtual int	binEntriesX (int indexX) const=0
virtual int	binEntriesY (int indexY) const=0
virtual double	binHeight (int indexX, int indexY) const=0
virtual double	binHeightX (int indexX) const=0
virtual double	binHeightY (int indexY) const=0
virtual double	binError (int indexX, int indexY) const=0
virtual double	binRms (int indexX, int indexY) const=0
virtual double	meanX () const=0
virtual double	meanY () const=0
virtual double	rmsX () const=0
virtual double	rmsY () const=0
virtual const IAxis&	xAxis () const=0
virtual const IAxis&	yAxis () const=0
virtual int	coordToIndexX (double coordX) const=0
virtual int	coordToIndexY (double coordY) const=0
virtual bool	add (const IProfile2D &h)=0

---

Detailed Description

User level interface to a 2-dimensional profile histogram

Author:

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

Definition at line 28 of file IProfile2D.h.

---

Constructor & Destructor Documentation

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

Definition at line 32 of file IProfile2D.h.

---

Member Function Documentation

bool AIDA::IProfile2D::add ( const IProfile2D & h ) [pure virtual]

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

int AIDA::IProfile2D::binEntries ( int indexX, int indexY ) const [pure virtual]

The number of entries (ie the number of times fill was called for this bin). Parameters: indexX   the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY   the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

int AIDA::IProfile2D::binEntriesX ( int indexX ) const [pure virtual]

Equivalent to projectionX().binEntries(indexX).

int AIDA::IProfile2D::binEntriesY ( int indexY ) const [pure virtual]

Equivalent to projectionY().binEntries(indexY).

double AIDA::IProfile2D::binError ( int indexX, int indexY ) const [pure virtual]

The error on this bin. Parameters: indexX   the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY   the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

double AIDA::IProfile2D::binHeight ( int indexX, int indexY ) const [pure virtual]

Total height of the corresponding bin (ie the sum of the weights in this bin). Parameters: indexX   the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY   the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

double AIDA::IProfile2D::binHeightX ( int indexX ) const [pure virtual]

Equivalent to projectionX().binHeight(indexX).

double AIDA::IProfile2D::binHeightY ( int indexY ) const [pure virtual]

Equivalent to projectionY().binHeight(indexY).

double AIDA::IProfile2D::binMeanX ( int indexX, int indexY ) const [pure virtual]

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

double AIDA::IProfile2D::binMeanY ( int indexX, int indexY ) const [pure virtual]

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

double AIDA::IProfile2D::binRms ( int indexX, int indexY ) const [pure virtual]

The spread (RMS) of this bin. Parameters: indexX   the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW. indexY   the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.

int AIDA::IProfile2D::coordToIndexX ( double coordX ) const [pure virtual]

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

int AIDA::IProfile2D::coordToIndexY ( double coordY ) const [pure virtual]

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

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

Fill the IProfile2D.

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

Returns the mean of the profile, as calculated on filling-time projected on the X axis.

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

Returns the mean of the profile, as calculated on filling-time projected on the Y axis.

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

Returns the rms of the profile as calculated on filling-time projected on the X axis.

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

Returns the rms of the profile as calculated on filling-time projected on the Y axis.

const IAxis & AIDA::IProfile2D::xAxis ( ) const [pure virtual]

Return the X axis.

const IAxis & AIDA::IProfile2D::yAxis ( ) const [pure virtual]

Return the Y axis.

---

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

• IProfile2D.h

---