Belle II Software development
WeightedRelationCreator< AObject, ARelationFilter > Class Template Referenceabstract

Findlet that combines geometrical constrained pairs of objects to relations and selects them by the filter given as template parameter. More...

#include <WeightedRelationCreator.h>

Inheritance diagram for WeightedRelationCreator< AObject, ARelationFilter >:
Findlet< AObject *const, WeightedRelation< AObject > > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

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

 WeightedRelationCreator ()
 Constructor registering the subordinary findlets to the processing signal distribution machinery.
 
std::string getDescription () final
 Short description of the findlet.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose the parameters to a module.
 
void apply (const std::vector< AObject * > &inputObjects, std::vector< WeightedRelation< AObject > > &weightedRelations) final
 Main function.
 
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.
 

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 = Findlet<AObject, WeightedRelation<AObject> >
 Type of the base class.
 

Private Attributes

ARelationFilter m_relationFilter
 Relation filter used to select relations.
 
int m_param_onlyBest = 0
 Parameter : Maximal number of the best relations from each item to keep.
 
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 AObject, class ARelationFilter>
class Belle2::TrackFindingCDC::WeightedRelationCreator< AObject, ARelationFilter >

Findlet that combines geometrical constrained pairs of objects to relations and selects them by the filter given as template parameter.

Template Parameters
AItemObject type on which relation should be created.
ARelationFilterSelection criterion to find the accepted relations.

In addition a parameter is exposed to only keep a fixed number of highest weighted relations from each segment.

Definition at line 48 of file WeightedRelationCreator.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.

◆ Super

template<class AObject, class ARelationFilter>
using Super = Findlet<AObject, WeightedRelation<AObject> >
private

Type of the base class.

Definition at line 52 of file WeightedRelationCreator.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ WeightedRelationCreator()

template<class AObject, class ARelationFilter>
WeightedRelationCreator ( )
inline

Constructor registering the subordinary findlets to the processing signal distribution machinery.

Definition at line 56 of file WeightedRelationCreator.h.

57 {
58 this->addProcessingSignalListener(&m_relationFilter);
59 }

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 AObject, class ARelationFilter>
void apply ( const std::vector< AObject * > & inputObjects,
std::vector< WeightedRelation< AObject > > & weightedRelations )
inlinefinal

Main function.

Definition at line 79 of file WeightedRelationCreator.h.

80 {
81
82 B2ASSERT("Expected the objects on which relations are constructed to be sorted",
83 std::is_sorted(inputObjects.begin(), inputObjects.end(), LessOf<Deref>()));
84
85 RelationFilterUtil::appendUsing(m_relationFilter, inputObjects, weightedRelations);
86
87 if (m_param_onlyBest > 0)
88 {
89 const int nMaxRepetitions = m_param_onlyBest;
90 int nCurrentRepetitions = 1;
91 auto sameFrom =
92 [&nMaxRepetitions,
93 &nCurrentRepetitions](const WeightedRelation<AObject>& relation,
94 const WeightedRelation<AObject>& otherRelation) -> bool {
95 if (relation.getFrom() == otherRelation.getFrom())
96 {
97 ++nCurrentRepetitions;
98 return nCurrentRepetitions > nMaxRepetitions;
99 } else {
100 // cppcheck-suppress unreadVariable
101 nCurrentRepetitions = 1;
102 return false;
103 }
104 };
105
106 auto itLast = std::unique(weightedRelations.begin(), weightedRelations.end(), sameFrom);
107 weightedRelations.erase(itLast, weightedRelations.end());
108 }
109 }

◆ 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 AObject, class ARelationFilter>
void exposeParameters ( ModuleParamList * moduleParamList,
const std::string & prefix )
inlinefinalvirtual

Expose the parameters to a module.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 69 of file WeightedRelationCreator.h.

69 {
70 m_relationFilter.exposeParameters(moduleParamList, prefix);
71 moduleParamList->addParameter(prefixed(prefix, "onlyBest"),
72 m_param_onlyBest,
73 "Maximal number of the best relation to keep from each " +
74 getClassMnemomicParameterDescription((AObject*)nullptr),
75 m_param_onlyBest);
76 }
std::string getClassMnemomicParameterDescription(const RecoTrack *dispatchTag)
Returns a short description for class RecoTrack to be used in descriptions of parameters.

◆ getDescription()

template<class AObject, class ARelationFilter>
std::string getDescription ( )
inlinefinalvirtual

Short description of the findlet.

Reimplemented from Findlet< AObject *const, WeightedRelation< AObject > >.

Definition at line 62 of file WeightedRelationCreator.h.

62 {
63 return "Constructs geometrically constrained relations between " +
64 getClassMnemomicParameterDescription((AObject*)nullptr) +
65 " filter by some acceptance criterion.";
66 }

◆ 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_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_param_onlyBest

template<class AObject, class ARelationFilter>
int m_param_onlyBest = 0
private

Parameter : Maximal number of the best relations from each item to keep.

Definition at line 116 of file WeightedRelationCreator.h.

◆ m_relationFilter

template<class AObject, class ARelationFilter>
ARelationFilter m_relationFilter
private

Relation filter used to select relations.

Definition at line 113 of file WeightedRelationCreator.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 file: