JGEOMETRY3D::JAxis3D Class Reference

Axis object. More...

#include <JAxis3D.hh>

Inheritance diagram for JGEOMETRY3D::JAxis3D:

Public Member Functions
	JAxis3D ()
	Default constructor. More...
	JAxis3D (const JVector3D &pos)
	Constructor. More...
	JAxis3D (const JVector3D &pos, const JVersor3D &dir)
	Constructor. More...
	JAxis3D (const JVector3D &pos, const JVersor3Z &dir)
	Constructor. More...
	JAxis3D (const JSegment3D &segment)
	Constructor. More...
const JAxis3D &	getAxis () const
	Get axis. More...
void	setAxis (const JAxis3D &axis)
	Set axis. More...
JAxis3D &	negate ()
	Negate axis. More...
void	move (const double step)
	Move vertex along this axis. More...
double	getIntersection (const JVector3D &pos) const
	Get longitudinal position along axis of position of closest approach with given position. More...
double	getIntersection (const JAxis3D &axis, const double precision=1.0e-8) const
	Get longitudinal position along axis of position of closest approach with given axis. More...
double	getDistanceSquared (const JVector3D &pos) const
	Get distance squared. More...
double	getDistance (const JVector3D &pos) const
	Get distance. More...
JAxis3D &	rotate (const JRotation3D &R)
	Rotate axis. More...
JAxis3D &	rotate_back (const JRotation3D &R)
	Rotate back axis. More...
JAxis3D &	rotate (const JRotation3X &R)
	Rotate around X-axis. More...
JAxis3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis. More...
JAxis3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis. More...
JAxis3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis. More...
JAxis3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis. More...
JAxis3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis. More...
JAxis3D &	rotate (const JQuaternion3D &Q)
	Rotate axis. More...
void	transform (const JAxis3D &axis)
	Transform axis to reference frame of given axis. More...
void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform axis. More...
void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back axis. More...
void	transform (const JTransformation3D &T)
	Transform axis. More...
void	transform_back (const JTransformation3D &T)
	Transform back axis. More...
const JPosition3D &	getPosition () const
	Get position. More...
JPosition3D &	getPosition ()
	Get position. More...
void	setPosition (const JVector3D &pos)
	Set position. More...
	operator JAngle3D () const
	Type conversion operator. More...
	operator JVersor3D () const
	Type conversion operator. More...
JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...
JVector3D &	transform (const JMatrix3D &T)
	Transform. More...
double	getDot (const JAngle3D &angle) const
	Get dot product. More...
double	getDot (const JVersor3D &dir) const
	Get dot product. More...
double	getDot (const JVersor3Z &dir) const
	Get dot product. More...
double	getDot (const JVector3D &vector) const
	Get dot product. More...
	operator JVector2D () const
	Type conversion operator. More...
double	getX () const
	Get x position. More...
double	getY () const
	Get y position. More...
double	getZ () const
	Get z position. More...
JVector3D &	add (const JVector3D &vector)
	Add vector. More...
JVector3D &	sub (const JVector3D &vector)
	Subtract vector. More...
JVector3D &	mul (const double factor)
	Scale vector. More...
JVector3D &	mul (const JNullType &object)
	Multiply with object. More...
JVector3D &	div (const double factor)
	Scale vector. More...
bool	equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
JVector3D &	cross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...
const JDirection3D &	getDirection () const
	Get direction. More...
JDirection3D &	getDirection ()
	Get direction. More...
void	setDirection (const JDirection3D &dir)
	Set direction. More...
	operator JAngle3D () const
	Type conversion operator. More...
	operator JVector3D () const
	Type conversion operator. More...
JDirection3D &	transform (const JMatrix3D &T)
	Transform. More...
JDirection3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...
double	getDot (const JAngle3D &angle) const
	Get dot product. More...
double	getDot (const JVector3D &pos) const
	Get dot product. More...
double	getDot (const JVersor3Z &dir) const
	Get dot product. More...
double	getDot (const JVersor3D &versor) const
	Get dot product. More...
bool	equals (const JVersor3D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...
double	getDX () const
	Get x direction. More...
double	getDY () const
	Get y direction. More...
double	getDZ () const
	Get z direction. More...
double	getTheta () const
	Get theta angle. More...
double	getPhi () const
	Get phi angle. More...
JVersor3D &	normalise ()
	Normalise versor. More...
JVersor3D &	mul (const JNullType &object)
	Multiply with object. More...

Protected Attributes
double	__x
double	__y
double	__z
double	__dx
double	__dy
double	__dz

Friends
std::istream &	operator>> (std::istream &in, JAxis3D &axis)
	Read axis from input. More...
std::ostream &	operator<< (std::ostream &out, const JAxis3D &axis)
	Write axis to output. More...
JReader &	operator>> (JReader &in, JAxis3D &axis)
	Read axis from input. More...
JWriter &	operator<< (JWriter &out, const JAxis3D &axis)
	Write axis to output. More...

Detailed Description

Axis object.

An axis object consists of a position and a direction.

Definition at line 38 of file JAxis3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JAxis3D::JAxis3D ( )

inline

Default constructor.

Definition at line 50 of file JAxis3D.hh.

              :
      JPosition3D (),
      JDirection3D()
    {}

JGEOMETRY3D::JAxis3D::JAxis3D ( const JVector3D &  pos )

inline

Constructor.

Parameters

pos

position

Definition at line 61 of file JAxis3D.hh.

                                  :
      JPosition3D (pos), 
      JDirection3D()
    {}

JGEOMETRY3D::JAxis3D::JAxis3D ( const JVector3D &  pos, const JVersor3D &  dir  )

inline

Constructor.

Parameters

pos	position
dir	direction

Definition at line 73 of file JAxis3D.hh.

                                  :
      JPosition3D (pos), 
      JDirection3D(dir)
    {}

JGEOMETRY3D::JAxis3D::JAxis3D ( const JVector3D &  pos, const JVersor3Z &  dir  )

inline

Constructor.

Parameters

pos	position
dir	direction

Definition at line 86 of file JAxis3D.hh.

                                  :
      JPosition3D (pos), 
      JDirection3D(dir)
    {}

JGEOMETRY3D::JAxis3D::JAxis3D ( const JSegment3D &  segment )

inline

Constructor.

Parameters

segment

line segment

Definition at line 98 of file JAxis3D.hh.

                                       :
      JPosition3D (segment.first), 
      JDirection3D(segment.second - segment.first)
    {}

Member Function Documentation

const JAxis3D& JGEOMETRY3D::JAxis3D::getAxis ( ) const

inline

Get axis.

Returns

axis

Definition at line 109 of file JAxis3D.hh.

    { 
      return *this; 
    }

void JGEOMETRY3D::JAxis3D::setAxis ( const JAxis3D &  axis )

inline

Set axis.

Parameters

axis

axis

Definition at line 120 of file JAxis3D.hh.

    { 
      *this = axis; 
    }

JAxis3D& JGEOMETRY3D::JAxis3D::negate ( )

inline

Negate axis.

Returns

this axis

Definition at line 131 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).negate();
      static_cast<JDirection3D&>(*this).negate();

      return *this;
    }

void JGEOMETRY3D::JAxis3D::move ( const double  step )

inline

Move vertex along this axis.

Parameters

step

step

Definition at line 145 of file JAxis3D.hh.

    {
      getPosition() += step * JPosition3D(getDirection());    
    }

double JGEOMETRY3D::JAxis3D::getIntersection ( const JVector3D &  pos ) const

inline

Get longitudinal position along axis of position of closest approach with given position.

Parameters

pos

position

Returns

longitudinal position

Definition at line 157 of file JAxis3D.hh.

    {
      JPosition3D D(pos);

      D.sub(this->getPosition());

      return D.getDot(this->getDirection());
    }

double JGEOMETRY3D::JAxis3D::getIntersection ( const JAxis3D &  axis, const double  precision = 1.0e-8  ) const

inline

Get longitudinal position along axis of position of closest approach with given axis.

If the axes are paralel, this position corresponds to the vertex of the given axis.

Parameters

axis	axis
precision	precision

Returns

longitudinal position

Definition at line 175 of file JAxis3D.hh.

    {
      JPosition3D  pos(getPosition ());
      JDirection3D dir(getDirection());
      
      const JRotation3D R(axis.getDirection());
     
      // offset this position with position of given axis
 
      pos.sub(axis.getPosition());

      // rotate along given axis
      
      pos.rotate(R);
      dir.rotate(R);
      
      // longitudinal position at minimal distance of approach
      
      const double alpha = pos.getX()  * dir.getDX()  +  pos.getY()  * dir.getDY();
      const double beta  = dir.getDX() * dir.getDX()  +  dir.getDY() * dir.getDY();
      
      return (fabs(beta) > precision ? -alpha/beta : -pos.getZ());
    }

double JGEOMETRY3D::JAxis3D::getDistanceSquared ( const JVector3D &  pos ) const

inline

Get distance squared.

Parameters

pos

position

Returns

square of distance

Definition at line 206 of file JAxis3D.hh.

    {
      JPosition3D D(pos);

      D.sub(this->getPosition());

      const double dz = D.getDot(this->getDirection());

      return D.getLengthSquared() - dz*dz;
    }

double JGEOMETRY3D::JAxis3D::getDistance ( const JVector3D &  pos ) const

inline

Get distance.

Parameters

pos

osition

Returns

distance

Definition at line 224 of file JAxis3D.hh.

    {
      return sqrt(this->getDistanceSquared(pos));
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate ( const JRotation3D &  R )

inline

Rotate axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 236 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate_back ( const JRotation3D &  R )

inline

Rotate back axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 251 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate ( const JRotation3X &  R )

inline

Rotate around X-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 266 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate_back ( const JRotation3X &  R )

inline

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 281 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate ( const JRotation3Y &  R )

inline

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 296 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate_back ( const JRotation3Y &  R )

inline

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 311 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate ( const JRotation3Z &  R )

inline

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 326 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate_back ( const JRotation3Z &  R )

inline

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns

his axis

Definition at line 341 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);

      return *this;
    }

JAxis3D& JGEOMETRY3D::JAxis3D::rotate ( const JQuaternion3D &  Q )

inline

Rotate axis.

Parameters

Q	quaternion

Returns

this axis

Definition at line 356 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(Q);
      static_cast<JDirection3D&>(*this).rotate(Q);

      return *this;
    }

void JGEOMETRY3D::JAxis3D::transform ( const JAxis3D &  axis )

inline

Transform axis to reference frame of given axis.

Parameters

axis

axis

Definition at line 370 of file JAxis3D.hh.

    {
      JRotation3D R  (axis.getDirection());
      JPosition3D pos(axis.getPosition ());

      transform(R, pos.rotate(R));
    }

void JGEOMETRY3D::JAxis3D::transform ( const JRotation3D &  R, const JVector3D &  pos  )

inline

Transform axis.

The final position and direction are obtained as follows:

1. rotation of the position and the direction according rotation matrix (R);
2. offset position with position of origin in rotated system (pos);
3. rotation of position and direction around z-axis, such that final position is in x-z plane;

Parameters

R	rotation matrix
pos	position of origin

Definition at line 390 of file JAxis3D.hh.

    {
      JPosition3D&  u = getPosition ();
      JDirection3D& v = getDirection();

      // rotate axis to system such that direction is along z-axis

      u.rotate(R);
      v.rotate(R);

      // offset with respect to origin

      u.sub(pos);

      // rotate axis to x-z plane such that position is in x-z plane

      const double phi = atan2(u.getY(), u.getX());

      const JRotation3Z r(-phi);

      u.rotate(r);
      v.rotate(r);
    }

void JGEOMETRY3D::JAxis3D::transform_back ( const JRotation3D &  R, const JVector3D &  pos  )

inline

Transform back axis.

The final position and direction are obtained as follows:

1. offset position with position pos;
2. rotation of position and direction according matrix R;

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 426 of file JAxis3D.hh.

    {
      JPosition3D&  u = getPosition ();
      JDirection3D& v = getDirection();

      // offset with respect to origin

      u.add(pos);

      // rotate back axis to system with original particle direction

      u.rotate_back(R);
      v.rotate_back(R);
    }

void JGEOMETRY3D::JAxis3D::transform ( const JTransformation3D &  T )

inline

Transform axis.

Parameters

T	transformation

Definition at line 448 of file JAxis3D.hh.

    {
      transform(T.getRotation(), T.getPosition());
    }

void JGEOMETRY3D::JAxis3D::transform_back ( const JTransformation3D &  T )

inline

Transform back axis.

Parameters

T	transformation

Definition at line 459 of file JAxis3D.hh.

    {
      transform_back(T.getRotation(), T.getPosition());
    }

const JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( ) const

inlineinherited

Get position.

Returns

position

Definition at line 129 of file JPosition3D.hh.

    {
      return static_cast<const JPosition3D&>(*this);
    }

JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns

position

Definition at line 140 of file JPosition3D.hh.

    {
      return static_cast<JPosition3D&>(*this);
    }

void JGEOMETRY3D::JPosition3D::setPosition ( const JVector3D &  pos )

inlineinherited

Set position.

Parameters

pos

position

Definition at line 151 of file JPosition3D.hh.

    {
      static_cast<JVector3D&>(*this) = pos;
    }

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 162 of file JPosition3D.hh.

    {
      return JAngle3D(getX(), getY(), getZ());
    }

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns

direction

Definition at line 173 of file JPosition3D.hh.

    {
      return JVersor3D(getX(), getY(), getZ());
    }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JQuaternion3D &  Q )

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns

this position

Definition at line 311 of file JPosition3D.hh.

    {
      Q.rotate_back(__x, __y, __z);

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::transform ( const JMatrix3D &  T )

inlineinherited

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 205 of file JVector3D.hh.

    {
      T.transform(__x, __y, __z);

      return *this;
    }

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

inlineinherited

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 377 of file JPosition3D.hh.

    {
      return
        getX() * angle.getDX() +
        getY() * angle.getDY() +
        getZ() * angle.getDZ();
    }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3D &  dir ) const

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 392 of file JPosition3D.hh.

    {
      return
        getX() * dir.getDX() +
        getY() * dir.getDY() +
        getZ() * dir.getDZ();
    }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3Z &  dir ) const

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 407 of file JPosition3D.hh.

    {
      return
        getX() * dir.getDX() +
        getY() * dir.getDY() +
        getZ() * dir.getDZ();
    }

double JGEOMETRY3D::JVector3D::getDot ( const JVector3D &  vector ) const

inlineinherited

Get dot product.

Parameters

vector

vector

Returns

dot product

Definition at line 281 of file JVector3D.hh.

    {
      return
        getX() * vector.getX() +
        getY() * vector.getY() +
        getZ() * vector.getZ();
    }

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns

JVector2D

Definition at line 82 of file JVector3D.hh.

    {
      return JVector2D(this->getX(), this->getY());
    }

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns

x position

Definition at line 93 of file JVector3D.hh.

    { 
      return __x;
    }

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns

y position

Definition at line 103 of file JVector3D.hh.

    { 
      return __y;
    }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns

z position

Definition at line 114 of file JVector3D.hh.

    { 
      return __z;
    }

JVector3D& JGEOMETRY3D::JVector3D::add ( const JVector3D &  vector )

inlineinherited

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 141 of file JVector3D.hh.

    {
      __x += vector.getX();
      __y += vector.getY();
      __z += vector.getZ();

      return *this;
    }

JVector3D& JGEOMETRY3D::JVector3D::sub ( const JVector3D &  vector )

inlineinherited

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 157 of file JVector3D.hh.

    {
      __x -= vector.getX();
      __y -= vector.getY();
      __z -= vector.getZ();

      return *this;
    }

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

inlineinherited

Scale vector.

Parameters

factor

multiplication factor

Returns

this vector

Definition at line 173 of file JVector3D.hh.

    {
      __x *= factor;
      __y *= factor;
      __z *= factor;

      return *this;
    }

JVector3D & JMATH::JMath< JVector3D , JNullType >::mul ( const JNullType &  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);
    }

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

inlineinherited

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 189 of file JVector3D.hh.

    {
      __x /= factor;
      __y /= factor;
      __z /= factor;

      return *this;
    }

bool JGEOMETRY3D::JVector3D::equals ( const JVector3D &  vector, const double  precision = std::numeric_limits<double>::min()  ) const

inlineinherited

Check equality.

Parameters

vector	vector
precision	precision

Returns

true if vectors are equal; else false

Definition at line 220 of file JVector3D.hh.

    {
      return (fabs(getX() - vector.getX()) <= precision &&
              fabs(getY() - vector.getY()) <= precision &&
              fabs(getZ() - vector.getZ()) <= precision);
    }

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns

square of length

Definition at line 234 of file JVector3D.hh.

    { 
      return getX()*getX() + getY()*getY() + getZ()*getZ();
    }

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns

length

Definition at line 245 of file JVector3D.hh.

    { 
      return sqrt(getLengthSquared());
    }

JVector3D& JGEOMETRY3D::JVector3D::cross ( const JVector3D &  first, const JVector3D &  second  )

inlineinherited

Get cross product.

Note that this vector should not overlap with the first or second vector,

Parameters

first	first vector
second	second vector

Returns

this vector

Definition at line 298 of file JVector3D.hh.

    {
      __x = first .getY() * second.getZ()  -  second.getY() * first .getZ();
      __y = second.getX() * first .getZ()  -  first .getX() * second.getZ();
      __z = first .getX() * second.getY()  -  second.getX() * first .getY();

      return *this;
    }

const JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( ) const

inlineinherited

Get direction.

Returns

direction

Definition at line 106 of file JDirection3D.hh.

    {
      return static_cast<const JDirection3D&>(*this);
    }

JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( )

inlineinherited

Get direction.

Returns

direction

Definition at line 117 of file JDirection3D.hh.

    {
      return static_cast<JDirection3D&>(*this);
    }

void JGEOMETRY3D::JDirection3D::setDirection ( const JDirection3D &  dir )

inlineinherited

Set direction.

Parameters

dir

direction

Definition at line 128 of file JDirection3D.hh.

    {
      static_cast<JDirection3D&>(*this) = dir;
    }

JGEOMETRY3D::JDirection3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 138 of file JDirection3D.hh.

    {
      return JAngle3D(getDX(), getDY(), getDZ());
    }

JGEOMETRY3D::JDirection3D::operator JVector3D ( ) const

inlineinherited

Type conversion operator.

Returns

position

Definition at line 149 of file JDirection3D.hh.

    {
      return JVector3D(getDX(), getDY(), getDZ());
    }

JDirection3D& JGEOMETRY3D::JDirection3D::transform ( const JMatrix3D &  T )

inlineinherited

Transform.

Parameters

T

matrix

Returns

this direction

Definition at line 161 of file JDirection3D.hh.

    {
      T.transform(__dx, __dy, __dz);

      normalise();

      return *this;
    }

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JQuaternion3D &  Q )

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns

this position

Definition at line 319 of file JDirection3D.hh.

    {
      Q.rotate_back(__dx, __dy, __dz);

      return *this;
    }

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

inlineinherited

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 333 of file JDirection3D.hh.

    {
      return
        getDX() * angle.getDX() +
        getDY() * angle.getDY() +
        getDZ() * angle.getDZ();
    }

double JGEOMETRY3D::JDirection3D::getDot ( const JVector3D &  pos ) const

inlineinherited

Get dot product.

Parameters

pos

position

Returns

dot product

Definition at line 348 of file JDirection3D.hh.

    {
      return
        getDX() * pos.getX() +
        getDY() * pos.getY() +
        getDZ() * pos.getZ();
    }

double JGEOMETRY3D::JDirection3D::getDot ( const JVersor3Z &  dir ) const

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 363 of file JDirection3D.hh.

    {
      return
        getDX() * dir.getDX() +
        getDY() * dir.getDY() +
        getDZ() * dir.getDZ();
    }

double JGEOMETRY3D::JVersor3D::getDot ( const JVersor3D &  versor ) const

inlineinherited

Get dot product.

Parameters

versor

versor

Returns

dot product

Definition at line 153 of file JVersor3D.hh.

    {
      return
        getDX() * versor.getDX() + 
        getDY() * versor.getDY() +
        getDZ() * versor.getDZ();
    }

bool JGEOMETRY3D::JVersor3D::equals ( const JVersor3D &  versor, const double  precision = std::numeric_limits<double>::min()  ) const

inlineinherited

Check equality.

Parameters

versor	versor
precision	precision

Returns

true if versors are equal; else false

Definition at line 78 of file JVersor3D.hh.

    {
      return (fabs(getDX() - versor.getDX()) <= precision &&
              fabs(getDY() - versor.getDY()) <= precision &&
              fabs(getDZ() - versor.getDZ()) <= precision);
    }

double JGEOMETRY3D::JVersor3D::getDX ( ) const

inlineinherited

Get x direction.

Returns

x direction

Definition at line 92 of file JVersor3D.hh.

    {
      return __dx;
    }

double JGEOMETRY3D::JVersor3D::getDY ( ) const

inlineinherited

Get y direction.

Returns

y direction

Definition at line 103 of file JVersor3D.hh.

    {
      return __dy;
    }

double JGEOMETRY3D::JVersor3D::getDZ ( ) const

inlineinherited

Get z direction.

Returns

z direction

Definition at line 114 of file JVersor3D.hh.

    {
      return __dz;
    }

double JGEOMETRY3D::JVersor3D::getTheta ( ) const

inlineinherited

Get theta angle.

Returns

theta angle [rad]

Definition at line 125 of file JVersor3D.hh.

    {
      if      (__dz > +1.0)
        return 0.0;
      else if (__dz < -1.0)
        return JTOOLS::PI;
      else
        return acos(__dz);
    }

double JGEOMETRY3D::JVersor3D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns

phi angle [rad]

Definition at line 141 of file JVersor3D.hh.

    { 
      return atan2(__dy, __dx);
    }

JVersor3D& JGEOMETRY3D::JVersor3D::normalise ( )

inlineinherited

Normalise versor.

This operation may set the result to the unit z-vector.

Returns

this versor

Definition at line 168 of file JVersor3D.hh.

    {
      const double v = sqrt(getDX()*getDX() + getDY()*getDY() + getDZ()*getDZ());

      if (v != 0.0) {
        __dx /= v;
        __dy /= v;
        __dz /= v;
      }

      return *this;
    }

JVersor3D & JMATH::JMath< JVersor3D , JNullType >::mul ( const JNullType &  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

std::istream& operator>> ( std::istream &  in, JAxis3D &  axis  )

friend

Read axis from input.

Parameters

in	input stream
axis	axis

Returns

input stream

Definition at line 472 of file JAxis3D.hh.

    {
      in >> static_cast<JPosition3D&> (axis);
      in >> static_cast<JDirection3D&>(axis);

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JAxis3D &  axis  )

friend

Write axis to output.

Parameters

out	output stream
axis	axis

Returns

output stream

Definition at line 488 of file JAxis3D.hh.

    {
      out << static_cast<const JPosition3D&> (axis);
      out << ' ';
      out << static_cast<const JDirection3D&>(axis);

      return out;
    }

JReader& operator>> ( JReader &  in, JAxis3D &  axis  )

friend

Read axis from input.

Parameters

in	reader
axis	axis

Returns

reader

Definition at line 505 of file JAxis3D.hh.

    {
      in >> static_cast<JPosition3D&> (axis);
      in >> static_cast<JDirection3D&>(axis);

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JAxis3D &  axis  )

friend

Write axis to output.

Parameters

out	writer
axis	axis

Returns

writer

Definition at line 521 of file JAxis3D.hh.

    {
      out << static_cast<const JPosition3D&> (axis);
      out << static_cast<const JDirection3D&>(axis);

      return out;
    }

Member Data Documentation

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 309 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 311 of file JVector3D.hh.

double JGEOMETRY3D::JVersor3D::__dx

protectedinherited

Definition at line 182 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dy

protectedinherited

Definition at line 183 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dz

protectedinherited

Definition at line 184 of file JVersor3D.hh.

---

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

• JAxis3D.hh