Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SVDClusterizerModule Class Reference

The SVD Clusterizer. More...

#include <SVDClusterizerModule.h>

Inheritance diagram for SVDClusterizerModule:
Module PathElement

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

 SVDClusterizerModule ()
 Constructor defining the parameters.
 
void initialize () override
 Initialize the module.
 
void beginRun () override
 configure clustering
 
void event () override
 does the actual clustering
 
void endRun () override
 delete pointers
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void terminate ()
 This method is called at the end of the event processing.
 
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 Member Functions

double applyLorentzShiftCorrection (double position, VxdID vxdID, bool isU)
 returns the position of the cluster after lorentz shift correction
 
void finalizeCluster (Belle2::SVD::RawCluster &rawCluster)
 computes charge, position and time of the raw cluster and appends the new SVDCluster to the StoreArray
 
void writeClusterRelations (const Belle2::SVD::RawCluster &rawCluster)
 writes the relations of the SVDClusters with the other StoreArrays
 
void alterClusterPosition ()
 alter the cluster position (applied on MC to match resolution measured on data)
 
void alterClusterTime ()
 alter the cluster time (applied on MC to match resolution measured on data)
 
void shiftSVDClusterTime ()
 Apply cluster time shift depending on cluster size.
 
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_svdEventInfoName
 Name of the collection to use for the SVDEventInfo.
 
std::string m_storeShaperDigitsName
 Name of the collection to use for the SVDShaperDigits.
 
std::string m_storeClustersName
 Name of the collection to use for the SVDClusters.
 
std::string m_storeTrueHitsName
 Name of the collection to use for the SVDTrueHits.
 
std::string m_storeMCParticlesName
 Name of the collection to use for the MCParticles.
 
std::string m_relShaperDigitMCParticleName
 Name of the relation between SVDShaperDigits and MCParticles.
 
std::string m_relClusterMCParticleName
 Name of the relation between SVDClusters and MCParticles.
 
std::string m_relClusterShaperDigitName
 Name of the relation between SVDClusters and SVDShaperDigits.
 
std::string m_relShaperDigitTrueHitName
 Name of the relation between SVDShaperDigits and SVDTrueHits.
 
std::string m_relClusterTrueHitName
 Name of the relation between SVDClusters and SVDTrueHits.
 
StoreArray< SVDCluster > m_storeClusters
 Collection of SVDClusters.
 
StoreArray< SVDShaperDigit > m_storeDigits
 Collection of SVDShaperDigits.
 
StoreArray< SVDTrueHit > m_storeTrueHits
 Collection of SVDTrueHits.
 
StoreArray< MCParticle > m_storeMCParticles
 Collection of MCParticles.
 
double m_cutSeed = 5
 Seed cut in units of noise.
 
double m_cutAdjacent = 3
 Adjacent cut in units of noise.
 
double m_cutCluster = 0
 Cluster cut in units of m_elNoise, not included (yet?)
 
bool m_useDB = true
 if true takes the clusterizer cuts and reconstruction configuration from the DB objects
 
int m_numberOfAcquiredSamples = 0
 number of acquired samples, can be 6 or 3 (1 is not supported!)
 
std::string m_timeRecoWith6SamplesAlgorithm = "not set"
 string storing the cluster time reconstruction algorithm in 6-sample DAQ mode
 
std::string m_timeRecoWith3SamplesAlgorithm = "not set"
 string storing the cluster time reconstruction algorithm in 3-sample DAQ mode
 
std::string m_chargeRecoWith6SamplesAlgorithm = "not set"
 string storing the cluster charge reconstruction algorithm in 6-sample DAQ mode
 
std::string m_chargeRecoWith3SamplesAlgorithm = "not set"
 string storing the cluster charge reconstruction algorithm in 3-sample DAQ mode
 
std::string m_positionRecoWith6SamplesAlgorithm = "not set"
 string storing the cluster position reconstruction algorithm in 6-sample DAQ mode
 
std::string m_positionRecoWith3SamplesAlgorithm = "not set"
 string storing the cluster position reconstruction algorithm in 3-sample DAQ mode
 
std::string m_stripTimeRecoWith6SamplesAlgorithm = "not set"
 string storing the strip time reconstruction algorithm for cluster position reconstruction in 6-sample DAQ mode
 
std::string m_stripTimeRecoWith3SamplesAlgorithm = "not set"
 string storing the strip time reconstruction algorithm for cluster position reconstruction in 3-sample DAQ mode
 
std::string m_stripChargeRecoWith6SamplesAlgorithm = "not set"
 string storing the strip charge reconstruction algorithm for cluster position reconstruction in 6-sample DAQ mode
 
std::string m_stripChargeRecoWith3SamplesAlgorithm = "not set"
 string storing the strip charge reconstruction algorithm for cluster reconstruction in 3-sample DAQ mode
 
SVDClusterTime * m_time6SampleClass = nullptr
 cluster time class for the 6-sample acquisition mode
 
SVDClusterTime * m_time3SampleClass = nullptr
 cluster time class for the 3-sample acquisition mode
 
SVDClusterCharge * m_charge6SampleClass = nullptr
 cluster charge class for the 6-sample acquisition mode
 
SVDClusterCharge * m_charge3SampleClass = nullptr
 cluster charge class for the 3-sample acquisition mode
 
SVDClusterPosition * m_position6SampleClass = nullptr
 cluster position class for the 6-sample acquisition mode
 
SVDClusterPosition * m_position3SampleClass = nullptr
 cluster position class for the 3-sample acquisition mode
 
bool m_returnRawClusterTime = false
 if true cluster time is not calibrated, to be used for time calibration
 
bool m_shiftSVDClusterTime = true
 if true applies SVDCluster time shift based on cluster-size
 
DBObjPtr< HardwareClockSettings > m_hwClock
 systems clock
 
DBObjPtr< SVDRecoConfiguration > m_recoConfig
 SVD Reconstruction Configuration payload.
 
SVDNoiseCalibrations m_NoiseCal
 SVDNoise calibrations db object.
 
SVDClustering m_ClusterCal
 SVDCluster calibrations db object.
 
SVDMCClusterPositionFudgeFactor m_mcPositionFudgeFactor
 SVDMCClusterPositionFudgeFactor db object.
 
SVDMCClusterTimeFudgeFactor m_mcTimeFudgeFactor
 SVDMCClusterTimeFudgeFactor db object.
 
DBObjPtr< SVDClusterTimeShifter > m_svdClusterTimeShifter
 SVDCluster time shift.
 

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

The SVD Clusterizer.

This module produces SVDClusters from SVDShaperDigits

Definition at line 48 of file SVDClusterizerModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ SVDClusterizerModule()

SVDClusterizerModule ( )

Constructor defining the parameters.

Definition at line 44 of file SVDClusterizerModule.cc.

44 : Module(),
45 m_cutSeed(5.0), m_cutAdjacent(3.0), m_useDB(true)
46{
47 //Set module properties
48 setDescription("This module produces SVDClusters from SVDShaperDigits, providing 1-D hit position, charge and time on SVD sensors.");
49 setPropertyFlags(c_ParallelProcessingCertified);
50
51 // 1. Collections.
52 addParam("EventInfo", m_svdEventInfoName,
53 "SVDEventInfo collection name.", string("SVDEventInfo"));
54 addParam("ShaperDigits", m_storeShaperDigitsName,
55 "SVDShaperDigits collection name.", string(""));
56 addParam("Clusters", m_storeClustersName,
57 "SVDCluster collection name.", string(""));
58 addParam("SVDTrueHits", m_storeTrueHitsName,
59 "TrueHit collection name.", string(""));
60 addParam("MCParticles", m_storeMCParticlesName,
61 "MCParticles collection name.", string(""));
62
63 // 2. Clustering
64 addParam("AdjacentSN", m_cutAdjacent,
65 "minimum SNR for strips to be considered for clustering. Overwritten by the dbobject, unless you set useDB = False.",
66 m_cutAdjacent);
67 addParam("returnClusterRawTime", m_returnRawClusterTime,
68 "if True, returns the raw cluster time (to be used for time calibration).",
69 m_returnRawClusterTime);
70 addParam("shiftSVDClusterTime", m_shiftSVDClusterTime,
71 "if True, applies SVDCluster time shift based on cluster-size.", m_shiftSVDClusterTime);
72 addParam("SeedSN", m_cutSeed,
73 "minimum SNR for strips to be considered as cluster seed. Overwritten by the dbobject, unless you set useDB = False.", m_cutSeed);
74 addParam("ClusterSN", m_cutCluster,
75 "minimum value of the SNR of the cluster. Overwritten by the dbobject, unless you set useDB = False.", m_cutCluster);
76 addParam("timeAlgorithm6Samples", m_timeRecoWith6SamplesAlgorithm,
77 "cluster-time reconstruction algorithm for the 6-sample DAQ mode: CoG6 = 6-sample CoG (default), CoG3 = 3-sample CoG, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
78 m_timeRecoWith6SamplesAlgorithm);
79 addParam("timeAlgorithm3Samples", m_timeRecoWith3SamplesAlgorithm,
80 "cluster-time reconstruction algorithm for the 3-sample DAQ mode: CoG6 = 6-sample CoG, CoG3 = 3-sample CoG (default), ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
81 m_timeRecoWith3SamplesAlgorithm);
82 addParam("chargeAlgorithm6Samples", m_chargeRecoWith6SamplesAlgorithm,
83 "cluster-charge reconstruction algorithm for 6-sample DAQ mode: MaxSample (default), SumSamples, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
84 m_chargeRecoWith6SamplesAlgorithm);
85 addParam("chargeAlgorithm3Samples", m_chargeRecoWith3SamplesAlgorithm,
86 "cluster-charge reconstruction algorithm for 3-sample DAQ mode: MaxSample (default), SumSamples, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
87 m_chargeRecoWith3SamplesAlgorithm);
88 addParam("positionAlgorithm6Samples", m_positionRecoWith6SamplesAlgorithm,
89 "cluster-position reconstruction algorithm for 6-sample DAQ mode: old (default), CoGOnly. Overwritten by the dbobject, unless you set useDB = False.",
90 m_positionRecoWith6SamplesAlgorithm);
91 addParam("positionAlgorithm3Samples", m_positionRecoWith3SamplesAlgorithm,
92 "cluster-position reconstruction algorithm for 3-sample DAQ mode: old (default), CoGOnly. Overwritten by the dbobject, unless you set useDB = False.",
93 m_positionRecoWith3SamplesAlgorithm);
94
95 addParam("stripTimeAlgorithm6Samples", m_stripTimeRecoWith6SamplesAlgorithm,
96 "strip-time reconstruction algorithm used for cluster position reconstruction for the 6-sample DAQ mode: dontdo = not done (default), CoG6 = 6-sample CoG, CoG3 = 3-sample CoG, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
97 m_stripTimeRecoWith6SamplesAlgorithm);
98 addParam("stripTimeAlgorithm3Samples", m_stripTimeRecoWith3SamplesAlgorithm,
99 "strip-time reconstruction algorithm used for cluster position reconstruction for the 3-sample DAQ mode: dontdo = not done (default), CoG6 = 6-sample CoG, CoG3 = 3-sample CoG, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
100 m_stripTimeRecoWith3SamplesAlgorithm);
101 addParam("stripChargeAlgorithm6Samples", m_stripChargeRecoWith6SamplesAlgorithm,
102 "strip-charge reconstruction algorithm used for cluster position reconstruction for the 6-sample DAQ mode: dontdo = not done, MaxSample, SumSamples, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
103 m_stripChargeRecoWith6SamplesAlgorithm);
104 addParam("stripChargeAlgorithm3Samples", m_stripChargeRecoWith3SamplesAlgorithm,
105 "strip-charge reconstruction algorithm used for cluster position reconstruction for the 3-sample DAQ mode: dontdo = not done, MaxSample, SumSamples, ELS3 = 3-sample ELS. Overwritten by the dbobject, unless you set useDB = False.",
106 m_stripChargeRecoWith3SamplesAlgorithm);
107
108 addParam("useDB", m_useDB,
109 "if False, use clustering and reconstruction configuration module parameters", m_useDB);
110
111}
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:30
Belle2::SVD::SVDClusterizerModule::m_stripChargeRecoWith3SamplesAlgorithm
std::string m_stripChargeRecoWith3SamplesAlgorithm
string storing the strip charge reconstruction algorithm for cluster reconstruction in 3-sample DAQ m...
Definition: SVDClusterizerModule.h:133
Belle2::SVD::SVDClusterizerModule::m_storeShaperDigitsName
std::string m_storeShaperDigitsName
Name of the collection to use for the SVDShaperDigits.
Definition: SVDClusterizerModule.h:73
Belle2::SVD::SVDClusterizerModule::m_cutCluster
double m_cutCluster
Cluster cut in units of m_elNoise, not included (yet?)
Definition: SVDClusterizerModule.h:107
Belle2::SVD::SVDClusterizerModule::m_storeTrueHitsName
std::string m_storeTrueHitsName
Name of the collection to use for the SVDTrueHits.
Definition: SVDClusterizerModule.h:77
Belle2::SVD::SVDClusterizerModule::m_storeMCParticlesName
std::string m_storeMCParticlesName
Name of the collection to use for the MCParticles.
Definition: SVDClusterizerModule.h:79
Belle2::SVD::SVDClusterizerModule::m_shiftSVDClusterTime
bool m_shiftSVDClusterTime
if true applies SVDCluster time shift based on cluster-size
Definition: SVDClusterizerModule.h:145
Belle2::SVD::SVDClusterizerModule::m_chargeRecoWith6SamplesAlgorithm
std::string m_chargeRecoWith6SamplesAlgorithm
string storing the cluster charge reconstruction algorithm in 6-sample DAQ mode
Definition: SVDClusterizerModule.h:118
Belle2::SVD::SVDClusterizerModule::m_chargeRecoWith3SamplesAlgorithm
std::string m_chargeRecoWith3SamplesAlgorithm
string storing the cluster charge reconstruction algorithm in 3-sample DAQ mode
Definition: SVDClusterizerModule.h:120
Belle2::SVD::SVDClusterizerModule::m_positionRecoWith3SamplesAlgorithm
std::string m_positionRecoWith3SamplesAlgorithm
string storing the cluster position reconstruction algorithm in 3-sample DAQ mode
Definition: SVDClusterizerModule.h:124
Belle2::SVD::SVDClusterizerModule::m_stripTimeRecoWith6SamplesAlgorithm
std::string m_stripTimeRecoWith6SamplesAlgorithm
string storing the strip time reconstruction algorithm for cluster position reconstruction in 6-sampl...
Definition: SVDClusterizerModule.h:127
Belle2::SVD::SVDClusterizerModule::m_stripChargeRecoWith6SamplesAlgorithm
std::string m_stripChargeRecoWith6SamplesAlgorithm
string storing the strip charge reconstruction algorithm for cluster position reconstruction in 6-sam...
Definition: SVDClusterizerModule.h:131
Belle2::SVD::SVDClusterizerModule::m_svdEventInfoName
std::string m_svdEventInfoName
Name of the collection to use for the SVDEventInfo.
Definition: SVDClusterizerModule.h:71
Belle2::SVD::SVDClusterizerModule::m_storeClustersName
std::string m_storeClustersName
Name of the collection to use for the SVDClusters.
Definition: SVDClusterizerModule.h:75
Belle2::SVD::SVDClusterizerModule::m_cutSeed
double m_cutSeed
Seed cut in units of noise.
Definition: SVDClusterizerModule.h:103
Belle2::SVD::SVDClusterizerModule::m_stripTimeRecoWith3SamplesAlgorithm
std::string m_stripTimeRecoWith3SamplesAlgorithm
string storing the strip time reconstruction algorithm for cluster position reconstruction in 3-sampl...
Definition: SVDClusterizerModule.h:129
Belle2::SVD::SVDClusterizerModule::m_timeRecoWith6SamplesAlgorithm
std::string m_timeRecoWith6SamplesAlgorithm
string storing the cluster time reconstruction algorithm in 6-sample DAQ mode
Definition: SVDClusterizerModule.h:114
Belle2::SVD::SVDClusterizerModule::m_positionRecoWith6SamplesAlgorithm
std::string m_positionRecoWith6SamplesAlgorithm
string storing the cluster position reconstruction algorithm in 6-sample DAQ mode
Definition: SVDClusterizerModule.h:122
Belle2::SVD::SVDClusterizerModule::m_timeRecoWith3SamplesAlgorithm
std::string m_timeRecoWith3SamplesAlgorithm
string storing the cluster time reconstruction algorithm in 3-sample DAQ mode
Definition: SVDClusterizerModule.h:116
Belle2::SVD::SVDClusterizerModule::m_useDB
bool m_useDB
if true takes the clusterizer cuts and reconstruction configuration from the DB objects
Definition: SVDClusterizerModule.h:109
Belle2::SVD::SVDClusterizerModule::m_cutAdjacent
double m_cutAdjacent
Adjacent cut in units of noise.
Definition: SVDClusterizerModule.h:105
Belle2::SVD::SVDClusterizerModule::m_returnRawClusterTime
bool m_returnRawClusterTime
if true cluster time is not calibrated, to be used for time calibration
Definition: SVDClusterizerModule.h:144
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ alterClusterPosition()

void alterClusterPosition ( )
protected

alter the cluster position (applied on MC to match resolution measured on data)

Definition at line 504 of file SVDClusterizerModule.cc.

505{
506 // alter the position of the last cluster in the array
507 int clsIndex = m_storeClusters.getEntries() - 1;
508
509 // get the necessary information on the cluster
510 float clsPosition = m_storeClusters[clsIndex]->getPosition();
511 VxdID sensorID = m_storeClusters[clsIndex]->getSensorID();
512 bool isU = m_storeClusters[clsIndex]->isUCluster();
513 int layerNum = sensorID.getLayerNumber();
514
515 // get the first true hit in the array
516 SVDTrueHit* trueHit = m_storeClusters[clsIndex]->getRelatedTo<SVDTrueHit>(m_storeTrueHitsName);
517
518 // get the track's incident angle
519 double trkAngle = 0.;
520
521 // check if cluster has associated true hit
522 if (trueHit) {
523 double trkLength = isU ? trueHit->getExitU() - trueHit->getEntryU() : trueHit->getExitV() - trueHit->getEntryV();
524 double trkHeight = std::abs(trueHit->getExitW() - trueHit->getEntryW());
525 trkAngle = atan2(trkLength, trkHeight);
526 }
527
528 // get the appropriate sigma to alter the position
529 double sigma = m_mcPositionFudgeFactor.getFudgeFactor(sensorID, isU, trkAngle);
530
531 // do the job
532 float fudgeFactor = (float) gRandom->Gaus(0., sigma);
533 m_storeClusters[clsIndex]->setPosition(clsPosition + fudgeFactor);
534
535 B2DEBUG(20, "Layer number: " << layerNum << ", is U side: " << isU << ", track angle: " << trkAngle << ", sigma: " << sigma <<
536 ", cluster position: " << clsPosition << ", fudge factor: " << fudgeFactor);
537}
Belle2::SVDMCClusterPositionFudgeFactor::getFudgeFactor
double getFudgeFactor(const Belle2::VxdID &sensorID, const bool &isU, const double &trkAngle) const
Return the MC fudge factor.
Definition: SVDMCClusterPositionFudgeFactor.h:49
Belle2::SVDTrueHit
Class SVDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: SVDTrueHit.h:33
Belle2::SVD::SVDClusterizerModule::m_mcPositionFudgeFactor
SVDMCClusterPositionFudgeFactor m_mcPositionFudgeFactor
SVDMCClusterPositionFudgeFactor db object.
Definition: SVDClusterizerModule.h:151
Belle2::SVD::SVDClusterizerModule::m_storeClusters
StoreArray< SVDCluster > m_storeClusters
Collection of SVDClusters.
Definition: SVDClusterizerModule.h:93
Belle2::StoreArray::getEntries
int getEntries() const
Get the number of objects in the array.
Definition: StoreArray.h:216
Belle2::VXDTrueHit::getEntryU
float getEntryU() const
Return local u coordinate of hit when entering silicon.
Definition: VXDTrueHit.h:80
Belle2::VXDTrueHit::getExitW
float getExitW() const
Return local w coordinate of hit at the endpoint of the track.
Definition: VXDTrueHit.h:90
Belle2::VXDTrueHit::getEntryW
float getEntryW() const
Return local w coordinate of the start point of the track.
Definition: VXDTrueHit.h:84
Belle2::VXDTrueHit::getExitU
float getExitU() const
Return local u coordinate of hit at the endpoint of the track.
Definition: VXDTrueHit.h:86
Belle2::VXDTrueHit::getExitV
float getExitV() const
Return local v coordinate of hit at the endpoint of the track.
Definition: VXDTrueHit.h:88
Belle2::VXDTrueHit::getEntryV
float getEntryV() const
Return local v coordinate of the start point of the track.
Definition: VXDTrueHit.h:82
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:33
Belle2::VxdID::getLayerNumber
baseType getLayerNumber() const
Get the layer id.
Definition: VxdID.h:96

◆ alterClusterTime()

void alterClusterTime ( )
protected

alter the cluster time (applied on MC to match resolution measured on data)

Definition at line 539 of file SVDClusterizerModule.cc.

540{
541 // alter the time of the last cluster in the array
542 int clsIndex = m_storeClusters.getEntries() - 1;
543
544 // get the necessary information on the cluster
545 float clsTime = m_storeClusters[clsIndex]->getClsTime();
546 VxdID sensorID = m_storeClusters[clsIndex]->getSensorID();
547 bool isU = m_storeClusters[clsIndex]->isUCluster();
548
549 // get the appropriate sigma to alter the time
550 double sigma = m_mcTimeFudgeFactor.getFudgeFactor(sensorID, isU);
551
552 // do the job
553 float fudgeFactor = (float) gRandom->Gaus(0., sigma);
554 m_storeClusters[clsIndex]->setClsTime(clsTime + fudgeFactor);
555
556 B2DEBUG(20, "Layer number: " << sensorID.getLayerNumber() << ", is U side: " << isU << ", sigma: " << sigma <<
557 ", cluster time: " << clsTime << ", fudge factor: " << fudgeFactor);
558}
Belle2::SVDMCClusterTimeFudgeFactor::getFudgeFactor
double getFudgeFactor(const Belle2::VxdID &sensorID, const bool &isU) const
Return the MC fudge factor.
Definition: SVDMCClusterTimeFudgeFactor.h:47
Belle2::SVD::SVDClusterizerModule::m_mcTimeFudgeFactor
SVDMCClusterTimeFudgeFactor m_mcTimeFudgeFactor
SVDMCClusterTimeFudgeFactor db object.
Definition: SVDClusterizerModule.h:152

◆ applyLorentzShiftCorrection()

double applyLorentzShiftCorrection ( double  position,
VxdID  vxdID,
bool  isU 
)
protected

returns the position of the cluster after lorentz shift correction

Definition at line 486 of file SVDClusterizerModule.cc.

487{
488
489 //Lorentz shift correction - PATCHED
490 //NOTE: layer 3 is upside down with respect to L4,5,6 in the real data (real SVD), but _not_ in the simulation. We need to change the sign of the Lorentz correction on L3 only if reconstructing data, i.e. if Environment::Instance().isMC() is FALSE.
491
492 const SensorInfo& sensorInfo = dynamic_cast<const SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(vxdID));
493
494 bool isMC = Environment::Instance().isMC();
495
496 if ((vxdID.getLayerNumber() == 3) && ! isMC)
497 position += sensorInfo.getLorentzShift(isU, position);
498 else
499 position -= sensorInfo.getLorentzShift(isU, position);
500
501 return position;
502}
Belle2::Environment::isMC
bool isMC() const
Do we have generated, not real data?
Definition: Environment.cc:54
Belle2::Environment::Instance
static Environment & Instance()
Static method to get a reference to the Environment instance.
Definition: Environment.cc:28
Belle2::SVD::SensorInfo
Specific implementation of SensorInfo for SVD Sensors which provides additional sensor specific infor...
Definition: SensorInfo.h:25
Belle2::SVD::SensorInfo::getLorentzShift
const ROOT::Math::XYZVector & getLorentzShift(double uCoord, double vCoord) const
Calculate Lorentz shift along a given coordinate in a magnetic field at a given position.
Definition: SensorInfo.cc:104
Belle2::VXD::GeoCache::getSensorInfo
const SensorInfoBase & getSensorInfo(Belle2::VxdID id) const
Return a referecne to the SensorInfo of a given SensorID.
Definition: GeoCache.cc:67
Belle2::VXD::GeoCache::getInstance
static GeoCache & getInstance()
Return a reference to the singleton instance.
Definition: GeoCache.cc:214

◆ beginRun()

void beginRun ( void  )
overridevirtual

configure clustering

Reimplemented from Module.

Definition at line 113 of file SVDClusterizerModule.cc.

114{
115 if (m_useDB) {
116 if (!m_recoConfig.isValid())
117 B2FATAL("no valid configuration found for SVD reconstruction");
118 else
119 B2DEBUG(20, "SVDRecoConfiguration: from now on we are using " << m_recoConfig->get_uniqueID());
120
121 m_timeRecoWith6SamplesAlgorithm = m_recoConfig->getTimeRecoWith6Samples();
122 //m_timeRecoWith6SamplesAlgorithm = "ELS3";
123 //m_timeRecoWith3SamplesAlgorithm = "ELS3";
124 m_timeRecoWith3SamplesAlgorithm = m_recoConfig->getTimeRecoWith3Samples();
125 m_chargeRecoWith6SamplesAlgorithm = m_recoConfig->getChargeRecoWith6Samples();
126 m_chargeRecoWith3SamplesAlgorithm = m_recoConfig->getChargeRecoWith3Samples();
127 m_positionRecoWith6SamplesAlgorithm = m_recoConfig->getPositionRecoWith6Samples();
128 m_positionRecoWith3SamplesAlgorithm = m_recoConfig->getPositionRecoWith3Samples();
129
130 //strip algorithms
131 m_stripTimeRecoWith6SamplesAlgorithm = m_recoConfig->getStripTimeRecoWith6Samples();
132 m_stripTimeRecoWith3SamplesAlgorithm = m_recoConfig->getStripTimeRecoWith3Samples();
133 m_stripChargeRecoWith6SamplesAlgorithm = m_recoConfig->getStripChargeRecoWith6Samples();
134 m_stripChargeRecoWith3SamplesAlgorithm = m_recoConfig->getStripChargeRecoWith3Samples();
135
136 }
137 //check that all algorithms are available, otherwise use the default one
138 SVDReconstructionBase recoBase;
139
140 if (!recoBase.isTimeAlgorithmAvailable(m_timeRecoWith6SamplesAlgorithm)) {
141 B2WARNING("cluster time algorithm " << m_timeRecoWith6SamplesAlgorithm << " is NOT available, using CoG3");
142 m_timeRecoWith6SamplesAlgorithm = "CoG3";
143 };
144
145 if (!recoBase.isTimeAlgorithmAvailable(m_timeRecoWith3SamplesAlgorithm)) {
146 B2WARNING("cluster time algorithm " << m_timeRecoWith3SamplesAlgorithm << " is NOT available, using CoG3");
147 m_timeRecoWith3SamplesAlgorithm = "CoG3";
148 };
149 if (!recoBase.isChargeAlgorithmAvailable(m_chargeRecoWith6SamplesAlgorithm)) {
150 B2WARNING("cluster charge algorithm " << m_chargeRecoWith6SamplesAlgorithm << " is NOT available, using MaxSample");
151 m_chargeRecoWith6SamplesAlgorithm = "MaxSample";
152 };
153 if (!recoBase.isChargeAlgorithmAvailable(m_chargeRecoWith3SamplesAlgorithm)) {
154 B2WARNING("cluster charge algorithm " << m_chargeRecoWith3SamplesAlgorithm << " is NOT available, using MaxSample");
155 m_chargeRecoWith3SamplesAlgorithm = "MaxSample";
156 };
157 if (!recoBase.isPositionAlgorithmAvailable(m_positionRecoWith6SamplesAlgorithm)) {
158 B2WARNING("cluster position algorithm " << m_positionRecoWith6SamplesAlgorithm << " is NOT available, using OldDefault");
159 m_positionRecoWith6SamplesAlgorithm = "OldDefault";
160 };
161 if (!recoBase.isPositionAlgorithmAvailable(m_positionRecoWith3SamplesAlgorithm)) {
162 B2WARNING("cluster position algorithm " << m_positionRecoWith3SamplesAlgorithm << " is NOT available, using OldDefault");
163 m_positionRecoWith3SamplesAlgorithm = "OldDefault";
164 };
165
166
167 m_time6SampleClass = SVDRecoTimeFactory::NewTime(m_timeRecoWith6SamplesAlgorithm, m_returnRawClusterTime);
168 m_time3SampleClass = SVDRecoTimeFactory::NewTime(m_timeRecoWith3SamplesAlgorithm, m_returnRawClusterTime);
169 m_charge6SampleClass = SVDRecoChargeFactory::NewCharge(m_chargeRecoWith6SamplesAlgorithm);
170 m_charge3SampleClass = SVDRecoChargeFactory::NewCharge(m_chargeRecoWith3SamplesAlgorithm);
171 m_position6SampleClass = SVDRecoPositionFactory::NewPosition(m_positionRecoWith6SamplesAlgorithm);
172 m_position6SampleClass->set_stripChargeAlgo(m_stripChargeRecoWith6SamplesAlgorithm);
173 m_position6SampleClass->set_stripTimeAlgo(m_stripTimeRecoWith6SamplesAlgorithm);
174 m_position3SampleClass = SVDRecoPositionFactory::NewPosition(m_positionRecoWith3SamplesAlgorithm);
175 m_position3SampleClass->set_stripChargeAlgo(m_stripChargeRecoWith3SamplesAlgorithm);
176 m_position3SampleClass->set_stripTimeAlgo(m_stripTimeRecoWith3SamplesAlgorithm);
177
178 string israwtime = "";
179 if (m_returnRawClusterTime) israwtime = " (raw)";
180 B2INFO("SVD 6-sample DAQ, cluster time algorithm: " << m_timeRecoWith6SamplesAlgorithm << israwtime <<
181 ", cluster charge algorithm: " <<
182 m_chargeRecoWith6SamplesAlgorithm << ", cluster position algorithm: " << m_positionRecoWith6SamplesAlgorithm);
183 B2INFO(" with strip charge reconstructed with " << m_stripChargeRecoWith6SamplesAlgorithm << " and strip time reconstructed with "
184 <<
185 m_stripTimeRecoWith6SamplesAlgorithm);
186
187 B2INFO("SVD 3-sample DAQ, cluster time algorithm: " << m_timeRecoWith3SamplesAlgorithm << israwtime <<
188 ", cluster charge algorithm: " <<
189 m_chargeRecoWith3SamplesAlgorithm << ", cluster position algorithm: " << m_positionRecoWith3SamplesAlgorithm);
190 B2INFO(" with strip charge reconstructed with " << m_stripChargeRecoWith3SamplesAlgorithm << " and strip time reconstructed with "
191 <<
192 m_stripTimeRecoWith3SamplesAlgorithm);
193}
Belle2::SVD::SVDClusterPosition::set_stripChargeAlgo
void set_stripChargeAlgo(const std::string &user_stripChargeAlgo)
set which algorithm to use for strip charge in cluster position reconstruction
Definition: SVDClusterPosition.h:59
Belle2::SVD::SVDClusterPosition::set_stripTimeAlgo
void set_stripTimeAlgo(const std::string &user_stripTimeAlgo)
set which algorithm to use for strip time in cluster position reconstruction, 'dontdo' will skip it
Definition: SVDClusterPosition.h:62
Belle2::SVD::SVDClusterizerModule::m_charge6SampleClass
SVDClusterCharge * m_charge6SampleClass
cluster charge class for the 6-sample acquisition mode
Definition: SVDClusterizerModule.h:137
Belle2::SVD::SVDClusterizerModule::m_charge3SampleClass
SVDClusterCharge * m_charge3SampleClass
cluster charge class for the 3-sample acquisition mode
Definition: SVDClusterizerModule.h:138
Belle2::SVD::SVDClusterizerModule::m_position3SampleClass
SVDClusterPosition * m_position3SampleClass
cluster position class for the 3-sample acquisition mode
Definition: SVDClusterizerModule.h:140
Belle2::SVD::SVDClusterizerModule::m_time6SampleClass
SVDClusterTime * m_time6SampleClass
cluster time class for the 6-sample acquisition mode
Definition: SVDClusterizerModule.h:135
Belle2::SVD::SVDClusterizerModule::m_position6SampleClass
SVDClusterPosition * m_position6SampleClass
cluster position class for the 6-sample acquisition mode
Definition: SVDClusterizerModule.h:139
Belle2::SVD::SVDClusterizerModule::m_recoConfig
DBObjPtr< SVDRecoConfiguration > m_recoConfig
SVD Reconstruction Configuration payload.
Definition: SVDClusterizerModule.h:148
Belle2::SVD::SVDClusterizerModule::m_time3SampleClass
SVDClusterTime * m_time3SampleClass
cluster time class for the 3-sample acquisition mode
Definition: SVDClusterizerModule.h:136
Belle2::SVD::SVDRecoChargeFactory::NewCharge
static SVDClusterCharge * NewCharge(const std::string &description)
static function that returns the class to compute the cluster charge
Definition: SVDRecoChargeFactory.h:31
Belle2::SVD::SVDRecoPositionFactory::NewPosition
static SVDClusterPosition * NewPosition(const std::string &description)
static function that returns the class to compute the cluster position
Definition: SVDRecoPositionFactory.h:30
Belle2::SVD::SVDRecoTimeFactory::NewTime
static SVDClusterTime * NewTime(const std::string &description, const bool &returnRawClusterTime)
static function that returns the class to compute the cluster time
Definition: SVDRecoTimeFactory.h:31
Belle2::SVD::SVDReconstructionBase
Class to check whether the reconstruction algorithms are available or not.
Definition: SVDReconstructionBase.h:18
Belle2::SVD::SVDReconstructionBase::isChargeAlgorithmAvailable
bool isChargeAlgorithmAvailable(TString chargeAlg)
Definition: SVDReconstructionBase.h:48
Belle2::SVD::SVDReconstructionBase::isTimeAlgorithmAvailable
bool isTimeAlgorithmAvailable(TString timeAlg)
Definition: SVDReconstructionBase.h:40
Belle2::SVD::SVDReconstructionBase::isPositionAlgorithmAvailable
bool isPositionAlgorithmAvailable(TString positionAlg)
Definition: SVDReconstructionBase.h:56

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

180{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
Belle2::ModuleManager::registerModule
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
Definition: ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition: ModuleManager.cc:24
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
Belle2::ModulePtr
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

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

426{ beginRun(); }
Belle2::Module::beginRun
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

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

439{ endRun(); }
Belle2::Module::endRun
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

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

432{ event(); }
Belle2::Module::event
virtual void event()
This method is the core of the module.
Definition: Module.h:157

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

420{ initialize(); }
Belle2::Module::initialize
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

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

445{ terminate(); }
Belle2::Module::terminate
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

delete pointers

Reimplemented from Module.

Definition at line 580 of file SVDClusterizerModule.cc.

581{
582
583 delete m_time6SampleClass;
584 delete m_time3SampleClass;
585 delete m_charge6SampleClass;
586 delete m_charge3SampleClass;
587 delete m_position6SampleClass;
588 delete m_position3SampleClass;
589
590}

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

does the actual clustering

Reimplemented from Module.

Definition at line 251 of file SVDClusterizerModule.cc.

252{
253 int nDigits = m_storeDigits.getEntries();
254 if (nDigits == 0)
255 return;
256
257 m_storeClusters.clear();
258
259
260 RelationArray relClusterMCParticle(m_storeClusters, m_storeMCParticles,
261 m_relClusterMCParticleName);
262 if (relClusterMCParticle) relClusterMCParticle.clear();
263
264 RelationArray relClusterDigit(m_storeClusters, m_storeDigits,
265 m_relClusterShaperDigitName);
266 if (relClusterDigit) relClusterDigit.clear();
267
268 RelationArray relClusterTrueHit(m_storeClusters, m_storeTrueHits,
269 m_relClusterTrueHitName);
270 if (relClusterTrueHit) relClusterTrueHit.clear();
271
272 if (m_useDB) {
273 m_cutSeed = m_ClusterCal.getMinSeedSNR(m_storeDigits[0]->getSensorID(), m_storeDigits[0]->isUStrip());
274 m_cutAdjacent = m_ClusterCal.getMinAdjSNR(m_storeDigits[0]->getSensorID(), m_storeDigits[0]->isUStrip());
275 m_cutCluster = m_ClusterCal.getMinClusterSNR(m_storeDigits[0]->getSensorID(), m_storeDigits[0]->isUStrip());
276 }
277
278 //create a dummy cluster just to start
279 RawCluster rawCluster(m_storeDigits[0]->getSensorID(), m_storeDigits[0]->isUStrip(), m_cutSeed, m_cutAdjacent,
280 m_storeShaperDigitsName);
281
282 //loop over the SVDShaperDigits
283 for (const SVDShaperDigit& currentDigit : m_storeDigits) {
284
285 //retrieve the VxdID, sensor and cellID of the current ShaperDigit
286 VxdID thisSensorID = currentDigit.getSensorID();
287 bool thisSide = currentDigit.isUStrip();
288 int thisCellID = currentDigit.getCellID();
289
290 if (m_useDB) {
291 m_cutSeed = m_ClusterCal.getMinSeedSNR(thisSensorID, thisSide);
292 m_cutAdjacent = m_ClusterCal.getMinAdjSNR(thisSensorID, thisSide);
293 m_cutCluster = m_ClusterCal.getMinClusterSNR(thisSensorID, thisSide);
294 }
295
296 //Ignore digits with insufficient signal
297 float thisNoise = m_NoiseCal.getNoise(thisSensorID, thisSide, thisCellID);
298 int thisCharge = currentDigit.getMaxADCCounts();
299 B2DEBUG(20, "Noise = " << thisNoise << " ADC, MaxSample = " << thisCharge << " ADC");
300
301 if ((float)thisCharge / thisNoise < m_cutAdjacent)
302 continue;
303
304 //this strip has a sufficient S/N
305 StripInRawCluster aStrip;
306 aStrip.shaperDigitIndex = currentDigit.getArrayIndex();
307 aStrip.maxSample = thisCharge;
308 aStrip.cellID = thisCellID;
309 aStrip.noise = thisNoise;
310 aStrip.samples = currentDigit.getSamples();
311
312 //try to add the strip to the existing cluster
313 if (! rawCluster.add(thisSensorID, thisSide, aStrip)) {
314
315 //if the strip is not added, write the cluster, if present and good:
316 if ((rawCluster.getSize() > 0) && (rawCluster.isGoodRawCluster()))
317 finalizeCluster(rawCluster);
318
319 //prepare for the next cluster:
320 rawCluster = RawCluster(thisSensorID, thisSide, m_cutSeed, m_cutAdjacent, m_storeShaperDigitsName);
321
322 //start another cluster:
323 if (! rawCluster.add(thisSensorID, thisSide, aStrip))
324 B2WARNING("this state is forbidden!!");
325
326 }
327 } //exit loop on ShaperDigits
328
329 //write the last cluster, if good
330 if ((rawCluster.getSize() > 0) && (rawCluster.isGoodRawCluster()))
331 finalizeCluster(rawCluster);
332
333 B2DEBUG(20, "Number of clusters: " << m_storeClusters.getEntries());
334}
Belle2::RelationArray
Low-level class to create/modify relations between StoreArrays.
Definition: RelationArray.h:62
Belle2::SVDClustering::getMinClusterSNR
double getMinClusterSNR(const Belle2::VxdID &sensorID, const bool &isU) const
Return the minimum SNR for the cluster.
Definition: SVDClustering.h:119
Belle2::SVDClustering::getMinSeedSNR
double getMinSeedSNR(const Belle2::VxdID &sensorID, const bool &isU) const
Return the minimum SNR for the seed.
Definition: SVDClustering.h:54
Belle2::SVDClustering::getMinAdjSNR
double getMinAdjSNR(const Belle2::VxdID &sensorID, const bool &isU) const
Return the minimum SNR for the adjacent.
Definition: SVDClustering.h:75
Belle2::SVDNoiseCalibrations::getNoise
float getNoise(const VxdID &sensorID, const bool &isU, const unsigned short &strip) const
This is the method for getting the noise.
Definition: SVDNoiseCalibrations.h:58
Belle2::SVDShaperDigit
The SVD ShaperDigit class.
Definition: SVDShaperDigit.h:32
Belle2::SVD::RawCluster
Class representing a raw cluster candidate during clustering of the SVD.
Definition: RawCluster.h:33
Belle2::SVD::SVDClusterizerModule::m_storeTrueHits
StoreArray< SVDTrueHit > m_storeTrueHits
Collection of SVDTrueHits.
Definition: SVDClusterizerModule.h:97
Belle2::SVD::SVDClusterizerModule::m_storeDigits
StoreArray< SVDShaperDigit > m_storeDigits
Collection of SVDShaperDigits.
Definition: SVDClusterizerModule.h:95
Belle2::SVD::SVDClusterizerModule::m_storeMCParticles
StoreArray< MCParticle > m_storeMCParticles
Collection of MCParticles.
Definition: SVDClusterizerModule.h:99
Belle2::SVD::SVDClusterizerModule::m_NoiseCal
SVDNoiseCalibrations m_NoiseCal
SVDNoise calibrations db object.
Definition: SVDClusterizerModule.h:149
Belle2::SVD::SVDClusterizerModule::m_ClusterCal
SVDClustering m_ClusterCal
SVDCluster calibrations db object.
Definition: SVDClusterizerModule.h:150
Belle2::SVD::SVDClusterizerModule::m_relClusterShaperDigitName
std::string m_relClusterShaperDigitName
Name of the relation between SVDClusters and SVDShaperDigits.
Definition: SVDClusterizerModule.h:86
Belle2::SVD::SVDClusterizerModule::m_relClusterMCParticleName
std::string m_relClusterMCParticleName
Name of the relation between SVDClusters and MCParticles.
Definition: SVDClusterizerModule.h:84
Belle2::SVD::SVDClusterizerModule::finalizeCluster
void finalizeCluster(Belle2::SVD::RawCluster &rawCluster)
computes charge, position and time of the raw cluster and appends the new SVDCluster to the StoreArra...
Definition: SVDClusterizerModule.cc:337
Belle2::SVD::SVDClusterizerModule::m_relClusterTrueHitName
std::string m_relClusterTrueHitName
Name of the relation between SVDClusters and SVDTrueHits.
Definition: SVDClusterizerModule.h:90
Belle2::StoreArray::clear
void clear() override
Delete all entries in this array.
Definition: StoreArray.h:207
Belle2::SVD::StripInRawCluster
structure containing the relevant informations of each strip of the raw cluster
Definition: RawCluster.h:20
Belle2::SVD::StripInRawCluster::samples
Belle2::SVDShaperDigit::APVFloatSamples samples
ADC of the acquired samples.
Definition: RawCluster.h:25
Belle2::SVD::StripInRawCluster::shaperDigitIndex
int shaperDigitIndex
index of the shaper digit
Definition: RawCluster.h:21
Belle2::SVD::StripInRawCluster::maxSample
int maxSample
ADC max of the acquired samples.
Definition: RawCluster.h:23

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
350 .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
351 .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
352 .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
353 .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
354 .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
355 .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
491 &Module::setLogConfig)
Belle2::ModuleCondition::c_GE
@ c_GE
Greater or equal than: ">=".
Definition: ModuleCondition.h:35
Belle2::ModuleCondition::c_SE
@ c_SE
Smaller or equal than: "<=".
Definition: ModuleCondition.h:36
Belle2::ModuleCondition::c_GT
@ c_GT
Greater than: ">"
Definition: ModuleCondition.h:33
Belle2::ModuleCondition::c_NE
@ c_NE
Not equal: "!=".
Definition: ModuleCondition.h:38
Belle2::ModuleCondition::c_EQ
@ c_EQ
Equal: "=" or "=="
Definition: ModuleCondition.h:37
Belle2::ModuleCondition::c_ST
@ c_ST
Smaller than: "<"
Definition: ModuleCondition.h:34
Belle2::Module
Base class for Modules.
Definition: Module.h:72
Belle2::Module::getLogConfig
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
Belle2::Module::if_value
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
Belle2::Module::if_true
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
Belle2::Module::setReturnValue
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
Belle2::Module::setLogConfig
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
Belle2::Module::getDescription
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
Belle2::Module::if_false
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
Belle2::Module::hasCondition
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
Belle2::Module::getPackage
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
Belle2::Module::setName
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
Belle2::Module::hasProperties
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
Belle2::Module::getPathString
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ finalizeCluster()

void finalizeCluster ( Belle2::SVD::RawCluster &  rawCluster)
protected

computes charge, position and time of the raw cluster and appends the new SVDCluster to the StoreArray

Definition at line 337 of file SVDClusterizerModule.cc.

338{
339
340 VxdID sensorID = rawCluster.getSensorID();
341 bool isU = rawCluster.isUSide();
342 int size = rawCluster.getSize();
343
344 //first take Event Informations:
345 StoreObjPtr<SVDEventInfo> temp_eventinfo(m_svdEventInfoName);
346 if (!temp_eventinfo.isValid())
347 m_svdEventInfoName = "SVDEventInfoSim";
348 StoreObjPtr<SVDEventInfo> eventinfo(m_svdEventInfoName);
349 if (!eventinfo) B2ERROR("No SVDEventInfo!");
350 eventinfo->setAPVClock(m_hwClock);
351
352
353 m_numberOfAcquiredSamples = eventinfo->getNSamples();
354
355 //--------------
356 // CLUSTER RECO
357 //--------------
358 double time = std::numeric_limits<double>::quiet_NaN();
359 double timeError = std::numeric_limits<double>::quiet_NaN();
360 int firstFrame = std::numeric_limits<int>::quiet_NaN();
361
362 double charge = std::numeric_limits<double>::quiet_NaN();
363 double seedCharge = std::numeric_limits<float>::quiet_NaN();
364 double SNR = std::numeric_limits<double>::quiet_NaN();
365
366 double position = std::numeric_limits<float>::quiet_NaN();
367 double positionError = std::numeric_limits<float>::quiet_NaN();
368
369
370 if (m_numberOfAcquiredSamples == 6) {
371
372 //time
373 m_time6SampleClass->computeClusterTime(rawCluster, time, timeError, firstFrame);
374 //charge
375 m_charge6SampleClass->computeClusterCharge(rawCluster, charge, SNR, seedCharge);
376
377 //position
378 m_position6SampleClass->computeClusterPosition(rawCluster, position, positionError);
379 } else if (m_numberOfAcquiredSamples == 3) {
380 //time
381 m_time3SampleClass->computeClusterTime(rawCluster, time, timeError, firstFrame);
382
383 //charge
384 m_charge3SampleClass->computeClusterCharge(rawCluster, charge, SNR, seedCharge);
385
386 //position
387 m_position3SampleClass->computeClusterPosition(rawCluster, position, positionError);
388
389 } else //we should never get here!
390 B2FATAL("SVD Reconstruction not available for this cluster (unrecognized or not supported number of acquired APV samples!!");
391
392 // now go into FTSW time reference frame
393 time = eventinfo->getTimeInFTSWReference(time, firstFrame);
394
395 //apply the Lorentz Shift Correction
396 position = applyLorentzShiftCorrection(position, sensorID, isU);
397
398 //append the new cluster to the StoreArray...
399 if (SNR > m_cutCluster) {
400 m_storeClusters.appendNew(sensorID, isU, position, positionError, time, timeError, charge, seedCharge, size, SNR, -1,
401 firstFrame);
402
403 B2DEBUG(20, "CLUSTER SIZE = " << size);
404 B2DEBUG(20, " time = " << time << ", timeError = " << timeError << ", firstframe = " << firstFrame);
405 B2DEBUG(20, " charge = " << charge << ", SNR = " << SNR << ", seedCharge = " << seedCharge);
406 B2DEBUG(20, " position = " << position << ", positionError = " << positionError);
407
408 //..and write relations
409 writeClusterRelations(rawCluster);
410
411 //alter cluster position and time on MC to match resolution measured on data
412 bool isMC = Environment::Instance().isMC();
413 if (isMC) {
414 alterClusterPosition();
415 alterClusterTime();
416 } else {
417 if (m_svdClusterTimeShifter.isValid() &&
418 !m_returnRawClusterTime &&
419 m_shiftSVDClusterTime) {
420 shiftSVDClusterTime();
421 }
422 }
423 }
424}
Belle2::SVD::RawCluster::isUSide
bool isUSide() const
Definition: RawCluster.h:85
Belle2::SVD::RawCluster::getSensorID
VxdID getSensorID() const
Definition: RawCluster.h:80
Belle2::SVD::SVDClusterCharge::computeClusterCharge
virtual void computeClusterCharge(Belle2::SVD::RawCluster &rawCluster, double &charge, double &SNR, double &seedCharge)=0
computes the cluster charge, SNR and seedCharge
Belle2::SVD::SVDClusterPosition::computeClusterPosition
virtual void computeClusterPosition(Belle2::SVD::RawCluster &rawCluster, double &position, double &positionError)=0
computes the cluster position and position error
Belle2::SVD::SVDClusterTime::computeClusterTime
virtual void computeClusterTime(Belle2::SVD::RawCluster &rawCluster, double &time, double &timeError, int &firstFrame)=0
computes the cluster time, timeError and FirstFrame
Belle2::SVD::SVDClusterizerModule::applyLorentzShiftCorrection
double applyLorentzShiftCorrection(double position, VxdID vxdID, bool isU)
returns the position of the cluster after lorentz shift correction
Definition: SVDClusterizerModule.cc:486
Belle2::SVD::SVDClusterizerModule::m_svdClusterTimeShifter
DBObjPtr< SVDClusterTimeShifter > m_svdClusterTimeShifter
SVDCluster time shift.
Definition: SVDClusterizerModule.h:153
Belle2::SVD::SVDClusterizerModule::alterClusterPosition
void alterClusterPosition()
alter the cluster position (applied on MC to match resolution measured on data)
Definition: SVDClusterizerModule.cc:504
Belle2::SVD::SVDClusterizerModule::writeClusterRelations
void writeClusterRelations(const Belle2::SVD::RawCluster &rawCluster)
writes the relations of the SVDClusters with the other StoreArrays
Definition: SVDClusterizerModule.cc:426
Belle2::SVD::SVDClusterizerModule::m_numberOfAcquiredSamples
int m_numberOfAcquiredSamples
number of acquired samples, can be 6 or 3 (1 is not supported!)
Definition: SVDClusterizerModule.h:112
Belle2::SVD::SVDClusterizerModule::m_hwClock
DBObjPtr< HardwareClockSettings > m_hwClock
systems clock
Definition: SVDClusterizerModule.h:147
Belle2::SVD::SVDClusterizerModule::shiftSVDClusterTime
void shiftSVDClusterTime()
Apply cluster time shift depending on cluster size.
Definition: SVDClusterizerModule.cc:560
Belle2::SVD::SVDClusterizerModule::alterClusterTime
void alterClusterTime()
alter the cluster time (applied on MC to match resolution measured on data)
Definition: SVDClusterizerModule.cc:539
Belle2::StoreArray::appendNew
T * appendNew()
Construct a new T object at the end of the array.
Definition: StoreArray.h:246
Belle2::StoreObjPtr
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:96
Belle2::EvtPDLUtil::charge
double charge(int pdgCode)
Returns electric charge of a particle with given pdg code.
Definition: EvtPDLUtil.cc:44

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
Belle2::PathPtr
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
Belle2::Module::m_description
std::string m_description
The description of the module.
Definition: Module.h:511

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

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

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

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

187{return m_name;}
Belle2::Module::m_name
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

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

280{
281 return m_moduleParamList.getParamInfoListPython();
282}
Belle2::ModuleParamList::getParamInfoListPython
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
Definition: ModuleParamList.cc:64
Belle2::Module::m_moduleParamList
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

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

381{ return m_returnValue; }

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
Belle2::Module::m_type
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

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

311{ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

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

167{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition: ModuleParamList.cc:54

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

Initialize the module.

Reimplemented from Module.

Definition at line 195 of file SVDClusterizerModule.cc.

196{
197 //Register collections
198 m_storeClusters.registerInDataStore(m_storeClustersName, DataStore::c_ErrorIfAlreadyRegistered);
199 m_storeDigits.isRequired(m_storeShaperDigitsName);
200 m_storeTrueHits.isOptional(m_storeTrueHitsName);
201 m_storeMCParticles.isOptional(m_storeMCParticlesName);
202
203 RelationArray relClusterDigits(m_storeClusters, m_storeDigits);
204 RelationArray relClusterTrueHits(m_storeClusters, m_storeTrueHits);
205 RelationArray relClusterMCParticles(m_storeClusters, m_storeMCParticles);
206 RelationArray relDigitTrueHits(m_storeDigits, m_storeTrueHits);
207 RelationArray relDigitMCParticles(m_storeDigits, m_storeMCParticles);
208
209 relClusterDigits.registerInDataStore();
210
211 //Relations to simulation objects only if the ancestor relations exist
212 if (relDigitTrueHits.isOptional())
213 relClusterTrueHits.registerInDataStore();
214
215 if (relDigitMCParticles.isOptional())
216 relClusterMCParticles.registerInDataStore();
217
218 //Store names to speed up creation later
219 m_storeClustersName = m_storeClusters.getName();
220 m_storeShaperDigitsName = m_storeDigits.getName();
221 m_storeTrueHitsName = m_storeTrueHits.getName();
222 m_storeMCParticlesName = m_storeMCParticles.getName();
223
224 m_relClusterShaperDigitName = relClusterDigits.getName();
225 m_relClusterTrueHitName = relClusterTrueHits.getName();
226 m_relClusterMCParticleName = relClusterMCParticles.getName();
227 m_relShaperDigitTrueHitName = relDigitTrueHits.getName();
228 m_relShaperDigitMCParticleName = relDigitMCParticles.getName();
229
230 // Report:
231 B2DEBUG(20, "SVDClusterizer Parameters (in default system unit, *=cannot be set directly):");
232
233 B2DEBUG(20, " 1. COLLECTIONS:");
234 B2DEBUG(20, " --> MCParticles: " << m_storeMCParticlesName);
235 B2DEBUG(20, " --> SVDShaperDigits: " << m_storeShaperDigitsName);
236 B2DEBUG(20, " --> SVDClusters: " << m_storeClustersName);
237 B2DEBUG(20, " --> SVDTrueHits: " << m_storeTrueHitsName);
238 B2DEBUG(20, " 2. RELATIONS:");
239 B2DEBUG(20, " --> DigitMCRel: " << m_relShaperDigitMCParticleName);
240 B2DEBUG(20, " --> ClusterMCRel: " << m_relClusterMCParticleName);
241 B2DEBUG(20, " --> ClusterDigitRel: " << m_relClusterShaperDigitName);
242 B2DEBUG(20, " --> DigitTrueRel: " << m_relShaperDigitTrueHitName);
243 B2DEBUG(20, " --> ClusterTrueRel: " << m_relClusterTrueHitName);
244 B2DEBUG(20, " 3. CLUSTERING:");
245 B2DEBUG(20, " --> Neighbour cut: " << m_cutAdjacent);
246 B2DEBUG(20, " --> Seed cut: " << m_cutSeed);
247}
Belle2::DataStore::c_ErrorIfAlreadyRegistered
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:72
Belle2::SVD::SVDClusterizerModule::m_relShaperDigitMCParticleName
std::string m_relShaperDigitMCParticleName
Name of the relation between SVDShaperDigits and MCParticles.
Definition: SVDClusterizerModule.h:82
Belle2::SVD::SVDClusterizerModule::m_relShaperDigitTrueHitName
std::string m_relShaperDigitTrueHitName
Name of the relation between SVDShaperDigits and SVDTrueHits.
Definition: SVDClusterizerModule.h:88
Belle2::StoreAccessorBase::getName
const std::string & getName() const
Return name under which the object is saved in the DataStore.
Definition: StoreAccessorBase.h:128
Belle2::StoreAccessorBase::isOptional
bool isOptional(const std::string &name="")
Tell the DataStore about an optional input.
Definition: StoreAccessorBase.h:93
Belle2::StoreAccessorBase::registerInDataStore
bool registerInDataStore(DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut)
Register the object/array in the DataStore.
Definition: StoreAccessorBase.h:52

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
Belle2::LogConfig::setDebugLevel
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig &  logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
Belle2::LogConfig::setLogInfo
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
Belle2::LogConfig::setLogLevel
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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
nameThe name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList &  params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
239 m_moduleParamList.setParamPython(name, pyObj);
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
Belle2::Module::setParamPython
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ shiftSVDClusterTime()

void shiftSVDClusterTime ( )
protected

Apply cluster time shift depending on cluster size.

Definition at line 560 of file SVDClusterizerModule.cc.

561{
562 // alter the time of the last cluster in the array
563 int clsIndex = m_storeClusters.getEntries() - 1;
564
565 // get the necessary information on the cluster
566 float clsTime = m_storeClusters[clsIndex]->getClsTime();
567
568 TString algo = m_timeRecoWith6SamplesAlgorithm;
569 if (m_numberOfAcquiredSamples == 3) algo = m_timeRecoWith3SamplesAlgorithm;
570
571 clsTime -= m_svdClusterTimeShifter->getClusterTimeShift(algo,
572 m_storeClusters[clsIndex]->getSensorID().getLayerNumber(),
573 m_storeClusters[clsIndex]->getSensorID().getSensorNumber(),
574 m_storeClusters[clsIndex]->isUCluster(),
575 m_storeClusters[clsIndex]->getSize());
576
577 m_storeClusters[clsIndex]->setClsTime(clsTime);
578}

◆ terminate()

virtual void terminate ( void  )
inlinevirtualinherited

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

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

This method can be implemented by subclasses.

Reimplemented in ARICHBackgroundModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, CosmicsAlignmentValidationModule, CurlTaggerModule, EventKinematicsModule, FlavorTaggerInfoFillerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleKinematicFitterModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, RemoveParticlesNotInListsModule, SkimFilterModule, TreeFitterModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, arichBtestModule, ARICHNtupleModule, arichToNtupleModule, B2BIIMCParticlesMonitorModule, 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, CDCCrossTalkAdderModule, CDCCRTestModule, CDCDigitizerModule, cdcDQM7Module, CDCDQMModule, ScanCDCGeoModule, CDCInitialT0DeterminationModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, ElapsedTimeModule, DeSerializerModule, DeSerializerPXDModule, GenRawSendModule, Root2RawModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, DisplayModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLClusterPSDModule, ECLCompressBGOverlayModule, ECLCovarianceMatrixModule, ECLCRFinderModule, EclCovMatrixNtupleModule, ECLDataAnalysisModule, ECLDigiStudyModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLFillCellIdMappingModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLOMModule, ECLMatchingPerformanceExpertModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLTrackClusterMatchingModule, ECLTrackClusterMatchingParametrizationExpertModule, ECLTrackClusterMatchingPerformanceModule, ECLTRGInformationModule, ECLTrimShowersAndDigitsModule, ECLUnpackerModule, eclWaveformCalibCollectorModule, ECLWaveformFitModule, HistoModule, MergeDataStoreModule, SubEventModule, SwitchDataStoreModule, ProgressBarModule, RandomBarrierModule, HistoManagerModule, ProfileModule, RootInputModule, RootOutputModule, SeqRootInputModule, SeqRootOutputModule, AsyncWrapper, RxModule, TxModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, ZMQTxWorkerModule, AafhInputModule, BabayagaNLOInputModule, BBBremInputModule, BHWideInputModule, CRYInputModule, EvtGenDecayModule, FragmentationModule, HepMCInputModule, HepMCOutputModule, GeneratedVertexDisplacerModule, GeneratorPreselectionModule, HepevtOutputModule, OverrideGenerationFlagsModule, RemoveMCParticlesModule, KKGenInputModule, KoralWInputModule, PhokharaInputModule, TeeggInputModule, TrepsInputModule, GeometryModule, SoftwareTriggerModule, SoftwareTriggerResultPrinterModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, MasterClassModule, MVAExpertModule, MVAMultipleExpertsModule, AWESOMEBasicModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDSpacePointCreatorModule, CheckErrorEventModule, Convert2RawDetModule, Root2BinaryModule, CDCDedxCorrectionModule, CDCDedxDQMModule, CDCDedxPIDModule, CDCDedxScanModule, CDCDedxSkimModule, CDCDedxSkimCDSTModule, CDCDedxValidationModule, HitLevelInfoWriterModule, DataWriterModule, ECLExpertModule, KLMExpertModule, KlongValidationModule, KLMMuonIDDNNExpertModule, PIDNtupleModule, VXDDedxPIDModule, FullSimModule, FullSimTimingModule, SVDBackgroundModule, SVDChannelMappingModule, SVDHotStripFinderModule, SVDChargeSharingAnalysisModule, SVDClusterQualityEstimatorCalibrationModule, SVDClusterQualityEstimatorModule, SVDCrossTalkFinderModule, svdDumpModule, SVDPackerModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDEventT0PerformanceTTreeModule, SVDMaxStripTTreeModule, SVDPerformanceTTreeModule, SVDShaperDigitsFromTracksModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVD3SamplesEmulatorModule, SVDDigitizerModule, SVDTriggerQualityGeneratorModule, SVDSpacePointCreatorModule, SVDSpacePointQICalibrationModule, TOPAlignerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelT0CalibratorModule, TOPChannelT0MCModule, TOPCommonT0CalibratorModule, TOPCosmicT0FinderModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLLScannerModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPPDFCheckerModule, TOPRawDigitConverterModule, TOPRingPlotterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, ExtModule, GenfitVisModule, BeamSpotMonitorModule, KinkFinderModule, Chi2MCTrackMatcherModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, ROIReadTestModule, SVDROIFinderAnalysisDataModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, CurlingTrackCandSplitterModule, GFTC2SPTCConverterModule, PhaseSpaceAnalysisModule, RT2SPTCConverterModule, SpacePoint2TrueHitConnectorModule, SpacePointCreatorTestModule, SPTC2GFTCConverterModule, SPTCRefereeModule, TCConvertersTestModule, StandardTrackingPerformanceModule, TrackFilterModule, CollectorTestModule, StudyMaterialEffectsModule, EffPlotsModule, FillTrackFitNtupleModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, V0FinderModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDQETrainingDataCollectorModule, FastBDTClassifierAnalyzerModule, FastBDTClassifierTrainingModule, MLSegmentNetworkProducerModule, NoKickCutsEvalModule, SegmentNetworkAnalyzerModule, SPTC2RTConverterModule, 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, CDCTriggerHoughETFModule, CDCTrigger2DFinderModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDataModule, CDCTriggerNeuroIDHistModule, CDCTriggerTSFFirmwareModule, CDCTriggerTSFModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, CDCTriggerUnpackerModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, GRLNeuroModule, GRLNeuroTrainerModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, VXDMisalignmentModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, PyModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDDQMEfficiencyNtupleModule, PXDDQMEfficiencyNtupleSelftrackModule, PXDDQMTrackRawNtupleModule, PXDPackerErrModule, PXDPackerModule, PXDReadRawBonnDAQModule, PXDReadRawBonnDAQMatchedModule, PXDReadRawONSENModule, PXDUnpackerModule, PXDUnpackerOldModule, PXDUnpackerOTModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, PXDROIFinderAnalysisModule, ROISenderModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisTRGModule, DQMHistOutputToEPICSModule, and ROIDQMModule.

Definition at line 176 of file Module.h.

176{};

◆ writeClusterRelations()

void writeClusterRelations ( const Belle2::SVD::RawCluster &  rawCluster)
protected

writes the relations of the SVDClusters with the other StoreArrays

Definition at line 426 of file SVDClusterizerModule.cc.

427{
428 RelationArray relClusterDigit(m_storeClusters, m_storeDigits, m_relClusterShaperDigitName);
429
430 RelationArray relClusterMCParticle(m_storeClusters, m_storeMCParticles, m_relClusterMCParticleName);
431 RelationArray relClusterTrueHit(m_storeClusters, m_storeTrueHits, m_relClusterTrueHitName);
432
433 RelationIndex<SVDShaperDigit, MCParticle> relDigitMCParticle(m_storeDigits, m_storeMCParticles, m_relShaperDigitMCParticleName);
434 RelationIndex<SVDShaperDigit, SVDTrueHit> relDigitTrueHit(m_storeDigits, m_storeTrueHits, m_relShaperDigitTrueHitName);
435
436
437 //register relation between ShaperDigit and Cluster
438 int clsIndex = m_storeClusters.getEntries() - 1;
439
440 map<int, float> mc_relations;
441 map<int, float> truehit_relations;
442
443 vector<pair<int, float> > digit_weights;
444 digit_weights.reserve(m_storeClusters[clsIndex]->getSize());
445
446 std::vector<StripInRawCluster> strips = rawCluster.getStripsInRawCluster();
447
448 for (const auto& strip : strips) {
449
450 //Fill map with MCParticle relations
451 if (relDigitMCParticle) {
452 typedef const RelationIndex<SVDShaperDigit, MCParticle>::Element relMC_type;
453 for (relMC_type& mcRel : relDigitMCParticle.getElementsFrom(m_storeDigits[strip.shaperDigitIndex])) {
454 //negative weights are from ignored particles, we don't like them and
455 //thus ignore them :D
456 if (mcRel.weight < 0) continue;
457 mc_relations[mcRel.indexTo] += mcRel.weight;
458 };
459 };
460 //Fill map with SVDTrueHit relations
461 if (relDigitTrueHit) {
462 typedef const RelationIndex<SVDShaperDigit, SVDTrueHit>::Element relTrueHit_type;
463 for (relTrueHit_type& trueRel : relDigitTrueHit.getElementsFrom(m_storeDigits[strip.shaperDigitIndex])) {
464 //negative weights are from ignored particles, we don't like them and
465 //thus ignore them :D
466 if (trueRel.weight < 0) continue;
467 truehit_relations[trueRel.indexTo] += trueRel.weight;
468 };
469 };
470
471 digit_weights.push_back(make_pair(strip.shaperDigitIndex, strip.maxSample));
472 }
473
474 //Create Relations to this Digit
475 if (!mc_relations.empty()) {
476 relClusterMCParticle.add(clsIndex, mc_relations.begin(), mc_relations.end());
477 }
478 if (!truehit_relations.empty()) {
479 relClusterTrueHit.add(clsIndex, truehit_relations.begin(), truehit_relations.end());
480 }
481
482 relClusterDigit.add(clsIndex, digit_weights.begin(), digit_weights.end());
483
484}
Belle2::RelationIndex
Provides access to fast ( O(log n) ) bi-directional lookups on a specified relation.
Definition: RelationIndex.h:76
Belle2::SVD::RawCluster::getStripsInRawCluster
const std::vector< StripInRawCluster > getStripsInRawCluster() const
Definition: RawCluster.h:110
Belle2::RelationIndexContainer::Element::weight
RelationElement::weight_type weight
weight of the relation.
Definition: RelationIndexContainer.h:74

Member Data Documentation

◆ m_charge3SampleClass

SVDClusterCharge* m_charge3SampleClass = nullptr
protected

cluster charge class for the 3-sample acquisition mode

Definition at line 138 of file SVDClusterizerModule.h.

◆ m_charge6SampleClass

SVDClusterCharge* m_charge6SampleClass = nullptr
protected

cluster charge class for the 6-sample acquisition mode

Definition at line 137 of file SVDClusterizerModule.h.

◆ m_chargeRecoWith3SamplesAlgorithm

std::string m_chargeRecoWith3SamplesAlgorithm = "not set"
protected

string storing the cluster charge reconstruction algorithm in 3-sample DAQ mode

Definition at line 120 of file SVDClusterizerModule.h.

◆ m_chargeRecoWith6SamplesAlgorithm

std::string m_chargeRecoWith6SamplesAlgorithm = "not set"
protected

string storing the cluster charge reconstruction algorithm in 6-sample DAQ mode

Definition at line 118 of file SVDClusterizerModule.h.

◆ m_ClusterCal

SVDClustering m_ClusterCal
protected

SVDCluster calibrations db object.

Definition at line 150 of file SVDClusterizerModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_cutAdjacent

double m_cutAdjacent = 3
protected

Adjacent cut in units of noise.

DEPRECATED - useDB

Definition at line 105 of file SVDClusterizerModule.h.

◆ m_cutCluster

double m_cutCluster = 0
protected

Cluster cut in units of m_elNoise, not included (yet?)

Definition at line 107 of file SVDClusterizerModule.h.

◆ m_cutSeed

double m_cutSeed = 5
protected

Seed cut in units of noise.

DEPRECATED - useDB

Definition at line 103 of file SVDClusterizerModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hwClock

DBObjPtr<HardwareClockSettings> m_hwClock
protected

systems clock

Definition at line 147 of file SVDClusterizerModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mcPositionFudgeFactor

SVDMCClusterPositionFudgeFactor m_mcPositionFudgeFactor
protected

SVDMCClusterPositionFudgeFactor db object.

Definition at line 151 of file SVDClusterizerModule.h.

◆ m_mcTimeFudgeFactor

SVDMCClusterTimeFudgeFactor m_mcTimeFudgeFactor
protected

SVDMCClusterTimeFudgeFactor db object.

Definition at line 152 of file SVDClusterizerModule.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_NoiseCal

SVDNoiseCalibrations m_NoiseCal
protected

SVDNoise calibrations db object.

Definition at line 149 of file SVDClusterizerModule.h.

◆ m_numberOfAcquiredSamples

int m_numberOfAcquiredSamples = 0
protected

number of acquired samples, can be 6 or 3 (1 is not supported!)

Definition at line 112 of file SVDClusterizerModule.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_position3SampleClass

SVDClusterPosition* m_position3SampleClass = nullptr
protected

cluster position class for the 3-sample acquisition mode

Definition at line 140 of file SVDClusterizerModule.h.

◆ m_position6SampleClass

SVDClusterPosition* m_position6SampleClass = nullptr
protected

cluster position class for the 6-sample acquisition mode

Definition at line 139 of file SVDClusterizerModule.h.

◆ m_positionRecoWith3SamplesAlgorithm

std::string m_positionRecoWith3SamplesAlgorithm = "not set"
protected

string storing the cluster position reconstruction algorithm in 3-sample DAQ mode

Definition at line 124 of file SVDClusterizerModule.h.

◆ m_positionRecoWith6SamplesAlgorithm

std::string m_positionRecoWith6SamplesAlgorithm = "not set"
protected

string storing the cluster position reconstruction algorithm in 6-sample DAQ mode

Definition at line 122 of file SVDClusterizerModule.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_recoConfig

DBObjPtr<SVDRecoConfiguration> m_recoConfig
protected

SVD Reconstruction Configuration payload.

Definition at line 148 of file SVDClusterizerModule.h.

◆ m_relClusterMCParticleName

std::string m_relClusterMCParticleName
protected

Name of the relation between SVDClusters and MCParticles.

Definition at line 84 of file SVDClusterizerModule.h.

◆ m_relClusterShaperDigitName

std::string m_relClusterShaperDigitName
protected

Name of the relation between SVDClusters and SVDShaperDigits.

Definition at line 86 of file SVDClusterizerModule.h.

◆ m_relClusterTrueHitName

std::string m_relClusterTrueHitName
protected

Name of the relation between SVDClusters and SVDTrueHits.

Definition at line 90 of file SVDClusterizerModule.h.

◆ m_relShaperDigitMCParticleName

std::string m_relShaperDigitMCParticleName
protected

Name of the relation between SVDShaperDigits and MCParticles.

Definition at line 82 of file SVDClusterizerModule.h.

◆ m_relShaperDigitTrueHitName

std::string m_relShaperDigitTrueHitName
protected

Name of the relation between SVDShaperDigits and SVDTrueHits.

Definition at line 88 of file SVDClusterizerModule.h.

◆ m_returnRawClusterTime

bool m_returnRawClusterTime = false
protected

if true cluster time is not calibrated, to be used for time calibration

Definition at line 144 of file SVDClusterizerModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_shiftSVDClusterTime

bool m_shiftSVDClusterTime = true
protected

if true applies SVDCluster time shift based on cluster-size

Definition at line 145 of file SVDClusterizerModule.h.

◆ m_storeClusters

StoreArray<SVDCluster> m_storeClusters
protected

Collection of SVDClusters.

Definition at line 93 of file SVDClusterizerModule.h.

◆ m_storeClustersName

std::string m_storeClustersName
protected

Name of the collection to use for the SVDClusters.

Definition at line 75 of file SVDClusterizerModule.h.

◆ m_storeDigits

StoreArray<SVDShaperDigit> m_storeDigits
protected

Collection of SVDShaperDigits.

Definition at line 95 of file SVDClusterizerModule.h.

◆ m_storeMCParticles

StoreArray<MCParticle> m_storeMCParticles
protected

Collection of MCParticles.

Definition at line 99 of file SVDClusterizerModule.h.

◆ m_storeMCParticlesName

std::string m_storeMCParticlesName
protected

Name of the collection to use for the MCParticles.

Definition at line 79 of file SVDClusterizerModule.h.

◆ m_storeShaperDigitsName

std::string m_storeShaperDigitsName
protected

Name of the collection to use for the SVDShaperDigits.

Definition at line 73 of file SVDClusterizerModule.h.

◆ m_storeTrueHits

StoreArray<SVDTrueHit> m_storeTrueHits
protected

Collection of SVDTrueHits.

Definition at line 97 of file SVDClusterizerModule.h.

◆ m_storeTrueHitsName

std::string m_storeTrueHitsName
protected

Name of the collection to use for the SVDTrueHits.

Definition at line 77 of file SVDClusterizerModule.h.

◆ m_stripChargeRecoWith3SamplesAlgorithm

std::string m_stripChargeRecoWith3SamplesAlgorithm = "not set"
protected

string storing the strip charge reconstruction algorithm for cluster reconstruction in 3-sample DAQ mode

Definition at line 133 of file SVDClusterizerModule.h.

◆ m_stripChargeRecoWith6SamplesAlgorithm

std::string m_stripChargeRecoWith6SamplesAlgorithm = "not set"
protected

string storing the strip charge reconstruction algorithm for cluster position reconstruction in 6-sample DAQ mode

Definition at line 131 of file SVDClusterizerModule.h.

◆ m_stripTimeRecoWith3SamplesAlgorithm

std::string m_stripTimeRecoWith3SamplesAlgorithm = "not set"
protected

string storing the strip time reconstruction algorithm for cluster position reconstruction in 3-sample DAQ mode

Definition at line 129 of file SVDClusterizerModule.h.

◆ m_stripTimeRecoWith6SamplesAlgorithm

std::string m_stripTimeRecoWith6SamplesAlgorithm = "not set"
protected

string storing the strip time reconstruction algorithm for cluster position reconstruction in 6-sample DAQ mode

Definition at line 127 of file SVDClusterizerModule.h.

◆ m_svdClusterTimeShifter

DBObjPtr<SVDClusterTimeShifter> m_svdClusterTimeShifter
protected

SVDCluster time shift.

Definition at line 153 of file SVDClusterizerModule.h.

◆ m_svdEventInfoName

std::string m_svdEventInfoName
protected

Name of the collection to use for the SVDEventInfo.

Definition at line 71 of file SVDClusterizerModule.h.

◆ m_time3SampleClass

SVDClusterTime* m_time3SampleClass = nullptr
protected

cluster time class for the 3-sample acquisition mode

Definition at line 136 of file SVDClusterizerModule.h.

◆ m_time6SampleClass

SVDClusterTime* m_time6SampleClass = nullptr
protected

cluster time class for the 6-sample acquisition mode

Definition at line 135 of file SVDClusterizerModule.h.

◆ m_timeRecoWith3SamplesAlgorithm

std::string m_timeRecoWith3SamplesAlgorithm = "not set"
protected

string storing the cluster time reconstruction algorithm in 3-sample DAQ mode

Definition at line 116 of file SVDClusterizerModule.h.

◆ m_timeRecoWith6SamplesAlgorithm

std::string m_timeRecoWith6SamplesAlgorithm = "not set"
protected

string storing the cluster time reconstruction algorithm in 6-sample DAQ mode

Definition at line 114 of file SVDClusterizerModule.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_useDB

bool m_useDB = true
protected

if true takes the clusterizer cuts and reconstruction configuration from the DB objects

Definition at line 109 of file SVDClusterizerModule.h.

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