Jpp test-rotations-new
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Friends | List of all members
JDETECTOR::JModulePosition_t Struct Reference

Auxiliary data structure for module position. More...

#include <JDetectorCalibration.hh>

Inheritance diagram for JDETECTOR::JModulePosition_t:
JLANG::JObjectID JGEOMETRY3D::JPosition3D JLANG::JComparable< JObjectID > JLANG::JComparable< JObjectID, int > JGEOMETRY3D::JVector3D JMATH::JMath< JFirst_t, JSecond_t >

Public Member Functions

 JModulePosition_t ()
 Default constructor.
 
 JModulePosition_t (const JObjectID &id, const JPosition3D &position)
 Constructor.
 
int getID () const
 Get identifier.
 
int & getID ()
 Get identifier.
 
void setID (const int id)
 Set identifier.
 
bool less (const JObjectID &object) const
 Less than method.
 
bool less (const int id) const
 Less than method.
 
bool more (const int id) const
 More than method.
 
const JPosition3D & getPosition () const
 Get position.
 
JPosition3D & getPosition ()
 Get position.
 
void setPosition (const JVector3D &pos)
 Set position.
 
 operator JAngle3D () const
 Type conversion operator.
 
 operator JVersor3D () const
 Type conversion operator.
 
JPosition3D & rotate (const JRotation3D &R)
 Rotate.
 
JPosition3D & rotate (const JRotation3X &R)
 Rotate around X-axis.
 
JPosition3D & rotate (const JRotation3Y &R)
 Rotate around Y-axis.
 
JPosition3D & rotate (const JRotation3Z &R)
 Rotate around Z-axis.
 
JPosition3D & rotate (const JQuaternion3D &Q)
 Rotate.
 
JPosition3D & rotate_back (const JRotation3D &R)
 Rotate back.
 
JPosition3D & rotate_back (const JRotation3X &R)
 Rotate back around X-axis.
 
JPosition3D & rotate_back (const JRotation3Y &R)
 Rotate back around Y-axis.
 
JPosition3D & rotate_back (const JRotation3Z &R)
 Rotate back around Z-axis.
 
JPosition3D & rotate_back (const JQuaternion3D &Q)
 Rotate back.
 
void transform (const JRotation3D &R, const JVector3D &pos)
 Transform position.
 
JVector3D & transform (const JMatrix3D &T)
 Transform.
 
void transform_back (const JRotation3D &R, const JVector3D &pos)
 Transform back position.
 
double getDot (const JAngle3D &angle) const
 Get dot product.
 
double getDot (const JVersor3D &dir) const
 Get dot product.
 
double getDot (const JVersor3Z &dir) const
 Get dot product.
 
double getDot (const JVector3D &vector) const
 Get dot product.
 
 operator JVector2D () const
 Type conversion operator.
 
double getX () const
 Get x position.
 
double getY () const
 Get y position.
 
double getZ () const
 Get z position.
 
JVector3D & negate ()
 Negate vector.
 
JVector3D & add (const JVector3D &vector)
 Add vector.
 
JVector3D & sub (const JVector3D &vector)
 Subtract vector.
 
JVector3D & mul (const double factor)
 Scale vector.
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object.
 
JVector3D & div (const double factor)
 Scale vector.
 
bool equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
 Check equality.
 
double getLengthSquared () const
 Get length squared.
 
double getLength () const
 Get length.
 
double getDistanceSquared (const JVector3D &pos) const
 Get squared of distance to point.
 
double getDistance (const JVector3D &pos) const
 Get distance to point.
 
JVector3D & getCross (const JVector3D &first, const JVector3D &second)
 Get cross product.
 

Protected Attributes

int __id
 
double __x
 
double __y
 
double __z
 

Friends

void to_json (json &js, const JModulePosition_t &object)
 Convert module position to JSon.
 
void from_json (const json &js, JModulePosition_t &object)
 Convert JSon to module position.
 

Detailed Description

Auxiliary data structure for module position.

Definition at line 496 of file JDetectorCalibration.hh.

Constructor & Destructor Documentation

◆ JModulePosition_t() [1/2]

JDETECTOR::JModulePosition_t::JModulePosition_t ( )
inline

Default constructor.

Definition at line 503 of file JDetectorCalibration.hh.

504 {}

◆ JModulePosition_t() [2/2]

JDETECTOR::JModulePosition_t::JModulePosition_t ( const JObjectID & id,
const JPosition3D & position )
inline

Constructor.

Parameters
idmodule identifier
positionmodule position

Definition at line 513 of file JDetectorCalibration.hh.

514 :
515 JObjectID (id),
516 JPosition3D(position)
517 {}
JGEOMETRY3D::JPosition3D::JPosition3D
JPosition3D()
Default constructor.
Definition JPosition3D.hh:48
JLANG::JObjectID::JObjectID
JObjectID()
Default constructor.
Definition JObjectID.hh:30

Member Function Documentation

◆ getID() [1/2]

int JLANG::JObjectID::getID ( ) const
inlineinherited

Get identifier.

Returns
identifier

Definition at line 50 of file JObjectID.hh.

51 {
52 return __id;
53 }

◆ getID() [2/2]

int & JLANG::JObjectID::getID ( )
inlineinherited

Get identifier.

Returns
identifier

Definition at line 61 of file JObjectID.hh.

62 {
63 return __id;
64 }

◆ setID()

void JLANG::JObjectID::setID ( const int id)
inlineinherited

Set identifier.

Parameters
ididentifier

Definition at line 72 of file JObjectID.hh.

73 {
74 this->__id = id;
75 }

◆ less() [1/2]

bool JLANG::JObjectID::less ( const JObjectID & object) const
inlineinherited

Less than method.

Parameters
objectobject identifier
Returns
true if this identifier less than given identifier; else false

Definition at line 84 of file JObjectID.hh.

85 {
86 return this->getID() < object.getID();
87 }
JLANG::JObjectID::getID
int getID() const
Get identifier.
Definition JObjectID.hh:50

◆ less() [2/2]

bool JLANG::JObjectID::less ( const int id) const
inlineinherited

Less than method.

Parameters
ididentifier
Returns
true if this identifier less than given identifier; else false

Definition at line 96 of file JObjectID.hh.

97 {
98 return this->getID() < id;
99 }

◆ more()

bool JLANG::JObjectID::more ( const int id) const
inlineinherited

More than method.

Parameters
ididentifier
Returns
true if this identifier greater than given identifier; else false

Definition at line 108 of file JObjectID.hh.

109 {
110 return this->getID() > id;
111 }

◆ getPosition() [1/2]

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

Get position.

Returns
position

Definition at line 130 of file JPosition3D.hh.

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

◆ getPosition() [2/2]

JPosition3D & JGEOMETRY3D::JPosition3D::getPosition ( )
inlineinherited

Get position.

Returns
position

Definition at line 141 of file JPosition3D.hh.

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

◆ setPosition()

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

Set position.

Parameters
posposition

Definition at line 152 of file JPosition3D.hh.

153 {
154 static_cast<JVector3D&>(*this) = pos;
155 }
JGEOMETRY3D::JVector3D::JVector3D
JVector3D()
Default constructor.
Definition JVector3D.hh:41

◆ operator JAngle3D()

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const
inlineinherited

Type conversion operator.

Returns
angle

Definition at line 163 of file JPosition3D.hh.

164 {
165 return JAngle3D(getX(), getY(), getZ());
166 }
JGEOMETRY3D::JVector3D::getY
double getY() const
Get y position.
Definition JVector3D.hh:104
JGEOMETRY3D::JVector3D::getZ
double getZ() const
Get z position.
Definition JVector3D.hh:115
JGEOMETRY3D::JVector3D::getX
double getX() const
Get x position.
Definition JVector3D.hh:94

◆ operator JVersor3D()

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const
inlineinherited

Type conversion operator.

Returns
direction

Definition at line 174 of file JPosition3D.hh.

175 {
176 return JVersor3D(getX(), getY(), getZ());
177 }

◆ rotate() [1/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3D & R)
inlineinherited

Rotate.

Parameters
Rrotation matrix
Returns
this position

Definition at line 186 of file JPosition3D.hh.

187 {
188 R.rotate(__x, __y, __z);
189
190 return *this;
191 }

◆ rotate() [2/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3X & R)
inlineinherited

Rotate around X-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 214 of file JPosition3D.hh.

215 {
216 R.rotate(__y, __z);
217
218 return *this;
219 }

◆ rotate() [3/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Y & R)
inlineinherited

Rotate around Y-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 242 of file JPosition3D.hh.

243 {
244 R.rotate(__x, __z);
245
246 return *this;
247 }

◆ rotate() [4/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Z & R)
inlineinherited

Rotate around Z-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 270 of file JPosition3D.hh.

271 {
272 R.rotate(__x, __y);
273
274 return *this;
275 }

◆ rotate() [5/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate ( const JQuaternion3D & Q)
inlineinherited

Rotate.

Parameters
Qquaternion
Returns
this position

Definition at line 298 of file JPosition3D.hh.

299 {
300 Q.rotate(__x, __y, __z);
301
302 return *this;
303 }

◆ rotate_back() [1/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3D & R)
inlineinherited

Rotate back.

Parameters
Rrotation matrix
Returns
this position

Definition at line 200 of file JPosition3D.hh.

201 {
202 R.rotate_back(__x, __y, __z);
203
204 return *this;
205 }

◆ rotate_back() [2/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3X & R)
inlineinherited

Rotate back around X-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 228 of file JPosition3D.hh.

229 {
230 R.rotate_back(__y, __z);
231
232 return *this;
233 }

◆ rotate_back() [3/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Y & R)
inlineinherited

Rotate back around Y-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 256 of file JPosition3D.hh.

257 {
258 R.rotate_back(__x, __z);
259
260 return *this;
261 }

◆ rotate_back() [4/5]

JPosition3D & JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Z & R)
inlineinherited

Rotate back around Z-axis.

Parameters
Rrotation matrix
Returns
this position

Definition at line 284 of file JPosition3D.hh.

285 {
286 R.rotate_back(__x, __y);
287
288 return *this;
289 }

◆ rotate_back() [5/5]

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

Rotate back.

Parameters
Qquaternion
Returns
this position

Definition at line 312 of file JPosition3D.hh.

313 {
314 Q.rotate_back(__x, __y, __z);
315
316 return *this;
317 }

◆ transform() [1/2]

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

Transform position.

The final position is obtained as follows:

  1. rotation of the position according matrix R;
  2. offset position with pos;
  3. rotation of position around z-axis, such that final position lies in x-z plane;
Parameters
Rrotation matrix
posposition of origin (after rotation)

Definition at line 331 of file JPosition3D.hh.

333 {
334 // rotate geometry to system with particle direction along z-axis
335
336 rotate(R);
337
338 // offset with respect to origin
339
340 sub(pos);
341
342 // rotate geometry to x-z plane
343
344 __x = sqrt(__x*__x + __y*__y);
345 __y = 0.0;
346 }
JGEOMETRY3D::JPosition3D::rotate
JPosition3D & rotate(const JRotation3D &R)
Rotate.
Definition JPosition3D.hh:186
JGEOMETRY3D::JVector3D::sub
JVector3D & sub(const JVector3D &vector)
Subtract vector.
Definition JVector3D.hh:158

◆ transform() [2/2]

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

Transform.

Parameters
Tmatrix
Returns
this vector

Definition at line 206 of file JVector3D.hh.

207 {
208 T.transform(__x, __y, __z);
209
210 return *this;
211 }

◆ transform_back()

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

Transform back position.

The final position is obtained as follows:

  1. offset position with position pos;
  2. rotation of postion according matrix R;
Parameters
Rrotation matrix
posposition of origin (before rotation)

Definition at line 359 of file JPosition3D.hh.

361 {
362 // offset with respect to origin
363
364 add(pos);
365
366 // rotate back geometry to system with particle direction along z-axis
367
368 rotate_back(R);
369 }
JGEOMETRY3D::JPosition3D::rotate_back
JPosition3D & rotate_back(const JRotation3D &R)
Rotate back.
Definition JPosition3D.hh:200
JGEOMETRY3D::JVector3D::add
JVector3D & add(const JVector3D &vector)
Add vector.
Definition JVector3D.hh:142

◆ getDot() [1/4]

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

Get dot product.

Parameters
angleangle
Returns
dot product

Definition at line 378 of file JPosition3D.hh.

379 {
380 return
381 getX() * angle.getDX() +
382 getY() * angle.getDY() +
383 getZ() * angle.getDZ();
384 }

◆ getDot() [2/4]

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

Get dot product.

Parameters
dirdirection
Returns
dot product

Definition at line 393 of file JPosition3D.hh.

394 {
395 return
396 getX() * dir.getDX() +
397 getY() * dir.getDY() +
398 getZ() * dir.getDZ();
399 }

◆ getDot() [3/4]

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

Get dot product.

Parameters
dirdirection
Returns
dot product

Definition at line 408 of file JPosition3D.hh.

409 {
410 return
411 getX() * dir.getDX() +
412 getY() * dir.getDY() +
413 getZ() * dir.getDZ();
414 }

◆ getDot() [4/4]

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

Get dot product.

Parameters
vectorvector
Returns
dot product

Definition at line 282 of file JVector3D.hh.

283 {
284 return
285 getX() * vector.getX() +
286 getY() * vector.getY() +
287 getZ() * vector.getZ();
288 }

◆ operator JVector2D()

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const
inlineinherited

Type conversion operator.

Returns
JVector2D

Definition at line 83 of file JVector3D.hh.

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

◆ getX()

double JGEOMETRY3D::JVector3D::getX ( ) const
inlineinherited

Get x position.

Returns
x position

Definition at line 94 of file JVector3D.hh.

95 {
96 return __x;
97 }

◆ getY()

double JGEOMETRY3D::JVector3D::getY ( ) const
inlineinherited

Get y position.

Returns
y position

Definition at line 104 of file JVector3D.hh.

105 {
106 return __y;
107 }

◆ getZ()

double JGEOMETRY3D::JVector3D::getZ ( ) const
inlineinherited

Get z position.

Returns
z position

Definition at line 115 of file JVector3D.hh.

116 {
117 return __z;
118 }

◆ negate()

JVector3D & JGEOMETRY3D::JVector3D::negate ( )
inlineinherited

Negate vector.

Returns
this vector

Definition at line 126 of file JVector3D.hh.

127 {
128 __x = -__x;
129 __y = -__y;
130 __z = -__z;
131
132 return *this;
133 }

◆ add()

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

Add vector.

Parameters
vectorvector
Returns
this vector

Definition at line 142 of file JVector3D.hh.

143 {
144 __x += vector.getX();
145 __y += vector.getY();
146 __z += vector.getZ();
147
148 return *this;
149 }

◆ sub()

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

Subtract vector.

Parameters
vectorvector
Returns
this vector

Definition at line 158 of file JVector3D.hh.

159 {
160 __x -= vector.getX();
161 __y -= vector.getY();
162 __z -= vector.getZ();
163
164 return *this;
165 }

◆ mul() [1/2]

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

Scale vector.

Parameters
factormultiplication factor
Returns
this vector

Definition at line 174 of file JVector3D.hh.

175 {
176 __x *= factor;
177 __y *= factor;
178 __z *= factor;
179
180 return *this;
181 }

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >
JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

355 {
356 return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
357 }

◆ div()

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

Scale vector.

Parameters
factordivision factor
Returns
this vector

Definition at line 190 of file JVector3D.hh.

191 {
192 __x /= factor;
193 __y /= factor;
194 __z /= factor;
195
196 return *this;
197 }

◆ equals()

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

Check equality.

Parameters
vectorvector
precisionprecision
Returns
true if vectors are equal; else false

Definition at line 221 of file JVector3D.hh.

223 {
224 return (fabs(getX() - vector.getX()) <= precision &&
225 fabs(getY() - vector.getY()) <= precision &&
226 fabs(getZ() - vector.getZ()) <= precision);
227 }

◆ getLengthSquared()

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const
inlineinherited

Get length squared.

Returns
square of length

Definition at line 235 of file JVector3D.hh.

236 {
237 return getX()*getX() + getY()*getY() + getZ()*getZ();
238 }

◆ getLength()

double JGEOMETRY3D::JVector3D::getLength ( ) const
inlineinherited

Get length.

Returns
length

Definition at line 246 of file JVector3D.hh.

247 {
248 return sqrt(getLengthSquared());
249 }
JGEOMETRY3D::JVector3D::getLengthSquared
double getLengthSquared() const
Get length squared.
Definition JVector3D.hh:235

◆ getDistanceSquared()

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

Get squared of distance to point.

Parameters
posposition
Returns
square of distance

Definition at line 258 of file JVector3D.hh.

259 {
260 return JVector3D(pos).sub(*this).getLengthSquared();
261 }

◆ getDistance()

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

Get distance to point.

Parameters
posposition
Returns
distance

Definition at line 270 of file JVector3D.hh.

271 {
272 return sqrt(getDistanceSquared(pos));
273 }
JGEOMETRY3D::JVector3D::getDistanceSquared
double getDistanceSquared(const JVector3D &pos) const
Get squared of distance to point.
Definition JVector3D.hh:258

◆ getCross()

JVector3D & JGEOMETRY3D::JVector3D::getCross ( const JVector3D & first,
const JVector3D & second )
inlineinherited

Get cross product.

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

Parameters
firstfirst vector
secondsecond vector
Returns
this vector

Definition at line 299 of file JVector3D.hh.

301 {
302 __x = first .getY() * second.getZ() - second.getY() * first .getZ();
303 __y = second.getX() * first .getZ() - first .getX() * second.getZ();
304 __z = first .getX() * second.getY() - second.getX() * first .getY();
305
306 return *this;
307 }

Friends And Related Symbol Documentation

◆ to_json

void to_json ( json & js,
const JModulePosition_t & object )
friend

Convert module position to JSon.

Parameters
jsjson
objectmodule position

Definition at line 526 of file JDetectorCalibration.hh.

527 {
528 js = json{ { Id_t, object.getID() },
529 { PX_t, object.getX() },
530 { PY_t, object.getY() },
531 { PZ_t, object.getZ() } };
532 }
json
nlohmann::json json
Definition JSupernovaProcessor.cc:37
JSON::Id_t
static const std::string Id_t
Definition JSon/JSupport.hh:222
JSON::PX_t
static const std::string PX_t
Definition JSon/JSupport.hh:226
JSON::PZ_t
static const std::string PZ_t
Definition JSon/JSupport.hh:228
JSON::PY_t
static const std::string PY_t
Definition JSon/JSupport.hh:227

◆ from_json

void from_json ( const json & js,
JModulePosition_t & object )
friend

Convert JSon to module position.

Parameters
jsjson
objectmodule position

Definition at line 541 of file JDetectorCalibration.hh.

542 {
543 if (js.contains(DOMId_t))
544 object.setID(js.at(DOMId_t).get<int>());
545 else if (js.contains(Id_t))
546 object.setID(js.at(Id_t) .get<int>());
547 else
548 THROW(JNoValue, "Missing module identifier.");
549
550 object.setPosition(JPosition3D(js.at(PX_t).get<double>(),
551 js.at(PY_t).get<double>(),
552 js.at(PZ_t).get<double>()));
553 }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition JException.hh:712
JSON::DOMId_t
static const std::string DOMId_t
Definition JSon/JSupport.hh:221

Member Data Documentation

◆ __id

int JLANG::JObjectID::__id
protectedinherited

Definition at line 140 of file JObjectID.hh.

◆ __x

double JGEOMETRY3D::JVector3D::__x
protectedinherited

Definition at line 310 of file JVector3D.hh.

◆ __y

double JGEOMETRY3D::JVector3D::__y
protectedinherited

Definition at line 311 of file JVector3D.hh.

◆ __z

double JGEOMETRY3D::JVector3D::__z
protectedinherited

Definition at line 312 of file JVector3D.hh.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.12.0