om::math::SHExpansion< T > Class Template Reference

A class that stores a spherical harmonic expansion of a template (possibly vector) type. More...

#include <omSphericalHarmonics.h>

Public Member Functions
	SHExpansion ()
	Create a spherical harmonic expansion with no cofficients allocated. More...
	SHExpansion (Size newOrder)
	Create a spherical harmonic expansion of the specified order. More...
	SHExpansion (const SHExpansion &other)
	Create a spherical harmonic expansion that is a copy of another expansion. More...
SHExpansion &	operator= (const SHExpansion &other)
	Assign the contents of another spherical harmonic expansion to this one. More...
Size	getOrder () const
	Return the order of this spherical harmonic expansion. More...
void	setOrder (Size newOrder)
	Set the order of this spherical harmonic expansion. More...
void	setOrderUninitialized (Size newOrder)
	Set the order of this spherical harmonic expansion. More...
T *	getCoefficients ()
	Return a pointer to the spherical harmonic coefficients for this expansion. More...
const T *	getCoefficients () const
	Return a const pointer to the spherical harmonic coefficients for this expansion. More...
Size	getCoefficientCount () const
	Return the number of coefficients that are in this spherical harmonic expansion. More...
void	zero ()
	Zero-out the storage of this spherical harmonic expansion. More...

Detailed Description

template<typename T>
class om::math::SHExpansion< T >

A class that stores a spherical harmonic expansion of a template (possibly vector) type.

Constructor & Destructor Documentation

template<typename T >

om::math::SHExpansion< T >::SHExpansion ( )

inline

Create a spherical harmonic expansion with no cofficients allocated.

template<typename T >

om::math::SHExpansion< T >::SHExpansion ( Size  newOrder )

inline

Create a spherical harmonic expansion of the specified order.

The coefficients are uninitialized.

template<typename T >

om::math::SHExpansion< T >::SHExpansion ( const SHExpansion< T > &  other )

inline

Create a spherical harmonic expansion that is a copy of another expansion.

Member Function Documentation

template<typename T >

SHExpansion& om::math::SHExpansion< T >::operator= ( const SHExpansion< T > &  other )

inline

Assign the contents of another spherical harmonic expansion to this one.

template<typename T >

Size om::math::SHExpansion< T >::getOrder ( ) const

inline

Return the order of this spherical harmonic expansion.

An expansion of order N has (N+1)*(N+1) coefficients in its expansion.

template<typename T >

void om::math::SHExpansion< T >::setOrder ( Size  newOrder )

inline

Set the order of this spherical harmonic expansion.

The entries from the previous expansion that are valid for the specified order are copied into the new expansion array. Any new values in the expansion are uninitialized.

template<typename T >

void om::math::SHExpansion< T >::setOrderUninitialized ( Size  newOrder )

inline

Set the order of this spherical harmonic expansion.

The entries in the new expansion array are not initialized.

template<typename T >

T* om::math::SHExpansion< T >::getCoefficients ( )

inline

Return a pointer to the spherical harmonic coefficients for this expansion.

template<typename T >

const T* om::math::SHExpansion< T >::getCoefficients ( ) const

inline

Return a const pointer to the spherical harmonic coefficients for this expansion.

template<typename T >

Size om::math::SHExpansion< T >::getCoefficientCount ( ) const

inline

Return the number of coefficients that are in this spherical harmonic expansion.

template<typename T >

void om::math::SHExpansion< T >::zero ( )

inline

Zero-out the storage of this spherical harmonic expansion.

---

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

• omSphericalHarmonics.h