Jpp
Public Member Functions | Protected Attributes | Friends | List of all members
JGEOMETRY3D::JDirection3D Class Reference

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

#include <JDirection3D.hh>

Inheritance diagram for JGEOMETRY3D::JDirection3D:
JGEOMETRY3D::JVersor3D JMATH::JMath< JVersor3D > JGEOMETRY3D::JAxis3D JDETECTOR::JPMT JGEOMETRY3D::JTrack3D JTRIGGER::JHitL0 JTRIGGER::JPMTHeader JFIT::JPMTW0 JGEOMETRY3D::JTrack3E JFIT::JHitW0 JTRIGGER::JFrame< JElement_t, JAllocator_t > JTRIGGER::JFrameClone< JElement_t, JAllocator_t >

Public Member Functions

 JDirection3D ()
 Default constructor. More...
 
 JDirection3D (const JVersor3D &dir)
 Constructor. More...
 
 JDirection3D (const JAngle3D &angle)
 Constructor. More...
 
 JDirection3D (const JVector3D &pos)
 Constructor. More...
 
 JDirection3D (const JVersor3Z &dir)
 Constructor. More...
 
 JDirection3D (const double dx, const double dy, const double dz)
 Constructor. 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 (const JRotation3D &R)
 Rotate. More...
 
JDirection3D & rotate_back (const JRotation3D &R)
 Rotate back. More...
 
JDirection3D & rotate (const JRotation3X &R)
 Rotate around X-axis. More...
 
JDirection3D & rotate_back (const JRotation3X &R)
 Rotate back around X-axis. More...
 
JDirection3D & rotate (const JRotation3Y &R)
 Rotate around Y-axis. More...
 
JDirection3D & rotate_back (const JRotation3Y &R)
 Rotate back around Y-axis. More...
 
JDirection3D & rotate (const JRotation3Z &R)
 Rotate around Z-axis. More...
 
JDirection3D & rotate_back (const JRotation3Z &R)
 Rotate back around Z-axis. More...
 
JDirection3D & rotate (const JQuaternion3D &Q)
 Rotate. 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...
 
JVersor3D & negate ()
 Negate versor. 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...
 
double getDot (const JVersor3D &versor) const
 Get dot product. More...
 
JVersor3D & normalise ()
 Normalise versor. More...
 
JVersor3D & mul (const JSecond_t &object)
 Multiply with object. More...
 

Protected Attributes

double __dx
 
double __dy
 
double __dz
 

Friends

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

Detailed Description

Data structure for direction in three dimensions.

Definition at line 32 of file JDirection3D.hh.

Constructor & Destructor Documentation

◆ JDirection3D() [1/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( )
inline

Default constructor.

Definition at line 42 of file JDirection3D.hh.

42  :
43  JVersor3D()
44  {}

◆ JDirection3D() [2/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVersor3D &  dir)
inline

Constructor.

Parameters
dirdirection

Definition at line 52 of file JDirection3D.hh.

52  :
53  JVersor3D(dir)
54  {}

◆ JDirection3D() [3/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JAngle3D &  angle)
inline

Constructor.

Parameters
angleangle

Definition at line 62 of file JDirection3D.hh.

62  :
63  JVersor3D(angle.getDX(), angle.getDY(), angle.getDZ())
64  {}

◆ JDirection3D() [4/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVector3D &  pos)
inline

Constructor.

Parameters
posposition

Definition at line 72 of file JDirection3D.hh.

72  :
73  JVersor3D(pos.getX(), pos.getY(), pos.getZ())
74  {}

◆ JDirection3D() [5/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVersor3Z &  dir)
inline

Constructor.

Parameters
dirdirection

Definition at line 82 of file JDirection3D.hh.

82  :
83  JVersor3D(dir.getDX(), dir.getDY(), dir.getDZ())
84  {}

◆ JDirection3D() [6/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const double  dx,
const double  dy,
const double  dz 
)
inline

Constructor.

Parameters
dxdx value
dydy value
dzdz value

Definition at line 94 of file JDirection3D.hh.

96  :
97  JVersor3D(dx, dy, dz)
98  {}

Member Function Documentation

◆ getDirection() [1/2]

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

Get direction.

Returns
direction

Definition at line 106 of file JDirection3D.hh.

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

◆ getDirection() [2/2]

JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( )
inline

Get direction.

Returns
direction

Definition at line 117 of file JDirection3D.hh.

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

◆ setDirection()

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

Set direction.

Parameters
dirdirection

Definition at line 128 of file JDirection3D.hh.

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

◆ operator JAngle3D()

JGEOMETRY3D::JDirection3D::operator JAngle3D ( ) const
inline

Type conversion operator.

Returns
angle

Definition at line 138 of file JDirection3D.hh.

139  {
140  return JAngle3D(getDX(), getDY(), getDZ());
141  }

◆ operator JVector3D()

JGEOMETRY3D::JDirection3D::operator JVector3D ( ) const
inline

Type conversion operator.

Returns
position

Definition at line 149 of file JDirection3D.hh.

150  {
151  return JVector3D(getDX(), getDY(), getDZ());
152  }

◆ transform()

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

Transform.

Parameters
Tmatrix
Returns
this direction

Definition at line 161 of file JDirection3D.hh.

162  {
163  T.transform(__dx, __dy, __dz);
164 
165  normalise();
166 
167  return *this;
168  }

◆ rotate() [1/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3D &  R)
inline

Rotate.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 177 of file JDirection3D.hh.

178  {
179  R.rotate(__dx, __dy, __dz);
180 
181  normalise();
182 
183  return *this;
184  }

◆ rotate_back() [1/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3D &  R)
inline

Rotate back.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 193 of file JDirection3D.hh.

194  {
195  R.rotate_back(__dx, __dy, __dz);
196 
197  normalise();
198 
199  return *this;
200  }

◆ rotate() [2/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3X &  R)
inline

Rotate around X-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 209 of file JDirection3D.hh.

210  {
211  R.rotate(__dy, __dz);
212 
213  normalise();
214 
215  return *this;
216  }

◆ rotate_back() [2/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3X &  R)
inline

Rotate back around X-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 225 of file JDirection3D.hh.

226  {
227  R.rotate_back(__dy, __dz);
228 
229  normalise();
230 
231  return *this;
232  }

◆ rotate() [3/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3Y &  R)
inline

Rotate around Y-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 241 of file JDirection3D.hh.

242  {
243  R.rotate(__dx, __dz);
244 
245  normalise();
246 
247  return *this;
248  }

◆ rotate_back() [3/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3Y &  R)
inline

Rotate back around Y-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 257 of file JDirection3D.hh.

258  {
259  R.rotate_back(__dx, __dz);
260 
261  normalise();
262 
263  return *this;
264  }

◆ rotate() [4/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3Z &  R)
inline

Rotate around Z-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 273 of file JDirection3D.hh.

274  {
275  R.rotate(__dx, __dy);
276 
277  normalise();
278 
279  return *this;
280  }

◆ rotate_back() [4/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3Z &  R)
inline

Rotate back around Z-axis.

Parameters
Rrotation matrix
Returns
this direction

Definition at line 289 of file JDirection3D.hh.

290  {
291  R.rotate_back(__dx, __dy);
292 
293  normalise();
294 
295  return *this;
296  }

◆ rotate() [5/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JQuaternion3D &  Q)
inline

Rotate.

Parameters
Qquaternion
Returns
this position

Definition at line 305 of file JDirection3D.hh.

306  {
307  Q.rotate(__dx, __dy, __dz);
308 
309  return *this;
310  }

◆ rotate_back() [5/5]

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

Rotate back.

Parameters
Qquaternion
Returns
this position

Definition at line 319 of file JDirection3D.hh.

320  {
321  Q.rotate_back(__dx, __dy, __dz);
322 
323  return *this;
324  }

◆ getDot() [1/5]

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

Get dot product.

Parameters
angleangle
Returns
dot product

Definition at line 333 of file JDirection3D.hh.

334  {
335  return
336  getDX() * angle.getDX() +
337  getDY() * angle.getDY() +
338  getDZ() * angle.getDZ();
339  }

◆ getDot() [2/5]

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

Get dot product.

Parameters
posposition
Returns
dot product

Definition at line 348 of file JDirection3D.hh.

349  {
350  return
351  getDX() * pos.getX() +
352  getDY() * pos.getY() +
353  getDZ() * pos.getZ();
354  }

◆ getDot() [3/5]

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

Get dot product.

Parameters
dirdirection
Returns
dot product

Definition at line 363 of file JDirection3D.hh.

364  {
365  return
366  getDX() * dir.getDX() +
367  getDY() * dir.getDY() +
368  getDZ() * dir.getDZ();
369  }

◆ getDot() [4/5]

double JGEOMETRY3D::JVersor3D::getDot
inline

Get dot product.

Parameters
versorversor
Returns
dot product

Definition at line 152 of file JVersor3D.hh.

153  {
154  return
155  getDX() * versor.getDX() +
156  getDY() * versor.getDY() +
157  getDZ() * versor.getDZ();
158  }

◆ negate()

JVersor3D& JGEOMETRY3D::JVersor3D::negate ( )
inlineinherited

Negate versor.

Returns
this versor

Definition at line 61 of file JVersor3D.hh.

62  {
63  __dx = -__dx;
64  __dy = -__dy;
65  __dz = -__dz;
66 
67  return *this;
68  }

◆ equals()

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

Check equality.

Parameters
versorversor
Returns
true if versors are equal; else false

Definition at line 77 of file JVersor3D.hh.

79  {
80  return (fabs(getDX() - versor.getDX()) <= precision &&
81  fabs(getDY() - versor.getDY()) <= precision &&
82  fabs(getDZ() - versor.getDZ()) <= precision);
83  }

◆ getDX()

double JGEOMETRY3D::JVersor3D::getDX ( ) const
inlineinherited

Get x direction.

Returns
x direction

Definition at line 91 of file JVersor3D.hh.

92  {
93  return __dx;
94  }

◆ getDY()

double JGEOMETRY3D::JVersor3D::getDY ( ) const
inlineinherited

Get y direction.

Returns
y direction

Definition at line 102 of file JVersor3D.hh.

103  {
104  return __dy;
105  }

◆ getDZ()

double JGEOMETRY3D::JVersor3D::getDZ ( ) const
inlineinherited

Get z direction.

Returns
z direction

Definition at line 113 of file JVersor3D.hh.

114  {
115  return __dz;
116  }

◆ getTheta()

double JGEOMETRY3D::JVersor3D::getTheta ( ) const
inlineinherited

Get theta angle.

Returns
theta angle [rad]

Definition at line 124 of file JVersor3D.hh.

125  {
126  if (__dz > +1.0)
127  return 0.0;
128  else if (__dz < -1.0)
129  return JTOOLS::PI;
130  else
131  return acos(__dz);
132  }

◆ getPhi()

double JGEOMETRY3D::JVersor3D::getPhi ( ) const
inlineinherited

Get phi angle.

Returns
phi angle [rad]

Definition at line 140 of file JVersor3D.hh.

141  {
142  return atan2(__dy, __dx);
143  }

◆ getDot() [5/5]

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

Get dot product.

Parameters
versorversor
Returns
dot product

Definition at line 152 of file JVersor3D.hh.

153  {
154  return
155  getDX() * versor.getDX() +
156  getDY() * versor.getDY() +
157  getDZ() * versor.getDZ();
158  }

◆ normalise()

JVersor3D& JGEOMETRY3D::JVersor3D::normalise ( )
inlineinherited

Normalise versor.

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

Returns
this versor

Definition at line 167 of file JVersor3D.hh.

168  {
169  const double v = sqrt(getDX()*getDX() + getDY()*getDY() + getDZ()*getDZ());
170 
171  if (v != 0.0) {
172  __dx /= v;
173  __dy /= v;
174  __dz /= v;
175  }
176 
177  return *this;
178  }

◆ mul()

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

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 273 of file JMath.hh.

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

Friends And Related Function Documentation

◆ operator>> [1/2]

std::istream& operator>> ( std::istream &  in,
JDirection3D &  direction 
)
friend

Read direction from input.

Parameters
ininput stream
directiondirection
Returns
input stream

Definition at line 379 of file JDirection3D.hh.

380  {
381  in >> direction.__dx >> direction.__dy >> direction.__dz;
382 
383  return in;
384  }

◆ operator<< [1/2]

std::ostream& operator<< ( std::ostream &  out,
const JDirection3D &  direction 
)
friend

Write direction to output.

Parameters
outoutput stream
directiondirection
Returns
output stream

Definition at line 394 of file JDirection3D.hh.

395  {
396  out << direction.getDX() << ' ' << direction.getDY() << ' ' << direction.getDZ();
397 
398  return out;
399  }

◆ operator>> [2/2]

JReader& operator>> ( JReader &  in,
JDirection3D &  direction 
)
friend

Read direction from input.

Parameters
inreader
directiondirection
Returns
reader

Definition at line 409 of file JDirection3D.hh.

410  {
411  return in >> direction.__dx >> direction.__dy >> direction.__dz;
412  }

◆ operator<< [2/2]

JWriter& operator<< ( JWriter &  out,
const JDirection3D &  direction 
)
friend

Write direction to output.

Parameters
outwriter
directiondirection
Returns
writer

Definition at line 422 of file JDirection3D.hh.

423  {
424  return out << direction.getDX() << direction.getDY() << direction.getDZ();
425  }

Member Data Documentation

◆ __dx

double JGEOMETRY3D::JVersor3D::__dx
protectedinherited

Definition at line 181 of file JVersor3D.hh.

◆ __dy

double JGEOMETRY3D::JVersor3D::__dy
protectedinherited

Definition at line 182 of file JVersor3D.hh.

◆ __dz

double JGEOMETRY3D::JVersor3D::__dz
protectedinherited

Definition at line 183 of file JVersor3D.hh.

The documentation for this class was generated from the following file:
JGEOMETRY3D::JVersor3D::getDZ
double getDZ() const
Get z direction.
Definition: JVersor3D.hh:113
JGEOMETRY3D::JVersor3D::__dz
double __dz
Definition: JVersor3D.hh:183
JGEOMETRY2D::JRotation2D::rotate_back
void rotate_back(double &__x, double &__y) const
Rotate back.
Definition: JRotation2D.hh:112
JGEOMETRY3D::JRotation3D::rotate
void rotate(double &__x, double &__y, double &__z) const
Rotate.
Definition: JRotation3D.hh:336
JGEOMETRY3D::JVersor3D::__dx
double __dx
Definition: JVersor3D.hh:181
JGEOMETRY3D::JRotation3D::rotate_back
void rotate_back(double &__x, double &__y, double &__z) const
Rotate back.
Definition: JRotation3D.hh:355
JGEOMETRY3D::JQuaternion3D::rotate_back
void rotate_back(double &__x, double &__y, double &__z) const
Rotate back.
Definition: JQuaternion3D.hh:668
JGEOMETRY3D::JVector3D::getZ
double getZ() const
Get z position.
Definition: JVector3D.hh:114
JGEOMETRY3D::JVector3D
Data structure for vector in three dimensions.
Definition: JVector3D.hh:33
JGEOMETRY2D::JRotation2D::rotate
void rotate(double &__x, double &__y) const
Rotate.
Definition: JRotation2D.hh:96
JGEOMETRY3D::JVersor3D::JVersor3D
JVersor3D()
Default constructor.
Definition: JVersor3D.hh:31
JGEOMETRY3D::JAngle3D::getDX
double getDX() const
Get x direction.
Definition: JAngle3D.hh:106
JGEOMETRY3D::JVersor3D::getDX
double getDX() const
Get x direction.
Definition: JVersor3D.hh:91
JGEOMETRY3D::JVersor3D::getDY
double getDY() const
Get y direction.
Definition: JVersor3D.hh:102
JGEOMETRY3D::JVersor3D::__dy
double __dy
Definition: JVersor3D.hh:182
JTOOLS::v
data_type v[N+1][M+1]
Definition: JPolint.hh:707
JGEOMETRY3D::JAngle3D
Data structure for angles in three dimensions.
Definition: JAngle3D.hh:31
JGEOMETRY3D::JAngle3D::getDZ
double getDZ() const
Get z direction.
Definition: JAngle3D.hh:128
JGEOMETRY3D::JVersor3D::normalise
JVersor3D & normalise()
Normalise versor.
Definition: JVersor3D.hh:167
JGEOMETRY3D::JVector3D::getY
double getY() const
Get y position.
Definition: JVector3D.hh:103
JTOOLS::PI
static const double PI
Constants.
Definition: JConstants.hh:20
JGEOMETRY3D::JAngle3D::getDY
double getDY() const
Get y direction.
Definition: JAngle3D.hh:117
JGEOMETRY3D::JVersor3Z::getDY
double getDY() const
Get y direction.
Definition: JVersor3Z.hh:156
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18
JGEOMETRY3D::JVector3D::getX
double getX() const
Get x position.
Definition: JVector3D.hh:93
JGEOMETRY3D::JVersor3Z::getDZ
double getDZ() const
Get z direction.
Definition: JVersor3Z.hh:167
JGEOMETRY3D::JQuaternion3D::rotate
void rotate(double &__x, double &__y, double &__z) const
Rotate.
Definition: JQuaternion3D.hh:645
JGEOMETRY3D::JVersor3Z::getDX
double getDX() const
Get x direction.
Definition: JVersor3Z.hh:145
Generated by   doxygen 1.8.16