ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Private Attributes | List of all members
ROOT::Math::Cartesian3D< T > Class Template Reference
GenVector

template<class T = double>
class ROOT::Math::Cartesian3D< T >

Class describing a 3D cartesian coordinate system (x, y, z coordinates)

Definition at line 51 of file Cartesian3D.h.

Public Types

typedef T Scalar
 

Public Member Functions

 Cartesian3D ()
 Default constructor with x=y=z=0. More...
 
 Cartesian3D (Scalar xx, Scalar yy, Scalar zz)
 Constructor from x,y,z coordinates. More...
 
template<class CoordSystem >
 Cartesian3D (const CoordSystem &v)
 Construct from any Vector or coordinate system implementing X(), Y() and Z() More...
 
 Cartesian3D (const Cartesian3D &v)
 copy constructor More...
 
Cartesian3D & operator= (const Cartesian3D &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 xx, Scalar yy, Scalar zz)
 Set internal data based on 3 Scalar numbers. More...
 
void GetCoordinates (Scalar &xx, Scalar &yy, Scalar &zz) const
 get internal data into 3 Scalar numbers More...
 
Scalar X () const
 
Scalar Y () const
 
Scalar Z () const
 
Scalar Mag2 () const
 
Scalar Perp2 () const
 
Scalar Rho () const
 
Scalar R () const
 
Scalar Theta () const
 
Scalar Phi () const
 
Scalar Eta () const
 
void SetX (Scalar xx)
 set the x coordinate value keeping y and z constant More...
 
void SetY (Scalar yy)
 set the y coordinate value keeping x and z constant More...
 
void SetZ (Scalar zz)
 set the z coordinate value keeping x and y constant More...
 
void SetXYZ (Scalar xx, Scalar yy, Scalar zz)
 set all values using cartesian coordinates More...
 
void Scale (Scalar a)
 scale the vector by a scalar quantity a More...
 
void Negate ()
 negate the vector More...
 
template<class CoordSystem >
Cartesian3D & operator= (const CoordSystem &v)
 Assignment from any class implementing x(),y() and z() (can assign from any coordinate system) More...
 
bool operator== (const Cartesian3D &rhs) const
 Exact equality. More...
 
bool operator!= (const Cartesian3D &rhs) const
 
T x () const
 
T y () const
 
T z () const
 
template<class T2 >
 Cartesian3D (const Polar3D< T2 > &v)
 
template<class T2 >
Cartesian3D & operator= (const Polar3D< T2 > &v)
 

Private Attributes

T fX
 
T fY
 
T fZ
 

#include <Math/GenVector/Cartesian3D.h>

Member Typedef Documentation

template<class T = double>
typedef T ROOT::Math::Cartesian3D< T >::Scalar

Definition at line 55 of file Cartesian3D.h.

Constructor & Destructor Documentation

template<class T = double>
ROOT::Math::Cartesian3D< T >::Cartesian3D ( )
inline

Default constructor with x=y=z=0.

Definition at line 60 of file Cartesian3D.h.

template<class T = double>
ROOT::Math::Cartesian3D< T >::Cartesian3D ( Scalar  xx,
Scalar  yy,
Scalar  zz 
)
inline

Constructor from x,y,z coordinates.

Definition at line 65 of file Cartesian3D.h.

template<class T = double>
template<class CoordSystem >
ROOT::Math::Cartesian3D< T >::Cartesian3D ( const CoordSystem &  v)
inlineexplicit

Construct from any Vector or coordinate system implementing X(), Y() and Z()

Definition at line 72 of file Cartesian3D.h.

template<class T = double>
ROOT::Math::Cartesian3D< T >::Cartesian3D ( const Cartesian3D< T > &  v)
inline

copy constructor

Definition at line 80 of file Cartesian3D.h.

template<class T = double>
template<class T2 >
ROOT::Math::Cartesian3D< T >::Cartesian3D ( const Polar3D< T2 > &  v)
inlineexplicit

Definition at line 197 of file Cartesian3D.h.

Member Function Documentation

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Eta ( ) const
inline

Definition at line 127 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::GetCoordinates ( Scalar  dest[]) const
inline

get internal data into an array of 3 Scalar numbers

Definition at line 102 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::GetCoordinates ( Scalar &  xx,
Scalar &  yy,
Scalar &  zz 
) const
inline

get internal data into 3 Scalar numbers

Definition at line 113 of file Cartesian3D.h.

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Mag2 ( ) const
inline

Definition at line 118 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::R().

template<class T = double>
void ROOT::Math::Cartesian3D< T >::Negate ( )
inline

negate the vector

Definition at line 163 of file Cartesian3D.h.

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

Definition at line 183 of file Cartesian3D.h.

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

assignment operator

Definition at line 86 of file Cartesian3D.h.

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

Assignment from any class implementing x(),y() and z() (can assign from any coordinate system)

Definition at line 170 of file Cartesian3D.h.

template<class T = double>
template<class T2 >
Cartesian3D& ROOT::Math::Cartesian3D< T >::operator= ( const Polar3D< T2 > &  v)
inline

Definition at line 210 of file Cartesian3D.h.

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

Exact equality.

Definition at line 180 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::operator!=().

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Perp2 ( ) const
inline

Definition at line 119 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Rho().

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Phi ( ) const
inline

Definition at line 124 of file Cartesian3D.h.

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::R ( ) const
inline

Definition at line 121 of file Cartesian3D.h.

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Rho ( ) const
inline

Definition at line 120 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Eta(), and ROOT::Math::Cartesian3D< Double32_t >::Theta().

template<class T = double>
void ROOT::Math::Cartesian3D< T >::Scale ( Scalar  a)
inline

scale the vector by a scalar quantity a

Definition at line 158 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetCoordinates ( const Scalar  src[])
inline

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

Definition at line 97 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetCoordinates ( Scalar  xx,
Scalar  yy,
Scalar  zz 
)
inline

Set internal data based on 3 Scalar numbers.

Definition at line 108 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetX ( Scalar  xx)
inline

set the x coordinate value keeping y and z constant

Definition at line 134 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetXYZ ( Scalar  xx,
Scalar  yy,
Scalar  zz 
)
inline

set all values using cartesian coordinates

Definition at line 149 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetY ( Scalar  yy)
inline

set the y coordinate value keeping x and z constant

Definition at line 139 of file Cartesian3D.h.

template<class T = double>
void ROOT::Math::Cartesian3D< T >::SetZ ( Scalar  zz)
inline

set the z coordinate value keeping x and y constant

Definition at line 144 of file Cartesian3D.h.

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Theta ( ) const
inline

Definition at line 122 of file Cartesian3D.h.

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::X ( ) const
inline

Definition at line 115 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::x().

template<class T = double>
T ROOT::Math::Cartesian3D< T >::x ( ) const
inline

Definition at line 190 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::operator=().

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Y ( ) const
inline

Definition at line 116 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::y().

template<class T = double>
T ROOT::Math::Cartesian3D< T >::y ( ) const
inline

Definition at line 191 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::operator=().

template<class T = double>
Scalar ROOT::Math::Cartesian3D< T >::Z ( ) const
inline

Definition at line 117 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Theta(), and ROOT::Math::Cartesian3D< Double32_t >::z().

template<class T = double>
T ROOT::Math::Cartesian3D< T >::z ( ) const
inline

Definition at line 192 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::operator=().

Member Data Documentation

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fX
private

Definition at line 240 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Cartesian3D(), ROOT::Math::Cartesian3D< Double32_t >::GetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::Mag2(), ROOT::Math::Cartesian3D< Double32_t >::Negate(), ROOT::Math::Cartesian3D< Double32_t >::operator=(), ROOT::Math::Cartesian3D< Double32_t >::operator==(), ROOT::Math::Cartesian3D< Double32_t >::Perp2(), ROOT::Math::Cartesian3D< Double32_t >::Phi(), ROOT::Math::Cartesian3D< Double32_t >::Scale(), ROOT::Math::Cartesian3D< Double32_t >::SetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::SetX(), ROOT::Math::Cartesian3D< Double32_t >::SetXYZ(), ROOT::Math::Cartesian3D< Double32_t >::Theta(), and ROOT::Math::Cartesian3D< Double32_t >::X().

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fY
private

Definition at line 241 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Cartesian3D(), ROOT::Math::Cartesian3D< Double32_t >::GetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::Mag2(), ROOT::Math::Cartesian3D< Double32_t >::Negate(), ROOT::Math::Cartesian3D< Double32_t >::operator=(), ROOT::Math::Cartesian3D< Double32_t >::operator==(), ROOT::Math::Cartesian3D< Double32_t >::Perp2(), ROOT::Math::Cartesian3D< Double32_t >::Phi(), ROOT::Math::Cartesian3D< Double32_t >::Scale(), ROOT::Math::Cartesian3D< Double32_t >::SetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::SetXYZ(), ROOT::Math::Cartesian3D< Double32_t >::SetY(), ROOT::Math::Cartesian3D< Double32_t >::Theta(), and ROOT::Math::Cartesian3D< Double32_t >::Y().

template<class T = double>
T ROOT::Math::Cartesian3D< T >::fZ
private

Definition at line 242 of file Cartesian3D.h.

Referenced by ROOT::Math::Cartesian3D< Double32_t >::Eta(), ROOT::Math::Cartesian3D< Double32_t >::GetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::Mag2(), ROOT::Math::Cartesian3D< Double32_t >::Negate(), ROOT::Math::Cartesian3D< Double32_t >::operator=(), ROOT::Math::Cartesian3D< Double32_t >::operator==(), ROOT::Math::Cartesian3D< Double32_t >::Scale(), ROOT::Math::Cartesian3D< Double32_t >::SetCoordinates(), ROOT::Math::Cartesian3D< Double32_t >::SetXYZ(), ROOT::Math::Cartesian3D< Double32_t >::SetZ(), ROOT::Math::Cartesian3D< Double32_t >::Theta(), and ROOT::Math::Cartesian3D< Double32_t >::Z().

Collaboration diagram for ROOT::Math::Cartesian3D< T >:
[legend]
The documentation for this class was generated from the following file: