Rotation class representing a 3D rotation about the Z 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 RotationZ.h.

Public Types
typedef double	Scalar

Public Member Functions
	RotationZ ()
	Default constructor (identity rotation) More...

	RotationZ (Scalar angle)
	Construct from an angle. 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)

void	GetAngle (Scalar &angle) const
	Get the angle. More...

void	GetComponents (Scalar &angle) const

Scalar	Angle () const
	Angle of rotation. More...

Scalar	SinAngle () const
	Sine or Cosine of the rotation angle. More...

Scalar	CosAngle () 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...

void	Invert ()
	Invert a rotation in place. More...

RotationZ	Inverse () const
	Return inverse of a rotation. More...

RotationZ	operator* (const RotationZ &r) const
	Multiply (combine) two rotations. More...

RotationZ &	operator*= (const RotationZ &r)
	Post-Multiply (on right) by another rotation : T = T*R. More...

bool	operator== (const RotationZ &rhs) const
	Equality/inequality operators. More...

bool	operator!= (const RotationZ &rhs) const

Private Attributes
Scalar	fAngle

Scalar	fSin

Scalar	fCos

#include <Math/GenVector/RotationZ.h>

Member Typedef Documentation

typedef double ROOT::Math::RotationZ::Scalar

Definition at line 47 of file RotationZ.h.

Constructor & Destructor Documentation

ROOT::Math::RotationZ::RotationZ ( )

inline

Default constructor (identity rotation)

Definition at line 55 of file RotationZ.h.

ROOT::Math::RotationZ::RotationZ ( Scalar angle )

inlineexplicit

Construct from an angle.

Definition at line 60 of file RotationZ.h.

Member Function Documentation

Scalar ROOT::Math::RotationZ::Angle ( ) const

inline

Angle of rotation.

Definition at line 103 of file RotationZ.h.

Referenced by ROOT::Math::gv_detail::convert(), ROOT::Math::RotationZYX::operator*(), ROOT::Math::EulerAngles::operator*(), and ROOT::Math::operator<<().

Scalar ROOT::Math::RotationZ::CosAngle ( ) const

inline

Definition at line 109 of file RotationZ.h.

Referenced by ROOT::Math::gv_detail::convert(), ROOT::Math::LorentzRotation::LorentzRotation(), ROOT::Math::AxisAngle::operator*(), ROOT::Math::Rotation3D::operator*(), and ROOT::Math::operator*().

void ROOT::Math::RotationZ::GetAngle ( Scalar & angle ) const

inline

Get the angle.

Definition at line 97 of file RotationZ.h.

Referenced by GetComponents().

void ROOT::Math::RotationZ::GetComponents ( Scalar & angle ) const

inline

Definition at line 98 of file RotationZ.h.

RotationZ ROOT::Math::RotationZ::Inverse ( ) const

inline

Return inverse of a rotation.

Definition at line 187 of file RotationZ.h.

void ROOT::Math::RotationZ::Invert ( )

inline

Invert a rotation in place.

Definition at line 182 of file RotationZ.h.

Referenced by Inverse().

bool ROOT::Math::RotationZ::operator!= ( const RotationZ & rhs ) const

inline

Definition at line 215 of file RotationZ.h.

template<class CoordSystem , class U >

DisplacementVector3D<CoordSystem,U> ROOT::Math::RotationZ::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 RotationZ.h.

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

template<class CoordSystem , class U >

PositionVector3D<CoordSystem, U> ROOT::Math::RotationZ::operator() ( const PositionVector3D< CoordSystem, U > & v ) const

inline

Rotation operation on a position vector in any coordinate system.

Definition at line 138 of file RotationZ.h.

template<class CoordSystem >

LorentzVector<CoordSystem> ROOT::Math::RotationZ::operator() ( const LorentzVector< CoordSystem > & v ) const

inline

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

Definition at line 149 of file RotationZ.h.

template<class ForeignVector >

ForeignVector ROOT::Math::RotationZ::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 RotationZ.h.

template<class AVector >

AVector ROOT::Math::RotationZ::operator* ( const AVector & v ) const

inline

Overload operator * for rotation on a vector.

Definition at line 174 of file RotationZ.h.

RotationZ ROOT::Math::RotationZ::operator* ( const RotationZ & r ) const

inline

Multiply (combine) two rotations.

Definition at line 194 of file RotationZ.h.

RotationZ& ROOT::Math::RotationZ::operator*= ( const RotationZ & r )

inline

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

Definition at line 206 of file RotationZ.h.

bool ROOT::Math::RotationZ::operator== ( const RotationZ & rhs ) const

inline

Equality/inequality operators.

Definition at line 211 of file RotationZ.h.

Referenced by operator!=().

void ROOT::Math::RotationZ::Rectify ( )

inline

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

Definition at line 72 of file RotationZ.h.

Referenced by RotationZ(), and SetAngle().

void ROOT::Math::RotationZ::SetAngle ( Scalar angle )

inline

Set given the angle.

Definition at line 86 of file RotationZ.h.

Referenced by SetComponents().

void ROOT::Math::RotationZ::SetComponents ( Scalar angle )

inline

Definition at line 92 of file RotationZ.h.

Scalar ROOT::Math::RotationZ::SinAngle ( ) const

inline

Sine or Cosine of the rotation angle.

Definition at line 108 of file RotationZ.h.

Referenced by ROOT::Math::gv_detail::convert(), ROOT::Math::LorentzRotation::LorentzRotation(), ROOT::Math::AxisAngle::operator*(), ROOT::Math::Rotation3D::operator*(), and ROOT::Math::operator*().

Member Data Documentation

Scalar ROOT::Math::RotationZ::fAngle

private

Definition at line 221 of file RotationZ.h.

Referenced by Invert(), operator*(), operator==(), Rectify(), and SetAngle().

Scalar ROOT::Math::RotationZ::fCos

private

Definition at line 223 of file RotationZ.h.

Referenced by Angle(), CosAngle(), GetAngle(), operator()(), operator*(), Rectify(), and SetAngle().

Scalar ROOT::Math::RotationZ::fSin

private

Definition at line 222 of file RotationZ.h.

Referenced by Angle(), GetAngle(), Invert(), operator()(), operator*(), Rectify(), SetAngle(), and SinAngle().

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

math/genvector/inc/Math/GenVector/RotationZ.h

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation