Module that tries to register a relation between SpacePoints and TrueHits, hence making some MC Information easily accesible for other modules working with SpacePoints (e.g. More...

#include <SpacePoint2TrueHitConnectorModule.h>

Inheritance diagram for SpacePoint2TrueHitConnectorModule:

[legend]

Collaboration diagram for SpacePoint2TrueHitConnectorModule:

[legend]

Classes
struct	RootVariables
	helper struct to access root variables inside the module More...

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
	SpacePoint2TrueHitConnectorModule ()
	Constructor.

void	initialize () override
	initialize: initialize counters, check StoreArrays, register StoreArrays, ...

void	event () override
	event: try to find the appropriate TrueHit to all SpacePoints

void	terminate () override
	terminate: print some summary information

	BELLE2_DEFINE_EXCEPTION (NoClusterToSpacePoint, "Found no related Cluster for a SpacePoint!")
	Exception for when no related Cluster can be found for a SpacePoint.

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

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 Types
enum	e_detTypes { c_PXD = Belle2::VXD::SensorInfoBase::PXD , c_SVD = Belle2::VXD::SensorInfoBase::SVD }
	enum to distinguish the detectortypes More...

enum	e_relationStatus { c_clearHit = 1 , c_ghostHit = 2 , c_SpacePointU = 4 , c_SpacePointV = 8 , c_primaryParticle = 16 , c_bgParticle = 32 , c_nonUniqueRelation = 64 , c_registeredRelation = 128 , c_noiseCluster = 256 }
	enum for better code readability

typedef std::unordered_map< int, TrueHitInfo >	baseMapT
	typedef for shorter notation throughout the module

Protected Member Functions
void	initializeCounters ()
	initialize all counters to 0 WARNING: only call in constructor of module!

template<typename MapType , typename TrueHitType >
std::pair< TrueHitType *, double >	getTHwithWeight (const MapType &aMap, Belle2::StoreArray< TrueHitType > trueHits, Belle2::SpacePoint *spacePoint, e_detTypes detType)
	get the TrueHit from information that is stored in the map (conditions are checked in the following order): More...

template<typename TrueHitType >
bool	compatibleCombination (Belle2::SpacePoint spacePoint, TrueHitType trueHit)
	compares the TrueHit and the SpacePoint positions (global) to decide whether they are compatible NOTE: if a SpacePoint and a TrueHit do not 'pass' this test they are most proably not compatible, however just because this test is passed does not guarantee that the 'right' TrueHit has been chosen before calling this function!

template<typename MapType , typename ClusterType , typename TrueHitType >
MapType	getRelatedTrueHits (Belle2::SpacePoint *spacePoint, std::string clusterName="ALL", std::string trueHitName="ALL")
	get all the related TrueHits to the SpacePoint, including their weights in a map (multimap!) where the StoreArray indices of the TrueHits are the keys and the values are TrueHitInfos to these indices MapType has to have key value pairs of pair<int,TrueHitInfo> throws: + NoTrueHitToCluster More...

template<typename MapType >
MapType	processSpacePoint (Belle2::SpacePoint *spacePoint, e_detTypes detType)
	process a SpacePoint. More...

template<typename MapType >
void	registerAllRelations (Belle2::SpacePoint *spacePoint, MapType trueHitMap, e_detTypes detType)
	register a Relation to all the TrueHits in the trueHitMap for the passed SpacePoint

template<typename TrueHitType >
void	registerOneRelation (Belle2::SpacePoint spacePoint, std::pair< TrueHitType , double > trueHitwWeight, e_detTypes)
	register Relation between SpacePoint and TrueHit (and if neccessary also between SpacePoint and Cluster)

template<typename ClusterType >
void	reRegisterClusterRelations (Belle2::SpacePoint origSpacePoint, Belle2::SpacePoint newSpacePoint, std::string clusterName="ALL")
	register all the relations to Clusters that origSpacePoint had for newSpacePoint

template<typename ClusterType >
std::vector< std::pair< ClusterType *, double > >	getRelatedClusters (Belle2::SpacePoint *spacePoint, std::string clusterName="ALL")
	get the pointers to the related Clusters and the weight of the original Relations between the spacePoint and these Clusters

template<typename TrueHitType >
void	registerTrueHitRelation (Belle2::SpacePoint *spacePoint, int index, double weight, Belle2::StoreArray< TrueHitType > trueHits)
	register the relation between a SpacePoint and the TrueHit (passed by index in the correspoinding TrueHit Array) with the passed weight NOTE: defining a function here mainly to avoid having duplicate code for every TrueHitType

template<typename MapType >
void	positionAnalysis (Belle2::SpacePoint *spacePoint, const MapType &trueHitMap, const int &index, e_detTypes detType)
	Analyze the position of SpacePoints and corresponding TrueHits. More...

std::pair< double, double >	getLocalPos (Belle2::SpacePoint *spacePoint)
	get the local position of a SpacePoint

template<typename TrueHitType >
std::pair< ROOT::Math::XYZVector, ROOT::Math::XYZVector >	getTrueHitPositions (TrueHitType *trueHit)
	get the local (.first) and global (.second) position of a TrueHit (passed by index)

void	initializeRootFile ()
	initialize the root file that is used for output

void	closeRootFile ()
	close root file

std::pair< unsigned short int, unsigned short int >	getClusterSizes (Belle2::SpacePoint *spacePoint, e_detTypes detType)
	get the sizes of the related Clusters of a SpacePoint More...

std::pair< double, double >	getLocalError (Belle2::SpacePoint *spacePoint)
	get the position error of SpacePoints in local coordinates More...

double	calculateRelationWeight (const TrueHitInfo &trueHitInfo, Belle2::SpacePoint *spacePoint)
	calculate the Relation weight to be used (for SVD only, although method works with PXD as well!) More...

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.

Protected Attributes
std::string	m_PARAMoutputSuffix
	suffix that will be appended to the StoreArray names of the output StoreArrays

std::vector< std::string >	m_PARAMtrueHitNames
	names of containers of TrueHits

std::vector< std::string >	m_PARAMspacePointNames
	names of containers of SpacePoints

std::vector< std::string >	m_PARAMdetectorTypes
	detector type names as strings to determine which name belongs to which detector type

std::vector< std::string >	m_PARAMclusterNames
	names of containers of Clusters

std::vector< std::string >	m_PARAMrootFileName
	name and update status of root file

bool	m_PARAMstoreSeparate
	switch for storing the SpacePoints that can be related to a TrueHit into separate StoreArrays, where only such SpacePoints are stored

bool	m_PARAMregisterAll
	switch for registereing all relations for all TrueHits for all SpacePoints (there can be more than 1 related TrueHit to each SpacePoint). More...

bool	m_PARAMpositionAnalysis
	switch for doing the analysis of positions of SpacePoints and TrueHits

bool	m_PARAMrequirePrimary
	require the TrueHit to be related to a primary particle in order for the relation to get registered!

bool	m_PARAMrequireProximity
	require the TrueHit to be close to the SpacePoint. More...

double	m_PARAMmaxGlobalDiff
	maximum difference of global position coordinates for each direction between TrueHit and SpacePoint

double	m_PARAMmaxPosSigma
	defining th maximum difference of local coordinates in units of PitchSize / sqrt(12)

double	m_PARAMminWeight
	define a minimal weight a relation between Cluster and TrueHit. More...

unsigned int	m_nContainers
	number of passed containers -> storing the size of an input vector for not having to obtain it every time

std::vector< e_detTypes >	m_detectorTypes
	storing the detector types for each container in vector, needed in initialize

Belle2::StoreArray< Belle2::SVDTrueHit >	m_SVDTrueHits
	SVDTrueHits StoreArray used throughout the module.

Belle2::StoreArray< Belle2::PXDTrueHit >	m_PXDTrueHits
	PXDTrueHits StoreArray used throughout the module.

Belle2::StoreArray< Belle2::PXDCluster >	m_PXDClusters
	PXDTClusters StoreArray used throughout the module.

Belle2::StoreArray< Belle2::SVDCluster >	m_SVDClusters
	PXDClusters StoreArray used throughout the module.

std::vector< std::pair< Belle2::StoreArray< Belle2::SpacePoint >, e_detTypes > >	m_inputSpacePoints
	StoreArray of all input SpacePoints.

std::vector< Belle2::StoreArray< Belle2::SpacePoint > >	m_outputSpacePoints
	StoreArray of all output SpacePoints.

double	m_maxGlobalDiff
	storing the squared value of m_PARAMmaxGlobalDiff here to not alter the parameter input

unsigned int	m_iCont
	'helper variable' needed to not have to pass one integer down to processSpacePoint only to have a handle in cases where an exception gets caught

RootVariables	m_rootVariables
	Root variables used for collecting data eventwise.

TFile *	m_rootFilePtr
	pointer to root file

TTree *	m_treePtr
	pointer to tree in root file

std::vector< unsigned int >	m_SpacePointsCtr
	Number of SpacePoints presented to the module.

std::vector< std::array< unsigned int, 5 > >	m_nRelTrueHitsCtr
	counting different numbers of related TrueHits (to a SpacePoint) with one variable

std::vector< unsigned int >	m_noClusterCtr
	Number of SpacePoints without relation to a Cluster (i.e. More...

std::vector< unsigned int >	m_regRelationsCtr
	Number of registered relations.

std::vector< unsigned int >	m_ghostHitCtr
	Number of SpacePoints that are considered ghost hits.

std::vector< unsigned int >	m_noTrueHitCtr
	Number of SpacePoints that contained a Cluster to which no TrueHit could be found (i.e. More...

std::vector< unsigned int >	m_rejectedRelsCtr
	Number of SpacePoints that were not related to a TrueHit (i.e. More...

unsigned int	m_weightTooSmallCtr
	Count the omitted relations because of a too small weight.

unsigned int	m_rejectedNoPrimaryCtr
	Count how many times a relation was rejected because TrueHit was not related to primary.

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.

Detailed Description

Module that tries to register a relation between SpacePoints and TrueHits, hence making some MC Information easily accesible for other modules working with SpacePoints (e.g.

SPTCReferee or GFTC2SPTCConverter).

As there is no direct relation between SpacePoints and TrueHits, the relations between SpacePoints and Clusters and the relations between Clusters and TrueHits are used to relate SpacePoints and TrueHits. In a first step all (unique) TrueHits that are related to all Clusters of a SpacePoint are collected (including the weight of the relation). It is then possible that there is more than one TrueHit after this.

If 'storeSeperate' is set to true a new StoreArray of SpacePoints is created for every input StoreArray of SpacePoints with the same name and the 'outputSuffix' appended to it. This can be useful to have a StoreArray of SpacePoints where only 'checked' SpacePoints are (e.g. without ghost hits) that can then be used to feed the GFTC2SPTCConverter for example. If it is set to false, the relations will get registered in the existing StoreArray.
If 'registerAll' is set to true, the module simply registers a relation to all of these TrueHits. The weight of this new built relation encodes the information which Clusters of the SpacePoint where related to this TrueHit. ++ for PXD it is always 1, since these SpacePoints have only one underlying Cluster ++ for SVD it is 2 if it is a double Cluster SpacePoint and both Clusters have a relation to the TrueHit. It is 11 if only the U-Cluster has a relation to the TrueHit and it is 21 if only the V-Cluster has a relation to the TrueHit. This is also valid for single Cluster SpacePoints In this way the decision which TrueHit to use is left to the user. NOTE: The exact weight of the relations between Clusters and TrueHits is not stored, however the relations are registered in an order that the TrueHit with the heighest sum of weights is the first entry in the RelationVector (i.e. it should be th the one that is returned by SpacePoint::getRelatedTo<TrueHit>()).
If 'registerAll' is set to false, the module tries to find a relation to only one TrueHit: 1) If there is only one TrueHit -> check if all Clusters of the SpacePoint are related to this TrueHit -> if true -> register relation with weight holding the same information as explained above.
2) If there is more than one TrueHit but only one TrueHit has a relation to both Clusters of a SpacePoint -> register relation to this TrueHit (again the weight of the relation codes the information which clusters of the SpacePoint are related to the TrueHit)
3) If there is more than one TrueHit with a relation to all Clusters of a SpacePoint -> register relation to the TrueHit with the largest sum of weights (of relation between Clusters and TrueHits). Again the weight of the newly registered relation codes the above stated information
4) If the SpacePoint has only one Cluster (e.g. PXD) and there is more than one TrueHit -> register relation to the TrueHit with the largest weight (of relation between Cluster and TrueHit). The weight of the newly registered relation is 1,11 or 21 (depending on what Cluster is underlying the SpacePoint) in this case (as there is only one Cluster of such a SpacePoint related to the TrueHit)

NOTE: It is not guaranteed that every SpacePoint gets related to a TrueHit if 'registerAll' is set to false! E.g. 'ghost hits' should be sorted out. NOTE: Choosing the TrueHit with the biggest weight (or sum of weights) if there is more than one possible TrueHit does not guarantee that the 'right' TrueHit is chosen! It is possible that in such cases no relation will get registered in the future if this proves to be a source of errors! NOTE: in a previous version the weight of the registered relations was the sum of the weights. Now it encodes information on the relation between the SpacePoint and the Clusters as well. The Information on the absolute values of the weights (between Cluster and TrueHit)is lost, however the relative values are preserved and if there are more than one related TrueHits to a SpacePoint (only possible if 'registerAll' is set to true) the entries of the RelationVector of TrueHits are ordered from highest to lowest sum of weights. NOTE: This module should be used to connect SpacePoints and TrueHits if MC information is needed afterwards (e.g. in the SPTCRefereeModule for SpacePointTrackCands) to avoid having to look up the relations to obtain these informations seperately in every Module. Furthermore some modules are no longer able to determine the related TrueHits themselves (e.g. GFTC2SPTCConverter)

Definition at line 117 of file SpacePoint2TrueHitConnectorModule.h.

Member Enumeration Documentation

◆ e_detTypes

enum e_detTypes

protected

enum to distinguish the detectortypes

Enumerator
c_PXD	PXD.
c_SVD	SVD.

Definition at line 173 of file SpacePoint2TrueHitConnectorModule.h.

                     {
       c_PXD = Belle2::VXD::SensorInfoBase::PXD, 
       c_SVD = Belle2::VXD::SensorInfoBase::SVD, 
     };

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

◆ calculateRelationWeight()

double calculateRelationWeight	(	const TrueHitInfo &	trueHitInfo,
		Belle2::SpacePoint *	spacePoint
	)

protected

calculate the Relation weight to be used (for SVD only, although method works with PXD as well!)

if a TrueHit is related to both Clusters -> relation weight = 2
if a TrueHit is only related to the U-Cluster -> relation weight = 11 (this is what happens with if a PXD is passed!)
if a TrueHit is only related to the V-Cluster -> relation weight = 21

Definition at line 903 of file SpacePoint2TrueHitConnectorModule.cc.

 {
   bool isUAssigned = spacePoint->getIfClustersAssigned().first; // get if the Cluster in the SpacePoint is a U-Cluster
   // get if two Clusters are related to the Truehit (always false for single Cluster SPs
   bool bothClusters = trueHitInfo.m_U && trueHitInfo.m_V;
   // calculate the additional weight that identifies which Clusters are related to this TrueHit
   // 0 -> both Clusters have Relation to TrueHit, 10 -> only U-Cluster, 20 -> only V-Cluster has Relation to TrueHit
   short addWeight = 20 - (bothClusters ? 20 : isUAssigned ? 10 : 0);
  
   return addWeight + (bothClusters ? 2 : 1);
 }

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

◆ getClusterSizes()

std::pair< unsigned short int, unsigned short int > getClusterSizes	(	Belle2::SpacePoint *	spacePoint,
		e_detTypes	detType
	)

protected

get the sizes of the related Clusters of a SpacePoint

Returns: .first is U cluster size, .second is V cluster size

Definition at line 863 of file SpacePoint2TrueHitConnectorModule.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.

◆ getLocalError()

std::pair< double, double > getLocalError ( Belle2::SpacePoint * spacePoint )

protected

get the position error of SpacePoints in local coordinates

Returns: A pair of doubles. .first is U position error, .second is V position error

Definition at line 880 of file SpacePoint2TrueHitConnectorModule.cc.

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

◆ getRelatedTrueHits()

MapType getRelatedTrueHits	(	Belle2::SpacePoint *	spacePoint,
		std::string	clusterName = `"ALL"`,
		std::string	trueHitName = `"ALL"`
	)

protected

get all the related TrueHits to the SpacePoint, including their weights in a map (multimap!) where the StoreArray indices of the TrueHits are the keys and the values are TrueHitInfos to these indices MapType has to have key value pairs of pair<int,TrueHitInfo> throws: + NoTrueHitToCluster

NoSpacePointToCluster

Parameters

spacePoint	pointer to the SpacePoint of interest
clusterName	Name of the StoreArray of Clusters to be searched (defaults to "ALL")
trueHitName	Name of the StoreArray of TrueHits to be searched (defaults to "ALL")

Returns: multimap containing the related TrueHitInfos

Definition at line 330 of file SpacePoint2TrueHitConnectorModule.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.

◆ getTHwithWeight()

std::pair< TrueHitType *, double > getTHwithWeight	(	const MapType &	aMap,
		Belle2::StoreArray< TrueHitType >	trueHits,
		Belle2::SpacePoint *	spacePoint,
		e_detTypes	detType
	)

protected

get the TrueHit from information that is stored in the map (conditions are checked in the following order):

if there is only one TrueHit in the map, return a pointer to it and as weight the information which Clusters of the SpacePoint are related to this TrueHit (1 -> PXD, 2 -> both Clusters, 11 -> only U-, 21 -> only V-Cluster)
if there is only one TrueHit in the map with two weights associated (and all other TrueHits have only one weight or there is no other TrueHit), return a pointer to it and the weight is 2
if there are more than one TrueHits with two weights associated, return the one with the biggest sum of weights (.second = 2)
if there are only TrueHits with one weight associated, return the one with the biggest weight ONLY if the SpacePoint is related to only one Cluster (e.g. PXD). .second is either 1 (PXD), 11 or 21 (U-/V-cluster SP) NOTE: as this method is rather specific, it is not very much templated! NOTE: the possible return of a nullptr pointer has to be handled!

Definition at line 627 of file SpacePoint2TrueHitConnectorModule.cc.

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

◆ positionAnalysis()

void positionAnalysis	(	Belle2::SpacePoint *	spacePoint,
		const MapType &	trueHitMap,
		const int &	index,
		e_detTypes	detType
	)

protected

Analyze the position of SpacePoints and corresponding TrueHits.

Parameters

spacePoint	pointer to the SpacePoint
trueHitMap	map with the information to the (possibly) related TrueHits
index	(StoreArray) index of the TrueHit to which the relation actually got registered (if < 0 it is assumed that all possible relations were registered)
detType	the detector type NOTE: if a relation is not registered because the combination TrueHit - SpacePoint is considered not compatible (can happen if 'requirePrimary' or 'requireProximity' is set to true this method does not now about this! This can lead to unexpected values for the relation status in the output file!) If there is time in the future this can be fixed such that the information on why the relation was declined is preserved until the output

Definition at line 523 of file SpacePoint2TrueHitConnectorModule.cc.

◆ processSpacePoint()

MapType processSpacePoint	(	Belle2::SpacePoint *	spacePoint,
		e_detTypes	detType
	)

protected

process a SpacePoint.

This is essentially a wrapper that handles the different types of Clusters and TrueHits and then calls getRelatedTrueHits(args) appropriately and returns the map that is created by that NOTE: could declare as const (after developement)

Returns: : empty map if something went wrong (i.e. exception), or map of TrueHit indices to weights if all was good

Definition at line 306 of file SpacePoint2TrueHitConnectorModule.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_noClusterCtr

std::vector<unsigned int> m_noClusterCtr

protected

Number of SpacePoints without relation to a Cluster (i.e.

counts how many times the NoClusterTrueHit exception gets thrown)

Definition at line 262 of file SpacePoint2TrueHitConnectorModule.h.

◆ m_noTrueHitCtr

std::vector<unsigned int> m_noTrueHitCtr

protected

Number of SpacePoints that contained a Cluster to which no TrueHit could be found (i.e.

counts how many times the NoTrueHitToCluster exception gets thrown)

Definition at line 269 of file SpacePoint2TrueHitConnectorModule.h.

◆ m_PARAMminWeight

double m_PARAMminWeight

protected

define a minimal weight a relation between Cluster and TrueHit.

Below this limit the relation will not be registered

Definition at line 223 of file SpacePoint2TrueHitConnectorModule.h.

◆ m_PARAMregisterAll

bool m_PARAMregisterAll

protected

switch for registereing all relations for all TrueHits for all SpacePoints (there can be more than 1 related TrueHit to each SpacePoint).

The module can be used to get all TrueHits for a SpacePoint and then the user can decide what to do with it.

Definition at line 209 of file SpacePoint2TrueHitConnectorModule.h.

◆ m_PARAMrequireProximity

bool m_PARAMrequireProximity

protected

require the TrueHit to be close to the SpacePoint.

What close means can be controlled by other module parameters

Definition at line 215 of file SpacePoint2TrueHitConnectorModule.h.

◆ m_rejectedRelsCtr

std::vector<unsigned int> m_rejectedRelsCtr

protected

Number of SpacePoints that were not related to a TrueHit (i.e.

getTHwithWeight returned nullptr)

Definition at line 272 of file SpacePoint2TrueHitConnectorModule.h.

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

tracking/modules/spacePointCreator/include/SpacePoint2TrueHitConnectorModule.h
tracking/modules/spacePointCreator/src/SpacePoint2TrueHitConnectorModule.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ e_detTypes

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ calculateRelationWeight()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getClusterSizes()

◆ getConditionPath()

◆ getFileNames()

◆ getLocalError()

◆ getName()

◆ getParamInfoListPython()

◆ getRelatedTrueHits()

◆ getReturnValue()

◆ getTHwithWeight()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ positionAnalysis()

◆ processSpacePoint()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_noClusterCtr

◆ m_noTrueHitCtr

◆ m_PARAMminWeight

◆ m_PARAMregisterAll

◆ m_PARAMrequireProximity

◆ m_rejectedRelsCtr