HistoAxis.h

Go to the documentation of this file.

#ifndef NPSTAT_HISTOAXIS_HH_
#define NPSTAT_HISTOAXIS_HH_

#include <utility>

#include "Alignment/Geners/interface/ClassId.hh"

#include "JetMETCorrections/InterpolationTables/interface/CircularMapper1d.h"
#include "JetMETCorrections/InterpolationTables/interface/Interval.h"

namespace npstat {
    template <typename Numeric, class Axis> class HistoND;
    class DualHistoAxis;

    class HistoAxis
    {
    public:
        HistoAxis(unsigned nBins, double min, double max,
                  const char* label=nullptr);


        inline double min() const {return min_;}
        inline double max() const {return max_;}
        inline Interval<double> interval() const
            {return Interval<double>(min_, max_);}
        inline double length() const {return max_ - min_;}
        inline unsigned nBins() const {return nBins_;}
        inline double binWidth(const int /*binNum*/=0) const {return bw_;}
        inline const std::string& label() const {return label_;}
        inline bool isUniform() const {return true;}

        inline double binCenter(const int binNum) const
            {return min_ + (binNum + 0.5)*bw_;}

        inline double leftBinEdge(const int binNum) const
            {return min_ + binNum*bw_;}

        inline double rightBinEdge(const int binNum) const
            {return min_ + (binNum + 1)*bw_;}

        inline Interval<double> binInterval(const int binNum) const
            {return Interval<double>(min_+binNum*bw_, min_+(binNum+1)*bw_);}

        inline void setLabel(const char* newlabel)
            {label_ = newlabel ? newlabel : "";}

        int binNumber(double x) const;

        unsigned closestValidBin(double x) const;

        LinearMapper1d binNumberMapper(bool mapLeftEdgeTo0=true) const;

        inline double fltBinNumber(const double x,
                                   const bool mapLeftEdgeTo0=true) const
            {return (x - min_)/bw_ - (mapLeftEdgeTo0 ? 0.0 : 0.5);}

        CircularMapper1d kernelScanMapper(bool doubleRange) const;

        bool operator==(const HistoAxis&) const;
        bool operator!=(const HistoAxis&) const;

        bool isClose(const HistoAxis&, double tol) const;

        HistoAxis rebin(unsigned newBins) const;


        inline gs::ClassId classId() const {return gs::ClassId(*this);}
        bool write(std::ostream& of) const;

        static inline const char* classname() {return "npstat::HistoAxis";}
        static inline unsigned version() {return 1;}
        static HistoAxis* read(const gs::ClassId& id, std::istream& in);

    private:
        double min_;
        double max_;
        double bw_;
        std::string label_;
        unsigned nBins_;

        template <typename Numeric, class Axis> friend class HistoND;
        friend class DualHistoAxis;

        inline unsigned overflowIndex(
            const double x, unsigned* binNumber) const
        {
            if (x < min_)
                return 0U;
            else if (x >= max_)
                return 2U;
            else
            {
                const unsigned bin = static_cast<unsigned>((x - min_)/bw_);
                *binNumber = bin >= nBins_ ? nBins_ - 1U : bin;
                return 1U;
            }
        }

        unsigned overflowIndexWeighted(double x, unsigned* binNumber,
                                       double *weight) const;
        inline HistoAxis() : min_(0.0), max_(0.0), bw_(0.0), nBins_(0) {}
    };
}

#endif // NPSTAT_HISTOAXIS_HH_