ProcessorHarmonics< D, T > Class Template Reference

The harmonic processor. More...

#include <Hoa_Processor.hpp>

Inheritance diagram for ProcessorHarmonics< D, T >:

Public Member Functions
	ProcessorHarmonics (const size_t order) hoa_noexcept
	The harmonics constructor. More...
virtual	~ProcessorHarmonics () hoa_noexcept
	The harmonics destructor.
size_t	getDecompositionOrder () const hoa_noexcept
	Returns the order of decomposition.
size_t	getNumberOfHarmonics () const hoa_noexcept
	Returns the number of harmonics.
size_t	getHarmonicDegree (const size_t index) const hoa_noexcept
	Returns the degree of an harmonic. More...
long	getHarmonicOrder (const size_t index) const hoa_noexcept
	Returns the azimuthal order of an harmonic. More...
size_t	getHarmonicIndex (const size_t degree, const long order) const hoa_noexcept
	Returns the index of an harmonic given the degree and the azimuthal order. More...
std::string	getHarmonicName (const size_t index) const hoa_noexcept
	Returns the name of an harmonic. More...
T	getHarmonicNormalization (const size_t index) const hoa_noexcept
	Returns the normalization of an harmonic. More...
T	getHarmonicSemiNormalization (const size_t index) const hoa_noexcept
	Returns the semi-normalization of an harmonic. More...
Public Member Functions inherited from Processor< D, T >
virtual	~Processor () hoa_noexcept
	The destructor.
virtual void	process (const T *inputs, T *outputs) hoa_noexcept
	The pure virtual method performs that performs the digital signal processing. More...

Detailed Description

template<Dimension D, typename T>
class hoa::ProcessorHarmonics< D, T >

The harmonic processor.

The harmonic processor owns a set of harmonics depending on the order of decomposition.

Definition at line 40 of file Hoa_Processor.hpp.

Constructor & Destructor Documentation

ProcessorHarmonics ( const size_t  order )

inline

The harmonics constructor.

Parameters

order

The order of decomposition, must be at least 1.

Definition at line 46 of file Hoa_Processor.hpp.

Member Function Documentation

size_t getHarmonicDegree ( const size_t  index ) const

inline

Returns the degree of an harmonic.

Parameters

index

The index of an harmonic.

Definition at line 61 of file Hoa_Processor.hpp.

long getHarmonicOrder ( const size_t  index ) const

inline

Returns the azimuthal order of an harmonic.

Parameters

index

The index of an harmonic.

Definition at line 66 of file Hoa_Processor.hpp.

size_t getHarmonicIndex ( const size_t  degree, const long  order  ) const

inline

Returns the index of an harmonic given the degree and the azimuthal order.

Parameters

degree	The degree of the harmonic.
order	The azimuthal order of the harmonic.

Definition at line 72 of file Hoa_Processor.hpp.

std::string getHarmonicName ( const size_t  index ) const

inline

Returns the name of an harmonic.

Parameters

index

The index of an harmonic.

Definition at line 77 of file Hoa_Processor.hpp.

T getHarmonicNormalization ( const size_t  index ) const

inline

Returns the normalization of an harmonic.

Parameters

index

The index of an harmonic.

Definition at line 82 of file Hoa_Processor.hpp.

T getHarmonicSemiNormalization ( const size_t  index ) const

inline

Returns the semi-normalization of an harmonic.

Parameters

index

The index of an harmonic.

Definition at line 87 of file Hoa_Processor.hpp.