ATLAS Offline Software
Public Member Functions | Private Attributes | List of all members
Trk::Residual Class Reference

#include <Residual.h>

Collaboration diagram for Trk::Residual:

Public Member Functions

 Residual (AlignResidualType resType, AlignMesType mesType, ParamDefs param, double residual, double errSq)
 
 ~Residual ()=default
 
AlignResidualType residualType () const
 returns residual type More...
 
AlignMesType mesType () const
 returns measurement type of the residual More...
 
double residual () const
 returns residual More...
 
double error () const
 returns error More...
 
double errSq () const
 returns squared error More...
 
double residualNorm () const
 returns normalized residual More...
 
ParamDefs param () const
 returns the ParamDef More...
 

Private Attributes

AlignResidualType m_resType
 
AlignMesType m_mesType
 
ParamDefs m_param
 
double m_residual
 
double m_errSq
 
double m_residualNorm
 

Detailed Description

Definition at line 24 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

Constructor & Destructor Documentation

◆ Residual()

Residual::Residual ( AlignResidualType  resType,
AlignMesType  mesType,
ParamDefs  param,
double  residual,
double  errSq 
)

Definition at line 9 of file Tracking/TrkAlignment/TrkAlignEvent/src/Residual.cxx.

10  : m_resType(resType)
12  , m_param(param)
14  , m_errSq(errSq)
15  , m_residualNorm(residual/std::sqrt(errSq))
16  {
17 
18  }

◆ ~Residual()

Trk::Residual::~Residual ( )
default

Member Function Documentation

◆ error()

double Residual::error ( ) const
inline

returns error

Definition at line 64 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

64 { return std::sqrt(m_errSq); }

◆ errSq()

double Residual::errSq ( ) const
inline

returns squared error

Definition at line 66 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

66 { return m_errSq; }

◆ mesType()

AlignMesType Residual::mesType ( ) const
inline

returns measurement type of the residual

Definition at line 72 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

72 { return m_mesType; }

◆ param()

ParamDefs Trk::Residual::param ( ) const

returns the ParamDef

◆ residual()

double Residual::residual ( ) const
inline

returns residual

Definition at line 62 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

62 { return m_residual; }

◆ residualNorm()

double Residual::residualNorm ( ) const
inline

returns normalized residual

Definition at line 68 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

68 { return m_residualNorm; }

◆ residualType()

AlignResidualType Residual::residualType ( ) const
inline

returns residual type

Definition at line 70 of file Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h.

70 { return m_resType; }

Member Data Documentation

◆ m_errSq

double Trk::Residual::m_errSq
private

◆ m_mesType

AlignMesType Trk::Residual::m_mesType
private

◆ m_param

ParamDefs Trk::Residual::m_param
private

◆ m_residual

double Trk::Residual::m_residual
private

◆ m_residualNorm

double Trk::Residual::m_residualNorm
private

◆ m_resType

AlignResidualType Trk::Residual::m_resType
private

The documentation for this class was generated from the following files:
Trk::Residual::m_param
ParamDefs m_param
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:54
Trk::Residual::m_mesType
AlignMesType m_mesType
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:53
Trk::Residual::errSq
double errSq() const
returns squared error
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:66
Trk::Residual::param
ParamDefs param() const
returns the ParamDef
Trk::Residual::residual
double residual() const
returns residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:62
Trk::Residual::m_residual
double m_residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:55
Trk::Residual::m_resType
AlignResidualType m_resType
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:52
Trk::Residual::m_errSq
double m_errSq
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:56
Trk::Residual::mesType
AlignMesType mesType() const
returns measurement type of the residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:72
Trk::Residual::m_residualNorm
double m_residualNorm
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:57