SiStripDcsInfo

SubDetMEs

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
#include "DQM/SiStripCommon/interface/SiStripFolderOrganizer.h"
#include "DQM/SiStripMonitorClient/interface/SiStripUtility.h"
#include "DQMServices/Core/interface/DQMStore.h"
#include "CalibFormats/SiStripObjects/interface/SiStripDetCabling.h"
#include "CalibTracker/Records/interface/SiStripDetCablingRcd.h"
#include "CondFormats/RunInfo/interface/RunInfo.h"
#include "CondFormats/DataRecord/interface/RunSummaryRcd.h"
#include "CondFormats/DataRecord/interface/SiStripCondDataRecords.h"
#include "CondFormats/SiStripObjects/interface/SiStripDetVOff.h"
#include "FWCore/Framework/interface/one/EDAnalyzer.h"
#include "FWCore/Framework/interface/ESWatcher.h"
#include "FWCore/Framework/interface/LuminosityBlock.h"
#include "FWCore/Framework/interface/Run.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "Geometry/Records/interface/TrackerTopologyRcd.h"

#include <iostream>
#include <iomanip>
#include <cstdio>
#include <sstream>
#include <cmath>
#include <fstream>
#include <string>
#include <vector>
#include <map>
#include <unordered_map>

class SiStripDetVOff;
class SiStripDetCabling;
class RunInfo;

class SiStripDcsInfo
    : public edm::one::EDAnalyzer<edm::one::SharedResources, edm::one::WatchRuns, edm::one::WatchLuminosityBlocks> {
public:
  typedef dqm::harvesting::MonitorElement MonitorElement;
  typedef dqm::harvesting::DQMStore DQMStore;

  SiStripDcsInfo(const edm::ParameterSet& ps);

private:
  void beginJob() override;
  void beginRun(edm::Run const& run, edm::EventSetup const& eSetup) override;
  void beginLuminosityBlock(edm::LuminosityBlock const& lumiSeg, edm::EventSetup const& eSetup) override;
  void endLuminosityBlock(edm::LuminosityBlock const& lumiSeg, edm::EventSetup const& iSetup) override;
  void endRun(edm::Run const& run, edm::EventSetup const& eSetup) override;
  void analyze(edm::Event const&, edm::EventSetup const&) override;

  void bookStatus(DQMStore& dqm_store);
  void readStatus(edm::EventSetup const&, int transition);
  void readCabling(edm::EventSetup const&);
  void addBadModules(DQMStore& dqm_store);
  void fillStatus(DQMStore& dqm_store);
  void fillDummyStatus(DQMStore& dqm_store);

  MonitorElement* DcsFraction_{nullptr};

  struct SubDetMEs {
    std::string folder_name;
    MonitorElement* DcsFractionME;
    int TotalDetectors;
    std::vector<uint32_t> FaultyDetectors;
    std::unordered_map<uint32_t, uint16_t> NLumiDetectorIsFaulty;
  };

  std::map<std::string, SubDetMEs> SubDetMEsMap{};
  unsigned long long m_cacheIDDcs_{};
  bool bookedStatus_{false};

  int nFEDConnected_{};

  int nLumiAnalysed_{};

  bool IsLumiGoodDcs_{false};
  int nGoodDcsLumi_{};
  static constexpr float MinAcceptableDcsDetFrac_{0.90};
  static constexpr float MaxAcceptableBadDcsLumi_{2};

  const SiStripDetCabling* detCabling_;
  edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> tTopoToken0_, tTopoToken1_, tTopoToken2_, tTopoToken3_;
  edm::ESGetToken<SiStripDetVOff, SiStripDetVOffRcd> detVOffToken0_, detVOffToken1_, detVOffToken2_;
  edm::ESWatcher<SiStripFedCablingRcd> fedCablingWatcher_;
  edm::ESGetToken<SiStripDetCabling, SiStripDetCablingRcd> detCablingToken_;  // beginRun
  edm::ESGetToken<RunInfo, RunInfoRcd> runInfoToken_;
};

//
// -- Contructor
//
SiStripDcsInfo::SiStripDcsInfo(edm::ParameterSet const& pSet)
    : tTopoToken0_(esConsumes<edm::Transition::BeginLuminosityBlock>()),
      tTopoToken1_(esConsumes<edm::Transition::EndLuminosityBlock>()),
      tTopoToken2_(esConsumes<edm::Transition::EndRun>()),
      tTopoToken3_(esConsumes<edm::Transition::BeginRun>()),
      detVOffToken0_(esConsumes<edm::Transition::BeginLuminosityBlock>()),
      detVOffToken1_(esConsumes<edm::Transition::EndLuminosityBlock>()),
      detVOffToken2_(esConsumes<edm::Transition::EndRun>()),
      detCablingToken_(esConsumes<edm::Transition::BeginRun>()),
      runInfoToken_(esConsumes<edm::Transition::BeginRun>()) {
  usesResource("DQMStore");
  LogDebug("SiStripDcsInfo") << "SiStripDcsInfo::Deleting SiStripDcsInfo ";
}

void SiStripDcsInfo::beginJob() {
  // Since SubDetMEs is a struct, using the brace initialization will
  // zero-initialize all members that are not specified in the call.
  SubDetMEsMap.emplace("TIB", SubDetMEs{"TIB", nullptr, 0, {}, {}});
  SubDetMEsMap.emplace("TOB", SubDetMEs{"TOB", nullptr, 0, {}, {}});
  SubDetMEsMap.emplace("TECB", SubDetMEs{"TEC/MINUS", nullptr, 0, {}, {}});
  SubDetMEsMap.emplace("TECF", SubDetMEs{"TEC/PLUS", nullptr, 0, {}, {}});
  SubDetMEsMap.emplace("TIDB", SubDetMEs{"TID/MINUS", nullptr, 0, {}, {}});
  SubDetMEsMap.emplace("TIDF", SubDetMEs{"TID/PLUS", nullptr, 0, {}, {}});
}
//
// -- Begin Run
//
void SiStripDcsInfo::beginRun(edm::Run const& run, edm::EventSetup const& eSetup) {
  LogDebug("SiStripDcsInfo") << "SiStripDcsInfo:: Begining of Run";
  nFEDConnected_ = 0;
  constexpr int siStripFedIdMin{FEDNumbering::MINSiStripFEDID};
  constexpr int siStripFedIdMax{FEDNumbering::MAXSiStripFEDID};

  // Count Tracker FEDs from RunInfo
  //
  if (eSetup.tryToGet<RunInfoRcd>()) {
    if (auto sumFED = eSetup.getHandle(runInfoToken_)) {
      std::vector<int> FedsInIds = sumFED->m_fed_in;
      for (unsigned int it = 0; it < FedsInIds.size(); ++it) {
        int fedID = FedsInIds[it];
        if (fedID >= siStripFedIdMin && fedID <= siStripFedIdMax)
          ++nFEDConnected_;
      }
      LogDebug("SiStripDcsInfo") << " SiStripDcsInfo :: Connected FEDs " << nFEDConnected_;
    }
  }

  auto& dqm_store = *edm::Service<DQMStore>{};
  bookStatus(dqm_store);
  fillDummyStatus(dqm_store);
  if (nFEDConnected_ > 0)
    readCabling(eSetup);
}

void SiStripDcsInfo::analyze(edm::Event const& event, edm::EventSetup const& eSetup) {}

void SiStripDcsInfo::beginLuminosityBlock(edm::LuminosityBlock const& lumiSeg, edm::EventSetup const& eSetup) {
  LogDebug("SiStripDcsInfo") << "SiStripDcsInfo::beginLuminosityBlock";

  if (nFEDConnected_ == 0)
    return;

  // initialise BadModule list
  for (auto& subDetME : SubDetMEsMap) {
    subDetME.second.FaultyDetectors.clear();
  }
  readStatus(eSetup, 0);
  nLumiAnalysed_++;
}

void SiStripDcsInfo::endLuminosityBlock(edm::LuminosityBlock const& lumiSeg, edm::EventSetup const& eSetup) {
  LogDebug("SiStripDcsInfo") << "SiStripDcsInfo::endLuminosityBlock";

  if (nFEDConnected_ == 0)
    return;
  auto& dqm_store = *edm::Service<DQMStore>{};
  readStatus(eSetup, 1);
  fillStatus(dqm_store);
}

void SiStripDcsInfo::endRun(edm::Run const& run, edm::EventSetup const& eSetup) {
  LogDebug("SiStripDcsInfo") << "SiStripDcsInfo::EndRun";

  if (nFEDConnected_ == 0)
    return;

  for (auto& subDetME : SubDetMEsMap) {
    subDetME.second.FaultyDetectors.clear();
  }
  readStatus(eSetup, 2);
  auto& dqm_store = *edm::Service<DQMStore>{};
  addBadModules(dqm_store);
}
//
// -- Book MEs for SiStrip Dcs Fraction
//
void SiStripDcsInfo::bookStatus(DQMStore& dqm_store) {
  if (bookedStatus_)
    return;

  std::string strip_dir = "";
  SiStripUtility::getTopFolderPath(dqm_store, "SiStrip", strip_dir);
  if (!strip_dir.empty())
    dqm_store.setCurrentFolder(strip_dir + "/EventInfo");
  else
    dqm_store.setCurrentFolder("SiStrip/EventInfo");

  auto scope = DQMStore::UseLumiScope(dqm_store);

  DcsFraction_ = dqm_store.bookFloat("DCSSummary");

  dqm_store.cd();
  if (!strip_dir.empty())
    dqm_store.setCurrentFolder(strip_dir + "/EventInfo/DCSContents");
  else
    dqm_store.setCurrentFolder("SiStrip/EventInfo/DCSContents");
  for (auto& [suffix, subDetME] : SubDetMEsMap) {
    std::string const me_name{"SiStrip_" + suffix};
    subDetME.DcsFractionME = dqm_store.bookFloat(me_name);
  }
  bookedStatus_ = true;
  dqm_store.cd();
}

void SiStripDcsInfo::readCabling(edm::EventSetup const& eSetup) {
  const auto tTopo = &eSetup.getData(tTopoToken3_);

  if (fedCablingWatcher_.check(eSetup)) {
    LogDebug("SiStripDcsInfo") << "SiStripDcsInfo::readCabling : "
                               << " Change in Cache";
    detCabling_ = &eSetup.getData(detCablingToken_);

    std::vector<uint32_t> SelectedDetIds;
    detCabling_->addActiveDetectorsRawIds(SelectedDetIds);
    LogDebug("SiStripDcsInfo") << " SiStripDcsInfo::readCabling : "
                               << " Total Detectors " << SelectedDetIds.size();

    // initialise total # of detectors first
    for (std::map<std::string, SubDetMEs>::iterator it = SubDetMEsMap.begin(); it != SubDetMEsMap.end(); it++) {
      it->second.TotalDetectors = 0;
    }

    for (std::vector<uint32_t>::const_iterator idetid = SelectedDetIds.begin(); idetid != SelectedDetIds.end();
         ++idetid) {
      uint32_t detId = *idetid;
      if (detId == 0 || detId == 0xFFFFFFFF)
        continue;
      std::string subdet_tag;
      SiStripUtility::getSubDetectorTag(detId, subdet_tag, tTopo);

      std::map<std::string, SubDetMEs>::iterator iPos = SubDetMEsMap.find(subdet_tag);
      if (iPos != SubDetMEsMap.end()) {
        iPos->second.TotalDetectors++;
      }
    }
  }
}
//
// -- Get Faulty Detectors
//
void SiStripDcsInfo::readStatus(edm::EventSetup const& eSetup, int transition) {
  const auto tTopo = &eSetup.getData(transition == 0 ? tTopoToken0_ : (transition == 1 ? tTopoToken1_ : tTopoToken2_));
  const auto& detVOff =
      eSetup.getData(transition == 0 ? detVOffToken0_ : (transition == 1 ? detVOffToken1_ : detVOffToken2_));
  std::vector<uint32_t> FaultyDetIds;
  detVOff.getDetIds(FaultyDetIds);
  LogDebug("SiStripDcsInfo") << " SiStripDcsInfo::readStatus : "
                             << " Faulty Detectors " << FaultyDetIds.size();
  // Read and fille bad modules
  for (std::vector<uint32_t>::const_iterator ihvoff = FaultyDetIds.begin(); ihvoff != FaultyDetIds.end(); ++ihvoff) {
    uint32_t detId_hvoff = (*ihvoff);
    if (!detCabling_->IsConnected(detId_hvoff))
      continue;
    std::string subdet_tag;
    SiStripUtility::getSubDetectorTag(detId_hvoff, subdet_tag, tTopo);

    std::map<std::string, SubDetMEs>::iterator iPos = SubDetMEsMap.find(subdet_tag);
    if (iPos != SubDetMEsMap.end()) {
      std::vector<uint32_t>::iterator ibad =
          std::find(iPos->second.FaultyDetectors.begin(), iPos->second.FaultyDetectors.end(), detId_hvoff);
      if (ibad == iPos->second.FaultyDetectors.end())
        iPos->second.FaultyDetectors.push_back(detId_hvoff);
    }
  }
}
//
// -- Fill Status
//
void SiStripDcsInfo::fillStatus(DQMStore& dqm_store) {
  if (!bookedStatus_)
    bookStatus(dqm_store);
  assert(bookedStatus_);

  float total_det = 0.0;
  float faulty_det = 0.0;
  float fraction;
  for (auto const& [name, subDetMEs] : SubDetMEsMap) {
    int total_subdet = subDetMEs.TotalDetectors;
    int faulty_subdet = subDetMEs.FaultyDetectors.size();
    if (nFEDConnected_ == 0 || total_subdet == 0)
      fraction = -1;
    else
      fraction = 1.0 - faulty_subdet * 1.0 / total_subdet;
    subDetMEs.DcsFractionME->Reset();
    subDetMEs.DcsFractionME->Fill(fraction);
    edm::LogInfo("SiStripDcsInfo") << " SiStripDcsInfo::fillStatus : Sub Detector " << name << " Total Number "
                                   << total_subdet << " Faulty ones " << faulty_subdet;
    total_det += total_subdet;
    faulty_det += faulty_subdet;
  }
  if (nFEDConnected_ == 0 || total_det == 0)
    fraction = -1.0;
  else
    fraction = 1 - faulty_det / total_det;
  DcsFraction_->Reset();
  DcsFraction_->Fill(fraction);
  IsLumiGoodDcs_ = fraction > MinAcceptableDcsDetFrac_;
  if (!IsLumiGoodDcs_)
    return;

  ++nGoodDcsLumi_;
  for (auto& pr : SubDetMEsMap) {
    for (auto const detId_faulty : pr.second.FaultyDetectors) {
      pr.second.NLumiDetectorIsFaulty[detId_faulty]++;
    }
  }
}

//
// -- Fill with Dummy values
//
void SiStripDcsInfo::fillDummyStatus(DQMStore& dqm_store) {
  if (!bookedStatus_)
    bookStatus(dqm_store);
  assert(bookedStatus_);

  for (auto& pr : SubDetMEsMap) {
    pr.second.DcsFractionME->Reset();
    pr.second.DcsFractionME->Fill(-1.0);
  }
  DcsFraction_->Reset();
  DcsFraction_->Fill(-1.0);
}

void SiStripDcsInfo::addBadModules(DQMStore& dqm_store) {
  dqm_store.cd();
  std::string mdir = "MechanicalView";
  if (!SiStripUtility::goToDir(dqm_store, mdir)) {
    dqm_store.setCurrentFolder("SiStrip/" + mdir);
  }
  std::string mechanical_dir = dqm_store.pwd();
  std::string tag = "DCSError";

  for (auto const& pr : SubDetMEsMap) {
    auto const& lumiCountBadModules = pr.second.NLumiDetectorIsFaulty;
    for (auto const [ibad, nBadLumi] : lumiCountBadModules) {
      if (nBadLumi <= MaxAcceptableBadDcsLumi_)
        continue;
      std::string bad_module_folder = mechanical_dir + "/" + pr.second.folder_name +
                                      "/"
                                      "BadModuleList";
      dqm_store.setCurrentFolder(bad_module_folder);

      std::ostringstream detid_str;
      detid_str << ibad;
      std::string full_path = bad_module_folder + "/" + detid_str.str();
      MonitorElement* me = dqm_store.get(full_path);
      uint16_t flag = 0;
      if (me) {
        flag = me->getIntValue();
        me->Reset();
      } else
        me = dqm_store.bookInt(detid_str.str());
      SiStripUtility::setBadModuleFlag(tag, flag);
      me->Fill(flag);
    }
  }
  dqm_store.cd();
}

#include "FWCore/Framework/interface/MakerMacros.h"
DEFINE_FWK_MODULE(SiStripDcsInfo);