SVDHoughTracking Class Reference

Main Findlet for the SVDHoughTracking. More...

#include <SVDHoughTracking.h>

Inheritance diagram for SVDHoughTracking:

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

Public Member Functions
	SVDHoughTracking ()
	Constructor for adding the subfindlets.
	~SVDHoughTracking ()
	Default destructor.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.
void	apply () override
	Function to call all the sub-findlets.
void	beginEvent () override
	Clear the object pools.
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	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.
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<>
	Parent class.

Private Attributes
SpacePointLoaderAndPreparer	m_spacePointLoaderAndPreparer
	Findlets:
MultiHoughSpaceFastInterceptFinder	m_multiHouthSpaceInterceptFinder
	Hough Space intercept finder.
SingleHoughSpaceFastInterceptFinder	m_singleHouthSpaceInterceptFinder
	Simple Hough Space intercept finder.
RawTrackCandCleaner< VXDHoughState >	m_rawTCCleaner
	Raw track candidate cleaner.
TrackCandidateOverlapResolver	m_overlapResolver
	Resolve hit overlaps in track candidates.
RecoTrackStorer	m_recoTrackStorer
	Store tracks as RecoTracks.
ROIFinder	m_roiFinder
	ROIFinder findlet, calculates PXD intercepts and ROIs.
std::vector< const SpacePoint * >	m_spacePointVector
	Container to share data between findlets.
std::vector< VXDHoughState >	m_vxdHoughStates
	Vector containing the cached hit information.
std::vector< std::vector< VXDHoughState * > >	m_rawTrackCandidates
	Vector containing raw track candidates.
std::vector< SpacePointTrackCand >	m_trackCandidates
	A track candidate is a vector of SpacePoint, and in each event multiple track candidates will be created, which are stored in a vector themselves.
bool	m_useMultiHoughSpaceInterceptFinding = false
	Use the elaborate FastInterceptFinder2D with multiple Hough spaces (true) or the simple one with just one Hough space (false)
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

Main Findlet for the SVDHoughTracking.

Definition at line 37 of file SVDHoughTracking.h.

Member Typedef Documentation

IOTypes [1/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOTypes [2/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOVectors [1/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

IOVectors [2/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

Super

using Super = TrackFindingCDC::Findlet<>

private

Parent class.

Definition at line 39 of file SVDHoughTracking.h.

ToVector [1/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

ToVector [2/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

SVDHoughTracking()

SVDHoughTracking

(

)

Constructor for adding the subfindlets.

Definition at line 22 of file SVDHoughTracking.cc.

{
  addProcessingSignalListener(&m_spacePointLoaderAndPreparer);
  addProcessingSignalListener(&m_multiHouthSpaceInterceptFinder);
  addProcessingSignalListener(&m_singleHouthSpaceInterceptFinder);
  addProcessingSignalListener(&m_rawTCCleaner);
  addProcessingSignalListener(&m_overlapResolver);
  addProcessingSignalListener(&m_recoTrackStorer);
  addProcessingSignalListener(&m_roiFinder);
}

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

void apply ( )

override

Function to call all the sub-findlets.

Definition at line 71 of file SVDHoughTracking.cc.

{
  m_spacePointLoaderAndPreparer.apply(m_spacePointVector, m_vxdHoughStates);
  B2DEBUG(29, "m_vxdHoughStates.size(): " << m_vxdHoughStates.size());
 
  if (m_useMultiHoughSpaceInterceptFinding) {
    m_multiHouthSpaceInterceptFinder.apply(m_vxdHoughStates, m_rawTrackCandidates);
  } else {
    m_singleHouthSpaceInterceptFinder.apply(m_vxdHoughStates, m_rawTrackCandidates);
  }
  B2DEBUG(29, "m_rawTrackCandidates.size: " << m_rawTrackCandidates.size());
 
  m_rawTCCleaner.apply(m_rawTrackCandidates, m_trackCandidates);
 
  // sort by number of hits in the track candidate and by the QI
  std::sort(m_trackCandidates.begin(), m_trackCandidates.end(),
  [](const SpacePointTrackCand & a, const SpacePointTrackCand & b) {
    return ((a.getNHits() > b.getNHits()) or
            (a.getNHits() == b.getNHits() and a.getQualityIndicator() > b.getQualityIndicator()));
  });
 
  m_overlapResolver.apply(m_trackCandidates);
 
  m_recoTrackStorer.apply(m_trackCandidates, m_spacePointVector);
 
  // A check if or if not ROIs shall be calculated is performed within the m_roiFinder findlet to
  // avoid creation and registration of the ROIs and PXDIntercept StoreArrays
  // such that StoreArrays with the same name can be registered elsewhere.
  m_roiFinder.apply(m_trackCandidates);
}

beginEvent()

void beginEvent ( )

overridevirtual

Clear the object pools.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 57 of file SVDHoughTracking.cc.

{
  Super::beginEvent();
 
  // 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<const SpacePoint*>(m_spacePointVector, 5000);
  checkResizeClear<VXDHoughState>(m_vxdHoughStates, 5000);
  checkResizeClear<std::vector<VXDHoughState*>>(m_rawTrackCandidates, 500);
  checkResizeClear<SpacePointTrackCand>(m_trackCandidates, 500);
 
}

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

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

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 33 of file SVDHoughTracking.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  m_spacePointLoaderAndPreparer.exposeParameters(moduleParamList, prefix);
  m_multiHouthSpaceInterceptFinder.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "multi"));
  m_singleHouthSpaceInterceptFinder.exposeParameters(moduleParamList, prefix);
  m_rawTCCleaner.exposeParameters(moduleParamList, prefix);
  m_overlapResolver.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "finalOverlapResolver"));
  m_recoTrackStorer.exposeParameters(moduleParamList, prefix);
  m_roiFinder.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->getParameter<std::string>("relationFilter").setDefaultValue("angleAndTime");
  moduleParamList->getParameter<std::string>("twoHitFilter").setDefaultValue("twoHitVirtualIPQI");
  moduleParamList->getParameter<std::string>("threeHitFilter").setDefaultValue("qualityIndicator");
  moduleParamList->getParameter<std::string>("fourHitFilter").setDefaultValue("qualityIndicator");
  moduleParamList->getParameter<std::string>("fiveHitFilter").setDefaultValue("qualityIndicator");
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "useMultiHoughSpaceInterceptFinding"),
                                m_useMultiHoughSpaceInterceptFinding,
                                "Use Hough spaces working on a subset of hits (=true), or just one Hough space working on all hits at the same time (=false)?",
                                m_useMultiHoughSpaceInterceptFinding);
}

getDescription() [1/2]

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Reimplemented in CosmicsTrackMergerFindlet, FindletStoreArrayInput< TWrappedFindlet >, TrackFinder, TrackFinderAutomaton, and TrackFinderCosmics.

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.

Reimplemented in CosmicsTrackMergerFindlet, FindletStoreArrayInput< TWrappedFindlet >, TrackFinder, TrackFinderAutomaton, and TrackFinderCosmics.

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

Member Data Documentation

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_multiHouthSpaceInterceptFinder

MultiHoughSpaceFastInterceptFinder m_multiHouthSpaceInterceptFinder

private

Hough Space intercept finder.

Definition at line 65 of file SVDHoughTracking.h.

m_overlapResolver

TrackCandidateOverlapResolver m_overlapResolver

private

Resolve hit overlaps in track candidates.

Definition at line 73 of file SVDHoughTracking.h.

m_rawTCCleaner

RawTrackCandCleaner<VXDHoughState> m_rawTCCleaner

private

Raw track candidate cleaner.

Definition at line 70 of file SVDHoughTracking.h.

m_rawTrackCandidates

std::vector<std::vector<VXDHoughState*> > m_rawTrackCandidates

private

Vector containing raw track candidates.

Definition at line 91 of file SVDHoughTracking.h.

m_recoTrackStorer

RecoTrackStorer m_recoTrackStorer

private

Store tracks as RecoTracks.

Definition at line 76 of file SVDHoughTracking.h.

m_roiFinder

ROIFinder m_roiFinder

private

ROIFinder findlet, calculates PXD intercepts and ROIs.

Definition at line 79 of file SVDHoughTracking.h.

m_singleHouthSpaceInterceptFinder

SingleHoughSpaceFastInterceptFinder m_singleHouthSpaceInterceptFinder

private

Simple Hough Space intercept finder.

Definition at line 67 of file SVDHoughTracking.h.

m_spacePointLoaderAndPreparer

SpacePointLoaderAndPreparer m_spacePointLoaderAndPreparer

private

Findlets:

Load SVDSpacePoints and prepare them for Hough-based tracking by calculating the conformal mapped x and y values of the 3D SpacePoint

Definition at line 62 of file SVDHoughTracking.h.

m_spacePointVector

std::vector<const SpacePoint*> m_spacePointVector

private

Container to share data between findlets.

Pointers to the (const) SpacePoints as a vector

Definition at line 85 of file SVDHoughTracking.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.

m_trackCandidates

std::vector<SpacePointTrackCand> m_trackCandidates

private

A track candidate is a vector of SpacePoint, and in each event multiple track candidates will be created, which are stored in a vector themselves.

Definition at line 95 of file SVDHoughTracking.h.

m_useMultiHoughSpaceInterceptFinding

bool m_useMultiHoughSpaceInterceptFinding = false

private

Use the elaborate FastInterceptFinder2D with multiple Hough spaces (true) or the simple one with just one Hough space (false)

Definition at line 99 of file SVDHoughTracking.h.

m_vxdHoughStates

std::vector<VXDHoughState> m_vxdHoughStates

private

Vector containing the cached hit information.

Definition at line 88 of file SVDHoughTracking.h.

---

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

• tracking/vxdHoughTracking/findlets/include/SVDHoughTracking.h
• tracking/vxdHoughTracking/findlets/src/SVDHoughTracking.cc