NUHistoAxis.h

Go to the documentation of this file.

#ifndef NPSTAT_NUHISTOAXIS_HH_
#define NPSTAT_NUHISTOAXIS_HH_

#include <vector>
#include <utility>

#include "Alignment/Geners/interface/ClassId.hh"
#include "JetMETCorrections/InterpolationTables/interface/Interval.h"

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

    class NUHistoAxis
    {
    public:
        NUHistoAxis(const std::vector<double>& binEdges, 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) const
            {return binEdges_.at(binNum+1) - binEdges_.at(binNum);}
        inline const std::string& label() const {return label_;}
        inline bool isUniform() const {return uniform_;}

        inline double leftBinEdge(const int binNum) const
            {return binEdges_.at(binNum);}

        inline double rightBinEdge(const int binNum) const
            {return binEdges_.at(binNum + 1);}

        inline double binCenter(const int binNum) const
            {return 0.5*(binEdges_.at(binNum) + binEdges_.at(binNum + 1));}

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

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

        int binNumber(double x) const;

        double fltBinNumber(double x, bool mapLeftEdgeTo0=true) const;

        unsigned closestValidBin(double x) const;

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

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

        NUHistoAxis 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::NUHistoAxis";}
        static inline unsigned version() {return 1;}
        static NUHistoAxis* read(const gs::ClassId& id, std::istream& in);

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

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

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

        inline unsigned overflowIndex(
            const double x, unsigned* binNum) const
        {
            if (x < min_)
                return 0U;
            else if (x >= max_)
                return 2U;
            else
            {
                *binNum = binNumber(x);
                return 1U;
            }
        }

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

#endif // NPSTAT_NUHISTOAXIS_HH_