Belle II Software development
DQMHistReferenceModule.cc
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8
9#include <dqm/analysis/modules/DQMHistReferenceModule.h>
10#include <TROOT.h>
11#include <TStyle.h>
12#include <TKey.h>
13
14using namespace std;
15using namespace Belle2;
16
17//-----------------------------------------------------------------
18// Register the Module
19//-----------------------------------------------------------------
20REG_MODULE(DQMHistReference);
21
22//-----------------------------------------------------------------
23// Implementation
24//-----------------------------------------------------------------
25
27{
28 //Parameter definition
29 addParam("ReferenceFile", m_referenceFileName, "Name of the reference histrogram files", string(""));
30 B2DEBUG(1, "DQMHistReference: Constructor done.");
31}
32
34{
35 B2DEBUG(1, "DQMHistReference: initialized.");
36}
37
39{
40 B2DEBUG(1, "DQMHistReference: beginRun called.");
41
43}
44
46{
47 TH1::AddDirectory(false); // do not store any histograms
48
49 B2DEBUG(1, "DQMHistReference: reading references from input root file");
50
51 string run_type = getRunType();
52 if (run_type == "") run_type = "default";
53
54 B2INFO("DQMHistReference: run_type " << run_type);
55
56 TFile* refFile = new TFile(m_referenceFileName.c_str(), "READ");
57
58 if (refFile->IsZombie()) {
59 B2INFO("DQMHistReference: reference file " << m_referenceFileName << " does not exist. No references will be used!");
60 refFile->Close();
61 delete refFile;
62 return;
63 }
64
65 B2INFO("DQMHistReference: use reference file " << m_referenceFileName);
66
67 TIter nextRefDirKey(refFile->GetListOfKeys());
68 TKey* refDirKey;
69 while ((refDirKey = (TKey*)nextRefDirKey())) {
70 if (refDirKey->IsFolder() && string(refDirKey->GetName()) == string("ref")) {
71 TDirectory* refDir = (TDirectory*)refDirKey->ReadObj(); // ReadObj -> I own it, delete later
72 TIter nextDetDirKey(refDir->GetListOfKeys());
73 TKey* detDirKey;
74 // detector folders
75 while ((detDirKey = (TKey*)nextDetDirKey())) {
76 if (!detDirKey->IsFolder()) continue;
77 TDirectory* detDir = ((TDirectory*)detDirKey->ReadObj());
78 TIter nextRunTypeDirKey(detDir->GetListOfKeys()); // ReadObj -> Now I own this, so delete later
79 TKey* runtypeDirKey;
80 TDirectory* runtypeDir = nullptr;
81 // run type folders (get the run type corresponding folder or use default one)
82 while ((runtypeDirKey = (TKey*)nextRunTypeDirKey())) {
83 if (!runtypeDirKey->IsFolder()) continue;
84 if (string(runtypeDirKey->GetName()) == run_type) {
85 if (runtypeDir) delete runtypeDir; // if default was loaded before
86 runtypeDir = (TDirectory*)runtypeDirKey->ReadObj(); // ReadObj -> I own it, delete later
87 break; // break directly, otherwise "default" could overwrite it
88 }
89 // else we would check if default, which we load as backup
90 if (string(runtypeDirKey->GetName()) == "default") runtypeDir = (TDirectory*)runtypeDirKey->ReadObj(); // ReadObj -> I own it
91 }
92 string detName = detDir->GetName();
93 // Attention, runtypeDir and runtypeDirKey could be zero here
94 if (!runtypeDir) {
95 B2INFO("No run type specific or default references available for " << detName);
96 } else {
97 B2INFO("Reading reference histograms for " << detName << " from run type folder: " << runtypeDir->GetName());
98
99 TIter nextHistkey(runtypeDir->GetListOfKeys());
100 TKey* histKey;
101 // now read histograms
102 while ((histKey = (TKey*)nextHistkey())) {
103 if (histKey->IsFolder()) continue;
104 if (gROOT->GetClass(histKey->GetClassName())->InheritsFrom("TH1")) {
105 addRefHist(detName, (TH1*)histKey->ReadObj()); // ReadObj -> I own it, tranfer ownership to function
106 }
107 }
108 delete runtypeDir; // always non-zero as checked above ... runtype or "default"
109 }
110 delete detDir; // always non-zero ... detector subdir name
111 }
112 delete refDir; // always non-zero ... "ref" folder
113 }
114 }
115
116 B2INFO("DQMHistReference: read references done");
117 refFile->Close();
118 delete refFile;
119}
120
122{
123 B2DEBUG(1, "DQMHistReference: event called");
124}
125
127{
128 B2DEBUG(1, "DQMHistReference: endRun called");
129}
130
132{
133 B2DEBUG(1, "DQMHistReference: terminate called");
134}
135
static void addRefHist(const std::string &dirname, TH1 *hist)
Add reference histogram.
static const std::string & getRunType(void)
Get the list of the reference histograms.
DQMHistAnalysisModule()
Constructor / Destructor.
void initialize() override final
Initializer.
void loadReferenceHistos()
Reads reference histograms from input root file.
void terminate() override final
This method is called at the end of the event processing.
void event() override final
This method is called for each event.
void endRun() override final
This method is called if the current run ends.
void beginRun() override final
Called when entering a new run.
std::string m_referenceFileName
Reference Histogram Root file name.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition Module.h:559
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
Definition Module.h:649
Abstract base class for different kinds of events.
STL namespace.