Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::Cartesian3D< T > Class Template Reference

template<class T = double>
class ROOT::Math::Cartesian3D< T >

Class describing a 3D cartesian coordinate system (x, y, z coordinates)

See also
GenVector

Definition at line 46 of file Cartesian3D.h.

Public Types

typedefScalar
 

Public Member Functions

constexpr Cartesian3D () noexcept=default
 Default constructor with x=y=z=0.
 
template<class CoordSystem >
constexpr Cartesian3D (const CoordSystem &v)
 Construct from any Vector or coordinate system implementing X(), Y() and Z()
 
template<class T2 >
constexpr Cartesian3D (const Polar3D< T2 > &v)
 
constexpr Cartesian3D (Scalar xx, Scalar yy, Scalar zz) noexcept
 Constructor from x,y,z coordinates.
 
Scalar Eta () const
 
void GetCoordinates (Scalar &xx, Scalar &yy, Scalar &zz) const
 get internal data into 3 Scalar numbers
 
void GetCoordinates (Scalar dest[]) const
 get internal data into an array of 3 Scalar numbers
 
Scalar Mag2 () const
 
void Negate ()
 negate the vector
 
bool operator!= (const Cartesian3D &rhs) const
 
template<class CoordSystem >
Cartesian3Doperator= (const CoordSystem &v)
 Assignment from any class implementing x(),y() and z() (can assign from any coordinate system)
 
template<class T2 >
Cartesian3Doperator= (const Polar3D< T2 > &v)
 
bool operator== (const Cartesian3D &rhs) const
 Exact equality.
 
Scalar Perp2 () const
 
Scalar Phi () const
 
Scalar R () const
 
Scalar Rho () const
 
void Scale (Scalar a)
 scale the vector by a scalar quantity a
 
void SetCoordinates (const Scalar src[])
 Set internal data based on an array of 3 Scalar numbers.
 
void SetCoordinates (Scalar xx, Scalar yy, Scalar zz)
 Set internal data based on 3 Scalar numbers.
 
void SetX (Scalar xx)
 set the x coordinate value keeping y and z constant
 
void SetXYZ (Scalar xx, Scalar yy, Scalar zz)
 set all values using cartesian coordinates
 
void SetY (Scalar yy)
 set the y coordinate value keeping x and z constant
 
void SetZ (Scalar zz)
 set the z coordinate value keeping x and y constant
 
Scalar Theta () const
 
Scalar X () const
 
x () const
 
Scalar Y () const
 
y () const
 
Scalar Z () const
 
z () const
 

Static Public Attributes

static constexpr unsigned int Dimension = 3U
 

Private Attributes

fX = 0
 
fY = 0
 
fZ = 0
 

#include <Math/GenVector/Cartesian3D.h>

Member Typedef Documentation

◆ Scalar

template<class T = double>
typedef T ROOT::Math::Cartesian3D< T >::Scalar

Definition at line 50 of file Cartesian3D.h.

Constructor & Destructor Documentation

◆ Cartesian3D() [1/4]

template<class T = double>
constexpr ROOT::Math::Cartesian3D< T >::Cartesian3D ( )
constexprdefaultnoexcept

Default constructor with x=y=z=0.

◆ Cartesian3D() [2/4]

template<class T = double>
constexpr ROOT::Math::Cartesian3D< T >::Cartesian3D ( Scalar xx,
Scalar yy,
Scalar zz )
inlineconstexprnoexcept

Constructor from x,y,z coordinates.

Definition at line 62 of file Cartesian3D.h.

◆ Cartesian3D() [3/4]

template<class T = double>
template<class CoordSystem >
constexpr ROOT::Math::Cartesian3D< T >::Cartesian3D ( const CoordSystem & v)
inlineexplicitconstexpr

Construct from any Vector or coordinate system implementing X(), Y() and Z()

Definition at line 69 of file Cartesian3D.h.

◆ Cartesian3D() [4/4]

template<class T = double>
template<class T2 >
constexpr ROOT::Math::Cartesian3D< T >::Cartesian3D ( const Polar3D< T2 > & v)
inlineexplicitconstexpr

Definition at line 179 of file Cartesian3D.h.

Member Function Documentation

◆ Eta()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Eta ( ) const
inline

Definition at line 104 of file Cartesian3D.h.

◆ GetCoordinates() [1/2]

template<class T = double>
void ROOT::Math::Cartesian3D< T >::GetCoordinates ( Scalar & xx,
Scalar & yy,
Scalar & zz ) const
inline

get internal data into 3 Scalar numbers

Definition at line 91 of file Cartesian3D.h.

◆ GetCoordinates() [2/2]

template<class T = double>
void ROOT::Math::Cartesian3D< T >::GetCoordinates ( Scalar dest[]) const
inline

get internal data into an array of 3 Scalar numbers

Definition at line 80 of file Cartesian3D.h.

◆ Mag2()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Mag2 ( ) const
inline

Definition at line 96 of file Cartesian3D.h.

◆ Negate()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::Negate ( )
inline

negate the vector

Definition at line 145 of file Cartesian3D.h.

◆ operator!=()

template<class T = double>
bool ROOT::Math::Cartesian3D< T >::operator!= ( const Cartesian3D< T > & rhs) const
inline

Definition at line 165 of file Cartesian3D.h.

◆ operator=() [1/2]

template<class T = double>
template<class CoordSystem >
Cartesian3D & ROOT::Math::Cartesian3D< T >::operator= ( const CoordSystem & v)
inline

Assignment from any class implementing x(),y() and z() (can assign from any coordinate system)

Definition at line 152 of file Cartesian3D.h.

◆ operator=() [2/2]

template<class T = double>
template<class T2 >
Cartesian3D & ROOT::Math::Cartesian3D< T >::operator= ( const Polar3D< T2 > & v)
inline

Definition at line 193 of file Cartesian3D.h.

◆ operator==()

template<class T = double>
bool ROOT::Math::Cartesian3D< T >::operator== ( const Cartesian3D< T > & rhs) const
inline

Exact equality.

Definition at line 162 of file Cartesian3D.h.

◆ Perp2()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Perp2 ( ) const
inline

Definition at line 97 of file Cartesian3D.h.

◆ Phi()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Phi ( ) const
inline

Definition at line 101 of file Cartesian3D.h.

◆ R()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::R ( ) const
inline

Definition at line 99 of file Cartesian3D.h.

◆ Rho()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Rho ( ) const
inline

Definition at line 98 of file Cartesian3D.h.

◆ Scale()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::Scale ( Scalar a)
inline

scale the vector by a scalar quantity a

Definition at line 135 of file Cartesian3D.h.

◆ SetCoordinates() [1/2]

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetCoordinates ( const Scalar src[])
inline

Set internal data based on an array of 3 Scalar numbers.

Definition at line 75 of file Cartesian3D.h.

◆ SetCoordinates() [2/2]

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetCoordinates ( Scalar xx,
Scalar yy,
Scalar zz )
inline

Set internal data based on 3 Scalar numbers.

Definition at line 86 of file Cartesian3D.h.

◆ SetX()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetX ( Scalar xx)
inline

set the x coordinate value keeping y and z constant

Definition at line 111 of file Cartesian3D.h.

◆ SetXYZ()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetXYZ ( Scalar xx,
Scalar yy,
Scalar zz )
inline

set all values using cartesian coordinates

Definition at line 126 of file Cartesian3D.h.

◆ SetY()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetY ( Scalar yy)
inline

set the y coordinate value keeping x and z constant

Definition at line 116 of file Cartesian3D.h.

◆ SetZ()

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetZ ( Scalar zz)
inline

set the z coordinate value keeping x and y constant

Definition at line 121 of file Cartesian3D.h.

◆ Theta()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Theta ( ) const
inline

Definition at line 100 of file Cartesian3D.h.

◆ X()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::X ( ) const
inline

Definition at line 93 of file Cartesian3D.h.

◆ x()

template<class T = double>
T ROOT::Math::Cartesian3D< T >::x ( ) const
inline

Definition at line 172 of file Cartesian3D.h.

◆ Y()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Y ( ) const
inline

Definition at line 94 of file Cartesian3D.h.

◆ y()

template<class T = double>
T ROOT::Math::Cartesian3D< T >::y ( ) const
inline

Definition at line 173 of file Cartesian3D.h.

◆ Z()

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Z ( ) const
inline

Definition at line 95 of file Cartesian3D.h.

◆ z()

template<class T = double>
T ROOT::Math::Cartesian3D< T >::z ( ) const
inline

Definition at line 174 of file Cartesian3D.h.

Member Data Documentation

◆ Dimension

template<class T = double>
constexpr unsigned int ROOT::Math::Cartesian3D< T >::Dimension = 3U
staticconstexpr

Definition at line 52 of file Cartesian3D.h.

◆ fX

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fX = 0
private

Definition at line 224 of file Cartesian3D.h.

◆ fY

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fY = 0
private

Definition at line 225 of file Cartesian3D.h.

◆ fZ

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fZ = 0
private

Definition at line 226 of file Cartesian3D.h.

  • math/genvector/inc/Math/GenVector/Cartesian3D.h