SpacePoint2TrueHitConnectorModule Class Reference

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:

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.
virtual void	beginRun ()
	Called when entering a new run.
virtual void	endRun ()
	This method is called if the current run ends.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static 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 More...
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):
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
template<typename MapType >
MapType	processSpacePoint (Belle2::SpacePoint *spacePoint, e_detTypes detType)
	process a SpacePoint.
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.
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
std::pair< double, double >	getLocalError (Belle2::SpacePoint *spacePoint)
	get the position error of SpacePoints in local coordinates
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!)
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

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).
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.
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.
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.
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.
std::vector< unsigned int >	m_rejectedRelsCtr
	Number of SpacePoints that were not related to a TrueHit (i.e.
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.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

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

baseMapT

typedef std::unordered_map<int, TrueHitInfo> baseMapT

protected

typedef for shorter notation throughout the module

Definition at line 168 of file SpacePoint2TrueHitConnectorModule.h.

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.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, 
    };

e_relationStatus

enum e_relationStatus

protected

enum for better code readability

Definition at line 179 of file SpacePoint2TrueHitConnectorModule.h.

                          {
      c_clearHit = 1, //< bit 0: Only one TrueHit to SpacePoint
      c_ghostHit = 2, //< bit 1: ghost hit as described in this module
      c_SpacePointU = 4, //< bit 2: SpacePoint U-coordinate is set
      c_SpacePointV = 8, //< bit 3: SpacePoint V-coordinate is set
      c_primaryParticle = 16, //< bit 4: Particle related to TrueHit is primary
      c_bgParticle = 32, //< bit 5: particle related to TrueHit is background
      c_nonUniqueRelation = 64, //< bit 6: more than one TrueHit related to SpacePoint
      c_registeredRelation = 128, //< bit 7: this relation got registered
      c_noiseCluster = 256, //< bit 8: one of the Clusters has no relation to a TrueHit (i.e. is noise) -> only for twoCluster SPs!
    }; // end e_relationStatus

EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

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

Constructor & Destructor Documentation

SpacePoint2TrueHitConnectorModule()

SpacePoint2TrueHitConnectorModule

(

)

Constructor.

Definition at line 35 of file SpacePoint2TrueHitConnectorModule.cc.

                                                                     :
  Module()
{
  setDescription("Module that tries to find the appropriate TrueHit to each SpacePoint and to register a relation between them for making MC information for SpacePoints more easily accesible for Modules that need it. Module can also be used to filter out 'fishy' SpacePoints.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("storeSeperate", m_PARAMstoreSeparate,
           "Set to false if you do not want to create seperate StoreArrays for processed SpacePoints. (i.e. a relation from SpacePoint to TrueHit will be set in the passed StoreArray. NOTE: this StoreArray will contain SpacePoints with a relation to TrueHits and such without after this module). The Names of the output StoreArrays will be the names of the input StoreArrays with 'outputSuffix' (module parameter) appended to them",
           true);
 
  addParam("registerAll", m_PARAMregisterAll,
           "If set to true, the module simply registers a relation for all TrueHits that are related to a SpacePoint (resp. its Clusters). In this way the module can be used to find all related TrueHits and then the user can decide what to do with these TrueHits (otherwise this module does some decision making). Setting this to true means that all checks (e.g. 'minWeight', 'maxPosSigma', ...) are ommitted! NOTE that some of the information is lost in this way (e.g. how many of the Clusters of a SpacePoint have been related to a TrueHit)!",
           false);
 
  addParam("positionAnalysis", m_PARAMpositionAnalysis,
           "Analyze the positions of SpacePoints and corresponding TrueHits. NOTE: if enabled a root file gets created!", false);
 
  addParam("requirePrimary", m_PARAMrequirePrimary,
           "Set to true if only relations to TrueHits that are related to a primary particle should get registered.", false);
 
  addParam("requireProximity", m_PARAMrequireProximity,
           "Require that the TrueHit is close to the SpacePoint (in local coordinates). The meaning of 'close' can be defined with the parameters 'maxPosSigma' and 'maxGlobalPosDiff'.",
           true);
 
  std::vector<std::string> defaultInList; // default list for input StoreArrays
  defaultInList.push_back(std::string(""));
  addParam("TrueHitNames", m_PARAMtrueHitNames,
           "Container names of TrueHits. NOTE: need one name per 'DetectorType' (i.e. unique entries in 'DetectorType)!", defaultInList);
  addParam("SpacePointNames", m_PARAMspacePointNames, "Container names of SpacePoints.", {"SVDSpacePoints", "PXDSpacePoints"});
  addParam("DetectorTypes", m_PARAMdetectorTypes,
           "detector types to determine which entries in 'TrueHitNames' and 'SpacePointNames' belong to which detector type. Entries have to be 'SVD' or 'PXD'. NOTE: if more 'SpacePointNames' than 'DetectorTypes' get passed, the last entry in 'DetectorTypes' is assumed to be valid for all remaining 'SpacePointNames'!");
  addParam("ClusterNames", m_PARAMclusterNames,
           "Container names of Clusters. NOTE: need one name per 'DetectorType' (i.e. unique entries in 'DetectorType')!", defaultInList);
 
  std::vector<std::string> defaultRootFName = { "PositionAnalysis", "RECREATE" };
  addParam("rootFileName", m_PARAMrootFileName,
           "Filename and write-mode ('RECREATE' or 'UPDATE'). If given more than 2 strings this module will cause termination",
           defaultRootFName);
 
  addParam("outputSuffix", m_PARAMoutputSuffix,
           "Suffix that will be appended to the container names if 'storeSeperate' is set to true", std::string("_relTH"));
 
  addParam("maxGlobalPosDiff", m_PARAMmaxGlobalDiff,
           "max difference of global position coordinates between TrueHit and SpacePoint (in each direction) in cm.", 0.05);
//   addParam("maxLocalPosDiff", m_PARAMmaxLocalDiff, "max difference of local position coordinates between TrueHit and SpacePoint (in U & V direction) in cm. NOTE: the default value is still subject to tuning and finding the appropriate value!", 0.01);
 
  addParam("maxPosSigma", m_PARAMmaxPosSigma, "Define the maximum local position difference in units of PitchSize / sqrt(12).", 4.);
  addParam("minWeight", m_PARAMminWeight,
           "Define a minimal weight a relation between a Cluster and a TrueHit has to have for the TrueHit to be considered as possible candidate.",
           0.);
 
  // initialize all counters
  initializeCounters();
  m_rootFilePtr = nullptr;
  m_treePtr = nullptr;
 
  if (m_PARAMpositionAnalysis == true and Environment::Instance().getNumberProcesses() > 0) {
    B2WARNING(
      "SpacePoint2TrueHitConnector::initialize: parameter positionAnalysis (and therefore root-output) is enabled and basf2 is running in multi-threaded mode - this can cause nondeterministic behavior! "
      << "\n"
      << " you can suppress multi-threading for this module by writing:"
      << "\n"
      << "main.add_module('SpacePoint2TrueHitConnector').set_property_flags(0) "
      << "\n"
      << "into the steering file!");
  }
}

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.

Reimplemented in ARICHBackgroundModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, EventsOfDoomBusterModule, CosmicsAlignmentValidationModule, EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageSerializerModule, IPDQMModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, EvtGenDecayModule, EvtGenInputModule, OverrideGenerationFlagsModule, KKGenInputModule, CreateFieldMapModule, ExportGeometryModule, SoftwareTriggerModule, SoftwareTriggerHLTDQMModule, StatisticsTimingHLTDQMModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterAnaModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, PXDBackgroundModule, PXDRawDQMChipsModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDClusterizerModule, Convert2RawDetModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0DQMModule, EventT0ValidationModule, DataWriterModule, ECLExpertModule, KLMExpertModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, MaterialScanModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, SVDDQMHitTimeModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDMissingAPVsClusterCreatorModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDDigitizerModule, SVDEventInfoSetterModule, SVDTriggerQualityGeneratorModule, SVDSpacePointCreatorModule, SVDTimeGroupingModule, SVDUnpackerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPChannelT0MCModule, TOPDigitizerModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTimeRecalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, DQMHistoModuleBase, SVDEventT0EstimatorModule, ExtModule, FlipQualityModule, BeamSpotMonitorModule, KinkFinderModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, PXDROIFinderModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TrackQualityEstimatorMVAModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, QualityEstimatorVXDModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, SectorMapBootstrapModule, SegmentNetworkProducerModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, CDCTriggerTSFModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, CDCTriggerUnpackerModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, VXDMisalignmentModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, DAQMonitorModule, DelayDQMModule, V0ObjectsDQMModule, ECLDQMInjectionModule, PyModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDDAQDQMModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDRawDQMCorrModule, PXDRawDQMModule, PXDROIDQMModule, PXDTrackClusterDQMModule, PXDDigitizerModule, PXDPackerModule, PXDUnpackerModule, TTDDQMModule, SVDDQMClustersOnTrackModule, SVDDQMDoseModule, SVDDQMExpressRecoModule, SVDDQMInjectionModule, SVDUnpackerDQMModule, PXDclusterFilterModule, PXDdigiFilterModule, PXDROIFinderAnalysisModule, TrackingAbortDQMModule, VXDDQMExpressRecoModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisTRGModule, DQMHistInjectionModule, and DQMHistOutputToEPICSModule.

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.

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

closeRootFile()

void closeRootFile ( )

protected

close root file

Definition at line 852 of file SpacePoint2TrueHitConnectorModule.cc.

{
  if (m_treePtr != nullptr && m_rootFilePtr != nullptr) {
    m_rootFilePtr->cd(); //important! without this the famework root I/O (SimpleOutput etc) could mix with the root I/O of this module
//     m_treePtr->Write(); // using TTree::Write() instead, which calls this any way
    m_rootFilePtr->Write();
    m_rootFilePtr->Close();
  }
}

compatibleCombination()

bool compatibleCombination ( Belle2::SpacePoint *  spacePoint, TrueHitType *  trueHit  )

protected

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!

Definition at line 701 of file SpacePoint2TrueHitConnectorModule.cc.

{
  B2DEBUG(25, "Checking TrueHit " << trueHit->getArrayIndex() << " from Array " << trueHit->getArrayName() << " and SpacePoint " <<
          spacePoint->getArrayIndex() << " from Array " << spacePoint->getArrayName() << " for compatibility");
 
  // check primary first
  MCParticle* mcPart = trueHit->template getRelatedFrom<MCParticle>("ALL");
  bool primaryPart = false; // assume secondary or background for safety
  if (mcPart != nullptr) primaryPart = mcPart->hasStatus(MCParticle::c_PrimaryParticle);
  if (m_PARAMrequirePrimary && !primaryPart) {
    B2DEBUG(25, "TrueHit is not related to a primary particle but 'requirePrimary' is set to true!");
    m_rejectedNoPrimaryCtr++;
    return false;
  }
 
  // CAUTION: if further tests are added, make sure that they do not get 'over-ruled' by this one (i.e. put before this if)
  if (!m_PARAMrequireProximity) {
    B2DEBUG(29, "Not checking positions because 'requireProximity' is set to false");
    return true;
  }
  const VxdID spacePointVxdId = spacePoint->getVxdID();
  const VxdID trueHitVxdId = trueHit->getSensorID();
 
  B2DEBUG(29, "Comparing the VxdIDs, SpacePoint: " << spacePointVxdId << ", TrueHit: " << trueHitVxdId);
  if (spacePointVxdId != trueHitVxdId) {
    B2DEBUG(25, "SpacePoint and TrueHit do not have the same VxdID. spacePoint: " << spacePointVxdId << ", trueHit: " << trueHitVxdId);
    return false;
  }
 
  VXD::SensorInfoBase SensorInfoBase = VXD::GeoCache::getInstance().getSensorInfo(
                                         trueHitVxdId); // only have to get one, since VxdIds are already the same at this point!
  double maxUres = SensorInfoBase.getUPitch(trueHit->getV()) / sqrt(12.) * m_PARAMmaxPosSigma;
  double maxVres = SensorInfoBase.getVPitch(trueHit->getV()) / sqrt(12.) * m_PARAMmaxPosSigma;
 
  B2DEBUG(29, "maximum residual in U: " << maxUres << ", in V: " << maxVres);
 
  const ROOT::Math::XYZVector trueHitLocalPos = ROOT::Math::XYZVector(trueHit->getU(), trueHit->getV(), 0);
  const ROOT::Math::XYZVector trueHitGlobalPos = SensorInfoBase.pointToGlobal(trueHitLocalPos, true); // uses alignment
 
  std::pair<double, double> spacePointLocal = getLocalPos(spacePoint);
  // compare only those values of the local coordinates that have been set
  std::pair<bool, bool> setCoordinates = spacePoint->getIfClustersAssigned();
 
  if (setCoordinates.first) {
    B2DEBUG(29, "Comparing the U-coordinates, SpacePoint: " << spacePointLocal.first << ", TrueHit: " << trueHitLocalPos.X() <<
            " -> diff: " << spacePointLocal.first - trueHitLocalPos.X());
    if (pow(spacePointLocal.first - trueHitLocalPos.X(), 2) > maxUres * maxUres) {
      B2DEBUG(25, "The local position difference in U direction is " << spacePointLocal.first - trueHitLocalPos.X() <<
              " but maximum local position difference is set to: " << maxUres);
      return false;
    }
  }
  if (setCoordinates.second) {
    B2DEBUG(29, "Comparing the V-coordinates, SpacePoint: " << spacePointLocal.second << ", TrueHit: " << trueHitLocalPos.Y() <<
            " -> diff: " << spacePointLocal.second - trueHitLocalPos.Y());
    if (pow(spacePointLocal.second - trueHitLocalPos.Y(), 2) > maxVres * maxVres) {
      B2DEBUG(25, "The local position difference in V direction is " << spacePointLocal.second - trueHitLocalPos.Y() <<
              " but maximum local position difference is set to: " << maxVres);
      return false;
    }
  }
 
  // only if both local coordinates of a SpacePoint are set, compare also the global positions!
  if (setCoordinates.first && setCoordinates.second) {
    B2DEBUG(29, "Comparing the global positions, SpacePoint: (" << spacePoint->X() << "," << spacePoint->Y() << "," << spacePoint->Z()
            << "), TrueHit:  (" << trueHitGlobalPos.X() << "," << trueHitGlobalPos.Y() << "," << trueHitGlobalPos.Z() << ")");
    if (pow(spacePoint->X() - trueHitGlobalPos.X(), 2) > m_maxGlobalDiff
        || pow(spacePoint->Y() - trueHitGlobalPos.Y(), 2) > m_maxGlobalDiff ||
        pow(spacePoint->Z() - trueHitGlobalPos.Z(), 2) > m_maxGlobalDiff) {
      B2DEBUG(25, "The position differences are for X: " << spacePoint->X() - trueHitGlobalPos.X() << ", Y: " << spacePoint->Y() -
              trueHitGlobalPos.Y() << " Z: " << spacePoint->Z() - trueHitGlobalPos.Z() << " but the maximum position difference is set to: " <<
              sqrt(m_PARAMmaxGlobalDiff));
      return false;
    }
  } else {
    B2DEBUG(20, "For SpacePoint " << spacePoint->getArrayIndex() <<
            " one of the local coordinates was not assigned. The global positions and the un-assigned local coordinate were not compared!");
  }
 
  return true;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

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.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

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.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

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.

Reimplemented in BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, AlignDQMModule, CosmicsAlignmentValidationModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, arichBtestModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, Root2RawModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, EvtGenDecayModule, OverrideGenerationFlagsModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, AWESOMEBasicModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, Convert2RawDetModule, PrintDataModule, PrintEventRateModule, Root2BinaryModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0ValidationModule, DataWriterModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, ExtModule, GenfitVisModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, MCSlowPionPXDROICreatorModule, PXDROIFinderModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, RT2SPTCConverterModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, NoKickCutsEvalModule, SectorMapBootstrapModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGGDLModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, PyModule, SVDUnpackerDQMModule, TrackSetEvaluatorHopfieldNNDEVModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisTRGModule, and DQMHistOutputToEPICSModule.

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.

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

event()

void event ( void  )

overridevirtual

event: try to find the appropriate TrueHit to all SpacePoints

Reimplemented from Module.

Definition at line 196 of file SpacePoint2TrueHitConnectorModule.cc.

{
  StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
  const int eventCtr = eventMetaDataPtr->getEvent();
  B2DEBUG(20, "SpacePoint2TrueHitConnector::event(). Processing event " << eventCtr << " -----------------------");
 
  if (m_PARAMpositionAnalysis) m_rootVariables = RootVariables(); // clear the rootVariables for every event
 
  // loop over all containers
  for (m_iCont = 0; m_iCont < m_nContainers; ++m_iCont) {
    StoreArray<SpacePoint> spacePoints = m_inputSpacePoints.at(m_iCont).first;
    const int nSpacePoints = spacePoints.getEntries();
    e_detTypes detType = m_inputSpacePoints.at(m_iCont).second;
    std::string detTypeStr = detType == c_SVD ? "SVD" : "PXD";
    B2DEBUG(20, "Found " << nSpacePoints << " SpacePoints in Array " << m_inputSpacePoints.at(m_iCont).first.getName() <<
            " for this event. detType: " << detTypeStr);
 
    m_SpacePointsCtr.at(m_iCont) += nSpacePoints;
 
    for (int iSP = 0; iSP < nSpacePoints; ++iSP) {
      SpacePoint* spacePoint = spacePoints[iSP];
      B2DEBUG(21, "Processing SpacePoint " << iSP << " from " << nSpacePoints);
 
      baseMapT trueHitMap = processSpacePoint<baseMapT>(spacePoint, detType);
      if (trueHitMap.empty()) continue; // next SpacePoint if something went wrong
 
      unsigned int nUniqueTHs = getUniqueSize(trueHitMap);
      B2DEBUG(23, "Found " << nUniqueTHs << " TrueHits (unique) related to SpacePoint " << spacePoint->getArrayIndex() << " from Array "
              << spacePoint->getArrayName());
      unsigned int iRels = nUniqueTHs > 4 ? 4 : nUniqueTHs - 1;
      m_nRelTrueHitsCtr.at(m_iCont).at(iRels)++;
 
      // print the complete map if the debug level is set high enough
      if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 350, PACKAGENAME())) {
        std::string mapCont = printMap(trueHitMap);
        B2DEBUG(24, "The TrueHits and their weights for spacePoint " << spacePoint->getArrayIndex() << ": " + mapCont);
      }
 
      int thIndex = -1; // declare negative and only assign a value if ONE relation gets registered! (see doc of positionAnalysis)
      if (m_PARAMregisterAll) {
        registerAllRelations(spacePoint, trueHitMap, detType);
      } else { // find THE ONE TrueHit (to rule them all, one TrueHit to find them all ...)
        // COULDDO: wrap this up in a function
        std::pair<VXDTrueHit*, double> trueHitwWeight;
 
        if (detType == c_PXD) trueHitwWeight = getTHwithWeight<baseMapT, PXDTrueHit>(trueHitMap, m_PXDTrueHits, spacePoint, c_PXD);
        else trueHitwWeight = getTHwithWeight<baseMapT, SVDTrueHit>(trueHitMap, m_SVDTrueHits, spacePoint, c_SVD);
 
        if (trueHitwWeight.first != nullptr) {
          registerOneRelation(spacePoint, trueHitwWeight, detType);
          thIndex = trueHitwWeight.first->getArrayIndex();
        } else {
          B2DEBUG(20, "Could not relate one TrueHit to SpacePoint " << spacePoint->getArrayIndex() << ".");
          m_rejectedRelsCtr.at(m_iCont)++;
        }
      }
 
      if (m_PARAMpositionAnalysis) { positionAnalysis(spacePoint, trueHitMap, thIndex, detType); }
    } // end loop SpacePoints
  } // end loop containers
  if (m_PARAMpositionAnalysis) { m_treePtr->Fill(); }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

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.

{
  std::pair<unsigned short int, unsigned short int> clusterSizes = { 0, 0 };
  if (detType == c_PXD) {
    std::vector<std::pair<PXDCluster*, double> > relClusters = getRelatedClusters<PXDCluster>(spacePoint, m_PXDClusters.getName());
    return std::make_pair(relClusters[0].first->getUSize(), relClusters[0].first->getVSize());
  } else {
    std::vector<std::pair<SVDCluster*, double> > relClusters = getRelatedClusters<SVDCluster>(spacePoint, m_SVDClusters.getName());
    for (auto cluster : relClusters) {
      if (cluster.first->isUCluster()) clusterSizes.first = cluster.first->getSize();
      else clusterSizes.second = cluster.first->getSize();
    }
  }
  return clusterSizes;
}

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

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.

{
  auto detType = spacePoint->getType();
  std::pair<double, double> errors = { -1., -1. };
  if (detType == VXD::SensorInfoBase::PXD) {
    std::vector<std::pair<PXDCluster*, double> > relClusters = getRelatedClusters<PXDCluster>(spacePoint, m_PXDClusters.getName());
    errors.first = relClusters[0].first->getUSigma();
    errors.second = relClusters[0].first->getVSigma();
  } else if (detType == VXD::SensorInfoBase::SVD) {
    std::vector<std::pair<SVDCluster*, double> > relClusters = getRelatedClusters<SVDCluster>(spacePoint, m_SVDClusters.getName());
    for (auto cluster : relClusters) {
      if (cluster.first->isUCluster()) { errors.first = cluster.first->getPositionSigma(); }
      else { errors.second = cluster.first->getPositionSigma(); }
    }
  } else {
    B2ERROR("Detector type not known in SpacePoint2TrueHitConnector::getLocalError() !");
  }
 
  return errors;
}

getLocalPos()

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

protected

get the local position of a SpacePoint

Definition at line 784 of file SpacePoint2TrueHitConnectorModule.cc.

{
  // get the normalized local coordinates from SpacePoint and convert them to local coordinates (have to do so because at the slanted parts the local U-position is dependant on the local V-position)
  // NOTE: second way is to convert the global position of the SpacePoint to local position via the sensorInfoBase (yields same results)
  double normU = spacePoint->getNormalizedLocalU();
  double normV = spacePoint->getNormalizedLocalV();
  return spacePoint->convertNormalizedToLocalCoordinates(std::make_pair(normU, normV), spacePoint->getVxdID());
}

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getRelatedClusters()

std::vector< std::pair< ClusterType *, double > > getRelatedClusters ( Belle2::SpacePoint *  spacePoint, std::string  clusterName = "ALL"  )

protected

get the pointers to the related Clusters and the weight of the original Relations between the spacePoint and these Clusters

Definition at line 492 of file SpacePoint2TrueHitConnectorModule.cc.

{
  std::vector<std::pair<ClusterType*, double> > indsAndWeights;
  RelationVector<ClusterType> relClusters = spacePoint->getRelationsTo<ClusterType>(clusterName);
 
  for (unsigned int iCl = 0; iCl < relClusters.size(); ++iCl) {
    indsAndWeights.push_back(std::make_pair(relClusters[iCl], relClusters.weight(iCl)));
  }
 
  // safety measure, should not / cannot happen (checked before)
  if (indsAndWeights.empty()) { B2ERROR("No Clusters related to SpacePoint " << spacePoint->getArrayIndex() << "!"); }
 
  return indsAndWeights;
}

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.

{
  MapType trueHitsMap; // map to be filled with indices (keys) and weights (values)
 
  RelationVector<ClusterType> spacePointClusters = spacePoint->getRelationsTo<ClusterType>(clusterName);
  if (spacePointClusters.size() == 0) {
    B2DEBUG(20, "Found no related Cluster for SpacePoint " << spacePoint->getArrayIndex() << " from Array " <<
            spacePoint->getArrayIndex());
    throw NoClusterToSpacePoint();
  }
  B2DEBUG(24, "Found " << spacePointClusters.size() << " related Clusters to SpacePoint " << spacePoint->getArrayIndex() <<
          " from Array " << spacePoint->getArrayName());
 
  // loop over all Clusters, get all TrueHits from them and add the information to the map
  short noTrueHits = 0;
  for (size_t iCl = 0; iCl < spacePointClusters.size(); ++iCl) {
 
    const ClusterType* cluster = spacePointClusters[iCl];
    RelationVector<TrueHitType> clusterTrueHits = cluster->template getRelationsTo<TrueHitType>(trueHitName);
    if (clusterTrueHits.size() == 0) {
      B2DEBUG(20, "Found no related TrueHit for Cluster " << cluster->getArrayIndex() << " contained by SpacePoint " <<
              spacePoint->getArrayIndex() << " from Array " << spacePoint->getArrayName());
      noTrueHits++;
    } else {
      B2DEBUG(26, "Found " << clusterTrueHits.size() << " related TrueHits to Cluster " << cluster->getArrayIndex() << " from Array " <<
              cluster->getArrayName());
 
      for (unsigned int i = 0; i < clusterTrueHits.size(); ++i) { // 'TrueHit' loop
        if ((clusterTrueHits.weight(i) < m_PARAMminWeight) && !m_PARAMregisterAll) {
          m_weightTooSmallCtr++;
          continue; // not take into account relations with too little weight
        }
        int index = clusterTrueHits[i]->getArrayIndex();
        if (trueHitsMap.find(index) == trueHitsMap.end()) {  // create entry only if it is not already in the map
          trueHitsMap[index] = TrueHitInfo(index);
          B2DEBUG(29, "Added new TrueHitInfo to map. Index " << index);
        }
        if (spacePointClusters.weight(iCl) > 0) {
          trueHitsMap[index].setUWeight(clusterTrueHits.weight(i));
          B2DEBUG(29, "Added UCluster to TrueHitInfo with index " << index);
        } else {
          trueHitsMap[index].setVWeight(clusterTrueHits.weight(i));
          B2DEBUG(29, "Added VCluster to TrueHitInfo with index " << index);
        }
      }
    }
  }
  // check if there was no Cluster with a related TrueHit -> then throw
  if (noTrueHits == spacePoint->getNClustersAssigned()) {
    m_noTrueHitCtr[m_iCont]++; // increase counter for current container
  }
  return trueHitsMap;
}

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.

{ return m_returnValue; }

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.

{
  std::vector<TrueHitInfo> trueHitInfos = getAllValues(aMap);
  std::pair<TrueHitType*, double> THwithWeight(nullptr, 0.0); // default return value
  // return nullptr pointer and zero weight if there is no TrueHit (safety measure that should not actually be needed!)
  if (trueHitInfos.empty()) return THwithWeight;
  std::sort(trueHitInfos.begin(), trueHitInfos.end()); // sort to have best candidates at beginning
 
  short nClusters = spacePoint->getNClustersAssigned();
  size_t nRelations = trueHitInfos.size(); // get the number of possible relations
 
  B2DEBUG(23, "Trying to select one TrueHit for SpacePoint " << spacePoint->getArrayIndex() << " from Array " <<
          spacePoint->getArrayName() << ". SpacePoint has " << nClusters << " Clusters.");
  B2DEBUG(25, "There are " << nRelations << " possible candidates.");
 
  // very verbose output only to have a look on why these TrueHits could be in the same SpacePoint, COULDDO: wrap up in function
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 999, PACKAGENAME())) {
    std::stringstream output;
    output << "The candidates are: ";
    for (auto& info : trueHitInfos) { output << info; }
    B2DEBUG(29, output.str());
 
    std::pair<double, double> spacePointLocal = getLocalPos(spacePoint);
    std::pair<bool, bool> assignedLocal = spacePoint->getIfClustersAssigned();
 
    B2DEBUG(29, "SpacePoint " << spacePoint->getArrayIndex() << " U: " << spacePointLocal.first << " V: " << spacePointLocal.second <<
            " assigned: " << assignedLocal.first << ", " << assignedLocal.second);
 
    std::vector<int> uniqueKeys = getUniqueKeys(aMap);
    for (int key : uniqueKeys) {
      TrueHitType* trueHit = trueHits[key];
      // NOTE: assuming here that there is only one MCParticle to each TrueHit
      MCParticle* mcParticle = trueHit->template getRelatedFrom<MCParticle>("ALL");
 
      int mcPartId = -1, pdgCode = 0;
      bool primary = false;
 
      if (mcParticle != nullptr) {
        mcPartId = mcParticle->getArrayIndex();
        primary = mcParticle->hasStatus(MCParticle::c_PrimaryParticle);
        pdgCode = mcParticle->getPDG();
      }
 
      B2DEBUG(29, "TrueHit " << key << " U: " << trueHit->getU() << ", V: " << trueHit->getV() << " mc Particle Id: " << mcPartId <<
              ", primary " << primary << ", pdg: " << pdgCode);
    }
  }
 
  // loop over all TrueHitInfos and check if the number of related Clusters is equal to the number of the number of the assigned
  // Clusters in the SpacePoint -> if so, check for compatibility and return (the first that is compatible)
  bool ghostHit = false;
  for (const TrueHitInfo& info : trueHitInfos) {
    B2DEBUG(28, "Now checking trueHit: " << info);
    if (nClusters == info.getNClusters()) {
      TrueHitType* trueHit = trueHits[info.m_Id];
      if (compatibleCombination(spacePoint, trueHit)) {
        double weight = (detType == c_PXD ? 1 : calculateRelationWeight(info, spacePoint)); // if PXD weight is always 1!
        return std::make_pair(trueHit, weight);
      }
    } else {
      B2DEBUG(28, "The number of related Clusters ( = " << nClusters << ") and the number of associated weights ( = " <<
              info.getNClusters() << ") do not match! This indicates a ghost hit");
      ghostHit = true;
    }
  }
  if (ghostHit) m_ghostHitCtr[m_iCont]++;
 
  // B2DEBUG(28, "just before return in getTHwithWeight")
  return THwithWeight;
}

getTrueHitPositions()

std::pair< ROOT::Math::XYZVector, ROOT::Math::XYZVector > getTrueHitPositions ( TrueHitType *  trueHit )

protected

get the local (.first) and global (.second) position of a TrueHit (passed by index)

Definition at line 795 of file SpacePoint2TrueHitConnectorModule.cc.

{
//   TrueHitType* trueHit = trueHits[index];
  const ROOT::Math::XYZVector localPos = ROOT::Math::XYZVector(trueHit->getU(), trueHit->getV(), 0);
 
  const VxdID trueHitVxdId = trueHit->getSensorID();
  VXD::SensorInfoBase SensorInfoBase = VXD::GeoCache::getInstance().getSensorInfo(trueHitVxdId);
  const ROOT::Math::XYZVector globalPos = SensorInfoBase.pointToGlobal(localPos, true); // uses alignment
 
  return std::make_pair(localPos, globalPos);
}

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

See https://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.

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

initialize()

void initialize ( void  )

overridevirtual

initialize: initialize counters, check StoreArrays, register StoreArrays, ...

Reimplemented from Module.

Definition at line 104 of file SpacePoint2TrueHitConnectorModule.cc.

{
  B2INFO("SpacePoint2TrueHitConnector -------------------------- initialize --------------------------------");
 
  m_nContainers = m_PARAMspacePointNames.size(); // get number of passed arrays
  unsigned int nTHNames = m_PARAMtrueHitNames.size();
  unsigned int nDetTypes = m_PARAMdetectorTypes.size();
  unsigned int nClNames = m_PARAMclusterNames.size();
  if (m_nContainers < nTHNames || m_nContainers < nDetTypes || m_nContainers < nClNames) {
    B2FATAL("Passed " << nTHNames << " TrueHitNames and " << nDetTypes << " DetectorTypes but number of passed SpacePointArrays is " <<
            m_nContainers);
  }
  if ((nTHNames != nDetTypes) || (nClNames != nTHNames)) {
    B2FATAL("Passed " << nTHNames << " TrueHitNames and " << nClNames << "ClusterNames but " << nDetTypes << " DetectorTypes!");
  }
 
  for (unsigned int i = 0; i < m_nContainers; ++i) {
    if (i < nDetTypes) { // handle the detector types
      std::string detType = m_PARAMdetectorTypes.at(i);
      if (detType.compare(std::string("SVD")) != 0 && detType.compare(std::string("PXD")) != 0) {
        B2FATAL("Found entry " << detType << " in DetectorTypes, but only 'PXD' and 'SVD' are allowed!");
      }
      if (detType.compare(std::string("SVD")) == 0) {
        m_detectorTypes.push_back(c_SVD);
        m_SVDTrueHits = StoreArray<SVDTrueHit>(m_PARAMtrueHitNames.at(i));
        m_SVDTrueHits.isRequired();
        m_SVDClusters = StoreArray<SVDCluster>(m_PARAMclusterNames.at(i));
        m_SVDClusters.isRequired();
      } else {
        m_detectorTypes.push_back(c_PXD);
        m_PXDTrueHits = StoreArray<PXDTrueHit>(m_PARAMtrueHitNames.at(i));
        m_PXDTrueHits.isRequired();
        m_PXDClusters = StoreArray<PXDCluster>(m_PARAMclusterNames.at(i));
        m_PXDClusters.isRequired();
      }
    } else { m_detectorTypes.push_back(m_detectorTypes.at(i - 1)); } // add the last entry again
 
    m_inputSpacePoints.push_back(std::make_pair(StoreArray<SpacePoint>(m_PARAMspacePointNames.at(i)), m_detectorTypes.at(i)));
    m_inputSpacePoints.at(i).first.isRequired();
 
    // add counters
    m_SpacePointsCtr.push_back(0);
    m_nRelTrueHitsCtr.push_back(std::array<unsigned int, 5>());
    m_noClusterCtr.push_back(0);
    m_noTrueHitCtr.push_back(0);
    m_regRelationsCtr.push_back(0);
    m_ghostHitCtr.push_back(0);
    m_rejectedRelsCtr.push_back(0);
  }
 
  if (m_PARAMstoreSeparate) {
    if (m_PARAMoutputSuffix.empty()) {
      B2WARNING("'outputSuffix' is empty and 'storeSeperate' is set to true. This would lead to StoreArrays with the same name. Resetting to 'outputSuffix' to '_relTH'!");
      m_PARAMoutputSuffix = "_relTH";
    }
 
    for (unsigned int i = 0; i < m_nContainers; ++i) {
      std::string name = m_inputSpacePoints.at(i).first.getName() + m_PARAMoutputSuffix;
      m_outputSpacePoints.push_back(StoreArray<SpacePoint>(name));
      m_outputSpacePoints.at(i).registerInDataStore(name, DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
 
      // register relations (detector dependent)
      if (m_inputSpacePoints.at(i).second == c_SVD) {
        m_outputSpacePoints.at(i).registerRelationTo(m_SVDTrueHits, DataStore::c_Event, DataStore::c_DontWriteOut);
        m_outputSpacePoints.at(i).registerRelationTo(m_SVDClusters, DataStore::c_Event, DataStore::c_DontWriteOut);
      } else {
        m_outputSpacePoints.at(i).registerRelationTo(m_PXDTrueHits, DataStore::c_Event, DataStore::c_DontWriteOut);
        m_outputSpacePoints.at(i).registerRelationTo(m_PXDClusters, DataStore::c_Event, DataStore::c_DontWriteOut);
      }
    }
  } else {
    for (unsigned int i = 0; i < m_nContainers; ++i) {
      if (m_inputSpacePoints.at(i).second == c_SVD) {
        m_inputSpacePoints.at(i).first.registerRelationTo(m_SVDTrueHits, DataStore::c_Event, DataStore::c_DontWriteOut);
      } else {
        m_inputSpacePoints.at(i).first.registerRelationTo(m_PXDTrueHits, DataStore::c_Event, DataStore::c_DontWriteOut);
      }
    }
  }
 
  m_maxGlobalDiff = m_PARAMmaxGlobalDiff * m_PARAMmaxGlobalDiff; // only comparing squared values in module!
//   m_PARAMmaxLocalDiff *= m_PARAMmaxLocalDiff;
 
  if (m_PARAMmaxPosSigma < 0) {
    B2WARNING("'maxPosSigma' is set to a value below 0: " << m_PARAMmaxPosSigma << "! Resetting to default (4)!");
    m_PARAMmaxPosSigma = 4.;
  }
 
  if (m_PARAMpositionAnalysis) { initializeRootFile(); }
}

initializeCounters()

void initializeCounters ( )

protected

initialize all counters to 0 WARNING: only call in constructor of module!

Definition at line 386 of file SpacePoint2TrueHitConnectorModule.cc.

{
  // NEW
  for (unsigned int i = 0; i < m_SpacePointsCtr.size(); ++i) {
    m_SpacePointsCtr.at(i) = 0;
    m_regRelationsCtr.at(i) = 0;
    m_noClusterCtr.at(i) = 0;
    m_ghostHitCtr.at(i) = 0;
    m_noTrueHitCtr.at(i) = 0;
    m_rejectedRelsCtr.at(i) = 0;
 
    for (unsigned int j = 0; j < m_nRelTrueHitsCtr.at(i).size(); ++j) { m_nRelTrueHitsCtr.at(i).at(j) = 0; }
  }
 
  m_weightTooSmallCtr = 0;
  m_rejectedNoPrimaryCtr = 0;
 
  // initialize the following here because of cppcheck complaining (not initialized in constructor)
  m_nContainers = 0;
  m_maxGlobalDiff = 0.;
  m_iCont = 0;
 
//   m_negWeightCtr = 0;
//   m_totWeightsCtr = 0;
//   m_moreThan2Weights = 0;
//
//   m_single2WTHCtr = 0;
//   m_nonSingle2WTHCtr = 0;
//   m_all2WTHCtr = 0;
//   m_accSingle2WTHCtr = 0;
//   m_accNonSingle2WTHCtr = 0;
//   m_accAll2WTHCtr = 0;
//
//   m_oneCluster2THCtr = 0;
//
 
}

initializeRootFile()

void initializeRootFile ( )

protected

initialize the root file that is used for output

Definition at line 808 of file SpacePoint2TrueHitConnectorModule.cc.

{
  if (m_PARAMrootFileName.size() != 2 || (m_PARAMrootFileName[1] != "UPDATE" && m_PARAMrootFileName[1] != "RECREATE")) {
    std::string output;
    for (std::string entry : m_PARAMrootFileName) {
      output += "'" + entry + "' ";
    }
    B2FATAL("CurlingTrackCandSplitter::initialize() : rootFileName is set wrong: entries are: " << output);
  }
 
  std::string fileName = m_PARAMrootFileName[0] + ".root";
  m_rootFilePtr = new TFile(fileName.c_str(), m_PARAMrootFileName[1].c_str());
  m_treePtr = new TTree("PosAnaTree", "Position Analysis");
 
  // link the variables
  m_treePtr->Branch("SPLocalU", &m_rootVariables.SpacePointULocal);
  m_treePtr->Branch("SPLocalV", &m_rootVariables.SpacePointVLocal);
  m_treePtr->Branch("SPGlobalX", &m_rootVariables.SpacePointXGlobal);
  m_treePtr->Branch("SPGlobalY", &m_rootVariables.SpacePointYGlobal);
  m_treePtr->Branch("SPGlobalZ", &m_rootVariables.SpacePointZGlobal);
 
  m_treePtr->Branch("THLocalU", &m_rootVariables.TrueHitULocal);
  m_treePtr->Branch("THLocalV", &m_rootVariables.TrueHitVLocal);
  m_treePtr->Branch("THGlobalX", &m_rootVariables.TrueHitXGlobal);
  m_treePtr->Branch("THGlobalY", &m_rootVariables.TrueHitYGlobal);
  m_treePtr->Branch("THGlobalZ", &m_rootVariables.TrueHitZGlobal);
 
  m_treePtr->Branch("WeightU", &m_rootVariables.WeightU);
  m_treePtr->Branch("WeightV", &m_rootVariables.WeightV);
 
  m_treePtr->Branch("relStatus", &m_rootVariables.RelationStatus);
  m_treePtr->Branch("VxdID", &m_rootVariables.HitVxdID);
  m_treePtr->Branch("nRelations", &m_rootVariables.NRelations);
 
  m_treePtr->Branch("clusterSizeU", &m_rootVariables.ClusterSizeU);
  m_treePtr->Branch("clusterSizeV", &m_rootVariables.ClusterSizeV);
  m_treePtr->Branch("SPErrorU", &m_rootVariables.SpacePointErrorU);
  m_treePtr->Branch("SPErrorV", &m_rootVariables.SpacePointErrorV);
  m_treePtr->Branch("SPErrorX", &m_rootVariables.SpacePointErrorX);
  m_treePtr->Branch("SPErrorY", &m_rootVariables.SpacePointErrorY);
  m_treePtr->Branch("SPErrorZ", &m_rootVariables.SpacePointErrorZ);
}

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.

{
  B2DEBUG(28, "Doing position analysis for SpacePoint "  << spacePoint->getArrayIndex() << " from Array " <<
          spacePoint->getArrayName());
  simpleBitfield<unsigned short int> relationStatus;
 
  // TODO TODO TODO TODO TODO TODO TODO: remove if not needed, only for tessting at the moment (i.e. do not commit)
  std::pair<unsigned short int, unsigned short int> clusterSizes = getClusterSizes(spacePoint, detType);
  std::pair<double, double> positionError = getLocalError(spacePoint);
  // TODO TODO TODO TODO TODO TODO TODO: remove if not needed, only for tessting at the moment (i.e. do not commit)
 
  // do some checks and set the relationStatus
  std::pair<bool, bool> setUV = spacePoint->getIfClustersAssigned();
  if (setUV.first) relationStatus.addStatus(c_SpacePointU);
  if (setUV.second) relationStatus.addStatus(c_SpacePointV);
 
  const std::vector<TrueHitInfo> trueHitInfos = getAllValues(trueHitMap);
  unsigned int nRelations = trueHitInfos.size();
  if (nRelations != 1) relationStatus.addStatus(c_nonUniqueRelation);
  else relationStatus.addStatus(c_clearHit); // TODO: check if this is according to the definition of cleanHit
 
  B2DEBUG(29, "SpacePoint has assigned U: " << setUV.first << ", V: " << setUV.second << ". Possible TrueHits: " << nRelations);
 
  std::pair<double, double> spLocalPos = getLocalPos(spacePoint);
  unsigned short int vxdId = spacePoint->getVxdID();
  short nClusters = spacePoint->getNClustersAssigned();
 
  // loop over all TrueHitInfos and check if it is a ghostHit, and if a noise hit is contained in the SpacePoint
  bool onceU = false, onceV = false; // check if both Clusters are at least used once
  bool twoClusters = false;
  for (const TrueHitInfo& info : trueHitInfos) {
    onceU = onceU || info.m_U; // if U is set for one of the possible TrueHits, onceU is true after this loop
    onceV = onceV || info.m_V;
    twoClusters = twoClusters || (info.getNClusters() == 2); // if one of the TrueHits has two Clusters in the SpacePoint -> true
  }
  bool allSet = onceU && onceV;
 
  if (nClusters > 1) { // at this stage noise Clusters and ghostHits can only appear if there are two Clusters in the SpacePoint
    if (!allSet) relationStatus.addStatus(c_noiseCluster);
    if (allSet && !twoClusters) relationStatus.addStatus(c_ghostHit);
  }
 
  // get the status that has been set until now as from now on it can differ for every relation
  unsigned short int overAllStatus = relationStatus.getStatus();
 
  for (const TrueHitInfo& info : trueHitInfos) {
    relationStatus.setStatus(overAllStatus); // reset status
    VXDTrueHit* trueHit;
    if (detType == c_SVD) { trueHit = m_SVDTrueHits[info.m_Id]; }
    else { trueHit = m_PXDTrueHits[info.m_Id]; }
    std::pair<ROOT::Math::XYZVector, ROOT::Math::XYZVector> trueHitPos = getTrueHitPositions(trueHit);
 
    double weightU = info.m_wU;
    double weightV = info.m_wV;
 
    MCParticle* mcParticle = trueHit->getRelatedFrom<MCParticle>("ALL");
    if (mcParticle != nullptr) {
      if (mcParticle->hasStatus(MCParticle::c_PrimaryParticle)) relationStatus.addStatus(c_primaryParticle);
    }
 
    if (info.m_Id == index) relationStatus.addStatus(c_registeredRelation);
 
    m_rootVariables.SpacePointULocal.push_back(spLocalPos.first);
    m_rootVariables.SpacePointVLocal.push_back(spLocalPos.second);
    m_rootVariables.SpacePointXGlobal.push_back(spacePoint->X());
    m_rootVariables.SpacePointYGlobal.push_back(spacePoint->Y());
    m_rootVariables.SpacePointZGlobal.push_back(spacePoint->Z());
 
    m_rootVariables.TrueHitULocal.push_back(trueHitPos.first.X());
    m_rootVariables.TrueHitVLocal.push_back(trueHitPos.first.Y());
    m_rootVariables.TrueHitXGlobal.push_back(trueHitPos.second.X());
    m_rootVariables.TrueHitYGlobal.push_back(trueHitPos.second.Y());
    m_rootVariables.TrueHitZGlobal.push_back(trueHitPos.second.Z());
 
    m_rootVariables.NRelations.push_back(nRelations);
    m_rootVariables.RelationStatus.push_back(relationStatus.getStatus());
    m_rootVariables.WeightU.push_back(weightU);
    m_rootVariables.WeightV.push_back(weightV);
    m_rootVariables.HitVxdID.push_back(vxdId);
 
    // TODO TODO TODO TODO TODO TODO TODO: remove if not needed, only for tessting at the moment (i.e. do not commit)
    m_rootVariables.ClusterSizeU.push_back(clusterSizes.first);
    m_rootVariables.ClusterSizeV.push_back(clusterSizes.second);
    m_rootVariables.SpacePointErrorU.push_back(positionError.first);
    m_rootVariables.SpacePointErrorV.push_back(positionError.second);
    m_rootVariables.SpacePointErrorX.push_back(spacePoint->getPositionError().X());
    m_rootVariables.SpacePointErrorY.push_back(spacePoint->getPositionError().Y());
    m_rootVariables.SpacePointErrorZ.push_back(spacePoint->getPositionError().Z());
    // TODO TODO TODO TODO TODO TODO TODO: remove if not needed, only for tessting at the moment (i.e. do not commit)
 
    B2DEBUG(29, "Branch contents of this entry:\nSPLocalU: " << spLocalPos.first << ". SPLocalV: " << spLocalPos.second << "\n" << \
            "SPGlobalX: " << spacePoint->X() << ", SPGlobalY: " << spacePoint->Y() << ", SPGlobalZ " << spacePoint->Z() << "\n" << \
            "THLocalU: " << trueHitPos.first.X() << ", THLocalV: " << trueHitPos.first.Y() << "\n" << \
            "THGlobalX: " << trueHitPos.second.X() << ", THGlobalY: " << trueHitPos.second.Y() << ", THGlobalZ: " << trueHitPos.second.Z() <<
            "\n" << \
            "weight1: " << weightU << ", weight2: " << weightV << ", VxdID: " << vxdId << ", nRelations: " << nRelations << ", relStatus: " <<
            relationStatus.getStatus());
  }
}

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.

{
  B2DEBUG(23, "Processing SpacePoint " << spacePoint->getArrayIndex() << " from Array " << spacePoint->getArrayName());
  MapType trueHitMap;
  try {
    if (detType == c_PXD) {
      trueHitMap = getRelatedTrueHits<MapType, PXDCluster, PXDTrueHit>(spacePoint, m_PXDClusters.getName(), m_PXDTrueHits.getName());
    } else {
      trueHitMap = getRelatedTrueHits<MapType, SVDCluster, SVDTrueHit>(spacePoint, m_SVDClusters.getName(), m_SVDTrueHits.getName());
    }
  } catch (NoClusterToSpacePoint& anE) {
    B2WARNING("Caught an exception while trying to relate SpacePoints and TrueHits: " << anE.what());
    m_noClusterCtr.at(m_iCont)++;
  } catch (...) { // catch the rest
    B2ERROR("Caught undefined exception while trying to relate SpacePoints and TrueHits");
    throw; // throw further (maybe it is caught somewhere else)
  }
 
  B2DEBUG(25, "trueHitMap.size() before return in processSpacePoint: " << trueHitMap.size());
  return trueHitMap;
}

registerAllRelations()

void registerAllRelations ( Belle2::SpacePoint *  spacePoint, MapType  trueHitMap, e_detTypes  detType  )

protected

register a Relation to all the TrueHits in the trueHitMap for the passed SpacePoint

Definition at line 426 of file SpacePoint2TrueHitConnectorModule.cc.

{
  B2DEBUG(23, "Registering all possible relations for SpacePoint " << spacePoint->getArrayIndex() << " from Array " <<
          spacePoint->getArrayName() << ". storeSeparate is set to " << m_PARAMstoreSeparate);
  SpacePoint* newSP = spacePoint; // declaring pointer here, getting new pointer if storeSeparate is true
 
  if (m_PARAMstoreSeparate) { // if storing in separate Array, re-register the relations to the Clusters first
    newSP = m_outputSpacePoints.at(m_iCont).appendNew(*spacePoint);
    B2DEBUG(23, "Added new SpacePoint to Array " << m_outputSpacePoints[m_iCont].getName() << ".");
    if (detType == c_PXD) reRegisterClusterRelations<PXDCluster>(spacePoint, newSP, m_PXDClusters.getName());
    else reRegisterClusterRelations<SVDCluster>(spacePoint, newSP, m_SVDClusters.getName());
  }
 
  std::vector<TrueHitInfo> trueHitInfos = getAllValues(trueHitMap);
  // sort by the number of related Clusters first and than by weight (descending order)
  std::sort(trueHitInfos.begin(), trueHitInfos.end());
 
  for (const TrueHitInfo& info : trueHitInfos) {
    if (detType == c_PXD) registerTrueHitRelation<PXDTrueHit>(newSP, info.m_Id, 1, m_PXDTrueHits); // only one Cluster for PXDs!
    else { // for SVD relation weight is depending on which Cluster is related to TrueHit!
      double weight = calculateRelationWeight(info, spacePoint);
      registerTrueHitRelation<SVDTrueHit>(newSP, info.m_Id, weight, m_SVDTrueHits);
    }
  }
}

registerOneRelation()

void registerOneRelation ( Belle2::SpacePoint *  spacePoint, std::pair< TrueHitType *, double >  trueHitwWeight, e_detTypes  detType  )

protected

register Relation between SpacePoint and TrueHit (and if neccessary also between SpacePoint and Cluster)

Definition at line 454 of file SpacePoint2TrueHitConnectorModule.cc.

{
  TrueHitType* trueHit = trueHitwWeight.first;
  B2DEBUG(23, "Registering relation to TrueHit " << trueHit->getArrayIndex() << " from Array " << trueHit->getArrayName());
  SpacePoint* newSP = spacePoint; // declaring pointer here, getting new pointer if storeSeparate ist true
 
  if (m_PARAMstoreSeparate) { // if storing in separate Array, re-register the relations to the Clusters first
    newSP = m_outputSpacePoints.at(m_iCont).appendNew(*spacePoint);
    B2DEBUG(23, "Added new SpacePoint to Array " << m_outputSpacePoints[m_iCont].getName() << ".");
    if (detType == c_PXD) reRegisterClusterRelations<PXDCluster>(spacePoint, newSP, m_PXDClusters.getName());
    else reRegisterClusterRelations<SVDCluster>(spacePoint, newSP, m_SVDClusters.getName());
  }
 
  newSP->addRelationTo(trueHit, trueHitwWeight.second);
  m_regRelationsCtr.at(m_iCont)++;
  B2DEBUG(23, "Added Relation to TrueHit " << trueHit->getArrayIndex() << " from Array " << trueHit->getArrayName() <<
          " for SpacePoint " << spacePoint->getArrayIndex() << " (weight = " << trueHitwWeight.second << ")");
}

registerTrueHitRelation()

void registerTrueHitRelation ( Belle2::SpacePoint *  spacePoint, int  index, double  weight, Belle2::StoreArray< TrueHitType >  trueHits  )

protected

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

Definition at line 510 of file SpacePoint2TrueHitConnectorModule.cc.

{
  TrueHitType* trueHit = trueHits[index];
  spacePoint->addRelationTo(trueHit, weight);
  m_regRelationsCtr.at(m_iCont)++; // increase counter of registered relations for this container
  B2DEBUG(23, "Added Relation to TrueHit " << index << " from Array " << trueHits.getName() << " for SpacePoint " <<
          spacePoint->getArrayIndex() << " (weight = " << weight << ")");
}

reRegisterClusterRelations()

void reRegisterClusterRelations ( Belle2::SpacePoint *  origSpacePoint, Belle2::SpacePoint *  newSpacePoint, std::string  clusterName = "ALL"  )

protected

register all the relations to Clusters that origSpacePoint had for newSpacePoint

Definition at line 476 of file SpacePoint2TrueHitConnectorModule.cc.

{
  B2DEBUG(27, "Registering the Relations to Clusters of SpacePoint " << origSpacePoint->getArrayIndex() << " in Array " <<
          origSpacePoint->getArrayName() << " for SpacePoint " << newSpacePoint->getArrayIndex() << " in Array " <<
          newSpacePoint->getArrayName());
 
  std::vector<std::pair<ClusterType*, double> > clustersAndWeights = getRelatedClusters<ClusterType>(origSpacePoint, clusterName);
  for (auto aCluster : clustersAndWeights) {
    newSpacePoint->addRelationTo(aCluster.first, aCluster.second);
    B2DEBUG(27, "Registered Relation to Cluster " << aCluster.first->getArrayIndex() << " with weight " << aCluster.second);
  }
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string &  name, const boost::python::object &  pyObj  )

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

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

terminate()

void terminate ( void  )

overridevirtual

terminate: print some summary information

Reimplemented from Module.

Definition at line 260 of file SpacePoint2TrueHitConnectorModule.cc.

{
  unsigned int sumSpacePoints = accumulate(m_SpacePointsCtr.begin(), m_SpacePointsCtr.end(), 0);
  unsigned int sumRelations = accumulate(m_regRelationsCtr.begin(), m_regRelationsCtr.end(), 0);
 
  B2RESULT("SpacePoint2TrueHitConnector: Got " << sumSpacePoints << " SpacePoints in " << m_nContainers <<
           " containers and registered " << sumRelations << " relations to TrueHits");
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 1, PACKAGENAME())) {
    std::stringstream contSumm;
    contSumm << "Container-wise summary: \n";
 
    for (unsigned int iCont = 0; iCont < m_nContainers; ++iCont) {
      contSumm << "In Container " << iCont << " (container name: " << m_inputSpacePoints[iCont].first.getName() << ") " <<
               m_SpacePointsCtr[iCont]  << " SpacePoints were contained. " << m_regRelationsCtr[iCont] <<
               " relations were registered.\nNumber of related TrueHits to a SpacePoint are:\n";
      for (unsigned int i = 0; i < m_nRelTrueHitsCtr[iCont].size() - 1; ++i) { contSumm << i + 1 << " related TrueHits to a SpacePoint : " << m_nRelTrueHitsCtr[iCont].at(i) << "\n"; }
      contSumm << " more than 4 related TrueHits to a SpacePoint: " << m_nRelTrueHitsCtr[iCont].at(4) << "\n"; // WARNING: hardcoded
      contSumm << m_rejectedRelsCtr.at(iCont) << " SpacePoints did not get a relation, " << m_ghostHitCtr.at(
                 iCont) << " were probably ghost hits in this container!\n";
      contSumm << m_noTrueHitCtr[iCont] << " SpacePoints had no relation to a TrueHit at all.\n";
    }
    B2DEBUG(20, contSumm.str());
 
    if (!m_PARAMregisterAll) {
      // TODO: do this containerwise
      std::stringstream furtherSummary;
      furtherSummary << "Ommited Relations because of weight < " << m_PARAMminWeight << ": " << m_weightTooSmallCtr << "\n";
      furtherSummary << "Rejected Relations because of non primary particle: " << m_rejectedNoPrimaryCtr;
//       furtherSummary << "Summary for all containers:\n";
//       furtherSummary << "possible/accepted relations for cases:\n";
//       furtherSummary << m_all2WTHCtr << "/" << m_accAll2WTHCtr << " SP with THs (more than one) with all THs having two weights\n";
//       furtherSummary << m_single2WTHCtr << "/" << m_accSingle2WTHCtr << " SP with THs (more than one) with only one TH having two weights\n";
//       furtherSummary << m_nonSingle2WTHCtr << "/" << m_accNonSingle2WTHCtr << " SP with THs (more than one) with more than one but not all THs having two weights\n";
//       furtherSummary << "In " << m_oneCluster2THCtr << " cases there was a SP with only one Cluster but more than one related TrueHits";
      B2DEBUG(20, furtherSummary.str());
    }
  }
 
  if (m_PARAMpositionAnalysis) { closeRootFile(); }
 
//   B2INFO("total number of weights: " << m_totWeightsCtr << " of which " << m_negWeightCtr << " were negative")
//   B2INFO("m_moreThan2Weights = " << m_moreThan2Weights);
}

Member Data Documentation

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_detectorTypes

std::vector<e_detTypes> m_detectorTypes

protected

storing the detector types for each container in vector, needed in initialize

Definition at line 229 of file SpacePoint2TrueHitConnectorModule.h.

m_ghostHitCtr

std::vector<unsigned int> m_ghostHitCtr

protected

Number of SpacePoints that are considered ghost hits.

Definition at line 266 of file SpacePoint2TrueHitConnectorModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_iCont

unsigned int m_iCont

protected

'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

Definition at line 247 of file SpacePoint2TrueHitConnectorModule.h.

m_inputSpacePoints

std::vector<std::pair<Belle2::StoreArray<Belle2::SpacePoint>, e_detTypes> > m_inputSpacePoints

protected

StoreArray of all input SpacePoints.

Definition at line 240 of file SpacePoint2TrueHitConnectorModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_maxGlobalDiff

double m_maxGlobalDiff

protected

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

Definition at line 244 of file SpacePoint2TrueHitConnectorModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

m_nContainers

unsigned int m_nContainers

protected

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

Definition at line 227 of file SpacePoint2TrueHitConnectorModule.h.

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_nRelTrueHitsCtr

std::vector<std::array<unsigned int, 5> > m_nRelTrueHitsCtr

protected

counting different numbers of related TrueHits (to a SpacePoint) with one variable

Definition at line 259 of file SpacePoint2TrueHitConnectorModule.h.

m_outputSpacePoints

std::vector<Belle2::StoreArray<Belle2::SpacePoint> > m_outputSpacePoints

protected

StoreArray of all output SpacePoints.

Definition at line 242 of file SpacePoint2TrueHitConnectorModule.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

m_PARAMclusterNames

std::vector<std::string> m_PARAMclusterNames

protected

names of containers of Clusters

Definition at line 201 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMdetectorTypes

std::vector<std::string> m_PARAMdetectorTypes

protected

detector type names as strings to determine which name belongs to which detector type

Definition at line 199 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMmaxGlobalDiff

double m_PARAMmaxGlobalDiff

protected

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

Definition at line 217 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMmaxPosSigma

double m_PARAMmaxPosSigma

protected

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

Definition at line 221 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_PARAMoutputSuffix

std::string m_PARAMoutputSuffix

protected

suffix that will be appended to the StoreArray names of the output StoreArrays

Definition at line 192 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMpositionAnalysis

bool m_PARAMpositionAnalysis

protected

switch for doing the analysis of positions of SpacePoints and TrueHits

Definition at line 211 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_PARAMrequirePrimary

bool m_PARAMrequirePrimary

protected

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

Definition at line 213 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_PARAMrootFileName

std::vector<std::string> m_PARAMrootFileName

protected

name and update status of root file

Definition at line 203 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMspacePointNames

std::vector<std::string> m_PARAMspacePointNames

protected

names of containers of SpacePoints

Definition at line 196 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMstoreSeparate

bool m_PARAMstoreSeparate

protected

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

Definition at line 206 of file SpacePoint2TrueHitConnectorModule.h.

m_PARAMtrueHitNames

std::vector<std::string> m_PARAMtrueHitNames

protected

names of containers of TrueHits

Definition at line 194 of file SpacePoint2TrueHitConnectorModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_PXDClusters

Belle2::StoreArray<Belle2::PXDCluster> m_PXDClusters

protected

PXDTClusters StoreArray used throughout the module.

Definition at line 235 of file SpacePoint2TrueHitConnectorModule.h.

m_PXDTrueHits

Belle2::StoreArray<Belle2::PXDTrueHit> m_PXDTrueHits

protected

PXDTrueHits StoreArray used throughout the module.

Definition at line 233 of file SpacePoint2TrueHitConnectorModule.h.

m_regRelationsCtr

std::vector<unsigned int> m_regRelationsCtr

protected

Number of registered relations.

Definition at line 264 of file SpacePoint2TrueHitConnectorModule.h.

m_rejectedNoPrimaryCtr

unsigned int m_rejectedNoPrimaryCtr

protected

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

Definition at line 276 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.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_rootFilePtr

TFile* m_rootFilePtr

protected

pointer to root file

Definition at line 251 of file SpacePoint2TrueHitConnectorModule.h.

m_rootVariables

RootVariables m_rootVariables

protected

Root variables used for collecting data eventwise.

Definition at line 249 of file SpacePoint2TrueHitConnectorModule.h.

m_SpacePointsCtr

std::vector<unsigned int> m_SpacePointsCtr

protected

Number of SpacePoints presented to the module.

Definition at line 256 of file SpacePoint2TrueHitConnectorModule.h.

m_SVDClusters

Belle2::StoreArray<Belle2::SVDCluster> m_SVDClusters

protected

PXDClusters StoreArray used throughout the module.

Definition at line 237 of file SpacePoint2TrueHitConnectorModule.h.

m_SVDTrueHits

Belle2::StoreArray<Belle2::SVDTrueHit> m_SVDTrueHits

protected

SVDTrueHits StoreArray used throughout the module.

Definition at line 231 of file SpacePoint2TrueHitConnectorModule.h.

m_treePtr

TTree* m_treePtr

protected

pointer to tree in root file

Definition at line 253 of file SpacePoint2TrueHitConnectorModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

m_weightTooSmallCtr

unsigned int m_weightTooSmallCtr

protected

Count the omitted relations because of a too small weight.

Definition at line 274 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