Belle II Software development
SVDDQMHitTimeModule Class Reference

This module to design collect the svd hit time for different detectors trigger timing and physics processes. More...

#include <SVDDQMHitTimeModule.h>

Inheritance diagram for SVDDQMHitTimeModule:
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

 SVDDQMHitTimeModule ()
 Default constructor.
 
virtual ~SVDDQMHitTimeModule ()
 Destructor.
 
virtual void defineHisto () override
 Definition of histograms.
 
virtual void initialize () override
 Initialize the module.
 
virtual void beginRun () override
 This method is called for each run.
 
virtual void event () override
 This method is called for each event.
 
virtual void endRun () override
 Function to process end_run record.
 
virtual void terminate () override
 Function to terminate module.
 
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

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

std::string m_histogramDirectoryName
 Name of the histogram directory in ROOT file.
 
std::string m_storeSVDClustersName
 SVDClusters StoreArray name.
 
std::string m_storeSVDEventInfoName
 SVDEventInfo StoreObjPtry name.
 
bool m_desynchSVDTime = false
 if TRUE: svdTime back in SVD time reference
 
bool m_3Samples = false
 if true enable 3 samples histograms analysis
 
StoreObjPtr< TRGSummarym_objTrgSummary
 Trigger Summary data object.
 
int m_L1TimingSrc = -1
 L1 timing source from getTimeType() in TRGSummary See ETimingTYpe in mdst/dataobjects/include/TRGSummary.h (but information is obsolete...) (2019/11/11) release-04-00-02, return values from getTimType() are 0=ecltrg, 3=cdctrg, 5=delayed Bhabha, 7=random trigger from gdl, (toptrg is undefined yet)
 
StoreObjPtr< SoftwareTriggerResultm_TrgResult
 Trigger selection data object.
 
StoreObjPtr< EventT0m_eventT0
 EventT0 data object.
 
StoreObjPtr< SVDEventInfom_svdEventInfo
 SVDEventInfo data object.
 
StoreArray< SVDClusterm_clusters
 Store array for clusters.
 
TH1F * m_l3v_bhabha_L1_ECLTRG {nullptr}
 svd time histogram for bhabha events wrt the ECL trigger time
 
TH1F * m_l3vEvtT0_bhabha_L1_ECLTRG {nullptr}
 svd time histogram for bhabha events wrt the ECL trigger time
 
TH1F * m_l3v_hadron_L1_ECLTRG {nullptr}
 svd time histogram for hadronic events wrt the ECL trigger time
 
TH1F * m_l3vEvtT0_hadron_L1_ECLTRG {nullptr}
 svd time histogram for hadronic events wrt the ECL trigger time
 
TH1F * m_l3v_mumu_L1_ECLTRG {nullptr}
 svd time histogram for mu mu events wrt the ECL trigger time
 
TH1F * m_l3vEvtT0_mumu_L1_ECLTRG {nullptr}
 svd time histogram for mu mu events wrt the ECL trigger time
 
TH1F * m_l3v_bhabha_L1_CDCTRG {nullptr}
 svd time histogram for bhabha events wrt the CDC trigger time
 
TH1F * m_l3vEvtT0_bhabha_L1_CDCTRG {nullptr}
 svd time histogram for bhabha events wrt the CDC trigger time
 
TH1F * m_l3v_hadron_L1_CDCTRG {nullptr}
 svd time histogram for hadronic events wrt the CDC trigger time
 
TH1F * m_l3vEvtT0_hadron_L1_CDCTRG {nullptr}
 svd time histogram for hadronic events wrt the CDC trigger time
 
TH1F * m_l3v_mumu_L1_CDCTRG {nullptr}
 svd time histogram for mu mu events wrt the CDC trigger time
 
TH1F * m_l3vEvtT0_mumu_L1_CDCTRG {nullptr}
 svd time histogram for mu mu events wrt the CDC trigger time
 
TH1F * m_SVDEventT03Sample {nullptr}
 SVD event T0 for 3 sampels.
 
TH1F * m_SVDEventT06Sample {nullptr}
 SVD event T0 for 6 sampels.
 
TH1F * m_SVDEventT03Sample_bhabha_L1_ECLTRG {nullptr}
 svd eventT0 histogram for bhabha events wrt the ECL trigger time for 3 samples
 
TH1F * m_SVDEventT03Sample_hadron_L1_ECLTRG {nullptr}
 svd eventT0 histogram for hadronic events wrt the ECL trigger time for 3 samples
 
TH1F * m_SVDEventT03Sample_mumu_L1_ECLTRG {nullptr}
 svd eventT0 histogram for mu mu events wrt the ECL trigger time for 3 samples
 
TH1F * m_SVDEventT03Sample_bhabha_L1_CDCTRG {nullptr}
 svd eventT0 histogram for bhabha events wrt the CDC trigger time for 3 samples
 
TH1F * m_SVDEventT03Sample_hadron_L1_CDCTRG {nullptr}
 svd eventT0 histogram for hadronic events wrt the CDC trigger time for 3 samples
 
TH1F * m_SVDEventT03Sample_mumu_L1_CDCTRG {nullptr}
 svd eventT0 histogram for mu mu events wrt the CDC trigger time for 3 samples
 
TH1F * m_SVDEventT06Sample_bhabha_L1_ECLTRG {nullptr}
 svd eventT0 histogram for bhabha events wrt the ECL trigger time for 6 samples
 
TH1F * m_SVDEventT06Sample_hadron_L1_ECLTRG {nullptr}
 svd eventT0 histogram for hadronic events wrt the ECL trigger time for 6 samples
 
TH1F * m_SVDEventT06Sample_mumu_L1_ECLTRG {nullptr}
 svd eventT0 histogram for mu mu events wrt the ECL trigger time for 6 samples
 
TH1F * m_SVDEventT06Sample_bhabha_L1_CDCTRG {nullptr}
 svd eventT0 histogram for bhabha events wrt the CDC trigger time for 6 samples
 
TH1F * m_SVDEventT06Sample_hadron_L1_CDCTRG {nullptr}
 svd EventT0 histogram for hadronic events wrt the CDC trigger time for 6 samples
 
TH1F * m_SVDEventT06Sample_mumu_L1_CDCTRG {nullptr}
 svd eventT0 histogram for mu mu events wrt the CDC trigger time for 6 samples
 
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 to design collect the svd hit time for different detectors trigger timing and physics processes.

Definition at line 34 of file SVDDQMHitTimeModule.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

◆ SVDDQMHitTimeModule()

Default constructor.

Definition at line 19 of file SVDDQMHitTimeModule.cc.

19 : HistoModule()
20{
21 setPropertyFlags(c_ParallelProcessingCertified); // parallel processing
22 setDescription("Make data quality monitoring plots for SVD Hit Time for bhabha, mu mu, and hadron samples seeded by different trigger times (ECL, CDC).");
23 addParam("histogramDirectoryName", m_histogramDirectoryName, "Name of the directory where histograms will be placed.",
24 std::string("SVDHitTime"));
25 addParam("Clusters", m_storeSVDClustersName, "SVDCluster StoreArray name.",
26 std::string(""));
27 addParam("EventInfo", m_storeSVDEventInfoName, "SVDEventInfo StoreObjPtr name.",
28 std::string(""));
29 addParam("desynchronizeSVDTime", m_desynchSVDTime,
30 "if True, svd time back in SVD time reference", bool(false));
31 addParam("samples3", m_3Samples, "if True 3 samples histograms analysis is performed", bool(false));
32}
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
std::string m_histogramDirectoryName
Name of the histogram directory in ROOT file.
bool m_3Samples
if true enable 3 samples histograms analysis
bool m_desynchSVDTime
if TRUE: svdTime back in SVD time reference
std::string m_storeSVDClustersName
SVDClusters StoreArray name.
std::string m_storeSVDEventInfoName
SVDEventInfo StoreObjPtry name.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~SVDDQMHitTimeModule()

~SVDDQMHitTimeModule ( )
virtual

Destructor.

Definition at line 35 of file SVDDQMHitTimeModule.cc.

35{ }

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

This method is called for each run.

Reimplemented from HistoModule.

Definition at line 199 of file SVDDQMHitTimeModule.cc.

200{
201
202 m_l3v_bhabha_L1_ECLTRG->Reset();
204 m_l3v_hadron_L1_ECLTRG->Reset();
206 m_l3v_mumu_L1_ECLTRG->Reset();
208
209 m_l3v_bhabha_L1_CDCTRG->Reset();
211 m_l3v_hadron_L1_CDCTRG->Reset();
213 m_l3v_mumu_L1_CDCTRG->Reset();
215
216 if (m_3Samples) {
217 m_SVDEventT03Sample->Reset();
218 m_SVDEventT06Sample->Reset();
219
226
233 }
234}
TH1F * m_SVDEventT03Sample_mumu_L1_CDCTRG
svd eventT0 histogram for mu mu events wrt the CDC trigger time for 3 samples
TH1F * m_l3v_mumu_L1_ECLTRG
svd time histogram for mu mu events wrt the ECL trigger time
TH1F * m_SVDEventT03Sample_hadron_L1_CDCTRG
svd eventT0 histogram for hadronic events wrt the CDC trigger time for 3 samples
TH1F * m_SVDEventT03Sample_mumu_L1_ECLTRG
svd eventT0 histogram for mu mu events wrt the ECL trigger time for 3 samples
TH1F * m_l3vEvtT0_mumu_L1_ECLTRG
svd time histogram for mu mu events wrt the ECL trigger time
TH1F * m_SVDEventT06Sample
SVD event T0 for 6 sampels.
TH1F * m_SVDEventT06Sample_bhabha_L1_CDCTRG
svd eventT0 histogram for bhabha events wrt the CDC trigger time for 6 samples
TH1F * m_SVDEventT06Sample_bhabha_L1_ECLTRG
svd eventT0 histogram for bhabha events wrt the ECL trigger time for 6 samples
TH1F * m_l3v_hadron_L1_CDCTRG
svd time histogram for hadronic events wrt the CDC trigger time
TH1F * m_l3vEvtT0_mumu_L1_CDCTRG
svd time histogram for mu mu events wrt the CDC trigger time
TH1F * m_l3vEvtT0_hadron_L1_CDCTRG
svd time histogram for hadronic events wrt the CDC trigger time
TH1F * m_l3v_hadron_L1_ECLTRG
svd time histogram for hadronic events wrt the ECL trigger time
TH1F * m_l3vEvtT0_hadron_L1_ECLTRG
svd time histogram for hadronic events wrt the ECL trigger time
TH1F * m_l3v_bhabha_L1_ECLTRG
svd time histogram for bhabha events wrt the ECL trigger time
TH1F * m_l3vEvtT0_bhabha_L1_CDCTRG
svd time histogram for bhabha events wrt the CDC trigger time
TH1F * m_SVDEventT06Sample_mumu_L1_CDCTRG
svd eventT0 histogram for mu mu events wrt the CDC trigger time for 6 samples
TH1F * m_SVDEventT03Sample_bhabha_L1_ECLTRG
svd eventT0 histogram for bhabha events wrt the ECL trigger time for 3 samples
TH1F * m_l3v_mumu_L1_CDCTRG
svd time histogram for mu mu events wrt the CDC trigger time
TH1F * m_l3v_bhabha_L1_CDCTRG
svd time histogram for bhabha events wrt the CDC trigger time
TH1F * m_SVDEventT06Sample_hadron_L1_ECLTRG
svd eventT0 histogram for hadronic events wrt the ECL trigger time for 6 samples
TH1F * m_SVDEventT03Sample_hadron_L1_ECLTRG
svd eventT0 histogram for hadronic events wrt the ECL trigger time for 3 samples
TH1F * m_SVDEventT06Sample_mumu_L1_ECLTRG
svd eventT0 histogram for mu mu events wrt the ECL trigger time for 6 samples
TH1F * m_SVDEventT03Sample
SVD event T0 for 3 sampels.
TH1F * m_l3vEvtT0_bhabha_L1_ECLTRG
svd time histogram for bhabha events wrt the ECL trigger time
TH1F * m_SVDEventT03Sample_bhabha_L1_CDCTRG
svd eventT0 histogram for bhabha events wrt the CDC trigger time for 3 samples

◆ 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

Definition of histograms.

Reimplemented from HistoModule.

Definition at line 39 of file SVDDQMHitTimeModule.cc.

40{
41
42 TDirectory* oldDir = gDirectory;
43 oldDir->mkdir(m_histogramDirectoryName.c_str())->cd();
44
45 int nBins = 300 ;
46 double minT0 = -150 ;
47 double maxT0 = 150 ;
48
49 TString refFrame = "in FTSW reference";
51 refFrame = "in SVD reference";
52
53 m_l3v_bhabha_L1_ECLTRG = new TH1F("SVDTime_L3V_bhabha_ECLTRG",
54 Form("SVD L3 V-Side Cluster Time %s: bhabhas, ECLTRG time", refFrame.Data()),
55 nBins, minT0, maxT0);
56 m_l3v_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
57 m_l3vEvtT0_bhabha_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_bhabha_ECLTRG",
58 "SVD L3 V-Side Cluster Time - EventT0 : bhabhas, ECLTRG time",
59 nBins, minT0, maxT0);
60 m_l3vEvtT0_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
61
62 m_l3v_hadron_L1_ECLTRG = new TH1F("SVDTime_L3V_hadron_ECLTRG",
63 Form("SVD L3 V-Side Cluster Time %s: hadrons, ECLTRG time", refFrame.Data()),
64 nBins, minT0, maxT0);
65 m_l3v_hadron_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
66 m_l3vEvtT0_hadron_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_hadron_ECLTRG",
67 "SVD L3 V-Side Cluster Time - EventT0 : hadrons, ECLTRG time",
68 nBins, minT0, maxT0);
69 m_l3vEvtT0_hadron_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
70
71 m_l3v_mumu_L1_ECLTRG = new TH1F("SVDTime_L3V_mumu_ECLTRG",
72 Form("SVD L3 V-Side Cluster Time %s: mumus, ECLTRG time", refFrame.Data()),
73 nBins, minT0, maxT0);
74 m_l3v_mumu_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
75 m_l3vEvtT0_mumu_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_mumu_ECLTRG",
76 "SVD L3 V-Side Cluster Time - EventT0 : mumus, ECLTRG time",
77 nBins, minT0, maxT0);
78 m_l3vEvtT0_mumu_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
79
80 m_l3v_bhabha_L1_CDCTRG = new TH1F("SVDTime_L3V_bhabha_CDCTRG",
81 Form("SVD L3 V-Side Cluster Time %s: bhabhas, CDCTRG time", refFrame.Data()),
82 nBins, minT0, maxT0);
83 m_l3v_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
84 m_l3vEvtT0_bhabha_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_bhabha_CDCTRG",
85 "SVD L3 V-Side Cluster Time - EventT0 : bhabhas, CDCTRG time",
86 nBins, minT0, maxT0);
87 m_l3vEvtT0_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
88
89 m_l3v_hadron_L1_CDCTRG = new TH1F("SVDTime_L3V_hadron_CDCTRG",
90 Form("SVD L3 V-Side Cluster Time %s: hadrons, CDCTRG time", refFrame.Data()),
91 nBins, minT0, maxT0);
92 m_l3v_hadron_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
93 m_l3vEvtT0_hadron_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_hadron_CDCTRG",
94 "SVD L3 V-Side Cluster Time - EventT0 : hadrons, CDCTRG time",
95 nBins, minT0, maxT0);
96 m_l3vEvtT0_hadron_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
97
98 m_l3v_mumu_L1_CDCTRG = new TH1F("SVDTime_L3V_mumu_CDCTRG",
99 Form("SVD L3 V-Side Cluster Time %s: mumus, CDCTRG time", refFrame.Data()),
100 nBins, minT0, maxT0);
101 m_l3v_mumu_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
102 m_l3vEvtT0_mumu_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_mumu_CDCTRG",
103 "SVD L3 V-Side Cluster Time - EventT0 : mumus, CDCTRG time",
104 nBins, minT0, maxT0);
105 m_l3vEvtT0_mumu_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
106
107 if (m_3Samples) {
108 m_SVDEventT03Sample = new TH1F("SVD3EventT0", "SVD EventT0 for 3 samples", nBins, minT0, maxT0);
109 m_SVDEventT03Sample->GetXaxis()->SetTitle("SVD EventT0 time (ns)");
110 m_SVDEventT03Sample->GetYaxis()->SetTitle("count");
111
112 m_SVDEventT06Sample = new TH1F("SVDEventT06Sample", "SVD EventT0 for 6 samples", nBins, minT0, maxT0);
113 m_SVDEventT06Sample->GetXaxis()->SetTitle("SVD EventT0 time (ns)");
114 m_SVDEventT06Sample->GetYaxis()->SetTitle("count");
115
116 m_SVDEventT03Sample_bhabha_L1_ECLTRG = new TH1F("SVD3EventT0_bhabha_L1_ECLTRG",
117 "SVD EventT0 3 samples : bhabhas, ECLTRG time",
118 nBins, minT0, maxT0);
119 m_SVDEventT03Sample_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
120
121 m_SVDEventT03Sample_hadron_L1_ECLTRG = new TH1F("SVD3EventT0_hadron_L1_ECLTRG",
122 "SVD EventT0 3 samples : hadrons, ECLTRG time",
123 nBins, minT0, maxT0);
124 m_SVDEventT03Sample_hadron_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
125
126 m_SVDEventT03Sample_mumu_L1_ECLTRG = new TH1F("SVD3EventT0_mumu_L1_ECLTRG",
127 "SVD EventT0 3 samples : mumus, ECLTRG time",
128 nBins, minT0, maxT0);
129 m_SVDEventT03Sample_mumu_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
130
131 m_SVDEventT03Sample_bhabha_L1_CDCTRG = new TH1F("SVD3EventT0_bhabha_L1_CDCTRG",
132 "SVD EventT0 3 samples : bhabhas, CDCTRG time",
133 nBins, minT0, maxT0);
134 m_SVDEventT03Sample_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
135
136 m_SVDEventT03Sample_hadron_L1_CDCTRG = new TH1F("SVD3EventT0_hadron_L1_CDCTRG",
137 "SVD EventT0 3 samples : hadrons, CDCTRG time",
138 nBins, minT0, maxT0);
139 m_SVDEventT03Sample_hadron_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
140
141 m_SVDEventT03Sample_mumu_L1_CDCTRG = new TH1F("SVD3EventT0_mumu_L1_CDCTRG",
142 "SVD EventT0 3 samples : mumus, CDCTRG time",
143 nBins, minT0, maxT0);
144 m_SVDEventT03Sample_mumu_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
145
146
147
148 m_SVDEventT06Sample_bhabha_L1_ECLTRG = new TH1F("SVDEventT06Sample_bhabha_L1_ECLTRG",
149 "SVD EventT0 6 samples : bhabhas, ECLTRG time",
150 nBins, minT0, maxT0);
151 m_SVDEventT06Sample_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
152
153 m_SVDEventT06Sample_hadron_L1_ECLTRG = new TH1F("SVDEventT06Sample_hadron_L1_ECLTRG",
154 "SVD EventT0 6 samples : hadrons, ECLTRG time",
155 nBins, minT0, maxT0);
156 m_SVDEventT06Sample_hadron_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
157
158 m_SVDEventT06Sample_mumu_L1_ECLTRG = new TH1F("SVDEventT06Sample_mumu_L1_ECLTRG",
159 "SVD EventT0 6 samples : mumus, ECLTRG time",
160 nBins, minT0, maxT0);
161 m_SVDEventT06Sample_mumu_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
162
163 m_SVDEventT06Sample_bhabha_L1_CDCTRG = new TH1F("SVDEventT06Sample_bhabha_L1_CDCTRG",
164 "SVD EventT0 6 samples : bhabhas, CDCTRG time",
165 nBins, minT0, maxT0);
166 m_SVDEventT06Sample_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
167
168 m_SVDEventT06Sample_hadron_L1_CDCTRG = new TH1F("SVDEventT06Sample_hadron_L1_CDCTRG",
169 "SVD EventT0 6 samples : hadrons, CDCTRG time",
170 nBins, minT0, maxT0);
171 m_SVDEventT06Sample_hadron_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
172
173 m_SVDEventT06Sample_mumu_L1_CDCTRG = new TH1F("SVDEventT06Sample_mumu_L1_CDCTRG",
174 "SVD EventT0 6 samples : mumus, CDCTRG time",
175 nBins, minT0, maxT0);
176 m_SVDEventT06Sample_mumu_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
177 }
178 oldDir->cd();
179
180}
TH1F * m_SVDEventT06Sample_hadron_L1_CDCTRG
svd EventT0 histogram for hadronic events wrt the CDC trigger time for 6 samples

◆ endRun()

◆ 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

This method is called for each event.

All processing of the event takes place in this method.

Reimplemented from HistoModule.

Definition at line 238 of file SVDDQMHitTimeModule.cc.

239{
240
241 if (!m_TrgResult.isValid()) {
242 B2WARNING("Missing TRGSummary, SVDDQMHitTime is skipped.");
243 return;
244 }
245 if (!m_svdEventInfo.isValid()) {
246 B2WARNING("Missing SVDEventInfo, SVDDQMHitTime is skipped.");
247 return;
248 }
249
250
251
252 if (!m_clusters.isValid()) {
253 B2WARNING("Missing SVDClusters, SVDDQMHitTime is skipped.");
254 return;
255 }
256
257
258 if (!m_objTrgSummary.isValid()) {
259 B2WARNING("TRGSummary object not available but required to indicate which detector provided the L1 trigger time");
260 return;
261 } else {
262 m_L1TimingSrc = m_objTrgSummary->getTimType();
263 }
264
265 bool Is_ECL_L1TriggerSource = false ;
266 bool Is_CDC_L1TriggerSource = false ;
267 if (m_L1TimingSrc == TRGSummary::ETimingType::TTYP_ECL) { // for L1 timing source is "ecl trigger"
268 Is_ECL_L1TriggerSource = true ;
269 } else if (m_L1TimingSrc == TRGSummary::ETimingType::TTYP_CDC) { // for L1 timing source is "cdc trigger"
270 Is_CDC_L1TriggerSource = true ;
271 }
272 // else if(m_L1TimingSrc==ETimingType::TTYP_DPHY){ // for L1 timing source is "delayed Bhabha" }
273 B2DEBUG(20, "Is_ECL_L1TriggerSource = " << Is_ECL_L1TriggerSource) ;
274 B2DEBUG(20, "Is_CDC_L1TriggerSource= " << Is_CDC_L1TriggerSource) ;
275
276
277 if (!m_TrgResult.isValid()) {
278 B2WARNING("SoftwareTriggerResult object not available but require to select bhabha/mumu/hadron events for this module");
279 return;
280 }
281
282 const std::map<std::string, int>& fresults = m_TrgResult->getResults();
283 if ((fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end()) ||
284 (fresults.find("software_trigger_cut&skim&accept_mumu_2trk") == fresults.end()) ||
285 (fresults.find("software_trigger_cut&skim&accept_hadron") == fresults.end())) {
286 B2WARNING("SVDDQMHitTimeModule: Can't find required bhabha or mumu or hadron trigger identifier");
287 return;
288 }
289
290
291
292 // determine if the event was part of the hadron skim or bhabha skim or mumu skim
293 const bool IsEvtAcceptedBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
295 const bool IsEvtAcceptedHadron = (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron") ==
297 const bool IsEvtAcceptedMumu = (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk") ==
299
300
301 B2DEBUG(20, "bhabha trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
302 (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha"))) ;
303 B2DEBUG(20, "hadron trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
304 (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron"))) ;
305 B2DEBUG(20, "mu mu trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
306 (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk"))) ;
307 B2DEBUG(20, "bhabha trigger comparison bool = " << IsEvtAcceptedBhabha) ;
308 B2DEBUG(20, "hadron trigger comparison bool = " << IsEvtAcceptedHadron) ;
309 B2DEBUG(20, "mumu trigger comparison bool = " << IsEvtAcceptedMumu) ;
310
311
312 // get EventT0 if present and valid
313 double eventT0 = -1000;
314 if (m_eventT0.isValid())
315 if (m_eventT0->hasEventT0())
316 eventT0 = m_eventT0->getEventT0();
317
318 // if svd time in SVD time reference is shown, eventT0 is also synchronized with SVD reference frame, firstFrame = 0
319 if (m_desynchSVDTime && m_svdEventInfo.isValid())
320 eventT0 = eventT0 - m_svdEventInfo->getSVD2FTSWTimeShift(0);
321
322 int nSamples = m_svdEventInfo->getNSamples();
323
324 if (m_eventT0->hasTemporaryEventT0(Const::EDetector::SVD)) {
325 const auto bestSVDEvtT0 = m_eventT0->getBestSVDTemporaryEventT0() ;
326 // There is only one estimate of SVD EVentT0 for the moment
327 float svdEventT0 = bestSVDEvtT0->eventT0 ;
328
329 if (m_3Samples) {
330 if (nSamples == 3) {
331 m_SVDEventT03Sample->Fill(svdEventT0);
332 } else {
333 m_SVDEventT06Sample->Fill(svdEventT0);
334 }
335
336 if (Is_ECL_L1TriggerSource) {
337 if (IsEvtAcceptedBhabha) {
338 if (nSamples == 3) {
339 m_SVDEventT03Sample_bhabha_L1_ECLTRG->Fill(svdEventT0);
340 } else {
341 m_SVDEventT06Sample_bhabha_L1_ECLTRG->Fill(svdEventT0);
342 }
343 }
344 if (IsEvtAcceptedHadron) {
345 if (nSamples == 3) {
346 m_SVDEventT03Sample_hadron_L1_ECLTRG->Fill(svdEventT0);
347 } else {
348 m_SVDEventT06Sample_hadron_L1_ECLTRG->Fill(svdEventT0);
349 }
350 }
351 if (IsEvtAcceptedMumu) {
352 if (nSamples == 3) {
353 m_SVDEventT03Sample_mumu_L1_ECLTRG->Fill(svdEventT0);
354 } else {
355 m_SVDEventT06Sample_mumu_L1_ECLTRG->Fill(svdEventT0);
356 }
357 }
358 }
359
360 // Fill the plots that used the CDC trigger as the L1 timing source
361 else if (Is_CDC_L1TriggerSource) {
362 if (IsEvtAcceptedBhabha) {
363 if (nSamples == 3) {
364 m_SVDEventT03Sample_bhabha_L1_CDCTRG->Fill(svdEventT0);
365 } else {
366 m_SVDEventT06Sample_bhabha_L1_CDCTRG->Fill(svdEventT0);
367 }
368 }
369 if (IsEvtAcceptedHadron) {
370 if (nSamples == 3) {
371 m_SVDEventT03Sample_hadron_L1_CDCTRG->Fill(svdEventT0);
372 } else {
373 m_SVDEventT06Sample_hadron_L1_CDCTRG->Fill(svdEventT0);
374 }
375 }
376 if (IsEvtAcceptedMumu) {
377 if (nSamples == 3) {
378 m_SVDEventT03Sample_mumu_L1_CDCTRG->Fill(svdEventT0);
379 } else {
380 m_SVDEventT06Sample_mumu_L1_CDCTRG->Fill(svdEventT0);
381 }
382 }
383 }
384 }
385 }
386
387 //loop on clusters
388 for (const SVDCluster& cluster : m_clusters) {
389
390 //skip all non-L3 clusters
391 if (cluster.getSensorID().getLayerNumber() != 3) continue;
392 //skip all U-side clusters
393 if (cluster.isUCluster()) continue;
394
395 double time = cluster.getClsTime();
396
397 //if svd time is shown in SVD time reference we need to desynchronize (eventT0 is, instead, synchronized, see a few lines above
398 if (m_desynchSVDTime && m_svdEventInfo.isValid())
399 time = time - m_svdEventInfo->getSVD2FTSWTimeShift(cluster.getFirstFrame());
400
401 // Fill the plots that used the ECL trigger as the L1 timing source
402 if (Is_ECL_L1TriggerSource) {
403 if (IsEvtAcceptedBhabha) {
404 m_l3v_bhabha_L1_ECLTRG->Fill(time);
405 m_l3vEvtT0_bhabha_L1_ECLTRG->Fill(time - eventT0);
406 }
407 if (IsEvtAcceptedHadron) {
408 m_l3v_hadron_L1_ECLTRG->Fill(time);
409 m_l3vEvtT0_hadron_L1_ECLTRG->Fill(time - eventT0);
410 }
411 if (IsEvtAcceptedMumu) {
412 m_l3v_mumu_L1_ECLTRG->Fill(time);
413 m_l3vEvtT0_mumu_L1_ECLTRG->Fill(time - eventT0);
414 }
415 }
416
417 // Fill the plots that used the CDC trigger as the L1 timing source
418 else if (Is_CDC_L1TriggerSource) {
419 if (IsEvtAcceptedBhabha) {
420 m_l3v_bhabha_L1_CDCTRG->Fill(time);
421 m_l3vEvtT0_bhabha_L1_CDCTRG->Fill(time - eventT0);
422 }
423 if (IsEvtAcceptedHadron) {
424 m_l3v_hadron_L1_CDCTRG->Fill(time);
425 m_l3vEvtT0_hadron_L1_CDCTRG->Fill(time - eventT0);
426 }
427 if (IsEvtAcceptedMumu) {
428 m_l3v_mumu_L1_CDCTRG->Fill(time);
429 m_l3vEvtT0_mumu_L1_CDCTRG->Fill(time - eventT0);
430 }
431 }
432
433 B2DEBUG(20, "eventT0 = " << eventT0 << " ns" << ", SVD HitTime = " << time << " ns") ;
434
435 } //close loop on clusters
436}
The SVD Cluster class This class stores all information about reconstructed SVD clusters.
Definition: SVDCluster.h:29
StoreObjPtr< EventT0 > m_eventT0
EventT0 data object.
StoreObjPtr< SVDEventInfo > m_svdEventInfo
SVDEventInfo data object.
StoreArray< SVDCluster > m_clusters
Store array for clusters.
StoreObjPtr< TRGSummary > m_objTrgSummary
Trigger Summary data object.
int m_L1TimingSrc
L1 timing source from getTimeType() in TRGSummary See ETimingTYpe in mdst/dataobjects/include/TRGSumm...
StoreObjPtr< SoftwareTriggerResult > m_TrgResult
Trigger selection data object.
bool isValid() const
Check wether the array was registered.
Definition: StoreArray.h:288
@ TTYP_CDC
events triggered by CDC timing
Definition: TRGSummary.h:63
@ TTYP_ECL
events triggered by ECL timing
Definition: TRGSummary.h:45
@ c_accept
Accept this event.

◆ 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

◆ 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 184 of file SVDDQMHitTimeModule.cc.

185{
186
187 m_TrgResult.isOptional();
188 m_eventT0.isOptional();
191
192 REG_HISTOGRAM
193
194}
bool isOptional(const std::string &name="")
Tell the DataStore about an optional input.

◆ 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()

Member Data Documentation

◆ m_3Samples

bool m_3Samples = false
private

if true enable 3 samples histograms analysis

Definition at line 71 of file SVDDQMHitTimeModule.h.

◆ m_clusters

StoreArray<SVDCluster> m_clusters
private

Store array for clusters.

Definition at line 84 of file SVDDQMHitTimeModule.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_desynchSVDTime

bool m_desynchSVDTime = false
private

if TRUE: svdTime back in SVD time reference

Definition at line 68 of file SVDDQMHitTimeModule.h.

◆ m_eventT0

StoreObjPtr<EventT0> m_eventT0
private

EventT0 data object.

Definition at line 82 of file SVDDQMHitTimeModule.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

Name of the histogram directory in ROOT file.

Definition at line 60 of file SVDDQMHitTimeModule.h.

◆ m_L1TimingSrc

int m_L1TimingSrc = -1
private

L1 timing source from getTimeType() in TRGSummary See ETimingTYpe in mdst/dataobjects/include/TRGSummary.h (but information is obsolete...) (2019/11/11) release-04-00-02, return values from getTimType() are 0=ecltrg, 3=cdctrg, 5=delayed Bhabha, 7=random trigger from gdl, (toptrg is undefined yet)

Definition at line 79 of file SVDDQMHitTimeModule.h.

◆ m_l3v_bhabha_L1_CDCTRG

TH1F* m_l3v_bhabha_L1_CDCTRG {nullptr}
private

svd time histogram for bhabha events wrt the CDC trigger time

Definition at line 93 of file SVDDQMHitTimeModule.h.

◆ m_l3v_bhabha_L1_ECLTRG

TH1F* m_l3v_bhabha_L1_ECLTRG {nullptr}
private

svd time histogram for bhabha events wrt the ECL trigger time

Definition at line 86 of file SVDDQMHitTimeModule.h.

◆ m_l3v_hadron_L1_CDCTRG

TH1F* m_l3v_hadron_L1_CDCTRG {nullptr}
private

svd time histogram for hadronic events wrt the CDC trigger time

Definition at line 95 of file SVDDQMHitTimeModule.h.

◆ m_l3v_hadron_L1_ECLTRG

TH1F* m_l3v_hadron_L1_ECLTRG {nullptr}
private

svd time histogram for hadronic events wrt the ECL trigger time

Definition at line 88 of file SVDDQMHitTimeModule.h.

◆ m_l3v_mumu_L1_CDCTRG

TH1F* m_l3v_mumu_L1_CDCTRG {nullptr}
private

svd time histogram for mu mu events wrt the CDC trigger time

Definition at line 97 of file SVDDQMHitTimeModule.h.

◆ m_l3v_mumu_L1_ECLTRG

TH1F* m_l3v_mumu_L1_ECLTRG {nullptr}
private

svd time histogram for mu mu events wrt the ECL trigger time

Definition at line 90 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_bhabha_L1_CDCTRG

TH1F* m_l3vEvtT0_bhabha_L1_CDCTRG {nullptr}
private

svd time histogram for bhabha events wrt the CDC trigger time

Definition at line 94 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_bhabha_L1_ECLTRG

TH1F* m_l3vEvtT0_bhabha_L1_ECLTRG {nullptr}
private

svd time histogram for bhabha events wrt the ECL trigger time

Definition at line 87 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_hadron_L1_CDCTRG

TH1F* m_l3vEvtT0_hadron_L1_CDCTRG {nullptr}
private

svd time histogram for hadronic events wrt the CDC trigger time

Definition at line 96 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_hadron_L1_ECLTRG

TH1F* m_l3vEvtT0_hadron_L1_ECLTRG {nullptr}
private

svd time histogram for hadronic events wrt the ECL trigger time

Definition at line 89 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_mumu_L1_CDCTRG

TH1F* m_l3vEvtT0_mumu_L1_CDCTRG {nullptr}
private

svd time histogram for mu mu events wrt the CDC trigger time

Definition at line 98 of file SVDDQMHitTimeModule.h.

◆ m_l3vEvtT0_mumu_L1_ECLTRG

TH1F* m_l3vEvtT0_mumu_L1_ECLTRG {nullptr}
private

svd time histogram for mu mu events wrt the ECL trigger time

Definition at line 91 of file SVDDQMHitTimeModule.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_objTrgSummary

StoreObjPtr<TRGSummary> m_objTrgSummary
private

Trigger Summary data object.

Definition at line 73 of file SVDDQMHitTimeModule.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_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_storeSVDClustersName

std::string m_storeSVDClustersName
private

SVDClusters StoreArray name.

Definition at line 63 of file SVDDQMHitTimeModule.h.

◆ m_storeSVDEventInfoName

std::string m_storeSVDEventInfoName
private

SVDEventInfo StoreObjPtry name.

Definition at line 65 of file SVDDQMHitTimeModule.h.

◆ m_svdEventInfo

StoreObjPtr<SVDEventInfo> m_svdEventInfo
private

SVDEventInfo data object.

Definition at line 83 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample

TH1F* m_SVDEventT03Sample {nullptr}
private

SVD event T0 for 3 sampels.

Definition at line 100 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_bhabha_L1_CDCTRG

TH1F* m_SVDEventT03Sample_bhabha_L1_CDCTRG {nullptr}
private

svd eventT0 histogram for bhabha events wrt the CDC trigger time for 3 samples

Definition at line 106 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_bhabha_L1_ECLTRG

TH1F* m_SVDEventT03Sample_bhabha_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for bhabha events wrt the ECL trigger time for 3 samples

Definition at line 103 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_hadron_L1_CDCTRG

TH1F* m_SVDEventT03Sample_hadron_L1_CDCTRG {nullptr}
private

svd eventT0 histogram for hadronic events wrt the CDC trigger time for 3 samples

Definition at line 107 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_hadron_L1_ECLTRG

TH1F* m_SVDEventT03Sample_hadron_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for hadronic events wrt the ECL trigger time for 3 samples

Definition at line 104 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_mumu_L1_CDCTRG

TH1F* m_SVDEventT03Sample_mumu_L1_CDCTRG {nullptr}
private

svd eventT0 histogram for mu mu events wrt the CDC trigger time for 3 samples

Definition at line 108 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT03Sample_mumu_L1_ECLTRG

TH1F* m_SVDEventT03Sample_mumu_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for mu mu events wrt the ECL trigger time for 3 samples

Definition at line 105 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample

TH1F* m_SVDEventT06Sample {nullptr}
private

SVD event T0 for 6 sampels.

Definition at line 101 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_bhabha_L1_CDCTRG

TH1F* m_SVDEventT06Sample_bhabha_L1_CDCTRG {nullptr}
private

svd eventT0 histogram for bhabha events wrt the CDC trigger time for 6 samples

Definition at line 113 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_bhabha_L1_ECLTRG

TH1F* m_SVDEventT06Sample_bhabha_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for bhabha events wrt the ECL trigger time for 6 samples

Definition at line 110 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_hadron_L1_CDCTRG

TH1F* m_SVDEventT06Sample_hadron_L1_CDCTRG {nullptr}
private

svd EventT0 histogram for hadronic events wrt the CDC trigger time for 6 samples

Definition at line 114 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_hadron_L1_ECLTRG

TH1F* m_SVDEventT06Sample_hadron_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for hadronic events wrt the ECL trigger time for 6 samples

Definition at line 111 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_mumu_L1_CDCTRG

TH1F* m_SVDEventT06Sample_mumu_L1_CDCTRG {nullptr}
private

svd eventT0 histogram for mu mu events wrt the CDC trigger time for 6 samples

Definition at line 115 of file SVDDQMHitTimeModule.h.

◆ m_SVDEventT06Sample_mumu_L1_ECLTRG

TH1F* m_SVDEventT06Sample_mumu_L1_ECLTRG {nullptr}
private

svd eventT0 histogram for mu mu events wrt the ECL trigger time for 6 samples

Definition at line 112 of file SVDDQMHitTimeModule.h.

◆ m_TrgResult

StoreObjPtr<SoftwareTriggerResult> m_TrgResult
private

Trigger selection data object.

Definition at line 81 of file SVDDQMHitTimeModule.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.


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