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

Class describing a polar coordinate system based on r, theta and phi Phi is restricted to be in the range [-PI,PI). More...

#include <Polar3D.h>

List of all members.

Public Types
typedef T	Scalar
Public Member Functions
	Polar3D ()
	Default constructor with r=theta=phi=0.
	Polar3D (T r, T theta, T phi)
	Construct from the polar coordinates: r, theta and phi.
template<class CoordSystem >
	Polar3D (const CoordSystem &v)
	Construct from any Vector or coordinate system implementing R(), Theta() and Phi().
	Polar3D (const Polar3D &v)
	copy constructor
Polar3D &	operator= (const Polar3D &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 r, Scalar theta, Scalar phi)
	Set internal data based on 3 Scalar numbers.
void	GetCoordinates (Scalar &r, Scalar &theta, Scalar &phi) const
	get internal data into 3 Scalar numbers
Scalar	R () const
Scalar	Phi () const
Scalar	Theta () const
Scalar	Rho () const
Scalar	X () const
Scalar	Y () const
Scalar	Z () const
Scalar	Mag2 () const
Scalar	Perp2 () const
Scalar	Eta () const
void	SetR (const T &r)
	set the r coordinate value keeping theta and phi constant
void	SetTheta (const T &theta)
	set the theta coordinate value keeping r and phi constant
void	SetPhi (const T &phi)
	set the phi coordinate value keeping r and theta constant
void	SetXYZ (Scalar x, Scalar y, Scalar z)
	set all values using cartesian coordinates
void	Scale (T a)
	scale by a scalar quantity - for polar coordinates r changes
void	Negate ()
	negate the vector
template<class CoordSystem >
Polar3D &	operator= (const CoordSystem &c)
	generic assignment operator from any coordinate system
bool	operator== (const Polar3D &rhs) const
	Exact equality.
bool	operator!= (const Polar3D &rhs) const
T	x () const
T	y () const
T	z () const

---

Detailed Description

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

Class describing a polar coordinate system based on r, theta and phi Phi is restricted to be in the range [-PI,PI).

Definition at line 46 of file GenVector/Polar3D.h.

---

Member Typedef Documentation

template<class T>

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

Definition at line 50 of file GenVector/Polar3D.h.

---

Constructor & Destructor Documentation

template<class T>

ROOT::Math::Polar3D< T >::Polar3D

(

)

[inline]

Default constructor with r=theta=phi=0.

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

template<class T>

ROOT::Math::Polar3D< T >::Polar3D	(	T	r,
		T	theta,
		T	phi
	)			[inline]

Construct from the polar coordinates: r, theta and phi.

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

template<class T>

template<class CoordSystem >

ROOT::Math::Polar3D< T >::Polar3D

(

const CoordSystem &

v

)

[inline, explicit]

Construct from any Vector or coordinate system implementing R(), Theta() and Phi().

Definition at line 67 of file GenVector/Polar3D.h.

template<class T>

ROOT::Math::Polar3D< T >::Polar3D

(

const Polar3D< T > &

v

)

[inline]

copy constructor

Definition at line 76 of file GenVector/Polar3D.h.

---

Member Function Documentation

template<class T>

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

(

)

const [inline]

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

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

template<class T>

void ROOT::Math::Polar3D< T >::GetCoordinates	(	Scalar &	r,
		Scalar &	theta,
		Scalar &	phi
	)			const [inline]

get internal data into 3 Scalar numbers

Definition at line 110 of file GenVector/Polar3D.h.

template<class T>

void ROOT::Math::Polar3D< T >::GetCoordinates

(

Scalar

dest[]

)

const [inline]

get internal data into an array of 3 Scalar numbers

Definition at line 98 of file GenVector/Polar3D.h.

template<class T>

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

(

)

const [inline]

Definition at line 120 of file GenVector/Polar3D.h.

template<class T>

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

(

)

[inline]

negate the vector

Definition at line 185 of file GenVector/Polar3D.h.

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

template<class T>

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

(

const Polar3D< T > &

rhs

)

const [inline]

Definition at line 208 of file GenVector/Polar3D.h.

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

template<class T>

template<class CoordSystem >

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

(

const CoordSystem &

c

)

[inline]

generic assignment operator from any coordinate system

Definition at line 195 of file GenVector/Polar3D.h.

template<class T>

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

(

const Polar3D< T > &

v

)

[inline]

assignment operator

Definition at line 82 of file GenVector/Polar3D.h.

References ROOT::Math::Polar3D< T >::Phi(), ROOT::Math::Polar3D< T >::R(), and ROOT::Math::Polar3D< T >::Theta().

template<class T>

bool ROOT::Math::Polar3D< T >::operator==

(

const Polar3D< T > &

rhs

)

const [inline]

Exact equality.

Definition at line 205 of file GenVector/Polar3D.h.

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

template<class T>

Scalar ROOT::Math::Polar3D< T >::Perp2

(

)

const [inline]

Definition at line 121 of file GenVector/Polar3D.h.

References ROOT::Math::Polar3D< T >::Rho().

template<class T>

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

(

)

const [inline]

Definition at line 114 of file GenVector/Polar3D.h.

Referenced by ROOT::Math::Cartesian3D< double >::Cartesian3D(), ROOT::Math::Polar3D< T >::operator=(), and ROOT::Math::Cartesian3D< double >::operator=().

template<class T>

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

(

)

const [inline]

Definition at line 113 of file GenVector/Polar3D.h.

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

template<class T>

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

(

)

const [inline]

Definition at line 116 of file GenVector/Polar3D.h.

References sin().

Referenced by ROOT::Math::Cartesian3D< double >::Cartesian3D(), ROOT::Math::Cartesian3D< double >::operator=(), ROOT::Math::Polar3D< T >::Perp2(), ROOT::Math::Polar3D< T >::X(), and ROOT::Math::Polar3D< T >::Y().

template<class T>

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

(

T

a

)

[inline]

scale by a scalar quantity - for polar coordinates r changes

Definition at line 173 of file GenVector/Polar3D.h.

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

template<class T>

void ROOT::Math::Polar3D< T >::SetCoordinates	(	Scalar	r,
		Scalar	theta,
		Scalar	phi
	)			[inline]

Set internal data based on 3 Scalar numbers.

Definition at line 104 of file GenVector/Polar3D.h.

template<class T>

void ROOT::Math::Polar3D< T >::SetCoordinates

(

const Scalar

src[]

)

[inline]

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

Definition at line 92 of file GenVector/Polar3D.h.

template<class T>

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

(

const T &

phi

)

[inline]

set the phi coordinate value keeping r and theta constant

Definition at line 149 of file GenVector/Polar3D.h.

template<class T>

void ROOT::Math::Polar3D< T >::SetR

(

const T &

r

)

[inline]

set the r coordinate value keeping theta and phi constant

Definition at line 135 of file GenVector/Polar3D.h.

template<class T>

void ROOT::Math::Polar3D< T >::SetTheta

(

const T &

theta

)

[inline]

set the theta coordinate value keeping r and phi constant

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

template<class T >

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

set all values using cartesian coordinates

Definition at line 272 of file GenVector/Polar3D.h.

template<class T>

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

(

)

const [inline]

Definition at line 115 of file GenVector/Polar3D.h.

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

template<class T>

T ROOT::Math::Polar3D< T >::x

(

)

const [inline]

Definition at line 215 of file GenVector/Polar3D.h.

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

template<class T>

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

(

)

const [inline]

Definition at line 117 of file GenVector/Polar3D.h.

References cos(), and ROOT::Math::Polar3D< T >::Rho().

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

template<class T>

T ROOT::Math::Polar3D< T >::y

(

)

const [inline]

Definition at line 216 of file GenVector/Polar3D.h.

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

template<class T>

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

(

)

const [inline]

Definition at line 118 of file GenVector/Polar3D.h.

References ROOT::Math::Polar3D< T >::Rho(), and sin().

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

template<class T>

T ROOT::Math::Polar3D< T >::z

(

)

const [inline]

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

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

template<class T>

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

(

)

const [inline]

Definition at line 119 of file GenVector/Polar3D.h.

References cos().

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

---

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

• GenVector/Polar3D.h