Logo ROOT   6.19/01
Reference Guide
ROOT::Math::RotationX Class Reference

Rotation class representing a 3D rotation about the X axis by the angle of rotation.

For efficiency reason, in addition to the the angle, the sine and cosine of the angle are held

Definition at line 43 of file RotationX.h.

Public Types

typedef double Scalar
 

Public Member Functions

 RotationX ()
 Default constructor (identity rotation) More...
 
 RotationX (Scalar angle)
 Construct from an angle. More...
 
Scalar Angle () const
 Angle of rotation. More...
 
Scalar CosAngle () const
 
void GetAngle (Scalar &angle) const
 Get the angle. More...
 
void GetComponents (Scalar &angle) const
 
RotationX Inverse () const
 Return inverse of a rotation. More...
 
void Invert ()
 Invert a rotation in place. More...
 
bool operator!= (const RotationX &rhs) const
 
template<class CoordSystem , class U >
DisplacementVector3D< CoordSystem, U > operator() (const DisplacementVector3D< CoordSystem, U > &v) const
 Rotation operation on a cartesian vector. More...
 
template<class CoordSystem , class U >
PositionVector3D< CoordSystem, U > operator() (const PositionVector3D< CoordSystem, U > &v) const
 Rotation operation on a position vector in any coordinate system. More...
 
template<class CoordSystem >
LorentzVector< CoordSystem > operator() (const LorentzVector< CoordSystem > &v) const
 Rotation operation on a Lorentz vector in any 4D coordinate system. More...
 
template<class ForeignVector >
ForeignVector operator() (const ForeignVector &v) const
 Rotation operation on an arbitrary vector v. More...
 
template<class AVector >
AVector operator* (const AVector &v) const
 Overload operator * for rotation on a vector. More...
 
RotationX operator* (const RotationX &r) const
 Multiply (combine) two rotations. More...
 
RotationXoperator*= (const RotationX &r)
 Post-Multiply (on right) by another rotation : T = T*R. More...
 
bool operator== (const RotationX &rhs) const
 Equality/inequality operators. More...
 
void Rectify ()
 Rectify makes sure the angle is in (-pi,pi]. More...
 
void SetAngle (Scalar angle)
 Set given the angle. More...
 
void SetComponents (Scalar angle)
 
Scalar SinAngle () const
 Sine or Cosine of the rotation angle. More...
 

Private Attributes

Scalar fAngle
 
Scalar fCos
 
Scalar fSin
 

#include <Math/GenVector/RotationX.h>

Member Typedef Documentation

◆ Scalar

Definition at line 47 of file RotationX.h.

Constructor & Destructor Documentation

◆ RotationX() [1/2]

ROOT::Math::RotationX::RotationX ( )
inline

Default constructor (identity rotation)

Definition at line 55 of file RotationX.h.

◆ RotationX() [2/2]

ROOT::Math::RotationX::RotationX ( Scalar  angle)
inlineexplicit

Construct from an angle.

Definition at line 60 of file RotationX.h.

Member Function Documentation

◆ Angle()

Scalar ROOT::Math::RotationX::Angle ( ) const
inline

Angle of rotation.

Definition at line 103 of file RotationX.h.

◆ CosAngle()

Scalar ROOT::Math::RotationX::CosAngle ( ) const
inline

Definition at line 109 of file RotationX.h.

◆ GetAngle()

void ROOT::Math::RotationX::GetAngle ( Scalar angle) const
inline

Get the angle.

Definition at line 97 of file RotationX.h.

◆ GetComponents()

void ROOT::Math::RotationX::GetComponents ( Scalar angle) const
inline

Definition at line 98 of file RotationX.h.

◆ Inverse()

RotationX ROOT::Math::RotationX::Inverse ( ) const
inline

Return inverse of a rotation.

Definition at line 187 of file RotationX.h.

◆ Invert()

void ROOT::Math::RotationX::Invert ( )
inline

Invert a rotation in place.

Definition at line 182 of file RotationX.h.

◆ operator!=()

bool ROOT::Math::RotationX::operator!= ( const RotationX rhs) const
inline

Definition at line 215 of file RotationX.h.

◆ operator()() [1/4]

template<class CoordSystem , class U >
DisplacementVector3D<CoordSystem,U> ROOT::Math::RotationX::operator() ( const DisplacementVector3D< CoordSystem, U > &  v) const
inline

Rotation operation on a cartesian vector.

Rotation operation on a displacement vector in any coordinate system

Definition at line 127 of file RotationX.h.

◆ operator()() [2/4]

template<class CoordSystem , class U >
PositionVector3D<CoordSystem, U> ROOT::Math::RotationX::operator() ( const PositionVector3D< CoordSystem, U > &  v) const
inline

Rotation operation on a position vector in any coordinate system.

Definition at line 138 of file RotationX.h.

◆ operator()() [3/4]

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

Rotation operation on a Lorentz vector in any 4D coordinate system.

Definition at line 149 of file RotationX.h.

◆ operator()() [4/4]

template<class ForeignVector >
ForeignVector ROOT::Math::RotationX::operator() ( const ForeignVector &  v) const
inline

Rotation operation on an arbitrary vector v.

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

Definition at line 163 of file RotationX.h.

◆ operator*() [1/2]

template<class AVector >
AVector ROOT::Math::RotationX::operator* ( const AVector &  v) const
inline

Overload operator * for rotation on a vector.

Definition at line 174 of file RotationX.h.

◆ operator*() [2/2]

RotationX ROOT::Math::RotationX::operator* ( const RotationX r) const
inline

Multiply (combine) two rotations.

Definition at line 194 of file RotationX.h.

◆ operator*=()

RotationX& ROOT::Math::RotationX::operator*= ( const RotationX r)
inline

Post-Multiply (on right) by another rotation : T = T*R.

Definition at line 206 of file RotationX.h.

◆ operator==()

bool ROOT::Math::RotationX::operator== ( const RotationX rhs) const
inline

Equality/inequality operators.

Definition at line 211 of file RotationX.h.

◆ Rectify()

void ROOT::Math::RotationX::Rectify ( )
inline

Rectify makes sure the angle is in (-pi,pi].

Definition at line 72 of file RotationX.h.

◆ SetAngle()

void ROOT::Math::RotationX::SetAngle ( Scalar  angle)
inline

Set given the angle.

Definition at line 86 of file RotationX.h.

◆ SetComponents()

void ROOT::Math::RotationX::SetComponents ( Scalar  angle)
inline

Definition at line 92 of file RotationX.h.

◆ SinAngle()

Scalar ROOT::Math::RotationX::SinAngle ( ) const
inline

Sine or Cosine of the rotation angle.

Definition at line 108 of file RotationX.h.

Member Data Documentation

◆ fAngle

Scalar ROOT::Math::RotationX::fAngle
private

Definition at line 221 of file RotationX.h.

◆ fCos

Scalar ROOT::Math::RotationX::fCos
private

Definition at line 223 of file RotationX.h.

◆ fSin

Scalar ROOT::Math::RotationX::fSin
private

Definition at line 222 of file RotationX.h.


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