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

This module to design collect the event t0 values base on different detectors and physics processes. More...

#include <EventT0DQM.h>

Inheritance diagram for EventT0DQMModule:
Collaboration diagram for EventT0DQMModule:

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

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

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

StoreObjPtr< TRGSummarym_objTrgSummary
 Trigger Summary data object.
 
int m_L1TimingSrc
 L1 timing source from getTimeType() in TRGSummary See ETimingTYpe in mdst/dataobjects/include/TRGSummary.h (but information is obsolete...) (2019/11/11) release-04-00-02, return values from getTimType() are 0=ecltrg, 3=cdctrg, 5=delayed Bhabha, 7=random trigger from gdl, (toptrg is undefined yet)
 
StoreObjPtr< SoftwareTriggerResultm_TrgResult
 Store array for Trigger selection.
 
StoreObjPtr< EventT0m_eventT0
 Store array for event t0.
 
TH1F * m_histEventT0_ECL_bhabha_L1_ECLTRG {nullptr}
 event t0 histogram for ECL and bha bha events wrt the ECL trigger time
 
TH1F * m_histEventT0_CDC_bhabha_L1_ECLTRG {nullptr}
 event t0 histogram for CDC and bha bha events wrt the ECL trigger time
 
TH1F * m_histEventT0_TOP_bhabha_L1_ECLTRG {nullptr}
 event t0 histogram for TOP and bha bha events wrt the ECL trigger time
 
TH1F * m_histEventT0_ECL_hadron_L1_ECLTRG {nullptr}
 event t0 histogram for ECL and hadronic events wrt the ECL trigger time
 
TH1F * m_histEventT0_CDC_hadron_L1_ECLTRG {nullptr}
 event t0 histogram for CDC and hadronic events wrt the ECL trigger time
 
TH1F * m_histEventT0_TOP_hadron_L1_ECLTRG {nullptr}
 event t0 histogram for TOP and hadronic events wrt the ECL trigger time
 
TH1F * m_histEventT0_ECL_mumu_L1_ECLTRG {nullptr}
 event t0 histogram for ECL and mu mu events wrt the ECL trigger time
 
TH1F * m_histEventT0_CDC_mumu_L1_ECLTRG {nullptr}
 event t0 histogram for CDC and mu mu events wrt the ECL trigger time
 
TH1F * m_histEventT0_TOP_mumu_L1_ECLTRG {nullptr}
 event t0 histogram for TOP and mu mu events wrt the ECL trigger time
 
TH1F * m_histEventT0_ECL_bhabha_L1_CDCTRG {nullptr}
 event t0 histogram for ECL and bha bha events wrt the CDC trigger time
 
TH1F * m_histEventT0_CDC_bhabha_L1_CDCTRG {nullptr}
 event t0 histogram for CDC and bha bha events wrt the CDC trigger time
 
TH1F * m_histEventT0_TOP_bhabha_L1_CDCTRG {nullptr}
 event t0 histogram for TOP and bha bha events wrt the CDC trigger time
 
TH1F * m_histEventT0_ECL_hadron_L1_CDCTRG {nullptr}
 event t0 histogram for ECL and hadronic events wrt the CDC trigger time
 
TH1F * m_histEventT0_CDC_hadron_L1_CDCTRG {nullptr}
 event t0 histogram for CDC and hadronic events wrt the CDC trigger time
 
TH1F * m_histEventT0_TOP_hadron_L1_CDCTRG {nullptr}
 event t0 histogram for TOP and hadronic events wrt the CDC trigger time
 
TH1F * m_histEventT0_ECL_mumu_L1_CDCTRG {nullptr}
 event t0 histogram for ECL and mu mu events wrt the CDC trigger time
 
TH1F * m_histEventT0_CDC_mumu_L1_CDCTRG {nullptr}
 event t0 histogram for CDC and mu mu events wrt the CDC trigger time
 
TH1F * m_histEventT0_TOP_mumu_L1_CDCTRG {nullptr}
 event t0 histogram for TOP and mu mu events wrt the CDC trigger time
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

This module to design collect the event t0 values base on different detectors and physics processes.

Definition at line 42 of file EventT0DQM.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 79 of file Module.h.

Member Function Documentation

◆ clone()

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

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 181 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 441 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 422 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 98 of file Module.cc.

◆ event()

void event ( )
overridevirtual

This method is called for each event.

All processing of the event takes place in this method.

Reimplemented from HistoModule.

Definition at line 155 of file EventT0DQM.cc.

156 {
157  if (!m_objTrgSummary.isValid()) {
158  B2WARNING("TRGSummary object not available but required to indicate which detector provided the L1 trigger time");
159  return;
160  } else {
161  m_L1TimingSrc = m_objTrgSummary->getTimType();
162  }
163 
164  bool Is_ECL_L1TriggerSource = false ;
165  bool Is_CDC_L1TriggerSource = false ;
166  if (m_L1TimingSrc == 0) { // for L1 timing source is "ecl trigger"
167  Is_ECL_L1TriggerSource = true ;
168  } else if (m_L1TimingSrc == 3) { // for L1 timing source is "cdc trigger"
169  Is_CDC_L1TriggerSource = true ;
170  }
171  // else if(m_L1TimingSrc==5){ // for L1 timing source is "delayed Bhabha" }
172  B2DEBUG(20, "Is_ECL_L1TriggerSource = " << Is_ECL_L1TriggerSource) ;
173  B2DEBUG(20, "Is_CDC_L1TriggerSource= " << Is_CDC_L1TriggerSource) ;
174 
175 
176  if (!m_TrgResult.isValid()) {
177  B2WARNING("SoftwareTriggerResult object not available but require to select bhabha/mumu/hadron events for this module");
178  return;
179  }
180 
181  const std::map<std::string, int>& fresults = m_TrgResult->getResults();
182  if ((fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end()) ||
183  (fresults.find("software_trigger_cut&skim&accept_mumu_2trk") == fresults.end()) ||
184  (fresults.find("software_trigger_cut&skim&accept_hadron") == fresults.end())) {
185  B2WARNING("EventT0DQMModule: Can't find required bhabha or mumu or hadron trigger identifier");
186  return;
187  }
188 
189 
190 
191  // Skip this event if there is no event t0, to avoid crashing other DQM
192  if (!m_eventT0.isOptional()) {
193  B2WARNING("Missing event t0, EventT0DQM is skipped.");
194  return;
195  }
196 
197  // Determine if there is a valid event t0 to use and then extract the information about it
198  if (!m_eventT0.isValid()) {
199  return ;
200  }
201 
202  // determine if the event was part of the hadron skim or bhabha skim or mumu skim
203  const bool IsEvtAcceptedBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
205  const bool IsEvtAcceptedHadron = (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron") ==
207  const bool IsEvtAcceptedMumu = (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk") ==
209 
210 
211  B2DEBUG(20, "bhabha trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
212  (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha"))) ;
213  B2DEBUG(20, "hadron trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
214  (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron"))) ;
215  B2DEBUG(20, "mu mu trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
216  (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk"))) ;
217  B2DEBUG(20, "bhabha trigger comparison bool = " << IsEvtAcceptedBhabha) ;
218  B2DEBUG(20, "hadron trigger comparison bool = " << IsEvtAcceptedHadron) ;
219  B2DEBUG(20, "mumu trigger comparison bool = " << IsEvtAcceptedMumu) ;
220 
221 
222  // default values of the event t0 given that there may not be a value for every event depending on the detector measuring it.
223  double eventT0_ECL = -1000 ;
224  double eventT0_CDC = -1000 ;
225  double eventT0_TOP = -1000 ;
226 
227  // Set the CDC event t0 value if it exists
228  if (m_eventT0->hasTemporaryEventT0(Const::EDetector::CDC)) {
229  auto evtT0List_CDC = m_eventT0->getTemporaryEventT0s(Const::EDetector::CDC) ;
230 
231  // set the CDC event t0 value for filling into the histogram
232  // The most accurate CDC event t0 value is the last one in the list.
233  eventT0_CDC = evtT0List_CDC.back().eventT0 ;
234  }
235 
236  // Set the ECL event t0 value if it exists
237  if (m_eventT0->hasTemporaryEventT0(Const::EDetector::ECL)) {
238  // Get the list of ECL event t0 values. There are several event t0 values, not just one.
239  auto evtT0List_ECL = m_eventT0->getTemporaryEventT0s(Const::EDetector::ECL) ;
240 
241  // Select the event t0 value from the ECL as the one with the smallest chi squared value (defined as ".quality")
242  double smallest_ECL_t0_minChi2 = evtT0List_ECL[0].quality ;
243  int smallest_ECL_t0_minChi2_idx = 0 ;
244  for (long unsigned int ECLi = 0; ECLi < evtT0List_ECL.size(); ECLi++) {
245  if (evtT0List_ECL[ECLi].quality < smallest_ECL_t0_minChi2) {
246  smallest_ECL_t0_minChi2 = evtT0List_ECL[ECLi].quality ;
247  smallest_ECL_t0_minChi2_idx = ECLi ;
248  }
249  }
250  // set the ECL event t0 value for filling into the histogram
251  // It is the value found to have the small chi square
252  eventT0_ECL = evtT0List_ECL[smallest_ECL_t0_minChi2_idx].eventT0 ;
253  }
254 
255  // Set the TOP event t0 value if it exists
256  if (m_eventT0->hasTemporaryEventT0(Const::EDetector::TOP)) {
257  auto evtT0List_TOP = m_eventT0->getTemporaryEventT0s(Const::EDetector::TOP) ;
258 
259  // set the TOP event t0 value for filling into the histogram
260  // There should only be at most one value in the list per event
261  eventT0_TOP = evtT0List_TOP.back().eventT0 ;
262  }
263 
264 
265 
266 
267  // Fill the plots that used the ECL trigger as the L1 timing source
268  if (Is_ECL_L1TriggerSource) {
269  // Fill the histograms with the event t0 values
270  if (IsEvtAcceptedBhabha) { // fill the bha bha skim event t0s
271  m_histEventT0_ECL_bhabha_L1_ECLTRG->Fill(eventT0_ECL);
272  m_histEventT0_CDC_bhabha_L1_ECLTRG->Fill(eventT0_CDC);
273  m_histEventT0_TOP_bhabha_L1_ECLTRG->Fill(eventT0_TOP);
274  }
275 
276  if (IsEvtAcceptedHadron) { // fill the hadron skim event t0s
277  m_histEventT0_ECL_hadron_L1_ECLTRG->Fill(eventT0_ECL);
278  m_histEventT0_CDC_hadron_L1_ECLTRG->Fill(eventT0_CDC);
279  m_histEventT0_TOP_hadron_L1_ECLTRG->Fill(eventT0_TOP);
280  }
281 
282  if (IsEvtAcceptedMumu) { // fill the mumu skim event t0s
283  m_histEventT0_ECL_mumu_L1_ECLTRG->Fill(eventT0_ECL);
284  m_histEventT0_CDC_mumu_L1_ECLTRG->Fill(eventT0_CDC);
285  m_histEventT0_TOP_mumu_L1_ECLTRG->Fill(eventT0_TOP);
286  }
287  }
288  // Fill the plots that used the CDC trigger as the L1 timing source
289  else if (Is_CDC_L1TriggerSource) {
290  // Fill the histograms with the event t0 values
291  if (IsEvtAcceptedBhabha) { // fill the bha bha skim event t0s
292  m_histEventT0_ECL_bhabha_L1_CDCTRG->Fill(eventT0_ECL);
293  m_histEventT0_CDC_bhabha_L1_CDCTRG->Fill(eventT0_CDC);
294  m_histEventT0_TOP_bhabha_L1_CDCTRG->Fill(eventT0_TOP);
295  }
296 
297  if (IsEvtAcceptedHadron) { // fill the hadron skim event t0s
298  m_histEventT0_ECL_hadron_L1_CDCTRG->Fill(eventT0_ECL);
299  m_histEventT0_CDC_hadron_L1_CDCTRG->Fill(eventT0_CDC);
300  m_histEventT0_TOP_hadron_L1_CDCTRG->Fill(eventT0_TOP);
301  }
302 
303  if (IsEvtAcceptedMumu) { // fill the mumu skim event t0s
304  m_histEventT0_ECL_mumu_L1_CDCTRG->Fill(eventT0_ECL);
305  m_histEventT0_CDC_mumu_L1_CDCTRG->Fill(eventT0_CDC);
306  m_histEventT0_TOP_mumu_L1_CDCTRG->Fill(eventT0_TOP);
307  }
308  }
309 
310  B2DEBUG(20, "eventT0_ECL = " << eventT0_ECL << " ns") ;
311  B2DEBUG(20, "eventT0_CDC = " << eventT0_CDC << " ns") ;
312  B2DEBUG(20, "eventT0_TOP = " << eventT0_TOP << " ns") ;
313 }

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 135 of file Module.cc.

◆ getConditionPath()

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

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


Definition at line 115 of file Module.cc.

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Definition at line 136 of file Module.h.

◆ getName()

const std::string& getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 189 of file Module.h.

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 281 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 162 of file Module.cc.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 87 of file Module.cc.

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 92 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 81 of file Module.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 75 of file Module.cc.

◆ setName()

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

Set the name of the module.

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

Definition at line 216 of file Module.h.

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

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

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

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

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

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 222 of file Module.cc.

◆ setType()

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

Set the module type.

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

Definition at line 50 of file Module.cc.


The documentation for this class was generated from the following files:
Belle2::EventT0DQMModule::m_histEventT0_TOP_bhabha_L1_ECLTRG
TH1F * m_histEventT0_TOP_bhabha_L1_ECLTRG
event t0 histogram for TOP and bha bha events wrt the ECL trigger time
Definition: EventT0DQM.h:90
Belle2::EventT0DQMModule::m_histEventT0_ECL_mumu_L1_ECLTRG
TH1F * m_histEventT0_ECL_mumu_L1_ECLTRG
event t0 histogram for ECL and mu mu events wrt the ECL trigger time
Definition: EventT0DQM.h:94
Belle2::EventT0DQMModule::m_eventT0
StoreObjPtr< EventT0 > m_eventT0
Store array for event t0.
Definition: EventT0DQM.h:86
Belle2::EventT0DQMModule::m_histEventT0_ECL_bhabha_L1_ECLTRG
TH1F * m_histEventT0_ECL_bhabha_L1_ECLTRG
event t0 histogram for ECL and bha bha events wrt the ECL trigger time
Definition: EventT0DQM.h:88
Belle2::EventT0DQMModule::m_L1TimingSrc
int m_L1TimingSrc
L1 timing source from getTimeType() in TRGSummary See ETimingTYpe in mdst/dataobjects/include/TRGSumm...
Definition: EventT0DQM.h:83
Belle2::EventT0DQMModule::m_histEventT0_CDC_bhabha_L1_CDCTRG
TH1F * m_histEventT0_CDC_bhabha_L1_CDCTRG
event t0 histogram for CDC and bha bha events wrt the CDC trigger time
Definition: EventT0DQM.h:99
Belle2::EventT0DQMModule::m_histEventT0_TOP_hadron_L1_CDCTRG
TH1F * m_histEventT0_TOP_hadron_L1_CDCTRG
event t0 histogram for TOP and hadronic events wrt the CDC trigger time
Definition: EventT0DQM.h:103
Belle2::SoftwareTriggerCutResult::c_accept
@ c_accept
Accept this event.
Belle2::EventT0DQMModule::m_histEventT0_CDC_mumu_L1_ECLTRG
TH1F * m_histEventT0_CDC_mumu_L1_ECLTRG
event t0 histogram for CDC and mu mu events wrt the ECL trigger time
Definition: EventT0DQM.h:95
Belle2::EventT0DQMModule::m_histEventT0_ECL_hadron_L1_ECLTRG
TH1F * m_histEventT0_ECL_hadron_L1_ECLTRG
event t0 histogram for ECL and hadronic events wrt the ECL trigger time
Definition: EventT0DQM.h:91
Belle2::EventT0DQMModule::m_histEventT0_CDC_hadron_L1_CDCTRG
TH1F * m_histEventT0_CDC_hadron_L1_CDCTRG
event t0 histogram for CDC and hadronic events wrt the CDC trigger time
Definition: EventT0DQM.h:102
Belle2::EventT0DQMModule::m_histEventT0_ECL_hadron_L1_CDCTRG
TH1F * m_histEventT0_ECL_hadron_L1_CDCTRG
event t0 histogram for ECL and hadronic events wrt the CDC trigger time
Definition: EventT0DQM.h:101
Belle2::EventT0DQMModule::m_histEventT0_CDC_mumu_L1_CDCTRG
TH1F * m_histEventT0_CDC_mumu_L1_CDCTRG
event t0 histogram for CDC and mu mu events wrt the CDC trigger time
Definition: EventT0DQM.h:105
Belle2::EventT0DQMModule::m_histEventT0_TOP_bhabha_L1_CDCTRG
TH1F * m_histEventT0_TOP_bhabha_L1_CDCTRG
event t0 histogram for TOP and bha bha events wrt the CDC trigger time
Definition: EventT0DQM.h:100
Belle2::EventT0DQMModule::m_histEventT0_TOP_hadron_L1_ECLTRG
TH1F * m_histEventT0_TOP_hadron_L1_ECLTRG
event t0 histogram for TOP and hadronic events wrt the ECL trigger time
Definition: EventT0DQM.h:93
Belle2::EventT0DQMModule::m_histEventT0_CDC_bhabha_L1_ECLTRG
TH1F * m_histEventT0_CDC_bhabha_L1_ECLTRG
event t0 histogram for CDC and bha bha events wrt the ECL trigger time
Definition: EventT0DQM.h:89
Belle2::EventT0DQMModule::m_histEventT0_CDC_hadron_L1_ECLTRG
TH1F * m_histEventT0_CDC_hadron_L1_ECLTRG
event t0 histogram for CDC and hadronic events wrt the ECL trigger time
Definition: EventT0DQM.h:92
Belle2::EventT0DQMModule::m_histEventT0_TOP_mumu_L1_CDCTRG
TH1F * m_histEventT0_TOP_mumu_L1_CDCTRG
event t0 histogram for TOP and mu mu events wrt the CDC trigger time
Definition: EventT0DQM.h:106
Belle2::EventT0DQMModule::m_TrgResult
StoreObjPtr< SoftwareTriggerResult > m_TrgResult
Store array for Trigger selection.
Definition: EventT0DQM.h:85
Belle2::EventT0DQMModule::m_objTrgSummary
StoreObjPtr< TRGSummary > m_objTrgSummary
Trigger Summary data object.
Definition: EventT0DQM.h:76
Belle2::EventT0DQMModule::m_histEventT0_ECL_mumu_L1_CDCTRG
TH1F * m_histEventT0_ECL_mumu_L1_CDCTRG
event t0 histogram for ECL and mu mu events wrt the CDC trigger time
Definition: EventT0DQM.h:104
Belle2::EventT0DQMModule::m_histEventT0_TOP_mumu_L1_ECLTRG
TH1F * m_histEventT0_TOP_mumu_L1_ECLTRG
event t0 histogram for TOP and mu mu events wrt the ECL trigger time
Definition: EventT0DQM.h:96
Belle2::EventT0DQMModule::m_histEventT0_ECL_bhabha_L1_CDCTRG
TH1F * m_histEventT0_ECL_bhabha_L1_CDCTRG
event t0 histogram for ECL and bha bha events wrt the CDC trigger time
Definition: EventT0DQM.h:98