Links tracks based on a filter criterion. More...

#include <TrackLinker.h>

Inheritance diagram for TrackLinker:

Public Types
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
	TrackLinker ()
	Constructor adding the filter as a subordinary processing signal listener.

std::string	getDescription () final
	Short description of the findlet.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.

void	apply (const std::vector< TrackingUtilities::CDCTrack > &inputTracks, std::vector< TrackingUtilities::CDCTrack > &outputTracks) final
	Main algorithm.

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
	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 Types
using	Super = TrackingUtilities::Findlet<const TrackingUtilities::CDCTrack, TrackingUtilities::CDCTrack>
	Type of the base class.

Private Attributes
TrackingUtilities::WeightedRelationCreator< const TrackingUtilities::CDCTrack, TrackFindingCDC::ChooseableTrackRelationFilter >	m_trackRelationCreator
	Creator of the track relations for linking.

TrackingUtilities::MultipassCellularPathFinder< const TrackingUtilities::CDCTrack >	m_cellularPathFinder
	Instance of the cellular automaton path finder.

std::vector< TrackingUtilities::WeightedRelation< const TrackingUtilities::CDCTrack > >	m_trackRelations
	Memory for the relations between tracks to be followed on linking.

std::vector< TrackingUtilities::Path< const TrackingUtilities::CDCTrack > >	m_trackPaths
	Memory for the track paths generated from the graph.

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

Links tracks based on a filter criterion.

Definition at line 34 of file TrackLinker.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

using Super = TrackingUtilities::Findlet<const TrackingUtilities::CDCTrack, TrackingUtilities::CDCTrack>

private

Type of the base class.

Definition at line 38 of file TrackLinker.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.

Constructor & Destructor Documentation

◆ TrackLinker()

TrackLinker ( )

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 19 of file TrackLinker.cc.

{
  this->addProcessingSignalListener(&m_trackRelationCreator);
}

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

void apply	(	const std::vector< TrackingUtilities::CDCTrack > &	inputTracks,
		std::vector< TrackingUtilities::CDCTrack > &	outputTracks )

final

Main algorithm.

Definition at line 35 of file TrackLinker.cc.

{
  // Obtain the tracks as pointers
  std::vector<const CDCTrack*> trackPtrs = as_pointers<const CDCTrack>(inputTracks);
 
  // Create linking relations
  m_trackRelations.clear();
  m_trackRelationCreator.apply(trackPtrs, m_trackRelations);
 
  // Find linking paths
  m_trackPaths.clear();
  m_cellularPathFinder.apply(trackPtrs, m_trackRelations, m_trackPaths);
 
  // Put the linked tracks together
  outputTracks.reserve(outputTracks.size() + m_trackPaths.size());
  for (const std::vector<const CDCTrack*>& trackPath : m_trackPaths) {
    outputTracks.push_back(CDCTrack::condense(trackPath));
  }
}

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

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

finalvirtual

Expose the parameters to a module.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 29 of file TrackLinker.cc.

{
  m_trackRelationCreator.exposeParameters(moduleParamList, prefix);
  m_cellularPathFinder.exposeParameters(moduleParamList, prefix);
}

◆ getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const TrackingUtilities::CDCTrack, TrackingUtilities::CDCTrack >.

Definition at line 24 of file TrackLinker.cc.

{
  return "Links tracks by extraction of track paths in a cellular automaton.";
}

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

TrackingUtilities::MultipassCellularPathFinder<const TrackingUtilities::CDCTrack> m_cellularPathFinder

private

Instance of the cellular automaton path finder.

Definition at line 61 of file TrackLinker.h.

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

◆ m_trackPaths

std::vector<TrackingUtilities::Path<const TrackingUtilities::CDCTrack> > m_trackPaths

private

Memory for the track paths generated from the graph.

Definition at line 67 of file TrackLinker.h.

◆ m_trackRelationCreator

TrackingUtilities::WeightedRelationCreator<const TrackingUtilities::CDCTrack, TrackFindingCDC::ChooseableTrackRelationFilter> m_trackRelationCreator

private

Creator of the track relations for linking.

Definition at line 58 of file TrackLinker.h.

◆ m_trackRelations

std::vector<TrackingUtilities::WeightedRelation<const TrackingUtilities::CDCTrack> > m_trackRelations

private

Memory for the relations between tracks to be followed on linking.

Definition at line 64 of file TrackLinker.h.

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

tracking/trackFindingCDC/findlets/minimal/include/TrackLinker.h
tracking/trackFindingCDC/findlets/minimal/src/TrackLinker.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

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]

Constructor & Destructor Documentation

◆ TrackLinker()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_cellularPathFinder

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_trackPaths

◆ m_trackRelationCreator

◆ m_trackRelations