Class describing a generic position vector (point) in 3 dimensions.
Class describing a 3D Position vector.
This class is templated on the type of Coordinate system. One example is the XYZPoint which is a vector based on double precision x,y,z data members by using the ROOT::Math::Cartesian3D<double> Coordinate system. The class is having also an extra template parameter, the coordinate system tag, to be able to identify (tag) vector described in different reference coordinate system, like global or local coordinate systems.
Definition at line 55 of file PositionVector3D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
constexpr | PositionVector3D () |
Default constructor. | |
template<class T > | |
constexpr | PositionVector3D (const DisplacementVector3D< T, Tag > &p) |
Construct from an arbitrary displacement vector. | |
template<class ForeignVector > | |
constexpr | PositionVector3D (const ForeignVector &v) |
Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z() | |
template<class T > | |
constexpr | PositionVector3D (const PositionVector3D< T, Tag > &v) |
Construct from a position vector expressed in different coordinates, or using a different Scalar type. | |
constexpr | PositionVector3D (const Scalar &a, const Scalar &b, const Scalar &c) |
Construct from three values of type Scalar. | |
const CoordSystem & | Coordinates () const |
Retrieve a copy of the coordinates object. | |
template<class OtherCoords > | |
PositionVector3D | Cross (const DisplacementVector3D< OtherCoords, Tag > &v) const |
Return vector (Cross) product of this point with a displacement, as a point vector in this coordinate system of the first. | |
unsigned int | Dimension () const |
Dimension. | |
template<class OtherCoords > | |
Scalar | Dot (const DisplacementVector3D< OtherCoords, Tag > &v) const |
Return the scalar (Dot) product of this with a displacement vector in any coordinate system, but with the same tag. | |
Scalar | Eta () const |
Polar eta, converting if necessary from internal coordinate system. | |
Scalar | eta () const |
template<class IT > | |
void | GetCoordinates (IT begin) const |
get internal data into 3 Scalars at *begin | |
template<class IT > | |
void | GetCoordinates (IT begin, IT end) const |
get internal data into 3 Scalars at *begin to *end (3 past begin) | |
void | GetCoordinates (Scalar &a, Scalar &b, Scalar &c) const |
get internal data into 3 Scalar numbers | |
void | GetCoordinates (Scalar dest[]) const |
get internal data into a C-style array of 3 Scalar numbers | |
Scalar | Mag2 () const |
Magnitute squared ( r^2 in spherical coordinate) | |
Scalar | mag2 () const |
bool | operator!= (const PositionVector3D &rhs) const |
PositionVector3D | operator* (Scalar a) const |
Multiply a vector by a real number. | |
PositionVector3D & | operator*= (Scalar a) |
multiply this vector by a scalar quantity | |
template<class OtherCoords > | |
PositionVector3D & | operator+= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Self Addition with a displacement vector. | |
template<class OtherCoords > | |
PositionVector3D & | operator-= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Self Difference with a displacement vector. | |
PositionVector3D | operator/ (Scalar a) const |
Division of a vector with a real number. | |
PositionVector3D & | operator/= (Scalar a) |
divide this vector by a scalar quantity | |
template<class OtherCoords > | |
PositionVector3D & | operator= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Assignment operator from a displacement vector of arbitrary type. | |
template<class ForeignVector > | |
PositionVector3D & | operator= (const ForeignVector &v) |
Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z() | |
template<class OtherCoords > | |
PositionVector3D & | operator= (const PositionVector3D< OtherCoords, Tag > &v) |
Assignment operator from a position vector of arbitrary type. | |
bool | operator== (const PositionVector3D &rhs) const |
Exact equality. | |
Scalar | Perp2 () const |
Transverse component squared (rho^2 in cylindrical coordinates. | |
Scalar | perp2 () const |
Scalar | Phi () const |
Polar phi, converting if necessary from internal coordinate system. | |
Scalar | phi () const |
Scalar | R () const |
Polar R, converting if necessary from internal coordinate system. | |
Scalar | r () const |
Scalar | Rho () const |
Cylindrical transverse component rho. | |
Scalar | rho () const |
PositionVector3D< CoordSystem, Tag > & | SetCoordinates (const Scalar src[]) |
Set internal data based on a C-style array of 3 Scalar numbers. | |
template<class IT > | |
PositionVector3D< CoordSystem, Tag > & | SetCoordinates (IT begin, IT end) |
Set internal data based on 3 Scalars at *begin to *end. | |
PositionVector3D< CoordSystem, Tag > & | SetCoordinates (Scalar a, Scalar b, Scalar c) |
Set internal data based on 3 Scalar numbers. | |
PositionVector3D< CoordSystem, Tag > & | SetEta (Scalar etaval) |
Change Eta - CylindricalEta3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetPhi (Scalar ang) |
Change Phi - Polar3D or CylindricalEta3D coordinates. | |
PositionVector3D< CoordSystem, Tag > & | SetR (Scalar rr) |
Change R - Polar3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetRho (Scalar rr) |
Change Rho - CylindricalEta3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetTheta (Scalar ang) |
Change Theta - Polar3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetX (Scalar xx) |
Change X - Cartesian3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetXYZ (Scalar a, Scalar b, Scalar c) |
set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form) | |
PositionVector3D< CoordSystem, Tag > & | SetY (Scalar yy) |
Change Y - Cartesian3D coordinates only. | |
PositionVector3D< CoordSystem, Tag > & | SetZ (Scalar zz) |
Change Z - Cartesian3D coordinates only. | |
Scalar | Theta () const |
Polar theta, converting if necessary from internal coordinate system. | |
Scalar | theta () const |
Scalar | X () const |
Cartesian X, converting if necessary from internal coordinate system. | |
Scalar | x () const |
Scalar | Y () const |
Cartesian Y, converting if necessary from internal coordinate system. | |
Scalar | y () const |
Scalar | Z () const |
Cartesian Z, converting if necessary from internal coordinate system. | |
Scalar | z () const |
Private Member Functions | |
template<class OtherCoords , class OtherTag > | |
constexpr | PositionVector3D (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
constexpr | PositionVector3D (const PositionVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector3D & | operator+= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector3D & | operator-= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector3D & | operator= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector3D & | operator= (const PositionVector3D< OtherCoords, OtherTag > &) |
Private Attributes | |
CoordSystem | fCoordinates |
Static Private Attributes | |
static constexpr unsigned int | fDimension = CoordinateType::Dimension |
#include <Math/GenVector/PositionVector3D.h>
typedef Tag ROOT::Math::PositionVector3D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 61 of file PositionVector3D.h.
typedef CoordSystem ROOT::Math::PositionVector3D< CoordSystem, Tag >::CoordinateType |
Definition at line 60 of file PositionVector3D.h.
typedef CoordSystem::Scalar ROOT::Math::PositionVector3D< CoordSystem, Tag >::Scalar |
Definition at line 59 of file PositionVector3D.h.
|
inlineconstexpr |
Default constructor.
Construct an empty object with zero values
Definition at line 69 of file PositionVector3D.h.
|
inlineconstexpr |
Construct from three values of type Scalar.
In the case of a XYZPoint the values are x,y,z In the case of a polar vector they are r,theta,phi
Definition at line 76 of file PositionVector3D.h.
|
inlineexplicitconstexpr |
Construct from a position vector expressed in different coordinates, or using a different Scalar type.
Definition at line 84 of file PositionVector3D.h.
|
inlineexplicitconstexpr |
Construct from an arbitrary displacement vector.
Definition at line 91 of file PositionVector3D.h.
|
inlineexplicitconstexpr |
Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()
Definition at line 99 of file PositionVector3D.h.
|
explicitconstexprprivate |
|
explicitconstexprprivate |
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 170 of file PositionVector3D.h.
|
inline |
Return vector (Cross) product of this point with a displacement, as a point vector in this coordinate system of the first.
Definition at line 382 of file PositionVector3D.h.
|
inline |
Dimension.
Definition at line 262 of file PositionVector3D.h.
|
inline |
Return the scalar (Dot) product of this with a displacement vector in any coordinate system, but with the same tag.
Definition at line 372 of file PositionVector3D.h.
|
inline |
Polar eta, converting if necessary from internal coordinate system.
Definition at line 300 of file PositionVector3D.h.
|
inline |
Definition at line 461 of file PositionVector3D.h.
|
inline |
get internal data into 3 Scalars at *begin
Definition at line 225 of file PositionVector3D.h.
|
inline |
get internal data into 3 Scalars at *begin to *end (3 past begin)
Definition at line 214 of file PositionVector3D.h.
|
inline |
get internal data into 3 Scalar numbers
Definition at line 201 of file PositionVector3D.h.
|
inline |
get internal data into a C-style array of 3 Scalar numbers
Definition at line 207 of file PositionVector3D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 312 of file PositionVector3D.h.
|
inline |
Definition at line 463 of file PositionVector3D.h.
|
inline |
Definition at line 253 of file PositionVector3D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 438 of file PositionVector3D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 420 of file PositionVector3D.h.
|
private |
|
inline |
Self Addition with a displacement vector.
Definition at line 401 of file PositionVector3D.h.
|
private |
|
inline |
Self Difference with a displacement vector.
Definition at line 411 of file PositionVector3D.h.
|
inline |
Division of a vector with a real number.
Definition at line 447 of file PositionVector3D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 428 of file PositionVector3D.h.
|
private |
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 135 of file PositionVector3D.h.
|
inline |
Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()
Definition at line 146 of file PositionVector3D.h.
|
private |
|
inline |
Assignment operator from a position vector of arbitrary type.
Definition at line 125 of file PositionVector3D.h.
|
inline |
Exact equality.
Definition at line 250 of file PositionVector3D.h.
|
inline |
Transverse component squared (rho^2 in cylindrical coordinates.
Definition at line 317 of file PositionVector3D.h.
|
inline |
Definition at line 464 of file PositionVector3D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 295 of file PositionVector3D.h.
|
inline |
Definition at line 460 of file PositionVector3D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 285 of file PositionVector3D.h.
|
inline |
Definition at line 458 of file PositionVector3D.h.
|
inline |
Cylindrical transverse component rho.
Definition at line 305 of file PositionVector3D.h.
|
inline |
Definition at line 462 of file PositionVector3D.h.
|
inline |
Set internal data based on a C-style array of 3 Scalar numbers.
Definition at line 177 of file PositionVector3D.h.
|
inline |
Set internal data based on 3 Scalars at *begin to *end.
Definition at line 190 of file PositionVector3D.h.
|
inline |
Set internal data based on 3 Scalar numbers.
Definition at line 183 of file PositionVector3D.h.
|
inline |
Change Eta - CylindricalEta3D coordinates only.
Definition at line 362 of file PositionVector3D.h.
|
inline |
Change Phi - Polar3D or CylindricalEta3D coordinates.
Definition at line 352 of file PositionVector3D.h.
|
inline |
Change R - Polar3D coordinates only.
Definition at line 342 of file PositionVector3D.h.
|
inline |
Change Rho - CylindricalEta3D coordinates only.
Definition at line 357 of file PositionVector3D.h.
|
inline |
Change Theta - Polar3D coordinates only.
Definition at line 347 of file PositionVector3D.h.
|
inline |
Change X - Cartesian3D coordinates only.
Definition at line 327 of file PositionVector3D.h.
|
inline |
set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form)
Definition at line 240 of file PositionVector3D.h.
|
inline |
Change Y - Cartesian3D coordinates only.
Definition at line 332 of file PositionVector3D.h.
|
inline |
Change Z - Cartesian3D coordinates only.
Definition at line 337 of file PositionVector3D.h.
|
inline |
Polar theta, converting if necessary from internal coordinate system.
Definition at line 290 of file PositionVector3D.h.
|
inline |
Definition at line 459 of file PositionVector3D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 270 of file PositionVector3D.h.
|
inline |
Definition at line 455 of file PositionVector3D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 275 of file PositionVector3D.h.
|
inline |
Definition at line 456 of file PositionVector3D.h.
|
inline |
Cartesian Z, converting if necessary from internal coordinate system.
Definition at line 280 of file PositionVector3D.h.
|
inline |
Definition at line 457 of file PositionVector3D.h.
|
private |
Definition at line 468 of file PositionVector3D.h.
|
staticconstexprprivate |
Definition at line 469 of file PositionVector3D.h.