#include <Axis.h>
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. |
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.
bool LWH::Axis::isFixedBinning | ( | ) | const [inline] |
double LWH::Axis::lowerEdge | ( | ) | const [inline] |
double LWH::Axis::upperEdge | ( | ) | const [inline] |
int LWH::Axis::bins | ( | ) | const [inline] |
double LWH::Axis::binLowerEdge | ( | int | index | ) | const [inline] |
Get the lower edge of the specified bin.
index | The bin number: 0 to bins()-1 for the in-range bins or OVERFLOW or UNDERFLOW. |
Double.NEGATIVE_INFINITY
. Definition at line 86 of file Axis.h.
References binWidth(), lower, and nbins.
double LWH::Axis::binUpperEdge | ( | int | index | ) | const [inline] |
Get the upper edge of the specified bin.
index | The bin number: 0 to bins()-1 for the in-range bins or OVERFLOW or UNDERFLOW. |
Double.POSITIVE_INFINITY
. Definition at line 99 of file Axis.h.
References binWidth(), lower, and nbins.
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.
Definition at line 111 of file Axis.h.
References lower, nbins, and upper.
Referenced by binLowerEdge(), binMidPoint(), binUpperEdge(), and coordToIndex().
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.
coord | The coordinate to be converted. |
Definition at line 124 of file Axis.h.
References binWidth(), lower, and upper.
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.
References binWidth(), and lower.
Referenced by LWH::Histogram1D::binMean().
double LWH::Axis::lower [private] |
The lower edge.
Definition at line 141 of file Axis.h.
Referenced by binLowerEdge(), binMidPoint(), binUpperEdge(), binWidth(), coordToIndex(), and lowerEdge().
double LWH::Axis::upper [private] |
The upper edge.
Definition at line 144 of file Axis.h.
Referenced by binWidth(), coordToIndex(), and upperEdge().
int LWH::Axis::nbins [private] |
The number of bins.
Definition at line 147 of file Axis.h.
Referenced by binLowerEdge(), bins(), binUpperEdge(), and binWidth().