BaseClass for QualityEstimators. More...

#include <QualityEstimatorBase.h>

Inheritance diagram for QualityEstimatorBase:

Public Member Functions
	QualityEstimatorBase ()
	Constructor.

virtual	~QualityEstimatorBase ()=default
	Destructor.

void	setMagneticFieldStrength (double magneticFieldZ=1.5)
	Setter for z component of magnetic field.

virtual double	estimateQuality (std::vector< SpacePoint const * > const &measurements)=0
	Minimal implementation of the quality estimation Calculates quality indicator in range [0,1].

virtual QualityEstimationResults	estimateQualityAndProperties (std::vector< SpacePoint const * > const &measurements)
	Quality estimation providing additional quantities Calculates quality indicator in range [0,1] Optionally returns chi2 and additional extra information.

Protected Member Functions
double	calcPt (double const radius) const
	Returns a value for the transverse momentum in GeV calculated from a provided radius.

Protected Attributes
double	m_magneticFieldZ = 1.5
	Member storing the z component of the magnetic field.

QualityEstimationResults	m_results
	Result of the quality estimation This is stored as a member variable, because some values may be calculated by 'estimateQuality' anyways.

Detailed Description

BaseClass for QualityEstimators.

m_magneticFieldZ - Z component of magnetic field m_results - Member object storing all optional results. estimateQuality - Minimal implementation of the quality estimation estimateQualityAndProperties - Additionally calculates other properties that can be derived from the fit.

Definition at line 41 of file QualityEstimatorBase.h.

Constructor & Destructor Documentation

◆ QualityEstimatorBase()

QualityEstimatorBase ( )

inline

Constructor.

Definition at line 45 of file QualityEstimatorBase.h.

45{}

Member Function Documentation

◆ calcPt()

double calcPt ( double const radius ) const

inlineprotected

Returns a value for the transverse momentum in GeV calculated from a provided radius.

Utilizing m_magneticFieldZ and hard coded speed of light

Definition at line 80 of file QualityEstimatorBase.h.

80{ return m_magneticFieldZ * radius * 0.00299792458; }

Belle2::QualityEstimatorBase::m_magneticFieldZ

double m_magneticFieldZ

Member storing the z component of the magnetic field.

Definition: QualityEstimatorBase.h:84

◆ estimateQuality()

virtual double estimateQuality ( std::vector< SpacePoint const * > const & measurements )

pure virtual

Minimal implementation of the quality estimation Calculates quality indicator in range [0,1].

measurements - std::vector<SpacePoint const*> ordered from innermost to outermost measurement

Implemented in QualityEstimatorRandom, QualityEstimatorCircleFit, QualityEstimatorLineFit3D, QualityEstimatorMC, QualityEstimatorRiemannHelixFit, and QualityEstimatorTripletFit.

◆ estimateQualityAndProperties()

virtual QualityEstimationResults estimateQualityAndProperties ( std::vector< SpacePoint const * > const & measurements )

inlinevirtual

Quality estimation providing additional quantities Calculates quality indicator in range [0,1] Optionally returns chi2 and additional extra information.

Eg. momentum estimation.

measurements - std::vector<SpacePoint const*> ordered from innermost to outermost measurement

Reimplemented in QualityEstimatorTripletFit, and QualityEstimatorMC.

Definition at line 68 of file QualityEstimatorBase.h.

    {
      m_results = QualityEstimationResults();
      m_results.qualityIndicator = estimateQuality(measurements);
      return m_results;
    }

◆ setMagneticFieldStrength()

void setMagneticFieldStrength ( double magneticFieldZ = 1.5 )

inline

Setter for z component of magnetic field.

Parameters

magneticFieldZ : value to set it to

Definition at line 53 of file QualityEstimatorBase.h.

53{m_magneticFieldZ = magneticFieldZ;}

Member Data Documentation

◆ m_magneticFieldZ

double m_magneticFieldZ = 1.5

protected

Member storing the z component of the magnetic field.

Definition at line 84 of file QualityEstimatorBase.h.

◆ m_results

QualityEstimationResults m_results

protected

Result of the quality estimation This is stored as a member variable, because some values may be calculated by 'estimateQuality' anyways.

Therefore they don't need to be calculated explicitly in 'estimateQualityAndProperties'.

Definition at line 90 of file QualityEstimatorBase.h.

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

tracking/trackFindingVXD/trackQualityEstimators/include/QualityEstimatorBase.h

Public Member Functions

Protected Member Functions

Protected Attributes