DQMHistAnalysisInputRootFile.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
//+
// File : DQMHistAnalysisInputRootFile.cc
// Description : Module for offline testing of histogram analysis code.
//               Root file containing DQM histograms can be used as input.
//-
 
 
#include <dqm/analysis/modules/DQMHistAnalysisInputRootFile.h>
 
#include <TROOT.h>
#include <TKey.h>
 
#include <boost/regex.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <iostream>
 
using namespace Belle2;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(DQMHistAnalysisInputRootFile);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
DQMHistAnalysisInputRootFileModule::DQMHistAnalysisInputRootFileModule()
  : DQMHistAnalysisModule()
{
  //Parameter definition
  addParam("FileList", m_fileList, "List of input files", std::vector<std::string> {"input_histo.root"});
  addParam("SelectHistograms", m_histograms, "List of histogram name patterns, empty for all. Support wildcard matching (* and ?).",
           std::vector<std::string>());
  addParam("Experiment", m_expno, "Experiment Nr", 7u);
  addParam("RunList", m_runList, "Run Number List", std::vector<unsigned int> {1u});
  addParam("EventsList", m_eventsList, "Number of events for each run", std::vector<unsigned int> {10u});
  addParam("RunType", m_runType, "Run Type override", std::string(""));
  addParam("EventFilled", m_fillEvent, "Event override", 0);
  addParam("EventInterval", m_interval, "Time between events (seconds)", 20u);
  addParam("NullHistogramMode", m_nullHistoMode, "Test mode for null histograms", false);
  addParam("EnableRunInfo", m_enable_run_info, "Enable Run Info", false);
  addParam("AddRunControlHist", m_add_runcontrol_hist, "Add Hists from Run Control", false);
  B2DEBUG(1, "DQMHistAnalysisInputRootFile: Constructor done.");
}
 
void DQMHistAnalysisInputRootFileModule::initialize()
{
  if (m_file != nullptr) delete m_file;
  if (m_fileList.size() == 0) B2ERROR("File list is empty.");
  if (m_runList.size() == 0) B2ERROR("Run list is empty.");
  if (m_eventsList.size() == 0) B2ERROR("Events list is empty.");
  if (m_runList.size() != m_eventsList.size()) B2ERROR("Run list does not have the same size as events list.");
  if (m_runList.size() != m_fileList.size()) B2ERROR("Run list does not have the same size as file list.");
  m_run_idx = 0;
  m_file = new TFile(m_fileList[m_run_idx].c_str());
  m_eventMetaDataPtr.registerInDataStore();
 
  if (m_enable_run_info) {
    m_c_info = new TCanvas("DQMInfo/c_info", "");
    m_c_info->SetTitle("");
  }
  if (m_add_runcontrol_hist) {
    m_h_expno = new TH1F("DQMInfo/expno", "", 1, 0, 1);
    m_h_runno = new TH1F("DQMInfo/runno", "", 1, 0, 1);
    m_h_rtype = new TH1F("DQMInfo/rtype", "", 1, 0, 1);
  }
 
  B2INFO("DQMHistAnalysisInputRootFile: initialized.");
}
 
bool DQMHistAnalysisInputRootFileModule::hnamePatternMatch(std::string pattern, std::string text)
{
  boost::replace_all(pattern, "\\", "\\\\");
  boost::replace_all(pattern, "^", "\\^");
  boost::replace_all(pattern, ".", "\\.");
  boost::replace_all(pattern, "$", "\\$");
  boost::replace_all(pattern, "|", "\\|");
  boost::replace_all(pattern, "(", "\\(");
  boost::replace_all(pattern, ")", "\\)");
  boost::replace_all(pattern, "[", "\\[");
  boost::replace_all(pattern, "]", "\\]");
  boost::replace_all(pattern, "*", "\\*");
  boost::replace_all(pattern, "+", "\\+");
  boost::replace_all(pattern, "?", "\\?");
  boost::replace_all(pattern, "/", "\\/");
 
  boost::replace_all(pattern, "\\?", ".");
  boost::replace_all(pattern, "\\*", ".*");
 
  boost::regex bpattern(pattern);
 
  return regex_match(text, bpattern);
}
 
void DQMHistAnalysisInputRootFileModule::beginRun()
{
  B2INFO("DQMHistAnalysisInputRootFile: beginRun called. Run: " << m_runList[m_run_idx]);
  clearHistList();
  clearRefList();
}
 
void DQMHistAnalysisInputRootFileModule::event()
{
  B2INFO("DQMHistAnalysisInputRootFile: event called.");
  TH1::AddDirectory(false);
 
  sleep(m_interval);
 
  if (m_count > m_eventsList[m_run_idx]) {
    m_run_idx++;
    if (m_run_idx == m_runList.size()) {
      m_eventMetaDataPtr.create();
      m_eventMetaDataPtr->setEndOfData();
      return;
    }
    m_count = 0;
    if (m_file != nullptr) {
      m_file->Close();
      delete m_file;
    }
    m_file = new TFile(m_fileList[m_run_idx].c_str());
  }
 
  // Clear only after EndOfRun check, otherwise we won't have any histograms for MiraBelle
  // which expects analysis run in endRun function
  initHistListBeforeEvent();
 
  if (m_nullHistoMode) {
    m_eventMetaDataPtr.create();
    m_eventMetaDataPtr->setExperiment(m_expno);
    m_eventMetaDataPtr->setRun(m_runList[m_run_idx]);
    m_eventMetaDataPtr->setEvent(m_count);
    m_eventMetaDataPtr->setTime(0);
    //setExpNr(m_expno); // redundant access from MetaData
    //setRunNr(m_runno); // redundant access from MetaData
    setRunType(m_runType);
    //ExtractRunType();
    setEventProcessed(m_fillEvent);
    //ExtractEvent();
 
    B2INFO("DQMHistAnalysisInputRootFile: event finished. count: " << m_count);
    m_count++;
    return;
  }
 
  std::vector<TH1*> hs;
  unsigned long long int ts = 0;
  m_file->cd();
  TIter next(m_file->GetListOfKeys());
  TKey* key = NULL;
  while ((key = (TKey*)next())) {
    TClass* cl = gROOT->GetClass(key->GetClassName());
    if (ts == 0) ts = key->GetDatime().Convert();
    if (!cl->InheritsFrom("TDirectory")) continue;
    TDirectory* d = (TDirectory*)key->ReadObj();
    std::string dirname = d->GetName();
 
    d->cd();
    TIter nextd(d->GetListOfKeys());
 
    TKey* dkey;
    while ((dkey = (TKey*)nextd())) {
      TClass* dcl = gROOT->GetClass(dkey->GetClassName());
      if (!dcl->InheritsFrom("TH1")) continue;
      TH1* h = (TH1*)dkey->ReadObj();
      if (h->InheritsFrom("TH2")) h->SetOption("col");
      else h->SetOption("hist");
      Double_t scale = 1.0 * m_count / m_eventsList[m_run_idx];
      h->Scale(scale);
      std::string hname = h->GetName();
 
      bool hpass = false;
      if (m_histograms.size() == 0) {
        hpass = true;
      } else {
        for (auto& hpattern : m_histograms) {
          if (hnamePatternMatch(hpattern, dirname + "/" + hname)) {
            hpass = true;
            break;
          }
        }
      }
      if (!hpass) continue;
 
      if (hname.find("/") == std::string::npos) h->SetName((dirname + "/" + hname).c_str());
      hs.push_back(h);
    }
    m_file->cd();
  }
 
  // if no histograms are found in the sub-directories
  // search the top folder
  if (hs.size() == 0) {
    TIter nexth(m_file->GetListOfKeys());
    TKey* keyh = NULL;
    while ((keyh = (TKey*)nexth())) {
      TClass* cl = gROOT->GetClass(keyh->GetClassName());
      TH1* h;
      if (!cl->InheritsFrom("TH1")) continue;
      h = (TH1*)keyh->ReadObj();
 
      bool hpass = false;
      if (m_histograms.size() == 0) {
        hpass = true;
      } else {
        for (auto& hpattern : m_histograms) {
          if (hnamePatternMatch(hpattern, h->GetName())) {
            hpass = true;
            break;
          }
        }
      }
      if (!hpass) continue;
 
      hs.push_back(h);
      Double_t scale = 1.0 * m_count / m_eventsList[m_run_idx];
      h->Scale(scale);
    }
  }
 
  auto runno = m_runList[m_run_idx];
  if (m_c_info != NULL) m_c_info->SetTitle(("OFFLINE: Exp " + std::to_string(m_expno) + ", Run " + std::to_string(
                                                runno) + ", RunType " + m_runType + ", Last Changed NEVER, Last Updated NEVER, Last DQM event NEVER").c_str());
 
  m_count++;
  m_eventMetaDataPtr.create();
  m_eventMetaDataPtr->setExperiment(m_expno);
  m_eventMetaDataPtr->setRun(m_runList[m_run_idx]);
  m_eventMetaDataPtr->setEvent(m_count);
  m_eventMetaDataPtr->setTime(ts * 1e9);
 
  if (m_add_runcontrol_hist) {
    m_h_expno->SetTitle(std::to_string(m_expno).c_str());
    hs.push_back(m_h_expno);
    m_h_runno->SetTitle(std::to_string(runno).c_str());
    hs.push_back(m_h_runno);
    m_h_rtype->SetTitle(m_runType.c_str());
    hs.push_back(m_h_rtype);
  }
  //setExpNr(m_expno); // redundant access from MetaData
  //setRunNr(m_runno); // redundant access from MetaData
  if (m_runType == "") ExtractRunType(hs);
  if (m_fillEvent <= 0) ExtractEvent(hs);
 
  // this code must be run after "event processed" has been extracted
  for (size_t i = 0; i < hs.size(); i++) {
    TH1* h = hs[i];
    addHist("", h->GetName(), h);
    B2DEBUG(1, "Found : " << h->GetName() << " : " << h->GetEntries());
  }
 
  B2INFO("DQMHistAnalysisInputRootFile: event finished. count: " << m_count);
}