WUnitSphereCoordinates< T > Class Template Reference

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

#include <WUnitSphereCoordinates.h>

Collaboration diagram for WUnitSphereCoordinates< T >:

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

Private Attributes
T	m_theta
	coordinate More...
T	m_phi
	coordinate More...

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

WUnitSphereCoordinates() [1/3]

template<typename T >

WUnitSphereCoordinates< T >::WUnitSphereCoordinates

Default constructor.

Definition at line 114 of file WUnitSphereCoordinates.h.

WUnitSphereCoordinates() [2/3]

template<typename T >

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

Constructor for unit sphere angles.

Parameters

theta	coordinate
phi	coordinate

Definition at line 121 of file WUnitSphereCoordinates.h.

WUnitSphereCoordinates() [3/3]

template<typename T >

WUnitSphereCoordinates< T >::WUnitSphereCoordinates ( const WMatrixFixed< T, 3, 1 > &  vector )

explicit

Constructor for Euclidean coordinates.

Parameters

vector

Euclidean coordinates

Definition at line 128 of file WUnitSphereCoordinates.h.

~WUnitSphereCoordinates()

template<typename T >

WUnitSphereCoordinates< T >::~WUnitSphereCoordinates

virtual

Destructor.

Definition at line 134 of file WUnitSphereCoordinates.h.

Member Function Documentation

getEuclidean()

template<typename T >

WMatrixFixed< T, 3, 1 > WUnitSphereCoordinates< T >::getEuclidean

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().

Here is the caller graph for this function:

getPhi()

template<typename T >

T WUnitSphereCoordinates< T >::getPhi

Return the phi angle.

Returns

phi angle

Definition at line 145 of file WUnitSphereCoordinates.h.

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

Here is the caller graph for this function:

getTheta()

template<typename T >

T WUnitSphereCoordinates< T >::getTheta

Return the theta angle.

Returns

theta angle

Definition at line 139 of file WUnitSphereCoordinates.h.

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

Here is the caller graph for this function:

setEuclidean()

template<typename T >

void WUnitSphereCoordinates< T >::setEuclidean

(

WMatrixFixed< T, 3, 1 >

vector

)

Returns the stored sphere coordinates as Euclidean coordinates.

Parameters

vector

coordinates in euclidean space

Definition at line 169 of file WUnitSphereCoordinates.h.

Referenced by WUnitSphereCoordinatesTest::testSphereToEuclideanConversion().

Here is the caller graph for this function:

setPhi()

template<typename T >

void WUnitSphereCoordinates< T >::setPhi

(

T

phi

)

Set phi angle.

Parameters

phi	Value for phi.

Definition at line 157 of file WUnitSphereCoordinates.h.

setTheta()

template<typename T >

void WUnitSphereCoordinates< T >::setTheta

(

T

theta

)

Set theta angle.

Parameters

theta

Value for theta.

Definition at line 151 of file WUnitSphereCoordinates.h.

Member Data Documentation

m_phi

template<typename T >

T WUnitSphereCoordinates< T >::m_phi

private

coordinate

Definition at line 110 of file WUnitSphereCoordinates.h.

m_theta

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:

• WUnitSphereCoordinates.h