ATLAS Offline Software
Public Member Functions | Protected Attributes | List of all members
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. More...
 
std::unique_ptr< FitQualityuniqueClone () const
 NVI uniqueClone. More...
 
 FitQualityImpl ()=default
 default ctor for POOL More...
 
 FitQualityImpl (const FitQualityImpl &)=default
 
 FitQualityImpl (FitQualityImpl &&)=default
 
 FitQualityImpl (double chiSquared, int numberDoF)
 Constructor with \( \chi^2 \) and \( n_{dof} \). More...
 
 FitQualityImpl (double chiSquared, double numberDoF)
 Constructor hadling double type of NDF. More...
 
FitQualityImploperator= (const FitQualityImpl &)=default
 
FitQualityImploperator= (FitQualityImpl &&)=default
 
double chiSquared () const
 returns the \( \chi^2 \) of the overall track fit More...
 
double doubleNumberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as double More...
 
int numberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as integer More...
 
void setChiSquared (double chiSquared)
 set the \( \chi^2 \) More...
 
void setNumberDoF (double numberDoF)
 set the number of degrees of freedom More...
 
double chiSquared () const
 returns the \( \chi^2 \) of the overall track fit More...
 
int numberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as integer More...
 
double doubleNumberDoF () const
 returns the number of degrees of freedom of the overall track or vertex fit as double More...
 
void setChiSquared (double chiSquared)
 set the \( \chi^2 \) More...
 
void setNumberDoF (double numberDoF)
 set the number of degrees of freedom More...
 

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  }

◆ ~FitQuality()

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

Member Function Documentation

◆ chiSquared() [1/2]

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

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

Definition at line 56 of file FitQuality.h.

56 { return m_chiSquared; }

◆ chiSquared() [2/2]

double Trk::FitQualityImpl::chiSquared
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() [1/2]

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

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; }

◆ doubleNumberDoF() [2/2]

double Trk::FitQualityImpl::doubleNumberDoF
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
default

◆ FitQualityImpl() [3/5]

Trk::FitQualityImpl::FitQualityImpl
inline

Constructor hadling double type of NDF.

Definition at line 49 of file FitQuality.h.

52  {
53  }

◆ FitQualityImpl() [4/5]

Trk::FitQualityImpl::FitQualityImpl
inline

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

Definition at line 42 of file FitQuality.h.

45  {
46  }

◆ FitQualityImpl() [5/5]

Trk::FitQualityImpl::FitQualityImpl
default

◆ numberDoF() [1/2]

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

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  }

◆ numberDoF() [2/2]

int Trk::FitQualityImpl::numberDoF
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=
default

◆ operator=() [2/2]

FitQualityImpl& Trk::FitQualityImpl::operator=
default

◆ setChiSquared() [1/2]

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

set the \( \chi^2 \)

Definition at line 71 of file FitQuality.h.

◆ setChiSquared() [2/2]

void Trk::FitQualityImpl::setChiSquared
inline

set the \( \chi^2 \)

Definition at line 71 of file FitQuality.h.

◆ setNumberDoF() [1/2]

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

set the number of degrees of freedom

Definition at line 74 of file FitQuality.h.

◆ setNumberDoF() [2/2]

void Trk::FitQualityImpl::setNumberDoF
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.

◆ m_numberDoF

double Trk::FitQualityImpl::m_numberDoF {}
protectedinherited

Definition at line 82 of file FitQuality.h.


The documentation for this class was generated from the following file:
Trk::FitQualityImpl::FitQualityImpl
FitQualityImpl()=default
default ctor for POOL
Trk::FitQualityImpl::chiSquared
double chiSquared() const
returns the of the overall track fit
Definition: FitQuality.h:56
Trk::FitQualityImpl::m_numberDoF
double m_numberDoF
Definition: FitQuality.h:82
Trk::FitQualityImpl::numberDoF
int numberDoF() const
returns the number of degrees of freedom of the overall track or vertex fit as integer
Definition: FitQuality.h:60
Trk::FitQualityImpl::m_chiSquared
double m_chiSquared
Definition: FitQuality.h:81