sal::CircularArray< T > Class Template Reference

#include <microphonearray.h>

Inheritance diagram for sal::CircularArray< T >:

Public Member Functions
	CircularArray (const mcl::Point &position, const mcl::Quaternion &orientation, const T &mic_prototype, const Length radius, const std::vector< Angle > &angles)
virtual void	SetOrientation (const mcl::Quaternion &orientation) noexcept
Public Member Functions inherited from sal::UniformArray< T >
	UniformArray (const mcl::Point &position, const mcl::Quaternion &orientation, const T &mic_prototype, const mcl::Int num_microphones)
virtual	~UniformArray ()
Public Member Functions inherited from sal::MicrophoneArray
	MicrophoneArray (const mcl::Point &position, const mcl::Quaternion &orientation, const std::vector< Microphone * > &microphones)
virtual void	SetPosition (const mcl::Point &position) noexcept
bool	IsCoincident () const noexcept
Int	num_channels () const noexcept
const Microphone *	GetConstMicrophonePointer (const Int microphone_id) const noexcept
Microphone *	GetMicrophonePointer (const Int microphone_id) noexcept
std::vector< Microphone * >	GetMicrophonePointers () const noexcept
std::vector< const Microphone * >	GetConstMicrophonePointers () const noexcept
Int	num_microphones () const noexcept
virtual	~MicrophoneArray ()
virtual void	AddPlaneWave (const Sample *input_data, const Int num_samples, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
virtual void	AddPlaneWaveRelative (const Sample *input_data, const Int num_samples, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
Public Member Functions inherited from sal::Microphone
	Microphone (mcl::Point position, mcl::Quaternion orientation=mcl::Quaternion::Identity())
mcl::Point	position () const noexcept
mcl::Quaternion	orientation () const noexcept
void	SetHandedness (const mcl::Handedness handedness) noexcept
void	AddPlaneWave (const MonoBuffer &signal, const mcl::Point &point, Buffer &output_buffer) noexcept
void	AddPlaneWave (const Sample *input_data, const Int num_samples, const mcl::Point &point, Buffer &output_buffer) noexcept
void	AddPlaneWave (const Sample input_sample, const mcl::Point &point, Buffer &output_buffer) noexcept
void	AddPlaneWave (const MonoBuffer &input_buffer, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
void	AddPlaneWave (const Sample input_sample, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
virtual bool	IsOmni () const noexcept
mcl::Point	GetRelativePoint (const mcl::Point &point) const noexcept
virtual void	Reset () noexcept
virtual	~Microphone ()
virtual void	AddPlaneWaveRelative (const MonoBuffer &signal, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept

Additional Inherited Members
Static Public Member Functions inherited from sal::MicrophoneArray
static bool	Test ()
Protected Attributes inherited from sal::MicrophoneArray
std::vector< Microphone * >	microphones_

Detailed Description

template<class T>
class sal::CircularArray< T >

This generates a microphone array centered in position, with radius radius, num_microphones is the number of microphones, first_element_heading is the heading of first microphone - e.g. first_element_heading=0, means that the first microphone is at (position.x() + radius, position.y(), position.z()).

Constructor & Destructor Documentation

template<class T >

sal::CircularArray< T >::CircularArray ( const mcl::Point &  position, const mcl::Quaternion &  orientation, const T &  mic_prototype, const Length  radius, const std::vector< Angle > &  angles  )

inline

Member Function Documentation

template<class T >

virtual void sal::CircularArray< T >::SetOrientation ( const mcl::Quaternion &  orientation )

inlinevirtualnoexcept

Set microphone orientation

Reimplemented from sal::MicrophoneArray.

---

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

• sal/include/microphonearray.h