Belle II Software development
SingleMatchSelector< ACollectorItem, ACollectionItem, AComparer > Class Template Referenceabstract

Selector to remove all relations in the list, which share the same collection item - except one in case the useOnlySingleBestCandidate is set to false (then, only the one with the heightest weight is used). More...

#include <SingleMatchSelector.h>

Inheritance diagram for SingleMatchSelector< ACollectorItem, ACollectionItem, AComparer >:
Findlet< WeightedRelation< ACollectorItem, const ACollectionItem > > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using WeightedRelationItem = WeightedRelation<ACollectorItem, const ACollectionItem>
 Shortcut class name for a weighted relation between a collector item and a collection item.
 
using Super = Findlet<WeightedRelation<ACollectorItem, const ACollectionItem>>
 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

void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the useOnlySingleBestCandidate parameter to the module.
 
void apply (std::vector< WeightedRelationItem > &weightedRelations) override
 Main function of this class doing the relation selection.
 
void setUseOnlySingleBestCandidate (bool useOnlySingleBestCandidate)
 Set the UseOnlySingleBestCandidate parameter (mostly for tests).
 
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

bool m_param_useOnlySingleBestCandidate = true
 Whether to output only those relations, where the relation from collectio to collector items is injective or to output always the best relation for a given collection item.
 
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 ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
class Belle2::TrackFindingCDC::SingleMatchSelector< ACollectorItem, ACollectionItem, AComparer >

Selector to remove all relations in the list, which share the same collection item - except one in case the useOnlySingleBestCandidate is set to false (then, only the one with the heightest weight is used).

This means the function will output a list of weighted relations, where the relations from collection to collector items are injective (but not in the other way round: a collector can have multiple matched collection items, but one collection item only one matched collector item).

Most likely, the full stack is used as follows:

  • match two lists of elements (Collectors and Collections) resulting in a list of weighted relations among those
  • select only some relations using a certain criteria (this is where the difference between Collector and Collections comes into place)
  • add the found relations by absorbing the collection items into the collector items.

Please note that the CollectionItems are therefore const whereas the CollectorItems are not. All the passed WeightedRelations lists must be sorted.

Definition at line 44 of file SingleMatchSelector.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 ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
using Super = Findlet<WeightedRelation<ACollectorItem, const ACollectionItem>>

The parent class.

Definition at line 51 of file SingleMatchSelector.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.

◆ WeightedRelationItem

template<class ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
using WeightedRelationItem = WeightedRelation<ACollectorItem, const ACollectionItem>

Shortcut class name for a weighted relation between a collector item and a collection item.

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

◆ apply()

template<class ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
void apply ( std::vector< WeightedRelationItem > & weightedRelations)
inlineoverride

Main function of this class doing the relation selection.

Definition at line 64 of file SingleMatchSelector.h.

65 {
66 B2ASSERT("The relations need to be sorted for this selector!",
67 std::is_sorted(weightedRelations.begin(), weightedRelations.end()));
68
69 // Build a map from collectionItem -> matched collectionItems with weight
70 std::map<const ACollectionItem*, std::vector<WeightedRelationItem>, AComparer> collectionItemToMatchedMap;
71
72 for (const WeightedRelationItem& relation : weightedRelations) {
73 collectionItemToMatchedMap[relation.getTo()].push_back(relation);
74 }
75
76 // Clear all relations and start filling in only the ones which are valid
77 weightedRelations.clear();
78
79 for (const auto& collectionItemToMatches : collectionItemToMatchedMap) {
80 const auto& matches = collectionItemToMatches.second;
81
82 const auto& bestMatch = std::min_element(matches.begin(), matches.end(), GreaterWeight());
83
84 const bool addBestMatch = matches.size() == 1 or not m_param_useOnlySingleBestCandidate;
85
86 if (addBestMatch) {
87 weightedRelations.push_back(*bestMatch);
88 }
89 }
90
91 std::sort(weightedRelations.begin(), weightedRelations.end());
92 }

◆ 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 ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
void exposeParameters ( ModuleParamList * moduleParamList,
const std::string & prefix )
inlineoverridevirtual

Expose the useOnlySingleBestCandidate parameter to the module.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 54 of file SingleMatchSelector.h.

55 {
56 Super::exposeParameters(moduleParamList, prefix);
57
58 moduleParamList->addParameter(prefixed(prefix, "useOnlySingleBestCandidate"), m_param_useOnlySingleBestCandidate,
59 "Use only the found candidate, if it is the only one. Otherwise, use the best one.",
60 m_param_useOnlySingleBestCandidate);
61 }

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

◆ setUseOnlySingleBestCandidate()

template<class ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
void setUseOnlySingleBestCandidate ( bool useOnlySingleBestCandidate)
inline

Set the UseOnlySingleBestCandidate parameter (mostly for tests).

Definition at line 95 of file SingleMatchSelector.h.

96 {
97 m_param_useOnlySingleBestCandidate = useOnlySingleBestCandidate;
98 }

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

template<class ACollectorItem, class ACollectionItem, class AComparer = std::less<const ACollectionItem*>>
bool m_param_useOnlySingleBestCandidate = true
private

Whether to output only those relations, where the relation from collectio to collector items is injective or to output always the best relation for a given collection item.

Definition at line 105 of file SingleMatchSelector.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: