ROOT::Math::Cylindrical3D< T > Class Template Reference
[GenVector]

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

#include <Cylindrical3D.h>

List of all members.

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

---

Detailed Description

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

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

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 GenVector/Cylindrical3D.h.

---

Member Typedef Documentation

template<class T >

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

Definition at line 48 of file GenVector/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 GenVector/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 GenVector/Cylindrical3D.h.

template<class T >

template<class CoordSystem >

ROOT::Math::Cylindrical3D< T >::Cylindrical3D

(

const CoordSystem &

v

)

[inline, explicit]

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

Definition at line 66 of file GenVector/Cylindrical3D.h.

template<class T >

ROOT::Math::Cylindrical3D< T >::Cylindrical3D

(

const Cylindrical3D< T > &

v

)

[inline]

copy constructor

Definition at line 75 of file GenVector/Cylindrical3D.h.

---

Member Function Documentation

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Eta

(

)

const [inline]

Definition at line 136 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Impl::Eta_FromRhoZ().

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 GenVector/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 GenVector/Cylindrical3D.h.

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Mag2

(

)

const [inline]

Definition at line 130 of file GenVector/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 GenVector/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 GenVector/Cylindrical3D.h.

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

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 GenVector/Cylindrical3D.h.

template<class T >

Cylindrical3D& ROOT::Math::Cylindrical3D< T >::operator=

(

const Cylindrical3D< T > &

v

)

[inline]

assignment operator

Definition at line 81 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::Phi(), ROOT::Math::Cylindrical3D< T >::Rho(), and ROOT::Math::Cylindrical3D< T >::Z().

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 GenVector/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 GenVector/Cylindrical3D.h.

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Phi

(

)

const [inline]

Definition at line 125 of file GenVector/Cylindrical3D.h.

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

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::R

(

)

const [inline]

Definition at line 131 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::Mag2(), and ROOT::Math::sqrt().

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Rho

(

)

const [inline]

Definition at line 123 of file GenVector/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 GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::Negate().

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 GenVector/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 GenVector/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 GenVector/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 GenVector/Cylindrical3D.h.

template<class T >

void ROOT::Math::Cylindrical3D< T >::SetXYZ	(	Scalar	x,
		Scalar	y,
		Scalar	z
	)			[inline]

set all values using cartesian coordinates

Definition at line 277 of file GenVector/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 GenVector/Cylindrical3D.h.

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Theta

(

)

const [inline]

Definition at line 133 of file GenVector/Cylindrical3D.h.

References atan2().

template<class T >

T ROOT::Math::Cylindrical3D< T >::x

(

)

const [inline]

Definition at line 217 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::X().

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::X

(

)

const [inline]

Definition at line 127 of file GenVector/Cylindrical3D.h.

References cos().

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

template<class T >

T ROOT::Math::Cylindrical3D< T >::y

(

)

const [inline]

Definition at line 218 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::Y().

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Y

(

)

const [inline]

Definition at line 128 of file GenVector/Cylindrical3D.h.

References sin().

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

template<class T >

T ROOT::Math::Cylindrical3D< T >::z

(

)

const [inline]

Definition at line 219 of file GenVector/Cylindrical3D.h.

References ROOT::Math::Cylindrical3D< T >::Z().

template<class T >

Scalar ROOT::Math::Cylindrical3D< T >::Z

(

)

const [inline]

Definition at line 124 of file GenVector/Cylindrical3D.h.

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

---

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

• GenVector/Cylindrical3D.h