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

#include <IHistogram1D.h>

Inheritance diagram for AIDA::IHistogram1D::

List of all members.

Public Methods
virtual	~IHistogram1D ()
	Destructor. More...
virtual bool	fill (double x, 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	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 IHistogram1D &hist)=0

---

Detailed Description

User level interface to 1D Histogram.

Author:

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

Definition at line 28 of file IHistogram1D.h.

---

Constructor & Destructor Documentation

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

Definition at line 32 of file IHistogram1D.h.

---

Member Function Documentation

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

Add to this IHistogram1D the contents of another IHistogram1D. Parameters: hist   The IHistogram1D to be added to this IHistogram1D. Returns: false If the IHistogram1Ds binnings are incompatible.

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

Get the x axis of the IHistogram1D. Returns: The x coordinate IAxis.

int AIDA::IHistogram1D::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. Returns: The number of entries in the corresponding bin.

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

The error of a given bin. Parameters: index   The bin number (0...N-1) or OVERFLOW or UNDERFLOW. Returns: The error on the corresponding bin.

double AIDA::IHistogram1D::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. Returns: The height of the corresponding bin.

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

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

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

Get the bin number corresponding to a given coordinate along the x axis. This is a convenience method, equivalent to axis().coordToIndex(coord). See also: IAxis::coordToIndex(double) Parameters: coord   The coordinalte along the x axis. Returns: The corresponding bin number.

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

Fill the IHistogram1D with a value and the corresponding weight. Parameters: x   The value to be filled in. weight   The corresponding weight (by default 1). Returns: false If the weight is <0 or >1 (?).

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

The mean of the whole IHistogram1D. Returns: The mean of the IHistogram1D.

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

The RMS of the whole IHistogram1D. Returns: The RMS if the IHistogram1D.

---

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

• IHistogram1D.h

---