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

#include <TrackCandidateResultRefiner.h>

Inheritance diagram for TrackCandidateResultRefiner:

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

	~TrackCandidateResultRefiner ()
	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	beginRun () override
	End run and write Root file.

void	apply (std::vector< SpacePointTrackCand > &unrefinedResults, std::vector< SpacePointTrackCand > &refinedResults) override
	Reject bad SpacePointTrackCands and bad hits inside the remaining.

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	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 = TrackFindingCDC::Findlet< SpacePointTrackCand, SpacePointTrackCand >
	Parent class.

Private Attributes
std::string	m_EstimationMethod = "tripletFit"
	Identifier which estimation method to use.

std::string	m_MCRecoTracksStoreArrayName = "MCRecoTracks"
	sets the name of the expected StoreArray containing MCRecoTracks. Only required for MCInfo method

bool	m_MCStrictQualityEstimator = true
	Only required for MCInfo method.

std::unique_ptr< QualityEstimatorBase >	m_estimator
	pointer to the selected QualityEstimator

TrackCandidateOverlapResolver	m_overlapResolver
	Resolve hit overlaps in track candidates.

double	m_minQualitiyIndicatorSize3 = 0.5
	Cut on the quality estimator and only further propagate SPTCs with three hits that are above this value.

double	m_minQualitiyIndicatorSize4 = 0.5
	Cut on the quality estimator and only further propagate SPTCs with four hits that are above this value.

double	m_minQualitiyIndicatorSize5 = 0.5
	Cut on the quality estimator and only further propagate SPTCs with five hits that are above this value.

uint	m_maxNumberOfEachPathLength = 15
	Accept nHits for each size at maximum.

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

Findlet for rejecting wrong SpacePointTrackCands and for removing bad hits.

Definition at line 29 of file TrackCandidateResultRefiner.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 = TrackFindingCDC::Findlet<SpacePointTrackCand, SpacePointTrackCand>

private

Parent class.

Definition at line 31 of file TrackCandidateResultRefiner.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ TrackCandidateResultRefiner()

TrackCandidateResultRefiner ( )

Find intercepts in the 2D Hough space.

Definition at line 26 of file TrackCandidateResultRefiner.cc.

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

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< SpacePointTrackCand > &	unrefinedResults,
		std::vector< SpacePointTrackCand > &	refinedResults
	)

override

Reject bad SpacePointTrackCands and bad hits inside the remaining.

Definition at line 95 of file TrackCandidateResultRefiner.cc.

{
  refinedResults.clear();
  std::vector<SpacePointTrackCand> selectedResults;
  selectedResults.reserve(unrefinedResults.size());
  // assign a QI computed using the selected QualityEstimator for each given SpacePointTrackCand
  for (SpacePointTrackCand& aTrackCandidate : unrefinedResults) {
    double qi = m_estimator->estimateQuality(aTrackCandidate.getSortedHits());
    aTrackCandidate.setQualityIndicator(qi);
 
    // Track candidates of size >= 6 are very rare. If the track candidate already is quite long (>= 6 hits),
    // it's very likely it's a valid track anyway, so QI is not checked.
    if ((aTrackCandidate.getNHits() == 3 and qi >= m_minQualitiyIndicatorSize3) or
        (aTrackCandidate.getNHits() == 4 and qi >= m_minQualitiyIndicatorSize4) or
        (aTrackCandidate.getNHits() == 5 and qi >= m_minQualitiyIndicatorSize5) or
        (aTrackCandidate.getNHits() >= 6))  {
      selectedResults.emplace_back(aTrackCandidate);
    }
  }
 
  // return early if nothing to do
  if (selectedResults.size() <= 1) {
    std::swap(selectedResults, refinedResults);
    return;
  }
 
  // sort by number of hits in the track candidate and by the QI
  std::sort(selectedResults.begin(), selectedResults.end(),
  [](const SpacePointTrackCand & a, const SpacePointTrackCand & b) {
    return ((a.getNHits() > b.getNHits()) or
            (a.getNHits() == b.getNHits() and a.getQualityIndicator() > b.getQualityIndicator()));
  });
 
  std::array<uint, 8> numberOfHitsInCheckedSPTCs{{0, 0, 0, 0, 0, 0, 0, 0}};
  refinedResults.reserve(selectedResults.size());
  for (auto& currentSPTC : selectedResults) {
    if (numberOfHitsInCheckedSPTCs[currentSPTC.size()] < m_maxNumberOfEachPathLength) {
      numberOfHitsInCheckedSPTCs[currentSPTC.size()] += 1;
      refinedResults.emplace_back(currentSPTC);
    }
  }
 
  m_overlapResolver.apply(refinedResults);
}

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

overridevirtual

End run and write Root file.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 81 of file TrackCandidateResultRefiner.cc.

{
  Super::beginRun();
 
  // BField is required by all QualityEstimators
  double bFieldZ = BFieldManager::getField(0, 0, 0).Z() / Unit::T;
  m_estimator->setMagneticFieldStrength(bFieldZ);
 
  if (m_EstimationMethod == "mcInfo") {
    QualityEstimatorMC* MCestimator = static_cast<QualityEstimatorMC*>(m_estimator.get());
    MCestimator->forceUpdateClusterNames();
  }
}

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

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from Findlet< SpacePointTrackCand, SpacePointTrackCand >.

Definition at line 31 of file TrackCandidateResultRefiner.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  m_overlapResolver.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "refinerOverlapResolver"));
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "trackQualityEstimationMethod"), m_EstimationMethod,
                                "Identifier which estimation method to use. Valid identifiers are: [mcInfo, circleFit, tripletFit, helixFit]",
                                m_EstimationMethod);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "MCRecoTracksStoreArrayName"), m_MCRecoTracksStoreArrayName,
                                "Only required for MCInfo method. Name of StoreArray containing MCRecoTracks.",
                                m_MCRecoTracksStoreArrayName);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "MCStrictQualityEstimator"), m_MCStrictQualityEstimator,
                                "Only required for MCInfo method. If false combining several MCTracks is allowed.",
                                m_MCStrictQualityEstimator);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "minQualitiyIndicatorSize3"), m_minQualitiyIndicatorSize3,
                                "Cut on quality indicator value for track candidates of size 3. Only accept SpacePointTrackCands with QI above this value.",
                                m_minQualitiyIndicatorSize3);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "minQualitiyIndicatorSize4"), m_minQualitiyIndicatorSize4,
                                "Cut on quality indicator value for track candidates of size 4. Only accept SpacePointTrackCands with QI above this value.",
                                m_minQualitiyIndicatorSize4);
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "minQualitiyIndicatorSize5"), m_minQualitiyIndicatorSize5,
                                "Cut on quality indicator value for track candidates of size 5. Only accept SpacePointTrackCands with QI above this value.",
                                m_minQualitiyIndicatorSize5);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "maxNumberOfEachPathLength"), m_maxNumberOfEachPathLength,
                                "Maximum number of SpacePointTrackCands with a length of 3, 4, 5, or 6 each.",
                                m_maxNumberOfEachPathLength);
}

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

overridevirtual

Create the store arrays.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 62 of file TrackCandidateResultRefiner.cc.

{
  Super::initialize();
 
  // create pointer to chosen estimator
  if (m_EstimationMethod == "mcInfo") {
    StoreArray<RecoTrack> mcRecoTracks;
    mcRecoTracks.isRequired(m_MCRecoTracksStoreArrayName);
    m_estimator = std::make_unique<QualityEstimatorMC>(m_MCRecoTracksStoreArrayName, m_MCStrictQualityEstimator);
  } else if (m_EstimationMethod == "tripletFit") {
    m_estimator = std::make_unique<QualityEstimatorTripletFit>();
  } else if (m_EstimationMethod == "circleFit") {
    m_estimator = std::make_unique<QualityEstimatorCircleFit>();
  } else if (m_EstimationMethod == "helixFit") {
    m_estimator = std::make_unique<QualityEstimatorRiemannHelixFit>();
  }
  B2ASSERT("QualityEstimator could not be initialized with method: " << m_EstimationMethod, m_estimator);
}

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

std::string m_EstimationMethod = "tripletFit"

private

Identifier which estimation method to use.

Valid identifiers are: mcInfo, circleFit, tripletFit, helixFit

Definition at line 55 of file TrackCandidateResultRefiner.h.

◆ m_estimator

std::unique_ptr<QualityEstimatorBase> m_estimator

private

pointer to the selected QualityEstimator

Definition at line 61 of file TrackCandidateResultRefiner.h.

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

uint m_maxNumberOfEachPathLength = 15

private

Accept nHits for each size at maximum.

Definition at line 74 of file TrackCandidateResultRefiner.h.

◆ m_MCRecoTracksStoreArrayName

std::string m_MCRecoTracksStoreArrayName = "MCRecoTracks"

private

sets the name of the expected StoreArray containing MCRecoTracks. Only required for MCInfo method

Definition at line 57 of file TrackCandidateResultRefiner.h.

◆ m_MCStrictQualityEstimator

bool m_MCStrictQualityEstimator = true

private

Only required for MCInfo method.

Definition at line 59 of file TrackCandidateResultRefiner.h.

◆ m_minQualitiyIndicatorSize3

double m_minQualitiyIndicatorSize3 = 0.5

private

Cut on the quality estimator and only further propagate SPTCs with three hits that are above this value.

Definition at line 67 of file TrackCandidateResultRefiner.h.

◆ m_minQualitiyIndicatorSize4

double m_minQualitiyIndicatorSize4 = 0.5

private

Cut on the quality estimator and only further propagate SPTCs with four hits that are above this value.

Definition at line 69 of file TrackCandidateResultRefiner.h.

◆ m_minQualitiyIndicatorSize5

double m_minQualitiyIndicatorSize5 = 0.5

private

Cut on the quality estimator and only further propagate SPTCs with five hits that are above this value.

Definition at line 71 of file TrackCandidateResultRefiner.h.

◆ m_overlapResolver

TrackCandidateOverlapResolver m_overlapResolver

private

Resolve hit overlaps in track candidates.

Definition at line 64 of file TrackCandidateResultRefiner.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.

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

tracking/vxdHoughTracking/findlets/include/TrackCandidateResultRefiner.h
tracking/vxdHoughTracking/findlets/src/TrackCandidateResultRefiner.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

◆ TrackCandidateResultRefiner()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_EstimationMethod

◆ m_estimator

◆ m_initialized

◆ m_initializedAs

◆ m_maxNumberOfEachPathLength

◆ m_MCRecoTracksStoreArrayName

◆ m_MCStrictQualityEstimator

◆ m_minQualitiyIndicatorSize3

◆ m_minQualitiyIndicatorSize4

◆ m_minQualitiyIndicatorSize5

◆ m_overlapResolver

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated