ATLAS Offline Software
Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef TRKALIGNEVENT_RESIDUAL_H
6 #define TRKALIGNEVENT_RESIDUAL_H
7 
20 #include <cmath>
21 
22 namespace Trk {
23 
24  class Residual {
25 
26  public:
28  ~Residual() = default;
29 
32 
34  AlignMesType mesType() const;
35 
37  double residual() const;
38 
40  double error() const;
41 
43  double errSq() const;
44 
46  double residualNorm() const;
47 
49  ParamDefs param() const;
50 
51  private:
52  AlignResidualType m_resType; // type of the residual
53  AlignMesType m_mesType; // TSOS type for the residual
55  double m_residual;
56  double m_errSq;
58 
59  }; // end class
60 
61 
62  inline double Residual::residual() const { return m_residual; }
63 
64  inline double Residual::error() const { return std::sqrt(m_errSq); }
65 
66  inline double Residual::errSq() const { return m_errSq; }
67 
68  inline double Residual::residualNorm() const { return m_residualNorm; }
69 
71 
72  inline AlignMesType Residual::mesType() const { return m_mesType; }
73 }
74 
75 #endif // TRKALIGNEVENT_RESIDUAL_H
Trk::Residual::m_param
ParamDefs m_param
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:54
Trk::Residual::~Residual
~Residual()=default
Trk::Residual::m_mesType
AlignMesType m_mesType
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:53
Trk::ParamDefs
ParamDefs
Definition: ParamDefs.h:38
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
AlignResidualType.h
ParamDefs.h
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::residualNorm
double residualNorm() const
returns normalized residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:68
Trk
Ensure that the ATLAS eigen extensions are properly loaded.
Definition: FakeTrackBuilder.h:9
Trk::Residual::Residual
Residual(AlignResidualType resType, AlignMesType mesType, ParamDefs param, double residual, double errSq)
Definition: Tracking/TrkAlignment/TrkAlignEvent/src/Residual.cxx:9
Trk::Residual::m_errSq
double m_errSq
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:56
Trk::Residual::error
double error() const
returns error
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:64
Trk::Residual::mesType
AlignMesType mesType() const
returns measurement type of the residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:72
AlignResidualType
AlignResidualType is an enum describing the type of residual AlignMesType is an enum describing the t...
Trk::Residual
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:24
Trk::Residual::residualType
AlignResidualType residualType() const
returns residual type
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:70
Trk::Residual::m_residualNorm
double m_residualNorm
Definition: Tracking/TrkAlignment/TrkAlignEvent/TrkAlignEvent/Residual.h:57
Trk::AlignMesType
AlignMesType
Definition: AlignResidualType.h:32