Selector to remove all relations in the list, which share the same collection item - except the one which the highest weight - and vice versa. More...

#include <BestMatchSelector.h>

Inheritance diagram for BestMatchSelector< 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	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	apply (std::vector< WeightedRelationItem > &weightedRelations) override
	Main function of this class doing the relation selection.

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.

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.

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
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::BestMatchSelector< ACollectorItem, ACollectionItem >

Selector to remove all relations in the list, which share the same collection item - except the one which the highest weight - and vice versa.

This means the function will output a list of weighted relations, where the relations from collection to collector items are bijective.

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 43 of file BestMatchSelector.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>

using Super = Findlet<WeightedRelation<ACollectorItem, const ACollectionItem>>

The parent class.

Definition at line 50 of file BestMatchSelector.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>

using WeightedRelationItem = WeightedRelation<ACollectorItem, const ACollectionItem>

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

Definition at line 47 of file BestMatchSelector.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< WeightedRelationItem > & weightedRelations )

inlineoverride

Main function of this class doing the relation selection.

Definition at line 53 of file BestMatchSelector.h.

      {
        std::vector<WeightedRelationItem> selectedWeightedRelations;
 
        // Do until there are no more relations left:
        // (1) find the relation with the maximum weight
        // (2) store this and delete all relations, which share a "To" or a "From" item with this maximal relation
        // (3) repeat
        while (not weightedRelations.empty()) {
          // std:min_element is strange... this actually returns the element with the largest weight
          const auto maxElement = *(std::min_element(weightedRelations.begin(), weightedRelations.end(), GreaterWeight()));
          selectedWeightedRelations.push_back(maxElement);
 
          const auto itemSharesFromOrTo = [&maxElement](const WeightedRelationItem & item) {
            return item.getFrom() == maxElement.getFrom() or item.getTo() == maxElement.getTo();
          };
 
          erase_remove_if(weightedRelations, itemSharesFromOrTo);
        }
 
        std::sort(selectedWeightedRelations.begin(), selectedWeightedRelations.end());
        weightedRelations.swap(selectedWeightedRelations);
      }

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

49 {};

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

      {
        return "(no description)";
      }

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

      {
        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();
  }
}

◆ 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/selectors/include/BestMatchSelector.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes [1/2]

◆ IOTypes [2/2]

◆ IOVectors [1/2]

◆ IOVectors [2/2]

◆ Super

◆ ToVector [1/2]

◆ ToVector [2/2]

◆ WeightedRelationItem

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated