Findlet for rejecting wrong SpacePointTrackCands and for removing bad hits. More...

#include <RawTrackCandCleaner.dcl.h>

Inheritance diagram for RawTrackCandCleaner< AHit >:

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
	RawTrackCandCleaner ()
	Find intercepts in the 2D Hough space.

	~RawTrackCandCleaner ()
	Default destructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.

void	initialize () override
	Create the store arrays.

void	apply (std::vector< std::vector< AHit * > > &rawTrackCandidates, std::vector< SpacePointTrackCand > &trackCandidates) override
	Reject bad SpacePointTrackCands and bad hits inside the remaining.

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	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<std::vector<AHit*>, SpacePointTrackCand>
	Parent class.

using	Result = std::vector<TrackFindingCDC::WithWeight<const AHit*>>
	Shortcut definition for Result.

Private Attributes
RelationCreator< AHit, ChooseableRelationFilter >	m_relationCreator
	create relations between the hits in each raw track candidate

SVDHoughTrackingTreeSearcher< AHit, ChooseablePathFilter, Result >	m_treeSearcher
	perform a tree search using a cellular automaton for all the hits and relations of each raw track candidate

TrackCandidateResultRefiner	m_resultRefiner
	sort and refine the results for each raw track cand, performing a fit and a basic overlap check

std::vector< TrackFindingCDC::WeightedRelation< AHit > >	m_relations
	vector containing the relations between the hits in the raw track candidate

std::vector< Result >	m_results
	vector containing track candidates after tree search

std::vector< SpacePointTrackCand >	m_unfilteredResults
	vector containing unfiltered results, i.e.

std::vector< SpacePointTrackCand >	m_filteredResults
	vector containing the filtered and pruned results the filtered results of each raw track candidate will be collected and given back to the caller

uint	m_maxRelations = 100
	maximum number of relations that can be created per track candidate

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 Belle2::vxdHoughTracking::RawTrackCandCleaner< AHit >

Findlet for rejecting wrong SpacePointTrackCands and for removing bad hits.

Definition at line 30 of file RawTrackCandCleaner.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.

◆ Result

template<class AHit>

using Result = std::vector<TrackFindingCDC::WithWeight<const AHit*>>

private

Shortcut definition for Result.

Definition at line 35 of file RawTrackCandCleaner.dcl.h.

◆ Super

template<class AHit>

using Super = TrackFindingCDC::Findlet<std::vector<AHit*>, SpacePointTrackCand>

private

Parent class.

Definition at line 32 of file RawTrackCandCleaner.dcl.h.

◆ ToVector

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ RawTrackCandCleaner()

template<class AHit>

RawTrackCandCleaner ( )

Find intercepts in the 2D Hough space.

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

                                                 : Super()
  {
    Super::addProcessingSignalListener(&m_relationCreator);
    Super::addProcessingSignalListener(&m_treeSearcher);
    Super::addProcessingSignalListener(&m_resultRefiner);
  }

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>

void apply	(	std::vector< std::vector< AHit * > > &	rawTrackCandidates,
		std::vector< SpacePointTrackCand > &	trackCandidates )

override

Reject bad SpacePointTrackCands and bad hits inside the remaining.

Definition at line 52 of file RawTrackCandCleaner.icc.h.

  {
    uint family = 0; // family of the SpacePointTrackCands
    for (auto& rawTrackCand : rawTrackCandidates) {
 
      // If the capacity of a std::vector is too large, start with a fresh one.
      // Since std::vector.shrink() or std::vector.shrink_to_fit() not necessarily reduce the capacity in the desired way,
      // create a temporary vector of the same type and swap them to use the vector at the new location afterwards.
      checkResizeClear<TrackFindingCDC::WeightedRelation<AHit>>(m_relations, 8192);
      checkResizeClear<Result>(m_results, 8192);
      checkResizeClear<SpacePointTrackCand>(m_unfilteredResults, 8192);
      checkResizeClear<SpacePointTrackCand>(m_filteredResults, 8192);
 
      m_relationCreator.apply(rawTrackCand, m_relations);
 
      if (m_relations.size() > m_maxRelations) {
        m_relations.clear();
        continue;
      }
 
      m_treeSearcher.apply(rawTrackCand, m_relations, m_results);
 
      m_unfilteredResults.reserve(m_results.size());
      for (const std::vector<TrackFindingCDC::WithWeight<const AHit*>>& result : m_results) {
        std::vector<const SpacePoint*> spacePointsInResult;
        spacePointsInResult.reserve(result.size());
        for (const TrackFindingCDC::WithWeight<const AHit*>& hit : result) {
          spacePointsInResult.emplace_back(hit->getHit());
        }
        std::sort(spacePointsInResult.begin(), spacePointsInResult.end(), [](const SpacePoint * a, const SpacePoint * b) {
          return
            (a->getVxdID().getLayerNumber() < b->getVxdID().getLayerNumber()) or
            (a->getVxdID().getLayerNumber() == b->getVxdID().getLayerNumber()
             and a->getPosition().Perp() < b->getPosition().Perp());
        });
        m_unfilteredResults.emplace_back(spacePointsInResult);
      }
 
      for (auto aTC : m_unfilteredResults) {
        aTC.setFamily(family);
      }
 
      m_resultRefiner.apply(m_unfilteredResults, m_filteredResults);
 
      for (const SpacePointTrackCand& trackCand : m_filteredResults) {
        trackCandidates.emplace_back(trackCand);
      }
 
      family++;
    }
  }

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

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

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 34 of file RawTrackCandCleaner.icc.h.

  {
    Super::exposeParameters(moduleParamList, prefix);
    m_relationCreator.exposeParameters(moduleParamList, prefix);
    m_treeSearcher.exposeParameters(moduleParamList, prefix);
    m_resultRefiner.exposeParameters(moduleParamList, prefix);
 
    moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "maxRelations"), m_maxRelations,
                                  "Maximum number of relations allowed for entering tree search.", m_maxRelations);
  }

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

template<class AHit>

void initialize ( )

overridevirtual

Create the store arrays.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 46 of file RawTrackCandCleaner.icc.h.

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

Member Data Documentation

◆ m_filteredResults

template<class AHit>

std::vector<SpacePointTrackCand> m_filteredResults

private

vector containing the filtered and pruned results the filtered results of each raw track candidate will be collected and given back to the caller

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

◆ m_initialized

bool m_initialized

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

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.

◆ m_treeSearcher

template<class AHit>

SVDHoughTrackingTreeSearcher<AHit, ChooseablePathFilter, Result> m_treeSearcher

private

perform a tree search using a cellular automaton for all the hits and relations of each raw track candidate

Definition at line 59 of file RawTrackCandCleaner.dcl.h.

◆ m_unfilteredResults

template<class AHit>

std::vector<SpacePointTrackCand> m_unfilteredResults

private

vector containing unfiltered results, i.e.

SpacePointTrackCands containing only the SpacePoins of the hits in m_results

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

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

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Result

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ RawTrackCandCleaner()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_filteredResults

◆ m_initialized

◆ m_initializedAs

◆ m_maxRelations

◆ m_relationCreator

◆ m_relations

◆ m_resultRefiner

◆ m_results

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_treeSearcher

◆ m_unfilteredResults