MESet.h

Go to the documentation of this file.

#ifndef MESet_H
#define MESet_H

#include "DQM/EcalCommon/interface/MESetBinningUtils.h"

#include "DQMServices/Core/interface/DQMStore.h"

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/EcalDetId/interface/EcalElectronicsId.h"

#include "Geometry/EcalMapping/interface/EcalElectronicsMapping.h"
#include "Geometry/CaloTopology/interface/EcalTrigTowerConstituentsMap.h"
#include "Geometry/CaloGeometry/interface/CaloGeometry.h"
#include "Geometry/CaloTopology/interface/CaloTopology.h"

#include "FWCore/Utilities/interface/Exception.h"

#include <string>
#include <map>
#include <memory>
#include <vector>

namespace ecaldqm {
  /*
  class MESet
  Base class for MonitorElement wrappers
  Interface between ME bins and DetId
*/

  // struct made to simplify passing multiple setup
  // variables (see DQWorker.h for implementation)
  // to MESet functions
  struct EcalDQMSetupObjects {
    EcalElectronicsMapping const *electronicsMap;
    EcalTrigTowerConstituentsMap const *trigtowerMap;
    CaloGeometry const *geometry;
    CaloTopology const *topology;
  };

  class StatusManager;

  class MESet {
  public:
    typedef dqm::legacy::DQMStore DQMStore;
    typedef dqm::legacy::MonitorElement MonitorElement;
    typedef std::map<std::string, std::string> PathReplacements;

    MESet();
    MESet(std::string const &, binning::ObjectType, binning::BinningType, MonitorElement::Kind);
    MESet(MESet const &);
    virtual ~MESet();

    virtual MESet &operator=(MESet const &);

    virtual MESet *clone(std::string const & = "") const;

    virtual void book(DQMStore::IBooker &, EcalElectronicsMapping const *) {}
    virtual bool retrieve(EcalElectronicsMapping const *, DQMStore::IGetter &, std::string * = nullptr) const {
      return false;
    }
    virtual void clear() const;

    // Overloaded functions deal with different ids or
    // inputs to fill, setBinContent, etc and each determines
    // the correct bin to fill based on what is passed.
    //
    // Note: not every fill, setBinContent, etc necessarily uses
    // EcalDQMSetupObjects, but they are passed one anyway to
    // avoid accidentally casting a DetId or a EcalElectronicsId
    // to an int or a double and have it exercute the wrong function.
    // This would be tricky to debug if this error is made, so it
    // makes more sense for these functions to look consistent in
    // terms of passing EcalDQMSetupObjects.
    virtual void fill(EcalDQMSetupObjects const, DetId const &, double = 1., double = 1., double = 1.) {}
    virtual void fill(EcalDQMSetupObjects const, EcalElectronicsId const &, double = 1., double = 1., double = 1.) {}
    virtual void fill(EcalDQMSetupObjects const, int, double = 1., double = 1., double = 1.) {}
    virtual void fill(EcalDQMSetupObjects const, double, double = 1., double = 1.) {}

    virtual void setBinContent(EcalDQMSetupObjects const, DetId const &, double) {}
    virtual void setBinContent(EcalDQMSetupObjects const, EcalElectronicsId const &, double) {}
    virtual void setBinContent(EcalDQMSetupObjects const, int, double) {}
    virtual void setBinContent(EcalDQMSetupObjects const, DetId const &, int, double) {}
    virtual void setBinContent(EcalDQMSetupObjects const, EcalElectronicsId const &, int, double) {}
    virtual void setBinContent(EcalDQMSetupObjects const, int, int, double) {}

    virtual void setBinError(EcalDQMSetupObjects const, DetId const &, double) {}
    virtual void setBinError(EcalDQMSetupObjects const, EcalElectronicsId const &, double) {}
    virtual void setBinError(EcalDQMSetupObjects const, int, double) {}
    virtual void setBinError(EcalDQMSetupObjects const, DetId const &, int, double) {}
    virtual void setBinError(EcalDQMSetupObjects const, EcalElectronicsId const &, int, double) {}
    virtual void setBinError(EcalDQMSetupObjects const, int, int, double) {}

    virtual void setBinEntries(EcalDQMSetupObjects const, DetId const &, double) {}
    virtual void setBinEntries(EcalDQMSetupObjects const, EcalElectronicsId const &, double) {}
    virtual void setBinEntries(EcalDQMSetupObjects const, int, double) {}
    virtual void setBinEntries(EcalDQMSetupObjects const, DetId const &, int, double) {}
    virtual void setBinEntries(EcalDQMSetupObjects const, EcalElectronicsId const &, int, double) {}
    virtual void setBinEntries(EcalDQMSetupObjects const, int, int, double) {}

    virtual double getBinContent(EcalDQMSetupObjects const, DetId const &, int = 0) const { return 0.; }
    virtual double getBinContent(EcalDQMSetupObjects const, EcalElectronicsId const &, int = 0) const { return 0.; }
    virtual double getBinContent(EcalDQMSetupObjects const, int, int = 0) const { return 0.; }

    virtual double getBinError(EcalDQMSetupObjects const, DetId const &, int = 0) const { return 0.; }
    virtual double getBinError(EcalDQMSetupObjects const, EcalElectronicsId const &, int = 0) const { return 0.; }
    virtual double getBinError(EcalDQMSetupObjects const, int, int = 0) const { return 0.; }

    virtual double getBinEntries(EcalDQMSetupObjects const, DetId const &, int = 0) const { return 0.; }
    virtual double getBinEntries(EcalDQMSetupObjects const, EcalElectronicsId const &, int = 0) const { return 0.; }
    virtual double getBinEntries(EcalDQMSetupObjects const, int, int = 0) const { return 0.; }

    // title, axis
    virtual void setAxisTitle(std::string const &, int = 1);

    virtual void reset(EcalElectronicsMapping const *, double = 0., double = 0., double = 0.);
    virtual void resetAll(double = 0., double = 0., double = 0.);

    virtual bool maskMatches(DetId const &, uint32_t, StatusManager const *, EcalTrigTowerConstituentsMap const *) const;

    virtual std::string const &getPath() const { return path_; }
    binning::ObjectType getObjType() const { return otype_; }
    binning::BinningType getBinType() const { return btype_; }
    MonitorElement::Kind getKind() const { return kind_; }
    bool isActive() const { return active_; }  // booked or retrieved
    virtual bool isVariableBinning() const { return false; }
    virtual MonitorElement const *getME(unsigned _iME) const { return (_iME < mes_.size() ? mes_[_iME] : nullptr); }
    virtual MonitorElement *getME(unsigned _iME) { return (_iME < mes_.size() ? mes_[_iME] : nullptr); }

    std::string formPath(PathReplacements const &) const;

    void setLumiFlag() { lumiFlag_ = true; };
    bool getLumiFlag() const { return lumiFlag_; }
    void setBatchMode() { batchMode_ = true; }
    bool getBatchMode() const { return batchMode_; }

  protected:
    virtual void fill_(unsigned, int, double);
    virtual void fill_(unsigned, int, double, double);
    virtual void fill_(unsigned, double, double, double);

    virtual void checkME_(unsigned _iME) const {
      if (!getME(_iME)) {
        std::stringstream ss;
        ss << "ME does not exist at index " << _iME;
        throw_(ss.str());
      }
    }

    void throw_(std::string const &_message) const { throw cms::Exception("EcalDQM") << path_ << ": " << _message; }

    mutable std::vector<MonitorElement *> mes_;

    mutable std::string path_;
    binning::ObjectType otype_;
    binning::BinningType btype_;
    MonitorElement::Kind kind_;
    bool lumiFlag_;   // when true, histograms will be saved every lumi section
                      // (default false)
    bool batchMode_;  // when true, histograms are not GUI-ready (default false)

    mutable bool active_;

  public:
    struct ConstBin {
    protected:
      MESet const *meSet_;

    public:
      unsigned iME;
      int iBin;
      binning::ObjectType otype;

      ConstBin() : meSet_(nullptr), iME(-1), iBin(-1), otype(binning::nObjType) {}
      ConstBin(MESet const &, unsigned = 0, int = 1);
      ConstBin(ConstBin const &_orig) : meSet_(_orig.meSet_), iME(_orig.iME), iBin(_orig.iBin), otype(_orig.otype) {}
      ConstBin &operator=(ConstBin const &);
      bool operator==(ConstBin const &_rhs) const {
        return meSet_ != nullptr && meSet_ == _rhs.meSet_ && iME == _rhs.iME && iBin == _rhs.iBin;
      }
      bool isChannel(EcalElectronicsMapping const *electronicsMap) const {
        if (meSet_)
          return binning::isValidIdBin(electronicsMap, otype, meSet_->getBinType(), iME, iBin);
        else
          return false;
      }
      uint32_t getId() const {
        if (meSet_)
          return binning::idFromBin(otype, meSet_->getBinType(), iME, iBin);
        else
          return 0;
      }
      double getBinContent() const {
        if (meSet_ && iME != unsigned(-1))
          return meSet_->getME(iME)->getBinContent(iBin);
        else
          return 0.;
      }
      double getBinError() const {
        if (meSet_ && iME != unsigned(-1))
          return meSet_->getME(iME)->getBinError(iBin);
        else
          return 0.;
      }
      double getBinEntries() const {
        if (meSet_ && iME != unsigned(-1))
          return meSet_->getME(iME)->getBinEntries(iBin);
        else
          return 0.;
      }
      MonitorElement const *getME() const {
        if (meSet_ && iME != unsigned(-1))
          return meSet_->getME(iME);
        else
          return nullptr;
      }
      void setMESet(MESet const &_meSet) { meSet_ = &_meSet; }
      MESet const *getMESet() const { return meSet_; }
    };

    struct Bin : public ConstBin {
    protected:
      MESet *meSet_;

    public:
      Bin() : ConstBin(), meSet_(nullptr) {}
      Bin(MESet &_set, unsigned _iME = 0, int _iBin = 1) : ConstBin(_set, _iME, _iBin), meSet_(&_set) {}
      Bin(Bin const &_orig) : ConstBin(_orig), meSet_(_orig.meSet_) {}
      ConstBin &operator=(Bin const &_rhs) {
        bool wasNull(ConstBin::meSet_ == nullptr);
        ConstBin::operator=(_rhs);
        if (wasNull)
          meSet_ = _rhs.meSet_;
        return *this;
      }
      void fill(double _w = 1.) {
        if (meSet_)
          meSet_->fill_(iME, iBin, _w);
      }
      void fill(double _y, double _w = 1.) {
        if (meSet_)
          meSet_->fill_(iME, iBin, _y, _w);
      }
      void setBinContent(double _content) {
        if (meSet_ && iME != unsigned(-1))
          meSet_->getME(iME)->setBinContent(iBin, _content);
      }
      void setBinError(double _error) {
        if (meSet_ && iME != unsigned(-1))
          meSet_->getME(iME)->setBinError(iBin, _error);
      }
      void setBinEntries(double _entries) {
        if (meSet_ && iME != unsigned(-1))
          meSet_->getME(iME)->setBinEntries(iBin, _entries);
      }
      MonitorElement *getME() const {
        if (meSet_ && iME != unsigned(-1))
          return meSet_->getME(iME);
        else
          return nullptr;
      }
      void setMESet(MESet &_meSet) {
        ConstBin::meSet_ = &_meSet;
        meSet_ = &_meSet;
      }
      MESet *getMESet() const { return meSet_; }
    };

    /* const_iterator
     iterates over bins
     supports automatic transition between MEs in the same set
     underflow -> bin == 0 overflow -> bin == -1
  */
    struct const_iterator {
      const_iterator() : bin_() {}
      const_iterator(EcalElectronicsMapping const *, MESet const &_meSet, unsigned _iME = 0, int _iBin = 1)
          : bin_(_meSet, _iME, _iBin) {}
      const_iterator(EcalElectronicsMapping const *, MESet const &, DetId const &);
      const_iterator(const_iterator const &_orig) = default;
      const_iterator(const_iterator &&_orig) = default;
      const_iterator &operator=(const_iterator const &_orig) = default;
      const_iterator &operator=(const_iterator &&_orig) = default;
      bool operator==(const_iterator const &_rhs) const { return bin_ == _rhs.bin_; }
      bool operator!=(const_iterator const &_rhs) const { return !(bin_ == _rhs.bin_); }
      ConstBin const *operator->() const { return &bin_; }
      const_iterator &operator++();
      const_iterator &toNextChannel(EcalElectronicsMapping const *);
      bool up();
      bool down();
      bool left();
      bool right();

    protected:
      ConstBin bin_;
    };

    struct iterator : public const_iterator {
      iterator() : const_iterator(), bin_() {}
      iterator(EcalElectronicsMapping const *electronicsMap, MESet &_meSet, unsigned _iME = 0, int _iBin = 1)
          : const_iterator(electronicsMap, _meSet, _iME, _iBin), bin_(_meSet) {
        bin_.ConstBin::operator=(const_iterator::bin_);
      }
      iterator(EcalElectronicsMapping const *electronicsMap, MESet &_meSet, DetId const &_id)
          : const_iterator(electronicsMap, _meSet, _id), bin_(_meSet) {
        bin_.ConstBin::operator=(const_iterator::bin_);
      }
      iterator(iterator const &_orig) = default;
      iterator &operator=(iterator const &) = default;
      iterator &operator=(const_iterator const &_rhs) {
        const_iterator::operator=(_rhs);
        bin_.ConstBin::operator=(const_iterator::bin_);
        return *this;
      }
      Bin *operator->() { return &bin_; }
      Bin const *operator->() const { return &bin_; }
      const_iterator &operator++() {
        const_iterator::operator++();
        bin_.ConstBin::operator=(const_iterator::bin_);
        return *this;
      }
      const_iterator &toNextChannel(EcalElectronicsMapping const *electronicsMap) {
        const_iterator::toNextChannel(electronicsMap);
        bin_.ConstBin::operator=(const_iterator::bin_);
        return *this;
      }
      bool up() {
        bool res(const_iterator::up());
        bin_.ConstBin::operator=(const_iterator::bin_);
        return res;
      }
      bool down() {
        bool res(const_iterator::down());
        bin_.ConstBin::operator=(const_iterator::bin_);
        return res;
      }
      bool left() {
        bool res(const_iterator::left());
        bin_.ConstBin::operator=(const_iterator::bin_);
        return res;
      }
      bool right() {
        bool res(const_iterator::right());
        bin_.ConstBin::operator=(const_iterator::bin_);
        return res;
      }

    private:
      Bin bin_;
    };

    virtual const_iterator begin(EcalElectronicsMapping const *electronicsMap) const {
      return const_iterator(electronicsMap, *this);
    }

    virtual const_iterator end(EcalElectronicsMapping const *electronicsMap) const {
      return const_iterator(electronicsMap, *this, -1, -1);
    }

    virtual const_iterator beginChannel(EcalElectronicsMapping const *electronicsMap) const {
      const_iterator itr(electronicsMap, *this, 0, 0);
      return itr.toNextChannel(electronicsMap);
    }

    virtual iterator begin(EcalElectronicsMapping const *electronicsMap) { return iterator(electronicsMap, *this); }

    virtual iterator end(EcalElectronicsMapping const *electronicsMap) {
      return iterator(electronicsMap, *this, -1, -1);
    }

    virtual iterator beginChannel(EcalElectronicsMapping const *electronicsMap) {
      iterator itr(electronicsMap, *this, 0, 0);
      itr.toNextChannel(electronicsMap);
      return itr;
    }
  };

}  // namespace ecaldqm

namespace ecaldqm {

  class MESetCollection {
    using MESetColletionType = std::map<std::string, std::unique_ptr<MESet>>;

  public:
    using iterator = MESetColletionType::iterator;
    using const_iterator = MESetColletionType::const_iterator;

    void insert(const std::string &key, MESet *ptr) { _MESetColletion.emplace(key, ptr); }
    void insert(const std::string &&key, MESet *ptr) { _MESetColletion.emplace(key, ptr); }

    void erase(const std::string &key) { _MESetColletion.erase(key); }

    auto begin() { return _MESetColletion.begin(); }
    auto end() const { return _MESetColletion.end(); }

    const_iterator find(const std::string &key) const { return _MESetColletion.find(key); }
    iterator find(const std::string &key) { return _MESetColletion.find(key); }

    //return a reference, but this collection still has the ownership
    MESet &at(const std::string &key) { return *(_MESetColletion.at(key).get()); }

  private:
    MESetColletionType _MESetColletion;
  };

}  // namespace ecaldqm

#endif