Deletes fake tracks that have been rejected by a filter. More...

#include <TrackQualityEstimator.h>

Inheritance diagram for TrackQualityEstimator:

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
	TrackQualityEstimator (const std::string &defaultFilterName="mva")
	Constructor adding the filter as a subordinary processing signal listener.

std::string	getDescription () final
	Short description of the findlet.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.

void	initialize () override
	Receive and dispatch signal before the start of the event processing.

void	apply (std::vector< CDCTrack > &tracks) final
	Main algorithm.

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 = 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 = Findlet< CDCTrack & >
	Type of the base class.

Private Attributes
CDCMCCloneLookUpFiller	m_mcCloneLookUpFiller
	Findlet to fill CDCTracks into lookup table (singleton) with clone information.

bool	m_needsTruthInformation = false
	Store output of needsTruthInformation from filter in member variable.

bool	m_param_deleteTracks = false
	Delete tracks below threshold instead of just assigning quality indicator.

bool	m_param_resetTakenFlag = false
	Reset taken flag for deleted tracks so that hits can be used by subsequent TFs.

ChooseableFilter< TrackQualityFilterFactory >	m_trackQualityFilter
	Reference to the filter to be used to filter.

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

Deletes fake tracks that have been rejected by a filter.

Definition at line 28 of file TrackQualityEstimator.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 = Findlet<CDCTrack&>

private

Type of the base class.

Definition at line 32 of file TrackQualityEstimator.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ TrackQualityEstimator()

TrackQualityEstimator ( const std::string & defaultFilterName = "mva" )

explicit

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 24 of file TrackQualityEstimator.cc.

  : m_trackQualityFilter(defaultFilterName)
{
  this->addProcessingSignalListener(&m_mcCloneLookUpFiller);
  this->addProcessingSignalListener(&m_trackQualityFilter);
}

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< CDCTrack > & tracks )

final

Main algorithm.

Definition at line 59 of file TrackQualityEstimator.cc.

{
 
  if (m_needsTruthInformation) { m_mcCloneLookUpFiller.apply(tracks); }
  for (CDCTrack& track : tracks) {
    const double qualityIndicator = m_trackQualityFilter(track);
    track.setQualityIndicator(qualityIndicator);
  }
 
  if (m_param_deleteTracks) { // delete track with QI below cut threshold
    auto reject = [this](const CDCTrack & track) {
      const double qualityIndicator = track.getQualityIndicator();
      if (m_param_resetTakenFlag && std::isnan(qualityIndicator)) {
        track.forwardTakenFlag(false);
      }
      return std::isnan(qualityIndicator);
    };
    erase_remove_if(tracks, reject);
  }
}

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

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

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet< CDCTrack & >.

Definition at line 43 of file TrackQualityEstimator.cc.

{
  m_trackQualityFilter.exposeParameters(moduleParamList, prefix);
  m_mcCloneLookUpFiller.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(prefixed(prefix, "deleteTracks"),
                                m_param_deleteTracks,
                                "Delete tracks below cut instead of just assigning quality indicator.",
                                m_param_deleteTracks);
 
  moduleParamList->addParameter(prefixed(prefix, "resetTakenFlag"),
                                m_param_resetTakenFlag,
                                "Reset taken flag for deleted tracks so that hits can be used by subsequent TFs.",
                                m_param_resetTakenFlag);
}

◆ getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCTrack & >.

Definition at line 38 of file TrackQualityEstimator.cc.

{
  return "Set the quality indicator for CDC tracks and, if desired, delete tracks with a too low quality value.";
}

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

overridevirtual

Receive and dispatch signal before the start of the event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file TrackQualityEstimator.cc.

{
  Super::initialize();
  // cache output of needsTruthInformation in member variable
  m_needsTruthInformation = m_trackQualityFilter.needsTruthInformation();
}

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

CDCMCCloneLookUpFiller m_mcCloneLookUpFiller

private

Findlet to fill CDCTracks into lookup table (singleton) with clone information.

Definition at line 52 of file TrackQualityEstimator.h.

◆ m_needsTruthInformation

bool m_needsTruthInformation = false

private

Store output of needsTruthInformation from filter in member variable.

Definition at line 55 of file TrackQualityEstimator.h.

◆ m_param_deleteTracks

bool m_param_deleteTracks = false

private

Delete tracks below threshold instead of just assigning quality indicator.

Definition at line 58 of file TrackQualityEstimator.h.

◆ m_param_resetTakenFlag

bool m_param_resetTakenFlag = false

private

Reset taken flag for deleted tracks so that hits can be used by subsequent TFs.

Definition at line 61 of file TrackQualityEstimator.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.

◆ m_trackQualityFilter

ChooseableFilter<TrackQualityFilterFactory> m_trackQualityFilter

private

Reference to the filter to be used to filter.

Definition at line 64 of file TrackQualityEstimator.h.

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

tracking/trackFindingCDC/findlets/combined/include/TrackQualityEstimator.h
tracking/trackFindingCDC/findlets/combined/src/TrackQualityEstimator.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ TrackQualityEstimator()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_mcCloneLookUpFiller

◆ m_needsTruthInformation

◆ m_param_deleteTracks

◆ m_param_resetTakenFlag

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_trackQualityFilter