Belle II Software development
CKFRelationCreator< AState, ASeedRelationFilter, AHitRelationFilter > Class Template Referenceabstract

Findlet for applying filters for creating hit-hit and hit-seed relations. More...

#include <CKFRelationCreator.dcl.h>

Inheritance diagram for CKFRelationCreator< AState, ASeedRelationFilter, AHitRelationFilter >:
Findlet< AState, AState, TrackFindingCDC::WeightedRelation< AState > > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using Super = TrackFindingCDC::Findlet<AState, AState, TrackFindingCDC::WeightedRelation<AState>>
 The parent class.
 
using IOTypes
 Types that should be served to apply on invocation.
 
using IOTypes
 Types that should be served to apply on invocation.
 
using IOVectors
 Vector types that should be served to apply on invocation.
 
using IOVectors
 Vector types that should be served to apply on invocation.
 

Public Member Functions

 CKFRelationCreator ()
 Construct this findlet and add the subfindlet as listener.
 
 ~CKFRelationCreator ()
 Default destructor.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose the parameters of the subfindlet.
 
void apply (std::vector< AState > &seedStates, std::vector< AState > &states, std::vector< TrackFindingCDC::WeightedRelation< AState > > &relations) override
 Apply both filters for creating state-hit and hit-hit relations.
 
virtual std::string getDescription ()
 Brief description of the purpose of the concrete findlet.
 
virtual std::string getDescription ()
 Brief description of the purpose of the concrete findlet.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
void initialize () override
 Receive and dispatch signal before the start of the event processing.
 
void beginRun () override
 Receive and dispatch signal for the beginning of a new run.
 
void beginEvent () override
 Receive and dispatch signal for the start of a new event.
 
void endRun () override
 Receive and dispatch signal for the end of the run.
 
void terminate () override
 Receive and dispatch Signal for termination of the event processing.
 

Protected Types

using ToVector
 Short hand for ToRangeImpl.
 
using ToVector
 Short hand for ToRangeImpl.
 

Protected Member Functions

void addProcessingSignalListener (ProcessingSignalListener *psl)
 Register a processing signal listener to be notified.
 
int getNProcessingSignalListener ()
 Get the number of currently registered listeners.
 

Private Attributes

ASeedRelationFilter m_seedFilter
 Subfindlet for the relation checking between seed and hits.
 
AHitRelationFilter m_hitFilter
 Subfindlet for the relation checking between hits and hits.
 
bool m_onlyUseHitStatesRelatedToSeeds = false
 Only use subset of hits already related to the seeds to reduce combinatorics as the "FromState".
 
bool m_onlyCombineRelatedHitStates = false
 Only use subset of hits already related to the seeds to reduce combinatorics as "FromState" and as "ToStates".
 
std::vector< ProcessingSignalListener * > m_subordinaryProcessingSignalListeners
 References to subordinary signal processing listener contained in this findlet.
 
bool m_initialized
 Flag to keep track whether initialization happened before.
 
bool m_terminated
 Flag to keep track whether termination happened before.
 
std::string m_initializedAs
 Name of the type during initialisation.
 

Detailed Description

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
class Belle2::CKFRelationCreator< AState, ASeedRelationFilter, AHitRelationFilter >

Findlet for applying filters for creating hit-hit and hit-seed relations.

Definition at line 25 of file CKFRelationCreator.dcl.h.

Member Typedef Documentation

◆ IOTypes [1/2]

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOTypes [2/2]

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors [1/2]

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ IOVectors [2/2]

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
using Super = TrackFindingCDC::Findlet<AState, AState, TrackFindingCDC::WeightedRelation<AState>>

The parent class.

Definition at line 28 of file CKFRelationCreator.dcl.h.

◆ ToVector [1/2]

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

◆ ToVector [2/2]

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl)
protectedinherited

Register a processing signal listener to be notified.

Definition at line 53 of file CompositeProcessingSignalListener.cc.

56{
58}
Interface for a minimal algorithm part that wants to expose some parameters to a module.
Definition Findlet.h:26

◆ beginEvent()

void beginEvent ( )
overrideinherited

Receive and dispatch signal for the start of a new event.

Definition at line 36 of file CompositeProcessingSignalListener.cc.

32{
35 psl->beginEvent();
36 }
37}
void beginEvent() override
Receive and dispatch signal for the start of a new event.
virtual void beginEvent()
Receive signal for the start of a new event.

◆ beginRun()

void beginRun ( )
overrideinherited

Receive and dispatch signal for the beginning of a new run.

Definition at line 33 of file CompositeProcessingSignalListener.cc.

24{
27 psl->beginRun();
28 }
29}
void beginRun() override
Receive and dispatch signal for the beginning of a new run.
virtual void beginRun()
Receive signal for the beginning of a new run.

◆ endRun()

void endRun ( )
overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

40{
42 psl->endRun();
43 }
45}
void endRun() override
Receive and dispatch signal for the end of the run.
virtual void endRun()
Receive signal for the end of the run.

◆ getDescription() [1/2]

virtual std::string getDescription ( )
inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

61 {
62 return "(no description)";
63 }

◆ getDescription() [2/2]

virtual std::string getDescription ( )
inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

61 {
62 return "(no description)";
63 }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{
63}

◆ initialize()

void initialize ( )
overrideinherited

Receive and dispatch signal before the start of the event processing.

Definition at line 30 of file CompositeProcessingSignalListener.cc.

16{
19 psl->initialize();
20 }
21}
void initialize() override
Receive and dispatch signal before the start of the event processing.
virtual void initialize()
Receive signal before the start of the event processing.

◆ terminate()

void terminate ( )
overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

48{
50 psl->terminate();
51 }
53}
void terminate() override
Receive and dispatch Signal for termination of the event processing.
virtual void terminate()
Receive Signal for termination of the event processing.

Member Data Documentation

◆ m_hitFilter

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
AHitRelationFilter m_hitFilter
private

Subfindlet for the relation checking between hits and hits.

Definition at line 47 of file CKFRelationCreator.dcl.h.

◆ m_initialized

bool m_initialized
privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

◆ m_initializedAs

std::string m_initializedAs
privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

◆ m_onlyCombineRelatedHitStates

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
bool m_onlyCombineRelatedHitStates = false
private

Only use subset of hits already related to the seeds to reduce combinatorics as "FromState" and as "ToStates".

For this to work, m_onlyUseHitStatesRelatedToSeeds has to be true. Will only work reasonably well for PXD as we only have two layers and can jump over L2.

Definition at line 54 of file CKFRelationCreator.dcl.h.

◆ m_onlyUseHitStatesRelatedToSeeds

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
bool m_onlyUseHitStatesRelatedToSeeds = false
private

Only use subset of hits already related to the seeds to reduce combinatorics as the "FromState".

Will only work reasonably well for PXD as we only have two layers and can jump over L2.

Definition at line 50 of file CKFRelationCreator.dcl.h.

◆ m_seedFilter

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
ASeedRelationFilter m_seedFilter
private

Subfindlet for the relation checking between seed and hits.

Definition at line 45 of file CKFRelationCreator.dcl.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners
privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated
privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.


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