Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

IAxis Class Reference

Definition of the IAxis interface class IAxis represents a binned histogram axis. More...

#include <GaudiKernel/IAxis.h>

List of all members.

Public Methods

virtual const std::vector<
double>& 
edges () const = 0
 ========================================================================== Axis edges ========================================================================== All axis edges at once (in "n" is number of bins, there are "n+1" edges).

virtual double lowerEdge () const = 0
 Lower axis edge.

virtual double upperEdge () const = 0
 Upper axis edge.

virtual int bins () const = 0
 ========================================================================== Bins ========================================================================== -------------------------------------------------------------------------- Number of bins Number of in-range bins in the axis.

virtual double binLowerEdge ( int index ) const = 0
 -------------------------------------------------------------------------- Bin edges Lower edge of the in-range bin identified by index.

virtual double binUpperEdge ( int index ) const = 0
 Upper edge of the in-range bin identified by index.

virtual double binWidth ( int index ) const = 0
 -------------------------------------------------------------------------- Bin widths Width of the in-range bin identified by index.

virtual double binCentre ( int index ) const = 0
 -------------------------------------------------------------------------- Bin centre Centre of the bin located by index.

virtual int coordToIndex ( double coord ) const = 0
 ========================================================================== Conversions between coordinates and bin indices ========================================================================== Equivalent to coordToIndex( coord ); for 1D histogram or coordToIndexX( coordX ); or coordToIndexY( coordY ); for 2D histogram.


Detailed Description

Definition of the IAxis interface class IAxis represents a binned histogram axis.

A 1D histogram has one axis representing the X axis, a 2D histogram has two axes representing the X and Y Axis.

Author(s):
Pavel Binko , Dino Ferrero Merlino , Andreas Pfeiffer
Date:
22/03/2000

Definition at line 22 of file IAxis.h.


Member Function Documentation

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

-------------------------------------------------------------------------- Bin centre Centre of the bin located by index.

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

-------------------------------------------------------------------------- Bin edges Lower edge of the in-range bin identified by index.

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

Upper edge of the in-range bin identified by index.

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

-------------------------------------------------------------------------- Bin widths Width of the in-range bin identified by index.

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

========================================================================== Bins ========================================================================== -------------------------------------------------------------------------- Number of bins Number of in-range bins in the axis.

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

========================================================================== Conversions between coordinates and bin indices ========================================================================== Equivalent to coordToIndex( coord ); for 1D histogram or coordToIndexX( coordX ); or coordToIndexY( coordY ); for 2D histogram.

const std::vector< double >& IAxis::edges ( ) const [pure virtual]
 

========================================================================== Axis edges ========================================================================== All axis edges at once (in "n" is number of bins, there are "n+1" edges).

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

Lower axis edge.

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

Upper axis edge.


The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:10 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000