CDCCKFPathSelector Class Reference

Select the m_maximalCandidatesInFlight paths for further processing. More...

#include <CDCCKFPathSelector.h>

Inheritance diagram for CDCCKFPathSelector:

Collaboration diagram for CDCCKFPathSelector:

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
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.
void	setMaximalCandidatesInFlight (size_t maximalCandidatesInFlight)
	Set maximal candidates in flight.
void	apply (std::vector< CDCCKFPath > &newPaths) override
	main method of the findlet, out of all paths "newPaths" select the best N=m_maximalCandidatesInFlight
virtual std::string	getDescription ()
	Brief description of the purpose of the concrete findlet.
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
	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
	Type of the base class.

Private Attributes
size_t	m_maximalCandidatesInFlight = 3
	Maximum number of paths to select.
TrackingUtilities::ChooseableFilter< CDCPathPairFilterFactory >	m_filter
	Filter to order paths.
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

Select the m_maximalCandidatesInFlight paths for further processing.

Definition at line 25 of file CDCCKFPathSelector.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

privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.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

CDCCKFPathSelector()

CDCCKFPathSelector ( )

inline

Definition at line 27 of file CDCCKFPathSelector.h.

    {
      addProcessingSignalListener(&m_filter);
    }

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 ( std::vector< CDCCKFPath > & newPaths )

inlineoverride

main method of the findlet, out of all paths "newPaths" select the best N=m_maximalCandidatesInFlight

Definition at line 51 of file CDCCKFPathSelector.h.

    {
      const auto pathComparison = [&](const CDCCKFPath & lhs, const CDCCKFPath & rhs) {
        return m_filter(std::pair(&lhs, &rhs)) > 0;
      };
      std::sort(newPaths.begin(), newPaths.end(), pathComparison);
 
      TrackingUtilities::only_best_N(newPaths, m_maximalCandidatesInFlight);
    }

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 )

inlineoverridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 33 of file CDCCKFPathSelector.h.

    {
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "maximalCandidatesInFlight"),
                                    m_maximalCandidatesInFlight,
                                    "Maximal candidates in flight", m_maximalCandidatesInFlight);
      m_filter.exposeParameters(moduleParamList, prefix);
    }

getDescription() [1/2]

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

getDescription() [2/2]

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

setMaximalCandidatesInFlight()

void setMaximalCandidatesInFlight ( size_t maximalCandidatesInFlight )

inline

Set maximal candidates in flight.

Parameters

maximalCandidatesInFlight

Maximum number of candidates to keep in flight

Definition at line 45 of file CDCCKFPathSelector.h.

    {
      m_maximalCandidatesInFlight = maximalCandidatesInFlight;
    }

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_filter

TrackingUtilities::ChooseableFilter<CDCPathPairFilterFactory> m_filter

private

Filter to order paths.

Definition at line 65 of file CDCCKFPathSelector.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_maximalCandidatesInFlight

size_t m_maximalCandidatesInFlight = 3

private

Maximum number of paths to select.

Definition at line 63 of file CDCCKFPathSelector.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.

---

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

• tracking/ckf/cdc/findlets/include/CDCCKFPathSelector.h