Belle II Software development
ECLDQMModule Class Reference

This module is created to monitor ECL Data Quality. More...

#include <eclDQM.h>

Inheritance diagram for ECLDQMModule:
HistoModule Module PathElement

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

 ECLDQMModule ()
 < derived from HistoModule class.
 
virtual ~ECLDQMModule ()
 Destructor.
 
virtual void initialize () override
 Initialize the module.
 
virtual void beginRun () override
 Call when a run begins.
 
virtual void event () override
 Event processor.
 
virtual void endRun () override
 Call when a run ends.
 
virtual void terminate () override
 Terminate.
 
virtual void defineHisto () override
 Function to define histograms.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
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.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
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.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
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.
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
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.
 
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.
 
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.
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

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.
 
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.
 
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.
 
void setType (const std::string &type)
 Set the module type.
 
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.
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module.
 
void setReturnValue (int value)
 Sets the return value for this module as integer.
 
void setReturnValue (bool value)
 Sets the return value for this module as bool.
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

bool isRandomTrigger ()
 
bool fillInvMassHistogram ()
 Fill entries for pi0 invariant mass distribution.
 
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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

ECL::ECLGeometryParm_geom {nullptr}
 Geometry.
 
StoreObjPtr< EventMetaDatam_eventmetadata
 StoreObjPtr EventMetaData.
 
StoreObjPtr< TRGSummarym_l1Trigger
 StoreObjPtr TRGSummary

 
ECL::ECLChannelMapper mapper
 ECL channel mapper.
 
StoreArray< ECLDigitm_ECLDigits
 StoreArray ECLDigit.
 
StoreArray< ECLDspm_ECLDsps
 StoreArray ECLDsp.
 
StoreArray< ECLTrigm_ECLTrigs
 StoreArray ECLTrig.
 
StoreArray< ECLCalDigitm_ECLCalDigits
 StoreArray ECLCalDigit.
 
DBObjPtr< ECLCrystalCalibm_calibrationThrApsd
 PSD waveform amplitude threshold.
 
int m_iEvent { -1}
 Global event number.
 
std::string m_histogramDirectoryName
 Histogram directory in ROOT file.
 
double m_EnergyUpperThr
 Upper threshold of energy deposition in event, [GeV].
 
bool m_DPHYTTYP {0}
 Flag to select events triggered by delayed bhabha.
 
std::string m_pi0PListName
 Name of the pi0 particle list.
 
std::vector< double > m_HitThresholds = {}
 Parameters for hit occ.
 
std::vector< double > m_TotalEnergyThresholds = {}
 Parameters for histograms w/ total energy.
 
std::vector< double > m_TimingThresholds = {}
 Parameters for timing histograms.
 
std::vector< double > m_HitNumberUpperLimits = {}
 Parameters for number of hits histograms.
 
std::vector< std::string > m_WaveformOption
 Parameters for waveform histograms.
 
std::vector< double > ecltot = {}
 Container for energy.
 
std::vector< double > nhits = {}
 Container for channel multiplicity.
 
std::vector< int > v_totalthrApsd = {}
 Vector to store psd wf amplitude threshold.
 
int m_DspArray [ECLElementNumbers::c_NCrystals][31] = {}
 WF sampling points for digit array.
 
double m_PedestalMean [ECLElementNumbers::c_NCrystals] = {}
 Pedestal average values.
 
double m_PedestalRms [ECLElementNumbers::c_NCrystals] = {}
 Pedestal rms error values.
 
TH1F * h_evtot {nullptr}
 Histogram: Total event no (auxiliary) to normalize hit map .
 
TH1F * h_evtot_logic {nullptr}
 Histogram: Event no for logic (auxiliary) to normalize logic waveform flow.
 
TH1F * h_evtot_rand {nullptr}
 Histogram: Event no for rand (auxiliary) to normalize rand waveform flow.
 
TH1F * h_evtot_dphy {nullptr}
 Histogram: Event no for dphy (auxiliary) to normalize dphy waveform flow.
 
TH1F * h_quality {nullptr}
 Histogram: Fit quality flag (0 - good, 1 - large amplitude, 3 - bad chi2).
 
TH1F * h_quality_other {nullptr}
 Histogram: Fit quality flag for waveform type 'other'.
 
TH1F * h_bad_quality {nullptr}
 Histogram: Cell IDs w/ bad fit quality flag.
 
TH1F * h_trigtag1 {nullptr}
 Histogram: Trigger tag flag #1.
 
TH1F * h_adc_hits {nullptr}
 Histogram: Fraction of digits above ADC threshold.
 
TH1F * h_time_crate_Thr1GeV_large {nullptr}
 Histogram: Entries with crate time offsets > 100 ns (E > 1 GeV).
 
TH1F * h_pi0_mass {nullptr}
 Histogram: pi0 mass.
 
std::vector< TH1F * > h_cids = {}
 Histogram vector: Hit map.
 
std::vector< TH1F * > h_edeps = {}
 Histogram vector: Total energy.
 
std::vector< TH1F * > h_time_barrels = {}
 Histogram vector: Reconstructed time for barrel.
 
std::vector< TH1F * > h_time_endcaps = {}
 Histogram vector: Reconstructed time for endcaps.
 
std::vector< TH1F * > h_ncevs = {}
 Histogram vector: Channel multiplicity.
 
std::vector< TH1F * > h_cells = {}
 Histogram vector: Waveforms vs CellID.
 
TH1F * h_cell_psd_norm {nullptr}
 Histogram: Normalize to psd hits for CellID.
 
std::vector< TH1F * > h_time_crate_Thr1GeV = {}
 Histogram vector: Reconstructed signal time for all ECL crates above the threshold = 1 GeV.
 
TH2F * h_trigtime_trigid {nullptr}
 Histogram: Trigger time vs.
 
TH2F * h_trigtag2_trigid {nullptr}
 Histogram: Trigger tag flag #2 vs.
 
TProfile * h_pedmean_cellid {nullptr}
 Histogram: Pedestal Average vs.
 
TProfile * h_pedrms_cellid {nullptr}
 Histogram: Pedestal rms error vs.
 
TProfile * h_pedrms_thetaid {nullptr}
 Histogram: Pedestal rms error vs.
 
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

This module is created to monitor ECL Data Quality.

Definition at line 44 of file eclDQM.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.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 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ ECLDQMModule()

< derived from HistoModule class.

Constructor.

Definition at line 56 of file eclDQM.cc.

57 : HistoModule(),
58 m_calibrationThrApsd("ECL_FPGA_StoreWaveform")
59{
60 //Set module properties.
62 "Primary module for ECL Data Quality Monitor.\n"
63 "This module provides a large set of low-level histograms: occupancy, time distribution, number of saved waveforms, etc.");
64 setPropertyFlags(c_ParallelProcessingCertified); // specify parallel processing.
65
66 m_WaveformOption = {"psd", "logic", "rand", "dphy", "other"};
67
68 addParam("histogramDirectoryName", m_histogramDirectoryName,
69 "histogram directory in ROOT file", std::string("ECL"));
70 addParam("EnergyUpperThr", m_EnergyUpperThr, "Upper threshold of energy deposition in event, [GeV]", 20.0 * Belle2::Unit::GeV);
71 addParam("HitThresholds", m_HitThresholds, "Thresholds to display hit occupancy, MeV", std::vector<double> {0, 5, 10, 50});
72 addParam("TotalEnergyThresholds", m_TotalEnergyThresholds, "Thresholds to display total energy, MeV", std::vector<double> {0, 5, 7});
73 addParam("TimingThresholds", m_TimingThresholds, "Thresholds (MeV) to display ECL timing", std::vector<double> {5, 10, 50});
74 addParam("HitNumberUpperlimits", m_HitNumberUpperLimits,
75 "Upper limit (# of hits) to display hit multiplicity", std::vector<double> {10000, 1000, 700, 200});
76 addParam("WaveformOption", m_WaveformOption, "Option (all,psd,logic,rand,dphy,other) to display waveform flow",
78 addParam("DPHYTTYP", m_DPHYTTYP,
79 "Flag to control trigger of delayed bhabha events; 0 - select events by 'bha_delay' trigger bit, 1 - select by TTYP_DPHY", false);
80 addParam("PI0PListName", m_pi0PListName, "Name of the pi0 particle list", std::string("pi0:eclDQM"));
81}
bool m_DPHYTTYP
Flag to select events triggered by delayed bhabha.
Definition: eclDQM.h:107
std::vector< double > m_TimingThresholds
Parameters for timing histograms.
Definition: eclDQM.h:116
double m_EnergyUpperThr
Upper threshold of energy deposition in event, [GeV].
Definition: eclDQM.h:105
std::string m_histogramDirectoryName
Histogram directory in ROOT file.
Definition: eclDQM.h:103
std::vector< double > m_HitNumberUpperLimits
Parameters for number of hits histograms.
Definition: eclDQM.h:118
std::vector< double > m_TotalEnergyThresholds
Parameters for histograms w/ total energy.
Definition: eclDQM.h:114
std::vector< std::string > m_WaveformOption
Parameters for waveform histograms.
Definition: eclDQM.h:120
std::vector< double > m_HitThresholds
Parameters for hit occ.
Definition: eclDQM.h:112
std::string m_pi0PListName
Name of the pi0 particle list.
Definition: eclDQM.h:109
DBObjPtr< ECLCrystalCalib > m_calibrationThrApsd
PSD waveform amplitude threshold.
Definition: eclDQM.h:98
HistoModule()
Constructor.
Definition: HistoModule.h:32
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
static const double GeV
Standard of [energy, momentum, mass].
Definition: Unit.h:51
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:560

◆ ~ECLDQMModule()

~ECLDQMModule ( )
virtual

Destructor.

Definition at line 83 of file eclDQM.cc.

84{
85}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Call when a run begins.

Reimplemented from HistoModule.

Definition at line 271 of file eclDQM.cc.

272{
273 h_evtot->Reset();
274 h_evtot_logic->Reset();
275 h_evtot_rand->Reset();
276 h_evtot_dphy->Reset();
277 h_quality->Reset();
278 h_quality_other->Reset();
279 h_bad_quality->Reset();
280 h_trigtag1->Reset();
281 h_adc_hits->Reset();
283 h_cell_psd_norm->Reset();
284 for (TH1F* histogram : h_cids)
285 histogram->Reset();
286 for (TH1F* histogram : h_edeps)
287 histogram->Reset();
288 for (TH1F* histogram : h_time_barrels)
289 histogram->Reset();
290 for (TH1F* histogram : h_time_endcaps)
291 histogram->Reset();
292 for (TH1F* histogram : h_ncevs)
293 histogram->Reset();
294 for (TH1F* histogram : h_cells)
295 histogram->Reset();
296 for (TH1F* histogram : h_time_crate_Thr1GeV)
297 histogram->Reset();
298 h_trigtag2_trigid->Reset();
299 h_pedmean_cellid->Reset();
300 h_pedrms_cellid->Reset();
301 h_pedrms_thetaid->Reset();
302 h_trigtime_trigid->Reset();
303 h_pi0_mass->Reset();
304}
TH1F * h_trigtag1
Histogram: Trigger tag flag #1.
Definition: eclDQM.h:151
TH1F * h_bad_quality
Histogram: Cell IDs w/ bad fit quality flag.
Definition: eclDQM.h:149
TH1F * h_adc_hits
Histogram: Fraction of digits above ADC threshold.
Definition: eclDQM.h:153
TH1F * h_cell_psd_norm
Histogram: Normalize to psd hits for CellID.
Definition: eclDQM.h:172
TH2F * h_trigtime_trigid
Histogram: Trigger time vs.
Definition: eclDQM.h:176
std::vector< TH1F * > h_edeps
Histogram vector: Total energy.
Definition: eclDQM.h:162
std::vector< TH1F * > h_ncevs
Histogram vector: Channel multiplicity.
Definition: eclDQM.h:168
TH1F * h_evtot
Histogram: Total event no (auxiliary) to normalize hit map .
Definition: eclDQM.h:137
std::vector< TH1F * > h_time_barrels
Histogram vector: Reconstructed time for barrel.
Definition: eclDQM.h:164
TProfile * h_pedmean_cellid
Histogram: Pedestal Average vs.
Definition: eclDQM.h:180
TH1F * h_evtot_rand
Histogram: Event no for rand (auxiliary) to normalize rand waveform flow.
Definition: eclDQM.h:141
std::vector< TH1F * > h_time_crate_Thr1GeV
Histogram vector: Reconstructed signal time for all ECL crates above the threshold = 1 GeV.
Definition: eclDQM.h:174
TH1F * h_time_crate_Thr1GeV_large
Histogram: Entries with crate time offsets > 100 ns (E > 1 GeV).
Definition: eclDQM.h:155
TH1F * h_evtot_logic
Histogram: Event no for logic (auxiliary) to normalize logic waveform flow.
Definition: eclDQM.h:139
TProfile * h_pedrms_thetaid
Histogram: Pedestal rms error vs.
Definition: eclDQM.h:184
TH1F * h_evtot_dphy
Histogram: Event no for dphy (auxiliary) to normalize dphy waveform flow.
Definition: eclDQM.h:143
TH1F * h_quality
Histogram: Fit quality flag (0 - good, 1 - large amplitude, 3 - bad chi2).
Definition: eclDQM.h:145
TH2F * h_trigtag2_trigid
Histogram: Trigger tag flag #2 vs.
Definition: eclDQM.h:178
TH1F * h_pi0_mass
Histogram: pi0 mass.
Definition: eclDQM.h:157
TH1F * h_quality_other
Histogram: Fit quality flag for waveform type 'other'.
Definition: eclDQM.h:147
std::vector< TH1F * > h_cids
Histogram vector: Hit map.
Definition: eclDQM.h:160
TProfile * h_pedrms_cellid
Histogram: Pedestal rms error vs.
Definition: eclDQM.h:182
std::vector< TH1F * > h_cells
Histogram vector: Waveforms vs CellID.
Definition: eclDQM.h:170
std::vector< TH1F * > h_time_endcaps
Histogram vector: Reconstructed time for endcaps.
Definition: eclDQM.h:166

◆ 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 179 of file Module.cc.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ 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 439 of file Module.h.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ 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 420 of file Module.h.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ defineHisto()

void defineHisto ( )
overridevirtual

Function to define histograms.

Reimplemented from HistoModule.

Definition at line 88 of file eclDQM.cc.

89{
90 TDirectory* oldDir = gDirectory;
91
92 // Create a separate histogram directory and cd into it.
93
94 TDirectory* dirDAQ = dynamic_cast<TDirectory*>(oldDir->Get(m_histogramDirectoryName.c_str()));
95 if (!dirDAQ) dirDAQ = oldDir->mkdir(m_histogramDirectoryName.c_str());
96 dirDAQ->cd();
97
98 //1D histograms creation.
99 h_evtot = new TH1F("event", "Total event bank", 1, 0, 1);
100
101 h_quality = new TH1F("quality", "Fit quality flag. 0-good, 1-integer overflow, 2-low amplitude, 3-bad chi2", 4, 0, 4);
102 h_quality->GetXaxis()->SetTitle("Quality flag");
103 h_quality->GetYaxis()->SetTitle("ECL hits count");
104 h_quality->SetFillColor(kPink - 4);
105
106 h_quality_other = new TH1F("quality_other", "Fit quality flag for unexpectedly saved waveforms", 4, 0, 4);
107 h_quality_other->GetXaxis()->SetTitle("Quality flag. 0-good,1-int overflow,2-low amplitude,3-bad chi2");
108 h_quality_other->SetFillColor(kPink - 4);
109
110 h_bad_quality = new TH1F("bad_quality", "Fraction of hits with bad chi2 (qual=3) and E > 1 GeV vs Cell ID",
112 h_bad_quality->GetXaxis()->SetTitle("Cell ID");
113 h_bad_quality->GetYaxis()->SetTitle("ECL hits count");
114
115 h_trigtag1 = new TH1F("trigtag1", "Consistency b/w global event number and trigger tag. 0-good, 1-DQM error", 2, 0, 2);
116 h_trigtag1->GetXaxis()->SetTitle("Flag value");
117 h_trigtag1->GetYaxis()->SetTitle("Events count");
118 h_trigtag1->SetDrawOption("hist");
119 h_trigtag1->SetFillColor(kPink - 4);
120
121 h_adc_hits = new TH1F("adc_hits", "Fraction of high-energy hits (E > 50 MeV)", 1001, 0, 1.001);
122 h_adc_hits->GetXaxis()->SetTitle("Fraction");
123 h_adc_hits->GetYaxis()->SetTitle("Events count");
124
125 h_time_crate_Thr1GeV_large = new TH1F("time_crate_Thr1GeV_large",
126 "Number of hits with timing outside #pm 100 ns per Crate ID (E > 1 GeV)",
127 52, 1, 53);
128 h_time_crate_Thr1GeV_large->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
129 h_time_crate_Thr1GeV_large->GetYaxis()->SetTitle("ECL hits count");
130
131 for (const auto& id : m_HitThresholds) {
132 std::string h_name, h_title;
133 h_name = str(boost::format("cid_Thr%1%MeV") % id);
134 h_title = str(boost::format("Occupancy per Cell ID (E > %1% MeV)") % id);
135 TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(),
137 h->GetXaxis()->SetTitle("Cell ID");
138 h->GetYaxis()->SetTitle("Occupancy (hits / events_count)");
139 h_cids.push_back(h);
140 }
141
142 for (const auto& id : m_TotalEnergyThresholds) {
143 std::string h_name, h_title;
144 h_name = str(boost::format("edep_Thr%1%MeV") % id);
145 h_title = str(boost::format("Total energy (thr = %1% MeV)") % id);
146 TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), (int)(100 * m_EnergyUpperThr), 0, m_EnergyUpperThr);
147 h->GetXaxis()->SetTitle("Energy, [GeV]");
148 h_edeps.push_back(h);
149 }
150
151 for (const auto& id : m_TimingThresholds) {
152 std::string h_bar_name, h_bar_title;
153 std::string h_end_name, h_end_title;
154 h_bar_name = str(boost::format("time_barrel_Thr%1%MeV") % id);
155 h_bar_title = str(boost::format("Reconstructed time for ECL barrel (E > %1% MeV)") % id);
156 h_end_name = str(boost::format("time_endcaps_Thr%1%MeV") % id);
157 h_end_title = str(boost::format("Reconstructed time for ECL endcaps (E > %1% MeV)") % id);
158 TH1F* h_time_barrel = new TH1F(h_bar_name.c_str(), h_bar_title.c_str(), 206, -1030, 1030);
159 TH1F* h_time_endcap = new TH1F(h_end_name.c_str(), h_end_title.c_str(), 206, -1030, 1030);
160 h_time_barrel->GetXaxis()->SetTitle("Time, [ns]");
161 h_time_endcap->GetXaxis()->SetTitle("Time, [ns]");
162 h_time_barrels.push_back(h_time_barrel);
163 h_time_endcaps.push_back(h_time_endcap);
164 }
165
166 for (const auto& id : boost::combine(m_HitThresholds, m_HitNumberUpperLimits)) {
167 double id1 = 0, id2 = 0;
168 boost::tie(id1, id2) = id;
169 std::string h_name, h_title;
170 h_name = str(boost::format("ncev_Thr%1%MeV") % id1);
171 h_title = str(boost::format("Number of hits in event (E > %1% MeV)") % id1);
172 TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), id2, 0, id2);
173 h->GetXaxis()->SetTitle("Number of hits");
174 h_ncevs.push_back(h);
175 }
176
177 for (int i = 0; i < ECL_CRATES; i++) {
178 int crate = i + 1;
179 std::string h_name, h_title;
180 h_name = str(boost::format("time_crate_%1%_Thr1GeV") % (crate));
181 h_title = str(boost::format("Reconstructed time for ECL crate #%1% with E > 1 GeV") % (crate));
182 TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), 400, -100, 100);
183 h->GetXaxis()->SetTitle("Time [ns]");
184 h_time_crate_Thr1GeV.push_back(h);
185 }
186
187 for (const auto& id : m_WaveformOption) {
188 if (id != "all" && id != "psd" && id != "logic" && id != "rand" && id != "dphy" && id != "other")
189 B2WARNING("Waveform Options are not correctly assigned. They must be 'all', 'psd', 'logic', 'rand', 'dphy', 'other'!");
190 std::string h_title;
191 std::string h_cell_name;
192 if (id == "other") h_title = "Unexpectedly saved waveforms";
193 if (id == "psd") h_title = "#frac{Saved}{Expected} waveforms for high-energy hits (E > 50 MeV)";
194 if (id == "logic") h_title = "#frac{Saved}{Expected} waveforms for every 1000th event";
195 if (id == "rand") h_title = "#frac{Saved}{Expected} waveforms for random trigger events";
196 if (id == "dphy") h_title = "#frac{Saved}{Expected} waveforms for delayed bhabha (DPHY) events";
197 if (id == "all") h_title = "#frac{Saved}{Expected} waveforms for all events";
198 h_cell_name = str(boost::format("wf_cid_%1%") % (id));
199 TH1F* h_cell = new TH1F(h_cell_name.c_str(), h_title.c_str(),
201 h_cell->GetXaxis()->SetTitle("Cell ID");
202 if (id == "psd") {
203 h_cell_psd_norm = new TH1F("psd_cid", "Normalization to psd hits for cid",
205 }
206 if (id == "logic") {
207 h_evtot_logic = new TH1F("event_logic", "Event bank for logic", 1, 0, 1);
208 }
209 if (id == "rand") {
210 h_evtot_rand = new TH1F("event_rand", "Event bank for rand", 1, 0, 1);
211 }
212 if (id == "dphy") {
213 h_evtot_dphy = new TH1F("event_dphy", "Event bank for dphy", 1, 0, 1);
214 }
215 h_cells.push_back(h_cell);
216 }
217
218 //2D histograms creation.
219
220 h_trigtag2_trigid = new TH2F("trigtag2_trigid", "Internal data consistency vs crate. 0-good, 1-data corruption",
221 52, 1, 53, 11, -1, 10);
222 h_trigtag2_trigid->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
223 h_trigtag2_trigid->GetYaxis()->SetTitle("Data consistency flag");
224
225 h_pedmean_cellid = new TProfile("pedmean_cellid", "Pedestal vs Cell ID",
227 h_pedmean_cellid->GetXaxis()->SetTitle("Cell ID");
228 h_pedmean_cellid->GetYaxis()->SetTitle("Ped. average (ADC units, #approx 0.05 MeV)");
229
230 h_pedrms_cellid = new TProfile("pedrms_cellid", "Pedestal stddev vs Cell ID",
232 h_pedrms_cellid->GetXaxis()->SetTitle("Cell ID");
233 h_pedrms_cellid->GetYaxis()->SetTitle("Ped. stddev (ADC units, #approx 0.05 MeV)");
234
235 h_pedrms_thetaid = new TProfile("pedrms_thetaid", "Pedestal stddev vs #theta ID",
236 68, 0, 68);
237 h_pedrms_thetaid->GetXaxis()->SetTitle("#theta ID (0-12=FWD, 59-67=BWD endcap)");
238 h_pedrms_thetaid->GetYaxis()->SetTitle("Ped. stddev (ADC units, #approx 0.05 MeV)");
239
240 h_trigtime_trigid = new TH2F("trigtime_trigid", "Trigger time vs Crate ID", 52, 1, 53, 145, 0, 145);
241 h_trigtime_trigid->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
242 h_trigtime_trigid->GetYaxis()->SetTitle("Trigger time (only even, 0-142)");
243
244 h_pi0_mass = new TH1F("ecl_pi0_mass", "ecl_pi0_mass", 120, 0.08, 0.20);
245
246 //cd into parent directory.
247
248 oldDir->cd();
249}
const int c_NCrystals
Number of crystals.

◆ endRun()

void endRun ( void  )
overridevirtual

Call when a run ends.

Reimplemented from HistoModule.

Definition at line 443 of file eclDQM.cc.

444{
445}

◆ 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 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Event processor.

Reimplemented from HistoModule.

Definition at line 306 of file eclDQM.cc.

307{
308 int trigtag1 = 0;
309 int NDigits = 0;
310 for (auto& value : ecltot) value = 0;
311 for (auto& value : nhits) value = 0;
312 bool bhatrig = false;
313
314 if (m_l1Trigger.isValid() && m_DPHYTTYP) bhatrig = m_l1Trigger->getTimType() == TRGSummary::ETimingType::TTYP_DPHY;
315 else if (m_l1Trigger.isValid() && !m_DPHYTTYP) {
316 try { bhatrig = m_l1Trigger->testInput("bha_delay"); }
317 catch (const std::exception&) { bhatrig = false; }
318 }
319
320 m_iEvent = -1;
321 if (m_eventmetadata.isValid()) {
322 if (m_eventmetadata->getErrorFlag() != 0x10) {
323 m_iEvent = m_eventmetadata->getEvent();
324 h_evtot->Fill(0);
325 for (const auto& id : m_WaveformOption) {
326 if (id == "logic" && m_iEvent % 1000 == 999) h_evtot_logic->Fill(0);
327 if (id == "rand" && isRandomTrigger()) h_evtot_rand->Fill(0);
328 if (id == "dphy" && bhatrig) h_evtot_dphy->Fill(0);
329 }
330 }
331 }
332
333 for (auto& aECLDigit : m_ECLDigits) {
334 int i = aECLDigit.getCellId() - 1;
335 h_quality->Fill(aECLDigit.getQuality()); //Fit quality histogram filling.
336 if (aECLDigit.getAmp() > 2.e04 && aECLDigit.getQuality() == 3) h_bad_quality->Fill(aECLDigit.getCellId());
337 if (aECLDigit.getAmp() >= (v_totalthrApsd[i] / 4 * 4)) NDigits ++;
338 for (const auto& id : m_WaveformOption) {
339 if (id != "psd") continue;
340 else if (id == "psd" && (m_iEvent % 1000 == 999 ||
341 isRandomTrigger() ||
342 bhatrig ||
343 aECLDigit.getAmp() < (v_totalthrApsd[i] / 4 * 4))) continue;
344 h_cell_psd_norm->Fill(aECLDigit.getCellId());
345 }
346 }
347
348 for (auto& aECLTrig : m_ECLTrigs) {
349 double itrg = aECLTrig.getTimeTrig();
350 //trigger time conversion to acceptable units in range (0, ..., 142).
351 //one trigger time clock corresponds to 0.567/144*1000 = 3.93 ns
352 int tg = (int)itrg - 2 * ((int)itrg / 8);
353 h_trigtime_trigid->Fill(aECLTrig.getTrigId(), tg); //Trigger time histogram filling.
354 trigtag1 += aECLTrig.getTrigTag();
355 h_trigtag2_trigid->Fill(aECLTrig.getTrigId(), aECLTrig.getTrigTagQualityFlag()); //Data consistency histogram filling.
356 }
357
358 if (m_ECLTrigs.getEntries() > 0) {
359 int flagtag = 1;
360 trigtag1 /= m_ECLTrigs.getEntries();
361 int compar = (65535 & m_iEvent);
362 if (compar == trigtag1) flagtag = 0;
363 h_trigtag1->Fill(flagtag); //Trigger tag flag #1 histogram filling.
364 }
365
366 for (auto& aECLCalDigit : m_ECLCalDigits) {
367 int cid = aECLCalDigit.getCellId();
368 double energy = aECLCalDigit.getEnergy(); //get calibrated energy.
369 double timing = aECLCalDigit.getTime(); //get calibrated time.
370
371 for (size_t i = 0; i < m_HitThresholds.size(); i++) {
372 auto thrGeV = m_HitThresholds[i] / 1000.;
373 if (energy > thrGeV) {
374 h_cids[i]->Fill(cid);
375 nhits[i] += 1;
376 }
377 }
378
379 for (const auto& thr : m_TotalEnergyThresholds | indexed(0)) {
380 auto thrGeV = thr.value() / 1000.;
381 if (energy > thrGeV) ecltot[thr.index()] += energy;
382 }
383
384 for (const auto& thr : m_TimingThresholds | indexed(0)) {
385 auto thrGeV = thr.value() / 1000.;
386 if (energy > thrGeV) {
387 if (cid > ECL_FWD_CHANNELS && cid <= ECL_FWD_CHANNELS + ECL_BARREL_CHANNELS) h_time_barrels[thr.index()]->Fill(timing);
388 else h_time_endcaps[thr.index()]->Fill(timing);
389 }
390 }
391
392 if (energy > 1.000 && std::abs(timing) < 100.) h_time_crate_Thr1GeV[mapper.getCrateID(cid) - 1]->Fill(timing);
393 if (energy > 1.000 && std::abs(timing) > 100.) h_time_crate_Thr1GeV_large->Fill(mapper.getCrateID(cid));
394 }
395
396 for (const auto& h : h_edeps | indexed(0)) {
397 h.value()->Fill(ecltot[h.index()]);
398 }
399
400 for (const auto& h : h_ncevs | indexed(0)) {
401 h.value()->Fill(nhits[h.index()]);
402 }
403
404 for (auto& aECLDsp : m_ECLDsps) {
405 int i = aECLDsp.getCellId() - 1; //get number of Cell ID in m_DspArray.
406 aECLDsp.getDspA(m_DspArray[i]);
407 m_PedestalMean[i] = 0;
408 m_PedestalRms[i] = 0;
409
410 for (int j = 0; j < 16; j++) m_PedestalMean[i] += m_DspArray[i][j];
411 m_PedestalMean[i] /= 16;
412 h_pedmean_cellid->Fill(aECLDsp.getCellId(), m_PedestalMean[i]); //Pedestal Avg histogram filling.
413
414 for (int j = 0; j < 16; j++) m_PedestalRms[i] += pow(m_DspArray[i][j] - m_PedestalMean[i], 2);
415 m_PedestalRms[i] = sqrt(m_PedestalRms[i] / 15.);
416 h_pedrms_cellid->Fill(aECLDsp.getCellId(), m_PedestalRms[i]); //Pedestal stddev histogram filling.
417 m_geom->Mapping(i);
419
420 ECLDigit* aECLDigit = ECLDigit::getByCellID(aECLDsp.getCellId());
421
422 for (const auto& iter : m_WaveformOption | indexed(0)) {
423 const auto& index = iter.index();
424 const auto& wf_opt = iter.value();
425 if (wf_opt != "all" && wf_opt != "psd" && wf_opt != "logic" && wf_opt != "rand" && wf_opt != "dphy" && wf_opt != "other") continue;
426 else if (wf_opt == "psd" && (m_iEvent % 1000 == 999 || isRandomTrigger() || bhatrig ||
427 !aECLDigit || aECLDigit->getAmp() < (v_totalthrApsd[i] / 4 * 4))) continue;
428 else if (wf_opt == "logic" && m_iEvent % 1000 != 999) continue;
429 else if (wf_opt == "rand" && (m_iEvent % 1000 == 999 || !isRandomTrigger())) continue;
430 else if (wf_opt == "dphy" && (m_iEvent % 1000 == 999 || !bhatrig)) continue;
431 else if (wf_opt == "other" && (m_iEvent % 1000 == 999 || isRandomTrigger() || bhatrig ||
432 (aECLDigit && aECLDigit->getAmp() >= (v_totalthrApsd[i] / 4 * 4)))) continue;
433 h_cells[index]->Fill(aECLDsp.getCellId());
434 if (wf_opt == "other" && aECLDigit) h_quality_other->Fill(aECLDigit->getQuality());
435 }
436 }
437 if (m_ECLDigits.getEntries() > 0)
438 h_adc_hits->Fill((double)NDigits / (double)m_ECLDigits.getEntries()); //Fraction of high-energy hits
439
441}
double m_PedestalMean[ECLElementNumbers::c_NCrystals]
Pedestal average values.
Definition: eclDQM.h:132
std::vector< double > nhits
Container for channel multiplicity.
Definition: eclDQM.h:124
bool fillInvMassHistogram()
Fill entries for pi0 invariant mass distribution.
Definition: eclDQM.cc:459
double m_PedestalRms[ECLElementNumbers::c_NCrystals]
Pedestal rms error values.
Definition: eclDQM.h:134
StoreArray< ECLDsp > m_ECLDsps
StoreArray ECLDsp.
Definition: eclDQM.h:92
StoreArray< ECLCalDigit > m_ECLCalDigits
StoreArray ECLCalDigit.
Definition: eclDQM.h:96
StoreObjPtr< TRGSummary > m_l1Trigger
StoreObjPtr TRGSummary
Definition: eclDQM.h:86
int m_iEvent
Global event number.
Definition: eclDQM.h:101
ECL::ECLGeometryPar * m_geom
Geometry.
Definition: eclDQM.h:82
StoreArray< ECLDigit > m_ECLDigits
StoreArray ECLDigit.
Definition: eclDQM.h:90
std::vector< double > ecltot
Container for energy.
Definition: eclDQM.h:122
ECL::ECLChannelMapper mapper
ECL channel mapper.
Definition: eclDQM.h:88
int m_DspArray[ECLElementNumbers::c_NCrystals][31]
WF sampling points for digit array.
Definition: eclDQM.h:130
StoreArray< ECLTrig > m_ECLTrigs
StoreArray ECLTrig.
Definition: eclDQM.h:94
StoreObjPtr< EventMetaData > m_eventmetadata
StoreObjPtr EventMetaData.
Definition: eclDQM.h:84
std::vector< int > v_totalthrApsd
Vector to store psd wf amplitude threshold.
Definition: eclDQM.h:126
bool isRandomTrigger()
Definition: eclDQM.cc:452
Class to store ECL digitized hits (output of ECLDigi) relation to ECLHit filled in ecl/modules/eclDig...
Definition: ECLDigit.h:24
int getAmp() const
Get Fitting Amplitude.
Definition: ECLDigit.h:70
int getQuality() const
Get Fitting Quality.
Definition: ECLDigit.h:80
static ECLDigit * getByCellID(int cid)
Find ECLDigit by Cell ID using linear search.
Definition: ECLDigit.cc:14
int getCrateID(int iCOPPERNode, int iFINESSE, bool pcie40=false)
Get crate number by given COPPER node number and FINESSE number.
void Mapping(int cid)
Mapping theta, phi Id.
int GetThetaID()
Get Theta Id.
@ TTYP_DPHY
delayed physics events for background
Definition: TRGSummary.h:65
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ fillInvMassHistogram()

bool fillInvMassHistogram ( )
private

Fill entries for pi0 invariant mass distribution.

Returns
true if the current event satisfied selection criteria

Definition at line 459 of file eclDQM.cc.

460{
461 const std::string trg_identifier = "software_trigger_cut&skim&accept_hadron";
463 if (!result.isValid()) return false;
464
465 // check if trigger identifier is available
466 const std::map<std::string, int>& results = result->getResults();
467 if (results.find(trg_identifier) == results.end()) return false;
468 // apply software trigger
469 const bool accepted = (result->getResult(trg_identifier) == SoftwareTriggerCutResult::c_accept);
470 if (!accepted) return false;
471
473 if (!particles.isValid()) return false;
474
475 for (unsigned int i = 0; i < particles->getListSize(); i++) {
476 const Particle* part = particles->getParticle(i);
477 auto inv_mass = Variable::eclClusterOnlyInvariantMass(part);
478 h_pi0_mass->Fill(inv_mass);
479 }
480
481 return true;
482}
Class to store reconstructed particles.
Definition: Particle.h:75
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
@ c_accept
Accept this event.

◆ 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 133 of file Module.cc.

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const
inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const
inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

◆ 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 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( 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.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

135 {
136 return std::vector<std::string>();
137 }

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ 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 187 of file Module.h.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ 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 279 of file Module.cc.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ 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 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ 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 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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 85 of file Module.cc.

86{
87 if_value("<1", path, afterConditionPath);
88}

◆ 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 90 of file Module.cc.

91{
92 if_value(">=1", path, afterConditionPath);
93}

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 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 79 of file Module.cc.

80{
81 m_conditions.emplace_back(expression, path, afterConditionPath);
82}

◆ initialize()

void initialize ( void  )
overridevirtual

Initialize the module.

Reimplemented from HistoModule.

Definition at line 251 of file eclDQM.cc.

252{
253 REG_HISTOGRAM; // required to register histograms to HistoManager.
254 m_ECLDigits.isRequired();
255 m_ECLCalDigits.isOptional();
256 m_ECLTrigs.isOptional();
257 m_ECLDsps.isOptional();
258 m_l1Trigger.isOptional();
259
260 if (!mapper.initFromDB()) B2FATAL("ECL DQM: Can't initialize eclChannelMapper");
261
262 ecltot.resize(m_TotalEnergyThresholds.size());
263 nhits.resize(m_HitNumberUpperLimits.size());
264
266
267 v_totalthrApsd.resize((m_calibrationThrApsd->getCalibVector()).size());
268 for (size_t i = 0; i < v_totalthrApsd.size(); i++) v_totalthrApsd[i] = (int)(m_calibrationThrApsd->getCalibVector())[i];
269}
bool initFromDB()
Initialize channel mapper from the conditions database.
static ECLGeometryPar * Instance()
Static method to get a reference to the ECLGeometryPar instance.

◆ isRandomTrigger()

bool isRandomTrigger ( )
private
Returns
true if the current event is a random trigger event, false otherwise.

Definition at line 452 of file eclDQM.cc.

453{
454 if (!m_l1Trigger.isValid()) return false;
455 return m_l1Trigger->getTimType() == TRGSummary::ETimingType::TTYP_RAND ||
457}
@ TTYP_POIS
poisson random trigger
Definition: TRGSummary.h:73
@ TTYP_RAND
random trigger events
Definition: TRGSummary.h:67

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ 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 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ 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 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ 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 48 of file Module.cc.

49{
50 if (!m_type.empty())
51 B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
52 m_type = type;
53}

◆ terminate()

void terminate ( void  )
overridevirtual

Terminate.

Reimplemented from HistoModule.

Definition at line 448 of file eclDQM.cc.

449{
450}

Member Data Documentation

◆ ecltot

std::vector<double> ecltot = {}
private

Container for energy.

Definition at line 122 of file eclDQM.h.

◆ h_adc_hits

TH1F* h_adc_hits {nullptr}
private

Histogram: Fraction of digits above ADC threshold.

Definition at line 153 of file eclDQM.h.

◆ h_bad_quality

TH1F* h_bad_quality {nullptr}
private

Histogram: Cell IDs w/ bad fit quality flag.

Definition at line 149 of file eclDQM.h.

◆ h_cell_psd_norm

TH1F* h_cell_psd_norm {nullptr}
private

Histogram: Normalize to psd hits for CellID.

Definition at line 172 of file eclDQM.h.

◆ h_cells

std::vector<TH1F*> h_cells = {}
private

Histogram vector: Waveforms vs CellID.

Definition at line 170 of file eclDQM.h.

◆ h_cids

std::vector<TH1F*> h_cids = {}
private

Histogram vector: Hit map.

Definition at line 160 of file eclDQM.h.

◆ h_edeps

std::vector<TH1F*> h_edeps = {}
private

Histogram vector: Total energy.

Definition at line 162 of file eclDQM.h.

◆ h_evtot

TH1F* h_evtot {nullptr}
private

Histogram: Total event no (auxiliary) to normalize hit map .

Definition at line 137 of file eclDQM.h.

◆ h_evtot_dphy

TH1F* h_evtot_dphy {nullptr}
private

Histogram: Event no for dphy (auxiliary) to normalize dphy waveform flow.

Definition at line 143 of file eclDQM.h.

◆ h_evtot_logic

TH1F* h_evtot_logic {nullptr}
private

Histogram: Event no for logic (auxiliary) to normalize logic waveform flow.

Definition at line 139 of file eclDQM.h.

◆ h_evtot_rand

TH1F* h_evtot_rand {nullptr}
private

Histogram: Event no for rand (auxiliary) to normalize rand waveform flow.

Definition at line 141 of file eclDQM.h.

◆ h_ncevs

std::vector<TH1F*> h_ncevs = {}
private

Histogram vector: Channel multiplicity.

Definition at line 168 of file eclDQM.h.

◆ h_pedmean_cellid

TProfile* h_pedmean_cellid {nullptr}
private

Histogram: Pedestal Average vs.

Cell ID.

Definition at line 180 of file eclDQM.h.

◆ h_pedrms_cellid

TProfile* h_pedrms_cellid {nullptr}
private

Histogram: Pedestal rms error vs.

Cell ID.

Definition at line 182 of file eclDQM.h.

◆ h_pedrms_thetaid

TProfile* h_pedrms_thetaid {nullptr}
private

Histogram: Pedestal rms error vs.

Theta ID.

Definition at line 184 of file eclDQM.h.

◆ h_pi0_mass

TH1F* h_pi0_mass {nullptr}
private

Histogram: pi0 mass.

Definition at line 157 of file eclDQM.h.

◆ h_quality

TH1F* h_quality {nullptr}
private

Histogram: Fit quality flag (0 - good, 1 - large amplitude, 3 - bad chi2).

Definition at line 145 of file eclDQM.h.

◆ h_quality_other

TH1F* h_quality_other {nullptr}
private

Histogram: Fit quality flag for waveform type 'other'.

Definition at line 147 of file eclDQM.h.

◆ h_time_barrels

std::vector<TH1F*> h_time_barrels = {}
private

Histogram vector: Reconstructed time for barrel.

Definition at line 164 of file eclDQM.h.

◆ h_time_crate_Thr1GeV

std::vector<TH1F*> h_time_crate_Thr1GeV = {}
private

Histogram vector: Reconstructed signal time for all ECL crates above the threshold = 1 GeV.

Definition at line 174 of file eclDQM.h.

◆ h_time_crate_Thr1GeV_large

TH1F* h_time_crate_Thr1GeV_large {nullptr}
private

Histogram: Entries with crate time offsets > 100 ns (E > 1 GeV).

Definition at line 155 of file eclDQM.h.

◆ h_time_endcaps

std::vector<TH1F*> h_time_endcaps = {}
private

Histogram vector: Reconstructed time for endcaps.

Definition at line 166 of file eclDQM.h.

◆ h_trigtag1

TH1F* h_trigtag1 {nullptr}
private

Histogram: Trigger tag flag #1.

Definition at line 151 of file eclDQM.h.

◆ h_trigtag2_trigid

TH2F* h_trigtag2_trigid {nullptr}
private

Histogram: Trigger tag flag #2 vs.

Trig Cell ID.

Definition at line 178 of file eclDQM.h.

◆ h_trigtime_trigid

TH2F* h_trigtime_trigid {nullptr}
private

Histogram: Trigger time vs.

Trig Cell ID.

Definition at line 176 of file eclDQM.h.

◆ m_calibrationThrApsd

DBObjPtr<ECLCrystalCalib> m_calibrationThrApsd
private

PSD waveform amplitude threshold.

Definition at line 98 of file eclDQM.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_DPHYTTYP

bool m_DPHYTTYP {0}
private

Flag to select events triggered by delayed bhabha.

Definition at line 107 of file eclDQM.h.

◆ m_DspArray

int m_DspArray[ECLElementNumbers::c_NCrystals][31] = {}
private

WF sampling points for digit array.


Definition at line 130 of file eclDQM.h.

◆ m_ECLCalDigits

StoreArray<ECLCalDigit> m_ECLCalDigits
private

StoreArray ECLCalDigit.

Definition at line 96 of file eclDQM.h.

◆ m_ECLDigits

StoreArray<ECLDigit> m_ECLDigits
private

StoreArray ECLDigit.

Definition at line 90 of file eclDQM.h.

◆ m_ECLDsps

StoreArray<ECLDsp> m_ECLDsps
private

StoreArray ECLDsp.

Definition at line 92 of file eclDQM.h.

◆ m_ECLTrigs

StoreArray<ECLTrig> m_ECLTrigs
private

StoreArray ECLTrig.

Definition at line 94 of file eclDQM.h.

◆ m_EnergyUpperThr

double m_EnergyUpperThr
private

Upper threshold of energy deposition in event, [GeV].

Definition at line 105 of file eclDQM.h.

◆ m_eventmetadata

StoreObjPtr<EventMetaData> m_eventmetadata
private

StoreObjPtr EventMetaData.

Definition at line 84 of file eclDQM.h.

◆ m_geom

ECL::ECLGeometryPar* m_geom {nullptr}
private

Geometry.

Definition at line 82 of file eclDQM.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_histogramDirectoryName

std::string m_histogramDirectoryName
private

Histogram directory in ROOT file.

Definition at line 103 of file eclDQM.h.

◆ m_HitNumberUpperLimits

std::vector<double> m_HitNumberUpperLimits = {}
private

Parameters for number of hits histograms.

Definition at line 118 of file eclDQM.h.

◆ m_HitThresholds

std::vector<double> m_HitThresholds = {}
private

Parameters for hit occ.

histograms.

Definition at line 112 of file eclDQM.h.

◆ m_iEvent

int m_iEvent { -1}
private

Global event number.

Definition at line 101 of file eclDQM.h.

◆ m_l1Trigger

StoreObjPtr<TRGSummary> m_l1Trigger
private

StoreObjPtr TRGSummary

Definition at line 86 of file eclDQM.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package
privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

◆ m_PedestalMean

double m_PedestalMean[ECLElementNumbers::c_NCrystals] = {}
private

Pedestal average values.


Definition at line 132 of file eclDQM.h.

◆ m_PedestalRms

double m_PedestalRms[ECLElementNumbers::c_NCrystals] = {}
private

Pedestal rms error values.


Definition at line 134 of file eclDQM.h.

◆ m_pi0PListName

std::string m_pi0PListName
private

Name of the pi0 particle list.

Definition at line 109 of file eclDQM.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_TimingThresholds

std::vector<double> m_TimingThresholds = {}
private

Parameters for timing histograms.

Definition at line 116 of file eclDQM.h.

◆ m_TotalEnergyThresholds

std::vector<double> m_TotalEnergyThresholds = {}
private

Parameters for histograms w/ total energy.

Definition at line 114 of file eclDQM.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_WaveformOption

std::vector<std::string> m_WaveformOption
private

Parameters for waveform histograms.

Definition at line 120 of file eclDQM.h.

◆ mapper

ECL::ECLChannelMapper mapper
private

ECL channel mapper.

Definition at line 88 of file eclDQM.h.

◆ nhits

std::vector<double> nhits = {}
private

Container for channel multiplicity.

Definition at line 124 of file eclDQM.h.

◆ v_totalthrApsd

std::vector<int> v_totalthrApsd = {}
private

Vector to store psd wf amplitude threshold.

Definition at line 126 of file eclDQM.h.


The documentation for this class was generated from the following files: