CKF tree searcher which traces several best paths. More...

#include <StackTreeSearcher.h>

Inheritance diagram for StackTreeSearcher:

[legend]

Collaboration diagram for StackTreeSearcher:

[legend]

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
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.

void	setMaximalDeltaPhi (double maximalDeltaPhi)
	Set maximal delta phi for state creation.

void	setMaximalLayerJump (int maximalLayerJump)
	Set maximal layer jump for state creation.

void	setMaximalLayerJumpBackwardSeed (int maximalLayerJumpBackwardSeed)
	Set maximal layer jump for backward seed tracks.

void	setHitFindingDirection (const std::string &hitFindingDirection)
	Set hit finding direction.

void	setPathMaximalCandidatesInFlight (size_t pathMaximalCandidatesInFlight)
	Set maximal candidates in flight for path selection.

void	setStateMaximalHitCandidates (size_t stateMaximalHitCandidates)
	Set maximal hit candidates for state filtering.

void	apply (std::vector< CDCCKFPath > &paths, const std::vector< const TrackingUtilities::CDCWireHit * > &wireHits) override
	Main method to update the paths. Input: vector of the selected paths and a vector of CDC wirehits to be considered.

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
template<class T>
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 = ProcessingSignalListener
	Type of the base class.

Private Attributes
CDCCKFStateCreator	m_stateCreator
	algorithm to create CDC-CDF states while traversing the path

CDCCKFStateFilter	m_stateFilter
	algorithm to perform state filtering

CDCCKFPathMerger	m_pathMerger
	algorithm to merge similar paths

CDCCKFPathSelector	m_pathSelector
	algorithm to select N best paths, for further processing.

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

CKF tree searcher which traces several best paths.

Definition at line 30 of file StackTreeSearcher.h.

Member Typedef Documentation

◆ IOTypes

template<class ... AIOTypes>

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

template<class ... AIOTypes>

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 = ProcessingSignalListener

privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.h.

◆ ToVector

template<class ... AIOTypes>

template<class T>

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ StackTreeSearcher()

StackTreeSearcher ( )

inline

Definition at line 33 of file StackTreeSearcher.h.

    {
      addProcessingSignalListener(&m_stateCreator);
      addProcessingSignalListener(&m_stateFilter);
      addProcessingSignalListener(&m_pathMerger);
      addProcessingSignalListener(&m_pathSelector);
    }

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< CDCCKFPath > &	paths,
		const std::vector< const TrackingUtilities::CDCWireHit * > &	wireHits )

inlineoverride

Main method to update the paths. Input: vector of the selected paths and a vector of CDC wirehits to be considered.

Definition at line 99 of file StackTreeSearcher.h.

    {
 
      if (paths.empty()) {
        return;
      }
 
      std::vector<CDCCKFPath> newPaths;
      std::vector<CDCCKFState> nextStates;
 
      for (CDCCKFPath& path : paths) {
        B2DEBUG(29, "Testing one path from " << path.back());
        m_stateCreator.apply(nextStates, path, wireHits);
        m_stateFilter.apply(path, nextStates);
 
        // TODO: Attention: if there is no hit anymore, the path will not be added to the final set!
        for (const auto& nextState : nextStates) {
          path.push_back(nextState);
 
          B2DEBUG(29, "will go to " << nextState);
          newPaths.push_back(path);
          path.pop_back();
        }
        B2DEBUG(29, "Now having " << newPaths.size() << " in flight");
        nextStates.clear();
      }
 
      B2DEBUG(29, "Having found " << newPaths.size() << " new paths");
      for (const auto& path : newPaths) {
        B2DEBUG(29, path);
      }
 
      m_pathMerger.apply(newPaths);
      B2DEBUG(29, "Having found " << newPaths.size() << " new paths after merging");
      for (const auto& path : newPaths) {
        B2DEBUG(29, path);
      }
 
      m_pathSelector.apply(newPaths);
      B2DEBUG(29, "Having found " << newPaths.size() << " new paths after selection");
      for (const auto& path : newPaths) {
        B2DEBUG(29, path);
      }
 
      if (newPaths.empty()) {
        return;
      }
 
      paths.swap(newPaths);
      newPaths.clear();
 
      apply(paths, wireHits);
    }

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

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 DATCONSVDClusterizer, LayerPXDRelationFilter< AFilter, APrefilter >, LayerPXDRelationFilter< TrackingUtilities::ChooseableFilter< PXDPairFilterFactory > >, LayerPXDRelationFilter< TrackingUtilities::ChooseableFilter< PXDPairFilterFactory > >, LayerSVDRelationFilter< AFilter, APrefilter >, LayerSVDRelationFilter< TrackingUtilities::ChooseableFilter< SVDPairFilterFactory > >, LayerSVDRelationFilter< TrackingUtilities::ChooseableFilter< SVDPairFilterFactory > >, SectorMapBasedSVDPairFilter, SimplePXDStateFilter, SimpleSVDStateFilter, CutsFromDBWireHitFilter, WireHitCreator, MVA< Filter< AVarSet::Object > >, MVA< Filter< Belle2::TrackFindingCDC::CDCWireHitVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, FourHitFilter, LayerRelationFilter< AFilter >, LayerRelationFilter< TrackingUtilities::ChooseableFilter< RelationFilterFactory > >, LayerRelationFilter< TrackingUtilities::ChooseableFilter< RelationFilterFactory > >, QualityIndicatorFilter, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, ThreeHitFilter, TrackCandidateOverlapResolver, TrackCandidateResultRefiner, TwoHitVirtualIPFilter, and TwoHitVirtualIPQIFilter.

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 )

inlineoverridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 42 of file StackTreeSearcher.h.

    {
      m_stateCreator.exposeParameters(moduleParamList, prefix);
      m_stateFilter.exposeParameters(moduleParamList, TrackingUtilities::prefixed("state", prefix));
      m_pathMerger.exposeParameters(moduleParamList, prefix);
      m_pathSelector.exposeParameters(moduleParamList, TrackingUtilities::prefixed("path", prefix));
    }

◆ getDescription()

template<class ... AIOTypes>

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

Definition at line 15 of file CompositeProcessingSignalListener.cc.

{
  Super::initialize();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->initialize();
  }
}

◆ setHitFindingDirection()

void setHitFindingDirection ( const std::string & hitFindingDirection )

inline

Set hit finding direction.

Parameters

hitFindingDirection Start from innermost/outermost CDC layers

Definition at line 75 of file StackTreeSearcher.h.

    {
      m_stateCreator.setHitFindingDirection(hitFindingDirection);
    }

◆ setMaximalDeltaPhi()

void setMaximalDeltaPhi ( double maximalDeltaPhi )

inline

Set maximal delta phi for state creation.

Parameters

maximalDeltaPhi Maximum distance in phi between wires for Z=0 plane

Definition at line 54 of file StackTreeSearcher.h.

54{ m_stateCreator.setMaximalDeltaPhi(maximalDeltaPhi); }

◆ setMaximalLayerJump()

void setMaximalLayerJump ( int maximalLayerJump )

inline

Set maximal layer jump for state creation.

Parameters

maximalLayerJump Maximum number of layers to jump

Definition at line 60 of file StackTreeSearcher.h.

60{ m_stateCreator.setMaximalLayerJump(maximalLayerJump); }

◆ setMaximalLayerJumpBackwardSeed()

void setMaximalLayerJumpBackwardSeed ( int maximalLayerJumpBackwardSeed )

inline

Set maximal layer jump for backward seed tracks.

Parameters

maximalLayerJumpBackwardSeed Maximum number of layers to jump for backward seeds

Definition at line 66 of file StackTreeSearcher.h.

    {
      m_stateCreator.setMaximalLayerJumpBackwardSeed(maximalLayerJumpBackwardSeed);
    }

◆ setPathMaximalCandidatesInFlight()

void setPathMaximalCandidatesInFlight ( size_t pathMaximalCandidatesInFlight )

inline

Set maximal candidates in flight for path selection.

Parameters

pathMaximalCandidatesInFlight Maximum number of candidates to keep in flight

Definition at line 84 of file StackTreeSearcher.h.

    {
      m_pathSelector.setMaximalCandidatesInFlight(pathMaximalCandidatesInFlight);
    }

◆ setStateMaximalHitCandidates()

void setStateMaximalHitCandidates ( size_t stateMaximalHitCandidates )

inline

Set maximal hit candidates for state filtering.

Parameters

stateMaximalHitCandidates Maximum number of hit candidates to test

Definition at line 93 of file StackTreeSearcher.h.

    {
      m_stateFilter.setMaximalHitCandidates(stateMaximalHitCandidates);
    }

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< AQuadTree >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInHyperBox >, 4, 3, 2 > >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInQuadraticBox >, 2, 2 > >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre< std::pair< TrackingUtilities::CDCRecoHit3D, const TrackingUtilities::CDCRLWireHit * >, FirstOfPairInBox< HitInZ0TanLambdaBox >, 2, 2 > >, Recording< Filter< AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, and Recording< Filter< typename AVarSet::Object > >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

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

CDCCKFPathMerger m_pathMerger

private

algorithm to merge similar paths

Definition at line 160 of file StackTreeSearcher.h.

◆ m_pathSelector

CDCCKFPathSelector m_pathSelector

private

algorithm to select N best paths, for further processing.

Definition at line 162 of file StackTreeSearcher.h.

◆ m_stateCreator

CDCCKFStateCreator m_stateCreator

private

algorithm to create CDC-CDF states while traversing the path

Definition at line 156 of file StackTreeSearcher.h.

◆ m_stateFilter

CDCCKFStateFilter m_stateFilter

private

algorithm to perform state filtering

Definition at line 158 of file StackTreeSearcher.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 = false

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/StackTreeSearcher.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ StackTreeSearcher()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ setHitFindingDirection()

◆ setMaximalDeltaPhi()

◆ setMaximalLayerJump()

◆ setMaximalLayerJumpBackwardSeed()

◆ setPathMaximalCandidatesInFlight()

◆ setStateMaximalHitCandidates()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_pathMerger

◆ m_pathSelector

◆ m_stateCreator

◆ m_stateFilter

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated