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

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 = std::tuple< AIOTypes... >
	Types that should be served to apply on invocation.

using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	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 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 = typename ToVectorImpl< T >::Type
	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 = false
	Flag to keep track whether initialization happened before.

bool	m_terminated = false
	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

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

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

The parent class.

Definition at line 51 of file SingleMatchSelector.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

◆ WeightedRelationItem

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 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

void apply ( std::vector< WeightedRelationItem > & weightedRelations )

inlineoverride

Main function of this class doing the relation selection.

Definition at line 64 of file SingleMatchSelector.h.

      {
        B2ASSERT("The relations need to be sorted for this selector!",
                 std::is_sorted(weightedRelations.begin(), weightedRelations.end()));
 
        // Build a map from collectionItem -> matched collectionItems with weight
        std::map<const ACollectionItem*, std::vector<WeightedRelationItem>, AComparer> collectionItemToMatchedMap;
 
        for (const WeightedRelationItem& relation : weightedRelations) {
          collectionItemToMatchedMap[relation.getTo()].push_back(relation);
        }
 
        // Clear all relations and start filling in only the ones which are valid
        weightedRelations.clear();
 
        for (const auto& collectionItemToMatches : collectionItemToMatchedMap) {
          const auto& matches = collectionItemToMatches.second;
 
          const auto& bestMatch = std::min_element(matches.begin(), matches.end(), GreaterWeight());
 
          const bool addBestMatch = matches.size() == 1 or not m_param_useOnlySingleBestCandidate;
 
          if (addBestMatch) {
            weightedRelations.push_back(*bestMatch);
          }
        }
 
        std::sort(weightedRelations.begin(), weightedRelations.end());
      }

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

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

◆ exposeParameters()

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

inlineoverridevirtual

Expose the useOnlySingleBestCandidate parameter to the module.

Reimplemented from Findlet< WeightedRelation< ACollectorItem, const ACollectionItem > >.

Definition at line 54 of file SingleMatchSelector.h.

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

◆ 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 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

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

◆ setUseOnlySingleBestCandidate()

void setUseOnlySingleBestCandidate ( bool useOnlySingleBestCandidate )

inline

Set the UseOnlySingleBestCandidate parameter (mostly for tests).

Definition at line 95 of file SingleMatchSelector.h.

      {
        m_param_useOnlySingleBestCandidate = useOnlySingleBestCandidate;
      }

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

◆ m_initialized

bool m_initialized = false

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

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 52 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated = false

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/SingleMatchSelector.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

◆ WeightedRelationItem

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ setUseOnlySingleBestCandidate()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_param_useOnlySingleBestCandidate

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated