An Axis represents a binned histogram axis.
More...
#include <Axis.h>
List of all members.
Public Member Functions |
| Axis (int n, double lo, double up) |
| Standard constructor.
|
| Axis (const Axis &a) |
| Copy constructor.
|
virtual | ~Axis () |
| Destructor.
|
bool | isFixedBinning () const |
| Check if the IAxis has fixed binning, i.e.
|
double | lowerEdge () const |
| Get the lower edge of the IAxis.
|
double | upperEdge () const |
| Get the upper edge of the IAxis.
|
int | bins () const |
| The number of bins (excluding underflow and overflow) on the IAxis.
|
double | binLowerEdge (int index) const |
| Get the lower edge of the specified bin.
|
double | binUpperEdge (int index) const |
| Get the upper edge of the specified bin.
|
double | binWidth (int) const |
| Get the width of the specified bin.
|
int | coordToIndex (double coord) const |
| Convert a coordinate on the axis to a bin number.
|
double | binMidPoint (int index) const |
| Return the midpoint of the specified bin.
|
Private Attributes |
double | lower |
| The lower edge.
|
double | upper |
| The upper edge.
|
int | nbins |
| The number of bins.
|
Detailed Description
An Axis 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.
Definition at line 30 of file Axis.h.
Member Function Documentation
double LWH::Axis::binLowerEdge |
( |
int |
index | ) |
const |
|
inline |
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
.
Definition at line 86 of file Axis.h.
double LWH::Axis::binMidPoint |
( |
int |
index | ) |
const |
|
inline |
Return the midpoint of the specified bin.
No checking is performed to ensure the argument is a valid bin.
Definition at line 134 of file Axis.h.
int LWH::Axis::bins |
( |
| ) |
const |
|
inline |
double LWH::Axis::binUpperEdge |
( |
int |
index | ) |
const |
|
inline |
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
.
Definition at line 99 of file Axis.h.
double LWH::Axis::binWidth |
( |
int |
| ) |
const |
|
inline |
Get the width of the specified bin.
The argument gives the bin number: 0 to bins()-1) for the in-range bins or OVERFLOW or UNDERFLOW.
- Returns:
- The width of the corresponding bin.
Definition at line 111 of file Axis.h.
int LWH::Axis::coordToIndex |
( |
double |
coord | ) |
const |
|
inline |
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.
Definition at line 124 of file Axis.h.
bool LWH::Axis::isFixedBinning |
( |
| ) |
const |
|
inline |
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.
Definition at line 55 of file Axis.h.
double LWH::Axis::lowerEdge |
( |
| ) |
const |
|
inline |
double LWH::Axis::upperEdge |
( |
| ) |
const |
|
inline |
Member Data Documentation
The lower edge.
Definition at line 141 of file Axis.h.
The number of bins.
Definition at line 147 of file Axis.h.
The upper edge.
Definition at line 144 of file Axis.h.
The documentation for this class was generated from the following file: