Belle II Software development
ReferenceFrame Class Referenceabstract

Abstract base class of all reference frames. More...

#include <ReferenceFrame.h>

Inheritance diagram for ReferenceFrame:
CMSFrame CMSRotationFrame LabFrame RestFrame RotationFrame

Public Member Functions

virtual ROOT::Math::XYZVector getVertex (const ROOT::Math::XYZVector &vector) const =0
 Get vertex 3-vector in reference frame.
 
virtual ROOT::Math::XYZVector getVertex (const Particle *particle) const
 Wrapper for particles.
 
virtual ROOT::Math::PxPyPzEVector getMomentum (const ROOT::Math::PxPyPzEVector &vector) const =0
 Get momentum 4-vector in reference frame.
 
virtual ROOT::Math::PxPyPzEVector getMomentum (const Particle *particle) const
 Wrapper for particles.
 
virtual TMatrixFSym getMomentumErrorMatrix (const TMatrixFSym &matrix) const =0
 Get Momentum error matrix in reference frame.
 
virtual TMatrixFSym getMomentumErrorMatrix (const Particle *particle) const
 Wrapper for particles.
 
virtual TMatrixFSym getVertexErrorMatrix (const TMatrixFSym &matrix) const =0
 Get Vertex error matrix in reference frame.
 
virtual TMatrixFSym getVertexErrorMatrix (const Particle *particle) const
 Wrapper for particles.
 

Static Public Member Functions

static const ReferenceFrameGetCurrent ()
 Get current rest frame.
 

Static Private Member Functions

static void Push (const ReferenceFrame *frame)
 Push rest frame of given particle.
 
static void Pop ()
 Pop current rest frame.
 

Static Private Attributes

static std::stack< const ReferenceFrame * > m_reference_frames
 Stack of current rest frames.
 

Friends

template<class T >
class UseReferenceFrame
 

Detailed Description

Abstract base class of all reference frames.

Definition at line 29 of file ReferenceFrame.h.

Member Function Documentation

◆ GetCurrent()

const ReferenceFrame & GetCurrent ( )
static

Get current rest frame.

Returns
RestFrame

Definition at line 26 of file ReferenceFrame.cc.

27{
28 if (m_reference_frames.empty()) {
29 static LabFrame _default;
30 return _default;
31 } else {
32 return *m_reference_frames.top();
33 }
34}
static std::stack< const ReferenceFrame * > m_reference_frames
Stack of current rest frames.

◆ getMomentum() [1/2]

virtual ROOT::Math::PxPyPzEVector getMomentum ( const Particle particle) const
inlinevirtual

Wrapper for particles.

Parameters
particleparticle
Returns
momentum 4-vector in reference frame

Definition at line 60 of file ReferenceFrame.h.

61 {
62 return getMomentum(particle->get4Vector());
63 }
virtual ROOT::Math::PxPyPzEVector getMomentum(const ROOT::Math::PxPyPzEVector &vector) const =0
Get momentum 4-vector in reference frame.

◆ getMomentum() [2/2]

virtual ROOT::Math::PxPyPzEVector getMomentum ( const ROOT::Math::PxPyPzEVector &  vector) const
pure virtual

Get momentum 4-vector in reference frame.

Parameters
vector4-vector from particle
Returns
momentum 4-vector in reference frame

Implemented in RestFrame, LabFrame, CMSFrame, RotationFrame, and CMSRotationFrame.

◆ getMomentumErrorMatrix() [1/2]

virtual TMatrixFSym getMomentumErrorMatrix ( const Particle particle) const
inlinevirtual

Wrapper for particles.

Parameters
particleparticle
Returns
Covariance matrix in reference frame

Definition at line 77 of file ReferenceFrame.h.

78 {
79 return getMomentumErrorMatrix(particle->getMomentumErrorMatrix());
80 }
virtual TMatrixFSym getMomentumErrorMatrix(const TMatrixFSym &matrix) const =0
Get Momentum error matrix in reference frame.

◆ getMomentumErrorMatrix() [2/2]

virtual TMatrixFSym getMomentumErrorMatrix ( const TMatrixFSym &  matrix) const
pure virtual

Get Momentum error matrix in reference frame.

Parameters
matrixCovariance matrix of particle
Returns
Covariance matrix in reference frame

Implemented in RestFrame, LabFrame, CMSFrame, RotationFrame, and CMSRotationFrame.

◆ getVertex() [1/2]

virtual ROOT::Math::XYZVector getVertex ( const Particle particle) const
inlinevirtual

Wrapper for particles.

Parameters
particle
Returns
3-vector in reference frame

Definition at line 43 of file ReferenceFrame.h.

44 {
45 return getVertex(particle->getVertex());
46 }
virtual ROOT::Math::XYZVector getVertex(const ROOT::Math::XYZVector &vector) const =0
Get vertex 3-vector in reference frame.

◆ getVertex() [2/2]

virtual ROOT::Math::XYZVector getVertex ( const ROOT::Math::XYZVector &  vector) const
pure virtual

Get vertex 3-vector in reference frame.

Parameters
vector3-vector from particle
Returns
3-vector in reference frame

Implemented in RestFrame, LabFrame, CMSFrame, RotationFrame, and CMSRotationFrame.

◆ getVertexErrorMatrix() [1/2]

virtual TMatrixFSym getVertexErrorMatrix ( const Particle particle) const
inlinevirtual

Wrapper for particles.

Parameters
particle
Returns
Covariance matrix in reference frame

Definition at line 94 of file ReferenceFrame.h.

95 {
96 return getVertexErrorMatrix(particle->getVertexErrorMatrix());
97 }
virtual TMatrixFSym getVertexErrorMatrix(const TMatrixFSym &matrix) const =0
Get Vertex error matrix in reference frame.

◆ getVertexErrorMatrix() [2/2]

virtual TMatrixFSym getVertexErrorMatrix ( const TMatrixFSym &  matrix) const
pure virtual

Get Vertex error matrix in reference frame.

Parameters
matrixCovariance matrix of particle
Returns
Covariance matrix in reference frame

Implemented in RestFrame, LabFrame, CMSFrame, RotationFrame, and CMSRotationFrame.

◆ Pop()

static void Pop ( )
inlinestaticprivate

Pop current rest frame.

Definition at line 118 of file ReferenceFrame.h.

119 {
120 m_reference_frames.pop();
121 }

◆ Push()

static void Push ( const ReferenceFrame frame)
inlinestaticprivate

Push rest frame of given particle.

Parameters
frameUse this reference frame

Definition at line 110 of file ReferenceFrame.h.

111 {
112 m_reference_frames.push(frame);
113 }

Friends And Related Function Documentation

◆ UseReferenceFrame

friend class UseReferenceFrame
friend

Definition at line 126 of file ReferenceFrame.h.

Member Data Documentation

◆ m_reference_frames

std::stack< const ReferenceFrame * > m_reference_frames
staticprivate

Stack of current rest frames.

Definition at line 123 of file ReferenceFrame.h.


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