Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
RT2SPTCConverterModule Class Reference
Packages » tracking | Modules » tracking modules

Module for converting RecoTracks to SpacePointTrackCands. More...

#include <RT2SPTCConverterModuleDev.h>

Inheritance diagram for RT2SPTCConverterModule:
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

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

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Types

enum  conversionFlags {
  c_singleCluster = 0 ,
  c_undefinedError = 1
}
 enum for differentiating reasons why a conversion failed More...
 
using ConversionState = std::bitset< 2 >
 Used to store conversionFlags and pass them between methods.
 

Protected Member Functions

std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformations (std::vector< RecoHitInformation * > hitInfos)
 Convert Clusters to SpacePoints using the Relation: Cluster->SpacePoint.
 
std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformationViaTrueHits (std::vector< RecoHitInformation * > hitInfos)
 Convert Clusters to SpacePoints using the Relation: Cluster->TrueHit->SpacePoint.
 
void initializeCounters ()
 reset counters to 0 to avoid indeterministic behaviour
 
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_SVDClusterName
 SVDCluster collection name.
 
std::optional< std::string > m_pxdSpacePointsStoreArrayName
 PXD SpacePoints collection names.
 
std::optional< std::string > m_svdSpacePointsStoreArrayName
 Non SingleCluster SVD SpacePoints collection names.
 
std::string m_SVDSingleClusterSPName
 Single Cluster SVD SpacePoints collection name.
 
std::string m_RecoTracksName
 Name of collection of RecoTrack StoreArray.
 
std::string m_SPTCName
 Name of collection under which SpacePointTrackCands will be stored in the StoreArray.
 
StoreArray< SpacePoint > m_PXDSpacePoints
 PXDSpacePoints StoreArray.
 
StoreArray< SpacePoint > m_SVDSpacePoints
 SVDSpacePoints StoreArray.
 
StoreArray< RecoTrack > m_RecoTracks
 RecoTracks StoreArray.
 
StoreArray< SpacePointTrackCand > m_SpacePointTrackCands
 SpacePointTrackCands StoreArray.
 
StoreArray< MCParticle > m_MCParticles
 MCParticles StoreArray.
 
StoreArray< SVDTrueHit > m_SVDTrueHit
 SVDTrueHits StoreArray.
 
StoreArray< SVDCluster > m_SVDClusters
 SVDClusters StoreArray.
 
bool m_ignorePXDHits
 PXD hits will be ignored when creating the SP track candidate.
 
int m_minSP
 parameter for specifying a minimal number of SpacePoints a SpacePointTrackCand has to have in order to be registered in the DataStore
 
bool m_useTrueHits
 If true the method getSpacePointsFromSVDClustersViaTrueHits is utilized.
 
bool m_skipProblematicCluster
 If true problematic clusters are ignored.
 
bool m_useSingleClusterSP
 If true use single cluster SpacePoint collection as fallback.
 
bool m_markRecoTracks
 If True RecoTracks where conversion problems occurred are marked dirty.
 
bool m_convertFittedOnly = false
 if true only RecoTracks with successful fit will be converted
 
NoKickRTSel * m_trackSel
 data members used for the NoKickCuts method
 
std::string m_noKickCutsFile
 name of TFile of the cuts
 
bool m_noKickOutput
 true=produce TFile with effects of NoKickCuts on tracks
 
int m_ncut = 0
 counter of the cut tracks
 
int m_npass = 0
 counter of the selected tracks
 
bool m_mcParticlesPresent
 If MCParticles are available.
 
unsigned int m_minSPCtr
 Counts how many tracks didn't contain enough SpacePoints after conversion.
 
unsigned int m_noFailCtr
 Counts how many tracks could be converted without any problems.
 
unsigned int m_singleClusterUseCtr
 Counts how many tracks contained a single cluster.
 
unsigned int m_undefinedErrorCtr
 Counts how many tracks failed to be converted.
 
unsigned int m_missingTrueHitCtr
 Counts how many times a SpacePoint had no relation to a SVDTrueHit.
 

Private Member Functions

std::list< ModulePtr > getModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

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

Detailed Description

Module for converting RecoTracks to SpacePointTrackCands.

NOTE: currently only working with SVD clusters!

Intended Behaviour: The Module takes a RecoTrack and converts it to a SpacePointTrackCand by taking the Clusters (PXD and SVD) of the RecoTrack and then look for Relations of these Clusters to SpacePoints. NOTE: other hits than PXD and SVD are ignored!

Definition at line 37 of file RT2SPTCConverterModuleDev.h.

Member Typedef Documentation

◆ ConversionState

using ConversionState = std::bitset<2>
protected

Used to store conversionFlags and pass them between methods.

Definition at line 69 of file RT2SPTCConverterModuleDev.h.

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ conversionFlags

enum conversionFlags
protected

enum for differentiating reasons why a conversion failed

Definition at line 64 of file RT2SPTCConverterModuleDev.h.

64 {
65 c_singleCluster = 0,
66 c_undefinedError = 1
67 };

◆ 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

◆ RT2SPTCConverterModule()

RT2SPTCConverterModule ( )

Constructor.

Definition at line 21 of file RT2SPTCConverterModuleDev.cc.

21 :
22 Module(),
23 m_trackSel(nullptr)
24
25{
26 setDescription("Module for converting RecoTracks (e.g. from TrackFinderMCTruth) to SpacePointTrackCands.");
27 setPropertyFlags(c_ParallelProcessingCertified);
28
29 // input
30 addParam("RecoTracksName", m_RecoTracksName, "Name of container of RecoTracks", std::string(""));
31
32 // required for conversion
33 addParam("SVDClusters", m_SVDClusterName, "SVDCluster collection name", std::string(""));
34
35 addParam("SVDSpacePointStoreArrayName", m_svdSpacePointsStoreArrayName, "Name of the collection for SVD.",
36 std::make_optional<std::string>("SVDSpacePoints"));
37 addParam("PXDSpacePointStoreArrayName", m_pxdSpacePointsStoreArrayName, "Name of the collection for PXD.",
38 std::make_optional<std::string>("PXDSpacePoints"));
39
40 // optional input
41 addParam("SVDSingleClusterSP", m_SVDSingleClusterSPName, "SVD single Cluster SpacePoints collection name.", std::string(""));
42
43 // output
44 addParam("SpacePointTCName", m_SPTCName,
45 "Name of the container under which SpacePointTrackCands will be stored in the DataStore (NOTE: These SpaceTrackCands are not checked for curling behaviour, but are simply converted and stored!)",
46 std::string(""));
47
48 // parameters
49 addParam("minSP", m_minSP,
50 "Minimum number of SpacePoints a SpacePointTrackCand has to contain in order to get registered in the DataStore. If set to 0, any number is accepted",
51 0);
52
53 addParam("useTrueHits", m_useTrueHits, "Converts clusters via their relations to TrueHits.", false);
54
55 addParam("skipProblematicCluster", m_skipProblematicCluster,
56 "If set to true clusters that could not be converted are skipped instead of throwing away the complete SPTC",
57 false);
58
59 addParam("useSingleClusterSP", m_useSingleClusterSP, "Set to true if these SpacePoints should be used as fallback.", false);
60
61 addParam("markRecoTracks", m_markRecoTracks, "If True RecoTracks where conversion problems occurred are marked dirty.", false);
62
63 addParam("noKickCutsFile", m_noKickCutsFile,
64 "TFile that contains the list of cuts to select trainins sample. If parameter left empty NoKickCuts are not applied",
65 std::string(""));
66
67 addParam("noKickOutput", m_noKickOutput,
68 "If true produce a TFile with some histograms useful to understand behaviour of training sample selection", false);
69
70 addParam("ignorePXDHits", m_ignorePXDHits, "If true no PXD hits will be used when creating the SpacePointTrackCand", bool(false));
71
72 addParam("convertFittedOnly", m_convertFittedOnly, "If true only RecoTracks with successful fit will be converted to "
73 "SpacePointTrackCands", m_convertFittedOnly);
74
75 initializeCounters();
76}
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::RT2SPTCConverterModule::m_ignorePXDHits
bool m_ignorePXDHits
PXD hits will be ignored when creating the SP track candidate.
Definition: RT2SPTCConverterModuleDev.h:110
Belle2::RT2SPTCConverterModule::m_noKickOutput
bool m_noKickOutput
true=produce TFile with effects of NoKickCuts on tracks
Definition: RT2SPTCConverterModuleDev.h:124
Belle2::RT2SPTCConverterModule::m_minSP
int m_minSP
parameter for specifying a minimal number of SpacePoints a SpacePointTrackCand has to have in order t...
Definition: RT2SPTCConverterModuleDev.h:112
Belle2::RT2SPTCConverterModule::m_skipProblematicCluster
bool m_skipProblematicCluster
If true problematic clusters are ignored.
Definition: RT2SPTCConverterModuleDev.h:114
Belle2::RT2SPTCConverterModule::m_SVDSingleClusterSPName
std::string m_SVDSingleClusterSPName
Single Cluster SVD SpacePoints collection name.
Definition: RT2SPTCConverterModuleDev.h:95
Belle2::RT2SPTCConverterModule::m_useTrueHits
bool m_useTrueHits
If true the method getSpacePointsFromSVDClustersViaTrueHits is utilized.
Definition: RT2SPTCConverterModuleDev.h:113
Belle2::RT2SPTCConverterModule::m_noKickCutsFile
std::string m_noKickCutsFile
name of TFile of the cuts
Definition: RT2SPTCConverterModuleDev.h:123
Belle2::RT2SPTCConverterModule::m_pxdSpacePointsStoreArrayName
std::optional< std::string > m_pxdSpacePointsStoreArrayName
PXD SpacePoints collection names.
Definition: RT2SPTCConverterModuleDev.h:92
Belle2::RT2SPTCConverterModule::m_SPTCName
std::string m_SPTCName
Name of collection under which SpacePointTrackCands will be stored in the StoreArray.
Definition: RT2SPTCConverterModuleDev.h:99
Belle2::RT2SPTCConverterModule::m_RecoTracksName
std::string m_RecoTracksName
Name of collection of RecoTrack StoreArray.
Definition: RT2SPTCConverterModuleDev.h:97
Belle2::RT2SPTCConverterModule::m_convertFittedOnly
bool m_convertFittedOnly
if true only RecoTracks with successful fit will be converted
Definition: RT2SPTCConverterModuleDev.h:119
Belle2::RT2SPTCConverterModule::m_SVDClusterName
std::string m_SVDClusterName
SVDCluster collection name.
Definition: RT2SPTCConverterModuleDev.h:90
Belle2::RT2SPTCConverterModule::m_trackSel
NoKickRTSel * m_trackSel
data members used for the NoKickCuts method
Definition: RT2SPTCConverterModuleDev.h:122
Belle2::RT2SPTCConverterModule::m_svdSpacePointsStoreArrayName
std::optional< std::string > m_svdSpacePointsStoreArrayName
Non SingleCluster SVD SpacePoints collection names.
Definition: RT2SPTCConverterModuleDev.h:93
Belle2::RT2SPTCConverterModule::initializeCounters
void initializeCounters()
reset counters to 0 to avoid indeterministic behaviour
Definition: RT2SPTCConverterModuleDev.h:80
Belle2::RT2SPTCConverterModule::m_useSingleClusterSP
bool m_useSingleClusterSP
If true use single cluster SpacePoint collection as fallback.
Definition: RT2SPTCConverterModuleDev.h:115
Belle2::RT2SPTCConverterModule::m_markRecoTracks
bool m_markRecoTracks
If True RecoTracks where conversion problems occurred are marked dirty.
Definition: RT2SPTCConverterModuleDev.h:116
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

◆ ~RT2SPTCConverterModule()

~RT2SPTCConverterModule ( )

Destructor.

destructor

Definition at line 79 of file RT2SPTCConverterModuleDev.cc.

80{
81 if (m_trackSel) delete m_trackSel;
82}

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void  )
inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

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

Definition at line 147 of file Module.h.

147{};

◆ 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

End Run function.

Reimplemented from Module.

Definition at line 406 of file RT2SPTCConverterModuleDev.cc.

407{
408 B2RESULT("Number of Selected Tracks (NoKickRTSel): " << m_npass);
409 B2RESULT("Number of Rejected Tracks (NoKickRTSel): " << m_ncut);
410
411 m_trackSel->produceHistoNoKick();
412}
Belle2::NoKickRTSel::produceHistoNoKick
void produceHistoNoKick()
This method produce the validation histograms (to be used the endrun combined with the filling in tra...
Definition: NoKickRTSel.cc:277
Belle2::RT2SPTCConverterModule::m_npass
int m_npass
counter of the selected tracks
Definition: RT2SPTCConverterModuleDev.h:128
Belle2::RT2SPTCConverterModule::m_ncut
int m_ncut
counter of the cut tracks
Definition: RT2SPTCConverterModuleDev.h:127

◆ 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

Event: convert RecoTracks to SpacePointTrackCands.

< skip this recoTrack

< skip this recoTrack

Reimplemented from Module.

Definition at line 121 of file RT2SPTCConverterModuleDev.cc.

122{
123 StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
124 const int eventCounter = eventMetaDataPtr->getEvent();
125 B2DEBUG(20, "RT2SPTCConverter::event(). Processing event " << eventCounter << " --------");
126
127 for (auto& recoTrack : m_RecoTracks) {
128
129 // if corresponding flag is set only use fitted tracks
130 if (m_convertFittedOnly and not recoTrack.wasFitSuccessful()) continue;
131
132 if (m_noKickCutsFile.size() != 0) {
133 bool passCut = m_trackSel->trackSelector(recoTrack);
134 if (!passCut) {
135 m_ncut++;
136 continue; //exclude tracks with catastrophic multiple scattering interactions
137 } else {
138 m_npass++;
139 }
140 }
141 std::pair<std::vector<const SpacePoint*>, ConversionState> spacePointStatePair;
142
143 // the hit information from the recotrack, the option "true" will result in a sorted vector
144 std::vector<RecoHitInformation*> hitInfos = recoTrack.getRecoHitInformations(true);
145
146 // if requested remove the PXD hits
147 // NOTE: in RecoTracks there is also a function to get sorted SVD hits only but this uses not the same code as getRecoHitInformations!
148 if (m_ignorePXDHits) {
149 std::vector<RecoHitInformation*> hitInfos_buff;
150 for (std::vector<RecoHitInformation*>::iterator it = hitInfos.begin(); it < hitInfos.end(); ++it) {
151 if ((*it)->getTrackingDetector() != RecoHitInformation::c_PXD) hitInfos_buff.push_back(*it);
152 }
153 hitInfos = hitInfos_buff;
154 }
155
156 B2DEBUG(20, "New call getSpacePointsFromRecoHitInformationViaTrueHits. Number of hitInfos: " << hitInfos.size());
157 B2DEBUG(20, "number of SVD hits in RecoTrack : " << recoTrack.getNumberOfSVDHits());
158 B2DEBUG(20, "number of PXD hits in RecoTrack : " << recoTrack.getNumberOfPXDHits());
159 B2DEBUG(20, "number of CDC hits in RecoTrack : " << recoTrack.getNumberOfCDCHits());
160
161 if (m_useTrueHits) {
162 spacePointStatePair = getSpacePointsFromRecoHitInformationViaTrueHits(hitInfos);
163 } else {
164 spacePointStatePair = getSpacePointsFromRecoHitInformations(hitInfos);
165 }
166 B2DEBUG(20, "RT2SPTCConverter::event: Number of SpacePoints: " << spacePointStatePair.first.size() << "State: " <<
167 spacePointStatePair.second);
168
169 if (int(spacePointStatePair.first.size()) < m_minSP) {
170 B2DEBUG(20, "RT2SPTCConverter::event: Not enough number of SpacePoints: " << spacePointStatePair.first.size() <<
171 " Required Number: "
172 << m_minSP);
173 m_minSPCtr++;
174 continue;
175 }
176
177 if (spacePointStatePair.second.test(c_undefinedError)) {
178 if (!m_skipProblematicCluster) {
179 m_undefinedErrorCtr++;
180 continue;
181 }
182 if (m_markRecoTracks) recoTrack.setDirtyFlag();
183 }
184
185 SpacePointTrackCand spacePointTC;
186 if (m_mcParticlesPresent) {
187 MCParticle* mcParticle = recoTrack.getRelatedTo<MCParticle>();
188 spacePointTC = SpacePointTrackCand(spacePointStatePair.first, mcParticle->getPDG(), mcParticle->getCharge(),
189 recoTrack.getArrayIndex());
190 } else {
191 spacePointTC = SpacePointTrackCand(spacePointStatePair.first, 0, 0, recoTrack.getArrayIndex());
192 }
193
194 if (m_useTrueHits) spacePointTC.addRefereeStatus(SpacePointTrackCand::c_checkedTrueHits);
195
196 if (spacePointStatePair.second.test(c_singleCluster)) {
197 m_singleClusterUseCtr++;
198 spacePointTC.addRefereeStatus(SpacePointTrackCand::c_singleClustersSPs);
199 if (m_markRecoTracks) recoTrack.setDirtyFlag();
200 }
201
202 // convert momentum and position seed into a single 6D seed
203 const ROOT::Math::XYZVector& momentumSeed = recoTrack.getMomentumSeed();
204 const ROOT::Math::XYZVector& positionSeed = recoTrack.getPositionSeed();
205
206 TVectorD seed6D(6);
207 seed6D[0] = positionSeed.X();
208 seed6D[1] = positionSeed.Y();
209 seed6D[2] = positionSeed.Z();
210 seed6D[3] = momentumSeed.X();
211 seed6D[4] = momentumSeed.Y();
212 seed6D[5] = momentumSeed.Z();
213 spacePointTC.set6DSeed(seed6D);
214 spacePointTC.setCovSeed(recoTrack.getSeedCovariance());
215
216 if (spacePointStatePair.second == ConversionState(0)) {
217 m_noFailCtr++;
218 if (m_markRecoTracks) recoTrack.setDirtyFlag(false);
219 }
220
221 m_SpacePointTrackCands.appendNew(spacePointTC)->addRelationTo(&recoTrack);
222 } // end RecoTrack loop
223}
Belle2::DataStore::c_Event
@ c_Event
Different object in each event, all objects/arrays are invalidated after event() function has been ca...
Definition: DataStore.h:59
Belle2::MCParticle
A Class to store the Monte Carlo particle information.
Definition: MCParticle.h:32
Belle2::MCParticle::getCharge
float getCharge() const
Return the particle charge defined in TDatabasePDG.
Definition: MCParticle.cc:36
Belle2::MCParticle::getPDG
int getPDG() const
Return PDG code of particle.
Definition: MCParticle.h:112
Belle2::NoKickRTSel::trackSelector
bool trackSelector(const RecoTrack &track)
This method return true if every segment (see segmentSelector) of the input track respects the cuts c...
Definition: NoKickRTSel.cc:194
Belle2::RT2SPTCConverterModule::m_singleClusterUseCtr
unsigned int m_singleClusterUseCtr
Counts how many tracks contained a single cluster.
Definition: RT2SPTCConverterModuleDev.h:135
Belle2::RT2SPTCConverterModule::m_minSPCtr
unsigned int m_minSPCtr
Counts how many tracks didn't contain enough SpacePoints after conversion.
Definition: RT2SPTCConverterModuleDev.h:133
Belle2::RT2SPTCConverterModule::m_SpacePointTrackCands
StoreArray< SpacePointTrackCand > m_SpacePointTrackCands
SpacePointTrackCands StoreArray.
Definition: RT2SPTCConverterModuleDev.h:104
Belle2::RT2SPTCConverterModule::m_mcParticlesPresent
bool m_mcParticlesPresent
If MCParticles are available.
Definition: RT2SPTCConverterModuleDev.h:132
Belle2::RT2SPTCConverterModule::getSpacePointsFromRecoHitInformations
std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformations(std::vector< RecoHitInformation * > hitInfos)
Convert Clusters to SpacePoints using the Relation: Cluster->SpacePoint.
Definition: RT2SPTCConverterModuleDev.cc:310
Belle2::RT2SPTCConverterModule::m_RecoTracks
StoreArray< RecoTrack > m_RecoTracks
RecoTracks StoreArray.
Definition: RT2SPTCConverterModuleDev.h:103
Belle2::RT2SPTCConverterModule::m_undefinedErrorCtr
unsigned int m_undefinedErrorCtr
Counts how many tracks failed to be converted.
Definition: RT2SPTCConverterModuleDev.h:136
Belle2::RT2SPTCConverterModule::m_noFailCtr
unsigned int m_noFailCtr
Counts how many tracks could be converted without any problems.
Definition: RT2SPTCConverterModuleDev.h:134
Belle2::RT2SPTCConverterModule::getSpacePointsFromRecoHitInformationViaTrueHits
std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformationViaTrueHits(std::vector< RecoHitInformation * > hitInfos)
Convert Clusters to SpacePoints using the Relation: Cluster->TrueHit->SpacePoint.
Definition: RT2SPTCConverterModuleDev.cc:226
Belle2::RelationsInterface::addRelationTo
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).
Definition: RelationsObject.h:142
Belle2::RelationsInterface::getRelatedTo
TO * getRelatedTo(const std::string &name="", const std::string &namedRelation="") const
Get the object to which this object has a relation.
Definition: RelationsObject.h:248
Belle2::SpacePointTrackCand
Storage for (VXD) SpacePoint-based track candidates.
Definition: SpacePointTrackCand.h:40
Belle2::SpacePointTrackCand::set6DSeed
void set6DSeed(const TVectorD &state6D)
set the 6D state seed
Definition: SpacePointTrackCand.h:297
Belle2::SpacePointTrackCand::setCovSeed
void setCovSeed(const TMatrixDSym &cov)
set the covariance matrix seed
Definition: SpacePointTrackCand.h:302
Belle2::SpacePointTrackCand::c_checkedTrueHits
@ c_checkedTrueHits
bit 5: All SpacePoints of the SPTC have a relation to at least one TrueHit.
Definition: SpacePointTrackCand.h:75
Belle2::SpacePointTrackCand::c_singleClustersSPs
@ c_singleClustersSPs
bit 10: SPTC contains single Cluster SpacePoints.
Definition: SpacePointTrackCand.h:82
Belle2::SpacePointTrackCand::addRefereeStatus
void addRefereeStatus(unsigned short int bitmask)
add a referee status
Definition: SpacePointTrackCand.h:333
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

◆ 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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
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

◆ 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; }

◆ getSpacePointsFromRecoHitInformations()

std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformations ( std::vector< RecoHitInformation * >  hitInfos)
protected

Convert Clusters to SpacePoints using the Relation: Cluster->SpacePoint.

< For all SpacePoints in this vector a TrackNode will be created

< For all SpacePoints in this vector a TrackNode will be created

< Cluster information already used. Don't use it again.

Definition at line 310 of file RT2SPTCConverterModuleDev.cc.

311{
312 std::vector<const SpacePoint*> finalSpacePoints;
313 ConversionState state;
314
315 // loop over all cluster to determine the SpacePoints that define the given RecoTrack.
316 for (size_t iHit = 0; iHit < hitInfos.size(); ++iHit) {
317
318 // ignore all hits that are not SVD or PXD
319 if (hitInfos[iHit]->getTrackingDetector() != RecoHitInformation::c_SVD &&
320 hitInfos[iHit]->getTrackingDetector() != RecoHitInformation::c_PXD) continue;
321
322
323 std::vector<const SpacePoint*> spacePointCandidates;
325 if (m_pxdSpacePointsStoreArrayName) {
326 // simple case PXD : there is a one to one relation between cluster and SpacePoint
327 if (hitInfos[iHit]->getTrackingDetector() == RecoHitInformation::c_PXD) {
328 PXDCluster* pxdCluster = hitInfos.at(iHit)->getRelated<PXDCluster>();
329 SpacePoint* relatedPXDSP = nullptr;
330 if (pxdCluster) relatedPXDSP = pxdCluster->getRelated<SpacePoint>(*m_pxdSpacePointsStoreArrayName);
331 // if found a spacepoint one is already done!
332 if (relatedPXDSP) {
333 finalSpacePoints.push_back(relatedPXDSP);
334 continue;
335 }
336 } // end PXD case
337 }
338
339 // At this point it has to be a SVD cluster, for SVD one has to combine u and v clusters
340 SVDCluster* clusterA = hitInfos.at(iHit)->getRelated<SVDCluster>();
341
342 // if it is not PXD it has to be a SVD hit so the cluster has to exist!!
343 if (!clusterA) {
344 B2WARNING("SVDCluster to hit not found! This should not happen!");
345 state.set(c_undefinedError);
346 if (m_skipProblematicCluster) continue;
347 else break;
348 }
349
350 if (m_svdSpacePointsStoreArrayName) {
351 RelationVector<SpacePoint> relatedSpacePointsA = clusterA->getRelationsFrom<SpacePoint>(
352 *m_svdSpacePointsStoreArrayName);
353
354 SVDCluster* clusterB = nullptr;
355 if (iHit + 1 < hitInfos.size()) clusterB = hitInfos.at(iHit + 1)->getRelated<SVDCluster>();
356
357 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClusters: Number of SpacePoints related to first cluster: " <<
358 relatedSpacePointsA.size());
359
360 // Try to verify SpacePoint by using next cluster to build a U/V pair.
361 // cppcheck-suppress knownConditionTrueFalse
362 if (clusterA && clusterB && (clusterA->isUCluster() != clusterB->isUCluster())) {
363 auto relatedSpacePointsB = clusterB->getRelationsFrom<SpacePoint>(*m_svdSpacePointsStoreArrayName);
364
365 // determine intersecting SpacePoints.
366 for (const auto& spacePoint : relatedSpacePointsA) {
367 for (const auto& spacePointCompare : relatedSpacePointsB) {
368 if (spacePoint == spacePointCompare) {
369 spacePointCandidates.push_back(&spacePoint);
370 break;
371 }
372 }
373 }
374 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClusters: Number of intersections with next cluster: " <<
375 spacePointCandidates.size());
376 // Intersection should resolve to the single SpacePoint that was used to create the recoTrack.
377 if (spacePointCandidates.size() == 1) ++iHit;
378 } // end first case
379 }
380
381 // Look up if it is part of single cluster SP collection. If no dedicated collection is given the default collection will be tried again!
382 // cppcheck-suppress knownConditionTrueFalse
383 if (clusterA && spacePointCandidates.size() != 1 && m_useSingleClusterSP) {
384
385 // look if it as single cluster!
386 auto relatedSpacePoints = clusterA->getRelationsFrom<SpacePoint>(m_SVDSingleClusterSPName);
387 if (relatedSpacePoints.size() == 1) {
388 state.set(c_singleCluster);
389 spacePointCandidates.push_back(relatedSpacePoints[0]);
390 }
391 } // second case
392
393 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClusters: Conversion state is: " << state);
394
395 if (spacePointCandidates.size() != 1) {
396 state.set(c_undefinedError);
397 if (m_skipProblematicCluster) continue;
398 else break;
399 }
400 finalSpacePoints.push_back(spacePointCandidates.at(0));
401 } // end loop hits
402
403 return std::make_pair(finalSpacePoints, state);
404}
Belle2::PXDCluster
The PXD Cluster class This class stores all information about reconstructed PXD clusters The position...
Definition: PXDCluster.h:30
Belle2::RelationVector
Class for type safe access to objects that are referred to in relations.
Definition: RelationVector.h:67
Belle2::RelationVector::size
size_t size() const
Get number of relations.
Definition: RelationVector.h:88
Belle2::RelationsInterface::getRelationsFrom
RelationVector< FROM > getRelationsFrom(const std::string &name="", const std::string &namedRelation="") const
Get the relations that point from another store array to this object.
Definition: RelationsObject.h:212
Belle2::RelationsInterface::getRelated
T * getRelated(const std::string &name="", const std::string &namedRelation="") const
Get the object to or from which this object has a relation.
Definition: RelationsObject.h:278
Belle2::SVDCluster
The SVD Cluster class This class stores all information about reconstructed SVD clusters.
Definition: SVDCluster.h:29
Belle2::SVDCluster::isUCluster
bool isUCluster() const
Get the direction of strips.
Definition: SVDCluster.h:110
Belle2::SpacePoint
SpacePoint typically is build from 1 PXDCluster or 1-2 SVDClusters.
Definition: SpacePoint.h:42

◆ getSpacePointsFromRecoHitInformationViaTrueHits()

std::pair< std::vector< const SpacePoint * >, ConversionState > getSpacePointsFromRecoHitInformationViaTrueHits ( std::vector< RecoHitInformation * >  hitInfos)
protected

Convert Clusters to SpacePoints using the Relation: Cluster->TrueHit->SpacePoint.

Definition at line 226 of file RT2SPTCConverterModuleDev.cc.

227{
228 std::vector<const SpacePoint*> finalSpacePoints;
229 ConversionState state;
230
231
232 // loop over all cluster to determine the SpacePoints that define the given RecoTrack.
233 for (const RecoHitInformation* hitInfo : hitInfos) {
234
235 // ignore all hits that are not SVD or PXD
236 if (hitInfo->getTrackingDetector() != RecoHitInformation::c_SVD && hitInfo->getTrackingDetector() != RecoHitInformation::c_PXD)
237 continue;
238
239
240 const VXDTrueHit* relatedTrueHit = nullptr;
241 RelationsObject* cluster = nullptr;
242
243 // SVD case
244 if (hitInfo->getTrackingDetector() == RecoHitInformation::c_SVD) {
245 cluster = hitInfo->getRelatedTo<SVDCluster>();
246 if (cluster) {
247 relatedTrueHit = cluster->getRelatedTo<SVDTrueHit>();
248 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClustersViaTrueHits: Number of related SVDTrueHits: " <<
249 cluster->getRelationsTo<SVDTrueHit>().size());
250 }
251 }
252
253 // PXD case
254 if (hitInfo->getTrackingDetector() == RecoHitInformation::c_PXD) {
255 cluster = hitInfo->getRelatedTo<PXDCluster>();
256 if (cluster) {
257 relatedTrueHit = cluster->getRelatedTo<PXDTrueHit>();
258 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClustersViaTrueHits: Number of related PXDTrueHits: "
259 << cluster->getRelationsTo<PXDTrueHit>().size());
260 }
261 }
262
263 if (!relatedTrueHit) {
264 state.set(c_undefinedError);
265 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClustersViaTrueHits: TrueHit missing.");
266 if (m_skipProblematicCluster) continue;
267 else break;
268 }
269
270 // NOTE: double cluster SVD SP and PXD SP should be stored in the same StoreArray!
271 const SpacePoint* relatedSpacePoint = [this, hitInfo, relatedTrueHit]() -> const SpacePoint* {
272 if (m_svdSpacePointsStoreArrayName and hitInfo->getTrackingDetector() == RecoHitInformation::c_SVD)
273 {
274 return relatedTrueHit->getRelatedFrom<SpacePoint>(*m_svdSpacePointsStoreArrayName);
275 }
276 if (m_pxdSpacePointsStoreArrayName and hitInfo->getTrackingDetector() == RecoHitInformation::c_PXD)
277 {
278 return relatedTrueHit->getRelatedFrom<SpacePoint>(*m_pxdSpacePointsStoreArrayName);
279 }
280 return nullptr;
281 }();
282
283 // special case for the SVD cluster as there is the option for single cluster SP
284 if (hitInfo->getTrackingDetector() == RecoHitInformation::c_SVD) {
285 if (!relatedSpacePoint && m_useSingleClusterSP) {
286 relatedSpacePoint = cluster->getRelatedFrom<SpacePoint>(m_SVDSingleClusterSPName);
287 if (!relatedSpacePoint->getRelatedTo<SVDTrueHit>()) relatedSpacePoint = nullptr;
288 }
289 } // end SVD
290
291 if (!relatedSpacePoint) {
292 state.set(c_undefinedError);
293 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClustersViaTrueHits: SpacePoint missing.");
294 if (m_skipProblematicCluster) continue;
295 else break;
296 }
297
298
299 // Prevent adding the same SpacePoint twice as there are 2 clusters per SP for SVD
300 if (std::find(finalSpacePoints.begin(), finalSpacePoints.end(), relatedSpacePoint) == finalSpacePoints.end()) {
301 finalSpacePoints.push_back(relatedSpacePoint);
302 }
303 }
304 B2DEBUG(20, "RT2SPTCConverter::getSpacePointsFromClustersViaTrueHits: Number of SpacePoints: " << finalSpacePoints.size());
305 return std::make_pair(finalSpacePoints, state);
306}
Belle2::PXDTrueHit
Class PXDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: PXDTrueHit.h:31
Belle2::RecoHitInformation
This class stores additional information to every CDC/SVD/PXD hit stored in a RecoTrack.
Definition: RecoHitInformation.h:38
Belle2::RelationsInterface
Defines interface for accessing relations of objects in StoreArray.
Definition: RelationsObject.h:100
Belle2::RelationsInterface::getRelatedFrom
FROM * getRelatedFrom(const std::string &name="", const std::string &namedRelation="") const
Get the object from which this object has a relation.
Definition: RelationsObject.h:263
Belle2::SVDTrueHit
Class SVDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: SVDTrueHit.h:33
Belle2::VXDTrueHit
Class VXDTrueHit - Records of tracks that either enter or leave the sensitive volume.
Definition: VXDTrueHit.h:36

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 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 module (e.g. check if all required StoreArrays are present or registering new StoreArrays)

Reimplemented from Module.

Definition at line 85 of file RT2SPTCConverterModuleDev.cc.

86{
87 B2INFO("RT2SPTCConverter -------------- initialize() ---------------------");
88 // initialize Counters
89 initializeCounters();
90
91 // check if all required StoreArrays are here
92 m_SVDClusters.isRequired(m_SVDClusterName);
93 if (m_pxdSpacePointsStoreArrayName) {
94 m_PXDSpacePoints.isRequired(*m_pxdSpacePointsStoreArrayName);
95 }
96 if (m_svdSpacePointsStoreArrayName) {
97 m_SVDSpacePoints.isRequired(*m_svdSpacePointsStoreArrayName);
98 }
99
100 m_RecoTracks.isRequired(m_RecoTracksName);
101
102 // registering StoreArray for SpacePointTrackCand
103 m_SpacePointTrackCands.registerInDataStore(m_SPTCName, DataStore::c_ErrorIfAlreadyRegistered);
104
105 if (m_MCParticles.isOptional()) {
106 m_mcParticlesPresent = true;
107 }
108
109 if (m_useTrueHits) {
110 m_SVDTrueHit.isRequired();
111 }
112
113 // register Relation to RecoTrack
114 m_SpacePointTrackCands.registerRelationTo(m_RecoTracks);
115
116 m_trackSel = new NoKickRTSel(m_noKickCutsFile, m_noKickOutput);
117
118}
Belle2::DataStore::c_ErrorIfAlreadyRegistered
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:72
Belle2::NoKickRTSel
This class implement some methods useful for the application of cuts evaluated in NoKickCutsEval modu...
Definition: NoKickRTSel.h:33
Belle2::RT2SPTCConverterModule::m_SVDClusters
StoreArray< SVDCluster > m_SVDClusters
SVDClusters StoreArray.
Definition: RT2SPTCConverterModuleDev.h:107
Belle2::RT2SPTCConverterModule::m_SVDSpacePoints
StoreArray< SpacePoint > m_SVDSpacePoints
SVDSpacePoints StoreArray.
Definition: RT2SPTCConverterModuleDev.h:102
Belle2::RT2SPTCConverterModule::m_SVDTrueHit
StoreArray< SVDTrueHit > m_SVDTrueHit
SVDTrueHits StoreArray.
Definition: RT2SPTCConverterModuleDev.h:106
Belle2::RT2SPTCConverterModule::m_PXDSpacePoints
StoreArray< SpacePoint > m_PXDSpacePoints
PXDSpacePoints StoreArray.
Definition: RT2SPTCConverterModuleDev.h:101
Belle2::RT2SPTCConverterModule::m_MCParticles
StoreArray< MCParticle > m_MCParticles
MCParticles StoreArray.
Definition: RT2SPTCConverterModuleDev.h:105
Belle2::StoreAccessorBase::isRequired
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
Definition: StoreAccessorBase.h:78
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
Belle2::StoreArray::registerRelationTo
bool registerRelationTo(const StoreArray< TO > &toArray, DataStore::EDurability durability=DataStore::c_Event, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut, const std::string &namedRelation="") const
Register a relation to the given StoreArray.
Definition: StoreArray.h:140

◆ initializeCounters()

void initializeCounters ( )
inlineprotected

reset counters to 0 to avoid indeterministic behaviour

Definition at line 80 of file RT2SPTCConverterModuleDev.h.

81 {
82 m_noFailCtr = 0;
83 m_singleClusterUseCtr = 0;
84 m_undefinedErrorCtr = 0;
85 m_missingTrueHitCtr = 0;
86 m_minSPCtr = 0;
87 m_mcParticlesPresent = false;
88 }
Belle2::RT2SPTCConverterModule::m_missingTrueHitCtr
unsigned int m_missingTrueHitCtr
Counts how many times a SpacePoint had no relation to a SVDTrueHit.
Definition: RT2SPTCConverterModuleDev.h:137

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

◆ terminate()

void terminate ( void  )
overridevirtual

Terminate: print some summary information on the processed events.

Reimplemented from Module.

Definition at line 415 of file RT2SPTCConverterModuleDev.cc.

416{
417 B2RESULT("RT2SPTCConverter::terminate: Converted " << m_noFailCtr << "Reco Tracks without errors and "
418 << m_singleClusterUseCtr << " Tracks were converted with a single Cluster SpacePoint. "
419 << m_missingTrueHitCtr << " Tracks were skipped because they contained SpacePoints that had no relations to TrueHits, "
420 << m_minSPCtr << " Tracks were skipped because they didn't contain enough SpacePoints and for "
421 << m_undefinedErrorCtr << " Tracks occurred an undefined error.");
422}

Member Data Documentation

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_convertFittedOnly

bool m_convertFittedOnly = false
protected

if true only RecoTracks with successful fit will be converted

Definition at line 119 of file RT2SPTCConverterModuleDev.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_ignorePXDHits

bool m_ignorePXDHits
protected

PXD hits will be ignored when creating the SP track candidate.

Definition at line 110 of file RT2SPTCConverterModuleDev.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_markRecoTracks

bool m_markRecoTracks
protected

If True RecoTracks where conversion problems occurred are marked dirty.

Definition at line 116 of file RT2SPTCConverterModuleDev.h.

◆ m_MCParticles

StoreArray<MCParticle> m_MCParticles
protected

MCParticles StoreArray.

Definition at line 105 of file RT2SPTCConverterModuleDev.h.

◆ m_mcParticlesPresent

bool m_mcParticlesPresent
protected

If MCParticles are available.

Definition at line 132 of file RT2SPTCConverterModuleDev.h.

◆ m_minSP

int m_minSP
protected

parameter for specifying a minimal number of SpacePoints a SpacePointTrackCand has to have in order to be registered in the DataStore

Definition at line 112 of file RT2SPTCConverterModuleDev.h.

◆ m_minSPCtr

unsigned int m_minSPCtr
protected

Counts how many tracks didn't contain enough SpacePoints after conversion.

Definition at line 133 of file RT2SPTCConverterModuleDev.h.

◆ m_missingTrueHitCtr

unsigned int m_missingTrueHitCtr
protected

Counts how many times a SpacePoint had no relation to a SVDTrueHit.

Definition at line 137 of file RT2SPTCConverterModuleDev.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_ncut

int m_ncut = 0
protected

counter of the cut tracks

Definition at line 127 of file RT2SPTCConverterModuleDev.h.

◆ m_noFailCtr

unsigned int m_noFailCtr
protected

Counts how many tracks could be converted without any problems.

Definition at line 134 of file RT2SPTCConverterModuleDev.h.

◆ m_noKickCutsFile

std::string m_noKickCutsFile
protected

name of TFile of the cuts

Definition at line 123 of file RT2SPTCConverterModuleDev.h.

◆ m_noKickOutput

bool m_noKickOutput
protected

true=produce TFile with effects of NoKickCuts on tracks

Definition at line 124 of file RT2SPTCConverterModuleDev.h.

◆ m_npass

int m_npass = 0
protected

counter of the selected tracks

Definition at line 128 of file RT2SPTCConverterModuleDev.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_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_PXDSpacePoints

StoreArray<SpacePoint> m_PXDSpacePoints
protected

PXDSpacePoints StoreArray.

Definition at line 101 of file RT2SPTCConverterModuleDev.h.

◆ m_pxdSpacePointsStoreArrayName

std::optional<std::string> m_pxdSpacePointsStoreArrayName
protected

PXD SpacePoints collection names.

Definition at line 92 of file RT2SPTCConverterModuleDev.h.

◆ m_RecoTracks

StoreArray<RecoTrack> m_RecoTracks
protected

RecoTracks StoreArray.

Definition at line 103 of file RT2SPTCConverterModuleDev.h.

◆ m_RecoTracksName

std::string m_RecoTracksName
protected

Name of collection of RecoTrack StoreArray.

Definition at line 97 of file RT2SPTCConverterModuleDev.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_singleClusterUseCtr

unsigned int m_singleClusterUseCtr
protected

Counts how many tracks contained a single cluster.

Definition at line 135 of file RT2SPTCConverterModuleDev.h.

◆ m_skipProblematicCluster

bool m_skipProblematicCluster
protected

If true problematic clusters are ignored.

If false the conversion of a RecoTrack containing such a cluster is aborted

Definition at line 114 of file RT2SPTCConverterModuleDev.h.

◆ m_SpacePointTrackCands

StoreArray<SpacePointTrackCand> m_SpacePointTrackCands
protected

SpacePointTrackCands StoreArray.

Definition at line 104 of file RT2SPTCConverterModuleDev.h.

◆ m_SPTCName

std::string m_SPTCName
protected

Name of collection under which SpacePointTrackCands will be stored in the StoreArray.

Definition at line 99 of file RT2SPTCConverterModuleDev.h.

◆ m_SVDClusterName

std::string m_SVDClusterName
protected

SVDCluster collection name.

Definition at line 90 of file RT2SPTCConverterModuleDev.h.

◆ m_SVDClusters

StoreArray<SVDCluster> m_SVDClusters
protected

SVDClusters StoreArray.

Definition at line 107 of file RT2SPTCConverterModuleDev.h.

◆ m_SVDSingleClusterSPName

std::string m_SVDSingleClusterSPName
protected

Single Cluster SVD SpacePoints collection name.

Definition at line 95 of file RT2SPTCConverterModuleDev.h.

◆ m_SVDSpacePoints

StoreArray<SpacePoint> m_SVDSpacePoints
protected

SVDSpacePoints StoreArray.

Definition at line 102 of file RT2SPTCConverterModuleDev.h.

◆ m_svdSpacePointsStoreArrayName

std::optional<std::string> m_svdSpacePointsStoreArrayName
protected

Non SingleCluster SVD SpacePoints collection names.

Definition at line 93 of file RT2SPTCConverterModuleDev.h.

◆ m_SVDTrueHit

StoreArray<SVDTrueHit> m_SVDTrueHit
protected

SVDTrueHits StoreArray.

Definition at line 106 of file RT2SPTCConverterModuleDev.h.

◆ m_trackSel

NoKickRTSel* m_trackSel
protected

data members used for the NoKickCuts method

member to call method of NoKickCuts selection

Definition at line 122 of file RT2SPTCConverterModuleDev.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_undefinedErrorCtr

unsigned int m_undefinedErrorCtr
protected

Counts how many tracks failed to be converted.

Definition at line 136 of file RT2SPTCConverterModuleDev.h.

◆ m_useSingleClusterSP

bool m_useSingleClusterSP
protected

If true use single cluster SpacePoint collection as fallback.

Definition at line 115 of file RT2SPTCConverterModuleDev.h.

◆ m_useTrueHits

bool m_useTrueHits
protected

If true the method getSpacePointsFromSVDClustersViaTrueHits is utilized.

Requires TrueHits to be present and to have relations to SpacePoints!

Definition at line 113 of file RT2SPTCConverterModuleDev.h.

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