npstat::NUHistoAxis Class Reference

#include <NUHistoAxis.h>

Public Member Functions
double	binCenter (const int binNum) const
Interval< double >	binInterval (const int binNum) const
int	binNumber (double x) const
double	binWidth (const int binNum) const
gs::ClassId	classId () const
unsigned	closestValidBin (double x) const
double	fltBinNumber (double x, bool mapLeftEdgeTo0=true) const
Interval< double >	interval () const
bool	isClose (const NUHistoAxis &, 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
	NUHistoAxis (const std::vector< double > &binEdges, const char *label=nullptr)
bool	operator!= (const NUHistoAxis &) const
bool	operator== (const NUHistoAxis &) const
NUHistoAxis	rebin (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 NUHistoAxis *	read (const gs::ClassId &id, std::istream &in)
static unsigned	version ()

Private Member Functions
	NUHistoAxis ()
	NUHistoAxis (unsigned nBins, double min, double max, const char *label=nullptr)
unsigned	overflowIndex (const double x, unsigned *binNum) const

Private Attributes
std::vector< double >	binEdges_
std::string	label_
double	max_
double	min_
unsigned	nBins_
bool	uniform_

Friends
class	DualHistoAxis
template<typename Numeric , class Axis >
class	HistoND

Detailed Description

This class can be used to create histograms with non-uniform binning

Definition at line 28 of file NUHistoAxis.h.

Constructor & Destructor Documentation

NUHistoAxis() [1/3]

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

The number of bin edges provided must be at least 2. Edge coordinates will be sorted internally in the increasing order. The number of bins will be less by 1 than the number of edges.

Definition at line 15 of file NUHistoAxis.cc.

      : binEdges_(binEdges), nBins_(binEdges.size() - 1U), uniform_(false) {
    if (!(binEdges_.size() > 1U && binEdges_.size() < UINT_MAX / 2U))
      throw npstat::NpstatInvalidArgument(
          "In npstat::NUHistoAxis constructor: "
          "number of bin edges is out of range");
    std::sort(binEdges_.begin(), binEdges_.end());
    min_ = binEdges_[0];
    max_ = binEdges_[nBins_];
    if (label)
      label_ = std::string(label);
  }

References binEdges_, label(), label_, max_, min_, nBins_, jetUpdater_cfi::sort, AlCaHLTBitMon_QueryRunRegistry::string, and mitigatedMETSequence_cff::U.

NUHistoAxis() [2/3]

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

private

Definition at line 28 of file NUHistoAxis.cc.

      : min_(min), max_(max), nBins_(nBins), uniform_(true) {
    if (!(nBins_ && nBins_ < UINT_MAX / 2U - 1U))
      throw npstat::NpstatInvalidArgument(
          "In npstat::NUHistoAxis constructor: "
          "number of bins is out of range");
    if (min_ > max_)
      std::swap(min_, max_);
    binEdges_ = EquidistantInLinearSpace(min_, max_, nBins + 1U);
    if (label)
      label_ = std::string(label);
  }

References binEdges_, label(), label_, max_, min_, nBins(), nBins_, AlCaHLTBitMon_QueryRunRegistry::string, std::swap(), and mitigatedMETSequence_cff::U.

NUHistoAxis() [3/3]

npstat::NUHistoAxis::NUHistoAxis ( )

inlineprivate

Definition at line 128 of file NUHistoAxis.h.

: min_(0.0), max_(0.0), nBins_(0), uniform_(false) {}

Referenced by read(), and rebin().

Member Function Documentation

binCenter()

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

inline

Return the coordinate of the given bin center

Definition at line 56 of file NUHistoAxis.h.

{ return 0.5 * (binEdges_.at(binNum) + binEdges_.at(binNum + 1)); }

References binEdges_.

Referenced by npstat::DualHistoAxis::binCenter(), and npstat::convertToGridAxis().

binInterval()

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

inline

Return the coordinate interval occupied by the given bin

Definition at line 59 of file NUHistoAxis.h.

                                                                {
      return Interval<double>(binEdges_.at(binNum), binEdges_.at(binNum + 1));
    }

References binEdges_.

Referenced by npstat::DualHistoAxis::binInterval().

binNumber()

int npstat::NUHistoAxis::binNumber

(

double

x

)

const

This method returns -1 for values below the lower limit and "nBins()" for values equal to or above the upper limit

Definition at line 62 of file NUHistoAxis.cc.

                                                 {
    const int delta = std::upper_bound(binEdges_.begin(), binEdges_.end(), x) - binEdges_.begin();
    return delta - 1;
  }

References binEdges_, dumpMFGeometry_cfg::delta, and pfDeepBoostedJetPreprocessParams_cfi::upper_bound.

Referenced by npstat::DualHistoAxis::binNumber(), and overflowIndex().

binWidth()

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

inline

Definition at line 44 of file NUHistoAxis.h.

{ return binEdges_.at(binNum + 1) - binEdges_.at(binNum); }

References binEdges_.

Referenced by npstat::DualHistoAxis::binWidth().

classId()

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

inline

Method related to "geners" I/O

Definition at line 95 of file NUHistoAxis.h.

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

Referenced by npstat::DualHistoAxis::write().

classname()

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

inlinestatic

Definition at line 99 of file NUHistoAxis.h.

{ return "npstat::NUHistoAxis"; }

closestValidBin()

unsigned npstat::NUHistoAxis::closestValidBin

(

double

x

)

const

This method returns the closest valid bin number (above 0 and below nBins() )

Definition at line 124 of file NUHistoAxis.cc.

                                                            {
    const int delta = std::upper_bound(binEdges_.begin(), binEdges_.end(), x) - binEdges_.begin();
    int binnum = delta - 1;
    if (binnum < 0)
      binnum = 0;
    else if (static_cast<unsigned>(binnum) >= nBins_)
      binnum = nBins_ - 1U;
    return binnum;
  }

References binEdges_, dumpMFGeometry_cfg::delta, nBins_, mitigatedMETSequence_cff::U, and pfDeepBoostedJetPreprocessParams_cfi::upper_bound.

Referenced by npstat::DualHistoAxis::closestValidBin().

fltBinNumber()

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

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

Definition at line 67 of file NUHistoAxis.cc.

                                                                                  {
    const int delta = std::upper_bound(binEdges_.begin(), binEdges_.end(), x) - binEdges_.begin();
    const int binnum = delta - 1;
 
    if (binnum < 0) {
      const double left = binEdges_[0];
      const double right = binEdges_[1];
      double bval = (x - left) / (right - left);
      if (!mapLeftEdgeTo0)
        bval -= 0.5;
      if (bval < -1.0)
        bval = -1.0;
      return bval;
    } else if (static_cast<unsigned>(binnum) >= nBins_) {
      const double left = binEdges_[nBins_ - 1U];
      const double right = binEdges_[nBins_];
      double bval = nBins_ - 1U + (x - left) / (right - left);
      if (!mapLeftEdgeTo0)
        bval -= 0.5;
      if (bval > static_cast<double>(nBins_))
        bval = nBins_;
      return bval;
    } else {
      const double left = binEdges_[binnum];
      const double right = binEdges_[delta];
      if (mapLeftEdgeTo0)
        return binnum + (x - left) / (right - left);
      else {
        // It is not obvious what is best to do here.
        // The following works to preserve interpolation
        // of 0th order. The commented out snippet below
        // would instead connect bin centers by straight
        // lines during interpolation.
        return binnum + (x - left) / (right - left) - 0.5;
 
        // Bin center is mapped to binnum.
        // Bin center of the next bin is mapped to binnum + 1.
        // Bin center of the previous bin is mapped to binnum - 1.
        //
        // const double binCenter = (left + right)/2.0;
        // if ((binnum == 0 && x <= binCenter) ||
        //     (static_cast<unsigned>(binnum) == nBins_ - 1 && x >= binCenter))
        //     return binnum + (x - left)/(right - left) - 0.5;
        // else if (x <= binCenter)
        // {
        //     const double otherBinCenter = (left + binEdges_[binnum - 1])/2.0;
        //     return binnum + (x - binCenter)/(binCenter - otherBinCenter);
        // }
        // else
        // {
        //     const double otherBinCenter = (right + binEdges_[binnum + 2])/2.0;
        //     return binnum + (x - binCenter)/(otherBinCenter - binCenter);
        // }
      }
    }
  }

References binEdges_, dumpMFGeometry_cfg::delta, nBins_, mitigatedMETSequence_cff::U, and pfDeepBoostedJetPreprocessParams_cfi::upper_bound.

Referenced by npstat::DualHistoAxis::fltBinNumber().

interval()

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

inline

Definition at line 41 of file NUHistoAxis.h.

{ return Interval<double>(min_, max_); }

References max_, and min_.

Referenced by npstat::DualHistoAxis::interval().

isClose()

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

Comparison of axis coordinates within given tolerance

Definition at line 45 of file NUHistoAxis.cc.

                                                                        {
    if (!(closeWithinTolerance(min_, r.min_, tol) && closeWithinTolerance(max_, r.max_, tol) && label_ == r.label_ &&
          nBins_ == r.nBins_ && uniform_ == r.uniform_))
      return false;
    for (unsigned i = 0; i < nBins_; ++i)
      if (!closeWithinTolerance(binEdges_[i], r.binEdges_[i], tol))
        return false;
    return true;
  }

References binEdges_, npstat::closeWithinTolerance(), mps_fire::i, label_, max_, min_, nBins_, alignCSCRings::r, and uniform_.

Referenced by npstat::DualHistoAxis::isClose().

isUniform()

bool npstat::NUHistoAxis::isUniform ( ) const

inline

Definition at line 46 of file NUHistoAxis.h.

{ return uniform_; }

References uniform_.

label()

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

inline

Definition at line 45 of file NUHistoAxis.h.

{ return label_; }

References label_.

Referenced by npstat::convertToGridAxis(), npstat::DualHistoAxis::label(), NUHistoAxis(), and read().

leftBinEdge()

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

inline

Return the coordinate of the given bin left edge

Definition at line 50 of file NUHistoAxis.h.

{ return binEdges_.at(binNum); }

References binEdges_.

Referenced by npstat::DualHistoAxis::leftBinEdge().

length()

double npstat::NUHistoAxis::length ( ) const

inline

Definition at line 42 of file NUHistoAxis.h.

{ return max_ - min_; }

References max_, and min_.

Referenced by npstat::DualHistoAxis::length().

max()

double npstat::NUHistoAxis::max ( ) const

inline

Definition at line 40 of file NUHistoAxis.h.

{ return max_; }

References max_.

Referenced by npstat::DualHistoAxis::max().

min()

double npstat::NUHistoAxis::min ( ) const

inline

Examine axis properties

Definition at line 39 of file NUHistoAxis.h.

{ return min_; }

References min_.

Referenced by npstat::DualHistoAxis::min().

nBins()

unsigned npstat::NUHistoAxis::nBins ( ) const

inline

Definition at line 43 of file NUHistoAxis.h.

{ return nBins_; }

References nBins_.

Referenced by npstat::convertToGridAxis(), npstat::DualHistoAxis::nBins(), and NUHistoAxis().

operator!=()

bool npstat::NUHistoAxis::operator!=

(

const NUHistoAxis &

r

)

const

Definition at line 60 of file NUHistoAxis.cc.

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

References alignCSCRings::r.

operator==()

bool npstat::NUHistoAxis::operator==

(

const NUHistoAxis &

r

)

const

Definition at line 55 of file NUHistoAxis.cc.

                                                         {
    return min_ == r.min_ && max_ == r.max_ && label_ == r.label_ && nBins_ == r.nBins_ && binEdges_ == r.binEdges_ &&
           uniform_ == r.uniform_;
  }

References binEdges_, label_, max_, min_, nBins_, alignCSCRings::r, and uniform_.

overflowIndex()

unsigned npstat::NUHistoAxis::overflowIndex ( const double  x, unsigned *  binNum  ) const

inlineprivate

Definition at line 117 of file NUHistoAxis.h.

                                                                          {
      if (x < min_)
        return 0U;
      else if (x >= max_)
        return 2U;
      else {
        *binNum = binNumber(x);
        return 1U;
      }
    }

References binNumber(), max_, min_, mitigatedMETSequence_cff::U, and x.

Referenced by npstat::DualHistoAxis::overflowIndex().

read()

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

static

Definition at line 142 of file NUHistoAxis.cc.

                                                                    {
    static const gs::ClassId current(gs::ClassId::makeId<NUHistoAxis>());
    current.ensureSameId(id);
 
    std::vector<double> binEdges;
    std::string label;
    unsigned char unif;
    gs::read_pod_vector(in, &binEdges);
    gs::read_pod(in, &label);
    gs::read_pod(in, &unif);
    if (in.fail())
      throw gs::IOReadFailure(
          "In npstat::UHistoAxis::read: "
          "input stream failure");
    NUHistoAxis* result = new NUHistoAxis(binEdges, label.c_str());
    result->uniform_ = unif;
    return result;
  }

References recoMuon::in, label(), NUHistoAxis(), mps_fire::result, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edmIntegrityCheck.PublishToFileSystem::get(), and npstat::DualHistoAxis::read().

rebin()

NUHistoAxis npstat::NUHistoAxis::rebin

(

unsigned

newBins

)

const

Return uniformly rebinned axis

Definition at line 41 of file NUHistoAxis.cc.

                                                             {
    return NUHistoAxis(newBins, min_, max_, label_.c_str());
  }

References label_, max_, min_, and NUHistoAxis().

rightBinEdge()

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

inline

Return the coordinate of the given bin right edge

Definition at line 53 of file NUHistoAxis.h.

{ return binEdges_.at(binNum + 1); }

References binEdges_.

Referenced by npstat::DualHistoAxis::rightBinEdge().

setLabel()

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

inline

Change the axis label

Definition at line 64 of file NUHistoAxis.h.

{ label_ = newlabel ? newlabel : ""; }

References label_.

Referenced by npstat::DualHistoAxis::setLabel().

version()

static unsigned npstat::NUHistoAxis::version ( )

inlinestatic

Definition at line 100 of file NUHistoAxis.h.

{ return 1; }

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

write()

bool npstat::NUHistoAxis::write

(

std::ostream &

of

)

const

Definition at line 134 of file NUHistoAxis.cc.

                                              {
    gs::write_pod_vector(of, binEdges_);
    gs::write_pod(of, label_);
    unsigned char c = uniform_;
    gs::write_pod(of, c);
    return !of.fail();
  }

References binEdges_, c, label_, and uniform_.

Referenced by npstat::DualHistoAxis::write().

Friends And Related Function Documentation

DualHistoAxis

friend class DualHistoAxis

friend

Definition at line 115 of file NUHistoAxis.h.

HistoND

template<typename Numeric , class Axis >

friend class HistoND

friend

Definition at line 114 of file NUHistoAxis.h.

Member Data Documentation

binEdges_

std::vector<double> npstat::NUHistoAxis::binEdges_

private

Definition at line 108 of file NUHistoAxis.h.

Referenced by binCenter(), binInterval(), binNumber(), binWidth(), closestValidBin(), fltBinNumber(), isClose(), leftBinEdge(), NUHistoAxis(), operator==(), rightBinEdge(), and write().

label_

std::string npstat::NUHistoAxis::label_

private

Definition at line 109 of file NUHistoAxis.h.

Referenced by SequenceTypes.DummyModule::__repr__(), Mixins._Labelable::_findDependencies(), isClose(), label(), NUHistoAxis(), operator==(), rebin(), setLabel(), Mixins._Labelable::setLabel(), and write().

max_

double npstat::NUHistoAxis::max_

private

Definition at line 107 of file NUHistoAxis.h.

Referenced by interval(), isClose(), length(), max(), NUHistoAxis(), operator==(), overflowIndex(), and rebin().

min_

double npstat::NUHistoAxis::min_

private

Definition at line 106 of file NUHistoAxis.h.

Referenced by interval(), isClose(), length(), min(), NUHistoAxis(), operator==(), overflowIndex(), and rebin().

nBins_

unsigned npstat::NUHistoAxis::nBins_

private

Definition at line 110 of file NUHistoAxis.h.

Referenced by closestValidBin(), fltBinNumber(), isClose(), nBins(), NUHistoAxis(), and operator==().

uniform_

bool npstat::NUHistoAxis::uniform_

private

Definition at line 111 of file NUHistoAxis.h.

Referenced by isClose(), isUniform(), operator==(), and write().