Logo ROOT  
Reference Guide
ROOT::Math::CylindricalEta3D< T > Class Template Reference

template<class T>
class ROOT::Math::CylindricalEta3D< T >

Class describing a cylindrical coordinate system based on eta (pseudorapidity) instead of z.

Class describing a 3D Cylindrical Eta coordinate system (rho, eta, phi coordinates)

The base coordinates are rho (transverse component) , eta and phi Phi is restricted to be in the range [-PI,PI)

See also
Overview of the physics vector library

Definition at line 48 of file CylindricalEta3D.h.

Public Types

typedef T Scalar
 

Public Member Functions

 CylindricalEta3D ()
 Default constructor with rho=eta=phi=0. More...
 
template<class CoordSystem >
 CylindricalEta3D (const CoordSystem &v)
 Construct from any Vector or coordinate system implementing Rho(), Eta() and Phi() More...
 
 CylindricalEta3D (const CylindricalEta3D &v)
 copy constructor More...
 
 CylindricalEta3D (Scalar rho, Scalar eta, Scalar phi)
 Construct from rho eta and phi values. More...
 
Eta () const
 
void GetCoordinates (Scalar &rho, Scalar &eta, Scalar &phi) const
 get internal data into 3 Scalar numbers More...
 
void GetCoordinates (Scalar dest[]) const
 get internal data into an array of 3 Scalar numbers More...
 
Mag2 () const
 
void Negate ()
 negate the vector More...
 
bool operator!= (const CylindricalEta3D &rhs) const
 
template<class CoordSystem >
CylindricalEta3Doperator= (const CoordSystem &c)
 generic assignment operator from any coordinate system More...
 
CylindricalEta3Doperator= (const CylindricalEta3D &v)
 assignment operator More...
 
bool operator== (const CylindricalEta3D &rhs) const
 Exact component-by-component equality Note: Peculiar representaions of the zero vector such as (0,1,0) will not test as equal to one another. More...
 
Perp2 () const
 
Phi () const
 
R () const
 
Rho () const
 
void Scale (T a)
 scale by a scalar quantity a – for cylindrical eta coords, as long as a >= 0, only rho changes! More...
 
void SetCoordinates (const Scalar src[])
 Set internal data based on an array of 3 Scalar numbers. More...
 
void SetCoordinates (Scalar rho, Scalar eta, Scalar phi)
 Set internal data based on 3 Scalar numbers. More...
 
void SetEta (T eta)
 set the eta coordinate value keeping rho and phi constant More...
 
void SetPhi (T phi)
 set the phi coordinate value keeping rho and eta constant More...
 
void SetRho (T rho)
 set the rho coordinate value keeping eta and phi constant More...
 
void SetXYZ (Scalar x, Scalar y, Scalar z)
 set all values using cartesian coordinates More...
 
Theta () const
 
X () const
 
x () const
 
Y () const
 
y () const
 
Z () const
 
z () const
 

Private Member Functions

void Restrict ()
 

Static Private Member Functions

static Scalar pi ()
 

Private Attributes

fEta
 
fPhi
 
fRho
 

#include <Math/GenVector/CylindricalEta3D.h>

Member Typedef Documentation

◆ Scalar

template<class T >
typedef T ROOT::Math::CylindricalEta3D< T >::Scalar

Definition at line 52 of file CylindricalEta3D.h.

Constructor & Destructor Documentation

◆ CylindricalEta3D() [1/4]

template<class T >
ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D ( )
inline

Default constructor with rho=eta=phi=0.

Definition at line 57 of file CylindricalEta3D.h.

◆ CylindricalEta3D() [2/4]

template<class T >
ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D ( Scalar  rho,
Scalar  eta,
Scalar  phi 
)
inline

Construct from rho eta and phi values.

Definition at line 62 of file CylindricalEta3D.h.

◆ CylindricalEta3D() [3/4]

template<class T >
template<class CoordSystem >
ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D ( const CoordSystem &  v)
inlineexplicit

Construct from any Vector or coordinate system implementing Rho(), Eta() and Phi()

Definition at line 70 of file CylindricalEta3D.h.

◆ CylindricalEta3D() [4/4]

template<class T >
ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D ( const CylindricalEta3D< T > &  v)
inline

copy constructor

Definition at line 89 of file CylindricalEta3D.h.

Member Function Documentation

◆ Eta()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Eta ( ) const
inline

Definition at line 138 of file CylindricalEta3D.h.

◆ GetCoordinates() [1/2]

template<class T >
void ROOT::Math::CylindricalEta3D< T >::GetCoordinates ( Scalar rho,
Scalar eta,
Scalar phi 
) const
inline

get internal data into 3 Scalar numbers

Definition at line 123 of file CylindricalEta3D.h.

◆ GetCoordinates() [2/2]

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

get internal data into an array of 3 Scalar numbers

Definition at line 111 of file CylindricalEta3D.h.

◆ Mag2()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Mag2 ( ) const
inline

Definition at line 153 of file CylindricalEta3D.h.

◆ Negate()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::Negate ( )
inline

negate the vector

Definition at line 215 of file CylindricalEta3D.h.

◆ operator!=()

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

Definition at line 240 of file CylindricalEta3D.h.

◆ operator=() [1/2]

template<class T >
template<class CoordSystem >
CylindricalEta3D & ROOT::Math::CylindricalEta3D< T >::operator= ( const CoordSystem &  c)
inline

generic assignment operator from any coordinate system

Definition at line 225 of file CylindricalEta3D.h.

◆ operator=() [2/2]

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

assignment operator

Definition at line 95 of file CylindricalEta3D.h.

◆ operator==()

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

Exact component-by-component equality Note: Peculiar representaions of the zero vector such as (0,1,0) will not test as equal to one another.

Definition at line 237 of file CylindricalEta3D.h.

◆ Perp2()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Perp2 ( ) const
inline

Definition at line 158 of file CylindricalEta3D.h.

◆ Phi()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Phi ( ) const
inline

Definition at line 139 of file CylindricalEta3D.h.

◆ pi()

template<class T >
static Scalar ROOT::Math::CylindricalEta3D< T >::pi ( )
inlinestaticprivate

Definition at line 127 of file CylindricalEta3D.h.

◆ R()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::R ( ) const
inline

Definition at line 147 of file CylindricalEta3D.h.

◆ Restrict()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::Restrict ( )
inlineprivate

Definition at line 128 of file CylindricalEta3D.h.

◆ Rho()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Rho ( ) const
inline

Definition at line 137 of file CylindricalEta3D.h.

◆ Scale()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::Scale ( a)
inline

scale by a scalar quantity a – for cylindrical eta coords, as long as a >= 0, only rho changes!

Definition at line 196 of file CylindricalEta3D.h.

◆ SetCoordinates() [1/2]

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

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

Definition at line 105 of file CylindricalEta3D.h.

◆ SetCoordinates() [2/2]

template<class T >
void ROOT::Math::CylindricalEta3D< T >::SetCoordinates ( Scalar  rho,
Scalar  eta,
Scalar  phi 
)
inline

Set internal data based on 3 Scalar numbers.

Definition at line 117 of file CylindricalEta3D.h.

◆ SetEta()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::SetEta ( eta)
inline

set the eta coordinate value keeping rho and phi constant

Definition at line 174 of file CylindricalEta3D.h.

◆ SetPhi()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::SetPhi ( phi)
inline

set the phi coordinate value keeping rho and eta constant

Definition at line 181 of file CylindricalEta3D.h.

◆ SetRho()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::SetRho ( rho)
inline

set the rho coordinate value keeping eta and phi constant

Definition at line 167 of file CylindricalEta3D.h.

◆ SetXYZ()

template<class T >
void ROOT::Math::CylindricalEta3D< T >::SetXYZ ( Scalar  x,
Scalar  y,
Scalar  z 
)

set all values using cartesian coordinates

Definition at line 300 of file CylindricalEta3D.h.

◆ Theta()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Theta ( ) const
inline

Definition at line 159 of file CylindricalEta3D.h.

◆ X()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::X ( ) const
inline

Definition at line 140 of file CylindricalEta3D.h.

◆ x()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::x ( ) const
inline

Definition at line 248 of file CylindricalEta3D.h.

◆ Y()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Y ( ) const
inline

Definition at line 141 of file CylindricalEta3D.h.

◆ y()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::y ( ) const
inline

Definition at line 249 of file CylindricalEta3D.h.

◆ Z()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::Z ( ) const
inline

Definition at line 142 of file CylindricalEta3D.h.

◆ z()

template<class T >
T ROOT::Math::CylindricalEta3D< T >::z ( ) const
inline

Definition at line 250 of file CylindricalEta3D.h.

Member Data Documentation

◆ fEta

template<class T >
T ROOT::Math::CylindricalEta3D< T >::fEta
private

Definition at line 276 of file CylindricalEta3D.h.

◆ fPhi

template<class T >
T ROOT::Math::CylindricalEta3D< T >::fPhi
private

Definition at line 277 of file CylindricalEta3D.h.

◆ fRho

template<class T >
T ROOT::Math::CylindricalEta3D< T >::fRho
private

Definition at line 275 of file CylindricalEta3D.h.

Libraries for ROOT::Math::CylindricalEta3D< T >:
[legend]

The documentation for this class was generated from the following file: