Belle II Software development
PathLengthToggledApplier< AHit, AFindlet > Class Template Referenceabstract

A special findlet, which chooses the filter based on the current path length. More...

#include <PathLengthToggledApplier.dcl.h>

Inheritance diagram for PathLengthToggledApplier< AHit, AFindlet >:
OnHitApplier< AHit > Findlet< const TrackFindingCDC::WithWeight< const AHit * >, TrackFindingCDC::WithWeight< AHit * > > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using Object = std::pair<const std::vector<TrackFindingCDC::WithWeight<const AHit*>>, AHit*>
 The object this filter refers to.
 
using IOTypes
 Types that should be served to apply on invocation.
 
using IOVectors
 Vector types that should be served to apply on invocation.
 

Public Member Functions

 PathLengthToggledApplier ()
 Add the subfilters as listeners.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose parameters of the subfilters and the layer to change.
 
void apply (const std::vector< TrackFindingCDC::WithWeight< const AHit * > > &currentPath, std::vector< TrackFindingCDC::WithWeight< AHit * > > &childHits) override
 The weight is calculated using the subfilter based on the geometrical layer of the state.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
virtual TrackFindingCDC::Weight operator() (const Object &object)
 The filter operator for this class.
 
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.
 
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.
 

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 Types

using Super = OnHitApplier<AHit>
 the parent class
 

Private Attributes

AFindlet m_twoHitFilterFindlet
 Findlet used for currentPath.size() == 1.
 
AFindlet m_threeHitFilterFindlet
 Findlet used for currentPath.size() == 2.
 
AFindlet m_fourHitFilterFindlet
 Findlet used for currentPath.size() == 3.
 
AFindlet m_fiveHitFilterFindlet
 Findlet used for currentPath.size() == 4.
 
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 AHit, class AFindlet>
class Belle2::vxdHoughTracking::PathLengthToggledApplier< AHit, AFindlet >

A special findlet, which chooses the filter based on the current path length.

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

Member Typedef Documentation

◆ IOTypes

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Object

template<class AHit>
using Object = std::pair<const std::vector<TrackFindingCDC::WithWeight<const AHit*>>, AHit*>
inherited

The object this filter refers to.

Definition at line 37 of file OnHitApplier.dcl.h.

◆ Super

template<class AHit, class AFindlet>
using Super = OnHitApplier<AHit>
private

the parent class

Definition at line 27 of file PathLengthToggledApplier.dcl.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ PathLengthToggledApplier()

template<class AHit, class AFindlet>
PathLengthToggledApplier ( )

Add the subfilters as listeners.

Definition at line 23 of file PathLengthToggledApplier.icc.h.

23 : Super()
24 {
25 Super::addProcessingSignalListener(&m_twoHitFilterFindlet);
26 Super::addProcessingSignalListener(&m_threeHitFilterFindlet);
27 Super::addProcessingSignalListener(&m_fourHitFilterFindlet);
28 Super::addProcessingSignalListener(&m_fiveHitFilterFindlet);
29 }

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

◆ apply()

template<class AHit, class AFindlet>
void apply ( const std::vector< TrackFindingCDC::WithWeight< const AHit * > > & currentPath,
std::vector< TrackFindingCDC::WithWeight< AHit * > > & childHits )
override

The weight is calculated using the subfilter based on the geometrical layer of the state.

Definition at line 44 of file PathLengthToggledApplier.icc.h.

46 {
47 // if currentPath.size() == 1, including the single child hits makes the total path length 2, so use the twoHitFilter
48 // if currentPath.size() == 2, including the single child hits makes the total path length 3, so use the threeHitFilter
49 // if currentPath.size() == 3, including the single child hits makes the total path length 4, so use the fourHitFilter
50 // if currentPath.size() == 4, including the single child hits makes the total path length 5, so use the fiveHitFilter
51 // in the rare case that currentPath already contains five or more hits, it's very likely already that it's a valid track
52 // candidate, so no filter is applied here, but only the best N candidates sorted by quality are used further.
53 if (currentPath.size() == 1) {
54 m_twoHitFilterFindlet.apply(currentPath, childHits);
55 } else if (currentPath.size() == 2) {
56 m_threeHitFilterFindlet.apply(currentPath, childHits);
57 } else if (currentPath.size() == 3) {
58 m_fourHitFilterFindlet.apply(currentPath, childHits);
59 } else if (currentPath.size() == 4) {
60 m_fiveHitFilterFindlet.apply(currentPath, childHits);
61 }
62 }

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

◆ exposeParameters()

template<class AHit, class AFindlet>
void exposeParameters ( ModuleParamList * moduleParamList,
const std::string & prefix )
finalvirtual

Expose parameters of the subfilters and the layer to change.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 33 of file PathLengthToggledApplier.icc.h.

35 {
36 m_twoHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "twoHit"));
37 m_threeHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "threeHit"));
38 m_fourHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "fourHit"));
39 m_fiveHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "fiveHit"));
40 }

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

◆ operator()()

template<class AHit>
TrackFindingCDC::Weight operator() ( const Object & object)
virtualinherited

The filter operator for this class.

Reimplemented in LimitedOnHitApplier< AHit, AFilter >.

Definition at line 39 of file OnHitApplier.icc.h.

40 {
41 return NAN;
42 };

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

template<class AHit, class AFindlet>
AFindlet m_fiveHitFilterFindlet
private

Findlet used for currentPath.size() == 4.

Definition at line 48 of file PathLengthToggledApplier.dcl.h.

◆ m_fourHitFilterFindlet

template<class AHit, class AFindlet>
AFindlet m_fourHitFilterFindlet
private

Findlet used for currentPath.size() == 3.

Definition at line 46 of file PathLengthToggledApplier.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_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.

◆ m_threeHitFilterFindlet

template<class AHit, class AFindlet>
AFindlet m_threeHitFilterFindlet
private

Findlet used for currentPath.size() == 2.

Definition at line 44 of file PathLengthToggledApplier.dcl.h.

◆ m_twoHitFilterFindlet

template<class AHit, class AFindlet>
AFindlet m_twoHitFilterFindlet
private

Findlet used for currentPath.size() == 1.

Definition at line 42 of file PathLengthToggledApplier.dcl.h.


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