GeoModel - GeoModelCore
Public Member Functions | Private Attributes | List of all members
CellBinning Class Reference

A simple class to specify a range, and a number of bins. The binning is specified as one would specify bins of a histogram. In addition to the usual start-of-range, end-of-range, and number of divisions this class also has an index for the first bin number. In this package the cell binning is used to set up regions of homogenous granularity (or just "regions"). More...

#include <CellBinning.h>

Public Member Functions

 CellBinning (double startVal, double endVal, unsigned int nBins, unsigned int firstDivisionNumber=0)
 Constructor.
 
double binLower (unsigned int i) const
 Gets the ith bin lower edge.
 
double binUpper (unsigned int i) const
 gets the ith bin upper edge
 
double binCenter (unsigned int i) const
 gets the ith bin center
 
double getStart () const
 Starting value.
 
double getEnd () const
 Ending Value.
 
unsigned int getNumDivisions () const
 Number of Bins.
 
double getDelta () const
 gets the bin width
 
unsigned int getFirstDivisionNumber () const
 Number for the first division. Optional, default=0.
 

Private Attributes

double m_start
 
double m_end
 
unsigned int m_numDivisions
 
double m_delta
 
unsigned int m_firstDivisionNumber
 

Detailed Description

A simple class to specify a range, and a number of bins. The binning is specified as one would specify bins of a histogram. In addition to the usual start-of-range, end-of-range, and number of divisions this class also has an index for the first bin number. In this package the cell binning is used to set up regions of homogenous granularity (or just "regions").

Definition at line 19 of file CellBinning.h.


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