Findlet for constructing result paths out of a list of hits, which are connected with weighted relations. More...

#include <SVDHoughTrackingTreeSearcher.dcl.h>

Inheritance diagram for SVDHoughTrackingTreeSearcher< AHit, APathFilter, AResult >:

Public Types
using	IOTypes
	Types that should be served to apply on invocation.

using	IOVectors
	Vector types that should be served to apply on invocation.

Public Member Functions
	SVDHoughTrackingTreeSearcher ()
	Construct this findlet and add the subfindlet as listener.

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

void	apply (std::vector< AHit * > &hits, const std::vector< TrackFindingCDC::WeightedRelation< AHit > > &relations, std::vector< AResult > &results) final
	Main function of this findlet: traverse a tree starting from a given seed hits.

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	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
	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<AHit*, const TrackFindingCDC::WeightedRelation<AHit>, AResult>
	Parent class.

Private Member Functions
void	traverseTree (std::vector< TrackFindingCDC::WithWeight< const AHit * > > &path, const std::vector< TrackFindingCDC::WeightedRelation< AHit > > &relations, std::vector< AResult > &results)
	Implementation of the traverseTree function.

Private Attributes
APathFilter	m_pathFilter
	State rejecter to decide which available continuations should be traversed next.

TrackFindingCDC::CellularAutomaton< AHit >	m_automaton
	Findlet for adding a recursion cell state to the hits.

uint	m_applyTwoHitFilterIfMoreChildStates = 50
	TwoHitFilter activarion cut.

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

template<class AHit, class APathFilter, class AResult>
class Belle2::vxdHoughTracking::SVDHoughTrackingTreeSearcher< AHit, APathFilter, AResult >

Findlet for constructing result paths out of a list of hits, which are connected with weighted relations.

At each step, the hits are again tested using a state rejector, which also knows the current path of hits.

This rejector is allowed to alter the hits, so using a cellular automaton it is assured, that the hits are traversed in the correct order without overriding each other. It is however crucial, that the relations do not create cycles in the graph!

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

Member Typedef Documentation

◆ IOTypes

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

template<class AHit, class APathFilter, class AResult>

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

private

Parent class.

Definition at line 41 of file SVDHoughTrackingTreeSearcher.dcl.h.

◆ ToVector

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ SVDHoughTrackingTreeSearcher()

template<class AHit, class APathFilter, class AResult>

SVDHoughTrackingTreeSearcher ( )

Construct this findlet and add the subfindlet as listener.

Definition at line 26 of file SVDHoughTrackingTreeSearcher.icc.h.

                                                                                           : Super()
    {
      Super::addProcessingSignalListener(&m_pathFilter);
    };

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

template<class AHit, class APathFilter, class AResult>

void apply	(	std::vector< AHit * > &	hits,
		const std::vector< TrackFindingCDC::WeightedRelation< AHit > > &	relations,
		std::vector< AResult > &	results )

final

Main function of this findlet: traverse a tree starting from a given seed hits.

ATTENTION: As described above, the hits themselves can be altered during the tree traversal.

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

    {
      B2ASSERT("Expected relation to be sorted", std::is_sorted(relations.begin(), relations.end()));
 
      m_automaton.applyTo(hits, relations);
 
      std::vector<const AHit*> seedHits;
      for (const AHit* hit : hits) {
        if (hit->getDataCache().layer >= 5) {
          seedHits.emplace_back(hit);
        }
      }
 
      std::vector<TrackFindingCDC::WithWeight<const AHit*>> path;
      for (const AHit* seedHit : seedHits) {
        B2DEBUG(29, "Starting with new seed...");
 
        path.emplace_back(seedHit, 0);
        traverseTree(path, relations, results);
        path.pop_back();
        B2ASSERT("Something went wrong during the path traversal", path.empty());
 
        B2DEBUG(29, "... finished with seed");
      }
    }

◆ beginEvent()

void beginEvent ( )

overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

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

template<class AHit, class APathFilter, class AResult>

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

finalvirtual

Expose the parameters of the subfindlet.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 32 of file SVDHoughTrackingTreeSearcher.icc.h.

    {
      m_pathFilter.exposeParameters(moduleParamList, prefix);
 
      moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "twoHitFilterLimit"),
                                    m_applyTwoHitFilterIfMoreChildStates,
                                    "Use the TwoHitFilter (path length == 1) if there are more child states than this value.",
                                    m_applyTwoHitFilterIfMoreChildStates);
    }

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

◆ traverseTree()

template<class AHit, class APathFilter, class AResult>

void traverseTree	(	std::vector< TrackFindingCDC::WithWeight< const AHit * > > &	path,
		const std::vector< TrackFindingCDC::WeightedRelation< AHit > > &	relations,
		std::vector< AResult > &	results )

private

Implementation of the traverseTree function.

Definition at line 73 of file SVDHoughTrackingTreeSearcher.icc.h.

    {
      // Implement only graph traversal logic and leave the extrapolation and selection to the
      // rejecter.
      const AHit* currentHit = path.back();
      auto continuations =
        TrackFindingCDC::asRange(std::equal_range(relations.begin(), relations.end(), currentHit));
 
      std::vector<TrackFindingCDC::WithWeight<AHit*>> childHits;
      for (const TrackFindingCDC::WeightedRelation<AHit>& continuation : continuations) {
        AHit* childHit = continuation.getTo();
        TrackFindingCDC::Weight weight = continuation.getWeight();
        // the state may still include information from an other round of processing, so lets set it back
 
        if (std::count(path.begin(), path.end(), childHit)) {
          // Cycle detected -- is this the best handling?
          // Other options: Raise an exception and bail out of this seed
          B2FATAL("Cycle detected!");
        }
 
        childHits.emplace_back(childHit, weight);
      }
 
      // Do everything with child states, linking, extrapolation, teaching, discarding, what have you.
      const std::vector<TrackFindingCDC::WithWeight<const AHit*>>& constPath = path;
      if (path.size() > 1 or childHits.size() > m_applyTwoHitFilterIfMoreChildStates) {
        m_pathFilter.apply(constPath, childHits);
      }
 
      if (childHits.empty()) {
        B2DEBUG(29, "Terminating this route, as there are no possible child states.");
        if (path.size() >= 3) {
          results.emplace_back(path);
        }
        return;
      }
 
      // Traverse the tree from each new state on
      std::sort(childHits.begin(), childHits.end(), TrackFindingCDC::GreaterOf<TrackFindingCDC::GetWeight>());
 
      B2DEBUG(29, "Having found " << childHits.size() << " child states.");
 
      for (const TrackFindingCDC::WithWeight<AHit*>& childHit : childHits) {
        path.emplace_back(childHit, childHit.getWeight());
        traverseTree(path, relations, results);
        path.pop_back();
      }
    }

Member Data Documentation

◆ m_applyTwoHitFilterIfMoreChildStates

template<class AHit, class APathFilter, class AResult>

uint m_applyTwoHitFilterIfMoreChildStates = 50

private

TwoHitFilter activarion cut.

Definition at line 74 of file SVDHoughTrackingTreeSearcher.dcl.h.

◆ m_automaton

template<class AHit, class APathFilter, class AResult>

TrackFindingCDC::CellularAutomaton<AHit> m_automaton

private

Findlet for adding a recursion cell state to the hits.

Definition at line 71 of file SVDHoughTrackingTreeSearcher.dcl.h.

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

template<class AHit, class APathFilter, class AResult>

APathFilter m_pathFilter

private

State rejecter to decide which available continuations should be traversed next.

Definition at line 68 of file SVDHoughTrackingTreeSearcher.dcl.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.

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

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ SVDHoughTrackingTreeSearcher()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

◆ traverseTree()

Member Data Documentation

◆ m_applyTwoHitFilterIfMoreChildStates

◆ m_automaton

◆ m_initialized

◆ m_initializedAs

◆ m_pathFilter

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated