MonitorElement.h

Go to the documentation of this file.

#ifndef DQMSERVICES_CORE_MONITOR_ELEMENT_H
# define DQMSERVICES_CORE_MONITOR_ELEMENT_H

# include "DQMServices/Core/interface/DQMNet.h"
# include "DQMServices/Core/interface/QReport.h"
# include "TF1.h"
# include "TH1F.h"
# include "TH1S.h"
# include "TH1D.h"
# include "TH2F.h"
# include "TH2S.h"
# include "TH2D.h"
# include "TH3F.h"
# include "TProfile.h"
# include "TProfile2D.h"
# include "TObjString.h"
# include "TAxis.h"
# include <sys/time.h>
# include <string>
# include <set>
# include <map>
# include <sstream>
# include <iomanip>
# include <cassert>
# include <cstdint>

# ifndef DQM_ROOT_METHODS
#  define DQM_ROOT_METHODS 1
# endif

class QCriterion;

// tag for a special constructor, see below
struct MonitorElementNoCloneTag {};

class MonitorElement
{
  friend class DQMStore;
  friend class DQMService;
public:
  struct Scalar
  {
    int64_t             num;
    double              real;
    std::string         str;
  };

  enum Kind
  {
    DQM_KIND_INVALID    = DQMNet::DQM_PROP_TYPE_INVALID,
    DQM_KIND_INT        = DQMNet::DQM_PROP_TYPE_INT,
    DQM_KIND_REAL       = DQMNet::DQM_PROP_TYPE_REAL,
    DQM_KIND_STRING     = DQMNet::DQM_PROP_TYPE_STRING,
    DQM_KIND_TH1F       = DQMNet::DQM_PROP_TYPE_TH1F,
    DQM_KIND_TH1S       = DQMNet::DQM_PROP_TYPE_TH1S,
    DQM_KIND_TH1D       = DQMNet::DQM_PROP_TYPE_TH1D,
    DQM_KIND_TH2F       = DQMNet::DQM_PROP_TYPE_TH2F,
    DQM_KIND_TH2S       = DQMNet::DQM_PROP_TYPE_TH2S,
    DQM_KIND_TH2D       = DQMNet::DQM_PROP_TYPE_TH2D,
    DQM_KIND_TH3F       = DQMNet::DQM_PROP_TYPE_TH3F,
    DQM_KIND_TPROFILE   = DQMNet::DQM_PROP_TYPE_TPROF,
    DQM_KIND_TPROFILE2D = DQMNet::DQM_PROP_TYPE_TPROF2D
  };

private:
  DQMNet::CoreObject    data_;       //< Core object information.
  Scalar                scalar_;     //< Current scalar value.
  TH1                   *object_;    //< Current ROOT object value.
  TH1                   *reference_; //< Current ROOT reference object.
  TH1                   *refvalue_;  //< Soft reference if any.
  std::vector<QReport>  qreports_;   //< QReports associated to this object.

  MonitorElement *initialise(Kind kind);
  MonitorElement *initialise(Kind kind, TH1 *rootobj);
  MonitorElement *initialise(Kind kind, const std::string &value);
  void globalize() {
    data_.streamId = 0;
    data_.moduleId = 0;
  }
  void setLumi(uint32_t ls) {data_.lumi = ls;}

public:
  MonitorElement();
  MonitorElement(const std::string *path,
                 const std::string &name,
                 uint32_t run = 0,
                 uint32_t streamId = 0,
                 uint32_t moduleId = 0);
  MonitorElement(const MonitorElement &, MonitorElementNoCloneTag);
  MonitorElement(const MonitorElement &);
  MonitorElement(MonitorElement &&);
  MonitorElement &operator=(const MonitorElement &) = delete;
  MonitorElement &operator=(MonitorElement &&) = delete;
  ~MonitorElement();

  bool operator<(const MonitorElement &x) const
    {
      return DQMNet::setOrder(data_, x.data_);
    }

  static bool CheckBinLabels(const TAxis* a1, const TAxis * a2);

  Kind kind() const
    { return Kind(data_.flags & DQMNet::DQM_PROP_TYPE_MASK); }

  uint32_t flags() const
    { return data_.flags; }

  const std::string &getName() const
    { return data_.objname; }

  const std::string &getPathname() const
    { return *data_.dirname; }

  const std::string getFullname() const
    {
      std::string path;
      path.reserve(data_.dirname->size() + data_.objname.size() + 2);
      path += *data_.dirname;
      if (! data_.dirname->empty())
        path += '/';
      path += data_.objname;
      return path;
    }

  bool wasUpdated() const
    { return data_.flags & DQMNet::DQM_PROP_NEW; }

  void update()
    { data_.flags |= DQMNet::DQM_PROP_NEW; }

  void setResetMe(bool /* flag */)
    { data_.flags |= DQMNet::DQM_PROP_RESET; }

  bool getLumiFlag() const
    { return data_.flags & DQMNet::DQM_PROP_LUMI; }

  void setLumiFlag()
    { data_.flags |= DQMNet::DQM_PROP_LUMI; }

  void setEfficiencyFlag()
    { data_.flags |= DQMNet::DQM_PROP_EFFICIENCY_PLOT; }

  // A static assert to check that T actually fits in
  // int64_t.
  template <typename T>
  struct fits_in_int64_t
  {
    int checkArray[sizeof(int64_t) - sizeof(T) + 1];
  };

  void Fill(long long x) { fits_in_int64_t<long long>(); doFill(static_cast<int64_t>(x)); }
  void Fill(unsigned long long x) { fits_in_int64_t<unsigned long long>(); doFill(static_cast<int64_t>(x)); }
  void Fill(unsigned long x) { fits_in_int64_t<unsigned long>(); doFill(static_cast<int64_t>(x)); }
  void Fill(long x) { fits_in_int64_t<long>(); doFill(static_cast<int64_t>(x)); }
  void Fill(unsigned int x) { fits_in_int64_t<unsigned int>(); doFill(static_cast<int64_t>(x)); }
  void Fill(int x) { fits_in_int64_t<int>(); doFill(static_cast<int64_t>(x)); }
  void Fill(short x) { fits_in_int64_t<short>(); doFill(static_cast<int64_t>(x)); }
  void Fill(unsigned short x) { fits_in_int64_t<unsigned short>(); doFill(static_cast<int64_t>(x)); }
  void Fill(char x) { fits_in_int64_t<char>(); doFill(static_cast<int64_t>(x)); }
  void Fill(unsigned char x) { fits_in_int64_t<unsigned char>(); doFill(static_cast<int64_t>(x)); }

  void Fill(float x)    { Fill(static_cast<double>(x)); }
  void Fill(double x);
  void Fill(std::string &value);

  void Fill(double x, double yw);
  void Fill(double x, double y, double zw);
  void Fill(double x, double y, double z, double w);
  void ShiftFillLast(double y, double ye = 0., int32_t xscale = 1);
  void Reset();

  std::string valueString() const;
  std::string tagString() const;
  std::string tagLabelString() const;
  std::string effLabelString() const;
  std::string qualityTagString(const DQMNet::QValue &qv) const;
  void packScalarData(std::string &into, const char *prefix) const;
  void packQualityData(std::string &into) const;

  bool hasError() const
    { return data_.flags & DQMNet::DQM_PROP_REPORT_ERROR; }

  bool hasWarning() const
    { return data_.flags & DQMNet::DQM_PROP_REPORT_WARN; }

  bool hasOtherReport() const
    { return data_.flags & DQMNet::DQM_PROP_REPORT_OTHER; }

  bool isEfficiency() const
    { return data_.flags & DQMNet::DQM_PROP_EFFICIENCY_PLOT; }

  const QReport *getQReport(const std::string &qtname) const;

  std::vector<QReport *> getQReports() const;

  std::vector<QReport *> getQWarnings() const;

  std::vector<QReport *> getQErrors() const;

  std::vector<QReport *> getQOthers() const;

  void runQTests();

private:
  void doFill(int64_t x);
  void incompatible(const char *func) const;
  TH1 *accessRootObject(const char *func, int reqdim) const;

public:
#if DQM_ROOT_METHODS
  double getMean(int axis = 1) const;
  double getMeanError(int axis = 1) const;
  double getRMS(int axis = 1) const;
  double getRMSError(int axis = 1) const;
  int getNbinsX() const;
  int getNbinsY() const;
  int getNbinsZ() const;
  double getBinContent(int binx) const;
  double getBinContent(int binx, int biny) const;
  double getBinContent(int binx, int biny, int binz) const;
  double getBinError(int binx) const;
  double getBinError(int binx, int biny) const;
  double getBinError(int binx, int biny, int binz) const;
  double getEntries() const;
  double getBinEntries(int bin) const;

private:
  double getYmin() const;
  double getYmax() const;

public:
  std::string getAxisTitle(int axis = 1) const;
  std::string getTitle() const;
  void setBinContent(int binx, double content);
  void setBinContent(int binx, int biny, double content);
  void setBinContent(int binx, int biny, int binz, double content);
  void setBinError(int binx, double error);
  void setBinError(int binx, int biny, double error);
  void setBinError(int binx, int biny, int binz, double error);
  void setBinEntries(int bin, double nentries);
  void setEntries(double nentries);
  void setBinLabel(int bin, const std::string &label, int axis = 1);
  void setAxisRange(double xmin, double xmax, int axis = 1);
  void setAxisTitle(const std::string &title, int axis = 1);
  void setAxisTimeDisplay(int value, int axis = 1);
  void setAxisTimeFormat(const char *format = "", int axis = 1);

private:
  void setAxisTimeOffset(double toffset, const char *option="local", int axis = 1);

public:
  void setTitle(const std::string &title);
#endif // DQM_ROOT_METHODS

private:
  bool isSoftResetEnabled() const
    { return refvalue_ != nullptr; }

  bool isAccumulateEnabled() const
    { return data_.flags & DQMNet::DQM_PROP_ACCUMULATE; }

  bool markedToDelete() const
    { return data_.flags & DQMNet::DQM_PROP_MARKTODELETE; }

  void markToDelete()
    { data_.flags |= DQMNet::DQM_PROP_MARKTODELETE; }

private:
  void resetUpdate()
    { data_.flags &= ~DQMNet::DQM_PROP_NEW; }

  bool resetMe() const
    { return data_.flags & DQMNet::DQM_PROP_RESET; }

  void setAccumulate(bool /* flag */)
    { data_.flags |= DQMNet::DQM_PROP_ACCUMULATE; }

  TAxis *getAxis(const char *func, int axis) const;

  // ------------ Operations for MEs that are normally never reset ---------
public:
  void softReset();
private:
  void disableSoftReset();
  void addProfiles(TProfile *h1, TProfile *h2, TProfile *sum, float c1, float c2);
  void addProfiles(TProfile2D *h1, TProfile2D *h2, TProfile2D *sum, float c1, float c2);
  void copyFunctions(TH1 *from, TH1 *to);
  void copyFrom(TH1 *from);


  // --- Operations on MEs that are normally reset at end of monitoring cycle ---
  void getQReport(bool create, const std::string &qtname, QReport *&qr, DQMNet::QValue *&qv);
  void addQReport(const DQMNet::QValue &desc, QCriterion *qc);
  void addQReport(QCriterion *qc);
  void updateQReportStats();

public:
  TObject *getRootObject() const;
  TH1 *getTH1() const;
  TH1F *getTH1F() const;
  TH1S *getTH1S() const;
  TH1D *getTH1D() const;
  TH2F *getTH2F() const;
  TH2S *getTH2S() const;
  TH2D *getTH2D() const;
  TH3F *getTH3F() const;
  TProfile *getTProfile() const;
  TProfile2D *getTProfile2D() const;

  TObject *getRefRootObject() const;
  TH1 *getRefTH1() const;
  TH1F *getRefTH1F() const;
  TH1S *getRefTH1S() const;
  TH1D *getRefTH1D() const;
  TH2F *getRefTH2F() const;
  TH2S *getRefTH2S() const;
  TH2D *getRefTH2D() const;
  TH3F *getRefTH3F() const;
  TProfile *getRefTProfile() const;
  TProfile2D *getRefTProfile2D() const;

  int64_t getIntValue() const
    {
      assert(kind() == DQM_KIND_INT);
      return scalar_.num;
    }

  double getFloatValue() const
    {
      assert(kind() == DQM_KIND_REAL);
      return scalar_.real;
    }

  const std::string &getStringValue() const
    {
      assert(kind() == DQM_KIND_STRING);
      return scalar_.str;
    }

  DQMNet::TagList getTags() const // DEPRECATED
    {
      DQMNet::TagList tags;
      if (data_.flags & DQMNet::DQM_PROP_TAGGED)
        tags.push_back(data_.tag);
      return tags;
    }

  const uint32_t getTag() const
    { return data_.tag; }

  const uint32_t run() const {return data_.run;}
  const uint32_t lumi() const {return data_.lumi;}
  const uint32_t streamId() const {return data_.streamId;}
  const uint32_t moduleId() const {return data_.moduleId;}
};

#endif // DQMSERVICES_CORE_MONITOR_ELEMENT_H