CLHEP::HepEulerAngles Class Reference

#include <EulerAngles.h>

Public Member Functions
int	compare (const EA &ea) const
double	getPhi () const
double	getPsi () const
double	getTheta () const
	HepEulerAngles ()
	HepEulerAngles (double phi, double theta, double psi)
double	howNear (const EA &ea) const
bool	isNear (const EA &ea, double epsilon=tolerance) const
bool	operator!= (const EA &ea) const
bool	operator< (const EA &ea) const
bool	operator<= (const EA &ea) const
bool	operator== (const EA &ea) const
bool	operator> (const EA &ea) const
bool	operator>= (const EA &ea) const
double	phi () const
double	psi () const
EA &	set (double phi, double theta, double psi)
EA &	setPhi (double phi)
EA &	setPsi (double psi)
EA &	setTheta (double theta)
double	theta () const

Static Public Member Functions
static double	getTolerance ()
static double	setTolerance (double tol)

Protected Types
typedef HepEulerAngles	EA

Protected Member Functions
double	distance (const HepEulerAngles &ex) const

Protected Attributes
double	phi_
double	psi_
double	theta_

Static Protected Attributes
static double	tolerance = Hep3Vector::ToleranceTicks * 1.0e-8

Friends
std::ostream &	operator<< (std::ostream &os, const EA &ea)
std::istream &	operator>> (std::istream &is, EA &ea)

Detailed Description

Author

Definition at line 38 of file EulerAngles.h.

Member Typedef Documentation

EA

typedef HepEulerAngles CLHEP::HepEulerAngles::EA

protected

Definition at line 41 of file EulerAngles.h.

Constructor & Destructor Documentation

HepEulerAngles() [1/2]

CLHEP::HepEulerAngles::HepEulerAngles ( )

inline

HepEulerAngles() [2/2]

CLHEP::HepEulerAngles::HepEulerAngles ( double  phi, double  theta, double  psi  )

inline

Member Function Documentation

compare()

int CLHEP::HepEulerAngles::compare ( const EA &  ea ) const

inline

distance()

double CLHEP::HepEulerAngles::distance ( const HepEulerAngles &  ex ) const

protected

Definition at line 65 of file EulerAngles.cc.

                                                      {
 
  double thisRep[9];
  double exRep[9];
 
  ZMpvEulerAnglesRep ( *this, thisRep );
  ZMpvEulerAnglesRep ( ex,    exRep );
 
  double sum = 0.0;
  for (int i = 0; i < 9; i++)  {
    sum += thisRep[i] * exRep[i];
  }
 
  double d = 3.0 - sum;     // NaN-proofing: 
  return  (d >= 0) ? d : 0;     // sqrt(distance) is used in howNear()
 
}  // HepEulerAngles::distance()

References CLHEP::ZMpvEulerAnglesRep().

Referenced by howNear(), and isNear().

getPhi()

double CLHEP::HepEulerAngles::getPhi ( ) const

inline

getPsi()

double CLHEP::HepEulerAngles::getPsi ( ) const

inline

getTheta()

double CLHEP::HepEulerAngles::getTheta ( ) const

inline

getTolerance()

static double CLHEP::HepEulerAngles::getTolerance ( )

inlinestatic

howNear()

double CLHEP::HepEulerAngles::howNear

(

const EA &

ea

)

const

Definition at line 91 of file EulerAngles.cc.

                                                     {
 
  return  std::sqrt( distance( ex ) );
 
}  // HepEulerAngles::howNear()

References distance().

isNear()

bool CLHEP::HepEulerAngles::isNear	(	const EA &	ea,
		double	epsilon = tolerance
	)		const

Definition at line 84 of file EulerAngles.cc.

                                                                  {
 
  return  distance( ex ) <= epsilon*epsilon ;
 
}  // HepEulerAngles::isNear()

References distance(), and epsilon().

operator!=()

bool CLHEP::HepEulerAngles::operator!= ( const EA &  ea ) const

inline

operator<()

bool CLHEP::HepEulerAngles::operator< ( const EA &  ea ) const

inline

operator<=()

bool CLHEP::HepEulerAngles::operator<= ( const EA &  ea ) const

inline

operator==()

bool CLHEP::HepEulerAngles::operator== ( const EA &  ea ) const

inline

operator>()

bool CLHEP::HepEulerAngles::operator> ( const EA &  ea ) const

inline

operator>=()

bool CLHEP::HepEulerAngles::operator>= ( const EA &  ea ) const

inline

phi()

double CLHEP::HepEulerAngles::phi ( ) const

inline

Referenced by CLHEP::HepRotation::HepRotation(), CLHEP::HepRotation::phi(), CLHEP::Hep3Vector::rotate(), CLHEP::HepRotation::set(), and CLHEP::ZMpvEulerAnglesRep().

psi()

double CLHEP::HepEulerAngles::psi ( ) const

inline

Referenced by CLHEP::HepRotation::HepRotation(), CLHEP::HepRotation::psi(), CLHEP::Hep3Vector::rotate(), CLHEP::HepRotation::set(), and CLHEP::ZMpvEulerAnglesRep().

set()

EA & CLHEP::HepEulerAngles::set ( double  phi, double  theta, double  psi  )

inline

setPhi()

EA & CLHEP::HepEulerAngles::setPhi ( double  phi )

inline

setPsi()

EA & CLHEP::HepEulerAngles::setPsi ( double  psi )

inline

setTheta()

EA & CLHEP::HepEulerAngles::setTheta ( double  theta )

inline

setTolerance()

static double CLHEP::HepEulerAngles::setTolerance ( double  tol )

inlinestatic

theta()

double CLHEP::HepEulerAngles::theta ( ) const

inline

Referenced by CLHEP::HepRotation::HepRotation(), CLHEP::Hep3Vector::rotate(), CLHEP::HepRotation::set(), and CLHEP::ZMpvEulerAnglesRep().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const EA &  ea  )

friend

Definition at line 101 of file EulerAngles.cc.

{
  os << "(" << ea.phi() << ", " << ea.theta() << ", " << ea.psi() << ")";
  return  os;
}  // operator<<()

operator>>

std::istream & operator>> ( std::istream &  is, EA &  ea  )

friend

Definition at line 110 of file EulerAngles.cc.

                                                              {
  double thePhi;
  double theTheta;
  double thePsi;
  ZMinput3doubles ( is, "HepEulerAngle", thePhi , theTheta , thePsi );
  ea.set ( thePhi , theTheta , thePsi );
  return  is;
}  // operator>>()

Field Documentation

phi_

double CLHEP::HepEulerAngles::phi_

protected

Definition at line 101 of file EulerAngles.h.

psi_

double CLHEP::HepEulerAngles::psi_

protected

Definition at line 103 of file EulerAngles.h.

theta_

double CLHEP::HepEulerAngles::theta_

protected

Definition at line 102 of file EulerAngles.h.

tolerance

double CLHEP::HepEulerAngles::tolerance = Hep3Vector::ToleranceTicks * 1.0e-8

staticprotected

Definition at line 42 of file EulerAngles.h.

---

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

• source/externals/clhep/include/CLHEP/Vector/EulerAngles.h
• source/externals/clhep/src/EulerAngles.cc