Histo1D.h

Go to the documentation of this file.

/* Copyright (C) 2023 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Volker Friese [committer] */
 
#ifndef ALGO_QA_HISTO1D_H
#define ALGO_QA_HISTO1D_H 1
 
#include <boost/serialization/access.hpp>
#include <boost/serialization/version.hpp>
 
#include <cstdint>
#include <string>
#include <vector>
 
 
namespace cbm::algo
{
 
  class Histo1D {
   public:
    Histo1D(uint32_t numBins, double minValue, double maxValue, const std::string& name = "",
            const std::string& title = "");
 
 
    Histo1D(const Histo1D&) = default;
 
 
    virtual ~Histo1D() = default;
 
 
    void Add(double value, double weight = 1.);
 
 
    void Clear();
 
 
    double Content(uint32_t bin) const;
 
 
    double NumEntries() const { return fNumEntries; }
 
 
    double MaxValue() const { return fMaxValue; }
 
 
    double Mean() const;
 
 
    double MinValue() const { return fMinValue; }
 
 
    const std::string& Name() const { return fName; }
 
 
    const std::string& Title() const { return fTitle; }
 
 
    uint32_t NumBins() const { return fNumBins; }
 
    Histo1D& operator+=(const Histo1D& other);
 
 
    double Overflow() const { return fOverflow; }
 
 
    double Underflow() const { return fUnderflow; }
 
 
    double Stddev() const;
 
 
    std::string ToString() const;
 
 
   private:
    std::string fName;
    std::string fTitle;
    uint32_t fNumBins;
    double fMinValue;
    double fMaxValue;
 
    std::vector<double> fContent = {};
    double fUnderflow            = 0;
    double fOverflow             = 0;
    size_t fNumEntries           = 0;
 
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int /*version*/)
    {
      ar& fName;
      ar& fTitle;
      ar& fNumBins;
      ar& fMinValue;
      ar& fMaxValue;
      ar& fContent;
      ar& fUnderflow;
      ar& fOverflow;
      ar& fNumEntries;
    }
 
    Histo1D() : fName(""), fTitle(""), fNumBins(0), fMinValue(0), fMaxValue(0){};
  };
 
 
  inline Histo1D operator+(Histo1D h1, const Histo1D& h2)
  {
    h1 += h2;
    return h1;
  }
 
} /* namespace cbm::algo */
 
BOOST_CLASS_VERSION(cbm::algo::Histo1D, 1)
 
#endif /* ALGO_QA_HISTO1D_H */