Belle II Software  release-05-01-25
PXDDAQDQMModule Class Reference

The PXD DAQ DQM module. More...

#include <PXDDAQDQMModule.h>

Inheritance diagram for PXDDAQDQMModule:
Collaboration diagram for PXDDAQDQMModule:

Public Types

enum  EModulePropFlags {
  c_Input = 1,
  c_Output = 2,
  c_ParallelProcessingCertified = 4,
  c_HistogramManager = 8,
  c_InternalSerializer = 16,
  c_TerminateInAllProcesses = 32,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 PXDDAQDQMModule ()
 Constructor defining the parameters.
 
virtual void endRun () override
 Function to process end_run record.
 
virtual void terminate () override
 Function to terminate module.
 
virtual std::vector< std::string > getFileNames (__attribute__((unused)) bool outputFiles)
 Return a list of output filenames for this modules. More...
 
const std::string & getName () const
 Returns the name of the module. More...
 
const std::string & getType () const
 Returns the type of the module (i.e. More...
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module. More...
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties. More...
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module. More...
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python. More...
 
virtual void def_beginRun ()
 Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
 
virtual void def_event ()
 Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
 
virtual void def_endRun ()
 This method can receive that the current run ends as a call from the Python side. More...
 
virtual void def_terminate ()
 Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
 
void setDescription (const std::string &description)
 Sets the description of the module. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
 Adds a new parameter to the module. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

void initialize () override final
 Function for dynamic initialization of module. More...
 
void beginRun () override final
 Function to process begin_run record.
 
void event () override final
 Function to process event record. More...
 
void defineHisto () override final
 Function to define histograms. More...
 
std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

std::string m_histogramDirectoryName
 Name of the histogram directory in ROOT file.
 
StoreObjPtr< PXDDAQStatusm_storeDAQEvtStats
 Input array for DAQ Status.
 
StoreArray< RawSVDm_rawSVD
 Input array for SVD/x-check HLT EODB .
 
StoreArray< RawFTSWm_rawTTD
 Input array for TTD/FTSW.
 
VXD::GeoCachem_vxdGeometry
 the geometry
 
TH1D * hDAQErrorEvent {}
 Remark: Because of DHH load balancing and sub event building, the very same DHE and DHC can show up in different packets (for different events)! but we will fill only one histogram. More...
 
TH1D * hDAQUseableModule {}
 Count Useable/unuseable decision.
 
TH1D * hDAQNotUseableModule {}
 Count Useable/unuseable decision.
 
TH1D * hDAQDHPDataMissing {}
 Count Missing DHP data.
 
TH2D * hDAQErrorDHC {}
 individual DHC errors

 
TH2D * hDAQErrorDHE {}
 individual DHE errors

 
TH2D * hDAQEndErrorDHC {}
 individual DHC END errors

 
TH2D * hDAQEndErrorDHE {}
 individual DHE END errors

 
std::map< VxdID, TH1D * > hDAQDHETriggerGate
 DHE Trigger Gate ("start Row")

 
std::map< VxdID, TH1D * > hDAQDHEReduction
 DHE data reduction

 
std::map< VxdID, TH2D * > hDAQCM
 Common Mode per DHE to gate and DHP level.
 
std::map< VxdID, TH1D * > hDAQCM2
 Common Mode per DHE to gate and DHP level.
 
std::map< int, TH1D * > hDAQDHCReduction
 DHC data reduction

 
TH1I * hEODBAfterInjLER {}
 Histogram of EODB after LER injection.
 
TH1I * hEODBAfterInjHER {}
 Histogram of EODB after HER injection.
 
TH1I * hCM63AfterInjLER {}
 Histogram of CM63 after LER injection.
 
TH1I * hCM63AfterInjHER {}
 Histogram of CM63 after HER injection.
 
TH1I * hTruncAfterInjLER {}
 Histogram Truncation after LER injection.
 
TH1I * hTruncAfterInjHER {}
 Histogram Truncation after HER injection.
 
TH1I * hMissAfterInjLER {}
 Histogram MissFrame after LER injection.
 
TH1I * hMissAfterInjHER {}
 Histogram MissFrame after HER injection.
 
TH1I * hEODBTrgDiff {}
 Histogram of EODB after last trigger.
 
TH1I * hCM63TrgDiff {}
 Histogram of CM63 after last trigger.
 
TH1I * hTruncTrgDiff {}
 Histogram Truncation after last trigger.
 
TH1I * hMissTrgDiff {}
 Histogram MissFrame after last trigger.
 
TH1D * hDAQStat {}
 Histogram for Truncation etc Stats.
 
std::vector< std::string > err
 vector of errors
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

The PXD DAQ DQM module.

Creates basic DQM for PXD DAQ errors and statistics

Definition at line 49 of file PXDDAQDQMModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 79 of file Module.h.

Member Function Documentation

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 181 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 441 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 422 of file Module.h.

◆ defineHisto()

void defineHisto ( )
finaloverrideprivatevirtual

Function to define histograms.

This function is hooked to HistoManager by calling RbTupleManager::Instance().register_module ( this ) or using a macro REG_HISTOGRAM. It is supposed to be done in initialize() function.

Reimplemented from HistoModule.

Definition at line 43 of file PXDDAQDQMModule.cc.

44 {
45  TDirectory* oldDir = gDirectory;
46  if (m_histogramDirectoryName != "") {
47  oldDir->mkdir(m_histogramDirectoryName.c_str());// do not rely on return value, might be ZERO
48  oldDir->cd(m_histogramDirectoryName.c_str());
49  }
50 
51  hDAQErrorEvent = new TH1D("PXDDAQError", "PXDDAQError/Event;;Count", ONSEN_USED_TYPE_ERR, 0, ONSEN_USED_TYPE_ERR);
52  hDAQErrorDHC = new TH2D("PXDDAQDHCError", "PXDDAQError/DHC;DHC ID;", 16, 0, 16, ONSEN_USED_TYPE_ERR, 0, ONSEN_USED_TYPE_ERR);
53  hDAQErrorDHE = new TH2D("PXDDAQDHEError", "PXDDAQError/DHE;DHE ID;", 64, 0, 64, ONSEN_USED_TYPE_ERR, 0, ONSEN_USED_TYPE_ERR);
54  hDAQUseableModule = new TH1D("PXDDAQUseableModule", "PXDDAQUseableModule/DHE;DHE ID;", 64, 0, 64);
55  hDAQNotUseableModule = new TH1D("PXDDAQNotUseableModule", "PXDDAQNotUseableModule/DHE;DHE ID;", 64, 0, 64);
56  hDAQDHPDataMissing = new TH1D("PXDDAQDHPDataMissing", "PXDDAQDHPDataMissing/DHE*DHP;DHE ID;", 64 * 4, 0, 64);
57  hDAQEndErrorDHC = new TH2D("PXDDAQDHCEndError", "PXDDAQEndError/DHC;DHC ID;", 16, 0, 16, 32, 0, 32);
58  hDAQEndErrorDHE = new TH2D("PXDDAQDHEEndError", "PXDDAQEndError/DHE;DHE ID;", 64, 0, 64, 4 * 2 * 8, 0, 4 * 2 * 8);
59 
60  // histograms might get unreadable, but, if necessary, you can zoom in anyways.
61  // we could use full alphanumeric histograms, but then, the labels would change (in the worst case) depending on observed errors
62  // and ... the histogram would contain NO labels if there is NO error ... confusing.
63  // ... an we would have to use alphanumeric X axis (DHE ID, DHC ID), too)
64  for (int i = 0; i < ONSEN_USED_TYPE_ERR; i++) {
65  const char* label = getPXDBitErrorName(i).c_str();
66  hDAQErrorEvent->GetXaxis()->SetBinLabel(i + 1, label);
67  hDAQErrorDHE->GetYaxis()->SetBinLabel(i + 1, label);
68  hDAQErrorDHC->GetYaxis()->SetBinLabel(i + 1, label);
69  }
70 
71  hDAQErrorEvent->LabelsOption("v"); // rotate the labels.
72 
73  std::vector<VxdID> sensors = m_vxdGeometry.getListOfSensors();
74  for (VxdID& avxdid : sensors) {
76  if (info.getType() != VXD::SensorInfoBase::PXD) continue;
77  //Only interested in PXD sensors
78 
79  TString buff = (std::string)avxdid;
80  TString bufful = buff;
81  buff.ReplaceAll(".", "_");
82 
83 // string s = str(format("DHE %d:%d:%d (DHH ID %02Xh)") % num1 % num2 % num3 % i);
84 // string s2 = str(format("_%d.%d.%d") % num1 % num2 % num3);
85 
86  hDAQDHETriggerGate[avxdid] = new TH1D("PXDDAQDHETriggerGate_" + bufful,
87  "TriggerGate DHE " + buff + "; Trigger Gate; Counts", 192, 0, 192);
88  hDAQDHEReduction[avxdid] = new TH1D("PXDDAQDHEDataReduction_" + bufful, "Data Reduction DHE " + buff + "; Raw/Red; Counts", 200, 0,
89  40);// If max changed, check overflow copy below
90  hDAQCM[avxdid] = new TH2D("PXDDAQCM_" + bufful, "Common Mode on DHE " + buff + "; Gate+Chip*192; Common Mode", 192 * 4, 0, 192 * 4,
91  64, 0, 64);
92  hDAQCM2[avxdid] = new TH1D("PXDDAQCM2_" + bufful, "Common Mode on DHE " + buff + "; Common Mode", 64, 0, 64);
93  }
94  for (int i = 0; i < 16; i++) {
95  hDAQDHCReduction[i] = new TH1D(("PXDDAQDHCDataReduction_" + str(format("%d") % i)).c_str(),
96  ("Data Reduction DHC " + str(format(" %d") % i) + "; Raw/Red; Counts").c_str(), 200, 0,
97  40); // If max changed, check overflow copy below
98  }
99 // hDAQErrorEvent->LabelsDeflate("X");
100 // hDAQErrorEvent->LabelsOption("v");
101 // hDAQErrorEvent->SetStats(0);
102  hEODBAfterInjLER = new TH1I("PXDEODBInjLER", "PXDEODBInjLER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
103  hEODBAfterInjHER = new TH1I("PXDEODBInjHER", "PXDEODBInjHER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
104  hCM63AfterInjLER = new TH1I("PXDCM63InjLER", "PXDCM63InjLER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
105  hCM63AfterInjHER = new TH1I("PXDCM63InjHER", "PXDCM63InjHER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
106  hTruncAfterInjLER = new TH1I("PXDTruncInjLER", "PXDTruncInjLER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
107  hTruncAfterInjHER = new TH1I("PXDTruncInjHER", "PXDTruncInjHER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
108  hMissAfterInjLER = new TH1I("PXDMissInjLER", "PXDMissInjLER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
109  hMissAfterInjHER = new TH1I("PXDMissInjHER", "PXDMissInjHER/Time;Time in #mus;Events/Time (5 #mus bins)", 4000, 0, 20000);
110  hEODBTrgDiff = new TH1I("PXDEODBTrgDiff", "PXDEODBTrgDiff/DiffTime;DiffTime in #mus;Events/Time (1 #mus bins)", 2000, 0, 2000);
111  hCM63TrgDiff = new TH1I("PXDCM63TrgDiff", "PXDCM63TrgDiff/DiffTime;DiffTime in #mus;Events/Time (1 #mus bins)", 2000, 0, 2000);
112  hTruncTrgDiff = new TH1I("PXDTruncTrgDiff", "PXDTruncTrgDiff/DiffTime;DiffTime in #mus;Events/Time (1 #mus bins)", 2000, 0, 2000);
113  hMissTrgDiff = new TH1I("PXDMissTrgDiff", "PXDMissTrgDiff/DiffTime;DiffTime in #mus;Events/Time (1 #mus bins)", 2000, 0, 2000);
114 
115  hDAQStat = new TH1D("PXDDAQStat", "PXDDAQStat", 20, 0, 20);
116  auto xa = hDAQStat->GetXaxis();
117  if (xa) {
118  // underflow: number of events -> for normalize
119  xa->SetBinLabel(0 + 1, "EODB/HLT rej"); // event of doom or rejected
120  xa->SetBinLabel(1 + 1, "Trunc 8%");
121  xa->SetBinLabel(2 + 1, "HER Trunc");
122  xa->SetBinLabel(3 + 1, "LER Trunc");
123  xa->SetBinLabel(4 + 1, "CM63");
124  xa->SetBinLabel(5 + 1, "HER CM63");
125  xa->SetBinLabel(6 + 1, "LER CM63");
126  xa->SetBinLabel(7 + 1, "HER CM63>1ms");
127  xa->SetBinLabel(8 + 1, "LER CM63>1ms");
128  xa->SetBinLabel(9 + 1, "HER Trunc>1ms");
129  xa->SetBinLabel(10 + 1, "LER Trunc>1ms");
130  xa->SetBinLabel(11 + 1, "MissFrame");
131  xa->SetBinLabel(12 + 1, "Timeout");
132  xa->SetBinLabel(13 + 1, "Link Down");
133  xa->SetBinLabel(14 + 1, "Mismatch");
134  xa->SetBinLabel(15 + 1, "HER MissFrame");
135  xa->SetBinLabel(16 + 1, "LER MissFrame");
136  xa->SetBinLabel(17 + 1, "HER MissFrame>1ms");
137  xa->SetBinLabel(18 + 1, "LER MissFrame>1ms");
138  xa->SetBinLabel(19 + 1, "unused");
139  }
140  // cd back to root directory
141  oldDir->cd();
142 }

◆ evalCondition()

bool evalCondition ( ) const
inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns
True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 98 of file Module.cc.

◆ event()

void event ( )
finaloverrideprivatevirtual

Function to process event record.

An Error Flag can only be set, if the object actually exists, thus we have to check for a difference to the number of events, too Remark: for HLT event selection and/or events rejected by the event- of-doom-buster, we might count anyhow broken events as broken from PXD

Reimplemented from HistoModule.

Definition at line 176 of file PXDDAQDQMModule.cc.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 135 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).


Definition at line 115 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( __attribute__((unused)) bool  outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Definition at line 136 of file Module.h.

◆ getName()

const std::string& getName ( ) const
inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 189 of file Module.h.

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const
inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns
A python list containing the parameters of this parameter list.

Definition at line 281 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

Returns true if all specified property flags are available in this module.

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 162 of file Module.cc.

◆ if_false()

void if_false ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 87 of file Module.cc.

◆ if_true()

void if_true ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 92 of file Module.cc.

◆ if_value()

void if_value ( const std::string &  expression,
const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 81 of file Module.cc.

◆ initialize()

void initialize ( )
finaloverrideprivatevirtual

Function for dynamic initialization of module.

TODO better use isRequired(), but RawFTSW is not in sim, thus tests are failing

just for checking EODB / Hlt rejections

Reimplemented from HistoModule.

Definition at line 144 of file PXDDAQDQMModule.cc.

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 75 of file Module.cc.

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

Note
The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.
Parameters
nameThe name of the module

Definition at line 216 of file Module.h.

◆ setParamPython()

void setParamPython ( const std::string &  name,
const boost::python::object &  pyObj 
)
privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary)
privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 222 of file Module.cc.

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 50 of file Module.cc.

Member Data Documentation

◆ hDAQErrorEvent

TH1D* hDAQErrorEvent {}
private

Remark: Because of DHH load balancing and sub event building, the very same DHE and DHC can show up in different packets (for different events)! but we will fill only one histogram.

per event errors

Definition at line 74 of file PXDDAQDQMModule.h.


The documentation for this class was generated from the following files:
Belle2::PXD::PXDDAQDQMModule::hCM63AfterInjHER
TH1I * hCM63AfterInjHER
Histogram of CM63 after HER injection.
Definition: PXDDAQDQMModule.h:92
Belle2::PXD::PXDDAQDQMModule::hTruncTrgDiff
TH1I * hTruncTrgDiff
Histogram Truncation after last trigger.
Definition: PXDDAQDQMModule.h:99
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:43
Belle2::PXD::PXDDAQDQMModule::hDAQCM2
std::map< VxdID, TH1D * > hDAQCM2
Common Mode per DHE to gate and DHP level.
Definition: PXDDAQDQMModule.h:86
Belle2::PXD::PXDDAQDQMModule::hDAQDHEReduction
std::map< VxdID, TH1D * > hDAQDHEReduction
DHE data reduction
Definition: PXDDAQDQMModule.h:84
Belle2::PXD::PXDDAQDQMModule::hDAQErrorEvent
TH1D * hDAQErrorEvent
Remark: Because of DHH load balancing and sub event building, the very same DHE and DHC can show up i...
Definition: PXDDAQDQMModule.h:74
Belle2::PXD::PXDDAQDQMModule::hTruncAfterInjHER
TH1I * hTruncAfterInjHER
Histogram Truncation after HER injection.
Definition: PXDDAQDQMModule.h:94
Belle2::PXD::PXDDAQDQMModule::hEODBAfterInjHER
TH1I * hEODBAfterInjHER
Histogram of EODB after HER injection.
Definition: PXDDAQDQMModule.h:90
Belle2::PXD::PXDDAQDQMModule::hDAQEndErrorDHC
TH2D * hDAQEndErrorDHC
individual DHC END errors
Definition: PXDDAQDQMModule.h:81
Belle2::PXD::PXDDAQDQMModule::hDAQDHPDataMissing
TH1D * hDAQDHPDataMissing
Count Missing DHP data.
Definition: PXDDAQDQMModule.h:77
Belle2::VXD::SensorInfoBase
Base class to provide Sensor Information for PXD and SVD.
Definition: SensorInfoBase.h:40
Belle2::PXD::PXDDAQDQMModule::hCM63AfterInjLER
TH1I * hCM63AfterInjLER
Histogram of CM63 after LER injection.
Definition: PXDDAQDQMModule.h:91
Belle2::VXD::GeoCache::getListOfSensors
const std::vector< VxdID > getListOfSensors() const
Get list of all sensors.
Definition: GeoCache.cc:60
Belle2::PXD::PXDDAQDQMModule::hDAQDHCReduction
std::map< int, TH1D * > hDAQDHCReduction
DHC data reduction
Definition: PXDDAQDQMModule.h:87
Belle2::PXD::PXDDAQDQMModule::hMissTrgDiff
TH1I * hMissTrgDiff
Histogram MissFrame after last trigger.
Definition: PXDDAQDQMModule.h:100
Belle2::PXD::PXDDAQDQMModule::hTruncAfterInjLER
TH1I * hTruncAfterInjLER
Histogram Truncation after LER injection.
Definition: PXDDAQDQMModule.h:93
Belle2::PXD::PXDDAQDQMModule::hDAQUseableModule
TH1D * hDAQUseableModule
Count Useable/unuseable decision.
Definition: PXDDAQDQMModule.h:75
Belle2::PXD::PXDDAQDQMModule::hEODBAfterInjLER
TH1I * hEODBAfterInjLER
Histogram of EODB after LER injection.
Definition: PXDDAQDQMModule.h:89
Belle2::PXD::PXDDAQDQMModule::hDAQEndErrorDHE
TH2D * hDAQEndErrorDHE
individual DHE END errors
Definition: PXDDAQDQMModule.h:82
Belle2::PXD::PXDDAQDQMModule::hDAQDHETriggerGate
std::map< VxdID, TH1D * > hDAQDHETriggerGate
DHE Trigger Gate ("start Row")
Definition: PXDDAQDQMModule.h:83
Belle2::PXD::PXDDAQDQMModule::hCM63TrgDiff
TH1I * hCM63TrgDiff
Histogram of CM63 after last trigger.
Definition: PXDDAQDQMModule.h:98
Belle2::PXD::PXDDAQDQMModule::hMissAfterInjHER
TH1I * hMissAfterInjHER
Histogram MissFrame after HER injection.
Definition: PXDDAQDQMModule.h:96
Belle2::PXD::PXDDAQDQMModule::m_histogramDirectoryName
std::string m_histogramDirectoryName
Name of the histogram directory in ROOT file.
Definition: PXDDAQDQMModule.h:57
Belle2::PXD::PXDDAQDQMModule::hDAQErrorDHE
TH2D * hDAQErrorDHE
individual DHE errors
Definition: PXDDAQDQMModule.h:80
Belle2::PXD::PXDDAQDQMModule::hDAQStat
TH1D * hDAQStat
Histogram for Truncation etc Stats.
Definition: PXDDAQDQMModule.h:101
Belle2::PXD::PXDDAQDQMModule::hDAQNotUseableModule
TH1D * hDAQNotUseableModule
Count Useable/unuseable decision.
Definition: PXDDAQDQMModule.h:76
Belle2::VXD::SensorInfoBase::PXD
@ PXD
PXD Sensor.
Definition: SensorInfoBase.h:44
Belle2::PXD::PXDDAQDQMModule::m_vxdGeometry
VXD::GeoCache & m_vxdGeometry
the geometry
Definition: PXDDAQDQMModule.h:69
Belle2::PXD::PXDDAQDQMModule::hDAQCM
std::map< VxdID, TH2D * > hDAQCM
Common Mode per DHE to gate and DHP level.
Definition: PXDDAQDQMModule.h:85
Belle2::PXD::PXDDAQDQMModule::hDAQErrorDHC
TH2D * hDAQErrorDHC
individual DHC errors
Definition: PXDDAQDQMModule.h:79
Belle2::VXD::GeoCache::getSensorInfo
const SensorInfoBase & getSensorInfo(Belle2::VxdID id) const
Return a referecne to the SensorInfo of a given SensorID.
Definition: GeoCache.cc:68
Belle2::PXD::PXDDAQDQMModule::hMissAfterInjLER
TH1I * hMissAfterInjLER
Histogram MissFrame after LER injection.
Definition: PXDDAQDQMModule.h:95
Belle2::PXD::PXDDAQDQMModule::hEODBTrgDiff
TH1I * hEODBTrgDiff
Histogram of EODB after last trigger.
Definition: PXDDAQDQMModule.h:97