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

#include <IAxis.h>

List of all members.

Public Types
enum	{ UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 }
Public Methods
virtual	~IAxis ()
	Destructor. More...
virtual bool	isFixedBinning () const=0
virtual double	lowerEdge () const=0
virtual double	upperEdge () const=0
virtual int	bins () const=0
virtual double	binLowerEdge (int index) const=0
virtual double	binUpperEdge (int index) const=0
virtual double	binWidth (int index) const=0
virtual int	coordToIndex (double coord) const=0

---

Detailed Description

An IAxis represents a binned histogram axis. A 1D Histogram would have one Axis representing the X axis, while a 2D Histogram would have two axes representing the X and Y Axis.

Author:

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

Definition at line 26 of file IAxis.h.

---

Member Enumeration Documentation

anonymous enum

Constants specifying the underflow and the overflow bin. They can be passed to any method accepting a bin number. Enumeration values: UNDERFLOW_BIN   OVERFLOW_BIN   Definition at line 99 of file IAxis.h.

---

Constructor & Destructor Documentation

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

Definition at line 30 of file IAxis.h.

---

Member Function Documentation

double AIDA::IAxis::binLowerEdge ( int index ) const [pure virtual]

Get the lower edge of the specified bin. Parameters: index   The bin number: 0 to bins()-1 for the in-range bins or OVERFLOW or UNDERFLOW. Returns: The lower edge of the corresponding bin; for the underflow bin this is Double.NEGATIVE_INFINITY.

double AIDA::IAxis::binUpperEdge ( int index ) const [pure virtual]

Get the upper edge of the specified bin. Parameters: index   The bin number: 0 to bins()-1 for the in-range bins or OVERFLOW or UNDERFLOW. Returns: The upper edge of the corresponding bin; for the overflow bin this is Double.POSITIVE_INFINITY.

double AIDA::IAxis::binWidth ( int index ) const [pure virtual]

Get the width of the specified bin. Parameters: index   The bin number: 0 to bins()-1) for the in-range bins or OVERFLOW or UNDERFLOW. Returns: The width of the corresponding bin.

int AIDA::IAxis::bins ( ) const [pure virtual]

The number of bins (excluding underflow and overflow) on the IAxis. Returns: The IAxis's number of bins.

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

Convert a coordinate on the axis to a bin number. If the coordinate is less than the lowerEdge UNDERFLOW is returned; if the coordinate is greater or equal to the upperEdge OVERFLOW is returned. Parameters: coord   The coordinate to be converted. Returns: The corresponding bin number.

bool AIDA::IAxis::isFixedBinning ( ) const [pure virtual]

Check if the IAxis has fixed binning, i.e. if all the bins have the same width. Returns: true if the binning is fixed, false otherwise.

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

Get the lower edge of the IAxis. Returns: The IAxis's lower edge.

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

Get the upper edge of the IAxis. Returns: The IAxis's upper edge.

---

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

• IAxis.h

---