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)

Class describing a 3D Polar coordinate system (r, theta, phi coordinates)

Definition at line 43 of file Polar3D.h.

Public Types
typedef T	Scalar

Public Member Functions
	Polar3D ()
	Default constructor with r=theta=phi=0. More...

	Polar3D (T r, T theta, T phi)
	Construct from the polar coordinates: r, theta and phi. More...

template<class CoordSystem >
	Polar3D (const CoordSystem &v)
	Construct from any Vector or coordinate system implementing R(), Theta() and Phi() More...

	Polar3D (const Polar3D &v)
	copy constructor More...

Scalar	Eta () const

void	GetCoordinates (Scalar dest[]) const
	get internal data into an array of 3 Scalar numbers More...

void	GetCoordinates (Scalar &r, Scalar &theta, Scalar &phi) const
	get internal data into 3 Scalar numbers More...

Scalar	Mag2 () const

void	Negate ()
	negate the vector More...

bool	operator!= (const Polar3D &rhs) const

Polar3D &	operator= (const Polar3D &v)
	assignment operator More...

template<class CoordSystem >
Polar3D &	operator= (const CoordSystem &c)
	generic assignment operator from any coordinate system More...

bool	operator== (const Polar3D &rhs) const
	Exact equality. More...

Scalar	Perp2 () const

Scalar	Phi () const

Scalar	R () const

Scalar	Rho () const

void	Scale (T a)
	scale by a scalar quantity - for polar coordinates r changes More...

void	SetCoordinates (const Scalar src[])
	Set internal data based on an array of 3 Scalar numbers. More...

void	SetCoordinates (Scalar r, Scalar theta, Scalar phi)
	Set internal data based on 3 Scalar numbers. More...

void	SetPhi (const T &phi)
	set the phi coordinate value keeping r and theta constant More...

void	SetR (const T &r)
	set the r coordinate value keeping theta and phi constant More...

void	SetTheta (const T &theta)
	set the theta coordinate value keeping r and phi constant More...

void	SetXYZ (Scalar x, Scalar y, Scalar z)
	set all values using cartesian coordinates More...

Scalar	Theta () const

Scalar	X () const

T	x () const

Scalar	Y () const

T	y () const

Scalar	Z () const

T	z () const

Private Member Functions
void	Restrict ()

Static Private Member Functions
static Scalar	pi ()

Private Attributes
T	fPhi

T	fR

T	fTheta

#include <Math/GenVector/Polar3D.h>

Member Typedef Documentation

◆ Scalar

template<class T>

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

Definition at line 47 of file Polar3D.h.

Constructor & Destructor Documentation

◆ Polar3D() [1/4]

template<class T>

ROOT::Math::Polar3D< T >::Polar3D ( )

inline

Default constructor with r=theta=phi=0.

Definition at line 52 of file Polar3D.h.

◆ Polar3D() [2/4]

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 57 of file Polar3D.h.

◆ Polar3D() [3/4]

template<class T>

template<class CoordSystem >

ROOT::Math::Polar3D< T >::Polar3D ( const CoordSystem & v )

inlineexplicit

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

Definition at line 64 of file Polar3D.h.

◆ Polar3D() [4/4]

template<class T>

ROOT::Math::Polar3D< T >::Polar3D ( const Polar3D< T > & v )

inline

copy constructor

Definition at line 73 of file Polar3D.h.

Member Function Documentation

◆ Eta()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Eta ( ) const

inline

Definition at line 121 of file Polar3D.h.

◆ GetCoordinates() [1/2]

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 95 of file Polar3D.h.

◆ GetCoordinates() [2/2]

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 107 of file Polar3D.h.

◆ Mag2()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Mag2 ( ) const

inline

Definition at line 117 of file Polar3D.h.

◆ Negate()

template<class T>

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

inline

negate the vector

Definition at line 180 of file Polar3D.h.

◆ operator!=()

template<class T>

bool ROOT::Math::Polar3D< T >::operator!= ( const Polar3D< T > & rhs ) const

inline

Definition at line 203 of file Polar3D.h.

◆ operator=() [1/2]

template<class T>

Polar3D& ROOT::Math::Polar3D< T >::operator= ( const Polar3D< T > & v )

inline

assignment operator

Definition at line 79 of file Polar3D.h.

◆ operator=() [2/2]

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 190 of file Polar3D.h.

◆ operator==()

template<class T>

bool ROOT::Math::Polar3D< T >::operator== ( const Polar3D< T > & rhs ) const

inline

Exact equality.

Definition at line 200 of file Polar3D.h.

◆ Perp2()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Perp2 ( ) const

inline

Definition at line 118 of file Polar3D.h.

◆ Phi()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Phi ( ) const

inline

Definition at line 111 of file Polar3D.h.

◆ pi()

template<class T>

static Scalar ROOT::Math::Polar3D< T >::pi ( )

inlinestaticprivate

Definition at line 158 of file Polar3D.h.

◆ R()

template<class T>

Scalar ROOT::Math::Polar3D< T >::R ( ) const

inline

Definition at line 110 of file Polar3D.h.

◆ Restrict()

template<class T>

void ROOT::Math::Polar3D< T >::Restrict ( )

inlineprivate

Definition at line 159 of file Polar3D.h.

◆ Rho()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Rho ( ) const

inline

Definition at line 113 of file Polar3D.h.

◆ Scale()

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 168 of file Polar3D.h.

◆ SetCoordinates() [1/2]

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 89 of file Polar3D.h.

◆ SetCoordinates() [2/2]

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 101 of file Polar3D.h.

◆ SetPhi()

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 146 of file Polar3D.h.

◆ SetR()

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 132 of file Polar3D.h.

◆ SetTheta()

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 139 of file Polar3D.h.

◆ SetXYZ()

template<class T >

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

set all values using cartesian coordinates

Definition at line 261 of file Polar3D.h.

◆ Theta()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Theta ( ) const

inline

Definition at line 112 of file Polar3D.h.

◆ X()

template<class T>

Scalar ROOT::Math::Polar3D< T >::X ( ) const

inline

Definition at line 114 of file Polar3D.h.

◆ x()

template<class T>

T ROOT::Math::Polar3D< T >::x ( ) const

inline

Definition at line 210 of file Polar3D.h.

◆ Y()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Y ( ) const

inline

Definition at line 115 of file Polar3D.h.

◆ y()

template<class T>

T ROOT::Math::Polar3D< T >::y ( ) const

inline

Definition at line 211 of file Polar3D.h.

◆ Z()

template<class T>

Scalar ROOT::Math::Polar3D< T >::Z ( ) const

inline

Definition at line 116 of file Polar3D.h.

◆ z()

template<class T>

T ROOT::Math::Polar3D< T >::z ( ) const

inline

Definition at line 212 of file Polar3D.h.

Member Data Documentation

◆ fPhi

template<class T>

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

private

Definition at line 237 of file Polar3D.h.

◆ fR

template<class T>

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

private

Definition at line 235 of file Polar3D.h.

◆ fTheta

template<class T>

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

private

Definition at line 236 of file Polar3D.h.

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

math/genvector/inc/Math/GenVector/Polar3D.h

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

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ Scalar

Constructor & Destructor Documentation

◆ Polar3D() [1/4]

◆ Polar3D() [2/4]

◆ Polar3D() [3/4]

◆ Polar3D() [4/4]

Member Function Documentation

◆ Eta()

◆ GetCoordinates() [1/2]

◆ GetCoordinates() [2/2]

◆ Mag2()

◆ Negate()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Perp2()

◆ Phi()

◆ pi()

◆ R()

◆ Restrict()

◆ Rho()

◆ Scale()

◆ SetCoordinates() [1/2]

◆ SetCoordinates() [2/2]

◆ SetPhi()

◆ SetR()

◆ SetTheta()

◆ SetXYZ()

◆ Theta()

◆ X()

◆ x()

◆ Y()

◆ y()

◆ Z()

◆ z()

Member Data Documentation

◆ fPhi

◆ fR

◆ fTheta

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