Belle II Software light-2406-ragdoll
B2BIIFixMdstModule Class Reference

Declaration of class B2BIIFixMdst. More...

#include <B2BIIFixMdstModule.h>

Inheritance diagram for B2BIIFixMdstModule:
Collaboration diagram for B2BIIFixMdstModule:

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

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

Static Public Member Functions

static double get_Benergy ()
 Get Benergy.
 
static double get_pi0resol (double p, double theta, const char *side, bool mcdata, int exp, int option)
 Get pi0 resolution.
 
static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Public Attributes

int m_scale_momenta
 Apply scale_momenta.
 
float m_scale_momenta_scale_data
 Set parameter scale_data for scale_momenta.
 
float m_scale_momenta_scale_mc
 Set parameter scale_mc for scale_momenta.
 
int m_scale_momenta_mode
 Set parameter mode for scale_momenta.
 
int m_scale_error
 Apply scale_error.
 
int m_smear_trk
 Do extra-smearing for MC tracks.
 
std::string m_scale_error_dataset_name
 Set scale_error_dataset name.
 
int m_add_or_remove_extra_trk_vee2
 (1) to add to Mdst_charged etc, (-1) to remove (move to Mdst_*_extra), (0) do nothing
 
int m_correct_ecl
 Apply correct_ecl.
 
int m_correct_ecl_option
 Apply correct_ecl_option.
 
int m_correct_ecl_version
 Apply correct_ecl_version.
 
int m_correct_ecl_primary_vertex
 Apply correct_ecl_primary_vertex.
 
int m_correct_ecl_5s
 For run indep.
 
int m_make_pi0
 Apply make_pi0 (after correct_ecl)
 
int m_make_pi0_option
 Set make_pi0 option.
 
double m_make_pi0_lower_limit
 Set make_pi0 lower mass limit.
 
double m_make_pi0_upper_limit
 Set make_pi0 upper mass limit.
 
int m_make_pi0_primary_vertex
 Apply make_pi0_primary_vertex (after correct_ecl)
 
int m_benergy
 Apply Benergy.
 
int m_benergy_db
 Apply Benergy from DB or file.
 
int m_benergy_mcdb
 Apply Benergy from DB or default value in MC.
 
int m_good_event
 Select good event only.
 
int m_hadron_a_only
 Select Hadron A event only.
 
int m_hadron_b_only
 Select Hadron B event only.
 
int m_l4passed_only
 Select level4-passed event only.
 
int m_calib_dedx
 Do dedx calibration.
 
int m_shift_tof_mode
 Do tof_correction.
 
int m_table_size
 Check table sizes.
 
int m_limit_mdst_ecl_trk
 Limit of mdst_ecl_trk table size.
 
int m_limit_mdst_klm_cluster_hit
 Limit of mdst_klm_cluster_hit table size.
 
int m_reprocess_version
 Reprocess version (=0:old; =1:new)
 
int m_reprocess_version_specified
 Specify reprocess version.
 
int m_5Srun
 5S,2S,1S run or not
 
int m_check_version_consistency
 Check consistency between environment variable and mdst version.
 

Static Public Attributes

static double s_benergy_value = NOMINAL_ENERGY
 Beam energy.
 

Protected Member Functions

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

Private Member Functions

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

Private Attributes

std::string m_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.
 

Static Private Attributes

static const int m_muid_version = 100
 Version number of muid part.
 

Muid user parameters (set via basf)

int m_eklm_max_layer
 parameter Endcap_MX_layer: Max layer # of KLM endcap (default=11) 0 ==> use same value as was used by muid_set and muid_dec during DST prod 11 ==> discard two outermost layers of KLM endcap 13 ==> use all layers of KLM endcap, if possible
 
int m_use_ecl
 parameter UseECL: Use (1) or don't use (0) ECL in muid (default=0)
 
int m_expno
 parameter ExpNo: Experiment number for muid (default=0) 0 ==> use experiment number stored in data file >0 ==> override experiment number with this value <0 ==> disable muid code within fix_mdst
 
bool m_saveResultExtraInfo
 Whether to save result as EventExtraInfo.
 
int m_old_expno = 0
 Most recently used experiment # in muid.
 
int m_mapped_expno = 0
 Mapped value of m_old_exp_no.
 
MuidProbm_muonprob {nullptr}
 Pointer to muons' prob-density object.
 
MuidProbm_pionprob {nullptr}
 Pointer to pions' prob-density object.
 
MuidProbm_kaonprob {nullptr}
 Pointer to kaons' prob-density object.
 
StoreObjPtr< EventExtraInfom_eventExtraInfo
 Event ExtraInfo.
 
bool good_event ()
 Check if event correspondes to the period when Belle detector not in good condition.
 
int get_reprocess_version ()
 Get reprocess version of input mdst.
 
void scale_momenta (float scale_data=1.0, float scale_mc=1.0, int mode=0)
 Scale momenta of Mdst_trk.
 
void scale_momenta_set (const int, const int, const int, double &)
 Return scale factors for 2001 summer confs.
 
void scale_momenta_set_v1 (const int, const int, const int, double &)
 Return scale factors set_v1.
 
void scale_momenta_set_v2 (const int, const int, const int, double &)
 Return scale factors set_v2.
 
double vee_mass_nofit (const Belle::Mdst_vee2 &vee2, float scale=1.0)
 Calculates V0 mass with non-constraint fit results.
 
void scale_error (const int message_level=0)
 Apply scale error.
 
void smear_trk ()
 Apply track smearing (on MC)
 
int add_extra_trk_vee2 ()
 Add Mdst_trk_extra and Mdst_vee_extra to Mdst_trk and Mdst_vee2, respectively.
 
int remove_extra_trk_vee2 ()
 Remove extra tracks from Mdst_trk and Mdst_vee2.
 
void make_pi0 (int, double, double)
 Create Mdst_pi0 from Mdst_gamma and Mdst_ecl to let people get mass-constraint fitted momentum of pi0 after ad_hoc correction.
 
void correct_ecl (int, int)
 Correct photon's momenta and error matrix.
 
int set_primary_vertex (HepPoint3D &v, CLHEP::HepSymMatrix &ve)
 Set primary vertex assuming all tracks are pions.
 
void make_pi0_primary_vertex (int, double, double, const HepPoint3D &, const CLHEP::HepSymMatrix &)
 Fill Mdst_pi0 based on the fit result.
 
void correct_ecl_primary_vertex (const HepPoint3D &, const CLHEP::HepSymMatrix &)
 Correct ecl using primary vertex.
 
double Benergy (int expnum=0, int runnum=0)
 Return Beam energy.
 
void fix_pi0_brecon (void)
 Fix relation gamma<->pi0 in brecon table.
 
void shift_tof (const int mode)
 Shift tof times to account for residuals.
 
void shift_tof_set (const int expno, const int runno, const int mode, const int im, const double pmom, const double sgn, double &shift)
 Return time shifts for different exp.
 
void Muid_init (void)
 Initialize the Muid module.
 
void Muid_term (void)
 Terminate the Muid module.
 
void Muid_event (void)
 Called for each event.
 
void Muid_begin_run (const int, const int, const int)
 Called for each new run.
 
void Muid_end_run (void)
 Called when the current run ends.
 
static double pi0resol (double, double, const char *, bool, int, int)
 Treat pi0 mass width as a func.
 

Detailed Description

Declaration of class B2BIIFixMdst.

Definition at line 101 of file B2BIIFixMdstModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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

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

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

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

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

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

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

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

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

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

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

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

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

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ get_Benergy()

static double get_Benergy ( )
inlinestatic

Get Benergy.

Definition at line 134 of file B2BIIFixMdstModule.h.

135 {
136 return s_benergy_value;
137 };
static double s_benergy_value
Beam energy.

◆ get_pi0resol()

static double get_pi0resol ( double  p,
double  theta,
const char *  side,
bool  mcdata,
int  exp,
int  option 
)
inlinestatic

Get pi0 resolution.

Definition at line 142 of file B2BIIFixMdstModule.h.

144 {
145 return pi0resol(p, theta, side, mcdata, exp, option);
146 };
static double pi0resol(double, double, const char *, bool, int, int)
Treat pi0 mass width as a func.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

See https://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 79 of file Module.cc.

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

◆ Muid_begin_run()

void Muid_begin_run ( const int  expmc,
const int  exp,
const int  run 
)
private

Called for each new run.

Definition at line 104 of file B2BIIFixMdstModule_muid.cc.

105{
106
107 if (m_mapped_expno > 0) {
108 int expno = (m_expno != 0) ? m_expno : exp;
109 if (expno != m_old_expno) {
110 B2INFO("Reading DB constants for "
111 << ((expmc == 1) ? "data" : "MC") << ", Exp #" << expno
112 << ", Run #" << run);
113 m_old_expno = expno;
118 }
119 }
120
121 return;
122
123}
int m_expno
parameter ExpNo: Experiment number for muid (default=0) 0 ==> use experiment number stored in data fi...
MuidProb * m_kaonprob
Pointer to kaons' prob-density object.
MuidProb * m_pionprob
Pointer to pions' prob-density object.
int m_mapped_expno
Mapped value of m_old_exp_no.
MuidProb * m_muonprob
Pointer to muons' prob-density object.
int m_old_expno
Most recently used experiment # in muid.
void readDB(const char *, int &)
Read in probability density functions from database.

◆ Muid_end_run()

void Muid_end_run ( void  )
private

Called when the current run ends.

Definition at line 125 of file B2BIIFixMdstModule_muid.cc.

126{
127
128 return;
129
130}

◆ Muid_event()

void Muid_event ( void  )
private

Called for each event.

Definition at line 132 of file B2BIIFixMdstModule_muid.cc.

133{
134
135 Belle::Mdst_klm_mu_ex_Manager& muexMgr = Belle::Mdst_klm_mu_ex_Manager::get_manager();
136 // In well formed C++ references must always be legal but panther sometimes
137 // returns references to NULL. To catch this reliably we check the address
138 // of the reference and to make sure the compiler does not optimize this
139 // away we cast to a void pointer first so he doesn't know it's the address
140 // of a reference anymore.
141 if ((void*)&muexMgr == NULL) {
142 B2ERROR("%B2BIIFixMdst muid did not find Belle::Mdst_klm_mu_ex table "
143 << "in this event, which implies" << std::endl
144 << " that muid_set and muid_dec were not run yet. "
145 << "Required order of modules is " << std::endl
146 << " ... muid_set muid_dec ... rec2mdst ... B2BIIFixMdst ..."
147 << std::endl << " This program is terminated.");
148 exit(-1);
149 }
150 Belle::Mdst_ecl_trk_Manager& eclTrkMgr = Belle::Mdst_ecl_trk_Manager::get_manager();
151 Belle::Mdst_ecl_trk_Index eclTrkIdx = eclTrkMgr.index("trk");
152 eclTrkIdx.update();
153
154// For each Belle::Mdst_klm_mu_ex, refigure the likelihoods by using the
155// most up-to-date probability density functions of muons, pions, and
156// kaons for the KLM range and reduced chi-squared. Optionally, fold
157// in the probability density function of muons, pions, and kaons for
158// the ECL energy associated with the corresponding charged track.
159// The chain of pointers among panther tables is a little byzantine.
160
161 for (std::vector<Belle::Mdst_klm_mu_ex>::iterator iMuex = muexMgr.begin();
162 iMuex < muexMgr.end(); ++iMuex) {
163 Belle::Mdst_charged& chg = iMuex->pMDST_Charged();
164 Belle::Mdst_muid& muid = chg.muid();
165 int ECMaxLyr = (muid.quality() & 0x400000) ? 1 : 0;
166 if (m_eklm_max_layer == 11) {
167 ECMaxLyr = 1;
168 } else {
169 if ((m_eklm_max_layer == 13) && (ECMaxLyr == 0)) {
170 ECMaxLyr = 0;
171 }
172 }
173 double px = chg.px();
174 double py = chg.py();
175 double pz = chg.pz();
176 double p = sqrt(px * px + py * py + pz * pz);
177 double muon = iMuex->Muon_likelihood();
178 double pion = iMuex->Pion_likelihood();
179 double kaon = iMuex->Kaon_likelihood();
180 double miss = iMuex->Miss_likelihood();
181 double junk = iMuex->Junk_likelihood();
182 int outcome = iMuex->Outcome();
183 int lyrPasMax = iMuex->Layer_trk_brl() +
184 iMuex->Layer_trk_end() + 1;
185 int lyrPicMax = iMuex->Layer_hit_brl();
186 if (iMuex->Layer_hit_end() != -1) {
187 lyrPicMax = iMuex->Layer_trk_brl() +
188 iMuex->Layer_hit_end() + 1;
189 }
190 int lyrDiff = lyrPasMax - lyrPicMax;
191 int lyrExt = iMuex->Layer_trk_brl();
192 if ((outcome == 2) || (outcome == 4)) {
193 lyrExt = iMuex->Layer_trk_end();
194 if ((ECMaxLyr == 1) && (lyrExt > 11)) {
195 outcome = 4; // unconditionally an escape from endcap
196 lyrExt = 11;
197 int lyrEnd = std::min(iMuex->Layer_hit_end(), 11);
198 lyrPasMax = iMuex->Layer_trk_brl() + lyrExt + 1;
199 lyrPicMax = iMuex->Layer_trk_brl() + lyrEnd + 1;
200 lyrDiff = lyrPasMax - lyrPicMax;
201 }
202 }
203 int nPoints = iMuex->N_hits() * 2;
204 double rChi2 = 1.0E10;
205 if (nPoints > 0) {
206 rChi2 = iMuex->Chi_2() / nPoints;
207 }
208
209 if (outcome > 0) {
210 muon = m_muonprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
211 pion = m_pionprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
212 kaon = m_kaonprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
213 double denom = muon + pion + kaon;
214 if (denom < 1.0E-10) {
215 denom = 1.0;
216 muon = pion = kaon = 0.0;
217 junk = 1.0; // should happen very rarely
218 }
219 muon /= denom;
220 pion /= denom;
221 kaon /= denom;
222 }
223 if (m_use_ecl) {
224 Belle::Mdst_trk& trk = chg.trk();
225 std::vector<Belle::Mdst_ecl_trk> eclTrk = point_from(trk.get_ID(), eclTrkIdx);
226 std::vector<Belle::Mdst_ecl_trk>::iterator iEclTrk = eclTrk.begin();
227 if (iEclTrk != eclTrk.end()) {
228 Belle::Mdst_ecl& ecl = iEclTrk->ecl();
229 if (ecl) {
230 if (ecl.match() >= 1) {
231 double eEcl = ecl.energy();
232 if ((eEcl > 0.0) && (p > 0.25)) {
233 double muonE = m_muonprob->probECL(eEcl, p);
234 double pionE = m_pionprob->probECL(eEcl, p);
235 double kaonE = m_kaonprob->probECL(eEcl, p);
236 double denom = muonE + pionE + kaonE;
237 if (denom > 1.0E-10) {
238 if (miss + junk > 0.0) {
239 muon = muonE;
240 pion = pionE;
241 kaon = kaonE;
242 miss = 0.0;
243 junk = 0.0;
244 outcome = 5;
245 } else {
246 if (nPoints == 0) {
247 muon *= muonE;
248 pion *= pionE;
249 kaon *= kaonE;
250 }
251 }
252 }
253 denom = muon + pion + kaon;
254 if (denom < 1.0E-10) {
255 denom = 1.0;
256 muon = pion = kaon = 0.0;
257 junk = 1.0; // should happen very rarely
258 }
259 muon /= denom;
260 pion /= denom;
261 kaon /= denom;
262 } // if ( (eEcl > 0.0) && (p > 0.25) )
263 } // if ( ecl.match() >= 1 )
264 } // if ( ecl )
265 } // if ( iEclTrk != eclTrk.end() )
266 } // if ( m_use_ecl )
267
268 iMuex->Muon_likelihood(muon);
269 iMuex->Pion_likelihood(pion);
270 iMuex->Kaon_likelihood(kaon);
271 iMuex->Miss_likelihood(miss);
272 iMuex->Junk_likelihood(junk);
273 iMuex->Outcome(outcome);
274
275 } // for iMuex loop
276
277 return;
278
279}
int m_use_ecl
parameter UseECL: Use (1) or don't use (0) ECL in muid (default=0)
int m_eklm_max_layer
parameter Endcap_MX_layer: Max layer # of KLM endcap (default=11) 0 ==> use same value as was used by...
double probECL(double, double) const
Compute probability density for ECL energy deposit.
double prob(int, int, int, int, double) const
Compute probability density.

◆ Muid_init()

void Muid_init ( void  )
private

Initialize the Muid module.

Definition at line 62 of file B2BIIFixMdstModule_muid.cc.

63{
64
65 m_old_expno = (m_expno != 0) ? m_expno : 5; // expt #5, by default
67 if (m_mapped_expno > 0) {
68 m_muonprob = new MuidProb("muon", m_mapped_expno);
69 m_pionprob = new MuidProb("pion", m_mapped_expno);
70 m_kaonprob = new MuidProb("kaon", m_mapped_expno);
71
72 B2INFO("%B2BIIFixMdst muid is initialized by basf with"
73 << std::endl << " Endcap_MX_layer = " << m_eklm_max_layer
74 << ((m_eklm_max_layer == 0) ?
75 " ==> use value in data file" : "")
76 << ((m_eklm_max_layer == 13) ? " (if possible)" : "")
77 << std::endl << " UseECL = "
78 << ((m_use_ecl == 0) ? "false" : "true")
79 << std::endl << " ExpNo = " << m_expno
80 << ((m_expno == 0) ?
81 " ==> use value in data file" : ""));
82 } else {
83 B2INFO("%B2BIIFixMdst muid is disabled by user (ExpNo = "
84 << m_expno << " is negative)");
85 }
86
87 return;
88
89}
Class computes probability density for Muid calculation.

◆ Muid_term()

void Muid_term ( void  )
private

Terminate the Muid module.

Definition at line 91 of file B2BIIFixMdstModule_muid.cc.

92{
93
94 if (m_mapped_expno > 0) {
95 delete m_muonprob;
96 delete m_pionprob;
97 delete m_kaonprob;
98 }
99
100 return;
101
102}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

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

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

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

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

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

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

◆ setType()

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

Set the module type.

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

Definition at line 48 of file Module.cc.

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

Member Data Documentation

◆ m_5Srun

int m_5Srun

5S,2S,1S run or not

Definition at line 183 of file B2BIIFixMdstModule.h.

◆ m_add_or_remove_extra_trk_vee2

int m_add_or_remove_extra_trk_vee2

(1) to add to Mdst_charged etc, (-1) to remove (move to Mdst_*_extra), (0) do nothing

Definition at line 157 of file B2BIIFixMdstModule.h.

◆ m_benergy

int m_benergy

Apply Benergy.

Definition at line 168 of file B2BIIFixMdstModule.h.

◆ m_benergy_db

int m_benergy_db

Apply Benergy from DB or file.

Definition at line 169 of file B2BIIFixMdstModule.h.

◆ m_benergy_mcdb

int m_benergy_mcdb

Apply Benergy from DB or default value in MC.

Definition at line 170 of file B2BIIFixMdstModule.h.

◆ m_calib_dedx

int m_calib_dedx

Do dedx calibration.

Definition at line 176 of file B2BIIFixMdstModule.h.

◆ m_check_version_consistency

int m_check_version_consistency

Check consistency between environment variable and mdst version.

Definition at line 184 of file B2BIIFixMdstModule.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_correct_ecl

int m_correct_ecl

Apply correct_ecl.

Definition at line 158 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_5s

int m_correct_ecl_5s

For run indep.

MC exp.61 5S runs.

Definition at line 162 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_option

int m_correct_ecl_option

Apply correct_ecl_option.

Definition at line 159 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_primary_vertex

int m_correct_ecl_primary_vertex

Apply correct_ecl_primary_vertex.

Definition at line 161 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_version

int m_correct_ecl_version

Apply correct_ecl_version.

Definition at line 160 of file B2BIIFixMdstModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_eklm_max_layer

int m_eklm_max_layer

parameter Endcap_MX_layer: Max layer # of KLM endcap (default=11) 0 ==> use same value as was used by muid_set and muid_dec during DST prod 11 ==> discard two outermost layers of KLM endcap 13 ==> use all layers of KLM endcap, if possible

Definition at line 191 of file B2BIIFixMdstModule.h.

◆ m_eventExtraInfo

StoreObjPtr<EventExtraInfo> m_eventExtraInfo
private

Event ExtraInfo.

Definition at line 216 of file B2BIIFixMdstModule.h.

◆ m_expno

int m_expno

parameter ExpNo: Experiment number for muid (default=0) 0 ==> use experiment number stored in data file >0 ==> override experiment number with this value <0 ==> disable muid code within fix_mdst

Definition at line 198 of file B2BIIFixMdstModule.h.

◆ m_good_event

int m_good_event

Select good event only.

Definition at line 172 of file B2BIIFixMdstModule.h.

◆ m_hadron_a_only

int m_hadron_a_only

Select Hadron A event only.

Definition at line 173 of file B2BIIFixMdstModule.h.

◆ m_hadron_b_only

int m_hadron_b_only

Select Hadron B event only.

Definition at line 174 of file B2BIIFixMdstModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_kaonprob

MuidProb* m_kaonprob {nullptr}
private

Pointer to kaons' prob-density object.

Definition at line 213 of file B2BIIFixMdstModule.h.

◆ m_l4passed_only

int m_l4passed_only

Select level4-passed event only.

Definition at line 175 of file B2BIIFixMdstModule.h.

◆ m_limit_mdst_ecl_trk

int m_limit_mdst_ecl_trk

Limit of mdst_ecl_trk table size.

Definition at line 179 of file B2BIIFixMdstModule.h.

◆ m_limit_mdst_klm_cluster_hit

int m_limit_mdst_klm_cluster_hit

Limit of mdst_klm_cluster_hit table size.

Definition at line 180 of file B2BIIFixMdstModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_make_pi0

int m_make_pi0

Apply make_pi0 (after correct_ecl)

Definition at line 163 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_lower_limit

double m_make_pi0_lower_limit

Set make_pi0 lower mass limit.

Definition at line 165 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_option

int m_make_pi0_option

Set make_pi0 option.

Definition at line 164 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_primary_vertex

int m_make_pi0_primary_vertex

Apply make_pi0_primary_vertex (after correct_ecl)

Definition at line 167 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_upper_limit

double m_make_pi0_upper_limit

Set make_pi0 upper mass limit.

Definition at line 166 of file B2BIIFixMdstModule.h.

◆ m_mapped_expno

int m_mapped_expno = 0
private

Mapped value of m_old_exp_no.

Definition at line 209 of file B2BIIFixMdstModule.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_muid_version

const int m_muid_version = 100
staticprivate

Version number of muid part.

Definition at line 103 of file B2BIIFixMdstModule.h.

◆ m_muonprob

MuidProb* m_muonprob {nullptr}
private

Pointer to muons' prob-density object.

Definition at line 211 of file B2BIIFixMdstModule.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_old_expno

int m_old_expno = 0
private

Most recently used experiment # in muid.

Definition at line 208 of file B2BIIFixMdstModule.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_pionprob

MuidProb* m_pionprob {nullptr}
private

Pointer to pions' prob-density object.

Definition at line 212 of file B2BIIFixMdstModule.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_reprocess_version

int m_reprocess_version

Reprocess version (=0:old; =1:new)

Definition at line 181 of file B2BIIFixMdstModule.h.

◆ m_reprocess_version_specified

int m_reprocess_version_specified

Specify reprocess version.

Definition at line 182 of file B2BIIFixMdstModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_saveResultExtraInfo

bool m_saveResultExtraInfo

Whether to save result as EventExtraInfo.

Definition at line 202 of file B2BIIFixMdstModule.h.

◆ m_scale_error

int m_scale_error

Apply scale_error.

Definition at line 154 of file B2BIIFixMdstModule.h.

◆ m_scale_error_dataset_name

std::string m_scale_error_dataset_name

Set scale_error_dataset name.

Definition at line 156 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta

int m_scale_momenta

Apply scale_momenta.

Definition at line 150 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta_mode

int m_scale_momenta_mode

Set parameter mode for scale_momenta.

Definition at line 153 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta_scale_data

float m_scale_momenta_scale_data

Set parameter scale_data for scale_momenta.

Definition at line 151 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta_scale_mc

float m_scale_momenta_scale_mc

Set parameter scale_mc for scale_momenta.

Definition at line 152 of file B2BIIFixMdstModule.h.

◆ m_shift_tof_mode

int m_shift_tof_mode

Do tof_correction.

Definition at line 177 of file B2BIIFixMdstModule.h.

◆ m_smear_trk

int m_smear_trk

Do extra-smearing for MC tracks.

Definition at line 155 of file B2BIIFixMdstModule.h.

◆ m_table_size

int m_table_size

Check table sizes.

Definition at line 178 of file B2BIIFixMdstModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_use_ecl

int m_use_ecl

parameter UseECL: Use (1) or don't use (0) ECL in muid (default=0)

Definition at line 193 of file B2BIIFixMdstModule.h.


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