HepMC3 event record library
Public Member Functions | Static Public Member Functions | Private Attributes
FourVector Class Reference

Detailed Description

Generic 4-vector.

Interpretation of its content depends on accessors used: it's much simpler to do this than to distinguish between space and momentum vectors via the type system (especially given the need for backward compatibility with HepMC2). Be sensible and don't call energy functions on spatial vectors! To avoid duplication, most definitions are only implemented on the spatial function names, with the energy-momentum functions as aliases.

This is not intended to be a fully featured 4-vector, but does contain the majority of common non-boosting functionality, as well as a few support operations on 4-vectors.

The implementations in this class are fully inlined.

Examples
basic_tree.cc.

Definition at line 36 of file FourVector.h.

#include <FourVector.h>

Public Member Functions

 FourVector ()
 Default constructor.
 
 FourVector (double xx, double yy, double zz, double ee)
 Sets all FourVector fields.
 
 FourVector (const FourVector &v)
 Copy constructor.
 
Component accessors
void set (double x1, double x2, double x3, double x4)
 Set all FourVector fields, in order x,y,z,t.
 
void set_component (const int i, const double x)
 set component of position/displacement
 
double get_component (const int i) const
 get component of position/displacement
 
double x () const
 x-component of position/displacement
 
void set_x (double xx)
 Set x-component of position/displacement.
 
void setX (double xx)
 
double y () const
 y-component of position/displacement
 
void set_y (double yy)
 Set y-component of position/displacement.
 
void setY (double yy)
 
double z () const
 z-component of position/displacement
 
void set_z (double zz)
 Set z-component of position/displacement.
 
void setZ (double zz)
 
double t () const
 Time component of position/displacement.
 
void set_t (double tt)
 Set time component of position/displacement.
 
void setT (double tt)
 
double px () const
 x-component of momentum
 
void set_px (double pxx)
 Set x-component of momentum.
 
void setPx (double pxx)
 
double py () const
 y-component of momentum
 
void set_py (double pyy)
 Set y-component of momentum.
 
void setPy (double pyy)
 
double pz () const
 z-component of momentum
 
void set_pz (double pzz)
 Set z-component of momentum.
 
void setPz (double pzz)
 
double e () const
 Energy component of momentum.
 
void set_e (double ee)
 Set energy component of momentum.
 
void setE (double ee)
 
Computed properties
double length2 () const
 Squared magnitude of (x, y, z) 3-vector.
 
double length () const
 Magnitude of spatial (x, y, z) 3-vector.
 
double rho () const
 Magnitude of spatial (x, y, z) 3-vector, for HepMC2 compatibility.
 
double perp2 () const
 Squared magnitude of (x, y) vector.
 
double perp () const
 Magnitude of (x, y) vector.
 
double interval () const
 Spacetime invariant interval s^2 = t^2 - x^2 - y^2 - z^2.
 
double p3mod2 () const
 Squared magnitude of p3 = (px, py, pz) vector.
 
double p3mod () const
 Magnitude of p3 = (px, py, pz) vector.
 
double pt2 () const
 Squared transverse momentum px^2 + py^2.
 
double pt () const
 Transverse momentum.
 
double m2 () const
 Squared invariant mass m^2 = E^2 - px^2 - py^2 - pz^2.
 
double m () const
 Invariant mass. Returns -sqrt(-m) if e^2 - P^2 is negative.
 
double phi () const
 Azimuthal angle.
 
double theta () const
 Polar angle w.r.t. z direction.
 
double eta () const
 Pseudorapidity.
 
double rap () const
 Rapidity.
 
double abs_eta () const
 Absolute pseudorapidity.
 
double abs_rap () const
 Absolute rapidity.
 
double pseudoRapidity () const
 
Comparisons to another FourVector
bool is_zero () const
 Check if the length of this vertex is zero.
 
double delta_phi (const FourVector &v) const
 Signed azimuthal angle separation in [-pi, pi].
 
double delta_eta (const FourVector &v) const
 Pseudorapidity separation.
 
double delta_rap (const FourVector &v) const
 Rapidity separation.
 
double delta_r2_eta (const FourVector &v) const
 R_eta^2-distance separation dR^2 = dphi^2 + deta^2.
 
double delta_r_eta (const FourVector &v) const
 R_eta-distance separation dR = sqrt(dphi^2 + deta^2)
 
double delta_r2_rap (const FourVector &v) const
 R_rap^2-distance separation dR^2 = dphi^2 + drap^2.
 
double delta_r_rap (const FourVector &v) const
 R-rap-distance separation dR = sqrt(dphi^2 + drap^2)
 
Operators
bool operator== (const FourVector &rhs) const
 Equality.
 
bool operator!= (const FourVector &rhs) const
 Inequality.
 
FourVector operator+ (const FourVector &rhs) const
 Arithmetic operator +.
 
FourVector operator- (const FourVector &rhs) const
 Arithmetic operator -.
 
FourVector operator* (const double rhs) const
 Arithmetic operator * by scalar.
 
FourVector operator/ (const double rhs) const
 Arithmetic operator / by scalar.
 
void operator+= (const FourVector &rhs)
 Arithmetic operator +=.
 
void operator-= (const FourVector &rhs)
 Arithmetic operator -=.
 
void operator*= (const double rhs)
 Arithmetic operator *= by scalar.
 
void operator/= (const double rhs)
 Arithmetic operator /= by scalar.
 

Static Public Member Functions

static const FourVectorZERO_VECTOR ()
 Static null FourVector = (0,0,0,0)
 

Private Attributes

double m_v1
 px or x. Interpretation depends on accessors used
 
double m_v2
 py or y. Interpretation depends on accessors used
 
double m_v3
 pz or z. Interpretation depends on accessors used
 
double m_v4
 e or t. Interpretation depends on accessors used
 

Constructor & Destructor Documentation

◆ FourVector() [1/3]

FourVector ( )
inline

Default constructor.

Definition at line 40 of file FourVector.h.

◆ FourVector() [2/3]

FourVector ( double  xx,
double  yy,
double  zz,
double  ee 
)
inline

Sets all FourVector fields.

Definition at line 43 of file FourVector.h.

◆ FourVector() [3/3]

FourVector ( const FourVector v)
inline

Copy constructor.

Definition at line 46 of file FourVector.h.

Member Function Documentation

◆ abs_eta()

double abs_eta ( ) const
inline

Absolute pseudorapidity.

Definition at line 178 of file FourVector.h.

References FourVector::eta().

◆ abs_rap()

double abs_rap ( ) const
inline

Absolute rapidity.

Definition at line 180 of file FourVector.h.

References FourVector::rap().

◆ delta_eta()

double delta_eta ( const FourVector v) const
inline

Pseudorapidity separation.

Definition at line 205 of file FourVector.h.

References FourVector::eta().

◆ delta_phi()

double delta_phi ( const FourVector v) const
inline

Signed azimuthal angle separation in [-pi, pi].

Definition at line 196 of file FourVector.h.

References M_PI, and FourVector::phi().

◆ delta_r2_eta()

double delta_r2_eta ( const FourVector v) const
inline

R_eta^2-distance separation dR^2 = dphi^2 + deta^2.

Definition at line 211 of file FourVector.h.

References FourVector::delta_eta(), and FourVector::delta_phi().

◆ delta_r2_rap()

double delta_r2_rap ( const FourVector v) const
inline

R_rap^2-distance separation dR^2 = dphi^2 + drap^2.

Definition at line 221 of file FourVector.h.

References FourVector::delta_phi(), and FourVector::delta_rap().

◆ delta_r_eta()

double delta_r_eta ( const FourVector v) const
inline

R_eta-distance separation dR = sqrt(dphi^2 + deta^2)

Definition at line 216 of file FourVector.h.

References FourVector::delta_r2_eta().

◆ delta_r_rap()

double delta_r_rap ( const FourVector v) const
inline

R-rap-distance separation dR = sqrt(dphi^2 + drap^2)

Definition at line 226 of file FourVector.h.

References FourVector::delta_r2_rap().

◆ delta_rap()

double delta_rap ( const FourVector v) const
inline

Rapidity separation.

Definition at line 208 of file FourVector.h.

References FourVector::rap().

◆ e()

double e ( ) const
inline

Energy component of momentum.

Definition at line 131 of file FourVector.h.

References FourVector::t().

◆ eta()

double eta ( ) const
inline

Pseudorapidity.

Definition at line 174 of file FourVector.h.

References FourVector::p3mod(), and FourVector::pz().

◆ get_component()

double get_component ( const int  i) const
inline

get component of position/displacement

Definition at line 70 of file FourVector.h.

References FourVector::m_v1, FourVector::m_v2, FourVector::m_v3, and FourVector::m_v4.

◆ interval()

double interval ( ) const
inline

Spacetime invariant interval s^2 = t^2 - x^2 - y^2 - z^2.

Definition at line 154 of file FourVector.h.

References FourVector::length2(), and FourVector::t().

◆ is_zero()

bool is_zero ( ) const
inline

Check if the length of this vertex is zero.

Definition at line 193 of file FourVector.h.

References FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ length()

double length ( ) const
inline

Magnitude of spatial (x, y, z) 3-vector.

Definition at line 146 of file FourVector.h.

References FourVector::length2().

◆ length2()

double length2 ( ) const
inline

Squared magnitude of (x, y, z) 3-vector.

Definition at line 144 of file FourVector.h.

References FourVector::x(), FourVector::y(), and FourVector::z().

◆ m()

double m ( ) const
inline

Invariant mass. Returns -sqrt(-m) if e^2 - P^2 is negative.

Definition at line 167 of file FourVector.h.

References FourVector::m2().

◆ m2()

double m2 ( ) const
inline

Squared invariant mass m^2 = E^2 - px^2 - py^2 - pz^2.

Definition at line 165 of file FourVector.h.

References FourVector::interval().

◆ operator!=()

bool operator!= ( const FourVector rhs) const
inline

Inequality.

Definition at line 241 of file FourVector.h.

◆ operator*()

FourVector operator* ( const double  rhs) const
inline

Arithmetic operator * by scalar.

Definition at line 252 of file FourVector.h.

References FourVector::FourVector(), FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ operator*=()

void operator*= ( const double  rhs)
inline

◆ operator+()

FourVector operator+ ( const FourVector rhs) const
inline

Arithmetic operator +.

Definition at line 244 of file FourVector.h.

References FourVector::FourVector(), FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ operator+=()

void operator+= ( const FourVector rhs)
inline

◆ operator-()

FourVector operator- ( const FourVector rhs) const
inline

Arithmetic operator -.

Definition at line 248 of file FourVector.h.

References FourVector::FourVector(), FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ operator-=()

void operator-= ( const FourVector rhs)
inline

◆ operator/()

FourVector operator/ ( const double  rhs) const
inline

Arithmetic operator / by scalar.

Definition at line 256 of file FourVector.h.

References FourVector::FourVector(), FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ operator/=()

void operator/= ( const double  rhs)
inline

◆ operator==()

bool operator== ( const FourVector rhs) const
inline

Equality.

Definition at line 237 of file FourVector.h.

References FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

◆ p3mod()

double p3mod ( ) const
inline

Magnitude of p3 = (px, py, pz) vector.

Definition at line 159 of file FourVector.h.

References FourVector::length().

◆ p3mod2()

double p3mod2 ( ) const
inline

Squared magnitude of p3 = (px, py, pz) vector.

Definition at line 157 of file FourVector.h.

References FourVector::length2().

◆ perp()

double perp ( ) const
inline

Magnitude of (x, y) vector.

Definition at line 152 of file FourVector.h.

References FourVector::perp2().

◆ perp2()

double perp2 ( ) const
inline

Squared magnitude of (x, y) vector.

Definition at line 150 of file FourVector.h.

References FourVector::x(), and FourVector::y().

◆ phi()

double phi ( ) const
inline

Azimuthal angle.

Definition at line 170 of file FourVector.h.

References FourVector::x(), and FourVector::y().

◆ pseudoRapidity()

double pseudoRapidity ( ) const
inline

Same as eta()

Deprecated:
Prefer 'only one way to do it', and we don't have equivalent long names for e.g. pid, phi or eta

Definition at line 184 of file FourVector.h.

References FourVector::eta().

◆ pt()

double pt ( ) const
inline

Transverse momentum.

Definition at line 163 of file FourVector.h.

References FourVector::perp().

◆ pt2()

double pt2 ( ) const
inline

Squared transverse momentum px^2 + py^2.

Definition at line 161 of file FourVector.h.

References FourVector::perp2().

◆ px()

double px ( ) const
inline

x-component of momentum

Definition at line 110 of file FourVector.h.

References FourVector::x().

◆ py()

double py ( ) const
inline

y-component of momentum

Definition at line 117 of file FourVector.h.

References FourVector::y().

◆ pz()

double pz ( ) const
inline

z-component of momentum

Definition at line 124 of file FourVector.h.

References FourVector::z().

◆ rap()

double rap ( ) const
inline

Rapidity.

Definition at line 176 of file FourVector.h.

References FourVector::e(), and FourVector::pz().

◆ rho()

double rho ( ) const
inline

Magnitude of spatial (x, y, z) 3-vector, for HepMC2 compatibility.

Definition at line 148 of file FourVector.h.

References FourVector::length().

◆ set()

void set ( double  x1,
double  x2,
double  x3,
double  x4 
)
inline

Set all FourVector fields, in order x,y,z,t.

Definition at line 54 of file FourVector.h.

References FourVector::m_v1, FourVector::m_v2, FourVector::m_v3, and FourVector::m_v4.

◆ set_component()

void set_component ( const int  i,
const double  x 
)
inline

set component of position/displacement

Definition at line 62 of file FourVector.h.

References FourVector::m_v1, FourVector::m_v2, FourVector::m_v3, FourVector::m_v4, and FourVector::x().

◆ set_e()

void set_e ( double  ee)
inline

Set energy component of momentum.

Definition at line 133 of file FourVector.h.

References FourVector::set_t().

◆ set_px()

void set_px ( double  pxx)
inline

Set x-component of momentum.

Definition at line 112 of file FourVector.h.

References FourVector::set_x().

◆ set_py()

void set_py ( double  pyy)
inline

Set y-component of momentum.

Definition at line 119 of file FourVector.h.

References FourVector::set_y().

◆ set_pz()

void set_pz ( double  pzz)
inline

Set z-component of momentum.

Definition at line 126 of file FourVector.h.

References FourVector::set_z().

◆ set_t()

void set_t ( double  tt)
inline

Set time component of position/displacement.

Definition at line 104 of file FourVector.h.

References FourVector::m_v4.

◆ set_x()

void set_x ( double  xx)
inline

Set x-component of position/displacement.

Definition at line 83 of file FourVector.h.

References FourVector::m_v1.

◆ set_y()

void set_y ( double  yy)
inline

Set y-component of position/displacement.

Definition at line 90 of file FourVector.h.

References FourVector::m_v2.

◆ set_z()

void set_z ( double  zz)
inline

Set z-component of position/displacement.

Definition at line 97 of file FourVector.h.

References FourVector::m_v3.

◆ setE()

void setE ( double  ee)
inline
Deprecated:
Prefer the HepMC-style set_y() function

Definition at line 135 of file FourVector.h.

References FourVector::set_e().

◆ setPx()

void setPx ( double  pxx)
inline
Deprecated:
Prefer the HepMC-style set_px() function

Definition at line 114 of file FourVector.h.

References FourVector::set_px().

◆ setPy()

void setPy ( double  pyy)
inline
Deprecated:
Prefer the HepMC-style set_py() function

Definition at line 121 of file FourVector.h.

References FourVector::set_py().

◆ setPz()

void setPz ( double  pzz)
inline
Deprecated:
Prefer the HepMC-style set_pz() function

Definition at line 128 of file FourVector.h.

References FourVector::set_pz().

◆ setT()

void setT ( double  tt)
inline
Deprecated:
Prefer the HepMC-style set_t() function

Definition at line 106 of file FourVector.h.

References FourVector::set_t().

◆ setX()

void setX ( double  xx)
inline
Deprecated:
Prefer the HepMC-style set_x() function

Definition at line 85 of file FourVector.h.

References FourVector::set_x().

◆ setY()

void setY ( double  yy)
inline
Deprecated:
Prefer the HepMC-style set_y() function

Definition at line 92 of file FourVector.h.

References FourVector::set_y().

◆ setZ()

void setZ ( double  zz)
inline
Deprecated:
Prefer the HepMC-style set_z() function

Definition at line 99 of file FourVector.h.

References FourVector::set_z().

◆ t()

double t ( ) const
inline

Time component of position/displacement.

Definition at line 102 of file FourVector.h.

References FourVector::m_v4.

◆ theta()

double theta ( ) const
inline

Polar angle w.r.t. z direction.

Definition at line 172 of file FourVector.h.

References FourVector::perp(), and FourVector::z().

◆ x()

double x ( ) const
inline

x-component of position/displacement

Definition at line 81 of file FourVector.h.

References FourVector::m_v1.

◆ y()

double y ( ) const
inline

y-component of position/displacement

Definition at line 88 of file FourVector.h.

References FourVector::m_v2.

◆ z()

double z ( ) const
inline

z-component of position/displacement

Definition at line 95 of file FourVector.h.

References FourVector::m_v3.

◆ ZERO_VECTOR()

static const FourVector & ZERO_VECTOR ( )
inlinestatic

Static null FourVector = (0,0,0,0)

Definition at line 293 of file FourVector.h.

Field Documentation

◆ m_v1

double m_v1
private

px or x. Interpretation depends on accessors used

Definition at line 301 of file FourVector.h.

◆ m_v2

double m_v2
private

py or y. Interpretation depends on accessors used

Definition at line 302 of file FourVector.h.

◆ m_v3

double m_v3
private

pz or z. Interpretation depends on accessors used

Definition at line 303 of file FourVector.h.

◆ m_v4

double m_v4
private

e or t. Interpretation depends on accessors used

Definition at line 304 of file FourVector.h.


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