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

Kink finder module. More...

#include <KinkFinderModule.h>

Inheritance diagram for KinkFinderModule:
Module PathElement

Classes

struct  CDCForwardBackwardWallLine
 Structure to store the information about forward and backward walls of CDC. More...
 

Public Types

enum  EModulePropFlags {
  c_Input = 1 ,
  c_Output = 2 ,
  c_ParallelProcessingCertified = 4 ,
  c_HistogramManager = 8 ,
  c_InternalSerializer = 16 ,
  c_TerminateInAllProcesses = 32 ,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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.
 

Private Member Functions

void fitAndStore (const Track *trackMother, const Track *trackDaughter, const short filterFlag)
 Kink fitting and storing.
 
bool kinkFitterModeSplitTrack ()
 Fitter mode 4th bit responsible for turning On/Off track splitting.
 
bool ifInCDC (const ROOT::Math::XYZVector &pos)
 Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall, passed as parameters of the module.
 
bool preFilterMotherTracks (Track const *const track)
 Check if the track can be a mother candidate based on some simple selections.
 
bool preFilterDaughterTracks (Track const *const track)
 Check if the track can be a daughter candidate based on some simple selections.
 
bool preFilterTracksToSplit (Track const *const track)
 Check if the track can be a candidate to be split based on some simple selections.
 
short isTrackPairSelected (const Track *motherTrack, const Track *daughterTrack)
 Track pair preselection based on distance between two tracks with different options.
 
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_arrayNameTrack
 StoreArray name of the Belle2::Track (Input).
 
StoreArray< Track > m_tracks
 StoreArray of Belle2::Track.
 
std::unique_ptr< KinkFitter > m_kinkFitter
 Object containing the algorithm of Kink creation.
 
std::string m_arrayNameRecoTrack
 StoreArray name of the RecoTrack (Input).
 
std::string m_arrayNameCopiedRecoTrack
 StoreArray name of the RecoTrack used for creating copies.
 
std::string m_arrayNameTFResult
 StoreArray name of the TrackFitResult (In- and Output).
 
std::string m_arrayNameKink
 StoreArray name of the Kink (Output).
 
DBObjPtr< KinkFinderParameters > m_kinkFinderParameters
 kinkFinder parameters Database ObjPtr
 
CDCForwardBackwardWallLine m_cdcForwardBottomWall
 Bottom part of forward CDC wall.
 
CDCForwardBackwardWallLine m_cdcForwardTopWall
 Top part of forward CDC wall.
 
CDCForwardBackwardWallLine m_cdcBackwardBottomWall
 Bottom part of backward CDC wall.
 
CDCForwardBackwardWallLine m_cdcBackwardTopWall
 Top part of backward CDC wall.
 
unsigned int m_allStored = 0
 counter for all saved Kinks
 
unsigned int m_f1Stored = 0
 counter for filter 1 saved Kinks
 
unsigned int m_f2Stored = 0
 counter for filter 2 saved Kinks
 
unsigned int m_f3Stored = 0
 counter for filter 3 saved Kinks
 
unsigned int m_f4Stored = 0
 counter for filter 4 saved Kinks
 
unsigned int m_f5Stored = 0
 counter for filter 5 saved Kinks
 
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.
 

Static Private Attributes

static constexpr double m_cdcInnerWithFirstLayerWall = 15
 Smaller radius of inner CDC wall [cm].
 
static constexpr double m_cdcInnerWallWithoutFirstLayer = 17
 Bigger radius of inner CDC wall [cm].
 
static constexpr double m_cdcInnerWallWithoutFirstTwoLayers = 18
 Second bigger radius of inner CDC wall [cm].
 
static constexpr double m_cdcOuterWall = 112
 Radius of outer CDC wall [cm].
 
static constexpr double m_svdBeforeOuterLayer = 12
 Radius between two outer SVD layers (10.4 and 13.5 cm) [cm].
 

Detailed Description

Kink finder module.

Preselects and pairs up tracks and tries to find a vertex between them. Preselects and tries to split tracks that might be combined from two kink tracks.

The resulting pairs of tracks are stored as Belle2::Kink.

Definition at line 37 of file KinkFinderModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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

Constructor & Destructor Documentation

◆ KinkFinderModule()

KinkFinderModule ( )

Setting of module description, parameters.

Definition at line 24 of file KinkFinderModule.cc.

24 : Module()
25{
26
27 setDescription("This is a Kink finder module which preselects mother and daughter candidate tracks and matches them "
28 "and fits a vertex for each pair. Depending on the outcome of each fit, a corresponding "
29 "``Belle2::Kink`` is stored or not.\n\n"
30 "The parameters of the ``KinkFinder`` are stored as payloads in ``KinkFinderParameters``.\n\n"
31 "A loose cut on the pair is applied before the fit; then, a vertex fit is performed, and only pairs "
32 "passing a chi^2 (``KinkFinderParameters::m_vertexChi2Cut``) and distance "
33 "(``KinkFinderParameters::m_vertexDistanceCut``) are stored as ``Belle2::Kink``.\n\n"
34 "If a corresponding ``KinkFitter`` mode is ON, hits are reassigned between mother and daughter tracks "
35 "to improve the resolutions and efficiency. If a corresponding ``KinkFitter`` mode is ON, the track "
36 "pair is also fitted as one track and a special flag is filled based on the result to suppress the clones.\n\n"
37 "If a corresponding ``KinkFitter`` mode is ON, ``KinkFinder`` preselects track candidates "
38 "that might be formed from two kink tracks, and ``KinkFitter`` splits such tracks. "
39 "After that the result is stored in ``Belle2::Kink``.");
40
41 setPropertyFlags(c_ParallelProcessingCertified);
42
43 // input: RecoTracks
44 addParam("RecoTracks", m_arrayNameRecoTrack,
45 "RecoTrack StoreArray name (input)", std::string(""));
46
47 // RecoTracks for the refitting procedures
48 addParam("CopiedRecoTracks", m_arrayNameCopiedRecoTrack,
49 "RecoTrack StoreArray name (used for track refitting)", std::string("RecoTracksKinkTmp"));
50
51 // input: Tracks and TrackFitResults; output: TrackFitResults (for the refitted tracks)
52 addParam("TrackFitResults", m_arrayNameTFResult,
53 "Belle2::TrackFitResult StoreArray name (in- and output).\n"
54 "Note that the Kinks use pointers indices into these arrays, so all hell may break loose, "
55 "if you change this.", std::string(""));
56 addParam("Tracks", m_arrayNameTrack,
57 "Belle2::Track StoreArray name (input).\n"
58 "Note that the Kinks use pointers indices into these arrays, so all hell may break loose, "
59 "if you change this.", std::string(""));
60
61 // output: Kinks
62 addParam("Kinks", m_arrayNameKink, "Kink StoreArray name (output).", std::string(""));
63
64}
Belle2::KinkFinderModule::m_arrayNameCopiedRecoTrack
std::string m_arrayNameCopiedRecoTrack
StoreArray name of the RecoTrack used for creating copies.
Definition: KinkFinderModule.h:167
Belle2::KinkFinderModule::m_arrayNameKink
std::string m_arrayNameKink
StoreArray name of the Kink (Output).
Definition: KinkFinderModule.h:169
Belle2::KinkFinderModule::m_arrayNameTFResult
std::string m_arrayNameTFResult
StoreArray name of the TrackFitResult (In- and Output).
Definition: KinkFinderModule.h:168
Belle2::KinkFinderModule::m_arrayNameRecoTrack
std::string m_arrayNameRecoTrack
StoreArray name of the RecoTrack (Input).
Definition: KinkFinderModule.h:166
Belle2::KinkFinderModule::m_arrayNameTrack
std::string m_arrayNameTrack
StoreArray name of the Belle2::Track (Input).
Definition: KinkFinderModule.h:162
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::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Read parameters from the database and apply to KinkFitter.

Reimplemented from Module.

Definition at line 92 of file KinkFinderModule.cc.

93{
94 if (!m_kinkFinderParameters.isValid())
95 B2FATAL("KinkFinder parameters are not available.");
96
97 // apply cuts and fitter mode to KinkFitter
98 m_kinkFitter->initializeCuts(m_kinkFinderParameters->getVertexDistanceCut(),
99 m_kinkFinderParameters->getVertexChi2Cut(),
100 m_kinkFinderParameters->getPrecutDistance());
101 m_kinkFitter->setFitterMode(m_kinkFinderParameters->getKinkFitterMode());
102}
Belle2::KinkFinderModule::m_kinkFinderParameters
DBObjPtr< KinkFinderParameters > m_kinkFinderParameters
kinkFinder parameters Database ObjPtr
Definition: KinkFinderModule.h:171
Belle2::KinkFinderModule::m_kinkFitter
std::unique_ptr< KinkFitter > m_kinkFitter
Object containing the algorithm of Kink creation.
Definition: KinkFinderModule.h:165

◆ 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()

virtual void endRun ( void  )
inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

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

Definition at line 166 of file Module.h.

166{};

◆ 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

Creates Belle2::Kink from Belle2::Track as described in the class documentation.

Reimplemented from Module.

Definition at line 105 of file KinkFinderModule.cc.

106{
107 B2DEBUG(29, m_tracks.getEntries() << " tracks in event.");
108
109 // Group tracks into mother and daughter candidates.
110 std::vector<const Track*> tracksMother;
111 tracksMother.reserve(m_tracks.getEntries());
112
113 std::vector<const Track*> tracksDaughter;
114 tracksDaughter.reserve(m_tracks.getEntries());
115
116 for (const auto& track : m_tracks) {
117 RecoTrack const* const recoTrack = track.getRelated<RecoTrack>(m_arrayNameRecoTrack);
118 B2ASSERT("No RecoTrack available for given Track.", recoTrack);
119
120 // track is fitted
121 if (!recoTrack->hasTrackFitStatus() || !recoTrack->wasFitSuccessful()) continue;
122
123 // exclude tracks that have CDC hits and end with VXD hits (the kink efficiency loss is negligible)
124 const auto& recoHitsInformation = recoTrack->getRecoHitInformations(true);
125 if (recoTrack->getNumberOfCDCHits() &&
126 ((recoHitsInformation.back())->getTrackingDetector() == RecoHitInformation::RecoHitDetector::c_SVD ||
127 (recoHitsInformation.back())->getTrackingDetector() == RecoHitInformation::RecoHitDetector::c_PXD))
128 continue;
129
130 bool trackChosen = false;
131 // select mother candidates
132 if (preFilterMotherTracks(&track)) {
133 tracksMother.push_back(&track);
134 trackChosen = true;
135
136 // if mother candidate pass criteria for splitting, split it with filter 7
137 if (kinkFitterModeSplitTrack() && preFilterTracksToSplit(&track)) {
138 const short filterFlag = 7;
139 fitAndStore(&track, &track, filterFlag);
140 }
141 }
142 // select daughter candidates
143 if (preFilterDaughterTracks(&track)) {
144 tracksDaughter.push_back(&track);
145 trackChosen = true;
146
147 // if daughter candidate pass criteria for splitting, split it with filter 8
148 if (kinkFitterModeSplitTrack() && preFilterTracksToSplit(&track)) {
149 const short filterFlag = 8;
150 fitAndStore(&track, &track, filterFlag);
151 }
152 }
153
154 // if track does not pass mother or daughter selection but passes criteria for splitting, split it with filter 9
155 if (kinkFitterModeSplitTrack() && !trackChosen && preFilterTracksToSplit(&track)) {
156 const short filterFlag = 9;
157 fitAndStore(&track, &track, filterFlag);
158 }
159 }
160
161 // Reject boring events.
162 if (tracksMother.empty() || tracksDaughter.empty()) {
163 B2DEBUG(29, "No interesting track pairs found. Number of selected tracksMother: " << tracksMother.size() <<
164 ", tracksDaughter " << tracksDaughter.size());
165 return;
166 }
167
168 // Pair up each mother track with each daughter track.
169 for (auto& trackMother : tracksMother) {
170 for (auto& trackDaughter : tracksDaughter) {
171 const short filterFlag = isTrackPairSelected(trackMother, trackDaughter);
172 if (!filterFlag) continue;
173 B2DEBUG(29, "Found kink candidate with filterFlag " << filterFlag);
174 fitAndStore(trackMother, trackDaughter, filterFlag);
175 }
176 }
177
178}
Belle2::KinkFinderModule::fitAndStore
void fitAndStore(const Track *trackMother, const Track *trackDaughter, const short filterFlag)
Kink fitting and storing.
Definition: KinkFinderModule.cc:397
Belle2::KinkFinderModule::preFilterTracksToSplit
bool preFilterTracksToSplit(Track const *const track)
Check if the track can be a candidate to be split based on some simple selections.
Definition: KinkFinderModule.cc:284
Belle2::KinkFinderModule::isTrackPairSelected
short isTrackPairSelected(const Track *motherTrack, const Track *daughterTrack)
Track pair preselection based on distance between two tracks with different options.
Definition: KinkFinderModule.cc:313
Belle2::KinkFinderModule::preFilterMotherTracks
bool preFilterMotherTracks(Track const *const track)
Check if the track can be a mother candidate based on some simple selections.
Definition: KinkFinderModule.cc:230
Belle2::KinkFinderModule::preFilterDaughterTracks
bool preFilterDaughterTracks(Track const *const track)
Check if the track can be a daughter candidate based on some simple selections.
Definition: KinkFinderModule.cc:264
Belle2::KinkFinderModule::m_tracks
StoreArray< Track > m_tracks
StoreArray of Belle2::Track.
Definition: KinkFinderModule.h:163
Belle2::KinkFinderModule::kinkFitterModeSplitTrack
bool kinkFitterModeSplitTrack()
Fitter mode 4th bit responsible for turning On/Off track splitting.
Definition: KinkFinderModule.cc:193
Belle2::RecoTrack
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:79
Belle2::RecoTrack::wasFitSuccessful
bool wasFitSuccessful(const genfit::AbsTrackRep *representation=nullptr) const
Returns true if the last fit with the given representation was successful.
Definition: RecoTrack.cc:336
Belle2::RecoTrack::getNumberOfCDCHits
unsigned int getNumberOfCDCHits() const
Return the number of cdc hits.
Definition: RecoTrack.h:427
Belle2::RecoTrack::hasTrackFitStatus
bool hasTrackFitStatus(const genfit::AbsTrackRep *representation=nullptr) const
Check, if there is a fit status for the given representation or for the cardinal one.
Definition: RecoTrack.cc:543
Belle2::RecoTrack::getRecoHitInformations
std::vector< RecoHitInformation * > getRecoHitInformations(bool getSorted=false) const
Return a list of all RecoHitInformations associated with the RecoTrack.
Definition: RecoTrack.cc:557

◆ 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

◆ fitAndStore()

void fitAndStore ( const Track *  trackMother,
const Track *  trackDaughter,
const short  filterFlag 
)
private

Kink fitting and storing.

Parameters
trackMothermother track
trackDaughterdaughter track
filterFlagflag of the satisfied preselection criteria

Definition at line 397 of file KinkFinderModule.cc.

398{
399 bool ok = m_kinkFitter->fitAndStore(trackMother, trackDaughter, filterFlag);
400 if (ok) {
401 ++m_allStored;
402 switch (filterFlag) {
403 case 1:
404 case 2:
405 case 4:
406 case 5:
407 ++m_f1Stored;
408 break;
409 case 3:
410 case 6:
411 ++m_f2Stored;
412 break;
413 case 7:
414 ++m_f3Stored;
415 break;
416 case 8:
417 ++m_f4Stored;
418 break;
419 case 9:
420 ++m_f5Stored;
421 }
422 }
423}
Belle2::KinkFinderModule::m_f4Stored
unsigned int m_f4Stored
counter for filter 4 saved Kinks
Definition: KinkFinderModule.h:192
Belle2::KinkFinderModule::m_f2Stored
unsigned int m_f2Stored
counter for filter 2 saved Kinks
Definition: KinkFinderModule.h:190
Belle2::KinkFinderModule::m_f3Stored
unsigned int m_f3Stored
counter for filter 3 saved Kinks
Definition: KinkFinderModule.h:191
Belle2::KinkFinderModule::m_f1Stored
unsigned int m_f1Stored
counter for filter 1 saved Kinks
Definition: KinkFinderModule.h:189
Belle2::KinkFinderModule::m_f5Stored
unsigned int m_f5Stored
counter for filter 5 saved Kinks
Definition: KinkFinderModule.h:193
Belle2::KinkFinderModule::m_allStored
unsigned int m_allStored
counter for all saved Kinks
Definition: KinkFinderModule.h:188

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

Returns
A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

◆ ifInCDC()

bool ifInCDC ( const ROOT::Math::XYZVector &  pos)
private

Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall, passed as parameters of the module.

Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall.

Parameters
pospoint in space
Returns
true if the pos is inside the required volume of the CDC; false if outside

Definition at line 199 of file KinkFinderModule.cc.

200{
201 // check for the first layer of CDC (needed separately because of calculation of trapezoid shapes later)
202 if (pos.Perp2() < m_cdcInnerWallWithoutFirstLayer * m_cdcInnerWallWithoutFirstLayer
203 && pos.Perp2() > m_cdcInnerWithFirstLayerWall * m_cdcInnerWithFirstLayerWall)
204 return true;
205
206 // position inside CDC with respect to required shifts
207 const double z = (pos.Z() > 0) ? (pos.Z() + m_kinkFinderParameters->getPrecutZ()) : (pos.Z() -
208 m_kinkFinderParameters->getPrecutZ());
209 const double r = sqrt(pos.Perp2()) + m_kinkFinderParameters->getPrecutRho();
210
211 // the point should be inside CDC with respect to shift, precutRho, from outer wall
212 if (!((r < m_cdcOuterWall) && (r > m_cdcInnerWallWithoutFirstLayer + m_kinkFinderParameters->getPrecutRho())))
213 return false;
214
215 // the z coordinate point restriction
216 // CDC has a shape of two trapezoids; thus, the forward and backward walls are described with two lines: bottom and top
217 bool z_part;
218 if (z > 0) {
219 // forward walls of CDC
220 z_part = (r > m_cdcForwardBottomWall.getLine(z)) && (r > m_cdcForwardTopWall.getLine(z));
221 } else {
222 // backward walls of CDC
223 z_part = (r > m_cdcBackwardBottomWall.getLine(z)) && (r > m_cdcBackwardTopWall.getLine(z));
224 }
225 return z_part;
226}
Belle2::KinkFinderModule::m_cdcInnerWallWithoutFirstLayer
static constexpr double m_cdcInnerWallWithoutFirstLayer
Bigger radius of inner CDC wall [cm].
Definition: KinkFinderModule.h:180
Belle2::KinkFinderModule::m_cdcBackwardTopWall
CDCForwardBackwardWallLine m_cdcBackwardTopWall
Top part of backward CDC wall.
Definition: KinkFinderModule.h:177
Belle2::KinkFinderModule::m_cdcInnerWithFirstLayerWall
static constexpr double m_cdcInnerWithFirstLayerWall
Smaller radius of inner CDC wall [cm].
Definition: KinkFinderModule.h:178
Belle2::KinkFinderModule::m_cdcForwardBottomWall
CDCForwardBackwardWallLine m_cdcForwardBottomWall
Bottom part of forward CDC wall.
Definition: KinkFinderModule.h:174
Belle2::KinkFinderModule::m_cdcBackwardBottomWall
CDCForwardBackwardWallLine m_cdcBackwardBottomWall
Bottom part of backward CDC wall.
Definition: KinkFinderModule.h:176
Belle2::KinkFinderModule::m_cdcOuterWall
static constexpr double m_cdcOuterWall
Radius of outer CDC wall [cm].
Definition: KinkFinderModule.h:184
Belle2::KinkFinderModule::m_cdcForwardTopWall
CDCForwardBackwardWallLine m_cdcForwardTopWall
Top part of forward CDC wall.
Definition: KinkFinderModule.h:175
Belle2::sqrt
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28
Belle2::KinkFinderModule::CDCForwardBackwardWallLine::getLine
double getLine(const double x) const
Return the y value of the sloping line based on the x value.
Definition: KinkFinderModule.h:152

◆ initialize()

void initialize ( void  )
overridevirtual

Registration of StoreArrays, Relations.

Reimplemented from Module.

Definition at line 67 of file KinkFinderModule.cc.

68{
69 m_tracks.isRequired(m_arrayNameTrack);
70 StoreArray<RecoTrack> recoTracks(m_arrayNameRecoTrack);
71 m_tracks.requireRelationTo(recoTracks);
72 // All the other required StoreArrays are checked in the Constructor of the KinkFitter.
73
74 // Create KinkFitter object.
75 // Its parameters and cuts are set at the beginning of each run based on the information from the database.
76 m_kinkFitter = std::make_unique<KinkFitter>(m_arrayNameTFResult, m_arrayNameKink,
77 m_arrayNameRecoTrack,
78 m_arrayNameCopiedRecoTrack);
79
80 // Set geometry of CDC forward and backward walls.
81 // Here the tangent is forward CDC acceptance (17 degrees).
82 m_cdcForwardBottomWall.setLine(tan(17. / 180 * M_PI), 0);
83 // Here numbers are calculated from the CDC technical geometry.
84 m_cdcForwardTopWall.setLine(4.97, -670);
85 // Here the tangent is backward CDC acceptance (30 degrees).
86 m_cdcBackwardBottomWall.setLine(-tan(30. / 180 * M_PI), 0);
87 // Here numbers are calculated from the CDC technical geometry.
88 m_cdcBackwardTopWall.setLine(-4.2, -192.5);
89
90}
Belle2::StoreArray
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
Belle2::KinkFinderModule::CDCForwardBackwardWallLine::setLine
void setLine(const double tangent, const double offset)
Set parameters of slopping line.
Definition: KinkFinderModule.h:140

◆ isTrackPairSelected()

short isTrackPairSelected ( const Track *  motherTrack,
const Track *  daughterTrack 
)
private

Track pair preselection based on distance between two tracks with different options.

Track pair preselection based on distance between two tracks with six different options.

Filter 1: Distance between first point of the daughter and last point of the mother < m_precutDistance (majority). Filter 2: Distance between last point of the daughter and last point of the mother < m_precutDistance (wrong daughter sign; minority but can be increased in future). Filter 3: Distance between the daughter Helix extrapolation to last point of the mother and last point of the mother < m_precutDistance (lost layers for daughter, second largest contribution). Filter 4: 2D distance between first point of the daughter and last point of the mother < m_precutDistance2D (bad daughter resolution recovered by hit reassignment). Filter 5: 2D distance between last point of the daughter and last point of the mother < m_precutDistance2D (bad daughter resolution and wrong daughter sign, almost no events). Filter 6: Distance between the daughter Helix extrapolation to last point of the mother and last point of the mother < m_precutDistance2D (lost layers for daughter combined with bad daughter resolution).

Parameters
motherTrackmother track
daughterTrackdaughter track
Returns
flag of the satisfied preselection criteria (1-6 as it was listed above), or 0 otherwise.

Definition at line 313 of file KinkFinderModule.cc.

314{
315 constexpr double M_PI_over_6 = M_PI / 6.;
316 const double cos_M_PI_over_6 = cos(M_PI_over_6);
317
318 // cut variables squared for convenience
319 const double precutDistanceSquared = m_kinkFinderParameters->getPrecutDistance() * m_kinkFinderParameters->getPrecutDistance();
320 const double precutDistance2DSquared = m_kinkFinderParameters->getPrecutDistance2D() *
321 m_kinkFinderParameters->getPrecutDistance2D();
322
323 // get recoTracks and check that they are not the same
324 RecoTrack const* const motherRecoTrack = motherTrack->getRelated<RecoTrack>(m_arrayNameRecoTrack);
325 RecoTrack const* const daughterRecoTrack = daughterTrack->getRelated<RecoTrack>(m_arrayNameRecoTrack);
326 if (motherRecoTrack == daughterRecoTrack) return 0;
327
328 // Filter 1 check.
329 const ROOT::Math::XYZVector motherPosLast(motherRecoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
330 const ROOT::Math::XYZVector daughterPosFirst(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
331 if ((daughterPosFirst - motherPosLast).Mag2() < precutDistanceSquared) return 1;
332
333 // Filter 2 check.
334 const ROOT::Math::XYZVector daughterPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
335 if ((daughterPosLast - motherPosLast).Mag2() < precutDistanceSquared) return 2;
336
337 // Filter 3 check. Here the same direction of daughter and mother is checked to exclude intersection of tracks
338 // from different hemispheres.
339 // Here and further M_PI_over_6 criteria was obtained empirically: it conservatively reduces the combinatorial
340 // background while saving as much signal events as possible.
341 if (daughterPosLast.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
342 daughterPosFirst.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
343 fabs(daughterPosLast.Phi() - motherPosLast.Phi()) < M_PI_over_6 ||
344 fabs(daughterPosFirst.Phi() - motherPosLast.Phi()) < M_PI_over_6) {
345
346 const ROOT::Math::XYZVector daughterPosClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
347 const ROOT::Math::XYZVector daughterMomClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getMom());
348 const double Bz = BFieldManager::getFieldInTesla(daughterPosClosestToMotherPosLast).Z();
349 // daughter Helix with move to mother last point
350 Helix daughterHelixClosestToMotherPosLast(daughterPosClosestToMotherPosLast,
351 daughterMomClosestToMotherPosLast,
352 static_cast<short>(daughterRecoTrack->getTrackFitStatus()->getCharge()),
353 Bz);
354 daughterHelixClosestToMotherPosLast.passiveMoveBy(motherPosLast);
355
356 if ((daughterHelixClosestToMotherPosLast.getD0() * daughterHelixClosestToMotherPosLast.getD0() +
357 daughterHelixClosestToMotherPosLast.getZ0() * daughterHelixClosestToMotherPosLast.getZ0()) <
358 precutDistanceSquared)
359 return 3;
360 }
361
362 // Filter 4 check.
363 if ((daughterPosFirst - motherPosLast).Perp2() < precutDistance2DSquared)
364 return 4;
365
366 // Filter 5 check.
367 if ((daughterPosLast - motherPosLast).Perp2() < precutDistance2DSquared)
368 return 5;
369
370 // Filter 6 check. Here the same direction of daughter and mother is checked to exclude intersection of tracks
371 // from different hemispheres.
372 if (daughterPosLast.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
373 daughterPosFirst.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
374 fabs(daughterPosLast.Phi() - motherPosLast.Phi()) < M_PI_over_6 ||
375 fabs(daughterPosFirst.Phi() - motherPosLast.Phi()) < M_PI_over_6) {
376
377 const ROOT::Math::XYZVector daughterPosClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
378 const ROOT::Math::XYZVector daughterMomClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getMom());
379 const double Bz = BFieldManager::getFieldInTesla(daughterPosClosestToMotherPosLast).Z();
380 // daughter Helix with move to mother last point
381 Helix daughterHelixClosestToMotherPosLast(daughterPosClosestToMotherPosLast,
382 daughterMomClosestToMotherPosLast,
383 static_cast<short>(daughterRecoTrack->getTrackFitStatus()->getCharge()),
384 Bz);
385 daughterHelixClosestToMotherPosLast.passiveMoveBy(motherPosLast);
386
387 if (fabs(daughterHelixClosestToMotherPosLast.getD0()) < m_kinkFinderParameters->getPrecutDistance())
388 return 6;
389 }
390
391 // No filter is passed.
392 return 0;
393
394}
Belle2::BFieldManager::getFieldInTesla
static ROOT::Math::XYZVector getFieldInTesla(const ROOT::Math::XYZVector &pos)
return the magnetic field at a given position in Tesla.
Definition: BFieldManager.h:61
Belle2::CDC::Helix
Helix parameter class.
Definition: Helix.h:48
Belle2::RecoTrack::getMeasuredStateOnPlaneFromLastHit
const genfit::MeasuredStateOnPlane & getMeasuredStateOnPlaneFromLastHit(const genfit::AbsTrackRep *representation=nullptr) const
Return genfit's MeasuredStateOnPlane for the last hit in a fit useful for extrapolation of measuremen...
Definition: RecoTrack.cc:619
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

◆ kinkFitterModeSplitTrack()

bool kinkFitterModeSplitTrack ( )
private

Fitter mode 4th bit responsible for turning On/Off track splitting.

Returns
true if the track splitting is On and false if it is Off

Definition at line 193 of file KinkFinderModule.cc.

194{
195 return m_kinkFinderParameters->getKinkFitterMode() & 0b1000;
196}

◆ preFilterDaughterTracks()

bool preFilterDaughterTracks ( Track const *const  track)
private

Check if the track can be a daughter candidate based on some simple selections.

Parameters
trackof the candidate
Returns
true if track pass the criteria; false otherwise

They are conservative enough to reduces the combinatorial background and save as much signal events as possible.

Definition at line 264 of file KinkFinderModule.cc.

265{
266 // RecoTrack (existence and fit checked before calling this function)
267 RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
268 // track fit result
269 TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
270
271 // first and last points of the track are > precutRho and > precutZ from outer walls of CDC (against back splashes)
272 const ROOT::Math::XYZVector posLast(recoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
273 const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
274 if (!ifInCDC(posLast) && !ifInCDC(posFirst)) return false;
275
276 // first point of the track is outside inner layers of VXD, or impact parameter in rphi > 1 cm
277 // inverse criteria for mother
278 if (posFirst.Perp2() < m_svdBeforeOuterLayer * m_svdBeforeOuterLayer && fabs(trackFitResult->getD0()) < 1) return false;
279 return true;
280}
Belle2::Const::pion
static const ChargedStable pion
charged pion particle
Definition: Const.h:661
Belle2::KinkFinderModule::ifInCDC
bool ifInCDC(const ROOT::Math::XYZVector &pos)
Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from ou...
Definition: KinkFinderModule.cc:199
Belle2::KinkFinderModule::m_svdBeforeOuterLayer
static constexpr double m_svdBeforeOuterLayer
Radius between two outer SVD layers (10.4 and 13.5 cm) [cm].
Definition: KinkFinderModule.h:185
Belle2::RecoTrack::getMeasuredStateOnPlaneFromFirstHit
const genfit::MeasuredStateOnPlane & getMeasuredStateOnPlaneFromFirstHit(const genfit::AbsTrackRep *representation=nullptr) const
Return genfit's MeasuredStateOnPlane for the first hit in a fit useful for extrapolation of measureme...
Definition: RecoTrack.cc:605
Belle2::TrackFitResult
Values of the result of a track fit with a given particle hypothesis.
Definition: TrackFitResult.h:49

◆ preFilterMotherTracks()

bool preFilterMotherTracks ( Track const *const  track)
private

Check if the track can be a mother candidate based on some simple selections.

Parameters
trackof the candidate
Returns
true if track pass the criteria; false otherwise

They are conservative enough to reduces the combinatorial background and save as much signal events as possible.

Definition at line 230 of file KinkFinderModule.cc.

231{
232 // RecoTrack (existence and fit checked before calling this function)
233 RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
234 // track fit result
235 TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
236
237 // total number of CDC hits
238 const int nCDCHits = recoTrack->getNumberOfCDCHits();
239
240 // last point of the track is > precutRho and > precutZ from outer walls of CDC
241 const ROOT::Math::XYZVector posLast(recoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
242 if (nCDCHits && !ifInCDC(posLast)) return false;
243
244 // track is not curled back to IP
245 // The first layer of CDC has 16.8 cm radius; thus, the track which ends inside m_cdcInnerWallWithoutFirstLayer=17 cm
246 // cylinder is either short or curler.
247 // The requirement of >= 10 hits ensures that it is a curler (obtained empirically)
248 if (nCDCHits >= 10 && posLast.Perp2() < m_cdcInnerWallWithoutFirstLayer * m_cdcInnerWallWithoutFirstLayer) return false;
249
250 // first point of the track is inside inner layers of VXD
251 // The mother candidate should start inside VXD. The radius of outer two SVD layers are 10.4 and 13.5 cm,
252 // so we set m_svdBeforeOuterLayer=12 cm cut (between these layers).
253 const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
254 if (posFirst.Perp2() > m_svdBeforeOuterLayer * m_svdBeforeOuterLayer) return false;
255
256 // impact parameter in rphi < 1 cm
257 // conservative enough assuming possible bad resolution of mother track due to daughter hits assignment
258 if (fabs(trackFitResult->getD0()) > 1) return false;
259 return true;
260}

◆ preFilterTracksToSplit()

bool preFilterTracksToSplit ( Track const *const  track)
private

Check if the track can be a candidate to be split based on some simple selections.

Check if the track is a candidate for splitting based on some simple selections.

Parameters
trackof the candidate
Returns
true if track pass the criteria; false otherwise

They are optimized to reduce the splitting of ordinary (non-decayed) tracks.

Definition at line 284 of file KinkFinderModule.cc.

285{
286 // RecoTrack (existence and fit checked before calling this function)
287 RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
288
289 if (recoTrack->getTrackFitStatus()->getPVal() > m_kinkFinderParameters->getPrecutSplitPValue()) return false;
290
291 // track fit result
292 TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
293
294 // number of fitted CDC hits
295 const int nFittedCDCHits = trackFitResult->getHitPatternCDC().getNHits();
296 if (nFittedCDCHits > m_kinkFinderParameters->getPrecutSplitNCDCHit()) return false;
297 // more than 5 CDC hits to have enough hits for possible splitting
298 if (nFittedCDCHits < 5) return false;
299
300 // first point of the track is close to the inner wall of the CDC
301 // we set m_cdcInnerWallWithoutFirstTwoLayers=18 cm cut to have both tracks with and without VXD hits
302 const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
303 if (posFirst.Perp2() > m_cdcInnerWallWithoutFirstTwoLayers * m_cdcInnerWallWithoutFirstTwoLayers) return false;
304
305 // impact parameter in rphi < 2 cm
306 // Loose enough assuming possible bad resolution of track due to daughter hits assignment
307 if (fabs(trackFitResult->getD0()) > 2) return false;
308
309 return true;
310}
Belle2::HitPatternCDC::getNHits
unsigned short getNHits() const
Get the total Number of CDC hits in the fit.
Definition: HitPatternCDC.cc:47
Belle2::KinkFinderModule::m_cdcInnerWallWithoutFirstTwoLayers
static constexpr double m_cdcInnerWallWithoutFirstTwoLayers
Second bigger radius of inner CDC wall [cm].
Definition: KinkFinderModule.h:182
Belle2::RecoTrack::getTrackFitStatus
const genfit::FitStatus * getTrackFitStatus(const genfit::AbsTrackRep *representation=nullptr) const
Return the track fit status for the given representation or for the cardinal one. You are not allowed...
Definition: RecoTrack.h:621
Belle2::TrackFitResult::getD0
double getD0() const
Getter for d0.
Definition: TrackFitResult.h:179
Belle2::TrackFitResult::getHitPatternCDC
HitPatternCDC getHitPatternCDC() const
Getter for the hit pattern in the CDC;.
Definition: TrackFitResult.cc:134

◆ 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

Prints status summary.

Reimplemented from Module.

Definition at line 181 of file KinkFinderModule.cc.

182{
183 B2INFO("===KinkFinder summary===========================================================");
184 B2INFO("In total " << m_allStored << " kinks saved. Among them");
185 B2INFO("track pairs with close endpoints: " << m_f1Stored << ";");
186 B2INFO("track pairs with missing layers between their endpoints (Helix extrapolation selection): " << m_f2Stored << ";");
187 B2INFO("split track chosen from mother candidates: " << m_f3Stored << ";");
188 B2INFO("split track chosen from daughter candidates: " << m_f4Stored << ";");
189 B2INFO("split track chosen from tracks not passing mother/daughter preselection " << m_f5Stored << ".");
190}

Member Data Documentation

◆ m_allStored

unsigned int m_allStored = 0
private

counter for all saved Kinks

Definition at line 188 of file KinkFinderModule.h.

◆ m_arrayNameCopiedRecoTrack

std::string m_arrayNameCopiedRecoTrack
private

StoreArray name of the RecoTrack used for creating copies.

Definition at line 167 of file KinkFinderModule.h.

◆ m_arrayNameKink

std::string m_arrayNameKink
private

StoreArray name of the Kink (Output).

Definition at line 169 of file KinkFinderModule.h.

◆ m_arrayNameRecoTrack

std::string m_arrayNameRecoTrack
private

StoreArray name of the RecoTrack (Input).

Definition at line 166 of file KinkFinderModule.h.

◆ m_arrayNameTFResult

std::string m_arrayNameTFResult
private

StoreArray name of the TrackFitResult (In- and Output).

Definition at line 168 of file KinkFinderModule.h.

◆ m_arrayNameTrack

std::string m_arrayNameTrack
private

StoreArray name of the Belle2::Track (Input).

Definition at line 162 of file KinkFinderModule.h.

◆ m_cdcBackwardBottomWall

CDCForwardBackwardWallLine m_cdcBackwardBottomWall
private

Bottom part of backward CDC wall.

Definition at line 176 of file KinkFinderModule.h.

◆ m_cdcBackwardTopWall

CDCForwardBackwardWallLine m_cdcBackwardTopWall
private

Top part of backward CDC wall.

Definition at line 177 of file KinkFinderModule.h.

◆ m_cdcForwardBottomWall

CDCForwardBackwardWallLine m_cdcForwardBottomWall
private

Bottom part of forward CDC wall.

Definition at line 174 of file KinkFinderModule.h.

◆ m_cdcForwardTopWall

CDCForwardBackwardWallLine m_cdcForwardTopWall
private

Top part of forward CDC wall.

Definition at line 175 of file KinkFinderModule.h.

◆ m_cdcInnerWallWithoutFirstLayer

constexpr double m_cdcInnerWallWithoutFirstLayer = 17
staticconstexprprivate

Bigger radius of inner CDC wall [cm].

It is taken a bit bigger to exclude the first layer of CDC (required in some preselection).

Definition at line 180 of file KinkFinderModule.h.

◆ m_cdcInnerWallWithoutFirstTwoLayers

constexpr double m_cdcInnerWallWithoutFirstTwoLayers = 18
staticconstexprprivate

Second bigger radius of inner CDC wall [cm].

It is taken a bit bigger to exclude first two layers of CDC (required in some preselection).

Definition at line 182 of file KinkFinderModule.h.

◆ m_cdcInnerWithFirstLayerWall

constexpr double m_cdcInnerWithFirstLayerWall = 15
staticconstexprprivate

Smaller radius of inner CDC wall [cm].

It is taken a bit smaller not to loose some events with the first layer of CDC.

Definition at line 178 of file KinkFinderModule.h.

◆ m_cdcOuterWall

constexpr double m_cdcOuterWall = 112
staticconstexprprivate

Radius of outer CDC wall [cm].

Definition at line 184 of file KinkFinderModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_f1Stored

unsigned int m_f1Stored = 0
private

counter for filter 1 saved Kinks

Definition at line 189 of file KinkFinderModule.h.

◆ m_f2Stored

unsigned int m_f2Stored = 0
private

counter for filter 2 saved Kinks

Definition at line 190 of file KinkFinderModule.h.

◆ m_f3Stored

unsigned int m_f3Stored = 0
private

counter for filter 3 saved Kinks

Definition at line 191 of file KinkFinderModule.h.

◆ m_f4Stored

unsigned int m_f4Stored = 0
private

counter for filter 4 saved Kinks

Definition at line 192 of file KinkFinderModule.h.

◆ m_f5Stored

unsigned int m_f5Stored = 0
private

counter for filter 5 saved Kinks

Definition at line 193 of file KinkFinderModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_kinkFinderParameters

DBObjPtr<KinkFinderParameters> m_kinkFinderParameters
private

kinkFinder parameters Database ObjPtr

Definition at line 171 of file KinkFinderModule.h.

◆ m_kinkFitter

std::unique_ptr<KinkFitter> m_kinkFitter
private

Object containing the algorithm of Kink creation.

Definition at line 165 of file KinkFinderModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.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_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_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_svdBeforeOuterLayer

constexpr double m_svdBeforeOuterLayer = 12
staticconstexprprivate

Radius between two outer SVD layers (10.4 and 13.5 cm) [cm].

Definition at line 185 of file KinkFinderModule.h.

◆ m_tracks

StoreArray<Track> m_tracks
private

StoreArray of Belle2::Track.

Definition at line 163 of file KinkFinderModule.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.

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