npstat is hosted by Hepforge, IPPP Durham
NPStat  5.10.0

#include <DualHistoAxis.hh>

Public Member Functions

 DualHistoAxis (const NUHistoAxis &a)
 
 DualHistoAxis (const HistoAxis &u)
 
 DualHistoAxis (const std::vector< double > &binEdges, const char *label=0)
 
 DualHistoAxis (unsigned nBins, double min, double max, const char *label=0)
 
bool isUniform () const
 
double min () const
 
double max () const
 
Interval< double > interval () const
 
double length () const
 
unsigned nBins () const
 
double binWidth (const int binNum) const
 
const std::string & label () const
 
double binCenter (const int binNum) const
 
double leftBinEdge (const int binNum) const
 
double rightBinEdge (const int binNum) const
 
Interval< double > binInterval (const int binNum) const
 
const NUHistoAxisgetNUHistoAxis () const
 
const HistoAxisgetHistoAxis () const
 
void setLabel (const char *newlabel)
 
int binNumber (const double x) const
 
double fltBinNumber (const double x, const bool mapLeftEdgeTo0=true) const
 
unsigned closestValidBin (const double x) const
 
bool operator== (const DualHistoAxis &r) const
 
bool operator!= (const DualHistoAxis &r) const
 
bool isClose (const DualHistoAxis &r, const double tol) const
 
DualHistoAxis rebin (const unsigned newBins) const
 
gs::ClassId classId () const
 
bool write (std::ostream &of) const
 

Static Public Member Functions

static const char * classname ()
 
static unsigned version ()
 
static DualHistoAxisread (const gs::ClassId &id, std::istream &in)
 

Friends

template<typename Numeric , class Axis >
class HistoND
 

Detailed Description

Histogram axis which can be either uniform or non-uniform. Will work a little bit slower than either HistoAxis or NUHistoAxis, but can be used in place of either one of them.

Member Function Documentation

◆ binNumber()

int npstat::DualHistoAxis::binNumber ( const double  x) const
inline

This method returns arbitrary integer bin number. Possible output depends on whether the axis is uniform or not.

◆ closestValidBin()

unsigned npstat::DualHistoAxis::closestValidBin ( const double  x) const
inline

Return the closest valid bin number (equal to or above 0 and below nBins() )

◆ fltBinNumber()

double npstat::DualHistoAxis::fltBinNumber ( const double  x,
const bool  mapLeftEdgeTo0 = true 
) const
inline

Floating point bin number given the coordinate. Useful for interpolation methods and such.

◆ getNUHistoAxis()

const NUHistoAxis* npstat::DualHistoAxis::getNUHistoAxis ( ) const
inline

Return a pointer to the underlying axis. This will be a null pointer if the axis does not correspond to the constructed type.

◆ isClose()

bool npstat::DualHistoAxis::isClose ( const DualHistoAxis r,
const double  tol 
) const
inline

Comparison within given tolerance

◆ rebin()

DualHistoAxis npstat::DualHistoAxis::rebin ( const unsigned  newBins) const
inline

Return uniformly rebinned axis

◆ setLabel()

void npstat::DualHistoAxis::setLabel ( const char *  newlabel)
inline

Modify the axis label


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