Declaration of class B2BIIFixMdst. More...

#include <B2BIIFixMdstModule.h>

Inheritance 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.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static 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< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_name
	The name of the module, saved as a string (user-modifiable)

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

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.

MuidProb *	m_muonprob {nullptr}
	Pointer to muons' prob-density object.

MuidProb *	m_pionprob {nullptr}
	Pointer to pions' prob-density object.

MuidProb *	m_kaonprob {nullptr}
	Pointer to kaons' prob-density object.

StoreObjPtr< EventExtraInfo >	m_eventExtraInfo
	Event ExtraInfo.

bool	good_event ()
	Check if event corresponds 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 98 of file B2BIIFixMdstModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

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.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ 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.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "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.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ get_Benergy()

static double get_Benergy ( )

inlinestatic

Get Benergy.

Definition at line 131 of file B2BIIFixMdstModule.h.

    {
      return s_benergy_value;
    };

◆ 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 139 of file B2BIIFixMdstModule.h.

    {
      return pi0resol(p, theta, side, mcdata, exp, option);
    };

◆ 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.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

◆ 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.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ 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.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

◆ 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.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ 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.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ 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.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ 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

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

◆ 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.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ 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

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ 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.

{
 
  if (m_mapped_expno > 0) {
    int expno = (m_expno != 0) ? m_expno : exp;
    if (expno != m_old_expno) {
      B2INFO("Reading DB constants for "
             << ((expmc == 1) ? "data" : "MC") << ", Exp #" << expno
             << ", Run #" << run);
      m_old_expno = expno;
      m_mapped_expno = m_old_expno;
      m_muonprob->readDB("muon", m_mapped_expno);
      m_pionprob->readDB("pion", m_mapped_expno);
      m_kaonprob->readDB("kaon", m_mapped_expno);
    }
  }
 
  return;
 
}

◆ Muid_end_run()

void Muid_end_run ( void )

private

Called when the current run ends.

Definition at line 125 of file B2BIIFixMdstModule_muid.cc.

{
 
  return;
 
}

◆ Muid_event()

void Muid_event ( void )

private

Called for each event.

Definition at line 132 of file B2BIIFixMdstModule_muid.cc.

{
 
  Belle::Mdst_klm_mu_ex_Manager& muexMgr = Belle::Mdst_klm_mu_ex_Manager::get_manager();
  // In well formed C++ references must always be legal but panther sometimes
  // returns references to NULL. To catch this reliably we check the address
  // of the reference and to make sure the compiler does not optimize this
  // away we cast to a void pointer first so he doesn't know it's the address
  // of a reference anymore.
  if ((void*)&muexMgr == NULL) {
    B2ERROR("%B2BIIFixMdst muid did not find Belle::Mdst_klm_mu_ex table "
            << "in this event, which implies" << std::endl
            << "   that muid_set and muid_dec were not run yet. "
            << "Required order of modules is " << std::endl
            << "   ... muid_set muid_dec ... rec2mdst ... B2BIIFixMdst ..."
            << std::endl << "   This program is terminated.");
    exit(-1);
  }
  Belle::Mdst_ecl_trk_Manager& eclTrkMgr = Belle::Mdst_ecl_trk_Manager::get_manager();
  Belle::Mdst_ecl_trk_Index eclTrkIdx = eclTrkMgr.index("trk");
  eclTrkIdx.update();
 
// For each Belle::Mdst_klm_mu_ex, refigure the likelihoods by using the
// most up-to-date probability density functions of muons, pions, and
// kaons for the KLM range and reduced chi-squared.  Optionally, fold
// in the probability density function of muons, pions, and kaons for
// the ECL energy associated with the corresponding charged track.
// The chain of pointers among panther tables is a little byzantine.
 
  for (std::vector<Belle::Mdst_klm_mu_ex>::iterator iMuex = muexMgr.begin();
       iMuex < muexMgr.end(); ++iMuex) {
    Belle::Mdst_charged& chg      = iMuex->pMDST_Charged();
    Belle::Mdst_muid&    muid     = chg.muid();
    int ECMaxLyr = (muid.quality() & 0x400000) ? 1 : 0;
    if (m_eklm_max_layer == 11) {
      ECMaxLyr = 1;
    } else {
      if ((m_eklm_max_layer == 13) && (ECMaxLyr == 0)) {
        ECMaxLyr = 0;
      }
    }
    double       px        = chg.px();
    double       py        = chg.py();
    double       pz        = chg.pz();
    double       p         = sqrt(px * px + py * py + pz * pz);
    double       muon      = iMuex->Muon_likelihood();
    double       pion      = iMuex->Pion_likelihood();
    double       kaon      = iMuex->Kaon_likelihood();
    double       miss      = iMuex->Miss_likelihood();
    double       junk      = iMuex->Junk_likelihood();
    int          outcome   = iMuex->Outcome();
    int          lyrPasMax = iMuex->Layer_trk_brl() +
                             iMuex->Layer_trk_end() + 1;
    int          lyrPicMax = iMuex->Layer_hit_brl();
    if (iMuex->Layer_hit_end() != -1) {
      lyrPicMax            = iMuex->Layer_trk_brl() +
                             iMuex->Layer_hit_end() + 1;
    }
    int          lyrDiff   = lyrPasMax - lyrPicMax;
    int          lyrExt    = iMuex->Layer_trk_brl();
    if ((outcome == 2) || (outcome == 4)) {
      lyrExt               = iMuex->Layer_trk_end();
      if ((ECMaxLyr == 1) && (lyrExt > 11)) {
        outcome            = 4;         // unconditionally an escape from endcap
        lyrExt             = 11;
        int lyrEnd         = std::min(iMuex->Layer_hit_end(), 11);
        lyrPasMax          = iMuex->Layer_trk_brl() + lyrExt + 1;
        lyrPicMax          = iMuex->Layer_trk_brl() + lyrEnd + 1;
        lyrDiff            = lyrPasMax - lyrPicMax;
      }
    }
    int          nPoints   = iMuex->N_hits() * 2;
    double       rChi2     = 1.0E10;
    if (nPoints > 0) {
      rChi2                = iMuex->Chi_2() / nPoints;
    }
 
    if (outcome > 0) {
      muon  = m_muonprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
      pion  = m_pionprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
      kaon  = m_kaonprob->prob(ECMaxLyr, outcome, lyrExt, lyrDiff, rChi2);
      double denom = muon + pion + kaon;
      if (denom < 1.0E-10) {
        denom = 1.0;
        muon  = pion = kaon = 0.0;
        junk  = 1.0;                    // should happen very rarely
      }
      muon /= denom;
      pion /= denom;
      kaon /= denom;
    }
    if (m_use_ecl) {
      Belle::Mdst_trk& trk = chg.trk();
      std::vector<Belle::Mdst_ecl_trk> eclTrk = point_from(trk.get_ID(), eclTrkIdx);
      std::vector<Belle::Mdst_ecl_trk>::iterator iEclTrk = eclTrk.begin();
      if (iEclTrk != eclTrk.end()) {
        Belle::Mdst_ecl& ecl = iEclTrk->ecl();
        if (ecl) {
          if (ecl.match() >= 1) {
            double eEcl = ecl.energy();
            if ((eEcl > 0.0) && (p > 0.25)) {
              double muonE = m_muonprob->probECL(eEcl, p);
              double pionE = m_pionprob->probECL(eEcl, p);
              double kaonE = m_kaonprob->probECL(eEcl, p);
              double denom = muonE + pionE + kaonE;
              if (denom > 1.0E-10) {
                if (miss + junk > 0.0) {
                  muon    = muonE;
                  pion    = pionE;
                  kaon    = kaonE;
                  miss    = 0.0;
                  junk    = 0.0;
                  outcome = 5;
                } else {
                  if (nPoints == 0) {
                    muon   *= muonE;
                    pion   *= pionE;
                    kaon   *= kaonE;
                  }
                }
              }
              denom = muon + pion + kaon;
              if (denom < 1.0E-10) {
                denom = 1.0;
                muon  = pion = kaon = 0.0;
                junk  = 1.0;                 // should happen very rarely
              }
              muon /= denom;
              pion /= denom;
              kaon /= denom;
            }   // if ( (eEcl > 0.0) && (p > 0.25) )
          }     // if ( ecl.match() >= 1 )
        }       // if ( ecl )
      } // if ( iEclTrk != eclTrk.end() )
    }           // if ( m_use_ecl )
 
    iMuex->Muon_likelihood(muon);
    iMuex->Pion_likelihood(pion);
    iMuex->Kaon_likelihood(kaon);
    iMuex->Miss_likelihood(miss);
    iMuex->Junk_likelihood(junk);
    iMuex->Outcome(outcome);
 
  }     // for iMuex loop
 
  return;
 
}

◆ Muid_init()

void Muid_init ( void )

private

Initialize the Muid module.

Definition at line 62 of file B2BIIFixMdstModule_muid.cc.

{
 
  m_old_expno = (m_expno != 0) ? m_expno : 5;  // expt #5, by default
  m_mapped_expno = m_old_expno;
  if (m_mapped_expno > 0) {
    m_muonprob = new MuidProb("muon", m_mapped_expno);
    m_pionprob = new MuidProb("pion", m_mapped_expno);
    m_kaonprob = new MuidProb("kaon", m_mapped_expno);
 
    B2INFO("%B2BIIFixMdst muid is initialized by basf with"
           << std::endl << "  Endcap_MX_layer = " << m_eklm_max_layer
           << ((m_eklm_max_layer ==  0) ?
               " ==> use value in data file" : "")
           << ((m_eklm_max_layer == 13) ? " (if possible)" : "")
           << std::endl << "           UseECL = "
           << ((m_use_ecl == 0) ? "false" : "true")
           << std::endl << "            ExpNo = " << m_expno
           << ((m_expno == 0) ?
               " ==> use value in data file" : ""));
  } else {
    B2INFO("%B2BIIFixMdst muid is disabled by user (ExpNo = "
           << m_expno << " is negative)");
  }
 
  return;
 
}

◆ Muid_term()

void Muid_term ( void )

private

Terminate the Muid module.

Definition at line 91 of file B2BIIFixMdstModule_muid.cc.

{
 
  if (m_mapped_expno > 0) {
    delete m_muonprob;
    delete m_pionprob;
    delete m_kaonprob;
  }
 
  return;
 
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ 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

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ 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

name	The 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

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ 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

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ 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

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ 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

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ 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.

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

Member Data Documentation

◆ m_5Srun

int m_5Srun

5S,2S,1S run or not

Definition at line 180 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 154 of file B2BIIFixMdstModule.h.

◆ m_benergy

int m_benergy

Apply Benergy.

Definition at line 165 of file B2BIIFixMdstModule.h.

◆ m_benergy_db

int m_benergy_db

Apply Benergy from DB or file.

Definition at line 166 of file B2BIIFixMdstModule.h.

◆ m_benergy_mcdb

int m_benergy_mcdb

Apply Benergy from DB or default value in MC.

Definition at line 167 of file B2BIIFixMdstModule.h.

◆ m_calib_dedx

int m_calib_dedx

Do dedx calibration.

Definition at line 173 of file B2BIIFixMdstModule.h.

◆ m_check_version_consistency

int m_check_version_consistency

Check consistency between environment variable and mdst version.

Definition at line 181 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 155 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_5s

int m_correct_ecl_5s

For run indep.

MC exp.61 5S runs.

Definition at line 159 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_option

int m_correct_ecl_option

Apply correct_ecl_option.

Definition at line 156 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_primary_vertex

int m_correct_ecl_primary_vertex

Apply correct_ecl_primary_vertex.

Definition at line 158 of file B2BIIFixMdstModule.h.

◆ m_correct_ecl_version

int m_correct_ecl_version

Apply correct_ecl_version.

Definition at line 157 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 188 of file B2BIIFixMdstModule.h.

◆ m_eventExtraInfo

StoreObjPtr<EventExtraInfo> m_eventExtraInfo

private

Event ExtraInfo.

Definition at line 213 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 195 of file B2BIIFixMdstModule.h.

◆ m_good_event

int m_good_event

Select good event only.

Definition at line 169 of file B2BIIFixMdstModule.h.

◆ m_hadron_a_only

int m_hadron_a_only

Select Hadron A event only.

Definition at line 170 of file B2BIIFixMdstModule.h.

◆ m_hadron_b_only

int m_hadron_b_only

Select Hadron B event only.

Definition at line 171 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 210 of file B2BIIFixMdstModule.h.

◆ m_l4passed_only

int m_l4passed_only

Select level4-passed event only.

Definition at line 172 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 176 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 177 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 160 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_lower_limit

double m_make_pi0_lower_limit

Set make_pi0 lower mass limit.

Definition at line 162 of file B2BIIFixMdstModule.h.

◆ m_make_pi0_option

int m_make_pi0_option

Set make_pi0 option.

Definition at line 161 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 164 of file B2BIIFixMdstModule.h.

int m_reprocess_version

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

Definition at line 178 of file B2BIIFixMdstModule.h.

◆ m_reprocess_version_specified

int m_reprocess_version_specified

Specify reprocess version.

Definition at line 179 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 199 of file B2BIIFixMdstModule.h.

◆ m_scale_error

int m_scale_error

Apply scale_error.

Definition at line 151 of file B2BIIFixMdstModule.h.

◆ m_scale_error_dataset_name

std::string m_scale_error_dataset_name

Set scale_error_dataset name.

Definition at line 153 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta

int m_scale_momenta

Apply scale_momenta.

Definition at line 147 of file B2BIIFixMdstModule.h.

◆ m_scale_momenta_mode

int m_scale_momenta_mode

Set parameter mode for scale_momenta.

Definition at line 150 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 148 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 149 of file B2BIIFixMdstModule.h.

◆ m_shift_tof_mode

int m_shift_tof_mode

Do tof_correction.

Definition at line 174 of file B2BIIFixMdstModule.h.

◆ m_smear_trk

int m_smear_trk

Do extra-smearing for MC tracks.

Definition at line 152 of file B2BIIFixMdstModule.h.

◆ m_table_size

int m_table_size

Check table sizes.

Definition at line 175 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 190 of file B2BIIFixMdstModule.h.

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

b2bii/modules/B2BIIMdstInput/include/B2BIIFixMdstModule.h
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule.cc
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule_brecon.cc
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule_ecl.cc
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule_muid.cc
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule_tof.cc
b2bii/modules/B2BIIMdstInput/src/B2BIIFixMdstModule_trk.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Muid user parameters (set via basf)

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ exposePythonAPI()

◆ get_Benergy()

◆ get_pi0resol()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ Muid_begin_run()

◆ Muid_end_run()

◆ Muid_event()

◆ Muid_init()

◆ Muid_term()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_5Srun

◆ m_add_or_remove_extra_trk_vee2

◆ m_benergy

◆ m_benergy_db

◆ m_benergy_mcdb

◆ m_calib_dedx

◆ m_check_version_consistency

◆ m_conditions

◆ m_correct_ecl

◆ m_correct_ecl_5s