ROOT::Math::PositionVector3D< CoordSystem, Tag > Class Template Reference
[GenVector]

Class describing a generic position vector (point) in 3 dimensions. More...

#include <PositionVector3D.h>

Collaboration diagram for ROOT::Math::PositionVector3D< CoordSystem, Tag >:

List of all members.

Public Types

typedef CoordSystem::Scalar Scalar

typedef CoordSystem CoordinateType

typedef Tag CoordinateSystemTag

Public Member Functions

PositionVector3D ()

Default constructor.

PositionVector3D (const Scalar &a, const Scalar &b, const Scalar &c)

Construct from three values of type Scalar.

template<class T >

PositionVector3D (const PositionVector3D< T, Tag > &v)

Construct from a position vector expressed in different coordinates, or using a different Scalar type.

template<class T >

PositionVector3D (const DisplacementVector3D< T, Tag > &p)

Construct from an arbitrary displacement vector.

template<class ForeignVector >

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 OtherCoords >

PositionVector3D & operator= (const PositionVector3D< OtherCoords, Tag > &v)

Assignment operator from a position vector of arbitrary type.

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().

const CoordSystem & Coordinates () const

Retrieve a copy of the coordinates object.

PositionVector3D< CoordSystem,
Tag > & SetCoordinates (const Scalar src[])

Set internal data based on a C-style array of 3 Scalar numbers.

PositionVector3D< CoordSystem,
Tag > & SetCoordinates (Scalar a, Scalar b, Scalar c)

Set internal data based on 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.

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

template<class IT >

void GetCoordinates (IT begin, IT end) const

get internal data into 3 Scalars at *begin to *end (3 past begin)

template<class IT >

void GetCoordinates (IT begin) const

get internal data into 3 Scalars at *begin

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)

bool operator== (const PositionVector3D &rhs) const

Exact equality.

bool operator!= (const PositionVector3D &rhs) const

Scalar X () const

Cartesian X, converting if necessary from internal coordinate system.

Scalar Y () const

Cartesian Y, converting if necessary from internal coordinate system.

Scalar Z () const

Cartesian Z, converting if necessary from internal coordinate system.

Scalar R () const

Polar R, converting if necessary from internal coordinate system.

Scalar Theta () const

Polar theta, converting if necessary from internal coordinate system.

Scalar Phi () const

Polar phi, converting if necessary from internal coordinate system.

Scalar Eta () const

Polar eta, converting if necessary from internal coordinate system.

Scalar Rho () const

Cylindrical transverse component rho.

Scalar Mag2 () const

Magnitute squared ( r^2 in spherical coordinate).

Scalar Perp2 () const

Transverse component squared (rho^2 in cylindrical coordinates.

PositionVector3D< CoordSystem,
Tag > & SetX (Scalar xx)

Change X - Cartesian3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetY (Scalar yy)

Change Y - Cartesian3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetZ (Scalar zz)

Change Z - Cartesian3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetR (Scalar rr)

Change R - Polar3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetTheta (Scalar ang)

Change Theta - Polar3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetPhi (Scalar ang)

Change Phi - Polar3D or CylindricalEta3D coordinates.

PositionVector3D< CoordSystem,
Tag > & SetRho (Scalar rr)

Change Rho - CylindricalEta3D coordinates only.

PositionVector3D< CoordSystem,
Tag > & SetEta (Scalar etaval)

Change Eta - CylindricalEta3D coordinates only.

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.

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.

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)

multiply this vector by a scalar quantity

PositionVector3D & operator/= (Scalar a)

divide this vector by a scalar quantity

PositionVector3D operator* (Scalar a) const

Multiply a vector by a real number.

PositionVector3D operator/ (Scalar a) const

Division of a vector with a real number.

Scalar x () const

Scalar y () const

Scalar z () const

Scalar r () const

Scalar theta () const

Scalar phi () const

Scalar eta () const

Scalar rho () const

Scalar mag2 () const

Scalar perp2 () const

Detailed Description

template<class CoordSystem, class Tag = DefaultCoordinateSystemTag>
class ROOT::Math::PositionVector3D< CoordSystem, Tag >

Class describing a generic position vector (point) in 3 dimensions.

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 63 of file GenVector/PositionVector3D.h.