Logo ROOT  
Reference Guide
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
Overview of the physics vector library
Class describing a 2D Polar coordinate system

(r, phi coordinates)

Definition at line 45 of file Polar2D.h.

Public Types

typedef T Scalar
 

Public Member Functions

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

Private Member Functions

void Restrict ()
 restrict abgle hi to be between -PI and PI More...
 

Static Private Member Functions

static double pi ()
 

Private Attributes

fPhi
 
fR
 

#include <Math/GenVector/Polar2D.h>

Member Typedef Documentation

◆ Scalar

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

Definition at line 49 of file Polar2D.h.

Constructor & Destructor Documentation

◆ Polar2D() [1/4]

template<class T >
ROOT::Math::Polar2D< T >::Polar2D ( )
inline

Default constructor with r=1,phi=0.

Definition at line 54 of file Polar2D.h.

◆ Polar2D() [2/4]

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

Construct from the polar coordinates: r and phi.

Definition at line 59 of file Polar2D.h.

◆ Polar2D() [3/4]

template<class T >
template<class CoordSystem >
ROOT::Math::Polar2D< T >::Polar2D ( const CoordSystem &  v)
inlineexplicit

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

Definition at line 66 of file Polar2D.h.

◆ Polar2D() [4/4]

template<class T >
ROOT::Math::Polar2D< T >::Polar2D ( const Polar2D< T > &  v)
inline

copy constructor

Definition at line 75 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 97 of file Polar2D.h.

◆ Mag2()

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

Definition at line 104 of file Polar2D.h.

◆ Negate()

template<class T >
void ROOT::Math::Polar2D< T >::Negate ( )
inline

negate the vector

Definition at line 160 of file Polar2D.h.

◆ operator!=()

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

Definition at line 189 of file Polar2D.h.

◆ operator=() [1/2]

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 177 of file Polar2D.h.

◆ operator=() [2/2]

template<class T >
Polar2D & ROOT::Math::Polar2D< T >::operator= ( const Polar2D< T > &  v)
inline

assignment operator

Definition at line 81 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 186 of file Polar2D.h.

◆ Phi()

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

Definition at line 101 of file Polar2D.h.

◆ pi()

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

Definition at line 133 of file Polar2D.h.

◆ R()

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

Definition at line 100 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 138 of file Polar2D.h.

◆ Rotate()

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

rotate the vector

Definition at line 167 of file Polar2D.h.

◆ Scale()

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

scale by a scalar quantity - for polar coordinates r changes

Definition at line 148 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 91 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 121 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 113 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 237 of file Polar2D.h.

◆ X()

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

Definition at line 102 of file Polar2D.h.

◆ x()

template<class T >
T ROOT::Math::Polar2D< T >::x ( ) const
inline

Definition at line 196 of file Polar2D.h.

◆ Y()

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

Definition at line 103 of file Polar2D.h.

◆ y()

template<class T >
T ROOT::Math::Polar2D< T >::y ( ) const
inline

Definition at line 197 of file Polar2D.h.

Member Data Documentation

◆ fPhi

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

Definition at line 215 of file Polar2D.h.

◆ fR

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

Definition at line 214 of file Polar2D.h.


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