Main findlet of the ToCDCCKF module. More...

#include <CKFToCDCFindlet.h>

Inheritance diagram for CKFToCDCFindlet:

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
	CKFToCDCFindlet ()
	Constructor, for setting module description and parameters.

	~CKFToCDCFindlet () override
	Default destructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.

void	apply (const std::vector< TrackFindingCDC::CDCWireHit > &wireHits) override
	Do the track/hit finding/merging.

void	beginEvent () override
	Clear the object pools.

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	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 = TrackFindingCDC::Findlet<const TrackFindingCDC::CDCWireHit>
	Parent class.

Private Attributes
TrackLoader	m_trackHandler
	Findlet for retrieving the vxd tracks and writing the result out.

CDCCKFSeedCreator	m_seedCreator
	Seed Creator.

StackTreeSearcher	m_treeSearcher
	Tree Searcher.

CDCCKFResultFinalizer	m_resultFinalizer
	Result Finalizer.

CDCCKFResultStorer	m_resultStorer
	Result Storer.

std::vector< RecoTrack * >	m_vxdRecoTrackVector
	Pointers to the CDC Reco tracks as a vector.

std::vector< CDCCKFPath >	m_paths
	Current list of paths.

std::vector< CDCCKFPath >	m_seeds
	Current list of seeds.

std::vector< CDCCKFResult >	m_results
	Current list of results.

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

Main findlet of the ToCDCCKF module.

Definition at line 34 of file CKFToCDCFindlet.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 = TrackFindingCDC::Findlet<const TrackFindingCDC::CDCWireHit>

private

Parent class.

Definition at line 36 of file CKFToCDCFindlet.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

◆ CKFToCDCFindlet()

CKFToCDCFindlet ( )

Constructor, for setting module description and parameters.

Definition at line 19 of file CKFToCDCFindlet.cc.

{
  addProcessingSignalListener(&m_trackHandler);
  addProcessingSignalListener(&m_seedCreator);
  addProcessingSignalListener(&m_treeSearcher);
  addProcessingSignalListener(&m_resultFinalizer);
  addProcessingSignalListener(&m_resultStorer);
}

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< TrackFindingCDC::CDCWireHit > & wireHits )

override

Do the track/hit finding/merging.

Definition at line 54 of file CKFToCDCFindlet.cc.

{
  m_trackHandler.apply(m_vxdRecoTrackVector);
  m_seedCreator.apply(m_vxdRecoTrackVector, m_seeds);
 
  const auto& wireHitPtrs = TrackFindingCDC::as_pointers<const TrackFindingCDC::CDCWireHit>(wireHits);
 
  for (const auto& seed : m_seeds) {
    B2DEBUG(29, "Starting new seed");
    m_paths.clear();
    m_paths.push_back(seed);
    m_treeSearcher.apply(m_paths, wireHitPtrs);
    m_resultFinalizer.apply(m_paths, m_results);
  }
 
  m_resultStorer.apply(m_results);
}

◆ beginEvent()

void beginEvent ( )

overridevirtual

Clear the object pools.

Reimplemented from ProcessingSignalListener.

Definition at line 44 of file CKFToCDCFindlet.cc.

{
  Super::beginEvent();
 
  m_vxdRecoTrackVector.clear();
  m_paths.clear();
  m_seeds.clear();
  m_results.clear();
}

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

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 28 of file CKFToCDCFindlet.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  m_trackHandler.exposeParameters(moduleParamList, prefix);
  m_seedCreator.exposeParameters(moduleParamList, prefix);
  m_treeSearcher.exposeParameters(moduleParamList, prefix);
  m_resultFinalizer.exposeParameters(moduleParamList, prefix);
  m_resultStorer.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->getParameter<std::string>("statePreFilter").setDefaultValue("all");
  moduleParamList->getParameter<std::string>("stateBasicFilter").setDefaultValue("rough");
  moduleParamList->getParameter<std::string>("stateExtrapolationFilter").setDefaultValue("extrapolate_and_update");
  moduleParamList->getParameter<std::string>("stateFinalFilter").setDefaultValue("distance");
}

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

◆ 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_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_paths

std::vector<CDCCKFPath> m_paths

private

Current list of paths.

Definition at line 71 of file CKFToCDCFindlet.h.

◆ m_resultFinalizer

CDCCKFResultFinalizer m_resultFinalizer

private

Result Finalizer.

Definition at line 63 of file CKFToCDCFindlet.h.

◆ m_results

std::vector<CDCCKFResult> m_results

private

Current list of results.

Definition at line 75 of file CKFToCDCFindlet.h.

◆ m_resultStorer

CDCCKFResultStorer m_resultStorer

private

Result Storer.

Definition at line 65 of file CKFToCDCFindlet.h.

◆ m_seedCreator

CDCCKFSeedCreator m_seedCreator

private

Seed Creator.

Definition at line 59 of file CKFToCDCFindlet.h.

◆ m_seeds

std::vector<CDCCKFPath> m_seeds

private

Current list of seeds.

Definition at line 73 of file CKFToCDCFindlet.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_trackHandler

TrackLoader m_trackHandler

private

Findlet for retrieving the vxd tracks and writing the result out.

Definition at line 57 of file CKFToCDCFindlet.h.

◆ m_treeSearcher

StackTreeSearcher m_treeSearcher

private

Tree Searcher.

Definition at line 61 of file CKFToCDCFindlet.h.

◆ m_vxdRecoTrackVector

std::vector<RecoTrack*> m_vxdRecoTrackVector

private

Pointers to the CDC Reco tracks as a vector.

Definition at line 69 of file CKFToCDCFindlet.h.

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

tracking/ckf/cdc/findlets/include/CKFToCDCFindlet.h
tracking/ckf/cdc/findlets/src/CKFToCDCFindlet.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

◆ CKFToCDCFindlet()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_paths

◆ m_resultFinalizer

◆ m_results

◆ m_resultStorer

◆ m_seedCreator

◆ m_seeds

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_trackHandler

◆ m_treeSearcher

◆ m_vxdRecoTrackVector