The planewaves processor. More...

#include <Hoa_Processor.hpp>

Inheritance diagram for ProcessorPlanewaves< D, T >:

Public Member Functions
	ProcessorPlanewaves (const size_t nplws) hoa_noexcept
	The planewaves constructor. More...

virtual	~ProcessorPlanewaves () hoa_noexcept
	The planewaves destructor.

size_t	getNumberOfPlanewaves () const hoa_noexcept
	Returns the number of planewaves.

void	setPlanewavesRotation (const T x_axe, const T y_axe, const T z_axe) hoa_noexcept
	Sets the global rotation of the planewaves. More...

T	getPlanewavesRotationX () const hoa_noexcept
	Returns the angle of rotation around the x axis in radian of the planewaves.

T	getPlanewavesRotationY () const hoa_noexcept
	Returns the angle of rotation around the y axis in radian of the planewaves.

T	getPlanewavesRotationZ () const hoa_noexcept
	Returns the angle of rotation around the z axis in radian of the planewaves.

size_t	getPlanewaveIndex (const size_t index) hoa_noexcept
	Returns the index of a planewave.

void	setPlanewaveAzimuth (const size_t index, const T azimuth) hoa_noexcept
	Sets the azimuth of a planewave in radian. More...

void	setPlanewaveElevation (const size_t index, const T elevation) hoa_noexcept
	Sets the azimuth of a planewave in radian. More...

T	getPlanewaveAzimuth (const size_t index, const bool rotation=true) const hoa_noexcept
	Returns the azimuth of a planewave. More...

T	getPlanewaveElevation (const size_t index, const bool rotation=true) const hoa_noexcept
	Returns the elevation of a planewave. More...

T	getPlanewaveAbscissa (const size_t index, const bool rotation=true) const hoa_noexcept
	Returns the abscissa of a planewave. More...

T	getPlanewaveOrdinate (const size_t index, const bool rotation=true) const hoa_noexcept
	Returns the ordinate of a planewave. More...

T	getPlanewaveHeight (const size_t index, const bool rotation=true) const hoa_noexcept
	Returns the height of a planewave. More...

std::string	getPlanewaveName (const size_t index) const hoa_noexcept
	Retruns the name for a planewave. 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::ProcessorPlanewaves< D, T >

The planewaves processor.

The planewaves processor owns a set of planewaves.

Definition at line 19 of file Hoa_Planewaves.hpp.

Constructor & Destructor Documentation

ProcessorPlanewaves ( const size_t nplws )

inline

The planewaves constructor.

Parameters

nplws The number of planewaves.

Definition at line 130 of file Hoa_Processor.hpp.

Member Function Documentation

void setPlanewavesRotation	(	const T	x_axe,
		const T	y_axe,
		const T	z_axe
	)

inline

Sets the global rotation of the planewaves.

Parameters

x_axe	The angle of rotation around the x axis in radian.
y_axe	The angle of rotation around the y axis in radian.
z_axe	The angle of rotation around the z axis in radian.

Definition at line 169 of file Hoa_Processor.hpp.

void setPlanewaveAzimuth	(	const size_t	index,
		const T	azimuth
	)

inline

Sets the azimuth of a planewave in radian.

The azimuth of the planewaves is in radian, 0 radian is at the front of the soundfield and π is at the back of the sound field.

Parameters

index	The index of the planewave.
azimuth	The azimuth of the planewave.

Definition at line 194 of file Hoa_Processor.hpp.

void setPlanewaveElevation	(	const size_t	index,
		const T	elevation
	)

inline

Sets the azimuth of a planewave in radian.

The elevation of the planewaves is in radian, 0 radian is at the equator of the soundfield, π/2 radian is the top of the sound field and -π/2 radian is the bottom of the sound field.

Parameters

index	The index of the planewave.
elevation	The elevation of the planewave.

Definition at line 203 of file Hoa_Processor.hpp.

T getPlanewaveAzimuth	(	const size_t	index,
		const bool	rotation = `true`
	)		const

inline

Returns the azimuth of a planewave.

The azimuth of the planewaves is in radian, 0 radian is at the front of the soundfield and π is at the back of the sound field.

Parameters

index	The index of the planewave.
rotation	false if you don't want to consider the rotation, otherwise true (default).

Definition at line 211 of file Hoa_Processor.hpp.

T getPlanewaveElevation	(	const size_t	index,
		const bool	rotation = `true`
	)		const

inline

Returns the elevation of a planewave.

The elevation of the planewaves is in radian, 0 radian is at the equator of the soundfield, π/2 radian is the top of the sound field and -π/2 radian is the bottom of the sound field.

Parameters

index	The index of the planewave.
rotation	false if you don't want to consider the rotation, otherwise true (default).

Definition at line 228 of file Hoa_Processor.hpp.

T getPlanewaveAbscissa	(	const size_t	index,
		const bool	rotation = `true`
	)		const

inline

Returns the abscissa of a planewave.

The abscissa is between -1 and 1, -1 is the left of the soundfield, 0 is the center of the soundfield and 1 is the right of the soundfield.

Parameters

index	The index of the planewave.
rotation	false if you don't want to consider the rotation, otherwise true (default).

Definition at line 244 of file Hoa_Processor.hpp.

T getPlanewaveOrdinate	(	const size_t	index,
		const bool	rotation = `true`
	)		const

inline

Returns the ordinate of a planewave.

The ordinate is between -1 and 1, -1 is the back of the soundfield, 0 is the center of the soundfield and 1 is the front of the soundfield.

Parameters

index	The index of the planewave.
rotation	false if you don't want to consider the rotation, otherwise true (default).

Definition at line 260 of file Hoa_Processor.hpp.

T getPlanewaveHeight	(	const size_t	index,
		const bool	rotation = `true`
	)		const

inline

Returns the height of a planewave.

The height is between -1 and 1, -1 is the back of the soundfield, 0 is the center of the soundfield and 1 is the front of the soundfield.

Parameters

index	The index of the planewave.
rotation	false if you don't want to consider the rotation, otherwise true (default).

Definition at line 276 of file Hoa_Processor.hpp.

std::string getPlanewaveName ( const size_t index ) const

inline

Retruns the name for a planewave.

The a name for a planewave is in a std::string format that will be "Planewave index azimuth (in degrees)".

Parameters

index The index of a planewave.

Definition at line 291 of file Hoa_Processor.hpp.

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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