PathLengthToggledApplier< AHit, AFindlet > Class Template Reference

A special findlet, which chooses the filter based on the current path length. More...

#include <PathLengthToggledApplier.dcl.h>

Inheritance diagram for PathLengthToggledApplier< AHit, AFindlet >:

Public Types
using	Object = std::pair< const std::vector< TrackFindingCDC::WithWeight< const AHit * > >, AHit * >
	The object this filter refers to.
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
	PathLengthToggledApplier ()
	Add the subfilters as listeners.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose parameters of the subfilters and the layer to change.
void	apply (const std::vector< TrackFindingCDC::WithWeight< const AHit * > > &currentPath, std::vector< TrackFindingCDC::WithWeight< AHit * > > &childHits) override
	The weight is calculated using the subfilter based on the geometrical layer of the state.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
virtual TrackFindingCDC::Weight	operator() (const Object &object)
	The filter operator for this class.
virtual std::string	getDescription ()
	Brief description of the purpose of the concrete findlet.
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 Types
using	Super = OnHitApplier< AHit >
	the parent class

Private Attributes
AFindlet	m_twoHitFilterFindlet
	Findlet used for currentPath.size() == 1.
AFindlet	m_threeHitFilterFindlet
	Findlet used for currentPath.size() == 2.
AFindlet	m_fourHitFilterFindlet
	Findlet used for currentPath.size() == 3.
AFindlet	m_fiveHitFilterFindlet
	Findlet used for currentPath.size() == 4.
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 AHit, class AFindlet>
class Belle2::vxdHoughTracking::PathLengthToggledApplier< AHit, AFindlet >

A special findlet, which chooses the filter based on the current path length.

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

Object

using Object = std::pair<const std::vector<TrackFindingCDC::WithWeight<const AHit*> >, AHit*>

inherited

The object this filter refers to.

Definition at line 37 of file OnHitApplier.dcl.h.

Super

using Super = OnHitApplier<AHit>

private

the parent class

Definition at line 27 of file PathLengthToggledApplier.dcl.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

PathLengthToggledApplier()

PathLengthToggledApplier

Add the subfilters as listeners.

Definition at line 23 of file PathLengthToggledApplier.icc.h.

                                                                       : Super()
    {
      Super::addProcessingSignalListener(&m_twoHitFilterFindlet);
      Super::addProcessingSignalListener(&m_threeHitFilterFindlet);
      Super::addProcessingSignalListener(&m_fourHitFilterFindlet);
      Super::addProcessingSignalListener(&m_fiveHitFilterFindlet);
    }

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 ( const std::vector< TrackFindingCDC::WithWeight< const AHit * > > &  currentPath, std::vector< TrackFindingCDC::WithWeight< AHit * > > &  childHits  )

override

The weight is calculated using the subfilter based on the geometrical layer of the state.

Definition at line 44 of file PathLengthToggledApplier.icc.h.

    {
      // if currentPath.size() == 1, including the single child hits makes the total path length 2, so use the twoHitFilter
      // if currentPath.size() == 2, including the single child hits makes the total path length 3, so use the threeHitFilter
      // if currentPath.size() == 3, including the single child hits makes the total path length 4, so use the fourHitFilter
      // if currentPath.size() == 4, including the single child hits makes the total path length 5, so use the fiveHitFilter
      // in the rare case that currentPath already contains five or more hits, it's very likely already that it's a valid track
      // candidate, so no filter is applied here, but only the best N candidates sorted by quality are used further.
      if (currentPath.size() == 1) {
        m_twoHitFilterFindlet.apply(currentPath, childHits);
      } else if (currentPath.size() == 2) {
        m_threeHitFilterFindlet.apply(currentPath, childHits);
      } else if (currentPath.size() == 3) {
        m_fourHitFilterFindlet.apply(currentPath, childHits);
      } else if (currentPath.size() == 4) {
        m_fiveHitFilterFindlet.apply(currentPath, childHits);
      }
    }

beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

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

exposeParameters()

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

finalvirtual

Expose parameters of the subfilters and the layer to change.

Reimplemented from Findlet< const TrackFindingCDC::WithWeight< const AHit * >, TrackFindingCDC::WithWeight< AHit * > >.

Definition at line 33 of file PathLengthToggledApplier.icc.h.

    {
      m_twoHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "twoHit"));
      m_threeHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "threeHit"));
      m_fourHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "fourHit"));
      m_fiveHitFilterFindlet.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "fiveHit"));
    }

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.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

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

operator()()

TrackFindingCDC::Weight operator() ( const Object &  object )

virtualinherited

The filter operator for this class.

Reimplemented in LimitedOnHitApplier< AHit, AFilter >.

Definition at line 39 of file OnHitApplier.icc.h.

    {
      return NAN;
    };

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_fiveHitFilterFindlet

AFindlet m_fiveHitFilterFindlet

private

Findlet used for currentPath.size() == 4.

Definition at line 48 of file PathLengthToggledApplier.dcl.h.

m_fourHitFilterFindlet

AFindlet m_fourHitFilterFindlet

private

Findlet used for currentPath.size() == 3.

Definition at line 46 of file PathLengthToggledApplier.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_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.

m_threeHitFilterFindlet

AFindlet m_threeHitFilterFindlet

private

Findlet used for currentPath.size() == 2.

Definition at line 44 of file PathLengthToggledApplier.dcl.h.

m_twoHitFilterFindlet

AFindlet m_twoHitFilterFindlet

private

Findlet used for currentPath.size() == 1.

Definition at line 42 of file PathLengthToggledApplier.dcl.h.

---

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

• tracking/vxdHoughTracking/findlets/include/PathLengthToggledApplier.dcl.h
• tracking/vxdHoughTracking/findlets/include/PathLengthToggledApplier.icc.h