Data structure for angles in three dimensions. More...

#include <JAngle3D.hh>

Inheritance diagram for JGEOMETRY3D::JAngle3D:

Public Member Functions
	JAngle3D ()
	Default constructor. More...

	JAngle3D (const double theta, const double phi)
	Constructor. More...

	JAngle3D (const double x, const double y, const double z)
	Constructor. More...

double	getTheta () const
	Get theta angle. More...

double	getPhi () const
	Get phi angle. More...

double	getDX () const
	Get x direction. More...

double	getDY () const
	Get y direction. More...

double	getDZ () const
	Get z direction. More...

JAngle3D &	negate ()
	Negate angle. More...

JAngle3D &	add (const JAngle3D &angle)
	Add angle. More...

JAngle3D &	sub (const JAngle3D &angle)
	Subtract angle. More...

JAngle3D &	mul (const double factor)
	Scale angle. More...

JAngle3D &	div (const double factor)
	Scale angle. More...

bool	equals (const JAngle3D &angle, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

double	getDot (const JAngle3D &angle) const
	Get dot product. More...

JAngle3D &	normalise ()
	Normalise angles. More...

JAngle3D &	mul (const JSecond_t &object)
	Multiply with object. More...

Protected Attributes
double	__theta

double	__phi

Friends
std::istream &	operator>> (std::istream &in, JAngle3D &angle)
	Write angle from input. More...

std::ostream &	operator<< (std::ostream &out, const JAngle3D &angle)
	Write angle to output. More...

JReader &	operator>> (JReader &in, JAngle3D &angle)
	Read angle from input. More...

JWriter &	operator<< (JWriter &out, const JAngle3D &angle)
	Write angle to output. More...

Detailed Description

Data structure for angles in three dimensions.

This class serves as input to the rotation matrix JRotation3D.

Definition at line 31 of file JAngle3D.hh.

Constructor & Destructor Documentation

◆ JAngle3D() [1/3]

JGEOMETRY3D::JAngle3D::JAngle3D ( )

inline

Default constructor.

Definition at line 38 of file JAngle3D.hh.

                :
       __theta(0.0),
       __phi  (0.0)
     {}

◆ JAngle3D() [2/3]

JGEOMETRY3D::JAngle3D::JAngle3D	(	const double	theta,
		const double	phi
	)

inline

Constructor.

Parameters

theta	theta angle [rad]
phi	phi angle [rad]

Definition at line 50 of file JAngle3D.hh.

                                :
       __theta(theta),
       __phi  (phi)
     {}

◆ JAngle3D() [3/3]

JGEOMETRY3D::JAngle3D::JAngle3D	(	const double	x,
		const double	y,
		const double	z
	)

inline

Constructor.

Parameters

x	x value
y	y value
z	z value

Definition at line 64 of file JAngle3D.hh.

                              :
       __theta(0.0),
       __phi  (0.0)
     {
       const double v = x*x + y*y + z*z;
  
       if (v != 0.0) {      
         __theta = acos (z / sqrt(v));
         __phi   = atan2(y, x);
       }
     }

Member Function Documentation

◆ getTheta()

double JGEOMETRY3D::JAngle3D::getTheta ( ) const

inline

Get theta angle.

Returns: theta angle

Definition at line 84 of file JAngle3D.hh.

     { 
       return __theta;
     }

◆ getPhi()

double JGEOMETRY3D::JAngle3D::getPhi ( ) const

inline

Get phi angle.

Returns: phi angle

Definition at line 95 of file JAngle3D.hh.

     { 
       return __phi;
     }

◆ getDX()

double JGEOMETRY3D::JAngle3D::getDX ( ) const

inline

Get x direction.

Returns: x direction

Definition at line 106 of file JAngle3D.hh.

     { 
       return sin(__theta) * cos(__phi);
     }

◆ getDY()

double JGEOMETRY3D::JAngle3D::getDY ( ) const

inline

Get y direction.

Returns: y direction

Definition at line 117 of file JAngle3D.hh.

     { 
       return sin(__theta) * sin(__phi);
     }

◆ getDZ()

double JGEOMETRY3D::JAngle3D::getDZ ( ) const

inline

Get z direction.

Returns: z direction

Definition at line 128 of file JAngle3D.hh.

     { 
       return cos(__theta);
     }

◆ negate()

JAngle3D& JGEOMETRY3D::JAngle3D::negate ( )

inline

Negate angle.

Returns: this angle

Definition at line 139 of file JAngle3D.hh.

     {
       __theta = -__theta;
       __phi   = -__phi;
  
       return *this;
     }

◆ add()

JAngle3D& JGEOMETRY3D::JAngle3D::add ( const JAngle3D & angle )

inline

Add angle.

Parameters

angle angle

Returns: this angle

Definition at line 154 of file JAngle3D.hh.

     {
       __theta += angle.getTheta();
       __phi   += angle.getPhi();
  
       return *this;
     }

◆ sub()

JAngle3D& JGEOMETRY3D::JAngle3D::sub ( const JAngle3D & angle )

inline

Subtract angle.

Parameters

angle angle

Returns: this angle

Definition at line 169 of file JAngle3D.hh.

     {
       __theta -= angle.getTheta();
       __phi   -= angle.getPhi();
  
       return *this;
     }

◆ mul() [1/2]

JAngle3D& JGEOMETRY3D::JAngle3D::mul ( const double factor )

inline

Scale angle.

Parameters

factor multiplication factor

Returns: this angle

Definition at line 183 of file JAngle3D.hh.

     {
       __theta *= factor;
       __phi   *= factor;
  
       return *this;
     }

◆ div()

JAngle3D& JGEOMETRY3D::JAngle3D::div ( const double factor )

inline

Scale angle.

Parameters

factor division factor

Returns: this angle

Definition at line 198 of file JAngle3D.hh.

     {
       __theta /= factor;
       __phi   /= factor;
  
       return *this;
     }

◆ equals()

bool JGEOMETRY3D::JAngle3D::equals	(	const JAngle3D &	angle,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

angle	angle
precision	precision

Returns: true if angles are equal; else false

Definition at line 214 of file JAngle3D.hh.

     {
       return (fabs(getTheta() - angle.getTheta()) <= precision &&
               fabs(getPhi()   - angle.getPhi())   <= precision);
     }

◆ getDot()

double JGEOMETRY3D::JAngle3D::getDot ( const JAngle3D & angle ) const

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 228 of file JAngle3D.hh.

     {
       return
         cos(getTheta()) * cos(angle.getTheta()) +
         sin(getTheta()) * sin(angle.getTheta()) *
         cos(getPhi() - angle.getPhi());
     }

◆ normalise()

JAngle3D& JGEOMETRY3D::JAngle3D::normalise ( )

inline

Normalise angles.

theta angle will be between 0 and π
phi angle will be between -π and +π

Returns: this angle

Definition at line 245 of file JAngle3D.hh.

     {
       using JTOOLS::PI;
  
       if (__theta > PI)  { do { __theta -= PI; } while (__theta > PI); }
       if (__theta < 0.0) { do { __theta += PI; } while (__theta < 0.0); }
  
       if (__phi > +PI) { do { __phi -= 2*PI; } while (__phi > +PI); }
       if (__phi < -PI) { do { __phi += 2*PI; } while (__phi < -PI); }
  
       return *this;
     }

◆ mul() [2/2]

JAngle3D & JMATH::JMath< JAngle3D , JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

Friends And Related Function Documentation

◆ operator>> [1/2]

std::istream& operator>>	(	std::istream &	in,
		JAngle3D &	angle
	)

friend

Write angle from input.

Parameters

in	input stream
angle	angle

Returns: input stream

Definition at line 266 of file JAngle3D.hh.

     {
       in >> angle.__theta >> angle.__phi;
  
       return in;
     }

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	out,
		const JAngle3D &	angle
	)

friend

Write angle to output.

Parameters

out	output stream
angle	angle

Returns: output stream

Definition at line 281 of file JAngle3D.hh.

     {
       out << angle.getTheta() << ' ' << angle.getPhi();
  
       return out;
     }

◆ operator>> [2/2]

JReader& operator>>	(	JReader &	in,
		JAngle3D &	angle
	)

friend

Read angle from input.

Parameters

in	reader
angle	angle

Returns: reader

Definition at line 296 of file JAngle3D.hh.

     {
       in >> angle.__theta;
       in >> angle.__phi;
  
       return in;
     }

◆ operator<< [2/2]

JWriter& operator<<	(	JWriter &	out,
		const JAngle3D &	angle
	)

friend

Write angle to output.

Parameters

out	writer
angle	angle

Returns: writer

Definition at line 312 of file JAngle3D.hh.

     {
       out << angle.getTheta();
       out << angle.getPhi();
  
       return out;
     }

Member Data Documentation

◆ __theta

double JGEOMETRY3D::JAngle3D::__theta

protected

Definition at line 321 of file JAngle3D.hh.

◆ __phi

double JGEOMETRY3D::JAngle3D::__phi

protected

Definition at line 322 of file JAngle3D.hh.

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

JAngle3D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JAngle3D() [1/3]

◆ JAngle3D() [2/3]

◆ JAngle3D() [3/3]

Member Function Documentation

◆ getTheta()

◆ getPhi()

◆ getDX()

◆ getDY()

◆ getDZ()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ getDot()

◆ normalise()

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __theta

◆ __phi