ATLAS Offline Software
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Trk::SpacePoint Class Referenceabstract

#include <SpacePoint.h>

Inheritance diagram for Trk::SpacePoint:
Collaboration diagram for Trk::SpacePoint:

Public Member Functions

 SpacePoint ()
 
virtual ~SpacePoint ()=default
 
const std::pair< IdentifierHash, IdentifierHash > & elementIdList () const
 return the pair of Ids of the element by reference More...
 
const std::pair< const PrepRawData *, const PrepRawData * > & clusterList () const
 return the pair of cluster pointers by reference More...
 
const AmgSymMatrix (3) &globCovariance() const
 return the error matrix by reference The Matrix is calculated from the local Covariance Matrix when demanded and the cached More...
 
double eta (double z0=0) const
 calculate eta (not cached), needs z0 info More...
 
double r () const
 returns the r value of the SpacePoint's position (in cylindrical coordinates). More...
 
double phi () const
 returns the phi value of the SpacePoint's position (in cylindrical coordinates). More...
 
virtual const SurfaceassociatedSurface () const override final
 Interface method to get the associated Surface. More...
 
virtual const Amg::Vector3DglobalPosition () const override final
 Interface method to get the global Position. More...
 
virtual SpacePointclone () const override=0
 Clone. More...
 
std::unique_ptr< SpacePointuniqueClone () const
 Clone. More...
 
virtual bool type (MeasurementBaseType::Type type) const override final
 Extended method checking the type. More...
 
virtual MsgStream & dump (MsgStream &out) const override=0
 Interface method for output, to be overloaded by child classes*. More...
 
virtual std::ostream & dump (std::ostream &out) const override=0
 Interface method for output, to be overloaded by child classes*. More...
 
const LocalParameterslocalParameters () const
 Interface method to get the LocalParameters. More...
 
const Amg::MatrixXlocalCovariance () const
 Interface method to get the localError. More...
 

Protected Member Functions

 AmgSymMatrix (3) m_globalCovariance
 
 SpacePoint (const SpacePoint &)=default
 
 SpacePoint (SpacePoint &&) noexcept=default
 
SpacePointoperator= (const SpacePoint &)=default
 
SpacePointoperator= (SpacePoint &&) noexcept=default
 
void setupGlobalFromLocalCovariance ()
 set up the global covariance matrix by rotating the local one More...
 

Protected Attributes

std::pair< const PrepRawData *, const PrepRawData * > m_clusList
 
std::pair< IdentifierHash, IdentifierHashm_elemIdList
 
Amg::Vector3D m_position
 
LocalParameters m_localParams
 
Amg::MatrixX m_localCovariance
 

Detailed Description

Definition at line 35 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

Constructor & Destructor Documentation

◆ SpacePoint() [1/3]

SpacePoint::SpacePoint ( )

Definition at line 30 of file Tracking/TrkEvent/TrkSpacePoint/src/SpacePoint.cxx.

31  :
32  m_clusList(nullptr, nullptr),
33  m_elemIdList(0,0),
34  m_position(),
35  m_globalCovariance()
36  {
37  }

◆ ~SpacePoint()

virtual Trk::SpacePoint::~SpacePoint ( )
virtualdefault

◆ SpacePoint() [2/3]

Trk::SpacePoint::SpacePoint ( const SpacePoint )
protecteddefault

◆ SpacePoint() [3/3]

Trk::SpacePoint::SpacePoint ( SpacePoint &&  )
protecteddefaultnoexcept

Member Function Documentation

◆ AmgSymMatrix() [1/2]

const Trk::SpacePoint::AmgSymMatrix ( ) const &

return the error matrix by reference The Matrix is calculated from the local Covariance Matrix when demanded and the cached

◆ AmgSymMatrix() [2/2]

Trk::SpacePoint::AmgSymMatrix ( )
protected

◆ associatedSurface()

const Surface & SpacePoint::associatedSurface ( ) const
finaloverridevirtual

Interface method to get the associated Surface.

Implements Trk::MeasurementBase.

Definition at line 71 of file Tracking/TrkEvent/TrkSpacePoint/src/SpacePoint.cxx.

71  {
72  assert(m_clusList.first->detectorElement());
73  return m_clusList.first->detectorElement()->surface();
74  }

◆ clone()

virtual SpacePoint* Trk::SpacePoint::clone ( ) const
overridepure virtual

Clone.

Implements Trk::MeasurementBase.

Implemented in InDet::SCT_SpacePoint, and InDet::PixelSpacePoint.

◆ clusterList()

const std::pair< const PrepRawData *, const PrepRawData * > & SpacePoint::clusterList ( ) const
inline

return the pair of cluster pointers by reference

Definition at line 127 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

127  {
128  return m_clusList;
129 }

◆ dump() [1/2]

virtual MsgStream& Trk::SpacePoint::dump ( MsgStream &  out) const
overridepure virtual

Interface method for output, to be overloaded by child classes*.

Implements Trk::MeasurementBase.

Implemented in InDet::SCT_SpacePoint, and InDet::PixelSpacePoint.

◆ dump() [2/2]

virtual std::ostream& Trk::SpacePoint::dump ( std::ostream &  out) const
overridepure virtual

Interface method for output, to be overloaded by child classes*.

Implements Trk::MeasurementBase.

Implemented in InDet::SCT_SpacePoint, and InDet::PixelSpacePoint.

◆ elementIdList()

const std::pair< IdentifierHash, IdentifierHash > & SpacePoint::elementIdList ( ) const
inline

return the pair of Ids of the element by reference

Definition at line 122 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

122  {
123  return m_elemIdList;
124 }

◆ eta()

double SpacePoint::eta ( double  z0 = 0) const
inline

calculate eta (not cached), needs z0 info

Definition at line 131 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

131  {
132  // double zr = (m_z-z0)/m_r;
133  double zr = (m_position.z() - z0) / m_position.perp();
134  return std::log(zr + std::sqrt(1. + zr * zr));
135 }

◆ globalPosition()

const Amg::Vector3D & SpacePoint::globalPosition ( ) const
inlinefinaloverridevirtual

Interface method to get the global Position.

Implements Trk::MeasurementBase.

Definition at line 146 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

146  {
147  return m_position;
148 }

◆ localCovariance()

const Amg::MatrixX & Trk::MeasurementBase::localCovariance ( ) const
inlineinherited

Interface method to get the localError.

Definition at line 138 of file MeasurementBase.h.

139 {
140  return m_localCovariance;
141 }

◆ localParameters()

const Trk::LocalParameters & Trk::MeasurementBase::localParameters ( ) const
inlineinherited

Interface method to get the LocalParameters.

Definition at line 132 of file MeasurementBase.h.

133 {
134  return m_localParams;
135 }

◆ operator=() [1/2]

SpacePoint& Trk::SpacePoint::operator= ( const SpacePoint )
protecteddefault

◆ operator=() [2/2]

SpacePoint& Trk::SpacePoint::operator= ( SpacePoint &&  )
protecteddefaultnoexcept

◆ phi()

double SpacePoint::phi ( ) const
inline

returns the phi value of the SpacePoint's position (in cylindrical coordinates).

This is calculated once in the ctor and then cached

Definition at line 141 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

141  {
142  return m_position.phi();
143 }

◆ r()

double SpacePoint::r ( ) const
inline

returns the r value of the SpacePoint's position (in cylindrical coordinates).

This is calculated once in the ctor and then cached

Definition at line 137 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

137  {
138  return m_position.perp();
139 }

◆ setupGlobalFromLocalCovariance()

void SpacePoint::setupGlobalFromLocalCovariance ( )
protected

set up the global covariance matrix by rotating the local one

Definition at line 57 of file Tracking/TrkEvent/TrkSpacePoint/src/SpacePoint.cxx.

57  {
58  const Amg::MatrixX& lc = this->localCovariance();
59 
60  Eigen::Matrix3d cov;
61 
62  cov << lc(0, 0), lc(0, 1), 0.,
63  lc(1, 0), lc(1, 1), 0.,
64  // cppcheck-suppress constStatement
65  0., 0., 0.;
66 
67  const Amg::RotationMatrix3D& R = associatedSurface().transform().rotation();
68  m_globalCovariance = R * cov * R.transpose();
69  }

◆ type()

virtual bool Trk::SpacePoint::type ( MeasurementBaseType::Type  type) const
inlinefinaloverridevirtual

Extended method checking the type.

Implements Trk::MeasurementBase.

Definition at line 87 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

87  {
89  }

◆ uniqueClone()

std::unique_ptr<SpacePoint> Trk::SpacePoint::uniqueClone ( ) const
inline

Clone.

Definition at line 82 of file Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h.

82  {
83  return std::unique_ptr<SpacePoint>(clone());
84  }

Member Data Documentation

◆ m_clusList

std::pair<const PrepRawData*, const PrepRawData*> Trk::SpacePoint::m_clusList
protected

◆ m_elemIdList

std::pair<IdentifierHash, IdentifierHash> Trk::SpacePoint::m_elemIdList
protected

◆ m_localCovariance

Amg::MatrixX Trk::MeasurementBase::m_localCovariance
protectedinherited

Definition at line 112 of file MeasurementBase.h.

◆ m_localParams

LocalParameters Trk::MeasurementBase::m_localParams
protectedinherited

Definition at line 111 of file MeasurementBase.h.

◆ m_position

Amg::Vector3D Trk::SpacePoint::m_position
protected

The documentation for this class was generated from the following files:
Amg::MatrixX
Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > MatrixX
Dynamic Matrix - dynamic allocation.
Definition: EventPrimitives.h:27
plotBeamSpotVxVal.cov
cov
Definition: plotBeamSpotVxVal.py:201
Trk::z0
@ z0
Definition: ParamDefs.h:64
Trk::SpacePoint::m_clusList
std::pair< const PrepRawData *, const PrepRawData * > m_clusList
Definition: Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h:97
python.LumiCalcHtml.lc
lc
Definition: LumiCalcHtml.py:579
Trk::SpacePoint::type
virtual bool type(MeasurementBaseType::Type type) const override final
Extended method checking the type.
Definition: Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h:87
Trk::SpacePoint::associatedSurface
virtual const Surface & associatedSurface() const override final
Interface method to get the associated Surface.
Definition: Tracking/TrkEvent/TrkSpacePoint/src/SpacePoint.cxx:71
AnalysisUtils::Delta::R
double R(const INavigable4Momentum *p1, const double v_eta, const double v_phi)
Definition: AnalysisMisc.h:49
Trk::MeasurementBase::m_localParams
LocalParameters m_localParams
Definition: MeasurementBase.h:111
Trk::MeasurementBase::localCovariance
const Amg::MatrixX & localCovariance() const
Interface method to get the localError.
Definition: MeasurementBase.h:138
Trk::SpacePoint::m_position
Amg::Vector3D m_position
Definition: Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h:99
Trk::SpacePoint::clone
virtual SpacePoint * clone() const override=0
Clone.
Trk::MeasurementBase::m_localCovariance
Amg::MatrixX m_localCovariance
Definition: MeasurementBase.h:112
Amg::RotationMatrix3D
Eigen::Matrix< double, 3, 3 > RotationMatrix3D
Definition: GeoPrimitives.h:49
python.CaloCondTools.log
log
Definition: CaloCondTools.py:20
Trk::SpacePoint::m_elemIdList
std::pair< IdentifierHash, IdentifierHash > m_elemIdList
Definition: Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h:98
Trk::Surface::transform
const Amg::Transform3D & transform() const
Returns HepGeom::Transform3D by reference.
Trk::MeasurementBaseType::SpacePoint
@ SpacePoint
Definition: MeasurementBase.h:48