This module compares tracks generated by some pattern recognition algorithm for PXD, SVD and CDC to ideal Monte Carlo tracks and performs a matching from the former to the underlying MCParticles. More...

#include <MCRecoTracksMatcherModule.h>

Inheritance diagram for MCRecoTracksMatcherModule:

[legend]

Collaboration diagram for MCRecoTracksMatcherModule:

[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
	MCRecoTracksMatcherModule ()
	Constructor setting up the parameter.

void	initialize () final
	Signal the beginning of the event processing.

void	event () final
	Process the event.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. More...

virtual void	beginRun ()
	Called when entering a new run. More...

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

virtual void	terminate ()
	This method is called at the end of the event processing. 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 void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...

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

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

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

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

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

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

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

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

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

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

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

Private Types
using	NDF = int
	Descriptive type defintion for a number of degrees of freedom.

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_prRecoTracksStoreArrayName
	Parameter : Name of the RecoTracks StoreArray from pattern recognition.

std::string	m_mcRecoTracksStoreArrayName
	Parameter : Name of the RecoTracks StoreArray from MC track finding.

std::string	m_TracksStoreArrayName
	Parameter : Name of the Tracks StoreArray.

bool	m_usePXDHits
	Parameter : Switch whether PXDHits should be used in the matching.

bool	m_useSVDHits
	Parameter : Switch whether SVDHits should be used in the matching.

bool	m_useCDCHits
	Parameter : Switch whether CDCHits should be used in the matching.

bool	m_useOnlyAxialCDCHits
	Parameter : Switch whether only axial CDCHits should be used.

bool	m_useFittedTracks = true
	Use fitted tracks for matching.

double	m_minimalPurity
	Parameter : Minimal purity of a PRTrack to be considered matchable to a MCTrack. More...

double	m_minimalEfficiency
	Parameter : Minimal efficiency for a MCTrack to be considered matchable to a PRTrack. More...

StoreArray< MCParticle >	m_MCParticles
	StoreArray containing MCParticles.

StoreArray< RecoTrack >	m_PRRecoTracks
	StoreArray containing PR RecoTracks.

StoreArray< RecoTrack >	m_MCRecoTracks
	StoreArray containing MC RecoTracks.

StoreArray< PXDCluster >	m_PXDClusters
	StoreArray containing PXDClusters.

StoreArray< SVDCluster >	m_SVDClusters
	StoreArray containing SVDClusters.

StoreArray< CDCHit >	m_CDCHits
	StoreArray containing CDCHits.

bool	m_mcParticlesPresent = false
	Flag to indicated whether the Monte Carlo track are on the DataStore.

std::map< int, NDF >	m_ndf_by_detId = {{Const::PXD, 2}, {Const::SVD, 1}, {Const::CDC, 1}}
	Map storing the standard number degrees of freedom for a single hit by detector *‍/.

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

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

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

std::string	m_description
	The description of the module.

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

LogConfig	m_logConfig
	The log system configuration of the module.

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

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

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

Detailed Description

This module compares tracks generated by some pattern recognition algorithm for PXD, SVD and CDC to ideal Monte Carlo tracks and performs a matching from the former to the underlying MCParticles.

To achieve this it evaluates and saves the purities and efficiencies from the pattern recognition track to Monte-Carlo tracks, which can than also be used by a subsequent evaluation modules.

In order to match the tracks the module takes two StoreArrays of RecoTracks, which should be compared.

One of them contains RecoTracks composed by the patter recognition algorithm to be assessed. They are refered to as PRTracks.

The second StoreArray holds the reference tracks, which should ideally be reconstructed. These are refered to as MCTracks and should generally be composed by the MCTrackingModule. (Design note : We use the tracks composed by the MCTrackFinder as reference, because the mere definition of what a trackable particle and what the best achievable track is, lies within the implementation of the MCTrackFinder. If we did not use the tracks from the MCTrackFinder as input, it would mean a double implementation of great parts of that logic.)

If the pattern recognition only covers a part of the tracking detectors, the matching can be constrained to specific subdetectors by switching of the appropriate usePXDHits, useSVDHits or useCDCHits parameters.

As a result the module

creates a RelationArray from the PRTracks to the MCTracks, which will be called the purity relation,
creates a RelationArray from the MCTracks to the PRTracks, which will be called the efficiency relation,
assigns the McTrackId property of the PRTracks and
creates a RelationArray from the PRTracks to the MCParticles.

The RelationArray for purity and efficiency generally store only the single highest purity and the single highest efficiency for a given PRTrack, MCTrack respectivelly. However these values are stored with a minus sign if the PRTrack is a clone, or the MCTrack is merged into another PRTrack. The McTrackId is either set to the index of the MCParticle or to some negative value indicating the severity of the mismatch. (Classification details below).

Moreover, only PRTracks that exceed the minimal purity requirement and a minimal efficiency requirement will have their purity/efficiency stored and will take part in the matching. The minimal purity can be choosen by the minimalPurity parameter (default 2.0/3.0). The minimal efficiency can be choosen by the minimalEfficiency parameter (default 0.05).

Last but not least a RelationArray from matched PRTracks to MCParticles is build and the McTrackId property of the PRTrack is set to the StoreArray index of the MCParticle (similar as the MCTrackFinder does it for the MCTracks). By default clone tracks are also assigned to their MCParticle. This behaviour can be switched off by the relateClonesToMCParticles.

In the following a more detailed explaination is given for the matching and the classification of PRTracks and MCTracks.

The PRTracks can be classified into six categories:

UNDEFINED
- Status of the track before any real status has been set.
- If the track status is still UNDEFINED after matching, something went wrong.
MATCHED
- The highest efficiency PRTrack of the highest purity MCTrack to this PRTrack is the same as this PRTrack.
- In addition, the charge of the PRTrack and the one of the MCTrack are the same.
- This means the PRTrack contains a high contribution of only one MCTrack and is also the best of all PRTracks describing this MCTrack (including the charge).
- The McTrackId property of matched PRTrack is set to the MCTrackId property of the MCTrack, which is usually the index of the MCParticle in its corresponding StoreArray.
- Also the relation from PRTrack to MCParticle is added.
- The purity relation is setup from the PRTrack to the MCTrack with the (positive) purity as weight.
WRONG CHARGE
- The highest efficiency PRTrack of the highest purity MCTrack to this PRTrack is the same as this PRTrack.
- But, the charge of the PRTrack and the one of the MCTrack are NOT the same.
- This means the PRTrack contains a high contribution of only one MCTrack and is also the best of all PRTracks describing this MCTrack, but the charge is wrong.
- The McTrackId property of matched PRTrack is set to the MCTrackId property of the MCTrack, which is usually the index of the MCParticle in its corresponding StoreArray.
- Also the relation from PRTrack to MCParticle is added.
- The purity relation is setup from the PRTrack to the MCTrack with the (positive) purity as weight.
CLONE
- The highest purity MCTrack has a different highest efficiency PRTrack than this track.
- Anyway, the charge of the PRTrack and the one of the MCTrack are the same.
- This means the PRTrack contains high contributions of only one MCTrack but a different other PRTrack contains an even higher contribution to this MCTrack.
- Only if the relateClonesToMCParticles parameter is active The McTrackId property of cloned PRTracks is set to the MCTrackId property of the MCTrack. Else it will be set to -9.
- Also the relation from PRTrack to MCParticle is added, only if the relateClonesToMCParticles parameter is active.
- The purity relation is always setup from the PRTrack to the MCTrack with the negative purity as weight, to be able to distinguish them from the matched tracks.
CLONE WRONG CHARGE
- The highest purity MCTrack has a different highest efficiency PRTrack than this track.
- Moreover, the charge of the PRTrack and the one of the MCTrack are NOT the same.
- This means the PRTrack contains high contributions of only one MCTrack but a different other PRTrack contains an even higher contribution to this MCTrack.
- Only if the relateClonesToMCParticles parameter is active The McTrackId property of cloned PRTracks is set to the MCTrackId property of the MCTrack. Else it will be set to -9.
- Also the relation from PRTrack to MCParticle is added, only if the relateClonesToMCParticles parameter is active.
- The purity relation is always setup from the PRTrack to the MCTrack with the negative purity as weight, to be able to distinguish them from the matched tracks.
BACKGROUND
- The PRTrack contains mostly hits, which are not part of any MCTrack.
- This normally means, that this PRTracks is made of beam background hits.
- If one constrains the MCTracks in the MCTrackFinder to some specific particles, say the tag side, also all signal side tracks end up in this category (in case of reasonable tracking performance). In this case the background rate is somewhat less meaningful.
- For background tracks the McTrackId of the PRTrack is set to -99.
- No relation from the PRTrack to the MCParticle is inserted.
- PRTracks classified as background are not entered in the purity RelationArray.
GHOST
- The highest purity MCTrack to this PRTrack has a purity lower than the minimal purity given in the parameter minimalPurity or
- has an efficiency lower than the efficiency given in the parameter minimalEfficiency.
- This means that the PRTrack does not contain a significat number of a specific MCTrack nor can it considered only made of background.
- For ghost tracks the McTrackId of the RecoTracks is set to -999.
- No relation from the PRTrack to the MCParticle is inserted.
- PRTracks classified as ghost are not entered in the purity RelationArray.

MCTracks are classified into five categories:

UNDEFINED
- Status of the track before any real status has been set.
- If the track status is still UNDEFINED after matching, something went wrong.
MATCHED
- The highest purity MCTrack of the highest efficiency PRTrack of this MCTrack is the same as this MCTrack.
- In addition, the charge of the MCTrack and the one of the PRTrack are the same.
- This means the MCTrack is well described by a PRTrack and this PRTrack has only a significant contribution from this MCTrack.
- The efficiency relation is setup from the MCTrack to the PRTrack with the (positive) efficiency as weight.
WRONG CHARGE
- The highest purity MCTrack of the highest efficiency PRTrack of this MCTrack is the same as this MCTrack.
- But, the charge of the MCTrack and the one of the PRTrack are NOT the same.
- This means the MCTrack is well described by a PRTrack and this PRTrack has only a significant contribution from this MCTrack.
- The efficiency relation is setup from the MCTrack to the PRTrack with the (positive) efficiency as weight.
MERGED
- The highest purity MCTrack of the highest efficiency PRTrack of this MCTrack is not the same as this MCTrack.
- Anyway, the charge of this MCTrack and the one of the PRTrack are the same.
- This means this MCTrack is mostly contained in a PRTrack, which in turn however better describes a MCTrack different form this.
- The efficiency relation is setup from the MCTrack to the PRTrack with the negative efficiency as weight, to be able to distinguish them from the matched tracks.
MERGED WRONG CHARGE
- The highest purity MCTrack of the highest efficiency PRTrack of this MCTrack is not the same as this MCTrack.
- Moreover, the charge of this MCTrack and the one of the PRTrack are NOT the same.
- This means this MCTrack is mostly contained in a PRTrack, which in turn however better describes a MCTrack different form this.
- The efficiency relation is setup from the MCTrack to the PRTrack with the negative efficiency as weight, to be able to distinguish them from the matched tracks.
MISSING
- There is no highest efficiency PRTrack to this MCTrack, which also fullfills the minimal purity requirement.
- For this category no efficiency relation is inserted.

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

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

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

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Definition at line 176 of file Module.h.

Member Data Documentation

◆ m_minimalEfficiency

double m_minimalEfficiency

private

Parameter : Minimal efficiency for a MCTrack to be considered matchable to a PRTrack.

This number encodes which fraction of the true hits must at least be in the reconstructed track. The default 0.05 suggests that at least 5% of the true hits should have been picked up.

Definition at line 229 of file MCRecoTracksMatcherModule.h.

◆ m_minimalPurity

double m_minimalPurity

private

Parameter : Minimal purity of a PRTrack to be considered matchable to a MCTrack.

This number encodes how many correct hits are minimally need to compensate for a false hits. The default 2. / 3. suggests that for each background hit can be compensated by two correct hits.

Definition at line 221 of file MCRecoTracksMatcherModule.h.

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

tracking/modules/mcMatcher/include/MCRecoTracksMatcherModule.h
tracking/modules/mcMatcher/src/MCRecoTracksMatcherModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

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

◆ terminate()

Member Data Documentation

◆ m_minimalEfficiency

◆ m_minimalPurity