Module for converting genfit::TrackCands to SpacePointTrackCands. More...

#include <GFTC2SPTCConverterModule.h>

Inheritance diagram for GFTC2SPTCConverterModule:

Collaboration diagram for GFTC2SPTCConverterModule:

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

void	initialize () override
	initialize module (e.g. More...

void	event () override
	event: convert genfit::TrackCands to SpacePointTrackCands

void	terminate () override
	terminate: print some summary information on the processed events

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	conversionStatus { c_singleClusterSP = 1 , c_noFail = 0 , c_foundNoSpacePoint = -1 , c_foundNoTrueHit = -2 , c_unsuitableGFTC = -3 , c_unusedHits = -4 , c_nonSingleSP = -5 , c_noValidSP = -6 , c_lowNDF = -7 }
	enum for differentiating different reasons why a conversion failed negative values mean fail! More...

template<typename HitType >
using	HitInfo = std::pair< double, const HitType * >
	container used for storing information, that is then put into the SpacePointTrackCand

template<typename T >
using	flaggedPair = boost::tuple< bool, T, T >
	typdef, for avoiding having a vector<bool> and a vector<pair<T,T>>

Protected Member Functions
conversionStatus	getFailEnum (int intToConvert)
	get the enum representation of an integer

void	initializeCounters ()
	reset counters to 0 to avoid indeterministic behaviour

void	increaseFailCounter (conversionStatus status)
	increase the counter that 'belongs' to the conversionStatus

template<typename ClusterType >
void	increaseSkippedCounter (conversionStatus status, ClusterType *cluster)
	increase the appropriate counter variable if a Cluster is skipped (i.e. More...

void	markHitAsUsed (std::vector< flaggedPair< int > > &flaggedHitIDs, int hitToMark)
	mark a hit as used, i.e. More...

std::pair< const Belle2::SpacePointTrackCand, conversionStatus >	createSpacePointTC (const genfit::TrackCand *genfitTC)
	create a SpacePointTrackCand from the genfit::TrackCand More...

std::pair< Belle2::SpacePoint *, conversionStatus >	processTrackCandHit (genfit::TrackCandHit *hit, std::vector< flaggedPair< int > > &flaggedHitIDs, int iHit)
	process a TrackCandHit (i.e. More...

template<typename ClusterType , typename TrueHitType >
std::pair< Belle2::SpacePoint *, conversionStatus >	getSpacePoint (const ClusterType *cluster, std::vector< flaggedPair< int > > &flaggedHitIDs, int iHit, bool singleCluster, std::string arrayName="")
	templated version to get a SpacePoint from a Cluster More...

template<typename ClusterType >
std::pair< Belle2::SpacePoint *, conversionStatus >	findAppropriateSpacePoint (const Belle2::RelationVector< Belle2::SpacePoint > &spacePoints, std::vector< flaggedPair< int > > &flaggedHitIDs)
	given a RelationVector with SpacePoints in it, it tries to get the appropriate one (see main documentation of module) NOTE: marks hits as used! NOTE: if no appropriate SpacePoint can be found, returns a nullptr pointer! templated for easier handling of other ClusterTypes later, at the moment only SVDCluster needed! More...

std::pair< int, int >	checkExistAndValid (int clusterInd, int detID, std::vector< flaggedPair< int > > &flaggedHitIDs)
	check if the Cluster (of a SpacePoint) is valid and/or exists in a genfit::TrackCand More...

int	getAppropriateSpacePointIndex (const std::vector< std::pair< bool, bool > > &existAndValidSPs, const std::vector< std::pair< int, int > > &clusterPositions)
	get the position of the appropriate SpacePoint inside the RelationVector NOTE: returns negative index if no SpacePoint fitting the criteria can be found!

template<typename ClusterType >
std::vector< int >	getClusterIndices (const Belle2::SpacePoint *spacePoint, std::string storeArrayName)
	get the indices of the Clusters related to the SpacePoint. More...

int	getNDF (Belle2::SpacePoint *spacePoint)
	get the NDF of a SpacePoint

bool	checkUsedAllHits (std::vector< flaggedPair< int > > &flaggedHitIDs)
	check if all hits have been used (i.e. More...

template<typename TrueHitType >
bool	foundRelatedTrueHit (const Belle2::SpacePoint *spacePoint, unsigned int allowedRelations=1)
	check if there is a related TrueHit for a given SpacePoint. More...

	BELLE2_DEFINE_EXCEPTION (UnusedHits, "Not all hits of the genfit::TrackCand have been marked as used. This indicates that not all hits have been used to create a SpacePointTrackCand.")
	Exception thrown, when not all hits of a genfit::TrackCand have been used for conversion.

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_PXDClusterName
	PXDCluster collection name.

std::string	m_SVDClusterName
	SVDCluster collection name.

std::string	m_SingleClusterSVDSPName
	Single Cluster SVD SpacePoints collection name.

std::string	m_NoSingleClusterSVDSPName
	Non SingleCluster SVD SpacePoints collection name.

std::string	m_PXDClusterSPName
	PXDCluster SpacePoints collection name.

std::string	m_genfitTCName
	Name of collection of genfit::TrackCand StoreArray.

std::string	m_SPTCName
	Name of collection under which SpacePointTrackCands will be stored in the StoreArray.

bool	m_PARAMcheckTrueHits
	Parameter Indicating if the TrueHits related from the Clusters forming a SpacePoint should be checked for equality.

bool	m_PARAMuseSingleClusterSP
	Parameter Indicating if SingleCluster SVD SpacePoints should be used if no double Cluster SVD SpacePoint can be found.

bool	m_PARAMcheckNoSingleSVDSP
	Switch for checking the StoreArray of non-single cluster SVD SpacePoints in initialize. More...

bool	m_PARAMskipCluster
	Switch for controlling the behavior of the converter, when for one or more Clusters no appropriate SpacePoint can be found.

int	m_PARAMminNDF
	parameter for specifying a minimal number of degrees of freedom a SpacePointTrackCand has to have in order to be registered in the DataStore

unsigned int	m_SpacePointTCCtr
	Counter for SpacePointTrackCands which were converted (if a curling track is split up, this counter will still be only increased by 1!)

unsigned int	m_genfitTCCtr
	Counter for genfit::TrackCands which were presented to the module.

unsigned int	m_abortedTrueHitCtr
	Counting discarded conversions due to check for TrueHits not good.

unsigned int	m_abortedUnsuitableTCCtr
	Counter for aborted conversions due to unsuitable genfit::TrackCand.

unsigned int	m_abortedNoSPCtr
	Counter for aborted conversions because no SpacePoint has been found.

unsigned int	m_noTwoClusterSPCtr
	Counter for cases where no related two Cluster could be found for a Cluster. More...

unsigned int	m_abortedLowNDFCtr
	Counter for SpacePointTrackCands that were not stored due to a too small number of degrees of freedom.

unsigned int	m_skippedPXDnoSPCtr
	Counter for skipped PXD Clusters, due to no found SpacePoint.

unsigned int	m_skippedPXDnoTHCtr
	Counter for skipped PXD Clusters, due to no related TrueHit to a SpacePoint.

unsigned int	m_skippedSVDnoSPCtr
	Counter for skipped SVD Clusters, due to no found SpacePoint.

unsigned int	m_skippedSVDnoTHCtr
	Counter for skipped SVD Clusters, due to no related TrueHit to a SpacePoint.

unsigned int	m_singleClusterSPCtr
	Counter for single cluster SVD SpacePoints.

unsigned int	m_abortedMiscCtr
	temporary counter used for counting all failed conversions for which the reason cannot be deduced at the moment

unsigned int	m_skippedCluster
	Counter for skipped Cluster.

unsigned int	m_skippedPXDunsuitableCtr
	Counter for skipped PXD Clusters due to unsuitable GFTC. More...

unsigned int	m_skippedSVDunsuitableCtr
	Counter for skipped SVD Clusters due to unsuitable GFTC.

unsigned int	m_skippedPXDnoValidSPCtr
	Counter for skipped PXD Clusters due to no found valid SpacePoint. More...

unsigned int	m_skippedSVDnoValidSPCtr
	Counter for skipped SVD Clusters due to no found valid SpacePoint.

unsigned int	m_nonSingleSPCtr
	Counter for cases where there is more than one single Cluster SpacePoint related to a Cluster.

unsigned int	m_abortedNoValidSPCtr
	Counter for aborted conversions due to no found valid SpacePoint to any Cluster of the GFTC.

std::string	svdMainArrayName
	Name of the Array of SVD SpacePoints that shall be searched first.

int	m_NDF
	number of degrees of freedom. More...

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
StoreArray< PXDCluster >	m_PXDClusters
	PXDClusters StoreArray.

StoreArray< SVDCluster >	m_SVDClusters
	SVDClusters StoreArray.

StoreArray< SpacePoint >	m_SingleClusterSpacePoints
	SVD SpacePoints StoreArray only consisting of one SVDCluster.

StoreArray< SpacePoint >	m_NoSingleClusterSpacePoints
	SVD SpacePoints StoreArray consisting of two SVDClusters.

StoreArray< SpacePoint >	m_PXDSpacePoints
	PXDSpacePoints StoreArray.

StoreArray< genfit::TrackCand >	m_GenfitTrackCands
	Genfit::TrackCand StoreArray.

StoreArray< SpacePointTrackCand >	m_SpacePointTrackCands
	SpacePointTrackCands StoreArray.

StoreArray< PXDTrueHit >	m_PXDTrueHits
	PXDTrueHits StoreArray.

StoreArray< SVDTrueHit >	m_SVDTrueHits
	SVDTrueHits StoreArray.

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 for converting genfit::TrackCands to SpacePointTrackCands.

NOTE: requires:

a StoreArray with PXD only SpacePoints
a StoreArray with SVD SpacePoints, where only SpacePoints with a U & a V Cluster are present
a StoreArray with SVD SpacePoints, where every Cluster has its own SpacePoint (if 'useSingleClusterSP' is set to true)

Intended Behaviour: The Module takes a genfit::TrackCand and converts it to a SpacePointTrackCand by taking the TrackCandHits of the TrackCand and searching the DataStore for the according Clusters and then look for Relations of these Clusters to SpacePoints (without loosing any information of the genfit::TrackCand, such that every hit in the genfit::TrackCand can be found in a SpacePoint in the SpacePointTrackCand). Employing a somewhat sloppy notation below regarding Clusters and TrackCandHits, since they are essentially the same for this Module.

NOTE: There are cases where the conversion cannot be done properly, in this case the genfit::TrackCand is skipped and will not be converted (by default, there are parameters that can change this behavior to only skip problematic Clusters)! Problems only occur, when a Cluster is not unambiguously related to a SpacePoint (i.e. a Cluster is related to more than one SpacePoint), because:

the decision which SpacePoint to use is not trivial in most cases. If no well defined decision can be made, the TrackCand will be skipped (see below how this decision is made, and when it is considered 'well defined')
If no decision can be made and every SpacePoint would be added, problems would only be postponed to the conversion of SpacePointTrackCand to genfit::TrackCand, where it is even harder to decide what is right and what is wrong.
To have a handle later on SpacePointTrackCands now have some flags to check what problems occured during conversion

Some statements on how the module works for a given (SVD) Cluster (TrackCandHit) 1) Check if the Cluster (TrackCandHit) has already been used (i.e. it is already contained in the SpacePointTrackCand via a SpacePoint). If not used 2) Get all SpacePoints (double Cluster) related to this Cluster 2.a) If no SpacePoints (double Cluster) can be found, add this Cluster via a single Cluster SpacePoint (should always be present, if not an exception is thrown, and the genfit::TrackCand is not converted). Mark this Cluster (TrackCandHit) as used and go to next Cluster (TrackCandHit) 3) For every SpacePoint (double Cluster) related to the original Cluster, get all Clusters related from this SpacePoint 4) For every SpacePoint (from 3) check if its Cluster combination is valid (i.e. both Clusters are contained in the genfit::TrackCand and neither of these Clusters has been used by another SpacePoint) and also check if its Cluster combination is not valid, but existing (i.e. both Clusters are contained in the genfit::TrackCand but one has already been used by another SpacePoint) 5) If ONLY ONE SpacePoint has a valid Cluster Combination, check if its Clusters appear in consecutive order in the genfit::TrackCand, if they do -> take this SpacePoint, mark the Clusters (TrackCandHits) as used, proceed with next TrackCandHit. If they do not appear in consecutive order -> throw an exception (this SpacePointTrackCand cannot be converted back to a genfit::TrackCand properly) 6) If more than SpacePoint has a valid Cluster Combination -> check if there is a SpacePoint with consecutive Clusters in the genfit::TrackCand ('normally' there is a Cluster Combination, that is in consecutive order in the genfit::TrackCand) and mark its Clusters as used, proceed with next TrackCandHit, if all valid SpacePoints have Cluster Combinations that do not appear in consecutive order -> throw 7) If no valid SpacePoint can be found, but SpacePoints with existing (but used) Cluster Combinations can be found, an exception is thrown and the genfit::TrackCand will not be converted, since the conversion would get ambiguous then (this happens in roughly 1 - 2 % of all cases) 8) If no valid SpacePoint can be found and no SpacePoint with existing (but used) Cluster Combinations, this Cluster will be added via a single Cluster SpacePoint (and then be marked as used) if this feature is activated by parameter 'useSingleClusterSP'

If no SpacePoint can be found for any Cluster in the genfit::TrackCand, an exception is thrown, and the conversion is skipped.

If 'checkTrueHits' is enabled the module only checks the DataStore if there is an existing relation to a TrueHit. Depending on the parameters the conversion of the genfit::TrackCand is aborted or only the Cluster is skipped from Conversion. (The registering of the relation has to be done with the SpacePoint2TrueHitConnector)

TODO: clean-up and bring in line with coding conventions!

Definition at line 68 of file GFTC2SPTCConverterModule.h.

Member Enumeration Documentation

◆ conversionStatus

enum conversionStatus

protected

enum for differentiating different reasons why a conversion failed negative values mean fail!

Enumerator
c_singleClusterSP	had to use a singleCluster SpacePoint (also returned if PXD is passed!
c_noFail	conversion without any problems
c_foundNoSpacePoint	conversion failed because no related SpacePoint was found to a Cluster/Hit of the GFTC
c_foundNoTrueHit	conversion failed because there was no related SpacePoint to a TrueHit
c_unsuitableGFTC	conversion failed because the GFTC is considered not suitable for conversion
c_unusedHits	conversion failed because there were unused Hits
c_nonSingleSP	conversion failed because there were more than one single Cluster SpacePoints related to a Cluster
c_noValidSP	conversion failed because there was no valid SpacePoint (only possible for double Cluster SpacePoints) SpacePoints
c_lowNDF	conversion failed because the created SpacePointTrackCand had not enough degrees of freedom

Definition at line 87 of file GFTC2SPTCConverterModule.h.

                           {
       c_singleClusterSP = 1, 
       c_noFail = 0, 
       c_foundNoSpacePoint = -1, 
       c_foundNoTrueHit = -2, 
       c_unsuitableGFTC = -3, 
       c_unusedHits = -4, 
       c_nonSingleSP = -5, 
       c_noValidSP = -6, 
       c_lowNDF = -7, 
     };

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

◆ checkExistAndValid()

std::pair< int, int > checkExistAndValid	(	int	clusterInd,
		int	detID,
		std::vector< flaggedPair< int > > &	flaggedHitIDs
	)

protected

check if the Cluster (of a SpacePoint) is valid and/or exists in a genfit::TrackCand

Parameters

clusterInd	index of Cluster to be checked in StoreArray
detID	detector id
flaggedHitIDs	(detId, hitId) of genfit::TrackCand with flag if hit has already been used

Returns: first is validPos, .second is existingPos, if one is not found a negative number is returned!

Definition at line 437 of file GFTC2SPTCConverterModule.cc.

 {
   B2DEBUG(29, "Now checking if Cluster " << clusterInd << " is valid");
   std::pair<int, int> positions = { -1, -1}; // return Vector
  
   // flaggedPair for finding valid IDs: hit is in genfit::TrackCand and has not yet been used by another SpacePoint
   flaggedPair<int> validID(false, detID, clusterInd);
   flaggedPair<int> existingID(true, detID, clusterInd); // flaggedPair for finding existing but used fHitIDs
  
   // find the positions of these two pairs in flaggedHitIDs
   // position in "normal array indexing" (i.e. starting at 0, ending at vector.size() -1 )
   unsigned int validPos =  std::find(flaggedHitIDs.begin(), flaggedHitIDs.end(), validID) - flaggedHitIDs.begin();
   unsigned int existingPos = std::find(flaggedHitIDs.begin(), flaggedHitIDs.end(), existingID) - flaggedHitIDs.begin();
  
   B2DEBUG(22, "validID = (" << validID.get<1>() << "," << validID.get<2>() << "), found at position " << validPos <<
           ", existingID found at position " << existingPos << " of " << flaggedHitIDs.size());
  
   // check if these positions are still in the TrackCand
   if (validPos < flaggedHitIDs.size()) { positions.first = validPos; }
   if (existingPos < flaggedHitIDs.size()) { positions.second = existingPos; }
  
   B2DEBUG(29, "Return values, .first: " << positions.first << ", .second: " << positions.second);
   return positions;
 }

◆ checkUsedAllHits()

bool checkUsedAllHits ( std::vector< flaggedPair< int > > & flaggedHitIDs )

protected

check if all hits have been used (i.e.

if all flags in the vector of flaggedPairs is set to true)

Definition at line 533 of file GFTC2SPTCConverterModule.cc.

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

◆ createSpacePointTC()

std::pair< const Belle2::SpacePointTrackCand, GFTC2SPTCConverterModule::conversionStatus > createSpacePointTC ( const genfit::TrackCand * genfitTC )

protected

create a SpacePointTrackCand from the genfit::TrackCand

Returns: first is the SPTC, .second is the conversion status, if < 0, something went wrong

Definition at line 186 of file GFTC2SPTCConverterModule.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.

◆ findAppropriateSpacePoint()

std::pair< Belle2::SpacePoint *, GFTC2SPTCConverterModule::conversionStatus > findAppropriateSpacePoint	(	const Belle2::RelationVector< Belle2::SpacePoint > &	spacePoints,
		std::vector< flaggedPair< int > > &	flaggedHitIDs
	)

protected

given a RelationVector with SpacePoints in it, it tries to get the appropriate one (see main documentation of module) NOTE: marks hits as used! NOTE: if no appropriate SpacePoint can be found, returns a nullptr pointer! templated for easier handling of other ClusterTypes later, at the moment only SVDCluster needed!

Returns: first is a pointer to the appropriate SpacePoint, .second is the conversion status, if this is <0 .first is nullptr! (i.e. check .second first)

Definition at line 352 of file GFTC2SPTCConverterModule.cc.

◆ foundRelatedTrueHit()

bool foundRelatedTrueHit	(	const Belle2::SpacePoint *	spacePoint,
		unsigned int	allowedRelations = `1`
	)

protected

check if there is a related TrueHit for a given SpacePoint.

Possibility to pass an optional argument on the maximum number of allowed relations (defautls to 1)

Definition at line 551 of file GFTC2SPTCConverterModule.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.

◆ getClusterIndices()

std::vector< int > getClusterIndices	(	const Belle2::SpacePoint *	spacePoint,
		std::string	storeArrayName
	)

protected

get the indices of the Clusters related to the SpacePoint.

size of returned vector is <= 2! NOTE: only the StoreArray of Clusters with name storeArrayName will be searched!

Definition at line 418 of file GFTC2SPTCConverterModule.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.

◆ getSpacePoint()

std::pair< Belle2::SpacePoint *, GFTC2SPTCConverterModule::conversionStatus > getSpacePoint	(	const ClusterType *	cluster,
		std::vector< flaggedPair< int > > &	flaggedHitIDs,
		int	iHit,
		bool	singleCluster,
		std::string	arrayName = `""`
	)

protected

templated version to get a SpacePoint from a Cluster

Parameters

cluster	type of cluster
flaggedHitIDs	(detId, hitId) of genfit::TrackCand with flag if hit has already been used
iHit	index of hit
arrayName	name of the StoreArray to be searched, defaults to empty string
singleCluster	singleCluster SpacePoint? (Can probably be done in another way as well) NOTE: returns nullptr if no (appropriate) SpacePoint can be found!

Returns: first is a pointer to the SpacePoint, .second is the status, if this is < 0, .first is nullptr! (i.e. check .second first!) get the SpacePoint related to a Cluster

Definition at line 300 of file GFTC2SPTCConverterModule.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.

◆ increaseSkippedCounter()

void increaseSkippedCounter	(	conversionStatus	status,
		ClusterType *	cluster
	)

inlineprotected

increase the appropriate counter variable if a Cluster is skipped (i.e.

only called if 'skipClusters' is set to true!) WARNING: decides which counter to increase (i.e. which ClusterType) via the layerNumber (hardcoded values!)

Definition at line 239 of file GFTC2SPTCConverterModule.h.

◆ initialize()

void initialize ( void )

overridevirtual

initialize module (e.g.

check if all required StoreArrays are present or registering new StoreArrays)

Reimplemented from Module.

Definition at line 65 of file GFTC2SPTCConverterModule.cc.

◆ markHitAsUsed()

void markHitAsUsed	(	std::vector< flaggedPair< int > > &	flaggedHitIDs,
		int	hitToMark
	)

protected

mark a hit as used, i.e.

change its boolean value to true. Code readability reasons mainly, Output hardcoded to debug level 150

Definition at line 565 of file GFTC2SPTCConverterModule.cc.

◆ processTrackCandHit()

std::pair< Belle2::SpacePoint *, GFTC2SPTCConverterModule::conversionStatus > processTrackCandHit	(	genfit::TrackCandHit *	hit,
		std::vector< flaggedPair< int > > &	flaggedHitIDs,
		int	iHit
	)

protected

process a TrackCandHit (i.e.

do the handling of the different ClusterTypes), this is essentially nothing more than a wrapper, that directly returns whats returned from getSpacePoint(args) that is called within!

Definition at line 273 of file GFTC2SPTCConverterModule.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_NDF

int m_NDF

protected

number of degrees of freedom.

counted during creation of SpacePointTrackCand

Definition at line 272 of file GFTC2SPTCConverterModule.h.

◆ m_noTwoClusterSPCtr

unsigned int m_noTwoClusterSPCtr

protected

Counter for cases where no related two Cluster could be found for a Cluster.

NOTE: Counter counts cases where there really was no SpacePoint for a Cluster but does not count the cases where a found two Cluster SP was rejected later on in the process!

Definition at line 154 of file GFTC2SPTCConverterModule.h.

◆ m_PARAMcheckNoSingleSVDSP

bool m_PARAMcheckNoSingleSVDSP

protected

Switch for checking the StoreArray of non-single cluster SVD SpacePoints in initialize.

Need this for cases, where only single Cluster SVD SpacePoints are presented to the module

Definition at line 135 of file GFTC2SPTCConverterModule.h.

◆ m_skippedPXDnoValidSPCtr

unsigned int m_skippedPXDnoValidSPCtr

protected

Counter for skipped PXD Clusters due to no found valid SpacePoint.

NOTE: this can actually not happen

Definition at line 180 of file GFTC2SPTCConverterModule.h.

◆ m_skippedPXDunsuitableCtr

unsigned int m_skippedPXDunsuitableCtr

protected

Counter for skipped PXD Clusters due to unsuitable GFTC.

NOTE: this can actually not happen

Definition at line 175 of file GFTC2SPTCConverterModule.h.

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

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

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

◆ conversionStatus

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ checkExistAndValid()

◆ checkUsedAllHits()

◆ clone()

◆ createSpacePointTC()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ findAppropriateSpacePoint()

◆ foundRelatedTrueHit()

◆ getAfterConditionPath()

◆ getClusterIndices()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getSpacePoint()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ increaseSkippedCounter()

◆ initialize()

◆ markHitAsUsed()

◆ processTrackCandHit()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_NDF

◆ m_noTwoClusterSPCtr

◆ m_PARAMcheckNoSingleSVDSP

◆ m_skippedPXDnoValidSPCtr

◆ m_skippedPXDunsuitableCtr