Algorithm to collect the x best TrackCandidates per family based on a VXD Quality estimator method output. More...

#include <SPTCSelectorXBestPerFamily.h>

Public Member Functions
	SPTCSelectorXBestPerFamily (unsigned short xBest=5, const std::string &estimationMethod=std::string("tripletFit"))
	Constructor for the selection of the x best candidates for each family based on the quality index.

	~SPTCSelectorXBestPerFamily ()=default
	Destructor.

void	prepareSelector (unsigned short nFamilies)
	Preparation of Best Candidate Selector by resetting the vectors.

void	testNewSPTC (SpacePointTrackCand &sptc)
	Test new SPTC if it is better than the least best of the current x best SPTCs of its respective family.

std::vector< SpacePointTrackCand >	returnSelection () const
	Return vector containing the best SPTCs; maximal m_xBest per family.

void	setMagneticFieldForQE (double bFieldZ)
	Setting magnetic field for the quality estimator.

Private Attributes
std::unique_ptr< QualityEstimatorBase >	m_estimator
	Pointer to the Quality Estimator used to evaluate the SPTCs to find the best.

std::vector< std::multiset< SpacePointTrackCand > >	m_bestPaths
	Vector containing one vector of the best SPTCs per family.

std::vector< short >	m_familyToIndex
	Map of family number to respective index for m_bestPaths.

unsigned short	m_currentIndex = 0
	Counter for current index used for m_familyToIndex.

unsigned short	m_xBest
	Number of allowed best SPTCs per family.

Detailed Description

Algorithm to collect the x best TrackCandidates per family based on a VXD Quality estimator method output.

Definition at line 29 of file SPTCSelectorXBestPerFamily.h.

Constructor & Destructor Documentation

◆ SPTCSelectorXBestPerFamily()

SPTCSelectorXBestPerFamily	(	unsigned short	xBest = `5`,
		const std::string &	estimationMethod = `std::string("tripletFit")`
	)

inline

Constructor for the selection of the x best candidates for each family based on the quality index.

Parameters

xBest	Maximal number of best candidates to be stored per family.
estimationMethod	Quality estimator to be used.

Definition at line 38 of file SPTCSelectorXBestPerFamily.h.

                                                                                                                     :
      m_xBest(xBest)
    {
      if (estimationMethod == "tripletFit") {
        m_estimator = std::make_unique<QualityEstimatorTripletFit>();
      } else if (estimationMethod == "circleFit") {
        m_estimator = std::make_unique<QualityEstimatorCircleFit>();
      } else if (estimationMethod == "helixFit") {
        m_estimator = std::make_unique<QualityEstimatorRiemannHelixFit>();
      } else if (estimationMethod == "random") {
        m_estimator = std::make_unique<QualityEstimatorRandom>();
      }
      B2ASSERT("QualityEstimator could not be initialized with method: " << estimationMethod, m_estimator);
    };

Member Function Documentation

◆ prepareSelector()

void prepareSelector ( unsigned short nFamilies )

inline

Preparation of Best Candidate Selector by resetting the vectors.

To be executed at the beginning of a new event after the families are defined to reset the respective vectors and set them up under consideration of the number of families in the event.

Parameters

nFamilies Number of families in the event.

Definition at line 61 of file SPTCSelectorXBestPerFamily.h.

    {
      m_bestPaths.clear();
      m_familyToIndex.clear();
      m_bestPaths.reserve(nFamilies);
      m_familyToIndex.resize(nFamilies, -1);
 
      m_currentIndex = 0;
    }

◆ returnSelection()

std::vector< SpacePointTrackCand > returnSelection ( ) const

inline

Return vector containing the best SPTCs; maximal m_xBest per family.

Returns: One vector containing the best SPTC candidates for the whole event.

Definition at line 103 of file SPTCSelectorXBestPerFamily.h.

    {
      std::vector<SpacePointTrackCand> jointBestPaths;
      jointBestPaths.reserve(std::accumulate(m_bestPaths.begin(), m_bestPaths.end(), 0,
      [](int a, auto b) { return a + b.size(); }));
 
      for (auto&& set : m_bestPaths) {
        jointBestPaths.insert(jointBestPaths.end(), set.begin(), set.end());
      }
 
      return jointBestPaths;
    }

◆ setMagneticFieldForQE()

void setMagneticFieldForQE ( double bFieldZ )

inline

Setting magnetic field for the quality estimator.

Parameters

bFieldZ Magnetic Field value to be used for the Quality Estimation.

Definition at line 119 of file SPTCSelectorXBestPerFamily.h.

    {
      m_estimator->setMagneticFieldStrength(bFieldZ);
    }

◆ testNewSPTC()

void testNewSPTC ( SpacePointTrackCand & sptc )

inline

Test new SPTC if it is better than the least best of the current x best SPTCs of its respective family.

If so, the least best is thrown out, and the new is added to the sorted x best SPTC multiset of the family. If the maximal number of best SPTCs is not reached for the family, yet, the SPTC is just added at the right place.

Parameters

sptc	SpacePointTrackCandidate to be evaluated for adding.

Definition at line 76 of file SPTCSelectorXBestPerFamily.h.

    {
      sptc.setQualityIndicator(m_estimator->estimateQuality(sptc.getSortedHits()));
      short family = sptc.getFamily();
 
      if (m_familyToIndex.at(family) == -1) {
        m_bestPaths.emplace_back(std::multiset<SpacePointTrackCand> { sptc });
        m_familyToIndex.at(family) = m_currentIndex;
        m_currentIndex++;
        return;
      }
 
      auto& currentSet = m_bestPaths.at(m_familyToIndex[family]);
 
      if (currentSet.size() == m_xBest) {
        std::multiset<SpacePointTrackCand>::iterator iter = currentSet.begin();
        if (sptc.getQualityIndicator() < iter->getQualityIndicator()) {
          return;
        }
        currentSet.erase(iter);
      }
      currentSet.emplace_hint(currentSet.cbegin(), sptc);
    }

Member Data Documentation

◆ m_bestPaths

std::vector<std::multiset<SpacePointTrackCand> > m_bestPaths

private

Vector containing one vector of the best SPTCs per family.

Definition at line 130 of file SPTCSelectorXBestPerFamily.h.

◆ m_currentIndex

unsigned short m_currentIndex = 0

private

Counter for current index used for m_familyToIndex.

The counter is increased each time a family is seen for the first time and thus a new entry for this family is added to m_familyToIndex.

Definition at line 137 of file SPTCSelectorXBestPerFamily.h.

◆ m_estimator

std::unique_ptr<QualityEstimatorBase> m_estimator

private

Pointer to the Quality Estimator used to evaluate the SPTCs to find the best.

Definition at line 127 of file SPTCSelectorXBestPerFamily.h.

◆ m_familyToIndex

std::vector<short> m_familyToIndex

private

Map of family number to respective index for m_bestPaths.

Definition at line 133 of file SPTCSelectorXBestPerFamily.h.

◆ m_xBest

unsigned short m_xBest

private

Number of allowed best SPTCs per family.

Definition at line 140 of file SPTCSelectorXBestPerFamily.h.

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

tracking/trackFindingVXD/algorithms/include/SPTCSelectorXBestPerFamily.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SPTCSelectorXBestPerFamily()

Member Function Documentation

◆ prepareSelector()

◆ returnSelection()

◆ setMagneticFieldForQE()

◆ testNewSPTC()

Member Data Documentation

◆ m_bestPaths

◆ m_currentIndex

◆ m_estimator

◆ m_familyToIndex

◆ m_xBest