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

template<class ScalarType = double>
class ROOT::Math::PxPyPzM4D< ScalarType >

Class describing a 4D coordinate system or momentum-energy vectors stored as (Px, Py, Pz, M).

This system is useful to describe ultra-relativistic particles (like electrons at LHC) to avoid numerical errors evaluating the mass when E >>> m The metric used is (-,-,-,+) Spacelike particles (M2 < 0) are described with negative mass values, but in this case m2 must alwasy be less than P2 to preserve a positive value of E2

Definition at line 47 of file PxPyPzM4D.h.

Public Types

typedef ScalarType Scalar
 

Public Member Functions

 PxPyPzM4D ()
 Default constructor with x=y=z=m=0. More...
 
template<class CoordSystem >
 PxPyPzM4D (const CoordSystem &v)
 construct from any 4D coordinate system class implementing X(), Y(), X() and M() More...
 
 PxPyPzM4D (const PxPyPzM4D &v)
 copy constructor More...
 
 PxPyPzM4D (Scalar px, Scalar py, Scalar pz, Scalar m)
 Constructor from x, y , z , m values. More...
 
Scalar E () const
 Energy. More...
 
Scalar E2 () const
 energy squared More...
 
Scalar Et () const
 transverse energy More...
 
Scalar Et2 () const
 transverse energy squared More...
 
Scalar Eta () const
 pseudorapidity More...
 
void GetCoordinates (Scalar &px, Scalar &py, Scalar &pz, Scalar &m) 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
 
Scalar M2 () const
 vector magnitude squared (or mass squared) In case of negative mass (spacelike particles return negative values) 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 - Note that the energy cannot be negate (would need an additional data member) therefore negate will work only on the spatial components. More...
 
bool operator!= (const PxPyPzM4D &rhs) const
 
template<class AnyCoordSystem >
PxPyPzM4Doperator= (const AnyCoordSystem &v)
 construct from any 4D coordinate system class implementing X(), Y(), X() and M() More...
 
PxPyPzM4Doperator= (const PxPyPzM4D &v)
 assignment operator More...
 
bool operator== (const PxPyPzM4D &rhs) const
 Exact equality. More...
 
Scalar P () const
 magnitude of spatial components (magnitude of 3-momentum) More...
 
Scalar P2 () const
 squared magnitude of spatial components More...
 
Scalar Perp () const
 
Scalar Perp2 () const
 
Scalar Phi () const
 azimuthal angle More...
 
Scalar Pt () const
 Transverse spatial component (P_perp or rho) More...
 
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 (const 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 px, Scalar py, Scalar pz, Scalar m)
 Set internal data based on 4 Scalar numbers. More...
 
void SetM (Scalar m)
 set T value More...
 
void SetPx (Scalar px)
 set X value More...
 
void SetPxPyPzE (Scalar px, Scalar py, Scalar pz, Scalar e)
 set all values More...
 
void SetPy (Scalar py)
 set Y value More...
 
void SetPz (Scalar pz)
 set Z value 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 RestrictNegMass ()
 

Private Attributes

ScalarType fM
 
ScalarType fX
 (contigous) data containing the coordinate values x,y,z,t More...
 
ScalarType fY
 
ScalarType fZ
 

#include <Math/GenVector/PxPyPzM4D.h>

Member Typedef Documentation

◆ Scalar

template<class ScalarType = double>
typedef ScalarType ROOT::Math::PxPyPzM4D< ScalarType >::Scalar

Definition at line 51 of file PxPyPzM4D.h.

Constructor & Destructor Documentation

◆ PxPyPzM4D() [1/4]

template<class ScalarType = double>
ROOT::Math::PxPyPzM4D< ScalarType >::PxPyPzM4D ( )
inline

Default constructor with x=y=z=m=0.

Definition at line 58 of file PxPyPzM4D.h.

◆ PxPyPzM4D() [2/4]

template<class ScalarType = double>
ROOT::Math::PxPyPzM4D< ScalarType >::PxPyPzM4D ( Scalar  px,
Scalar  py,
Scalar  pz,
Scalar  m 
)
inline

Constructor from x, y , z , m values.

Definition at line 64 of file PxPyPzM4D.h.

◆ PxPyPzM4D() [3/4]

template<class ScalarType = double>
template<class CoordSystem >
ROOT::Math::PxPyPzM4D< ScalarType >::PxPyPzM4D ( const CoordSystem &  v)
inlineexplicit

construct from any 4D coordinate system class implementing X(), Y(), X() and M()

Definition at line 75 of file PxPyPzM4D.h.

◆ PxPyPzM4D() [4/4]

template<class ScalarType = double>
ROOT::Math::PxPyPzM4D< ScalarType >::PxPyPzM4D ( const PxPyPzM4D< ScalarType > &  v)
inline

copy constructor

Definition at line 84 of file PxPyPzM4D.h.

Member Function Documentation

◆ E()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::E ( ) const
inline

Energy.

Definition at line 157 of file PxPyPzM4D.h.

◆ E2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::E2 ( ) const
inline

energy squared

Definition at line 186 of file PxPyPzM4D.h.

◆ Et()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Et ( ) const
inline

transverse energy

Definition at line 236 of file PxPyPzM4D.h.

◆ Et2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Et2 ( ) const
inline

transverse energy squared

Definition at line 227 of file PxPyPzM4D.h.

◆ Eta()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Eta ( ) const
inline

pseudorapidity

Definition at line 254 of file PxPyPzM4D.h.

◆ GetCoordinates() [1/2]

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::GetCoordinates ( Scalar px,
Scalar py,
Scalar pz,
Scalar m 
) const
inline

get internal data into 4 Scalar numbers

Definition at line 137 of file PxPyPzM4D.h.

◆ GetCoordinates() [2/2]

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

get internal data into an array of 4 Scalar numbers

Definition at line 123 of file PxPyPzM4D.h.

◆ M()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::M ( ) const
inline

Definition at line 147 of file PxPyPzM4D.h.

◆ M2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::M2 ( ) const
inline

vector magnitude squared (or mass squared) In case of negative mass (spacelike particles return negative values)

Definition at line 176 of file PxPyPzM4D.h.

◆ Mag()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Mag ( ) const
inline

Definition at line 181 of file PxPyPzM4D.h.

◆ Mag2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Mag2 ( ) const
inline

Definition at line 179 of file PxPyPzM4D.h.

◆ Mt()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Mt ( ) const
inline

transverse mass

Definition at line 213 of file PxPyPzM4D.h.

◆ Mt2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Mt2 ( ) const
inline

transverse mass squared

Definition at line 208 of file PxPyPzM4D.h.

◆ Negate()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::Negate ( )
inline

negate the 4-vector - Note that the energy cannot be negate (would need an additional data member) therefore negate will work only on the spatial components.

One would need to use negate only with vectors having the energy as data members

Definition at line 299 of file PxPyPzM4D.h.

◆ operator!=()

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

Definition at line 323 of file PxPyPzM4D.h.

◆ operator=() [1/2]

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

construct from any 4D coordinate system class implementing X(), Y(), X() and M()

Definition at line 104 of file PxPyPzM4D.h.

◆ operator=() [2/2]

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

assignment operator

Definition at line 90 of file PxPyPzM4D.h.

◆ operator==()

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

Exact equality.

Definition at line 320 of file PxPyPzM4D.h.

◆ P()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::P ( ) const
inline

magnitude of spatial components (magnitude of 3-momentum)

Definition at line 169 of file PxPyPzM4D.h.

◆ P2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::P2 ( ) const
inline

squared magnitude of spatial components

Definition at line 164 of file PxPyPzM4D.h.

◆ Perp()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Perp ( ) const
inline

Definition at line 202 of file PxPyPzM4D.h.

◆ Perp2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Perp2 ( ) const
inline

Definition at line 196 of file PxPyPzM4D.h.

◆ Phi()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Phi ( ) const
inline

azimuthal angle

Definition at line 244 of file PxPyPzM4D.h.

◆ Pt()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Pt ( ) const
inline

Transverse spatial component (P_perp or rho)

Definition at line 201 of file PxPyPzM4D.h.

◆ Pt2()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Pt2 ( ) const
inline

transverse spatial component squared

Definition at line 195 of file PxPyPzM4D.h.

◆ Px()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Px ( ) const
inline

Definition at line 144 of file PxPyPzM4D.h.

◆ Py()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Py ( ) const
inline

Definition at line 145 of file PxPyPzM4D.h.

◆ Pz()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Pz ( ) const
inline

Definition at line 146 of file PxPyPzM4D.h.

◆ R()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::R ( ) const
inline

Definition at line 170 of file PxPyPzM4D.h.

◆ RestrictNegMass()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::RestrictNegMass ( )
inlineprivate

Definition at line 355 of file PxPyPzM4D.h.

◆ Rho()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Rho ( ) const
inline

Definition at line 203 of file PxPyPzM4D.h.

◆ Scale()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::Scale ( const Scalar a)
inline

scale coordinate values by a scalar quantity a

Definition at line 309 of file PxPyPzM4D.h.

◆ SetCoordinates() [1/2]

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

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

Definition at line 115 of file PxPyPzM4D.h.

◆ SetCoordinates() [2/2]

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::SetCoordinates ( Scalar  px,
Scalar  py,
Scalar  pz,
Scalar  m 
)
inline

Set internal data based on 4 Scalar numbers.

Definition at line 129 of file PxPyPzM4D.h.

◆ SetM()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::SetM ( Scalar  m)
inline

set T value

Definition at line 282 of file PxPyPzM4D.h.

◆ SetPx()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::SetPx ( Scalar  px)
inline

set X value

Definition at line 264 of file PxPyPzM4D.h.

◆ SetPxPyPzE()

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

set all values

Definition at line 390 of file PxPyPzM4D.h.

◆ SetPy()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::SetPy ( Scalar  py)
inline

set Y value

Definition at line 270 of file PxPyPzM4D.h.

◆ SetPz()

template<class ScalarType = double>
void ROOT::Math::PxPyPzM4D< ScalarType >::SetPz ( Scalar  pz)
inline

set Z value

Definition at line 276 of file PxPyPzM4D.h.

◆ T()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::T ( ) const
inline

Definition at line 159 of file PxPyPzM4D.h.

◆ t()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::t ( ) const
inline

Definition at line 333 of file PxPyPzM4D.h.

◆ Theta()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Theta ( ) const
inline

polar angle

Definition at line 249 of file PxPyPzM4D.h.

◆ X()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::X ( ) const
inline

Definition at line 149 of file PxPyPzM4D.h.

◆ x()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::x ( ) const
inline

Definition at line 330 of file PxPyPzM4D.h.

◆ Y()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Y ( ) const
inline

Definition at line 150 of file PxPyPzM4D.h.

◆ y()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::y ( ) const
inline

Definition at line 331 of file PxPyPzM4D.h.

◆ Z()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::Z ( ) const
inline

Definition at line 151 of file PxPyPzM4D.h.

◆ z()

template<class ScalarType = double>
Scalar ROOT::Math::PxPyPzM4D< ScalarType >::z ( ) const
inline

Definition at line 332 of file PxPyPzM4D.h.

Member Data Documentation

◆ fM

template<class ScalarType = double>
ScalarType ROOT::Math::PxPyPzM4D< ScalarType >::fM
private

Definition at line 372 of file PxPyPzM4D.h.

◆ fX

template<class ScalarType = double>
ScalarType ROOT::Math::PxPyPzM4D< ScalarType >::fX
private

(contigous) data containing the coordinate values x,y,z,t

Definition at line 369 of file PxPyPzM4D.h.

◆ fY

template<class ScalarType = double>
ScalarType ROOT::Math::PxPyPzM4D< ScalarType >::fY
private

Definition at line 370 of file PxPyPzM4D.h.

◆ fZ

template<class ScalarType = double>
ScalarType ROOT::Math::PxPyPzM4D< ScalarType >::fZ
private

Definition at line 371 of file PxPyPzM4D.h.

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

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