FourVector Class Reference

Specialisation of VectorN to a general (non-momentum) Lorentz 4-vector. More...

#include <Vector4.hh>

Inheritance diagram for FourVector:
Inheritance graph
[legend]
Collaboration diagram for FourVector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 FourVector ()
template<typename V4 >
 FourVector (const V4 &other)
 FourVector (const Vector< 4 > &other)
 FourVector (const double t, const double x, const double y, const double z)
virtual ~FourVector ()
double t () const
double x () const
double y () const
double z () const
FourVectorsetT (const double t)
FourVectorsetX (const double x)
FourVectorsetY (const double y)
FourVectorsetZ (const double z)
double invariant () const
double angle (const FourVector &v) const
 Angle between this vector and another.
double angle (const Vector3 &v3) const
 Angle between this vector and another (3-vector).
double polarRadius2 () const
 Square of the projection of the 3-vector on to the $ x-y $ plane This is a more efficient function than polarRadius, as it avoids the square root. Use it if you only need the squared value, or e.g. an ordering by magnitude.
double perp2 () const
 Synonym for polarRadius2.
double rho2 () const
 Synonym for polarRadius2.
double polarRadius () const
 Projection of 3-vector on to the $ x-y $ plane.
double perp () const
 Synonym for polarRadius.
double rho () const
 Synonym for polarRadius.
double azimuthalAngle (const PhiMapping mapping=ZERO_2PI) const
 Angle subtended by the 3-vector's projection in x-y and the x-axis.
double phi (const PhiMapping mapping=ZERO_2PI) const
 Synonym for azimuthalAngle.
double polarAngle () const
 Angle subtended by the 3-vector and the z-axis.
double theta () const
 Synonym for polarAngle.
double pseudorapidity () const
 Pseudorapidity (defined purely by the 3-vector components).
double eta () const
 Synonym for pseudorapidity.
Vector3 vector3 () const
 Get the spatial part of the 4-vector as a 3-vector.
double contract (const FourVector &v) const
 Contract two 4-vectors, with metric signature (+ - - -).
double dot (const FourVector &v) const
 Contract two 4-vectors, with metric signature (+ - - -).
double operator* (const FourVector &v) const
 Contract two 4-vectors, with metric signature (+ - - -).
FourVectoroperator*= (double a)
 Multiply by a scalar.
FourVectoroperator/= (double a)
 Divide by a scalar.
FourVectoroperator+= (const FourVector &v)
FourVectoroperator-= (const FourVector &v)
FourVector operator- () const
 Invert the vector.
const double & get (const size_t index) const
const double & operator[] (const size_t index) const
 Direct access to vector elements by index.
double & operator[] (const size_t index)
 Direct access to vector elements by index.
Vector< N > & set (const size_t index, const double value)
 Set indexed value.
size_t size () const
 Vector dimensionality.
bool isZero (double tolerance=1E-5) const
 Check for nullness, allowing for numerical precision.
double mod2 () const
 Calculate the modulus-squared of a vector. $ \sum_{i=1}^N x_i^2 $.
double mod () const
 Calculate the modulus of a vector. $ \sqrt{\sum_{i=1}^N x_i^2} $.
bool operator== (const Vector< N > &a) const
bool operator!= (const Vector< N > &a) const
bool operator< (const Vector< N > &a) const
bool operator<= (const Vector< N > &a) const
bool operator> (const Vector< N > &a) const
bool operator>= (const Vector< N > &a) const

Protected Member Functions

double & get (const size_t index)

Protected Attributes

Eigen::Vector< double, N > _vec
 Vector.

Friends

FourVector multiply (const double a, const FourVector &v)
FourVector multiply (const FourVector &v, const double a)
FourVector add (const FourVector &a, const FourVector &b)
FourVector transform (const LorentzTransform &lt, const FourVector &v4)

Detailed Description

Specialisation of VectorN to a general (non-momentum) Lorentz 4-vector.

Definition at line 20 of file Vector4.hh.


Constructor & Destructor Documentation

FourVector (  )  [inline]

Definition at line 28 of file Vector4.hh.

00028 : Vector<4>() { }

FourVector ( const V4 &  other  )  [inline]

Definition at line 31 of file Vector4.hh.

References FourVector::setT(), FourVector::setX(), FourVector::setY(), and FourVector::setZ().

00031                                 {
00032       this->setT(other.t());
00033       this->setX(other.x());
00034       this->setY(other.y());
00035       this->setZ(other.z());
00036     }

FourVector ( const Vector< 4 > &  other  )  [inline]

Definition at line 38 of file Vector4.hh.

00039     : Vector<4>(other) { }

FourVector ( const double  t,
const double  x,
const double  y,
const double  z 
) [inline]

Definition at line 41 of file Vector4.hh.

References FourVector::setT(), FourVector::setX(), FourVector::setY(), and FourVector::setZ().

00041                                                                                {
00042       this->setT(t);
00043       this->setX(x);
00044       this->setY(y);
00045       this->setZ(z);
00046     }

virtual ~FourVector (  )  [inline, virtual]

Definition at line 48 of file Vector4.hh.

00048 { }


Member Function Documentation

double angle ( const Vector3 v3  )  const [inline]

Angle between this vector and another (3-vector).

Definition at line 72 of file Vector4.hh.

References Vector3::angle(), and FourVector::vector3().

00072                                           {
00073       return vector3().angle(v3);
00074     }

double angle ( const FourVector v  )  const [inline]

Angle between this vector and another.

Definition at line 67 of file Vector4.hh.

References Vector3::angle(), and FourVector::vector3().

Referenced by D0_1996_S3214044::_fourJetAnalysis(), H1_2000_S4129130::analyze(), H1_1994_S2919893::analyze(), and Rivet::angle().

00067                                             {
00068       return vector3().angle( v.vector3() );
00069     }

double azimuthalAngle ( const PhiMapping  mapping = ZERO_2PI  )  const [inline]
double contract ( const FourVector v  )  const [inline]

Contract two 4-vectors, with metric signature (+ - - -).

Definition at line 147 of file Vector4.hh.

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

Referenced by Rivet::contract(), FourVector::dot(), and FourVector::operator*().

00147                                                {
00148       const double result = t()*v.t() - x()*v.x() - y()*v.y() - z()*v.z();
00149       return result;
00150     }

double dot ( const FourVector v  )  const [inline]

Contract two 4-vectors, with metric signature (+ - - -).

Definition at line 153 of file Vector4.hh.

References FourVector::contract().

00153                                           {
00154       return contract(v);
00155     }

double eta (  )  const [inline]

Synonym for pseudorapidity.

Definition at line 134 of file Vector4.hh.

References Vector3::eta(), and FourVector::vector3().

Referenced by FinalState::accept(), UA1_1990_S2044935::analyze(), STAR_2009_UE_HELEN::analyze(), STAR_2008_S7993412::analyze(), MC_ZZJETS::analyze(), MC_ZJETS::analyze(), MC_WWJETS::analyze(), MC_WJETS::analyze(), MC_SUSY::analyze(), MC_PHOTONJETUE::analyze(), MC_PHOTONJETS::analyze(), MC_HJETS::analyze(), MC_GENERIC::analyze(), MC_DIPHOTON::analyze(), D0_2010_S8821313::analyze(), D0_2010_S8570965::analyze(), D0_2008_S7837160::analyze(), D0_2008_S7719523::analyze(), D0_2008_S6879055::analyze(), D0_1996_S3324664::analyze(), D0_1996_S3214044::analyze(), CMS_2011_S8957746::analyze(), CMS_2011_S8884919::analyze(), CMS_2010_S8656010::analyze(), CMS_2010_S8547297::analyze(), CDF_2010_S8591881_DY::analyze(), CDF_2009_S8436959::analyze(), CDF_2008_S7541902::analyze(), CDF_2008_NOTE_9351::analyze(), CDF_2005_S6080774::analyze(), CDF_2004_S5839831::analyze(), CDF_2001_S4563131::analyze(), CDF_2001_S4517016::analyze(), CDF_2000_S4266730::analyze(), CDF_1997_S3541940::analyze(), CDF_1996_S3418421::analyze(), CDF_1994_S2952106::analyze(), CDF_1993_S2742446::analyze(), ATLAS_2011_S9120807::analyze(), ATLAS_2011_S9019561::analyze(), ATLAS_2011_S9002537::analyze(), ATLAS_2011_S8994773::analyze(), ATLAS_2011_S8983313::analyze(), ATLAS_2011_CONF_2011_090::analyze(), ATLAS_2010_S8914702::analyze(), ATLAS_2010_S8894728::analyze(), ATLAS_2010_S8591806::analyze(), ATLAS_2010_CONF_2010_049::analyze(), JetShape::calc(), Rivet::eta(), Jet::eta(), ATLAS_2010_S8918562::fillPtEtaNch(), JetAlg::jets(), and NeutralFinalState::project().

00134                        {
00135       return vector3().eta();
00136     }

double& get ( const size_t  index  )  [inline, protected, inherited]

Definition at line 126 of file VectorN.hh.

References Vector< N >::_vec.

00126                                     {
00127       if (index >= N) {
00128         throw std::runtime_error("Tried to access an invalid vector index.");
00129       } else {
00130         return _vec(index);
00131       }
00132     }

const double& get ( const size_t  index  )  const [inline, inherited]

Definition at line 33 of file VectorN.hh.

References Vector< N >::_vec.

00033                                                 {
00034       if (index >= N) {
00035         throw std::runtime_error("Tried to access an invalid vector index.");
00036       } else {
00037         return _vec(index);
00038       }
00039     }

double invariant (  )  const [inline]

Definition at line 61 of file Vector4.hh.

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

Referenced by D0_2001_S4674421::analyze(), Rivet::invariant(), and FourMomentum::mass2().

00061                              {
00062       // Done this way for numerical precision
00063       return (t() + z())*(t() - z()) - x()*x() - y()*y();
00064     }

bool isZero ( double  tolerance = 1E-5  )  const [inline, inherited]

Check for nullness, allowing for numerical precision.

Definition at line 67 of file VectorN.hh.

References Vector< N >::_vec, and Rivet::isZero().

00067                                              {
00068       for (size_t i=0; i < N; ++i) {
00069         if (! Rivet::isZero(_vec[i], tolerance) ) return false;
00070       }
00071       return true;
00072     }

double mod (  )  const [inline, inherited]

Calculate the modulus of a vector. $ \sqrt{\sum_{i=1}^N x_i^2} $.

Definition at line 87 of file VectorN.hh.

References Vector< N >::mod2().

00087                        {
00088       const double norm = mod2();
00089       assert(norm >= 0);
00090       return sqrt(norm);
00091     }

double mod2 (  )  const [inline, inherited]

Calculate the modulus-squared of a vector. $ \sum_{i=1}^N x_i^2 $.

Definition at line 76 of file VectorN.hh.

References Vector< N >::mod2(), and Vector< N >::size().

00076                         {
00077       double mod2 = 0.0;
00078       for (size_t i = 0; i < size(); ++i) {
00079         const double element = get(i);
00080         mod2 += element*element;
00081       }
00082       return mod2;
00083     }

bool operator!= ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 104 of file VectorN.hh.

References Vector< N >::_vec.

00104                                               {
00105       return _vec != a._vec;
00106     }

double operator* ( const FourVector v  )  const [inline]

Contract two 4-vectors, with metric signature (+ - - -).

Definition at line 158 of file Vector4.hh.

References FourVector::contract().

00158                                                 {
00159       return contract(v);
00160     }

FourVector& operator*= ( double  a  )  [inline]

Multiply by a scalar.

Reimplemented in FourMomentum.

Definition at line 163 of file Vector4.hh.

References Vector< N >::_vec, Vector< 4 >::_vec, and FourVector::multiply.

00163                                      {
00164       _vec = multiply(a, *this)._vec;
00165       return *this;
00166     }

FourVector& operator+= ( const FourVector v  )  [inline]

Definition at line 174 of file Vector4.hh.

References Vector< N >::_vec, Vector< 4 >::_vec, and FourVector::add.

00174                                                 {
00175       _vec = add(*this, v)._vec;
00176       return *this;
00177     }

FourVector operator- (  )  const [inline]

Invert the vector.

Reimplemented from Vector< 4 >.

Reimplemented in FourMomentum.

Definition at line 184 of file Vector4.hh.

References Vector< 4 >::_vec, and Vector< N >::_vec.

00184                                  {
00185       FourVector result;
00186       result._vec = -_vec;
00187       return result;
00188     }

FourVector& operator-= ( const FourVector v  )  [inline]

Definition at line 179 of file Vector4.hh.

References Vector< N >::_vec, Vector< 4 >::_vec, and FourVector::add.

00179                                                 {
00180       _vec = add(*this, -v)._vec;
00181       return *this;
00182     }

FourVector& operator/= ( double  a  )  [inline]

Divide by a scalar.

Reimplemented in FourMomentum.

Definition at line 169 of file Vector4.hh.

References Vector< N >::_vec, Vector< 4 >::_vec, and FourVector::multiply.

00169                                      {
00170       _vec = multiply(1.0/a, *this)._vec;
00171       return *this;
00172     }

bool operator< ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 108 of file VectorN.hh.

References Vector< N >::_vec.

00108                                              {
00109       return _vec < a._vec;
00110     }

bool operator<= ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 112 of file VectorN.hh.

References Vector< N >::_vec.

00112                                               {
00113       return _vec <= a._vec;
00114     }

bool operator== ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 100 of file VectorN.hh.

References Vector< N >::_vec.

00100                                               {
00101       return _vec == a._vec;
00102     }

bool operator> ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 116 of file VectorN.hh.

References Vector< N >::_vec.

00116                                              {
00117       return _vec > a._vec;
00118     }

bool operator>= ( const Vector< N > &  a  )  const [inline, inherited]

Definition at line 120 of file VectorN.hh.

References Vector< N >::_vec.

00120                                               {
00121       return _vec >= a._vec;
00122     }

double& operator[] ( const size_t  index  )  [inline, inherited]

Direct access to vector elements by index.

Definition at line 47 of file VectorN.hh.

00047                                            {
00048       return get(index);
00049     }

const double& operator[] ( const size_t  index  )  const [inline, inherited]

Direct access to vector elements by index.

Definition at line 42 of file VectorN.hh.

00042                                                        {
00043       return get(index);
00044     }

double perp (  )  const [inline]

Synonym for polarRadius.

Definition at line 99 of file Vector4.hh.

References Vector3::perp(), and FourVector::vector3().

Referenced by LHCB_2010_S8758301::analyze(), ATLAS_2011_S8994773::analyze(), ATLAS_2010_S8894728::analyze(), and Rivet::perp().

00099                         {
00100       return vector3().perp();
00101     }

double perp2 (  )  const [inline]

Synonym for polarRadius2.

Definition at line 84 of file Vector4.hh.

References Vector3::perp2(), and FourVector::vector3().

Referenced by Rivet::perp2().

00084                          {
00085       return vector3().perp2();
00086     }

double phi ( const PhiMapping  mapping = ZERO_2PI  )  const [inline]
double polarAngle (  )  const [inline]

Angle subtended by the 3-vector and the z-axis.

Definition at line 119 of file Vector4.hh.

References Vector3::polarAngle(), and FourVector::vector3().

Referenced by H1_1994_S2919893::beamAngle(), FourMomentum::Et(), FourMomentum::massT(), Rivet::polarAngle(), and DISKinematics::project().

00119                               {
00120       return vector3().polarAngle();
00121     }

double polarRadius (  )  const [inline]

Projection of 3-vector on to the $ x-y $ plane.

Definition at line 94 of file Vector4.hh.

References Vector3::polarRadius(), and FourVector::vector3().

Referenced by Rivet::polarRadius().

00094                                {
00095       return vector3().polarRadius();
00096     }

double polarRadius2 (  )  const [inline]

Square of the projection of the 3-vector on to the $ x-y $ plane This is a more efficient function than polarRadius, as it avoids the square root. Use it if you only need the squared value, or e.g. an ordering by magnitude.

Definition at line 79 of file Vector4.hh.

References Vector3::polarRadius2(), and FourVector::vector3().

Referenced by Rivet::polarRadius2().

00079                                 {
00080       return vector3().polarRadius2();
00081     }

double pseudorapidity (  )  const [inline]
double rho (  )  const [inline]

Synonym for polarRadius.

Definition at line 104 of file Vector4.hh.

References Vector3::rho(), and FourVector::vector3().

Referenced by Rivet::rho().

00104                        {
00105       return vector3().rho();
00106     }

double rho2 (  )  const [inline]

Synonym for polarRadius2.

Definition at line 89 of file Vector4.hh.

References Vector3::rho2(), and FourVector::vector3().

Referenced by Rivet::rho2().

00089                         {
00090       return vector3().rho2();
00091     }

Vector<N>& set ( const size_t  index,
const double  value 
) [inline, inherited]

Set indexed value.

Definition at line 52 of file VectorN.hh.

References Vector< N >::_vec.

00052                                                            {
00053       if (index >= N) {
00054         throw std::runtime_error("Tried to access an invalid vector index.");
00055       } else {
00056         _vec[index] = value;
00057       }
00058       return *this;
00059     }

FourVector& setT ( const double  t  )  [inline]

Definition at line 56 of file Vector4.hh.

Referenced by FourVector::FourVector(), and FourMomentum::setE().

00056 { set(0, t); return *this; }

FourVector& setX ( const double  x  )  [inline]

Definition at line 57 of file Vector4.hh.

Referenced by FourVector::FourVector(), and FourMomentum::setPx().

00057 { set(1, x); return *this; }

FourVector& setY ( const double  y  )  [inline]

Definition at line 58 of file Vector4.hh.

Referenced by FourVector::FourVector(), and FourMomentum::setPy().

00058 { set(2, y); return *this; }

FourVector& setZ ( const double  z  )  [inline]

Definition at line 59 of file Vector4.hh.

Referenced by FourVector::FourVector(), and FourMomentum::setPz().

00059 { set(3, z); return *this; }

size_t size (  )  const [inline, inherited]

Vector dimensionality.

Definition at line 62 of file VectorN.hh.

00062                         {
00063       return N;
00064     }

double t (  )  const [inline]

Definition at line 52 of file Vector4.hh.

Referenced by FourVector::contract(), FourMomentum::E(), FourVector::invariant(), and Rivet::toString().

00052 { return get(0); }

double theta (  )  const [inline]

Synonym for polarAngle.

Definition at line 124 of file Vector4.hh.

References Vector3::theta(), and FourVector::vector3().

Referenced by D0_1996_S3214044::_fourJetAnalysis(), ALEPH_1996_S3196992::analyze(), and Rivet::theta().

00124                          {
00125       return vector3().theta();
00126     }

Vector3 vector3 (  )  const [inline]
double x (  )  const [inline]
double y (  )  const [inline]
double z (  )  const [inline]

Friends And Related Function Documentation

FourVector add ( const FourVector a,
const FourVector b 
) [friend]

Definition at line 225 of file Vector4.hh.

Referenced by FourVector::operator+=(), and FourVector::operator-=().

00225                                                                   {
00226     FourVector result;
00227     result._vec = a._vec + b._vec;
00228     return result;
00229   }

FourVector multiply ( const FourVector v,
const double  a 
) [friend]

Definition at line 209 of file Vector4.hh.

00209                                                                   {
00210     return multiply(a, v);
00211   }

FourVector multiply ( const double  a,
const FourVector v 
) [friend]

Definition at line 203 of file Vector4.hh.

Referenced by FourVector::operator*=(), and FourVector::operator/=().

00203                                                                   {
00204     FourVector result;
00205     result._vec = a * v._vec;
00206     return result;
00207   }

FourVector transform ( const LorentzTransform lt,
const FourVector v4 
) [friend]

Member Data Documentation

Eigen::Vector<double,N> _vec [protected, inherited]

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