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

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

#include <CylindricalEta3D.h>

List of all members.

Public Types
typedef T	Scalar
Public Member Functions
	CylindricalEta3D ()
	Default constructor with rho=eta=phi=0.
	CylindricalEta3D (Scalar rho, Scalar eta, Scalar phi)
	Construct from rho eta and phi values.
template<class CoordSystem >
	CylindricalEta3D (const CoordSystem &v)
	Construct from any Vector or coordinate system implementing Rho(), Eta() and Phi().
	CylindricalEta3D (const CylindricalEta3D &v)
	copy constructor
CylindricalEta3D &	operator= (const CylindricalEta3D &v)
	assignment operator
void	SetCoordinates (const Scalar src[])
	Set internal data based on an array of 3 Scalar numbers.
void	GetCoordinates (Scalar dest[]) const
	get internal data into an array of 3 Scalar numbers
void	SetCoordinates (Scalar rho, Scalar eta, Scalar phi)
	Set internal data based on 3 Scalar numbers.
void	GetCoordinates (Scalar &rho, Scalar &eta, Scalar &phi) const
	get internal data into 3 Scalar numbers
T	Rho () const
T	Eta () const
T	Phi () const
T	X () const
T	Y () const
T	Z () const
T	R () const
T	Mag2 () const
T	Perp2 () const
T	Theta () const
void	SetRho (T rho)
	set the rho coordinate value keeping eta and phi constant
void	SetEta (T eta)
	set the eta coordinate value keeping rho and phi constant
void	SetPhi (T phi)
	set the phi coordinate value keeping rho and eta 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 eta coords, as long as a >= 0, only rho changes!
void	Negate ()
	negate the vector
template<class CoordSystem >
CylindricalEta3D &	operator= (const CoordSystem &c)
	generic assignment operator from any coordinate system
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.
bool	operator!= (const CylindricalEta3D &rhs) const
T	x () const
T	y () const
T	z () const

---

Detailed Description

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

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

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

Definition at line 51 of file GenVector/CylindricalEta3D.h.

---

Member Typedef Documentation

template<class T >

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

Definition at line 55 of file GenVector/CylindricalEta3D.h.

---

Constructor & Destructor Documentation

template<class T >

ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D

(

)

[inline]

Default constructor with rho=eta=phi=0.

Definition at line 60 of file GenVector/CylindricalEta3D.h.

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 65 of file GenVector/CylindricalEta3D.h.

template<class T >

template<class CoordSystem >

ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D

(

const CoordSystem &

v

)

[inline, explicit]

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

Definition at line 73 of file GenVector/CylindricalEta3D.h.

References ROOT::Math::fabs(), log(), and ROOT::Math::CylindricalEta3D< T >::Z().

template<class T >

ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D

(

const CylindricalEta3D< T > &

v

)

[inline]

copy constructor

Definition at line 91 of file GenVector/CylindricalEta3D.h.

---

Member Function Documentation

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Eta

(

)

const [inline]

Definition at line 140 of file GenVector/CylindricalEta3D.h.

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

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 125 of file GenVector/CylindricalEta3D.h.

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 113 of file GenVector/CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Mag2

(

)

const [inline]

Definition at line 152 of file GenVector/CylindricalEta3D.h.

References ROOT::Math::CylindricalEta3D< T >::R().

template<class T >

void ROOT::Math::CylindricalEta3D< T >::Negate

(

)

[inline]

negate the vector

Definition at line 211 of file GenVector/CylindricalEta3D.h.

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

template<class T >

bool ROOT::Math::CylindricalEta3D< T >::operator!=

(

const CylindricalEta3D< T > &

rhs

)

const [inline]

Definition at line 236 of file GenVector/CylindricalEta3D.h.

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

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 221 of file GenVector/CylindricalEta3D.h.

template<class T >

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

(

const CylindricalEta3D< T > &

v

)

[inline]

assignment operator

Definition at line 97 of file GenVector/CylindricalEta3D.h.

References ROOT::Math::CylindricalEta3D< T >::Eta(), ROOT::Math::CylindricalEta3D< T >::Phi(), and ROOT::Math::CylindricalEta3D< T >::Rho().

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 233 of file GenVector/CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Perp2

(

)

const [inline]

Definition at line 153 of file GenVector/CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Phi

(

)

const [inline]

Definition at line 141 of file GenVector/CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::R

(

)

const [inline]

Definition at line 148 of file GenVector/CylindricalEta3D.h.

References cosh().

Referenced by ROOT::Math::CylindricalEta3D< T >::Mag2().

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Rho

(

)

const [inline]

Definition at line 139 of file GenVector/CylindricalEta3D.h.

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

template<class T >

void ROOT::Math::CylindricalEta3D< T >::Scale

(

T

a

)

[inline]

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

Definition at line 192 of file GenVector/CylindricalEta3D.h.

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

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 119 of file GenVector/CylindricalEta3D.h.

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 107 of file GenVector/CylindricalEta3D.h.

template<class T >

void ROOT::Math::CylindricalEta3D< T >::SetEta

(

T

eta

)

[inline]

set the eta coordinate value keeping rho and phi constant

Definition at line 170 of file GenVector/CylindricalEta3D.h.

template<class T >

void ROOT::Math::CylindricalEta3D< T >::SetPhi

(

T

phi

)

[inline]

set the phi coordinate value keeping rho and eta constant

Definition at line 177 of file GenVector/CylindricalEta3D.h.

template<class T >

void ROOT::Math::CylindricalEta3D< T >::SetRho

(

T

rho

)

[inline]

set the rho coordinate value keeping eta and phi constant

Definition at line 163 of file GenVector/CylindricalEta3D.h.

template<class T >

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

set all values using cartesian coordinates

Definition at line 302 of file GenVector/CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Theta

(

)

const [inline]

Definition at line 154 of file GenVector/CylindricalEta3D.h.

References atan(), and exp().

template<class T >

T ROOT::Math::CylindricalEta3D< T >::x

(

)

const [inline]

Definition at line 244 of file GenVector/CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::X

(

)

const [inline]

Definition at line 142 of file GenVector/CylindricalEta3D.h.

References cos().

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::y

(

)

const [inline]

Definition at line 245 of file GenVector/CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Y

(

)

const [inline]

Definition at line 143 of file GenVector/CylindricalEta3D.h.

References sin().

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::z

(

)

const [inline]

Definition at line 246 of file GenVector/CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Z

(

)

const [inline]

Definition at line 144 of file GenVector/CylindricalEta3D.h.

References sinh().

Referenced by ROOT::Math::CylindricalEta3D< T >::CylindricalEta3D(), and ROOT::Math::CylindricalEta3D< T >::z().

---

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

• GenVector/CylindricalEta3D.h