ROOT::Math::Polar2D< T > Class Template Reference

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

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

See also

Physics Vectors

Class describing a 2D Polar coordinate system

(r, phi coordinates)

Definition at line 46 of file Polar2D.h.

Public Types
typedef T	Scalar

Public Member Functions
constexpr	Polar2D () noexcept=default
	Default constructor with r=1,phi=0.
template<class CoordSystem >
constexpr	Polar2D (const CoordSystem &v)
	Construct from any Vector or coordinate system implementing R() and Phi()
	Polar2D (T r, T phi)
	Construct from the polar coordinates: r and phi.
void	GetCoordinates (Scalar &r, Scalar &phi) const
	get internal data into 2 Scalar numbers
Scalar	Mag2 () const
void	Negate ()
	negate the vector
bool	operator!= (const Polar2D &rhs) const
template<class CoordSystem >
Polar2D &	operator= (const CoordSystem &c)
	generic assignment operator from any coordinate system
bool	operator== (const Polar2D &rhs) const
	Exact equality.
Scalar	Phi () const
Scalar	R () const
void	Rotate (T angle)
	rotate the vector
void	Scale (T a)
	scale by a scalar quantity - for polar coordinates r changes
void	SetCoordinates (Scalar r, Scalar phi)
	Set internal data based on 2 Scalar numbers.
void	SetPhi (const T &phi)
	set the phi coordinate value keeping r constant
void	SetR (const T &r)
	set the r coordinate value keeping phi constant
void	SetXY (Scalar a, Scalar b)
	set all values using cartesian coordinates
Scalar	X () const
T	x () const
Scalar	Y () const
T	y () const

Static Public Attributes
static constexpr unsigned int	Dimension = 2U

Private Member Functions
void	Restrict ()
	restrict abgle hi to be between -PI and PI

Static Private Member Functions
static double	pi ()

Private Attributes
T	fPhi = 0.
T	fR = 1.

#include <Math/GenVector/Polar2D.h>

Member Typedef Documentation

Scalar

template<class T >

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

Definition at line 50 of file Polar2D.h.

Constructor & Destructor Documentation

Polar2D() [1/3]

template<class T >

constexpr ROOT::Math::Polar2D< T >::Polar2D ( )

constexprdefaultnoexcept

Default constructor with r=1,phi=0.

Polar2D() [2/3]

template<class T >

ROOT::Math::Polar2D< T >::Polar2D ( T r, T phi )

inline

Construct from the polar coordinates: r and phi.

Definition at line 61 of file Polar2D.h.

Polar2D() [3/3]

template<class T >

template<class CoordSystem >

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

inlineexplicitconstexpr

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

Definition at line 68 of file Polar2D.h.

Member Function Documentation

GetCoordinates()

template<class T >

void ROOT::Math::Polar2D< T >::GetCoordinates ( Scalar & r, Scalar & phi ) const

inline

get internal data into 2 Scalar numbers

Definition at line 80 of file Polar2D.h.

Mag2()

template<class T >

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

inline

Definition at line 87 of file Polar2D.h.

Negate()

template<class T >

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

inline

negate the vector

Definition at line 143 of file Polar2D.h.

operator!=()

template<class T >

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

inline

Definition at line 172 of file Polar2D.h.

operator=()

template<class T >

template<class CoordSystem >

Polar2D & ROOT::Math::Polar2D< T >::operator= ( const CoordSystem & c )

inline

generic assignment operator from any coordinate system

Definition at line 160 of file Polar2D.h.

operator==()

template<class T >

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

inline

Exact equality.

Definition at line 169 of file Polar2D.h.

Phi()

template<class T >

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

inline

Definition at line 84 of file Polar2D.h.

pi()

template<class T >

static double ROOT::Math::Polar2D< T >::pi ( )

inlinestaticprivate

Definition at line 116 of file Polar2D.h.

R()

template<class T >

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

inline

Definition at line 83 of file Polar2D.h.

Restrict()

template<class T >

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

inlineprivate

restrict abgle hi to be between -PI and PI

Definition at line 121 of file Polar2D.h.

Rotate()

template<class T >

void ROOT::Math::Polar2D< T >::Rotate ( T angle )

inline

rotate the vector

Definition at line 150 of file Polar2D.h.

Scale()

template<class T >

void ROOT::Math::Polar2D< T >::Scale ( T a )

inline

scale by a scalar quantity - for polar coordinates r changes

Definition at line 131 of file Polar2D.h.

SetCoordinates()

template<class T >

void ROOT::Math::Polar2D< T >::SetCoordinates ( Scalar r, Scalar phi )

inline

Set internal data based on 2 Scalar numbers.

Definition at line 74 of file Polar2D.h.

SetPhi()

template<class T >

void ROOT::Math::Polar2D< T >::SetPhi ( const T & phi )

inline

set the phi coordinate value keeping r constant

Definition at line 104 of file Polar2D.h.

SetR()

template<class T >

void ROOT::Math::Polar2D< T >::SetR ( const T & r )

inline

set the r coordinate value keeping phi constant

Definition at line 96 of file Polar2D.h.

SetXY()

template<class T >

void ROOT::Math::Polar2D< T >::SetXY	(	Scalar	a,
		Scalar	b )

set all values using cartesian coordinates

Definition at line 220 of file Polar2D.h.

X()

template<class T >

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

inline

Definition at line 85 of file Polar2D.h.

x()

template<class T >

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

inline

Definition at line 179 of file Polar2D.h.

Y()

template<class T >

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

inline

Definition at line 86 of file Polar2D.h.

y()

template<class T >

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

inline

Definition at line 180 of file Polar2D.h.

Member Data Documentation

Dimension

template<class T >

constexpr unsigned int ROOT::Math::Polar2D< T >::Dimension = 2U

staticconstexpr

Definition at line 51 of file Polar2D.h.

fPhi

template<class T >

T ROOT::Math::Polar2D< T >::fPhi = 0.

private

Definition at line 198 of file Polar2D.h.

fR

template<class T >

T ROOT::Math::Polar2D< T >::fR = 1.

private

Definition at line 197 of file Polar2D.h.