ROOT::Math::BoostZ Class Reference
[GenVector]

Class representing a Lorentz Boost along the Z axis, by beta. More...

#include <BoostZ.h>

List of all members.

Public Types

enum  ELorentzRotationMatrixIndex {
  kLXX = 0, kLXY = 1, kLXZ = 2, kLXT = 3,
  kLYX = 4, kLYY = 5, kLYZ = 6, kLYT = 7,
  kLZX = 8, kLZY = 9, kLZZ = 10, kLZT = 11,
  kLTX = 12, kLTY = 13, kLTZ = 14, kLTT = 15
}
enum  EBoostMatrixIndex {
  kXX = 0, kXY = 1, kXZ = 2, kXT = 3,
  kYY = 4, kYZ = 5, kYT = 6, kZZ = 7,
  kZT = 8, kTT = 9
}
typedef double Scalar
typedef DisplacementVector3D
< Cartesian3D< double >
, DefaultCoordinateSystemTag > 		XYZVector
 The beta vector for this boost.

Public Member Functions

 BoostZ ()
 Default constructor (identity transformation).
 BoostZ (Scalar beta_z)
 Construct given a Scalar beta_z.
void Rectify ()
 Re-adjust components to eliminate small deviations from a perfect orthosyplectic matrix.
void SetComponents (Scalar beta_z)
 Set components from a Scalar beta_z.
void GetComponents (Scalar &beta_z) const
 Get components into a Scalar beta_z.
Scalar Beta () const
 Retrieve the beta of the Boost.
Scalar Gamma () const
 Retrieve the gamma of the Boost.
void SetBeta (Scalar beta)
 Set the given beta of the Boost.
XYZVector BetaVector () const
void GetLorentzRotation (Scalar r[]) const
 Get elements of internal 4x4 symmetric representation, into a data array suitable for direct use as the components of a LorentzRotation Note -- 16 Scalars will be written into the array; if the array is not that large, then this will lead to undefined behavior.
LorentzVector
< ROOT::Math::PxPyPzE4D
< double > > 		operator() (const LorentzVector< ROOT::Math::PxPyPzE4D< double > > &v) const
 Lorentz transformation operation on a Minkowski ('Cartesian') LorentzVector.
template<class CoordSystem >
LorentzVector< CoordSystem > operator() (const LorentzVector< CoordSystem > &v) const
 Lorentz transformation operation on a LorentzVector in any coordinate system.
template<class Foreign4Vector >
Foreign4Vector operator() (const Foreign4Vector &v) const
 Lorentz transformation operation on an arbitrary 4-vector v.
template<class A4Vector >
A4Vector operator* (const A4Vector &v) const
 Overload operator * for boost on a vector.
void Invert ()
 Invert a BoostZ in place.
BoostZ Inverse () const
 Return inverse of a BoostZ.
bool operator== (const BoostZ &rhs) const
 Equality/inequality operators.
bool operator!= (const BoostZ &rhs) const

Detailed Description

Class representing a Lorentz Boost along the Z axis, by beta.

For efficiency, gamma is held as well.

Definition at line 37 of file GenVector/BoostZ.h.

Member Typedef Documentation

typedef double ROOT::Math::BoostZ::Scalar

Definition at line 41 of file GenVector/BoostZ.h.

typedef DisplacementVector3D<Cartesian3D<double>, DefaultCoordinateSystemTag > ROOT::Math::BoostZ::XYZVector

The beta vector for this boost.

Definition at line 111 of file GenVector/BoostZ.h.

Member Enumeration Documentation

enum ROOT::Math::BoostZ::EBoostMatrixIndex

Enumerator:
kXX 
kXY 
kXZ 
kXT 
kYY 
kYZ 
kYT 
kZZ 
kZT 
kTT 

Definition at line 50 of file GenVector/BoostZ.h.

enum ROOT::Math::BoostZ::ELorentzRotationMatrixIndex

Enumerator:
kLXX 
kLXY 
kLXZ 
kLXT 
kLYX 
kLYY 
kLYZ 
kLYT 
kLZX 
kLZY 
kLZZ 
kLZT 
kLTX 
kLTY 
kLTZ 
kLTT 

Definition at line 43 of file GenVector/BoostZ.h.

Constructor & Destructor Documentation

ROOT::Math::BoostZ::BoostZ (  ) 

Default constructor (identity transformation).

Definition at line 30 of file BoostZ.cxx.

ROOT::Math::BoostZ::BoostZ ( Scalar  beta_z  )  [inline, explicit]

Construct given a Scalar beta_z.

Definition at line 67 of file GenVector/BoostZ.h.

References SetComponents().

Member Function Documentation

Scalar ROOT::Math::BoostZ::Beta (  )  const [inline]

Retrieve the beta of the Boost.

Definition at line 96 of file GenVector/BoostZ.h.

Referenced by ROOT::Math::operator<<().

DisplacementVector3D< Cartesian3D< BoostZ::Scalar > > ROOT::Math::BoostZ::BetaVector (  )  const

Definition at line 50 of file BoostZ.cxx.

Referenced by ROOT::Math::Boost::Boost().

Scalar ROOT::Math::BoostZ::Gamma (  )  const [inline]

Retrieve the gamma of the Boost.

Definition at line 101 of file GenVector/BoostZ.h.

Referenced by ROOT::Math::operator<<().

void ROOT::Math::BoostZ::GetComponents ( Scalar &  beta_z  )  const

Get components into a Scalar beta_z.

Definition at line 44 of file BoostZ.cxx.

void ROOT::Math::BoostZ::GetLorentzRotation ( Scalar  r[]  )  const

Get elements of internal 4x4 symmetric representation, into a data array suitable for direct use as the components of a LorentzRotation Note -- 16 Scalars will be written into the array; if the array is not that large, then this will lead to undefined behavior.

Definition at line 56 of file BoostZ.cxx.

References kLTT, kLTX, kLTY, kLTZ, kLXT, kLXX, kLXY, kLXZ, kLYT, kLYX, kLYY, kLYZ, kLZT, kLZX, kLZY, and kLZZ.

Referenced by ROOT::Math::LorentzRotation::LorentzRotation().

BoostZ ROOT::Math::BoostZ::Inverse (  )  const

Return inverse of a BoostZ.

Definition at line 99 of file BoostZ.cxx.

References Invert().

void ROOT::Math::BoostZ::Invert (  ) 

Invert a BoostZ in place.

Definition at line 94 of file BoostZ.cxx.

Referenced by Inverse().

bool ROOT::Math::BoostZ::operator!= ( const BoostZ &  rhs  )  const [inline]

Definition at line 185 of file GenVector/BoostZ.h.

References operator==().

template<class Foreign4Vector >
Foreign4Vector ROOT::Math::BoostZ::operator() ( const Foreign4Vector &  v  )  const [inline]

Lorentz transformation operation on an arbitrary 4-vector v.

Preconditions: v must implement methods x(), y(), z(), and t() and the arbitrary vector type must have a constructor taking (x,y,z,t)

Definition at line 151 of file GenVector/BoostZ.h.

References operator()(), ROOT::Math::LorentzVector< CoordSystem >::T(), ROOT::Math::LorentzVector< CoordSystem >::X(), ROOT::Math::LorentzVector< CoordSystem >::Y(), and ROOT::Math::LorentzVector< CoordSystem >::Z().

template<class CoordSystem >
LorentzVector<CoordSystem> ROOT::Math::BoostZ::operator() ( const LorentzVector< CoordSystem > &  v  )  const [inline]

Lorentz transformation operation on a LorentzVector in any coordinate system.

Definition at line 138 of file GenVector/BoostZ.h.

References operator()().

LorentzVector< PxPyPzE4D< double > > ROOT::Math::BoostZ::operator() ( const LorentzVector< ROOT::Math::PxPyPzE4D< double > > &  v  )  const

Lorentz transformation operation on a Minkowski ('Cartesian') LorentzVector.

Definition at line 83 of file BoostZ.cxx.

References v.

Referenced by operator()(), and operator*().

template<class A4Vector >
A4Vector ROOT::Math::BoostZ::operator* ( const A4Vector &  v  )  const [inline]

Overload operator * for boost on a vector.

Definition at line 162 of file GenVector/BoostZ.h.

References operator()().

bool ROOT::Math::BoostZ::operator== ( const BoostZ &  rhs  )  const [inline]

Equality/inequality operators.

Definition at line 180 of file GenVector/BoostZ.h.

Referenced by operator!=().

void ROOT::Math::BoostZ::Rectify (  ) 

Re-adjust components to eliminate small deviations from a perfect orthosyplectic matrix.

Definition at line 64 of file BoostZ.cxx.

References ROOT::Math::beta(), SetComponents(), and ROOT::Math::Throw().

void ROOT::Math::BoostZ::SetBeta ( Scalar  beta  )  [inline]

Set the given beta of the Boost.

Definition at line 106 of file GenVector/BoostZ.h.

References SetComponents().

void ROOT::Math::BoostZ::SetComponents ( Scalar  beta_z  ) 

Set components from a Scalar beta_z.

Definition at line 32 of file BoostZ.cxx.

References ROOT::Math::sqrt(), and ROOT::Math::Throw().

Referenced by BoostZ(), Rectify(), and SetBeta().

The documentation for this class was generated from the following files:
Generated on Thu Dec 16 21:09:41 2010 for ROOT Mathematical Libraries by  doxygen 1.5.9