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
AlignMesType	mesType () const
	returns measurement type of the residual
double	residual () const
	returns residual
double	error () const
	returns error
double	errSq () const
	returns squared error
double	residualNorm () const
	returns normalized residual
ParamDefs	param () const
	returns the ParamDef

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.

    : m_resType(resType)
    , m_mesType(mesType)
    , m_param(param)
    , m_residual(residual)
    , m_errSq(errSq)
    , m_residualNorm(residual/std::sqrt(errSq)) 
  {
    
  }

~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.

{ 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.

{ 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.

{ 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.

{ return m_residual; }

residualNorm()

double Residual::residualNorm ( ) const

inline

returns normalized residual

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

{ return m_residualNorm; }

residualType()

AlignResidualType Residual::residualType ( ) const

inline

returns residual type

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

{ return m_resType; }

Member Data Documentation

m_errSq

double Trk::Residual::m_errSq

private

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

m_mesType

AlignMesType Trk::Residual::m_mesType

private

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

m_param

ParamDefs Trk::Residual::m_param

private

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

m_residual

double Trk::Residual::m_residual

private

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

m_residualNorm

double Trk::Residual::m_residualNorm

private

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

m_resType

AlignResidualType Trk::Residual::m_resType

private

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

---

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

• Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h
• Tracking/TrkAlignment/TrkAlignEvent/src/Residual.cxx