OpenWalnut  1.4.0
Public Member Functions | Private Attributes
WUnitSphereCoordinates< T > Class Template Reference

This class stores coordinates on the unit sphere. More...

#include <WUnitSphereCoordinates.h>

List of all members.

Public Member Functions

 WUnitSphereCoordinates ()
 Default constructor.
 WUnitSphereCoordinates (T theta, T phi)
 Constructor for unit sphere angles.
 WUnitSphereCoordinates (const WMatrixFixed< T, 3, 1 > &vector)
 Constructor for Euclidean coordinates.
virtual ~WUnitSphereCoordinates ()
 Destructor.
getTheta () const
 Return the theta angle.
getPhi () const
 Return the phi angle.
void setTheta (T theta)
 Set theta angle.
void setPhi (T phi)
 Set phi angle.
WMatrixFixed< T, 3, 1 > getEuclidean () const
 Returns the stored sphere coordinates as Euclidean coordinates.
void setEuclidean (WMatrixFixed< T, 3, 1 > vector)
 Returns the stored sphere coordinates as Euclidean coordinates.

Private Attributes

m_theta
 coordinate
m_phi
 coordinate

Detailed Description

template<typename T>
class WUnitSphereCoordinates< T >

This class stores coordinates on the unit sphere.

Definition at line 37 of file WUnitSphereCoordinates.h.


Constructor & Destructor Documentation

template<typename T >
WUnitSphereCoordinates< T >::WUnitSphereCoordinates ( )

Default constructor.

Definition at line 114 of file WUnitSphereCoordinates.h.

template<typename T >
WUnitSphereCoordinates< T >::WUnitSphereCoordinates ( theta,
phi 
)

Constructor for unit sphere angles.

Parameters:
thetacoordinate
phicoordinate

Definition at line 121 of file WUnitSphereCoordinates.h.

template<typename T >
WUnitSphereCoordinates< T >::WUnitSphereCoordinates ( const WMatrixFixed< T, 3, 1 > &  vector) [explicit]

Constructor for Euclidean coordinates.

Parameters:
vectorEuclidean coordinates

Definition at line 128 of file WUnitSphereCoordinates.h.

template<typename T >
WUnitSphereCoordinates< T >::~WUnitSphereCoordinates ( ) [virtual]

Destructor.

Definition at line 134 of file WUnitSphereCoordinates.h.


Member Function Documentation

template<typename T >
WMatrixFixed< T, 3, 1 > WUnitSphereCoordinates< T >::getEuclidean ( ) const

Returns the stored sphere coordinates as Euclidean coordinates.

Returns:
sphere coordinates in euclidean space

Definition at line 163 of file WUnitSphereCoordinates.h.

Referenced by WUnitSphereCoordinatesTest::testSphereToEuclideanConversion().

template<typename T >
T WUnitSphereCoordinates< T >::getPhi ( ) const

Return the phi angle.

Returns:
phi angle

Definition at line 145 of file WUnitSphereCoordinates.h.

Referenced by WSymmetricSphericalHarmonic< T >::getValue().

template<typename T >
T WUnitSphereCoordinates< T >::getTheta ( ) const

Return the theta angle.

Returns:
theta angle

Definition at line 139 of file WUnitSphereCoordinates.h.

Referenced by WSymmetricSphericalHarmonic< T >::getValue().

template<typename T >
void WUnitSphereCoordinates< T >::setEuclidean ( WMatrixFixed< T, 3, 1 >  vector)

Returns the stored sphere coordinates as Euclidean coordinates.

Parameters:
vectorcoordinates in euclidean space

Definition at line 169 of file WUnitSphereCoordinates.h.

Referenced by WUnitSphereCoordinatesTest::testSphereToEuclideanConversion().

template<typename T >
void WUnitSphereCoordinates< T >::setPhi ( phi)

Set phi angle.

Parameters:
phiValue for phi.

Definition at line 157 of file WUnitSphereCoordinates.h.

template<typename T >
void WUnitSphereCoordinates< T >::setTheta ( theta)

Set theta angle.

Parameters:
thetaValue for theta.

Definition at line 151 of file WUnitSphereCoordinates.h.


Member Data Documentation

template<typename T>
T WUnitSphereCoordinates< T >::m_phi [private]

coordinate

Definition at line 110 of file WUnitSphereCoordinates.h.

template<typename T>
T WUnitSphereCoordinates< T >::m_theta [private]

coordinate

Definition at line 108 of file WUnitSphereCoordinates.h.


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