Declaration of class B2BIIFixMdst. More...

#include <B2BIIFixMdstModule.h>

Inheritance diagram for B2BIIFixMdstModule:

Collaboration diagram for B2BIIFixMdstModule:

[legend]

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

virtual void	endRun ()
	This method is called if the current run ends. More...

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module. More...

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

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

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

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

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

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

const 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. More...

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). More...

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static 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. More...

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

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side. More...

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

void	setDescription (const std::string &description)
	Sets the description of the module. More...

void	setType (const std::string &type)
	Set the module type. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
std::list< 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. More...

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

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

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

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

Detailed Description

Declaration of class B2BIIFixMdst.

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

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.

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

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

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

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

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

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

◆ 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 RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

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

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.

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

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

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

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

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

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

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

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

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

Member Data Documentation

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

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 Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_correct_ecl_5s