SteeringVector¶

class
acoular.fbeamform.
SteeringVector
¶ Bases:
traits.has_traits.HasPrivateTraits
Basic class for implementing steering vectors with monopole source transfer models

mics
= Trait(MicGeom, desc="microphone geometry")¶ MicGeom
object that provides the microphone locations.

steer_type
= Trait('true level', 'true location', 'classic', 'inverse', desc="type of steering vectors used")¶ Type of steering vectors, see also Sarradj, 2012. Defaults to ‘true level’.

env
= Instance(Environment(), Environment)¶ Environment
or derived object, which provides information about the sound propagation in the medium. Defaults to standardEnvironment
object.

ref
= Property(desc="reference position or distance")¶ Reference position or distance at which to evaluate the sound pressure of a grid point. If set to a scalar, this is used as reference distance to the grid points. If set to a vector, this is interpreted as x,y,z coordinates of the reference position. Defaults to [0.,0.,0.].

transfer
(f, ind=None)¶ Calculates the transfer matrix for one frequency.
Parameters:  f : float
Frequency for which to calculate the transfer matrix
 ind : (optional) array of ints
If set, only the transfer function of the gridpoints addressed by the given indices will be calculated. Useful for algorithms like CLEANSC, where not the full transfer matrix is needed
Returns:  array of complex128
array of shape (ngridpts, nmics) containing the transfer matrix for the given frequency

steer_vector
(f, ind=None)¶ Calculates the steering vectors based on the transfer function See also Sarradj, 2012.
Parameters:  f : float
Frequency for which to calculate the transfer matrix
 ind : (optional) array of ints
If set, only the steering vectors of the gridpoints addressed by the given indices will be calculated. Useful for algorithms like CLEANSC, where not the full transfer matrix is needed
Returns:  array of complex128
array of shape (ngridpts, nmics) containing the steering vectors for the given frequency
