ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
ROOT::Math::Cylindrical3D< T > Class Template Reference
GenVector

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

Class describing a cylindrical coordinate system based on rho, z and phi.

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

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

Definition at line 44 of file Cylindrical3D.h.

Public Types

typedef T Scalar
 

Public Member Functions

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

Private Member Functions

void Restrict ()
 

Static Private Member Functions

static Scalar pi ()
 

Private Attributes

T fRho
 
T fZ
 
T fPhi
 

#include <Math/GenVector/Cylindrical3D.h>

Member Typedef Documentation

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

Definition at line 48 of file Cylindrical3D.h.

Constructor & Destructor Documentation

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

Default constructor with rho=z=phi=0.

Definition at line 53 of file Cylindrical3D.h.

template<class T >
ROOT::Math::Cylindrical3D< T >::Cylindrical3D ( Scalar  rho,
Scalar  zz,
Scalar  phi 
)
inline

Construct from rho eta and phi values.

Definition at line 58 of file Cylindrical3D.h.

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

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

Definition at line 66 of file Cylindrical3D.h.

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

copy constructor

Definition at line 75 of file Cylindrical3D.h.

Member Function Documentation

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

Definition at line 136 of file Cylindrical3D.h.

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

get internal data into an array of 3 Scalar numbers ( rho, z , phi)

Definition at line 97 of file Cylindrical3D.h.

template<class T >
void ROOT::Math::Cylindrical3D< T >::GetCoordinates ( Scalar &  rho,
Scalar &  zz,
Scalar &  phi 
) const
inline

get internal data into 3 Scalar numbers ( rho, z , phi)

Definition at line 109 of file Cylindrical3D.h.

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

Definition at line 130 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::R().

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

negate the vector

Definition at line 186 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::Scale().

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

Definition at line 209 of file Cylindrical3D.h.

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

assignment operator

Definition at line 81 of file Cylindrical3D.h.

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

generic assignment operator from any coordinate system implementing Rho(), Z() and Phi()

Definition at line 196 of file Cylindrical3D.h.

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

Exact component-by-component equality.

Definition at line 206 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::operator!=().

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

Definition at line 132 of file Cylindrical3D.h.

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

Definition at line 125 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::operator=().

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

Definition at line 113 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::Negate(), and ROOT::Math::Cylindrical3D< T >::Restrict().

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

Definition at line 131 of file Cylindrical3D.h.

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

Definition at line 114 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::Cylindrical3D(), ROOT::Math::Cylindrical3D< T >::SetCoordinates(), and ROOT::Math::Cylindrical3D< T >::SetPhi().

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

Definition at line 123 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::operator=().

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

scale by a scalar quantity a – for cylindrical coords only rho and z change

Definition at line 174 of file Cylindrical3D.h.

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

Set internal data based on an array of 3 Scalar numbers ( rho, z , phi)

Definition at line 91 of file Cylindrical3D.h.

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

Set internal data based on 3 Scalar numbers ( rho, z , phi)

Definition at line 103 of file Cylindrical3D.h.

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

set the phi coordinate value keeping rho and z constant

Definition at line 160 of file Cylindrical3D.h.

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

set the rho coordinate value keeping z and phi constant

Definition at line 146 of file Cylindrical3D.h.

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

set all values using cartesian coordinates

Definition at line 277 of file Cylindrical3D.h.

template<class T >
void ROOT::Math::Cylindrical3D< T >::SetZ ( T  zz)
inline

set the z coordinate value keeping rho and phi constant

Definition at line 153 of file Cylindrical3D.h.

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

Definition at line 133 of file Cylindrical3D.h.

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

Definition at line 127 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::x().

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

Definition at line 217 of file Cylindrical3D.h.

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

Definition at line 128 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::y().

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

Definition at line 218 of file Cylindrical3D.h.

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

Definition at line 124 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::operator=(), and ROOT::Math::Cylindrical3D< T >::z().

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

Definition at line 219 of file Cylindrical3D.h.

Member Data Documentation

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

Definition at line 246 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::GetCoordinates(), ROOT::Math::Cylindrical3D< T >::Negate(), ROOT::Math::Cylindrical3D< T >::operator=(), ROOT::Math::Cylindrical3D< T >::operator==(), ROOT::Math::Cylindrical3D< T >::Phi(), ROOT::Math::Cylindrical3D< T >::Restrict(), ROOT::Math::Cylindrical3D< T >::SetCoordinates(), ROOT::Math::Cylindrical3D< T >::SetPhi(), ROOT::Math::Cylindrical3D< T >::X(), and ROOT::Math::Cylindrical3D< T >::Y().

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

Definition at line 244 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::Eta(), ROOT::Math::Cylindrical3D< T >::GetCoordinates(), ROOT::Math::Cylindrical3D< T >::Mag2(), ROOT::Math::Cylindrical3D< T >::operator=(), ROOT::Math::Cylindrical3D< T >::operator==(), ROOT::Math::Cylindrical3D< T >::Perp2(), ROOT::Math::Cylindrical3D< T >::Rho(), ROOT::Math::Cylindrical3D< T >::Scale(), ROOT::Math::Cylindrical3D< T >::SetCoordinates(), ROOT::Math::Cylindrical3D< T >::SetRho(), ROOT::Math::Cylindrical3D< T >::Theta(), ROOT::Math::Cylindrical3D< T >::X(), and ROOT::Math::Cylindrical3D< T >::Y().

template<class T >
T ROOT::Math::Cylindrical3D< T >::fZ
private

Definition at line 245 of file Cylindrical3D.h.

Referenced by ROOT::Math::Cylindrical3D< T >::Eta(), ROOT::Math::Cylindrical3D< T >::GetCoordinates(), ROOT::Math::Cylindrical3D< T >::Mag2(), ROOT::Math::Cylindrical3D< T >::Negate(), ROOT::Math::Cylindrical3D< T >::operator=(), ROOT::Math::Cylindrical3D< T >::operator==(), ROOT::Math::Cylindrical3D< T >::Scale(), ROOT::Math::Cylindrical3D< T >::SetCoordinates(), ROOT::Math::Cylindrical3D< T >::SetZ(), ROOT::Math::Cylindrical3D< T >::Theta(), and ROOT::Math::Cylindrical3D< T >::Z().

Collaboration diagram for ROOT::Math::Cylindrical3D< T >:
[legend]
The documentation for this class was generated from the following file: