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

A generic matcher algorithm which outputs all combinations of elements with the number of shared hits as a weight. More...

#include <SharingHitsMatcher.h>

Inheritance diagram for SharingHitsMatcher< ACollectorItem, ACollectionItem >:
MatcherInterface< ACollectorItem, ACollectionItem > Findlet< ACollectorItem, const ACollectionItem, 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 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

void beginEvent () override
 Clear the hit lookup in every event.
 
void apply (std::vector< ACollectorItem > &collectorItems, const std::vector< ACollectionItem > &collectionItems, std::vector< typename Super::WeightedRelationItem > &weightedRelations) override
 Call the apply function of the super class - but before fill the hit lookup.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
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 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.
 
virtual void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
 Expose the set of parameters of the filter to the module parameter list.
 

Protected Types

using ToVector
 Short hand for ToRangeImpl.
 

Protected Member Functions

virtual Weight match (ACollectorItem &collectorItem, const ACollectionItem &collectionItem)
 Override this function to implement your own matching algorithm between one collector and one collection items.
 
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 = MatcherInterface<ACollectorItem, ACollectionItem>
 The parent class.
 

Private Member Functions

void match (ACollectorItem &collectorItem, const std::vector< ACollectionItem > &collectionItems, std::vector< typename Super::WeightedRelationItem > &relationsForCollector) override
 Output the number of shared hits - the rest of the logic (relation creation etc.) is handled by the parent class.
 

Private Attributes

std::multimap< const CDCWireHit *, const ACollectionItem * > m_hitLookup
 association of CDCWireHits with a generic 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 Belle2::TrackFindingCDC::SharingHitsMatcher< ACollectorItem, ACollectionItem >

A generic matcher algorithm which outputs all combinations of elements with the number of shared hits as a weight.

It does only use those collection items, which do not have a taken flag.

Definition at line 32 of file SharingHitsMatcher.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 ACollectorItem, class ACollectionItem>
using Super = MatcherInterface<ACollectorItem, ACollectionItem>
private

The parent class.

Definition at line 35 of file SharingHitsMatcher.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

◆ WeightedRelationItem

template<class ACollectorItem, class ACollectionItem>
using WeightedRelationItem = WeightedRelation<ACollectorItem, const ACollectionItem>
inherited

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

Definition at line 46 of file MatcherInterface.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>
void apply ( std::vector< ACollectorItem > & collectorItems,
const std::vector< ACollectionItem > & collectionItems,
std::vector< typename Super::WeightedRelationItem > & weightedRelations )
inlineoverride

Call the apply function of the super class - but before fill the hit lookup.

Definition at line 45 of file SharingHitsMatcher.h.

47 {
48
49 for (const ACollectionItem& collectionItem : collectionItems) {
50 const AutomatonCell& automatonCell = collectionItem.getAutomatonCell();
51
52 if (automatonCell.hasTakenFlag() or collectionItem.empty()) {
53 continue;
54 }
55
56 for (const auto& hit : collectionItem) {
57 const CDCWireHit& wireHit = hit.getWireHit();
58
59 // cppcheck-suppress danglingLifetime
60 m_hitLookup.insert(std::make_pair(&wireHit, &collectionItem));
61 }
62 }
63
64 Super::apply(collectorItems, collectionItems, weightedRelations);
65 }

◆ beginEvent()

template<class ACollectorItem, class ACollectionItem>
void beginEvent ( )
inlineoverridevirtual

Clear the hit lookup in every event.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 39 of file SharingHitsMatcher.h.

40 {
41 m_hitLookup.clear();
42 }

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

virtual void exposeParameters ( ModuleParamList * moduleParamList,
const std::string & prefix )
inlinevirtualinherited

Expose the set of parameters of the filter to the module parameter list.

Parameters
moduleParamListModule parameter list to add the new parameters to
prefixPrefix (or sometimes postfix) to be added to all nely added parameters.

Definition at line 47 of file CompositeProcessingSignalListener.h.

49 {};

◆ getDescription()

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.

◆ match() [1/2]

template<class ACollectorItem, class ACollectionItem>
virtual Weight match ( ACollectorItem & collectorItem,
const ACollectionItem & collectionItem )
inlineprotectedvirtualinherited

Override this function to implement your own matching algorithm between one collector and one collection items.

If you override this function, you just have to return a weight - the rest of the logic is handled by the MatcherInterface class.

Definition at line 82 of file MatcherInterface.h.

84 {
85 return NAN;
86 }

◆ match() [2/2]

template<class ACollectorItem, class ACollectionItem>
void match ( ACollectorItem & collectorItem,
const std::vector< ACollectionItem > & collectionItems,
std::vector< typename Super::WeightedRelationItem > & relationsForCollector )
inlineoverrideprivatevirtual

Output the number of shared hits - the rest of the logic (relation creation etc.) is handled by the parent class.

Reimplemented from MatcherInterface< ACollectorItem, ACollectionItem >.

Definition at line 72 of file SharingHitsMatcher.h.

74 {
75 std::map<const ACollectionItem*, unsigned int> numberOfIntersectionsMap;
76
77 // Set the number of intersections to 0
78 for (const ACollectionItem& collectionItem : collectionItems) {
79 numberOfIntersectionsMap[&collectionItem] = 0;
80 }
81
82 // For each hit in the collector item: Get all collection items for this hit and increase the number of intersections
83 for (const auto& hit : collectorItem) {
84 const CDCWireHit& wireHit = hit.getWireHit();
85
86 // Get all matched collection items
87 const auto& relatedCollectionItems = m_hitLookup.equal_range(&wireHit);
88
89 for (auto& relatedCollectionItemIterator : asRange(relatedCollectionItems)) {
90 const ACollectionItem* collectionItem = relatedCollectionItemIterator.second;
91 numberOfIntersectionsMap[collectionItem] += 1;
92 }
93 }
94
95 // Add new relations to the list
96 for (const auto& collectionWithIntersections : numberOfIntersectionsMap) {
97 const ACollectionItem* collectionItem = collectionWithIntersections.first;
98 unsigned int numberOfIntersections = collectionWithIntersections.second;
99
100 relationsForCollector.emplace_back(&collectorItem, numberOfIntersections, collectionItem);
101 }
102 }

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

template<class ACollectorItem, class ACollectionItem>
std::multimap<const CDCWireHit*, const ACollectionItem*> m_hitLookup
private

association of CDCWireHits with a generic collection item

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


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