Logo ROOT  
Reference Guide
ROOT::Math::PtEtaPhiE4D< ScalarType > Class Template Reference

template<class ScalarType>
class ROOT::Math::PtEtaPhiE4D< ScalarType >

Class describing a 4D cylindrical coordinate system using Pt , Phi, Eta and E (or rho, phi, eta , T) The metric used is (-,-,-,+).

Phi is restricted to be in the range [-PI,PI)

See also
Overview of the physics vector library

Definition at line 54 of file PtEtaPhiE4D.h.

Public Types

typedef ScalarType Scalar
 

Public Member Functions

 PtEtaPhiE4D ()
 Default constructor gives zero 4-vector. More...
 
template<class CoordSystem >
 PtEtaPhiE4D (const CoordSystem &c)
 Generic constructor from any 4D coordinate system implementing Pt(), Eta(), Phi() and E() More...
 
 PtEtaPhiE4D (const PtEtaPhiE4D &v)
 copy constructor More...
 
 PtEtaPhiE4D (Scalar pt, Scalar eta, Scalar phi, Scalar e)
 Constructor from pt, eta, phi, e values. More...
 
Scalar E () const
 
Scalar Et () const
 transverse energy More...
 
Scalar Et2 () const
 transverse energy squared More...
 
Scalar Eta () const
 
void GetCoordinates (Scalar &pt, Scalar &eta, Scalar &phi, Scalar &e) const
 get internal data into 4 Scalar numbers More...
 
void GetCoordinates (Scalar dest[]) const
 get internal data into an array of 4 Scalar numbers More...
 
Scalar M () const
 invariant mass More...
 
Scalar M2 () const
 vector magnitude squared (or mass squared) More...
 
Scalar Mag () const
 
Scalar Mag2 () const
 
Scalar Mt () const
 transverse mass More...
 
Scalar Mt2 () const
 transverse mass squared More...
 
void Negate ()
 negate the 4-vector More...
 
bool operator!= (const PtEtaPhiE4D &rhs) const
 
template<class CoordSystem >
PtEtaPhiE4Doperator= (const CoordSystem &c)
 Assignment from a generic coordinate system implementing Pt(), Eta(), Phi() and E() More...
 
PtEtaPhiE4Doperator= (const PtEtaPhiE4D &v)
 assignment operator More...
 
bool operator== (const PtEtaPhiE4D &rhs) const
 Exact equality. More...
 
Scalar P () const
 magnitude of momentum More...
 
Scalar P2 () const
 squared magnitude of spatial components (momentum squared) More...
 
Scalar Perp () const
 
Scalar Perp2 () const
 
Scalar Phi () const
 
Scalar Pt () const
 
Scalar Pt2 () const
 transverse spatial component squared More...
 
Scalar Px () const
 
Scalar Py () const
 
Scalar Pz () const
 
Scalar R () const
 
Scalar Rho () const
 
void Scale (Scalar a)
 Scale coordinate values by a scalar quantity a. More...
 
void SetCoordinates (const Scalar src[])
 Set internal data based on an array of 4 Scalar numbers. More...
 
void SetCoordinates (Scalar pt, Scalar eta, Scalar phi, Scalar e)
 Set internal data based on 4 Scalar numbers. More...
 
void SetE (Scalar e)
 set E value More...
 
void SetEta (Scalar eta)
 set eta value More...
 
void SetPhi (Scalar phi)
 set phi value More...
 
void SetPt (Scalar pt)
 set Pt value More...
 
void SetPxPyPzE (Scalar px, Scalar py, Scalar pz, Scalar e)
 set values using cartesian coordinate system More...
 
Scalar T () const
 
Scalar t () const
 
Scalar Theta () const
 polar angle More...
 
Scalar X () const
 
Scalar x () const
 
Scalar Y () const
 
Scalar y () const
 
Scalar Z () const
 
Scalar z () const
 

Private Member Functions

void Restrict ()
 

Static Private Member Functions

static Scalar pi ()
 

Private Attributes

ScalarType fE
 
ScalarType fEta
 
ScalarType fPhi
 
ScalarType fPt
 

#include <Math/GenVector/PtEtaPhiE4D.h>

Member Typedef Documentation

◆ Scalar

template<class ScalarType >
typedef ScalarType ROOT::Math::PtEtaPhiE4D< ScalarType >::Scalar

Definition at line 58 of file PtEtaPhiE4D.h.

Constructor & Destructor Documentation

◆ PtEtaPhiE4D() [1/4]

template<class ScalarType >
ROOT::Math::PtEtaPhiE4D< ScalarType >::PtEtaPhiE4D ( )
inline

Default constructor gives zero 4-vector.

Definition at line 65 of file PtEtaPhiE4D.h.

◆ PtEtaPhiE4D() [2/4]

template<class ScalarType >
ROOT::Math::PtEtaPhiE4D< ScalarType >::PtEtaPhiE4D ( Scalar  pt,
Scalar  eta,
Scalar  phi,
Scalar  e 
)
inline

Constructor from pt, eta, phi, e values.

Definition at line 70 of file PtEtaPhiE4D.h.

◆ PtEtaPhiE4D() [3/4]

template<class ScalarType >
template<class CoordSystem >
ROOT::Math::PtEtaPhiE4D< ScalarType >::PtEtaPhiE4D ( const CoordSystem &  c)
inlineexplicit

Generic constructor from any 4D coordinate system implementing Pt(), Eta(), Phi() and E()

Definition at line 78 of file PtEtaPhiE4D.h.

◆ PtEtaPhiE4D() [4/4]

template<class ScalarType >
ROOT::Math::PtEtaPhiE4D< ScalarType >::PtEtaPhiE4D ( const PtEtaPhiE4D< ScalarType > &  v)
inline

copy constructor

Definition at line 87 of file PtEtaPhiE4D.h.

Member Function Documentation

◆ E()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::E ( ) const
inline

Definition at line 134 of file PtEtaPhiE4D.h.

◆ Et()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Et ( ) const
inline

transverse energy

transverse energy

Definition at line 232 of file PtEtaPhiE4D.h.

◆ Et2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Et2 ( ) const
inline

transverse energy squared

Definition at line 240 of file PtEtaPhiE4D.h.

◆ Eta()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Eta ( ) const
inline

Definition at line 132 of file PtEtaPhiE4D.h.

◆ GetCoordinates() [1/2]

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::GetCoordinates ( Scalar pt,
Scalar eta,
Scalar phi,
Scalar e 
) const
inline

get internal data into 4 Scalar numbers

Definition at line 124 of file PtEtaPhiE4D.h.

◆ GetCoordinates() [2/2]

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::GetCoordinates ( Scalar  dest[]) const
inline

get internal data into an array of 4 Scalar numbers

Definition at line 111 of file PtEtaPhiE4D.h.

◆ M()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::M ( ) const
inline

invariant mass

Definition at line 185 of file PtEtaPhiE4D.h.

◆ M2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::M2 ( ) const
inline

vector magnitude squared (or mass squared)

Definition at line 175 of file PtEtaPhiE4D.h.

◆ Mag()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Mag ( ) const
inline

Definition at line 197 of file PtEtaPhiE4D.h.

◆ Mag2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Mag2 ( ) const
inline

Definition at line 180 of file PtEtaPhiE4D.h.

◆ Mt()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Mt ( ) const
inline

transverse mass

Definition at line 213 of file PtEtaPhiE4D.h.

◆ Mt2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Mt2 ( ) const
inline

transverse mass squared

Definition at line 208 of file PtEtaPhiE4D.h.

◆ Negate()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::Negate ( )
inline

negate the 4-vector

Definition at line 298 of file PtEtaPhiE4D.h.

◆ operator!=()

template<class ScalarType >
bool ROOT::Math::PtEtaPhiE4D< ScalarType >::operator!= ( const PtEtaPhiE4D< ScalarType > &  rhs) const
inline

Definition at line 335 of file PtEtaPhiE4D.h.

◆ operator=() [1/2]

template<class ScalarType >
template<class CoordSystem >
PtEtaPhiE4D & ROOT::Math::PtEtaPhiE4D< ScalarType >::operator= ( const CoordSystem &  c)
inline

Assignment from a generic coordinate system implementing Pt(), Eta(), Phi() and E()

Definition at line 320 of file PtEtaPhiE4D.h.

◆ operator=() [2/2]

template<class ScalarType >
PtEtaPhiE4D & ROOT::Math::PtEtaPhiE4D< ScalarType >::operator= ( const PtEtaPhiE4D< ScalarType > &  v)
inline

assignment operator

Definition at line 93 of file PtEtaPhiE4D.h.

◆ operator==()

template<class ScalarType >
bool ROOT::Math::PtEtaPhiE4D< ScalarType >::operator== ( const PtEtaPhiE4D< ScalarType > &  rhs) const
inline

Exact equality.

Definition at line 331 of file PtEtaPhiE4D.h.

◆ P()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::P ( ) const
inline

magnitude of momentum

Definition at line 155 of file PtEtaPhiE4D.h.

◆ P2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::P2 ( ) const
inline

squared magnitude of spatial components (momentum squared)

Definition at line 166 of file PtEtaPhiE4D.h.

◆ Perp()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Perp ( ) const
inline

Definition at line 136 of file PtEtaPhiE4D.h.

◆ Perp2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Perp2 ( ) const
inline

Definition at line 203 of file PtEtaPhiE4D.h.

◆ Phi()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Phi ( ) const
inline

Definition at line 133 of file PtEtaPhiE4D.h.

◆ pi()

template<class ScalarType >
static Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::pi ( )
inlinestaticprivate

Definition at line 247 of file PtEtaPhiE4D.h.

◆ Pt()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Pt ( ) const
inline

Definition at line 131 of file PtEtaPhiE4D.h.

◆ Pt2()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Pt2 ( ) const
inline

transverse spatial component squared

Definition at line 202 of file PtEtaPhiE4D.h.

◆ Px()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Px ( ) const
inline

Definition at line 142 of file PtEtaPhiE4D.h.

◆ Py()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Py ( ) const
inline

Definition at line 144 of file PtEtaPhiE4D.h.

◆ Pz()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Pz ( ) const
inline

Definition at line 146 of file PtEtaPhiE4D.h.

◆ R()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::R ( ) const
inline

Definition at line 161 of file PtEtaPhiE4D.h.

◆ Restrict()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::Restrict ( )
inlineprivate

Definition at line 248 of file PtEtaPhiE4D.h.

◆ Rho()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Rho ( ) const
inline

Definition at line 137 of file PtEtaPhiE4D.h.

◆ Scale()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::Scale ( Scalar  a)
inline

Scale coordinate values by a scalar quantity a.

Definition at line 307 of file PtEtaPhiE4D.h.

◆ SetCoordinates() [1/2]

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetCoordinates ( const Scalar  src[])
inline

Set internal data based on an array of 4 Scalar numbers.

Definition at line 105 of file PtEtaPhiE4D.h.

◆ SetCoordinates() [2/2]

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetCoordinates ( Scalar  pt,
Scalar  eta,
Scalar  phi,
Scalar  e 
)
inline

Set internal data based on 4 Scalar numbers.

Definition at line 117 of file PtEtaPhiE4D.h.

◆ SetE()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetE ( Scalar  e)
inline

set E value

Definition at line 283 of file PtEtaPhiE4D.h.

◆ SetEta()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetEta ( Scalar  eta)
inline

set eta value

Definition at line 270 of file PtEtaPhiE4D.h.

◆ SetPhi()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetPhi ( Scalar  phi)
inline

set phi value

Definition at line 276 of file PtEtaPhiE4D.h.

◆ SetPt()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetPt ( Scalar  pt)
inline

set Pt value

Definition at line 264 of file PtEtaPhiE4D.h.

◆ SetPxPyPzE()

template<class ScalarType >
void ROOT::Math::PtEtaPhiE4D< ScalarType >::SetPxPyPzE ( Scalar  px,
Scalar  py,
Scalar  pz,
Scalar  e 
)
inline

set values using cartesian coordinate system

Definition at line 389 of file PtEtaPhiE4D.h.

◆ T()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::T ( ) const
inline

Definition at line 138 of file PtEtaPhiE4D.h.

◆ t()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::t ( ) const
inline

Definition at line 344 of file PtEtaPhiE4D.h.

◆ Theta()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Theta ( ) const
inline

polar angle

Definition at line 257 of file PtEtaPhiE4D.h.

◆ X()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::X ( ) const
inline

Definition at line 143 of file PtEtaPhiE4D.h.

◆ x()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::x ( ) const
inline

Definition at line 341 of file PtEtaPhiE4D.h.

◆ Y()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Y ( ) const
inline

Definition at line 145 of file PtEtaPhiE4D.h.

◆ y()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::y ( ) const
inline

Definition at line 342 of file PtEtaPhiE4D.h.

◆ Z()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::Z ( ) const
inline

Definition at line 150 of file PtEtaPhiE4D.h.

◆ z()

template<class ScalarType >
Scalar ROOT::Math::PtEtaPhiE4D< ScalarType >::z ( ) const
inline

Definition at line 343 of file PtEtaPhiE4D.h.

Member Data Documentation

◆ fE

template<class ScalarType >
ScalarType ROOT::Math::PtEtaPhiE4D< ScalarType >::fE
private

Definition at line 368 of file PtEtaPhiE4D.h.

◆ fEta

template<class ScalarType >
ScalarType ROOT::Math::PtEtaPhiE4D< ScalarType >::fEta
private

Definition at line 366 of file PtEtaPhiE4D.h.

◆ fPhi

template<class ScalarType >
ScalarType ROOT::Math::PtEtaPhiE4D< ScalarType >::fPhi
private

Definition at line 367 of file PtEtaPhiE4D.h.

◆ fPt

template<class ScalarType >
ScalarType ROOT::Math::PtEtaPhiE4D< ScalarType >::fPt
private

Definition at line 365 of file PtEtaPhiE4D.h.

Libraries for ROOT::Math::PtEtaPhiE4D< ScalarType >:
[legend]

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