Findlet for applying filters for creating hit-hit and hit-seed relations. More...

#include <CKFRelationCreator.dcl.h>

Inheritance diagram for CKFRelationCreator< AState, ASeedRelationFilter, AHitRelationFilter >:

Public Types
using	Super = TrackFindingCDC::Findlet< AState, AState, TrackFindingCDC::WeightedRelation< AState > >
	The parent class.

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
	CKFRelationCreator ()
	Construct this findlet and add the subfindlet as listener.

	~CKFRelationCreator ()
	Default destructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters of the subfindlet.

void	apply (std::vector< AState > &seedStates, std::vector< AState > &states, std::vector< TrackFindingCDC::WeightedRelation< AState > > &relations) override
	Apply both filters for creating state-hit and hit-hit relations.

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 = 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 Attributes
ASeedRelationFilter	m_seedFilter
	Subfindlet for the relation checking between seed and hits.

AHitRelationFilter	m_hitFilter
	Subfindlet for the relation checking between hits and hits.

bool	m_onlyUseHitStatesRelatedToSeeds = false
	Only use subset of hits already related to the seeds to reduce combinatorics as the "FromState".

bool	m_onlyCombineRelatedHitStates = false
	Only use subset of hits already related to the seeds to reduce combinatorics as "FromState" and as "ToStates".

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

template<class AState, class ASeedRelationFilter, class AHitRelationFilter = ASeedRelationFilter>
class Belle2::CKFRelationCreator< AState, ASeedRelationFilter, AHitRelationFilter >

Findlet for applying filters for creating hit-hit and hit-seed relations.

Definition at line 25 of file CKFRelationCreator.dcl.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 = TrackFindingCDC::Findlet<AState, AState, TrackFindingCDC::WeightedRelation<AState> >

The parent class.

Definition at line 28 of file CKFRelationCreator.dcl.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

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

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

◆ getDescription()

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

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

AHitRelationFilter m_hitFilter

private

Subfindlet for the relation checking between hits and hits.

Definition at line 47 of file CKFRelationCreator.dcl.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_onlyCombineRelatedHitStates

bool m_onlyCombineRelatedHitStates = false

private

Only use subset of hits already related to the seeds to reduce combinatorics as "FromState" and as "ToStates".

For this to work, m_onlyUseHitStatesRelatedToSeeds has to be true. Will only work reasonably well for PXD as we only have two layers and can jump over L2.

Definition at line 54 of file CKFRelationCreator.dcl.h.

◆ m_onlyUseHitStatesRelatedToSeeds

bool m_onlyUseHitStatesRelatedToSeeds = false

private

Only use subset of hits already related to the seeds to reduce combinatorics as the "FromState".

Will only work reasonably well for PXD as we only have two layers and can jump over L2.

Definition at line 50 of file CKFRelationCreator.dcl.h.

◆ m_seedFilter

ASeedRelationFilter m_seedFilter

private

Subfindlet for the relation checking between seed and hits.

Definition at line 45 of file CKFRelationCreator.dcl.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.

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

tracking/ckf/general/findlets/include/CKFRelationCreator.dcl.h
tracking/ckf/general/findlets/include/CKFRelationCreator.icc.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_hitFilter

◆ m_initialized

◆ m_initializedAs

◆ m_onlyCombineRelatedHitStates

◆ m_onlyUseHitStatesRelatedToSeeds

◆ m_seedFilter

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated