ATLAS Offline Software
Loading...
Searching...
No Matches
Trk::FitQuality Class Reference

Class to represent and store fit qualities from track reconstruction in terms of \(\chi^2\) and number of degrees of freedom. More...

#include <FitQuality.h>

Inheritance diagram for Trk::FitQuality:
Collaboration diagram for Trk::FitQuality:

Public Member Functions

 FitQuality (const FitQualityImpl &fq)
virtual ~FitQuality ()=default
virtual FitQualityclone () const
 Virtual constructor.
std::unique_ptr< FitQualityuniqueClone () const
 NVI uniqueClone.
 FitQualityImpl ()=default
 default ctor for POOL
 FitQualityImpl (const FitQualityImpl &)=default
 FitQualityImpl (FitQualityImpl &&)=default
 FitQualityImpl (double chiSquared, int numberDoF)
 Constructor with \( \chi^2 \) and \( n_{dof} \).
 FitQualityImpl (double chiSquared, double numberDoF)
 Constructor hadling double type of NDF.
FitQualityImploperator= (const FitQualityImpl &)=default
FitQualityImploperator= (FitQualityImpl &&)=default
double chiSquared () const
 returns the \( \chi^2 \) of the overall track fit
double doubleNumberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as double
int numberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as integer
void setChiSquared (double chiSquared)
 set the \( \chi^2 \)
void setNumberDoF (double numberDoF)
 set the number of degrees of freedom

Protected Attributes

double m_chiSquared {}
double m_numberDoF {}

Detailed Description

Class to represent and store fit qualities from track reconstruction in terms of \(\chi^2\) and number of degrees of freedom.

Its main use is to describe the trajectory fit quality at a measurement and of the overall track. However, it can be extended as necessary.

Author
Edwar.nosp@m.d.Mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch, Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 96 of file FitQuality.h.

Constructor & Destructor Documentation

◆ FitQuality()

Trk::FitQuality::FitQuality ( const FitQualityImpl & fq)
inline

Definition at line 111 of file FitQuality.h.

112 : FitQualityImpl(fq.chiSquared(), fq.doubleNumberDoF())
113 {
114 }
FitQualityImpl()=default
default ctor for POOL

◆ ~FitQuality()

virtual Trk::FitQuality::~FitQuality ( )
virtualdefault

Member Function Documentation

◆ chiSquared()

double Trk::FitQualityImpl::chiSquared ( ) const
inline

returns the \( \chi^2 \) of the overall track fit

Definition at line 56 of file FitQuality.h.

56{ return m_chiSquared; }

◆ clone()

virtual FitQuality * Trk::FitQuality::clone ( ) const
virtual

Virtual constructor.

Reimplemented in Muon::MuonSegmentQuality.

◆ doubleNumberDoF()

double Trk::FitQualityImpl::doubleNumberDoF ( ) const
inline

returns the number of degrees of freedom of the overall track or vertex fit as double

Definition at line 68 of file FitQuality.h.

68{ return m_numberDoF; }

◆ FitQualityImpl() [1/5]

Trk::FitQualityImpl::FitQualityImpl ( )
default

default ctor for POOL

◆ FitQualityImpl() [2/5]

Trk::FitQualityImpl::FitQualityImpl ( const FitQualityImpl & )
default

◆ FitQualityImpl() [3/5]

Trk::FitQualityImpl::FitQualityImpl ( double chiSquared,
double numberDoF )
inline

Constructor hadling double type of NDF.

Definition at line 49 of file FitQuality.h.

52 {
53 }
int numberDoF() const
returns the number of degrees of freedom of the overall track or vertex fit as integer
Definition FitQuality.h:60
double chiSquared() const
returns the of the overall track fit
Definition FitQuality.h:56

◆ FitQualityImpl() [4/5]

Trk::FitQualityImpl::FitQualityImpl ( double chiSquared,
int numberDoF )
inline

Constructor with \( \chi^2 \) and \( n_{dof} \).

Definition at line 42 of file FitQuality.h.

◆ FitQualityImpl() [5/5]

Trk::FitQualityImpl::FitQualityImpl ( FitQualityImpl && )
default

◆ numberDoF()

int Trk::FitQualityImpl::numberDoF ( ) const
inline

returns the number of degrees of freedom of the overall track or vertex fit as integer

Definition at line 60 of file FitQuality.h.

61 {
62
63 return static_cast<int>(std::floor(m_numberDoF + 0.5));
64 }

◆ operator=() [1/2]

FitQualityImpl & Trk::FitQualityImpl::operator= ( const FitQualityImpl & )
default

◆ operator=() [2/2]

FitQualityImpl & Trk::FitQualityImpl::operator= ( FitQualityImpl && )
default

◆ setChiSquared()

void Trk::FitQualityImpl::setChiSquared ( double chiSquared)
inline

set the \( \chi^2 \)

Definition at line 71 of file FitQuality.h.

◆ setNumberDoF()

void Trk::FitQualityImpl::setNumberDoF ( double numberDoF)
inline

set the number of degrees of freedom

Definition at line 74 of file FitQuality.h.

◆ uniqueClone()

std::unique_ptr< FitQuality > Trk::FitQuality::uniqueClone ( ) const

NVI uniqueClone.

Member Data Documentation

◆ m_chiSquared

double Trk::FitQualityImpl::m_chiSquared {}
protectedinherited

Definition at line 81 of file FitQuality.h.

81{};

◆ m_numberDoF

double Trk::FitQualityImpl::m_numberDoF {}
protectedinherited

Definition at line 82 of file FitQuality.h.

82{};

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