MatcherInterface< ACollectorItem, ACollectionItem > Class Template Reference

Base class for a findlet, which outputs a list of weighted relations between elements in a list of CollectorItems and a list of CollectionItems. More...

#include <MatcherInterface.h>

Inheritance diagram for MatcherInterface< ACollectorItem, ACollectionItem >:

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	apply (std::vector< ACollectorItem > &collectorItems, const std::vector< ACollectionItem > &collectionItems, std::vector< WeightedRelationItem > &weightedRelations) override
	Main function: create weighted relations between collectors and collection items using the implemented functionality overridden in a derived class.
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.
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 void	match (ACollectorItem &collectorItem, const std::vector< ACollectionItem > &collectionItems, std::vector< WeightedRelationItem > &relationsForCollector)
	Override this function to implement your own matching algorithm between one collector and many collection items.
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
	Type of the base class.

Private Attributes
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::MatcherInterface< ACollectorItem, ACollectionItem >

Base class for a findlet, which outputs a list of weighted relations between elements in a list of CollectorItems and a list of CollectionItems.

Which item pairs are related and with which weight (if at all), can be defined by overriding one of the match()-functions in a derived class.

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.

Most of the provided selectors are built to match many collection items to one collector item.

Definition at line 40 of file MatcherInterface.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

using Super

privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.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>

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.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

apply()

template<class ACollectorItem, class ACollectionItem>

void apply ( std::vector< ACollectorItem > & collectorItems, const std::vector< ACollectionItem > & collectionItems, std::vector< WeightedRelationItem > & weightedRelations )

inlineoverride

Main function: create weighted relations between collectors and collection items using the implemented functionality overridden in a derived class.

Definition at line 52 of file MatcherInterface.h.

      {
        for (ACollectorItem& collectorItem : collectorItems) {
          match(collectorItem, collectionItems, weightedRelations);
        }
 
        std::sort(weightedRelations.begin(), weightedRelations.end());
      }

beginEvent()

void beginEvent ( )

overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

beginRun()

void beginRun ( )

overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

endRun()

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

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

moduleParamList	Module parameter list to add the new parameters to
prefix	Prefix (or sometimes postfix) to be added to all nely added parameters.

Definition at line 47 of file CompositeProcessingSignalListener.h.

      {};

getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

overrideinherited

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

Definition at line 30 of file CompositeProcessingSignalListener.cc.

{
  Super::initialize();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->initialize();
  }
}

match() [1/2]

template<class ACollectorItem, class ACollectionItem>

virtual Weight match ( ACollectorItem & collectorItem, const ACollectionItem & collectionItem )

inlineprotectedvirtual

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.

      {
        return NAN;
      }

match() [2/2]

template<class ACollectorItem, class ACollectionItem>

virtual void match ( ACollectorItem & collectorItem, const std::vector< ACollectionItem > & collectionItems, std::vector< WeightedRelationItem > & relationsForCollector )

inlineprotectedvirtual

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

A reason to override this instead of the other match function could be, if you want to apply some sort of caching for each collector item.

Reimplemented in SharingHitsMatcher< ACollectorItem, ACollectionItem >, and SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >.

Definition at line 68 of file MatcherInterface.h.

      {
        for (const ACollectionItem& collectionItem : collectionItems) {
          Weight weight = match(collectorItem, collectionItem);
          relationsForCollector.emplace_back(&collectorItem, weight, &collectionItem);
        }
      };

terminate()

void terminate ( )

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

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_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:

• tracking/trackFindingCDC/collectors/matchers/include/MatcherInterface.h