Helper findlet which applies its () operator to all pairs of path and hit with all hits in the given child hit list. More...

#include <OnHitApplier.dcl.h>

Inheritance diagram for OnHitApplier< AHit >:

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
void	apply (const std::vector< TrackFindingCDC::WithWeight< const AHit * > > &currentPath, std::vector< TrackFindingCDC::WithWeight< AHit * > > &childHits) override
	Apply the () operator to all pairs of hit and current path.

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.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Forward prefixed parameters of this findlet to the module parameter list.

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 Types
using	Super = TrackFindingCDC::Findlet< const TrackFindingCDC::WithWeight< const AHit * >, TrackFindingCDC::WithWeight< AHit * > >
	Parent class.

Private Attributes
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 Belle2::vxdHoughTracking::OnHitApplier< AHit >

Helper findlet which applies its () operator to all pairs of path and hit with all hits in the given child hit list.

It deletes all hits in the list, where the operator () return NAN. Should probably be overloaded in derived classes.

Definition at line 29 of file OnHitApplier.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*>

The object this filter refers to.

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

◆ Super

using Super = TrackFindingCDC::Findlet<const TrackFindingCDC::WithWeight<const AHit*>, TrackFindingCDC::WithWeight<AHit*> >

private

Parent class.

Definition at line 33 of file OnHitApplier.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);
}

◆ apply()

void apply	(	const std::vector< TrackFindingCDC::WithWeight< const AHit * > > &	currentPath,
		std::vector< TrackFindingCDC::WithWeight< AHit * > > &	childHits
	)

override

Apply the () operator to all pairs of hit and current path.

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

    {
      if (childHits.empty()) {
        return;
      }
 
      for (TrackFindingCDC::WithWeight<AHit*>& hitWithWeight : childHits) {
        AHit& hit = *hitWithWeight;
        const TrackFindingCDC::Weight& weight = this->operator()({currentPath, &hit});
        hitWithWeight.setWeight(weight);
      }
 
      TrackFindingCDC::erase_remove_if(childHits, TrackFindingCDC::HasNaNWeight());
    };

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

◆ exposeParameters()

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

inlinevirtualinherited

Forward prefixed parameters of this findlet to the module parameter list.

Reimplemented in PathLengthToggledApplier< AHit, AFindlet >, and LimitedOnHitApplier< AHit, AFilter >.

Definition at line 69 of file Findlet.h.

71 {

72 }

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

◆ operator()()

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

virtual

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

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

tracking/vxdHoughTracking/findlets/include/OnHitApplier.dcl.h
tracking/vxdHoughTracking/findlets/include/OnHitApplier.icc.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Object

◆ Super

◆ ToVector

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ operator()()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated