SegmentTrackCombiner Class Reference

Findlet for the combination of tracks and segments. More...

#include <SegmentTrackCombiner.h>

Inheritance diagram for SegmentTrackCombiner:

Public Types
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
	SegmentTrackCombiner ()
	Constructor setting up the filter parameters.
std::string	getDescription () final
	Short description of the findlet.
void	beginEvent () final
	Signal the beginning of a new event.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	apply (std::vector< CDCSegment2D > &segments, std::vector< CDCTrack > &tracks) override
	Try to combine the segments and the tracks.
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	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 Types
using	Super = Findlet< CDCSegment2D &, CDCTrack & >
	Type of the base class.

Private Attributes
SharingHitsMatcher< CDCTrack, CDCSegment2D >	m_sharedHitsMatcher
	Matcher for creating relations between tracks and segments based on the number of shared hits.
CutSelector< CDCTrack, CDCSegment2D >	m_selectPairsWithSharedHits
	Select only those pairs, which share at least a certain amount of hits.
FilterSelector< CDCTrack, CDCSegment2D, ChooseableFilter< SegmentTrackFilterFactory > >	m_chooseableSegmentTrackSelector
	Reference to the chooser to be used for matching segments and tracks in the first step.
SingleMatchSelector< CDCTrack, CDCSegment2D >	m_singleMatchSelector
	Select only the best matching segment-track relations and remove the hits from the other ones.
SegmentTrackAdderWithNormalization	m_segmentTrackAdderWithNormalization
	Add the matched segments to tracks.
TrackRejecter	m_trackRejecter
	Findlet to filter out fake tracks.
TrackNormalizer	m_trackNormalizer
	Findlet for normalizing the tracks.
std::vector< WeightedRelation< CDCTrack, const CDCSegment2D > >	m_relations
	Object pools.
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

Findlet for the combination of tracks and segments.

This module uses configurable filters to create matches between segments (from the local finder) and tracks (from the global finder). It also has capabilities to filter the remaining tracks for fakes and the remaining segments for new tracks/background.

Use this module at the end of the path, after you have run the local and the global track finder.

It uses several (filtering) steps, to do its job, namely:

1. Creation of a fast segment and track lookup.
2. First matching of segment and tracks that share one or more hits.
3. Filtering of fake tracks in the made combinations.
4. Cleanup of the lookup cache.

Definition at line 58 of file SegmentTrackCombiner.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<CDCSegment2D&, CDCTrack&>

private

Type of the base class.

Definition at line 62 of file SegmentTrackCombiner.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

SegmentTrackCombiner()

SegmentTrackCombiner

(

)

Constructor setting up the filter parameters.

Definition at line 21 of file SegmentTrackCombiner.cc.

{
  addProcessingSignalListener(&m_trackNormalizer);
  addProcessingSignalListener(&m_sharedHitsMatcher);
  addProcessingSignalListener(&m_selectPairsWithSharedHits);
  addProcessingSignalListener(&m_chooseableSegmentTrackSelector);
  addProcessingSignalListener(&m_singleMatchSelector);
  addProcessingSignalListener(&m_segmentTrackAdderWithNormalization);
  addProcessingSignalListener(&m_trackRejecter);
 
  ModuleParamList moduleParamList;
  const std::string prefix =  "";
  this->exposeParameters(&moduleParamList, prefix);
  moduleParamList.getParameter<double>("sharedHitsCutValue").setDefaultValue(1.0);
  moduleParamList.getParameter<bool>("useOnlySingleBestCandidate").setDefaultValue(false);
  moduleParamList.getParameter<bool>("hitSelectorUseOnlySingleBestCandidate").setDefaultValue(false);
}

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< CDCSegment2D > &  segments, std::vector< CDCTrack > &  tracks  )

override

Try to combine the segments and the tracks.

Definition at line 64 of file SegmentTrackCombiner.cc.

{
  m_trackNormalizer.apply(tracks);
 
  // Add a precut to add segments which are fully taken immediately at this stage
  for (const CDCSegment2D& segment : segments) {
    if (segment.isFullyTaken()) {
      segment.getAutomatonCell().setTakenFlag();
    } else {
      segment.getAutomatonCell().unsetTakenFlag();
    }
  }
 
  // After that, relations contains all pairs of segments and tracks, with the number of shared hits as weight
  m_sharedHitsMatcher.apply(tracks, segments, m_relations);
 
  // Require a certain (definable) amount of shared hits between segments and tracks
  m_selectPairsWithSharedHits.apply(m_relations);
 
  // Apply a (mva) filter to all combinations
  m_chooseableSegmentTrackSelector.apply(m_relations);
 
  // Search for the best combinations
  m_singleMatchSelector.apply(m_relations);
 
  // Add those combinations and remove all hits, that are part of other tracks (non-selected combinations)
  m_segmentTrackAdderWithNormalization.apply(m_relations, tracks, segments);
 
  // Reject tracks according to a (mva) filter
  m_trackRejecter.apply(tracks);
}

beginEvent()

void beginEvent ( )

finalvirtual

Signal the beginning of a new event.

Reimplemented from ProcessingSignalListener.

Definition at line 44 of file SegmentTrackCombiner.cc.

{
  m_relations.clear();
 
  Super::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  )

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet< CDCSegment2D &, CDCTrack & >.

Definition at line 51 of file SegmentTrackCombiner.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  m_sharedHitsMatcher.exposeParameters(moduleParamList, prefix);
  m_selectPairsWithSharedHits.exposeParameters(moduleParamList, prefixed(prefix, "sharedHits"));
  m_chooseableSegmentTrackSelector.exposeParameters(moduleParamList, prefixed(prefix, "segmentTrack"));
  m_singleMatchSelector.exposeParameters(moduleParamList, prefix);
  m_segmentTrackAdderWithNormalization.exposeParameters(moduleParamList, prefix);
  m_trackRejecter.exposeParameters(moduleParamList, prefixed(prefix, "track"));
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCSegment2D &, CDCTrack & >.

Definition at line 39 of file SegmentTrackCombiner.cc.

{
  return "Findlet for the combination of tracks and segments.";
}

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

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_chooseableSegmentTrackSelector

FilterSelector<CDCTrack, CDCSegment2D, ChooseableFilter<SegmentTrackFilterFactory> > m_chooseableSegmentTrackSelector

private

Reference to the chooser to be used for matching segments and tracks in the first step.

Definition at line 90 of file SegmentTrackCombiner.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_relations

std::vector<WeightedRelation<CDCTrack, const CDCSegment2D> > m_relations

private

Object pools.

Definition at line 105 of file SegmentTrackCombiner.h.

m_segmentTrackAdderWithNormalization

SegmentTrackAdderWithNormalization m_segmentTrackAdderWithNormalization

private

Add the matched segments to tracks.

Definition at line 96 of file SegmentTrackCombiner.h.

m_selectPairsWithSharedHits

CutSelector<CDCTrack, CDCSegment2D> m_selectPairsWithSharedHits

private

Select only those pairs, which share at least a certain amount of hits.

Definition at line 87 of file SegmentTrackCombiner.h.

m_sharedHitsMatcher

SharingHitsMatcher<CDCTrack, CDCSegment2D> m_sharedHitsMatcher

private

Matcher for creating relations between tracks and segments based on the number of shared hits.

Definition at line 84 of file SegmentTrackCombiner.h.

m_singleMatchSelector

SingleMatchSelector<CDCTrack, CDCSegment2D> m_singleMatchSelector

private

Select only the best matching segment-track relations and remove the hits from the other ones.

Definition at line 93 of file SegmentTrackCombiner.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.

m_trackNormalizer

TrackNormalizer m_trackNormalizer

private

Findlet for normalizing the tracks.

Definition at line 102 of file SegmentTrackCombiner.h.

m_trackRejecter

TrackRejecter m_trackRejecter

private

Findlet to filter out fake tracks.

Definition at line 99 of file SegmentTrackCombiner.h.

---

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

• tracking/trackFindingCDC/findlets/combined/include/SegmentTrackCombiner.h
• tracking/trackFindingCDC/findlets/combined/src/SegmentTrackCombiner.cc