Hoa2D::Rotate Class Reference

The ambisonic rotation. More...

#include <Rotate.h>

Inheritance diagram for Hoa2D::Rotate:

Public Member Functions
	Rotate (unsigned int order)
	The rotate constructor. More...
	~Rotate ()
	The Rotate destructor. More...
void	setYaw (const double value)
	This method sets the angle of the rotation around the z axis, the yaw value,. More...
double	getYaw () const
	Get the angle of the rotation around the z axis, the yaw value. More...
void	process (const float *inputs, float *outputs)
	This method performs the rotation with single precision. More...
void	process (const double *inputs, double *outputs)
	This method performs the rotation with double precision. More...
Public Member Functions inherited from Hoa2D::Ambisonic
	Ambisonic (unsigned int order)
	The ambisonic constructor. More...
	~Ambisonic ()
	The ambisonic destructor. More...
unsigned int	getOrder () const
	Retrieve the decomposition order. More...
unsigned int	getNumberOfHarmonics () const
	Retrieve the number of harmonics. More...
long	getHarmonicArgument (unsigned int index) const
	Retrieve the argument of an harmonic. More...
long	getHarmonicBand (unsigned int index) const
	Retrieve the band of an harmonic. More...
std::string	getHarmonicsName (unsigned int index) const
	Retrieve a name for an harmonic. More...

Detailed Description

The ambisonic rotation.

The rotate should be used to rotate the ambisonic soundfield.

Definition at line 17 of file Rotate.h.

Constructor & Destructor Documentation

Hoa2D::Rotate::Rotate

(

unsigned int

order

)

The rotate constructor.

The rotate constructor allocates and initialize the member values to computes spherical harmonics rotation depending on a decomposition order. The order must be at least 1.

Parameters

order

The order.

Definition at line 11 of file Rotate.cpp.

Hoa2D::Rotate::~Rotate

(

)

The Rotate destructor.

The Rotate destructor free the memory.

Definition at line 59 of file Rotate.cpp.

Member Function Documentation

double Hoa2D::Rotate::getYaw ( ) const

inline

Get the angle of the rotation around the z axis, the yaw value.

The method returns the angle of the rotation around the z axis, the yaw value, in radian between 0 and 2π.

Returns

The yaw value.

Definition at line 51 of file Rotate.h.

void Hoa2D::Rotate::process	(	const float *	inputs,
		float *	outputs
	)

This method performs the rotation with single precision.

You should use this method for in-place or not-in-place processing and performs the rotation sample by sample. The inputs array and outputs array contains the spherical harmonics samples and the minimum size must be the number of harmonics.

Parameters

inputs	The input array.
outputs	The output array.

Definition at line 23 of file Rotate.cpp.

void Hoa2D::Rotate::process	(	const double *	inputs,
		double *	outputs
	)

This method performs the rotation with double precision.

You should use this method for in-place or not-in-place processing and performs the rotation sample by sample. The inputs array and outputs array contains the spherical harmonics samples and the minimum size must be the number of harmonics.

Parameters

inputs	The input array.
outputs	The output array.

Definition at line 41 of file Rotate.cpp.

void Hoa2D::Rotate::setYaw

(

const double

value

)

This method sets the angle of the rotation around the z axis, the yaw value,.

The yaw is equivalent to a rotation around the z axis, the value is in radian and should be between 0 and 2π.

Parameters

value

The yaw value.

Definition at line 16 of file Rotate.cpp.