TrackFinder Class Reference

Complete findlet implementing track finding with the cellular automaton in two stages. More...

#include <TrackFinder.h>

Inheritance diagram for TrackFinder:

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
	TrackFinder ()
	Constructor registering the subordinary findlets to the processing signal distribution machinery.
std::string	getDescription () override
	Short description of the findlet.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	apply () final
	Execute the 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 Types
using	Super = Findlet<>
	Type of the base class.

Private Attributes
bool	m_param_withCA = false
	Parameter: Activate the combination of the local segment linking.
WireHitPreparer	m_wireHitPreparer
	Preparation findlet creating the wire hits from the packed CDCHits.
ClusterPreparer	m_clusterPreparer
	Preparation findlet creating the clusters wire hits forming locally connected groups.
SegmentFinderFacetAutomaton	m_segmentFinderFacetAutomaton
	First stage cellular automaton segment finder.
AxialTrackFinderLegendre	m_axialTrackFinderLegendre
	Axial track finder.
TrackQualityAsserter	m_trackQualityAsserter
	Improve the quality of the axial tracks.
StereoHitFinder	m_stereoHitFinder
	Associate the stereo hits that best match to the axial tracks.
SegmentTrackCombiner	m_segmentTrackCombiner
	Join the matching segments into the tracks.
TrackFinderSegmentPairAutomaton	m_trackFinderSegmentPairAutomaton
	Second stage cellular automaton track finder from segments.
TrackCombiner	m_trackCombiner
	Combine the tracks from the global search with the tracks from the local search.
TrackQualityAsserter	m_finalTrackQualityAsserter
	Final track quality assertions.
TrackCreatorSingleSegments	m_trackCreatorSingleSegments
	Add tracks from the first super layer that are contained with in the first super layer.
TrackExporter	m_trackExporter
	Exports the generated CDCTracks as RecoTracks.
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

Complete findlet implementing track finding with the cellular automaton in two stages.

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

private

Type of the base class.

Definition at line 39 of file TrackFinder.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

TrackFinder()

TrackFinder

(

)

Constructor registering the subordinary findlets to the processing signal distribution machinery.

Definition at line 18 of file TrackFinder.cc.

{
  this->addProcessingSignalListener(&m_wireHitPreparer);
  this->addProcessingSignalListener(&m_clusterPreparer);
  this->addProcessingSignalListener(&m_segmentFinderFacetAutomaton);
 
  this->addProcessingSignalListener(&m_axialTrackFinderLegendre);
  this->addProcessingSignalListener(&m_trackQualityAsserter);
 
  this->addProcessingSignalListener(&m_stereoHitFinder);
  this->addProcessingSignalListener(&m_segmentTrackCombiner);
 
  this->addProcessingSignalListener(&m_trackFinderSegmentPairAutomaton);
  this->addProcessingSignalListener(&m_trackCombiner);
 
  this->addProcessingSignalListener(&m_finalTrackQualityAsserter);
  this->addProcessingSignalListener(&m_trackCreatorSingleSegments);
  this->addProcessingSignalListener(&m_trackExporter);
 
  const std::string prefix = "";
  // Setup m_wireHitPreparer
  {
    ModuleParamList moduleParamList;
    m_wireHitPreparer.exposeParameters(&moduleParamList, prefix);
 
    moduleParamList.getParameter<std::string>("flightTimeEstimation").setDefaultValue("outwards");
  }
 
  // Setup m_trackQualityAsserter
  {
    ModuleParamList moduleParamList;
    m_trackQualityAsserter.exposeParameters(&moduleParamList, prefix);
 
    std::vector<std::string> corrections({"B2B"});
    moduleParamList.getParameter<std::vector<std::string>>("corrections")
                                                        .setDefaultValue(corrections);
  }
 
  // Setup m_finalTrackQualityAsserter
  {
    ModuleParamList moduleParamList;
    m_finalTrackQualityAsserter.exposeParameters(&moduleParamList, prefix);
 
    std::vector<std::string> corrections({"LayerBreak", "OneSuperlayer", "Small"});
    moduleParamList.getParameter<std::vector<std::string>>("corrections")
                                                        .setDefaultValue(corrections);
  }
}

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

final

Execute the findlet.

Definition at line 85 of file TrackFinder.cc.

{
  // Reserve some space for the created objects.
  std::vector<CDCWireHit> m_wireHits;
  std::vector<CDCWireHitCluster> m_clusters;
  std::vector<CDCWireHitCluster> m_superClusters;
  std::vector<CDCSegment2D> m_segments;
  std::vector<CDCTrack> m_axialTracks;
  std::vector<CDCTrack> m_tracks;
  m_wireHits.reserve(2000);
  m_clusters.reserve(200);
  m_superClusters.reserve(100);
  m_segments.reserve(200);
  m_axialTracks.reserve(30);
  m_tracks.reserve(30);
 
  m_wireHitPreparer.apply(m_wireHits);
  m_clusterPreparer.apply(m_wireHits, m_clusters, m_superClusters);
  m_segmentFinderFacetAutomaton.apply(m_clusters, m_segments);
 
  m_axialTrackFinderLegendre.apply(m_wireHits, m_axialTracks);
  m_trackQualityAsserter.apply(m_axialTracks);
 
  m_stereoHitFinder.apply(m_wireHits, m_axialTracks);
  m_segmentTrackCombiner.apply(m_segments, m_axialTracks);
 
  if (m_param_withCA) {
    m_trackFinderSegmentPairAutomaton.apply(m_segments, m_tracks);
    m_trackCombiner.apply(m_axialTracks, m_tracks, m_tracks);
  } else {
    m_tracks.swap(m_axialTracks);
  }
 
  m_finalTrackQualityAsserter.apply(m_tracks);
 
  if (m_param_withCA) {
    m_trackCreatorSingleSegments.apply(m_segments, m_tracks);
  }
 
  m_trackExporter.apply(m_tracks);
}

beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, 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 >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

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  )

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet<>.

Definition at line 73 of file TrackFinder.cc.

{
  // Expose a selection of the parameters
  m_wireHitPreparer.exposeParameters(moduleParamList, prefix);
  m_trackExporter.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter("withCA",
                                m_param_withCA,
                                "Also run the segment linking track finder and combine results.",
                                m_param_withCA);
}

getDescription()

std::string getDescription ( )

overridevirtual

Short description of the findlet.

Reimplemented from Findlet<>.

Definition at line 67 of file TrackFinder.cc.

{
  return "Combined track finder using the global legendre finder as well as the cellular automaton "
         "track finder.";
}

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_axialTrackFinderLegendre

AxialTrackFinderLegendre m_axialTrackFinderLegendre

private

Axial track finder.

Definition at line 70 of file TrackFinder.h.

m_clusterPreparer

ClusterPreparer m_clusterPreparer

private

Preparation findlet creating the clusters wire hits forming locally connected groups.

Definition at line 64 of file TrackFinder.h.

m_finalTrackQualityAsserter

TrackQualityAsserter m_finalTrackQualityAsserter

private

Final track quality assertions.

Definition at line 88 of file TrackFinder.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_param_withCA

bool m_param_withCA = false

private

Parameter: Activate the combination of the local segment linking.

Definition at line 56 of file TrackFinder.h.

m_segmentFinderFacetAutomaton

SegmentFinderFacetAutomaton m_segmentFinderFacetAutomaton

private

First stage cellular automaton segment finder.

Definition at line 67 of file TrackFinder.h.

m_segmentTrackCombiner

SegmentTrackCombiner m_segmentTrackCombiner

private

Join the matching segments into the tracks.

Definition at line 79 of file TrackFinder.h.

m_stereoHitFinder

StereoHitFinder m_stereoHitFinder

private

Associate the stereo hits that best match to the axial tracks.

Definition at line 76 of file TrackFinder.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_trackCombiner

TrackCombiner m_trackCombiner

private

Combine the tracks from the global search with the tracks from the local search.

Definition at line 85 of file TrackFinder.h.

m_trackCreatorSingleSegments

TrackCreatorSingleSegments m_trackCreatorSingleSegments

private

Add tracks from the first super layer that are contained with in the first super layer.

Definition at line 91 of file TrackFinder.h.

m_trackExporter

TrackExporter m_trackExporter

private

Exports the generated CDCTracks as RecoTracks.

Definition at line 94 of file TrackFinder.h.

m_trackFinderSegmentPairAutomaton

TrackFinderSegmentPairAutomaton m_trackFinderSegmentPairAutomaton

private

Second stage cellular automaton track finder from segments.

Definition at line 82 of file TrackFinder.h.

m_trackQualityAsserter

TrackQualityAsserter m_trackQualityAsserter

private

Improve the quality of the axial tracks.

Definition at line 73 of file TrackFinder.h.

m_wireHitPreparer

WireHitPreparer m_wireHitPreparer

private

Preparation findlet creating the wire hits from the packed CDCHits.

Definition at line 61 of file TrackFinder.h.

---

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

• tracking/trackFindingCDC/findlets/complete/include/TrackFinder.h
• tracking/trackFindingCDC/findlets/complete/src/TrackFinder.cc