Bin

ConstBin

EcalDQMSetupObjects

MESet

MESetCollection

const_iterator

iterator

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
#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());
      }
    }

    [[noreturn]] 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