Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
StatisticsTimingHLTDQMModule Class Referencefinal

Module for Event Time Statistics DQM plots. More...

#include <StatisticsTimingHLTDQMModule.h>

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

 StatisticsTimingHLTDQMModule ()
 Constructor for module parameters.
 
void initialize () override
 Define the histograms.
 
void event () override
 Full the histograms.
 
void defineHisto () override
 Histogram definition.
 
void beginRun () override
 Reset histogram entries.
 
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.
 
LogConfig & getLogConfig ()
 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 ModuleCondition * getCondition () 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< Path > getConditionPath () 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 ModuleParamList & getParamList () 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< PathElement > clone () 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< ModulePtr > getModules () 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

TH1F * m_meanTimeHistogram
 Mean time of certain modules.
 
TH1F * m_meanMemoryHistogram
 Mean memory of certain modules.
 
std::map< std::string, TH1F * > m_moduleTimeHistograms
 Time distribution of certain modules.
 
std::map< std::string, TH1F * > m_moduleMemoryHistograms
 Memory distribution of certain modules.
 
TH1F * m_fullTimeHistogram
 Budget time distribution of all events.
 
TH1F * m_processingTimeHistogram
 Processing time distribution of all events.
 
TH1F * m_fullMemoryHistogram
 Total memory usage distribution of all events.
 
TH1F * m_fullTimeMeanPerUnitHistogram
 Mean budget time of events per unit.
 
TH1F * m_processingTimeMeanPerUnitHistogram
 Mean processing time of events per unit.
 
std::map< unsigned int, TH1F * > m_fullTimePerUnitHistograms
 Budget time distribution of events per unit.
 
std::map< unsigned int, TH1F * > m_processingTimePerUnitHistograms
 Processing time distribution of events per unit.
 
std::map< unsigned int, TH1F * > m_fullMemoryPerUnitHistograms
 Total memory distribution of events per unit.
 
TH1F * m_processesPerUnitHistogram
 Number of processes per unit.
 
TH1F * m_processingTimePassiveVeto
 Processing time distribution of events passing passive injection veto.
 
TH1F * m_processingTimeNotPassiveVeto
 Processing time distribution of events not passing passive injection veto.
 
TH2F * m_procTimeVsnSVDShaperDigitsPassiveVeto
 Processing time vs nSVDShaperDigits distribution of events passing passive injection veto.
 
TH2F * m_procTimeVsnSVDShaperDigitsNotPassiveVeto
 Processing time vs nSVDShaperDigits distribution of events not passing passive injection veto.
 
TH2F * m_procTimeVsnCDCHitsPassiveVeto
 Processing time vs nCDCHits distribution of events passing passive injection veto.
 
TH2F * m_procTimeVsnCDCHitsNotPassiveVeto
 Processing time vs nCDCHits distribution of events not passing passive injection veto.
 
TH2F * m_procTimeVsnECLDigitsPassiveVeto
 Processing time vs nECLDigits distribution of events passing passive injection veto.
 
TH2F * m_procTimeVsnECLDigitsNotPassiveVeto
 Processing time vs nECLDigits distribution of events not passing passive injection veto.
 
double m_lastFullTimeSum = 0
 Storage for the last full time sum.
 
std::map< unsigned int, double > m_lastFullTimeSumPerUnit
 Storage for the last full time sum per unit.
 
double m_lastProcessingTimeSum = 0
 Storage for the last processing time sum.
 
std::map< unsigned int, double > m_lastProcessingTimeSumPerUnit
 Storage for the last processing time sum per unit.
 
std::map< std::string, double > m_lastModuleTimeSum
 Storage for the last time sum of certain modules.
 
bool m_param_create_hlt_unit_histograms
 Parameter: Create HLT unit number histograms?
 
std::string m_param_histogramDirectoryName = "timing_statistics"
 Parameter: Directory to put the generated histograms.
 
std::vector< std::string > m_param_overviewModuleList = {"Sum_Wait", "Sum_Initialization", "Sum_Unpackers", "Sum_EventsofDoomBuster", "Sum_Clustering", "Sum_Prefilter_Tracking", "Sum_Posttracking_Reconstruction", "Sum_HLT_Filter_Calculation", "Sum_HLT_DQM_before_filter", "Sum_HLT_Discard", "Sum_Postfilter_Reconstruction", "Sum_HLT_Skim_Calculation", "Sum_ROI_Finder", "Sum_HLT_DQM_filtered", "Sum_ROI_Payload_Assembler", "Sum_HLT_DQM_all_events", "Sum_Close_Event"}
 Parameter: which modules should be shown in the overview list.
 
std::vector< std::string > m_summaryModuleList = {"Sum_Initialization", "Sum_Unpackers", "Sum_EventsofDoomBuster", "Sum_Clustering", "Sum_Prefilter_Tracking", "Sum_Posttracking_Reconstruction", "Sum_HLT_Filter_Calculation", "Sum_HLT_DQM_before_filter", "Sum_HLT_Discard", "Sum_Postfilter_Reconstruction", "Sum_HLT_Skim_Calculation", "Sum_ROI_Finder", "Sum_HLT_DQM_filtered", "Sum_ROI_Payload_Assembler", "Sum_HLT_DQM_all_events", "Sum_Close_Event"}
 Summary modules of the actual processing.
 
int m_hlt_unit = 0
 Store HLT unit number on initialization.
 
const double m_fullTimeMax = 10000
 Maximum for the histograms of fullTime.
 
const double m_fullTimeNBins = 250
 Number of bins for the histograms of fullTime.
 
const double m_processingTimeMax = 10000
 Maximum for the histograms of processingTime.
 
const double m_processingTimeNBins = 250
 Number of bins for the histograms of processingTime.
 
const double m_fullMemoryMax = 4000
 Maximum for the histograms of fullMemory.
 
const double m_fullMemoryNBins = 100
 Number of bins for the histograms of fullMemory.
 
const double m_nSVDShaperDigitsMax = 20000
 Maximum for the histograms of nSVDShaperDigits.
 
const double m_nSVDShaperDigitsNBins = 100
 Number of bins for the histograms of nSVDShaperDigits.
 
const double m_nCDCHitsMax = 10000
 Maximum for the histograms of nCDCHits.
 
const double m_nCDCHitsNBins = 100
 Number of bins for the histograms of nCDCHits.
 
const double m_nECLDigitsMax = 10000
 Maximum for the histograms of nECLDigits.
 
const double m_nECLDigitsNBins = 100
 Number of bins for the histograms of nECLDigits.
 
StoreObjPtr< TRGSummary > m_trgSummary
 TRG Summary.
 
StoreArray< SVDShaperDigit > m_svdShaperDigits
 SVD strips.
 
StoreArray< CDCHit > m_cdcHits
 CDC Hits.
 
StoreArray< ECLDigit > m_eclDigits
 ECL Digits.
 
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< ModuleCondition > m_conditions
 Module condition, only non-null if set.
 

Detailed Description

Module for Event Time Statistics DQM plots.

Definition at line 30 of file StatisticsTimingHLTDQMModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

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,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ 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
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ StatisticsTimingHLTDQMModule()

StatisticsTimingHLTDQMModule ( )

Constructor for module parameters.

Definition at line 29 of file StatisticsTimingHLTDQMModule.cc.

29 : HistoModule()
30{
31 setDescription("Monitor reconstruction runtime on HLT");
32 setPropertyFlags(c_ParallelProcessingCertified);
33
34 addParam("histogramDirectoryName", m_param_histogramDirectoryName,
35 "Runtime DQM histograms on HLT will be put into this directory", m_param_histogramDirectoryName);
36
37 addParam("m_param_overviewModuleList", m_param_overviewModuleList,
38 "Which modules should be shown in the overview mean list", m_param_overviewModuleList);
39
40 addParam("createHLTUnitHistograms", m_param_create_hlt_unit_histograms,
41 "Create HLT unit histograms?",
42 false);
43}
Belle2::HistoModule::HistoModule
HistoModule()
Constructor.
Definition: HistoModule.h:32
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_param_overviewModuleList
std::vector< std::string > m_param_overviewModuleList
Parameter: which modules should be shown in the overview list.
Definition: StatisticsTimingHLTDQMModule.h:133
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_param_create_hlt_unit_histograms
bool m_param_create_hlt_unit_histograms
Parameter: Create HLT unit number histograms?
Definition: StatisticsTimingHLTDQMModule.h:127
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_param_histogramDirectoryName
std::string m_param_histogramDirectoryName
Parameter: Directory to put the generated histograms.
Definition: StatisticsTimingHLTDQMModule.h:130
Belle2::Module::addParam
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

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Reset histogram entries.

Reimplemented from HistoModule.

Definition at line 313 of file StatisticsTimingHLTDQMModule.cc.

314{
315 if (!m_meanTimeHistogram || !m_meanMemoryHistogram || !m_fullTimeHistogram || !m_processingTimeHistogram) {
316 B2FATAL("Histograms were not created. Did you setup a HistoManager?");
317 }
318
319 m_meanTimeHistogram->Reset();
320 m_meanMemoryHistogram->Reset();
321 std::for_each(m_moduleTimeHistograms.begin(), m_moduleTimeHistograms.end(),
322 [](auto & it) { it.second->Reset(); });
323 std::for_each(m_moduleMemoryHistograms.begin(), m_moduleMemoryHistograms.end(),
324 [](auto & it) { it.second->Reset(); });
325 m_fullTimeHistogram->Reset();
326 m_processingTimeHistogram->Reset();
327 m_fullMemoryHistogram->Reset();
328 if (m_param_create_hlt_unit_histograms) {
329 m_fullTimeMeanPerUnitHistogram->Reset();
330 m_processingTimeMeanPerUnitHistogram->Reset();
331 std::for_each(m_fullTimePerUnitHistograms.begin(), m_fullTimePerUnitHistograms.end(),
332 [](auto & it) { it.second->Reset(); });
333 std::for_each(m_processingTimePerUnitHistograms.begin(), m_processingTimePerUnitHistograms.end(),
334 [](auto & it) { it.second->Reset(); });
335 std::for_each(m_fullMemoryPerUnitHistograms.begin(), m_fullMemoryPerUnitHistograms.end(),
336 [](auto & it) { it.second->Reset(); });
337 m_processesPerUnitHistogram->Reset();
338
339 m_processesPerUnitHistogram->Fill(m_hlt_unit);
340 }
341}
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_moduleTimeHistograms
std::map< std::string, TH1F * > m_moduleTimeHistograms
Time distribution of certain modules.
Definition: StatisticsTimingHLTDQMModule.h:55
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullMemoryHistogram
TH1F * m_fullMemoryHistogram
Total memory usage distribution of all events.
Definition: StatisticsTimingHLTDQMModule.h:67
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_hlt_unit
int m_hlt_unit
Store HLT unit number on initialization.
Definition: StatisticsTimingHLTDQMModule.h:139
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimePerUnitHistograms
std::map< unsigned int, TH1F * > m_processingTimePerUnitHistograms
Processing time distribution of events per unit.
Definition: StatisticsTimingHLTDQMModule.h:79
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullTimeMeanPerUnitHistogram
TH1F * m_fullTimeMeanPerUnitHistogram
Mean budget time of events per unit.
Definition: StatisticsTimingHLTDQMModule.h:70
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimeHistogram
TH1F * m_processingTimeHistogram
Processing time distribution of all events.
Definition: StatisticsTimingHLTDQMModule.h:64
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimeMeanPerUnitHistogram
TH1F * m_processingTimeMeanPerUnitHistogram
Mean processing time of events per unit.
Definition: StatisticsTimingHLTDQMModule.h:73
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullTimePerUnitHistograms
std::map< unsigned int, TH1F * > m_fullTimePerUnitHistograms
Budget time distribution of events per unit.
Definition: StatisticsTimingHLTDQMModule.h:76
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_moduleMemoryHistograms
std::map< std::string, TH1F * > m_moduleMemoryHistograms
Memory distribution of certain modules.
Definition: StatisticsTimingHLTDQMModule.h:58
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullTimeHistogram
TH1F * m_fullTimeHistogram
Budget time distribution of all events.
Definition: StatisticsTimingHLTDQMModule.h:61
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullMemoryPerUnitHistograms
std::map< unsigned int, TH1F * > m_fullMemoryPerUnitHistograms
Total memory distribution of events per unit.
Definition: StatisticsTimingHLTDQMModule.h:82

◆ 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{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
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}
Belle2::ModuleManager::registerModule
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.
Definition: ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition: ModuleManager.cc:24
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
Belle2::ModulePtr
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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::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(); }
Belle2::Module::terminate
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ defineHisto()

void defineHisto ( )
overridevirtual

Histogram definition.

Reimplemented from HistoModule.

Definition at line 45 of file StatisticsTimingHLTDQMModule.cc.

46{
47 // Create a separate histogram directory and cd into it.
48 TDirectory* oldDirectory = nullptr;
49
50 if (!m_param_histogramDirectoryName.empty()) {
51 oldDirectory = gDirectory;
52 TDirectory* histDir = oldDirectory->mkdir(m_param_histogramDirectoryName.c_str());
53 histDir->cd();
54 }
55
56 m_meanTimeHistogram = new TH1F("meanTimeHistogram", "Mean Processing Time [ms]", m_param_overviewModuleList.size(), 0,
57 m_param_overviewModuleList.size());
58 m_meanTimeHistogram->SetStats(false);
59 m_meanMemoryHistogram = new TH1F("meanMemoryHistogram", "Mean Memory Change [MB]", m_param_overviewModuleList.size(), 0,
60 m_param_overviewModuleList.size());
61 m_meanMemoryHistogram->SetStats(false);
62 m_fullTimeHistogram = new TH1F("fullTimeHistogram", "Budget Time [ms]", m_fullTimeNBins, 0, m_fullTimeMax);
63 m_fullTimeHistogram->StatOverflows(true);
64 m_processingTimeHistogram = new TH1F("processingTimeHistogram", "Processing Time [ms]", m_processingTimeNBins, 0,
65 m_processingTimeMax);
66 m_processingTimeHistogram->StatOverflows(true);
67 m_fullMemoryHistogram = new TH1F("fullMemoryHistogram", "Total memory used [MB]", m_fullMemoryNBins, 0,
68 m_fullMemoryMax);
69 m_fullMemoryHistogram->StatOverflows(true);
70
71 for (unsigned int index = 0; index < m_param_overviewModuleList.size(); index++) {
72 const std::string& moduleName = m_param_overviewModuleList[index];
73 m_meanTimeHistogram->GetXaxis()->SetBinLabel(index + 1, moduleName.c_str());
74 m_meanMemoryHistogram->GetXaxis()->SetBinLabel(index + 1, moduleName.c_str());
75 m_moduleTimeHistograms.emplace(moduleName, new TH1F((moduleName + "_time").c_str(),
76 ("Time spent in: " + moduleName + " [ms]").c_str(), m_processingTimeNBins, 0, m_processingTimeMax));
77 m_moduleTimeHistograms[moduleName]->StatOverflows(true);
78 m_lastModuleTimeSum.emplace(moduleName, 0);
79 m_moduleMemoryHistograms.emplace(moduleName, new TH1F((moduleName + "_memory").c_str(),
80 ("Memory used in: " + moduleName + " [MB]").c_str(), m_fullMemoryNBins, 0, m_fullMemoryMax));
81 m_moduleMemoryHistograms[moduleName]->StatOverflows(true);
82 }
83
84 if (m_param_create_hlt_unit_histograms) {
85 m_fullTimeMeanPerUnitHistogram = new TH1F("fullTimeMeanPerUnitHistogram", "Mean Budget Time Per Unit [ms]",
86 HLTUnits::max_hlt_units + 1, 0,
87 HLTUnits::max_hlt_units + 1);
88 m_fullTimeMeanPerUnitHistogram->SetStats(false);
89 m_fullTimeMeanPerUnitHistogram->SetXTitle("HLT unit number");
90 m_processingTimeMeanPerUnitHistogram = new TH1F("processingTimeMeanPerUnitHistogram", "Mean Processing Time Per Unit [ms]",
91 HLTUnits::max_hlt_units + 1, 0,
92 HLTUnits::max_hlt_units + 1);
93 m_processingTimeMeanPerUnitHistogram->SetStats(false);
94 m_processingTimeMeanPerUnitHistogram->SetXTitle("HLT unit number");
95
96 for (unsigned int index = 1; index <= HLTUnits::max_hlt_units; index++) {
97 m_fullTimePerUnitHistograms.emplace(index, new TH1F(("fullTimePerUnitHistogram_HLT" + std::to_string(index)).c_str(),
98 ("Budget Time Per Unit: HLT" + std::to_string(index) + " [ms]").c_str(), m_fullTimeNBins, 0, m_fullTimeMax));
99 m_fullTimePerUnitHistograms[index]->StatOverflows(true);
100 m_lastFullTimeSumPerUnit.emplace(index, 0);
101 m_processingTimePerUnitHistograms.emplace(index, new TH1F(("processingTimePerUnitHistogram_HLT" + std::to_string(index)).c_str(),
102 ("Processing Time Per Unit: HLT" + std::to_string(index) + " [ms]").c_str(), m_processingTimeNBins, 0, m_processingTimeMax));
103 m_processingTimePerUnitHistograms[index]->StatOverflows(true);
104 m_lastProcessingTimeSumPerUnit.emplace(index, 0);
105 m_fullMemoryPerUnitHistograms.emplace(index, new TH1F(("fullMemoryPerUnitHistogram_HLT" + std::to_string(index)).c_str(),
106 ("Total Memory Used Per Unit: HLT" + std::to_string(index) + " [MB]").c_str(), m_fullMemoryNBins, 0, m_fullMemoryMax));
107 m_fullMemoryPerUnitHistograms[index]->StatOverflows(true);
108 }
109
110 m_processesPerUnitHistogram = new TH1F("processesPerUnitHistogram", "Number of Processes Per Unit",
111 HLTUnits::max_hlt_units + 1, 0,
112 HLTUnits::max_hlt_units + 1);
113 m_processesPerUnitHistogram->SetXTitle("HLT unit number");
114 }
115 m_processingTimePassiveVeto = new TH1F("processingTimePassiveVeto", "Processing Time of events passing passive veto [ms]",
116 m_processingTimeNBins, 0,
117 m_processingTimeMax);
118 m_processingTimePassiveVeto->StatOverflows(true);
119 m_processingTimeNotPassiveVeto = new TH1F("processingTimeNotPassiveVeto", "Processing Time of events not passing passive veto [ms]",
120 m_processingTimeNBins, 0,
121 m_processingTimeMax);
122 m_processingTimeNotPassiveVeto->StatOverflows(true);
123
124 m_procTimeVsnSVDShaperDigitsPassiveVeto = new TH2F("procTimeVsnSVDShaperDigitsPassiveVeto",
125 "Processing time [ms] vs nSVDShaperDigits of events passing passive veto",
126 m_nSVDShaperDigitsNBins, 0, m_nSVDShaperDigitsMax,
127 m_processingTimeNBins, 0, m_processingTimeMax);
128 m_procTimeVsnSVDShaperDigitsPassiveVeto->StatOverflows(true);
129 m_procTimeVsnSVDShaperDigitsPassiveVeto->SetXTitle("nSVDShaperDigits");
130 m_procTimeVsnSVDShaperDigitsPassiveVeto->SetYTitle("Processing time [ms]");
131 m_procTimeVsnSVDShaperDigitsNotPassiveVeto = new TH2F("procTimeVsnSVDShaperDigitsNotPassiveVeto",
132 "Processing time [ms] vs nSVDShaperDigits of events not passing passive veto",
133 m_nSVDShaperDigitsNBins, 0, m_nSVDShaperDigitsMax,
134 m_processingTimeNBins, 0, m_processingTimeMax);
135 m_procTimeVsnSVDShaperDigitsNotPassiveVeto->StatOverflows(true);
136 m_procTimeVsnSVDShaperDigitsNotPassiveVeto->SetXTitle("nSVDShaperDigits");
137 m_procTimeVsnSVDShaperDigitsNotPassiveVeto->SetYTitle("Processing time [ms]");
138 m_procTimeVsnCDCHitsPassiveVeto = new TH2F("procTimeVsnCDCHitsPassiveVeto",
139 "Processing time [ms] vs nCDCHits of events passing passive veto",
140 m_nCDCHitsNBins, 0, m_nCDCHitsMax,
141 m_processingTimeNBins, 0, m_processingTimeMax);
142 m_procTimeVsnCDCHitsPassiveVeto->StatOverflows(true);
143 m_procTimeVsnCDCHitsPassiveVeto->SetXTitle("nCDCHits");
144 m_procTimeVsnCDCHitsPassiveVeto->SetYTitle("Processing time [ms]");
145 m_procTimeVsnCDCHitsNotPassiveVeto = new TH2F("procTimeVsnCDCHitsNotPassiveVeto",
146 "Processing time [ms] vs nCDCHits of events not passing passive veto",
147 m_nCDCHitsNBins, 0, m_nCDCHitsMax,
148 m_processingTimeNBins, 0, m_processingTimeMax);
149 m_procTimeVsnCDCHitsNotPassiveVeto->StatOverflows(true);
150 m_procTimeVsnCDCHitsNotPassiveVeto->SetXTitle("nCDCHits");
151 m_procTimeVsnCDCHitsNotPassiveVeto->SetYTitle("Processing time [ms]");
152 m_procTimeVsnECLDigitsPassiveVeto = new TH2F("procTimeVsnECLDigitsPassiveVeto",
153 "Processing time [ms] vs nECLDigits of events passing passive veto",
154 m_nECLDigitsNBins, 0, m_nECLDigitsMax,
155 m_processingTimeNBins, 0, m_processingTimeMax);
156 m_procTimeVsnECLDigitsPassiveVeto->StatOverflows(true);
157 m_procTimeVsnECLDigitsPassiveVeto->SetXTitle("nECLDigits");
158 m_procTimeVsnECLDigitsPassiveVeto->SetYTitle("Processing time [ms]");
159 m_procTimeVsnECLDigitsNotPassiveVeto = new TH2F("procTimeVsnECLDigitsNotPassiveVeto",
160 "Processing time [ms] vs nECLDigits of events not passing passive veto",
161 m_nECLDigitsNBins, 0, m_nECLDigitsMax,
162 m_processingTimeNBins, 0, m_processingTimeMax);
163 m_procTimeVsnECLDigitsNotPassiveVeto->StatOverflows(true);
164 m_procTimeVsnECLDigitsNotPassiveVeto->SetXTitle("nECLDigits");
165 m_procTimeVsnECLDigitsNotPassiveVeto->SetYTitle("Processing time [ms]");
166
167 if (oldDirectory) {
168 oldDirectory->cd();
169 }
170}
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nSVDShaperDigitsNBins
const double m_nSVDShaperDigitsNBins
Number of bins for the histograms of nSVDShaperDigits.
Definition: StatisticsTimingHLTDQMModule.h:163
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimeNBins
const double m_processingTimeNBins
Number of bins for the histograms of processingTime.
Definition: StatisticsTimingHLTDQMModule.h:151
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_lastProcessingTimeSumPerUnit
std::map< unsigned int, double > m_lastProcessingTimeSumPerUnit
Storage for the last processing time sum per unit.
Definition: StatisticsTimingHLTDQMModule.h:121
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimeMax
const double m_processingTimeMax
Maximum for the histograms of processingTime.
Definition: StatisticsTimingHLTDQMModule.h:148
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nECLDigitsMax
const double m_nECLDigitsMax
Maximum for the histograms of nECLDigits.
Definition: StatisticsTimingHLTDQMModule.h:172
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnCDCHitsNotPassiveVeto
TH2F * m_procTimeVsnCDCHitsNotPassiveVeto
Processing time vs nCDCHits distribution of events not passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:103
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnSVDShaperDigitsPassiveVeto
TH2F * m_procTimeVsnSVDShaperDigitsPassiveVeto
Processing time vs nSVDShaperDigits distribution of events passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:94
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimeNotPassiveVeto
TH1F * m_processingTimeNotPassiveVeto
Processing time distribution of events not passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:91
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnCDCHitsPassiveVeto
TH2F * m_procTimeVsnCDCHitsPassiveVeto
Processing time vs nCDCHits distribution of events passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:100
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullMemoryMax
const double m_fullMemoryMax
Maximum for the histograms of fullMemory.
Definition: StatisticsTimingHLTDQMModule.h:154
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnECLDigitsNotPassiveVeto
TH2F * m_procTimeVsnECLDigitsNotPassiveVeto
Processing time vs nECLDigits distribution of events not passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:109
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullTimeNBins
const double m_fullTimeNBins
Number of bins for the histograms of fullTime.
Definition: StatisticsTimingHLTDQMModule.h:145
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnSVDShaperDigitsNotPassiveVeto
TH2F * m_procTimeVsnSVDShaperDigitsNotPassiveVeto
Processing time vs nSVDShaperDigits distribution of events not passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:97
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_lastModuleTimeSum
std::map< std::string, double > m_lastModuleTimeSum
Storage for the last time sum of certain modules.
Definition: StatisticsTimingHLTDQMModule.h:124
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_lastFullTimeSumPerUnit
std::map< unsigned int, double > m_lastFullTimeSumPerUnit
Storage for the last full time sum per unit.
Definition: StatisticsTimingHLTDQMModule.h:115
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nSVDShaperDigitsMax
const double m_nSVDShaperDigitsMax
Maximum for the histograms of nSVDShaperDigits.
Definition: StatisticsTimingHLTDQMModule.h:160
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nCDCHitsNBins
const double m_nCDCHitsNBins
Number of bins for the histograms of nCDCHits.
Definition: StatisticsTimingHLTDQMModule.h:169
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_processingTimePassiveVeto
TH1F * m_processingTimePassiveVeto
Processing time distribution of events passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:88
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullTimeMax
const double m_fullTimeMax
Maximum for the histograms of fullTime.
Definition: StatisticsTimingHLTDQMModule.h:142
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nCDCHitsMax
const double m_nCDCHitsMax
Maximum for the histograms of nCDCHits.
Definition: StatisticsTimingHLTDQMModule.h:166
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_fullMemoryNBins
const double m_fullMemoryNBins
Number of bins for the histograms of fullMemory.
Definition: StatisticsTimingHLTDQMModule.h:157
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_nECLDigitsNBins
const double m_nECLDigitsNBins
Number of bins for the histograms of nECLDigits.
Definition: StatisticsTimingHLTDQMModule.h:175
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_procTimeVsnECLDigitsPassiveVeto
TH2F * m_procTimeVsnECLDigitsPassiveVeto
Processing time vs nECLDigits distribution of events passing passive injection veto.
Definition: StatisticsTimingHLTDQMModule.h:106

◆ endRun()

virtual void endRun ( void  )
inlineoverridevirtualinherited

Function to process end_run record.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, AlignDQMModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, TPCStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMEXTENDEDModule, KLMDQMModule, KLMDQM2Module, CDCDedxDQMModule, CDCDedxValidationModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPTBCComparatorModule, TOPWaveformQualityPlotterModule, SVDROIDQMModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, SVDUnpackerDQMModule, and vxdDigitMaskingModule.

Definition at line 44 of file HistoModule.h.

44{};

◆ 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}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Full the histograms.

Reimplemented from HistoModule.

Definition at line 207 of file StatisticsTimingHLTDQMModule.cc.

208{
209 StoreObjPtr<ProcessStatistics> stats("", DataStore::c_Persistent);
210
211 if (not stats.isValid()) {
212 return;
213 }
214
215 const std::vector<ModuleStatistics>& moduleStatisticsList = stats->getAll();
216
217 std::vector<double> meanTimes(m_param_overviewModuleList.size(), 0);
218 std::vector<double> meanMemories(m_param_overviewModuleList.size(), 0);
219
220 for (const ModuleStatistics& moduleStatistics : moduleStatisticsList) {
221 const std::string& statisticsName = moduleStatistics.getName();
222 const auto m_param_overviewModuleListIterator = std::find(m_param_overviewModuleList.begin(), m_param_overviewModuleList.end(),
223 statisticsName);
224 if (m_param_overviewModuleListIterator == m_param_overviewModuleList.end()) {
225 continue;
226 }
227
228 const double statisticsTime = moduleStatistics.getTimeMean(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
229 const double statisticsMemory = moduleStatistics.getMemoryMean(ModuleStatistics::EStatisticCounters::c_Total) / 1024;
230 const double statisticsTime_sum = moduleStatistics.getTimeSum(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
231 const double statisticsMemory_sum = moduleStatistics.getMemorySum(ModuleStatistics::EStatisticCounters::c_Total) / 1024;
232
233 const int m_param_overviewModuleListIndex = std::distance(m_param_overviewModuleList.begin(), m_param_overviewModuleListIterator);
234 meanTimes[m_param_overviewModuleListIndex] += statisticsTime;
235 meanMemories[m_param_overviewModuleListIndex] += statisticsMemory;
236
237 m_moduleTimeHistograms[statisticsName]->Fill(statisticsTime_sum - m_lastModuleTimeSum[statisticsName]);
238 m_lastModuleTimeSum[statisticsName] = statisticsTime_sum;
239 m_moduleMemoryHistograms[statisticsName]->Fill(statisticsMemory_sum);
240 }
241
242 for (unsigned int index = 0; index < m_param_overviewModuleList.size(); index++) {
243 m_meanTimeHistogram->SetBinContent(index + 1, meanTimes[index]);
244 m_meanMemoryHistogram->SetBinContent(index + 1, meanMemories[index]);
245 }
246
247 double processingTimeSum = 0.0;
248 double processingTimeMean = 0.0;
249
250 for (const ModuleStatistics& moduleStatistics : moduleStatisticsList) {
251 const std::string& statisticsName = moduleStatistics.getName();
252 const auto m_summaryModuleListIterator = std::find(m_summaryModuleList.begin(), m_summaryModuleList.end(),
253 statisticsName);
254 if (m_summaryModuleListIterator == m_summaryModuleList.end()) {
255 continue;
256 }
257 processingTimeSum += moduleStatistics.getTimeSum(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
258 processingTimeMean += moduleStatistics.getTimeMean(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
259 }
260 m_processingTimeHistogram->Fill(processingTimeSum - m_lastProcessingTimeSum);
261
262 const ModuleStatistics& fullStatistics = stats->getGlobal();
263 const double fullTimeSum = fullStatistics.getTimeSum(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
264 m_fullTimeHistogram->Fill(fullTimeSum - m_lastFullTimeSum);
265 m_lastFullTimeSum = fullTimeSum;
266 const double fullMemorySum = fullStatistics.getMemorySum(ModuleStatistics::EStatisticCounters::c_Total) / 1024;
267 m_fullMemoryHistogram->Fill(fullMemorySum);
268
269 if (m_param_create_hlt_unit_histograms) {
270 if (0 < m_hlt_unit) {
271 m_processingTimeMeanPerUnitHistogram->SetBinContent(m_hlt_unit + 1, processingTimeMean);
272
273 m_processingTimePerUnitHistograms[m_hlt_unit]->Fill(processingTimeSum - m_lastProcessingTimeSumPerUnit[m_hlt_unit]);
274 m_lastProcessingTimeSumPerUnit[m_hlt_unit] = processingTimeSum;
275
276 const double fullTimeMean = fullStatistics.getTimeMean(ModuleStatistics::EStatisticCounters::c_Event) / Unit::ms;
277 m_fullTimeMeanPerUnitHistogram->SetBinContent(m_hlt_unit + 1, fullTimeMean);
278
279 m_fullTimePerUnitHistograms[m_hlt_unit]->Fill(fullTimeSum - m_lastFullTimeSumPerUnit[m_hlt_unit]);
280 m_lastFullTimeSumPerUnit[m_hlt_unit] = fullTimeSum;
281
282 m_fullMemoryPerUnitHistograms[m_hlt_unit]->Fill(fullMemorySum);
283 }
284 }
285
286 const uint32_t nCDCHits = m_cdcHits.isOptional() ? m_cdcHits.getEntries() : 0;
287 const uint32_t nSVDShaperDigits = m_svdShaperDigits.isOptional() ? m_svdShaperDigits.getEntries() : 0;
288 const uint32_t nECLDigits = m_eclDigits.isOptional() ? m_eclDigits.getEntries() : 0;
289 if (!m_trgSummary.isValid()) {
290 return;
291 }
292 try {
293 if (m_trgSummary->testInput("passive_veto") == 0) { // These events would stay even with just passive veto
294 m_processingTimePassiveVeto->Fill(processingTimeSum - m_lastProcessingTimeSum);
295
296 m_procTimeVsnSVDShaperDigitsPassiveVeto->Fill(nSVDShaperDigits, processingTimeSum - m_lastProcessingTimeSum);
297 m_procTimeVsnCDCHitsPassiveVeto->Fill(nCDCHits, processingTimeSum - m_lastProcessingTimeSum);
298 m_procTimeVsnECLDigitsPassiveVeto->Fill(nECLDigits, processingTimeSum - m_lastProcessingTimeSum);
299 } else {
300 m_processingTimeNotPassiveVeto->Fill(processingTimeSum - m_lastProcessingTimeSum);
301
302 m_procTimeVsnSVDShaperDigitsNotPassiveVeto->Fill(nSVDShaperDigits, processingTimeSum - m_lastProcessingTimeSum);
303 m_procTimeVsnCDCHitsNotPassiveVeto->Fill(nCDCHits, processingTimeSum - m_lastProcessingTimeSum);
304 m_procTimeVsnECLDigitsNotPassiveVeto->Fill(nECLDigits, processingTimeSum - m_lastProcessingTimeSum);
305 }
306 } catch (const std::exception&) {
307 return;
308 }
309
310 m_lastProcessingTimeSum = processingTimeSum;
311}
Belle2::DataStore::c_Persistent
@ c_Persistent
Object is available during entire execution time.
Definition: DataStore.h:60
Belle2::ModuleStatistics
Keep track of time and memory consumption during processing.
Definition: ModuleStatistics.h:27
Belle2::ModuleStatistics::c_Event
@ c_Event
Counting time/calls in event()
Definition: ModuleStatistics.h:36
Belle2::ModuleStatistics::c_Total
@ c_Total
Sum of the above.
Definition: ModuleStatistics.h:42
Belle2::ModuleStatistics::getMemorySum
value_type getMemorySum(EStatisticCounters type=c_Total) const
return the total used memory for a given counter
Definition: ModuleStatistics.h:103
Belle2::ModuleStatistics::getTimeSum
value_type getTimeSum(EStatisticCounters type=c_Total) const
return the sum of all execution times for a given counter
Definition: ModuleStatistics.h:88
Belle2::ModuleStatistics::getTimeMean
value_type getTimeMean(EStatisticCounters type=c_Total) const
return the mean execution time for a given counter
Definition: ModuleStatistics.h:93
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_lastProcessingTimeSum
double m_lastProcessingTimeSum
Storage for the last processing time sum.
Definition: StatisticsTimingHLTDQMModule.h:118
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_lastFullTimeSum
double m_lastFullTimeSum
Storage for the last full time sum.
Definition: StatisticsTimingHLTDQMModule.h:112
Belle2::SoftwareTrigger::StatisticsTimingHLTDQMModule::m_summaryModuleList
std::vector< std::string > m_summaryModuleList
Summary modules of the actual processing.
Definition: StatisticsTimingHLTDQMModule.h:136
Belle2::StoreObjPtr
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
Belle2::Unit::ms
static const double ms
[millisecond]
Definition: Unit.h:96

◆ 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")
350 .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
351 .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
352 .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
353 .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
354 .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
355 .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
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>()),
491 &Module::setLogConfig)
Belle2::ModuleCondition::c_GE
@ c_GE
Greater or equal than: ">=".
Definition: ModuleCondition.h:35
Belle2::ModuleCondition::c_SE
@ c_SE
Smaller or equal than: "<=".
Definition: ModuleCondition.h:36
Belle2::ModuleCondition::c_GT
@ c_GT
Greater than: ">"
Definition: ModuleCondition.h:33
Belle2::ModuleCondition::c_NE
@ c_NE
Not equal: "!=".
Definition: ModuleCondition.h:38
Belle2::ModuleCondition::c_EQ
@ c_EQ
Equal: "=" or "=="
Definition: ModuleCondition.h:37
Belle2::ModuleCondition::c_ST
@ c_ST
Smaller than: "<"
Definition: ModuleCondition.h:34
Belle2::Module
Base class for Modules.
Definition: Module.h:72
Belle2::Module::getLogConfig
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
Belle2::Module::if_value
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
Belle2::Module::if_true
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
Belle2::Module::setReturnValue
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
Belle2::Module::setLogConfig
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
Belle2::Module::getDescription
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
Belle2::Module::if_false
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
Belle2::Module::hasCondition
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
Belle2::Module::getPackage
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
Belle2::Module::setName
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
Belle2::Module::hasProperties
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
Belle2::Module::getPathString
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}
Belle2::PathPtr
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;}
Belle2::Module::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;}
Belle2::Module::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{
281 return m_moduleParamList.getParamInfoListPython();
282}
Belle2::ModuleParamList::getParamInfoListPython
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
Definition: ModuleParamList.cc:64
Belle2::Module::m_moduleParamList
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}
Belle2::Module::m_type
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{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
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}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition: ModuleParamList.cc:54

◆ 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

Define the histograms.

Reimplemented from HistoModule.

Definition at line 173 of file StatisticsTimingHLTDQMModule.cc.

174{
175 m_trgSummary.isOptional();
176 m_svdShaperDigits.isOptional();
177 m_cdcHits.isOptional();
178 m_eclDigits.isOptional();
179
180 // Register histograms (calls back defineHisto)
181 REG_HISTOGRAM
182
183 if (m_param_create_hlt_unit_histograms) {
184 // Read the HLT unit's hostname straight from the HLT worker
185 FILE* pipe = popen("hostname -d", "r");
186 if (pipe) {
187 char buffer[128];
188 std::string host = "";
189
190 while (fgets(buffer, sizeof(buffer), pipe) != nullptr) {
191 host += buffer;
192 }
193
194 pclose(pipe);
195
196 if (host.length() == 5) {
197 m_hlt_unit = atoi(host.substr(3, 2).c_str());
198 } else {
199 B2WARNING("HLT unit number not found");
200 }
201 } else {
202 B2WARNING("HLT unit number not found");
203 }
204 }
205}

◆ 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}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
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}
Belle2::LogConfig::setDebugLevel
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}
Belle2::LogConfig::setLogInfo
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}
Belle2::LogConfig::setLogLevel
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 {
239 m_moduleParamList.setParamPython(name, pyObj);
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}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
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
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

◆ 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}
Belle2::Module::setParamPython
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()

virtual void terminate ( void  )
inlineoverridevirtualinherited

Function to terminate module.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMEXTENDEDModule, KLMDQMModule, KLMDQM2Module, CDCDedxDQMModule, CDCDedxValidationModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPPDFCheckerModule, TOPTBCComparatorModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, and ROIDQMModule.

Definition at line 46 of file HistoModule.h.

46{};

Member Data Documentation

◆ m_cdcHits

StoreArray<CDCHit> m_cdcHits
private

CDC Hits.

Definition at line 184 of file StatisticsTimingHLTDQMModule.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_eclDigits

StoreArray<ECLDigit> m_eclDigits
private

ECL Digits.

Definition at line 187 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullMemoryHistogram

TH1F* m_fullMemoryHistogram
private

Total memory usage distribution of all events.

Definition at line 67 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullMemoryMax

const double m_fullMemoryMax = 4000
private

Maximum for the histograms of fullMemory.

Definition at line 154 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullMemoryNBins

const double m_fullMemoryNBins = 100
private

Number of bins for the histograms of fullMemory.

Definition at line 157 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullMemoryPerUnitHistograms

std::map<unsigned int, TH1F*> m_fullMemoryPerUnitHistograms
private

Total memory distribution of events per unit.

Definition at line 82 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullTimeHistogram

TH1F* m_fullTimeHistogram
private

Budget time distribution of all events.

Definition at line 61 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullTimeMax

const double m_fullTimeMax = 10000
private

Maximum for the histograms of fullTime.

Definition at line 142 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullTimeMeanPerUnitHistogram

TH1F* m_fullTimeMeanPerUnitHistogram
private

Mean budget time of events per unit.

Definition at line 70 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullTimeNBins

const double m_fullTimeNBins = 250
private

Number of bins for the histograms of fullTime.

Definition at line 145 of file StatisticsTimingHLTDQMModule.h.

◆ m_fullTimePerUnitHistograms

std::map<unsigned int, TH1F*> m_fullTimePerUnitHistograms
private

Budget time distribution of events per unit.

Definition at line 76 of file StatisticsTimingHLTDQMModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hlt_unit

int m_hlt_unit = 0
private

Store HLT unit number on initialization.

Definition at line 139 of file StatisticsTimingHLTDQMModule.h.

◆ m_lastFullTimeSum

double m_lastFullTimeSum = 0
private

Storage for the last full time sum.

Definition at line 112 of file StatisticsTimingHLTDQMModule.h.

◆ m_lastFullTimeSumPerUnit

std::map<unsigned int, double> m_lastFullTimeSumPerUnit
private

Storage for the last full time sum per unit.

Definition at line 115 of file StatisticsTimingHLTDQMModule.h.

◆ m_lastModuleTimeSum

std::map<std::string, double> m_lastModuleTimeSum
private

Storage for the last time sum of certain modules.

Definition at line 124 of file StatisticsTimingHLTDQMModule.h.

◆ m_lastProcessingTimeSum

double m_lastProcessingTimeSum = 0
private

Storage for the last processing time sum.

Definition at line 118 of file StatisticsTimingHLTDQMModule.h.

◆ m_lastProcessingTimeSumPerUnit

std::map<unsigned int, double> m_lastProcessingTimeSumPerUnit
private

Storage for the last processing time sum per unit.

Definition at line 121 of file StatisticsTimingHLTDQMModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_meanMemoryHistogram

TH1F* m_meanMemoryHistogram
private

Mean memory of certain modules.

Definition at line 52 of file StatisticsTimingHLTDQMModule.h.

◆ m_meanTimeHistogram

TH1F* m_meanTimeHistogram
private

Mean time of certain modules.

Definition at line 49 of file StatisticsTimingHLTDQMModule.h.

◆ m_moduleMemoryHistograms

std::map<std::string, TH1F*> m_moduleMemoryHistograms
private

Memory distribution of certain modules.

Definition at line 58 of file StatisticsTimingHLTDQMModule.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_moduleTimeHistograms

std::map<std::string, TH1F*> m_moduleTimeHistograms
private

Time distribution of certain modules.

Definition at line 55 of file StatisticsTimingHLTDQMModule.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_nCDCHitsMax

const double m_nCDCHitsMax = 10000
private

Maximum for the histograms of nCDCHits.

Definition at line 166 of file StatisticsTimingHLTDQMModule.h.

◆ m_nCDCHitsNBins

const double m_nCDCHitsNBins = 100
private

Number of bins for the histograms of nCDCHits.

Definition at line 169 of file StatisticsTimingHLTDQMModule.h.

◆ m_nECLDigitsMax

const double m_nECLDigitsMax = 10000
private

Maximum for the histograms of nECLDigits.

Definition at line 172 of file StatisticsTimingHLTDQMModule.h.

◆ m_nECLDigitsNBins

const double m_nECLDigitsNBins = 100
private

Number of bins for the histograms of nECLDigits.

Definition at line 175 of file StatisticsTimingHLTDQMModule.h.

◆ m_nSVDShaperDigitsMax

const double m_nSVDShaperDigitsMax = 20000
private

Maximum for the histograms of nSVDShaperDigits.

Definition at line 160 of file StatisticsTimingHLTDQMModule.h.

◆ m_nSVDShaperDigitsNBins

const double m_nSVDShaperDigitsNBins = 100
private

Number of bins for the histograms of nSVDShaperDigits.

Definition at line 163 of file StatisticsTimingHLTDQMModule.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_param_create_hlt_unit_histograms

bool m_param_create_hlt_unit_histograms
private

Parameter: Create HLT unit number histograms?

Definition at line 127 of file StatisticsTimingHLTDQMModule.h.

◆ m_param_histogramDirectoryName

std::string m_param_histogramDirectoryName = "timing_statistics"
private

Parameter: Directory to put the generated histograms.

Definition at line 130 of file StatisticsTimingHLTDQMModule.h.

◆ m_param_overviewModuleList

std::vector<std::string> m_param_overviewModuleList = {"Sum_Wait", "Sum_Initialization", "Sum_Unpackers", "Sum_EventsofDoomBuster", "Sum_Clustering", "Sum_Prefilter_Tracking", "Sum_Posttracking_Reconstruction", "Sum_HLT_Filter_Calculation", "Sum_HLT_DQM_before_filter", "Sum_HLT_Discard", "Sum_Postfilter_Reconstruction", "Sum_HLT_Skim_Calculation", "Sum_ROI_Finder", "Sum_HLT_DQM_filtered", "Sum_ROI_Payload_Assembler", "Sum_HLT_DQM_all_events", "Sum_Close_Event"}
private

Parameter: which modules should be shown in the overview list.

Definition at line 133 of file StatisticsTimingHLTDQMModule.h.

◆ m_processesPerUnitHistogram

TH1F* m_processesPerUnitHistogram
private

Number of processes per unit.

Definition at line 85 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimeHistogram

TH1F* m_processingTimeHistogram
private

Processing time distribution of all events.

Definition at line 64 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimeMax

const double m_processingTimeMax = 10000
private

Maximum for the histograms of processingTime.

Definition at line 148 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimeMeanPerUnitHistogram

TH1F* m_processingTimeMeanPerUnitHistogram
private

Mean processing time of events per unit.

Definition at line 73 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimeNBins

const double m_processingTimeNBins = 250
private

Number of bins for the histograms of processingTime.

Definition at line 151 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimeNotPassiveVeto

TH1F* m_processingTimeNotPassiveVeto
private

Processing time distribution of events not passing passive injection veto.

Definition at line 91 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimePassiveVeto

TH1F* m_processingTimePassiveVeto
private

Processing time distribution of events passing passive injection veto.

Definition at line 88 of file StatisticsTimingHLTDQMModule.h.

◆ m_processingTimePerUnitHistograms

std::map<unsigned int, TH1F*> m_processingTimePerUnitHistograms
private

Processing time distribution of events per unit.

Definition at line 79 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnCDCHitsNotPassiveVeto

TH2F* m_procTimeVsnCDCHitsNotPassiveVeto
private

Processing time vs nCDCHits distribution of events not passing passive injection veto.

Definition at line 103 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnCDCHitsPassiveVeto

TH2F* m_procTimeVsnCDCHitsPassiveVeto
private

Processing time vs nCDCHits distribution of events passing passive injection veto.

Definition at line 100 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnECLDigitsNotPassiveVeto

TH2F* m_procTimeVsnECLDigitsNotPassiveVeto
private

Processing time vs nECLDigits distribution of events not passing passive injection veto.

Definition at line 109 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnECLDigitsPassiveVeto

TH2F* m_procTimeVsnECLDigitsPassiveVeto
private

Processing time vs nECLDigits distribution of events passing passive injection veto.

Definition at line 106 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnSVDShaperDigitsNotPassiveVeto

TH2F* m_procTimeVsnSVDShaperDigitsNotPassiveVeto
private

Processing time vs nSVDShaperDigits distribution of events not passing passive injection veto.

Definition at line 97 of file StatisticsTimingHLTDQMModule.h.

◆ m_procTimeVsnSVDShaperDigitsPassiveVeto

TH2F* m_procTimeVsnSVDShaperDigitsPassiveVeto
private

Processing time vs nSVDShaperDigits distribution of events passing passive injection veto.

Definition at line 94 of file StatisticsTimingHLTDQMModule.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_summaryModuleList

std::vector<std::string> m_summaryModuleList = {"Sum_Initialization", "Sum_Unpackers", "Sum_EventsofDoomBuster", "Sum_Clustering", "Sum_Prefilter_Tracking", "Sum_Posttracking_Reconstruction", "Sum_HLT_Filter_Calculation", "Sum_HLT_DQM_before_filter", "Sum_HLT_Discard", "Sum_Postfilter_Reconstruction", "Sum_HLT_Skim_Calculation", "Sum_ROI_Finder", "Sum_HLT_DQM_filtered", "Sum_ROI_Payload_Assembler", "Sum_HLT_DQM_all_events", "Sum_Close_Event"}
private

Summary modules of the actual processing.

Definition at line 136 of file StatisticsTimingHLTDQMModule.h.

◆ m_svdShaperDigits

StoreArray<SVDShaperDigit> m_svdShaperDigits
private

SVD strips.

Definition at line 181 of file StatisticsTimingHLTDQMModule.h.

◆ m_trgSummary

StoreObjPtr<TRGSummary> m_trgSummary
private

TRG Summary.

Definition at line 178 of file StatisticsTimingHLTDQMModule.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: