npstat::DualHistoAxis Class Reference

#include <DualHistoAxis.h>

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

Static Public Member Functions
static const char *	classname ()
static DualHistoAxis *	read (const gs::ClassId &id, std::istream &in)
static unsigned	version ()

Private Member Functions
	DualHistoAxis ()
unsigned	overflowIndex (const double x, unsigned *binNumber) const

Static Private Member Functions
static std::vector< double >	dummy_vec ()

Private Attributes
NUHistoAxis	a_
HistoAxis	u_
bool	uniform_

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.

Definition at line 23 of file DualHistoAxis.h.

Constructor & Destructor Documentation

DualHistoAxis() [1/5]

npstat::DualHistoAxis::DualHistoAxis ( const NUHistoAxis &  a )

inline

Definition at line 26 of file DualHistoAxis.h.

: a_(a), u_(1U, 0.0, 1.0), uniform_(false) {}

DualHistoAxis() [2/5]

npstat::DualHistoAxis::DualHistoAxis ( const HistoAxis &  u )

inline

Definition at line 28 of file DualHistoAxis.h.

: a_(dummy_vec()), u_(u), uniform_(true) {}

DualHistoAxis() [3/5]

npstat::DualHistoAxis::DualHistoAxis ( const std::vector< double > &  binEdges, const char *  label = nullptr  )

inline

Definition at line 30 of file DualHistoAxis.h.

        : a_(binEdges, label), u_(1U, 0.0, 1.0), uniform_(false) {}

DualHistoAxis() [4/5]

npstat::DualHistoAxis::DualHistoAxis ( unsigned  nBins, double  min, double  max, const char *  label = nullptr  )

inline

Definition at line 33 of file DualHistoAxis.h.

        : a_(dummy_vec()), u_(nBins, min, max, label), uniform_(true) {}

DualHistoAxis() [5/5]

npstat::DualHistoAxis::DualHistoAxis ( )

inlineprivate

Definition at line 144 of file DualHistoAxis.h.

: a_(dummy_vec()), u_(1U, 0.0, 1.0), uniform_(true) {}

Referenced by read(), and rebin().

Member Function Documentation

binCenter()

double npstat::DualHistoAxis::binCenter ( const int  binNum ) const

inline

Definition at line 53 of file DualHistoAxis.h.

{ return uniform_ ? u_.binCenter(binNum) : a_.binCenter(binNum); }

References a_, npstat::HistoAxis::binCenter(), npstat::NUHistoAxis::binCenter(), u_, and uniform_.

binInterval()

Interval<double> npstat::DualHistoAxis::binInterval ( const int  binNum ) const

inline

Definition at line 63 of file DualHistoAxis.h.

                                                                {
      return uniform_ ? u_.binInterval(binNum) : a_.binInterval(binNum);
    }

References a_, npstat::NUHistoAxis::binInterval(), npstat::HistoAxis::binInterval(), u_, and uniform_.

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.

Definition at line 87 of file DualHistoAxis.h.

{ return uniform_ ? u_.binNumber(x) : a_.binNumber(x); }

References a_, npstat::NUHistoAxis::binNumber(), npstat::HistoAxis::binNumber(), u_, and uniform_.

Referenced by overflowIndex().

binWidth()

double npstat::DualHistoAxis::binWidth ( const int  binNum ) const

inline

Definition at line 49 of file DualHistoAxis.h.

{ return uniform_ ? u_.binWidth(binNum) : a_.binWidth(binNum); }

References a_, npstat::NUHistoAxis::binWidth(), npstat::HistoAxis::binWidth(), u_, and uniform_.

classId()

gs::ClassId npstat::DualHistoAxis::classId ( ) const

inline

Definition at line 118 of file DualHistoAxis.h.

{ return gs::ClassId(*this); }

classname()

static const char* npstat::DualHistoAxis::classname ( )

inlinestatic

Definition at line 122 of file DualHistoAxis.h.

{ return "npstat::DualHistoAxis"; }

closestValidBin()

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

inline

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

Definition at line 98 of file DualHistoAxis.h.

                                                          {
      return uniform_ ? u_.closestValidBin(x) : a_.closestValidBin(x);
    }

References a_, npstat::HistoAxis::closestValidBin(), npstat::NUHistoAxis::closestValidBin(), u_, and uniform_.

dummy_vec()

static std::vector<double> npstat::DualHistoAxis::dummy_vec ( )

inlinestaticprivate

Definition at line 138 of file DualHistoAxis.h.

                                                {
      std::vector<double> vec(2, 0.0);
      vec[1] = 1.0;
      return vec;
    }

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.

Definition at line 93 of file DualHistoAxis.h.

                                                                                       {
      return uniform_ ? u_.fltBinNumber(x, mapLeftEdgeTo0) : a_.fltBinNumber(x, mapLeftEdgeTo0);
    }

References a_, npstat::NUHistoAxis::fltBinNumber(), npstat::HistoAxis::fltBinNumber(), u_, and uniform_.

getHistoAxis()

const HistoAxis* npstat::DualHistoAxis::getHistoAxis ( ) const

inline

Definition at line 77 of file DualHistoAxis.h.

{ return uniform_ ? &u_ : static_cast<const HistoAxis*>(nullptr); }

References u_, and uniform_.

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.

Definition at line 73 of file DualHistoAxis.h.

                                                     {
      return uniform_ ? static_cast<const NUHistoAxis*>(nullptr) : &a_;
    }

References a_, and uniform_.

interval()

Interval<double> npstat::DualHistoAxis::interval ( ) const

inline

Definition at line 43 of file DualHistoAxis.h.

{ return uniform_ ? u_.interval() : a_.interval(); }

References a_, npstat::NUHistoAxis::interval(), npstat::HistoAxis::interval(), u_, and uniform_.

isClose()

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

inline

Comparison within given tolerance

Definition at line 107 of file DualHistoAxis.h.

                                                                        {
      return uniform_ == r.uniform_ && a_.isClose(r.a_, tol) && u_.isClose(r.u_, tol);
    }

References a_, npstat::NUHistoAxis::isClose(), npstat::HistoAxis::isClose(), alignCSCRings::r, u_, and uniform_.

isUniform()

bool npstat::DualHistoAxis::isUniform ( ) const

inline

Definition at line 37 of file DualHistoAxis.h.

{ return uniform_; }

References uniform_.

label()

const std::string& npstat::DualHistoAxis::label ( ) const

inline

Definition at line 51 of file DualHistoAxis.h.

{ return uniform_ ? u_.label() : a_.label(); }

References a_, npstat::NUHistoAxis::label(), npstat::HistoAxis::label(), u_, and uniform_.

Referenced by rebin().

leftBinEdge()

double npstat::DualHistoAxis::leftBinEdge ( const int  binNum ) const

inline

Definition at line 55 of file DualHistoAxis.h.

                                                      {
      return uniform_ ? u_.leftBinEdge(binNum) : a_.leftBinEdge(binNum);
    }

References a_, npstat::NUHistoAxis::leftBinEdge(), npstat::HistoAxis::leftBinEdge(), u_, and uniform_.

length()

double npstat::DualHistoAxis::length ( ) const

inline

Definition at line 45 of file DualHistoAxis.h.

{ return uniform_ ? u_.length() : a_.length(); }

References a_, npstat::NUHistoAxis::length(), npstat::HistoAxis::length(), u_, and uniform_.

max()

double npstat::DualHistoAxis::max ( ) const

inline

Definition at line 41 of file DualHistoAxis.h.

{ return uniform_ ? u_.max() : a_.max(); }

References a_, npstat::NUHistoAxis::max(), npstat::HistoAxis::max(), u_, and uniform_.

Referenced by rebin().

min()

double npstat::DualHistoAxis::min ( ) const

inline

Definition at line 39 of file DualHistoAxis.h.

{ return uniform_ ? u_.min() : a_.min(); }

References a_, npstat::NUHistoAxis::min(), npstat::HistoAxis::min(), u_, and uniform_.

Referenced by rebin().

nBins()

unsigned npstat::DualHistoAxis::nBins ( ) const

inline

Definition at line 47 of file DualHistoAxis.h.

{ return uniform_ ? u_.nBins() : a_.nBins(); }

References a_, npstat::NUHistoAxis::nBins(), npstat::HistoAxis::nBins(), u_, and uniform_.

operator!=()

bool npstat::DualHistoAxis::operator!= ( const DualHistoAxis &  r ) const

inline

Definition at line 104 of file DualHistoAxis.h.

{ return !(*this == r); }

References alignCSCRings::r.

operator==()

bool npstat::DualHistoAxis::operator== ( const DualHistoAxis &  r ) const

inline

Definition at line 102 of file DualHistoAxis.h.

{ return uniform_ == r.uniform_ && a_ == r.a_ && u_ == r.u_; }

References a_, alignCSCRings::r, u_, and uniform_.

overflowIndex()

unsigned npstat::DualHistoAxis::overflowIndex ( const double  x, unsigned *  binNumber  ) const

inlineprivate

Definition at line 134 of file DualHistoAxis.h.

                                                                             {
      return uniform_ ? u_.overflowIndex(x, binNumber) : a_.overflowIndex(x, binNumber);
    }

References a_, binNumber(), npstat::NUHistoAxis::overflowIndex(), npstat::HistoAxis::overflowIndex(), u_, uniform_, and x.

read()

DualHistoAxis * npstat::DualHistoAxis::read ( const gs::ClassId &  id, std::istream &  in  )

static

Definition at line 17 of file DualHistoAxis.cc.

                                                                        {
    static const gs::ClassId current(gs::ClassId::makeId<DualHistoAxis>());
    current.ensureSameId(id);
 
    unsigned char c;
    gs::read_pod(in, &c);
    gs::ClassId clid(in, 1);
    if (in.fail())
      throw gs::IOReadFailure(
          "In npstat::DualHistoAxis::read: "
          "input stream failure");
    if (c) {
      CPP11_auto_ptr<HistoAxis> axis(HistoAxis::read(clid, in));
      return new DualHistoAxis(*axis);
    } else {
      CPP11_auto_ptr<NUHistoAxis> axis(NUHistoAxis::read(clid, in));
      return new DualHistoAxis(*axis);
    }
  }

References c, DualHistoAxis(), recoMuon::in, npstat::NUHistoAxis::read(), and npstat::HistoAxis::read().

Referenced by edmIntegrityCheck.PublishToFileSystem::get().

rebin()

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

inline

Return uniformly rebinned axis

Definition at line 112 of file DualHistoAxis.h.

                                                             {
      return DualHistoAxis(newBins, min(), max(), label().c_str());
    }

References DualHistoAxis(), label(), max(), and min().

rightBinEdge()

double npstat::DualHistoAxis::rightBinEdge ( const int  binNum ) const

inline

Definition at line 59 of file DualHistoAxis.h.

                                                       {
      return uniform_ ? u_.rightBinEdge(binNum) : a_.rightBinEdge(binNum);
    }

References a_, npstat::NUHistoAxis::rightBinEdge(), npstat::HistoAxis::rightBinEdge(), u_, and uniform_.

setLabel()

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

inline

Modify the axis label

Definition at line 81 of file DualHistoAxis.h.

{ uniform_ ? u_.setLabel(newlabel) : a_.setLabel(newlabel); }

References a_, npstat::NUHistoAxis::setLabel(), npstat::HistoAxis::setLabel(), u_, and uniform_.

version()

static unsigned npstat::DualHistoAxis::version ( )

inlinestatic

Definition at line 123 of file DualHistoAxis.h.

{ return 1; }

Referenced by validation.Sample::datasetpattern(), and validation.Sample::filename().

write()

bool npstat::DualHistoAxis::write

(

std::ostream &

of

)

const

Definition at line 8 of file DualHistoAxis.cc.

                                                {
    unsigned char c = uniform_;
    gs::write_pod(of, c);
    if (uniform_)
      return !of.fail() && u_.classId().write(of) && u_.write(of);
    else
      return !of.fail() && a_.classId().write(of) && a_.write(of);
  }

References a_, c, npstat::NUHistoAxis::classId(), npstat::HistoAxis::classId(), u_, uniform_, npstat::NUHistoAxis::write(), and npstat::HistoAxis::write().

Friends And Related Function Documentation

HistoND

template<typename Numeric , class Axis >

friend class HistoND

friend

Definition at line 132 of file DualHistoAxis.h.

Member Data Documentation

a_

NUHistoAxis npstat::DualHistoAxis::a_

private

Definition at line 127 of file DualHistoAxis.h.

Referenced by binCenter(), binInterval(), binNumber(), binWidth(), closestValidBin(), fltBinNumber(), getNUHistoAxis(), interval(), isClose(), label(), leftBinEdge(), length(), max(), min(), nBins(), operator==(), overflowIndex(), rightBinEdge(), setLabel(), and write().

u_

HistoAxis npstat::DualHistoAxis::u_

private

Definition at line 128 of file DualHistoAxis.h.

Referenced by binCenter(), binInterval(), binNumber(), binWidth(), closestValidBin(), fltBinNumber(), getHistoAxis(), interval(), isClose(), label(), leftBinEdge(), length(), max(), min(), nBins(), operator==(), overflowIndex(), rightBinEdge(), setLabel(), and write().

uniform_

bool npstat::DualHistoAxis::uniform_

private

Definition at line 129 of file DualHistoAxis.h.

Referenced by binCenter(), binInterval(), binNumber(), binWidth(), closestValidBin(), fltBinNumber(), getHistoAxis(), getNUHistoAxis(), interval(), isClose(), isUniform(), label(), leftBinEdge(), length(), max(), min(), nBins(), operator==(), overflowIndex(), rightBinEdge(), setLabel(), and write().