Merge similar paths. More...

#include <CDCCKFPathMerger.h>

Inheritance diagram for CDCCKFPathMerger:

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	apply (std::vector< CDCCKFPath > &newPaths) override
	main method of the findlet, reads/returns merged paths

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.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list.

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

Private Member Functions
size_t	lastThreeHitHash (const CDCCKFPath &path)
	helper function, returns has of the last 3 wire hits on the path

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

Merge similar paths.

Definition at line 22 of file CDCCKFPathMerger.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 = ProcessingSignalListener

privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.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 ( std::vector< CDCCKFPath > & newPaths )

inlineoverride

main method of the findlet, reads/returns merged paths

TODO: Merging does not work properly, as the tracks we compare must not have the same number of hits (and must not be at the same stage)

Definition at line 25 of file CDCCKFPathMerger.h.

    {
      std::unordered_map<size_t, CDCCKFPath> hashToPathList;
      for (const CDCCKFPath& path : newPaths) {
        const auto lastHitsHash = lastThreeHitHash(path);
        if (hashToPathList.find(lastHitsHash) != hashToPathList.end()) {
          if (hashToPathList[lastHitsHash].size() < path.size()) {
            hashToPathList[lastHitsHash] = path;
          }
        } else {
          hashToPathList[lastHitsHash] = path;
        }
      }
 
      newPaths.clear();
      for (const auto& hashAndPathList : hashToPathList) {
        const CDCCKFPath& path = hashAndPathList.second;
        newPaths.push_back(path);
      }
    }

◆ 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

Expose the set of parameters of the filter to the module parameter list.

Parameters

moduleParamList	Module parameter list to add the new parameters to
prefix	Prefix (or sometimes postfix) to be added to all nely added parameters.

Definition at line 47 of file CompositeProcessingSignalListener.h.

49 {};

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

◆ lastThreeHitHash()

size_t lastThreeHitHash ( const CDCCKFPath & path )

inlineprivate

helper function, returns has of the last 3 wire hits on the path

Definition at line 49 of file CDCCKFPathMerger.h.

    {
      size_t seed = 0;
      unsigned int counter = 0;
 
      for (const CDCCKFState& state : boost::adaptors::reverse(path)) {
        if (counter >= 3) {
          break;
        }
        if (not state.isSeed()) {
          boost::hash_combine(seed, state.getWireHit());
        }
        counter++;
      }
      return seed;
    };

◆ 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 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/CDCCKFPathMerger.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

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ lastThreeHitHash()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated