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

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

Class describing a 3D Cylindrical Eta coordinate system (rho, eta, phi coordinates)

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 CylindricalEta3D.h.

Public Types
typedef T	Scalar

Public Member Functions
	CylindricalEta3D ()
	Default constructor with rho=eta=phi=0. More...

	CylindricalEta3D (Scalar rho, Scalar eta, Scalar phi)
	Construct from rho eta and phi values. More...

template<class CoordSystem >
	CylindricalEta3D (const CoordSystem &v)
	Construct from any Vector or coordinate system implementing Rho(), Eta() and Phi() More...

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

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

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

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

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

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

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 More...

void	SetEta (T eta)
	set the eta coordinate value keeping rho and phi constant More...

void	SetPhi (T phi)
	set the phi coordinate value keeping rho and eta constant More...

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

void	Scale (T a)
	scale by a scalar quantity a – for cylindrical eta coords, as long as a >= 0, only rho changes! More...

void	Negate ()
	negate the vector More...

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

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. More...

bool	operator!= (const CylindricalEta3D &rhs) const

T	x () const

T	y () const

T	z () const

Private Member Functions
void	Restrict ()

Static Private Member Functions
static Scalar	pi ()

Private Attributes
T	fRho

T	fEta

T	fPhi

#include <Math/GenVector/CylindricalEta3D.h>

Collaboration diagram for ROOT::Math::CylindricalEta3D< T >:

Member Typedef Documentation

template<class T >

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

Definition at line 55 of file 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 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 CylindricalEta3D.h.

template<class T >

template<class CoordSystem >

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

inlineexplicit

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

Definition at line 73 of file CylindricalEta3D.h.

template<class T >

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

inline

copy constructor

Definition at line 91 of file CylindricalEta3D.h.

Member Function Documentation

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Eta ( ) const

inline

Definition at line 140 of file CylindricalEta3D.h.

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

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 CylindricalEta3D.h.

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 CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Mag2 ( ) const

inline

Definition at line 152 of file CylindricalEta3D.h.

template<class T >

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

inline

negate the vector

Definition at line 211 of file 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 CylindricalEta3D.h.

template<class T >

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

inline

assignment operator

Definition at line 97 of file CylindricalEta3D.h.

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 CylindricalEta3D.h.

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 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 CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Phi ( ) const

inline

Definition at line 141 of file CylindricalEta3D.h.

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

template<class T >

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

inlinestaticprivate

Definition at line 129 of file CylindricalEta3D.h.

Referenced by ROOT::Math::CylindricalEta3D< T >::Negate(), ROOT::Math::CylindricalEta3D< T >::Restrict(), and ROOT::Math::CylindricalEta3D< T >::Theta().

template<class T >

T ROOT::Math::CylindricalEta3D< T >::R ( ) const

inline

Definition at line 148 of file CylindricalEta3D.h.

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

template<class T >

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

inlineprivate

Definition at line 130 of file CylindricalEta3D.h.

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

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Rho ( ) const

inline

Definition at line 139 of file 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 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 CylindricalEta3D.h.

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 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 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 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 CylindricalEta3D.h.

template<class T >

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

set all values using cartesian coordinates

Definition at line 302 of file CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Theta ( ) const

inline

Definition at line 154 of file CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::X ( ) const

inline

Definition at line 142 of file CylindricalEta3D.h.

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

template<class T >

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

inline

Definition at line 244 of file CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Y ( ) const

inline

Definition at line 143 of file CylindricalEta3D.h.

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

template<class T >

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

inline

Definition at line 245 of file CylindricalEta3D.h.

template<class T >

T ROOT::Math::CylindricalEta3D< T >::Z ( ) const

inline

Definition at line 144 of file CylindricalEta3D.h.

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

template<class T >

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

inline

Definition at line 246 of file CylindricalEta3D.h.

Member Data Documentation

template<class T >

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

private

Definition at line 272 of file CylindricalEta3D.h.

template<class T >

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

private

Definition at line 273 of file CylindricalEta3D.h.

Referenced by ROOT::Math::CylindricalEta3D< T >::GetCoordinates(), ROOT::Math::CylindricalEta3D< T >::Negate(), ROOT::Math::CylindricalEta3D< T >::operator=(), ROOT::Math::CylindricalEta3D< T >::operator==(), ROOT::Math::CylindricalEta3D< T >::Phi(), ROOT::Math::CylindricalEta3D< T >::Restrict(), ROOT::Math::CylindricalEta3D< T >::SetCoordinates(), ROOT::Math::CylindricalEta3D< T >::SetPhi(), ROOT::Math::CylindricalEta3D< T >::X(), and ROOT::Math::CylindricalEta3D< T >::Y().

template<class T >

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

private

Definition at line 271 of file CylindricalEta3D.h.

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

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

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

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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