SharingHitsMatcher< ACollectorItem, ACollectionItem > Class Template Reference

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

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 = 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	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.
virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Forward prefixed parameters of this findlet to the module parameter list.
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.

Protected Types
using	ToVector = typename ToVectorImpl< T >::Type
	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 = 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 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 = 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 = MatcherInterface<ACollectorItem, ACollectionItem>

private

The parent class.

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

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

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

apply()

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.

      {
 
        for (const ACollectionItem& collectionItem : collectionItems) {
          const AutomatonCell& automatonCell = collectionItem.getAutomatonCell();
 
          if (automatonCell.hasTakenFlag() or collectionItem.empty()) {
            continue;
          }
 
          for (const auto& hit : collectionItem) {
            const CDCWireHit& wireHit = hit.getWireHit();
 
            // cppcheck-suppress danglingLifetime
            m_hitLookup.insert(std::make_pair(&wireHit, &collectionItem));
          }
        }
 
        Super::apply(collectorItems, collectionItems, weightedRelations);
      }

beginEvent()

void beginEvent ( )

inlineoverridevirtual

Clear the hit lookup in every event.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file SharingHitsMatcher.h.

      {
        m_hitLookup.clear();
      }

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

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

inlinevirtualinherited

Forward prefixed parameters of this findlet to the module parameter list.

Definition at line 69 of file Findlet.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 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.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

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

match() [1/2]

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.

      {
        return NAN;
      }

match() [2/2]

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.

      {
        std::map<const ACollectionItem*, unsigned int> numberOfIntersectionsMap;
 
        // Set the number of intersections to 0
        for (const ACollectionItem& collectionItem : collectionItems) {
          numberOfIntersectionsMap[&collectionItem] = 0;
        }
 
        // For each hit in the collector item: Get all collection items for this hit and increase the number of intersections
        for (const auto& hit : collectorItem) {
          const CDCWireHit& wireHit = hit.getWireHit();
 
          // Get all matched collection items
          const auto& relatedCollectionItems = m_hitLookup.equal_range(&wireHit);
 
          for (auto& relatedCollectionItemIterator : asRange(relatedCollectionItems)) {
            const ACollectionItem* collectionItem = relatedCollectionItemIterator.second;
            numberOfIntersectionsMap[collectionItem] += 1;
          }
        }
 
        // Add new relations to the list
        for (const auto& collectionWithIntersections : numberOfIntersectionsMap) {
          const ACollectionItem* collectionItem = collectionWithIntersections.first;
          unsigned int numberOfIntersections = collectionWithIntersections.second;
 
          relationsForCollector.emplace_back(&collectorItem, numberOfIntersections, collectionItem);
        }
      }

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_hitLookup

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 = 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_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/matchers/include/SharingHitsMatcher.h