Acoular 16.5 documentation

BeamformerOrth

«  BeamformerDamas   ::   fbeamform   ::   BeamformerCleansc  »

BeamformerOrth

class acoular.fbeamform.BeamformerOrth

Bases: acoular.fbeamform.BeamformerBase

Orthogonal beamforming, see Sarradj, 2010. Needs a-priori beamforming with eigenvalue decomposition (BeamformerEig).

beamformer = Trait(BeamformerEig)

BeamformerEig object that provides data for deconvolution.

freq_data = Delegate('beamformer')

EigSpectra object that provides the cross spectral matrix and eigenvalues, is set automatically.

grid = Delegate('beamformer')

Grid-derived object that provides the grid locations, is set automatically.

mpos = Delegate('beamformer')

MicGeom object that provides the microphone locations, is set automatically.

c = Delegate('beamformer')

Speed of sound, is set automatically.

r_diag = Delegate('beamformer')

Flag, if ‘True’ (default), the main diagonal is removed before beamforming, is set automatically.

steer = Delegate('beamformer')

Type of steering vectors, is set automatically.

eva_list = CArray( desc="components")

List of components to consider, use this to directly set the eigenvalues used in the beamformer. Alternatively, set n.

n = Int(1)

Number of components to consider, defaults to 1. If set, eva_list will contain the indices of the n largest eigenvalues. Setting eva_list afterwards will override this value.

set_eva_list()

sets the list of eigenvalues to consider

calc(ac, fr)

Calculates the Orthogonal Beamforming result for the frequencies defined by freq_data.

This is an internal helper function that is automatically called when accessing the beamformer’s result or calling its synthetic() method.

Parameters:

ac : array of floats

This array of dimension ([number of frequencies]x[number of gridpoints]) is used as call-by-reference parameter and contains the calculated value after calling this method.

fr : array of booleans

The entries of this [number of frequencies]-sized array are either ‘True’ (if the result for this frequency has already been calculated) or ‘False’ (for the frequencies where the result has yet to be calculated). After the calculation at a certain frequency the value will be set to ‘True’

Returns:

This method only returns values through the ac and fr parameters

«  BeamformerDamas   ::   fbeamform   ::   BeamformerCleansc  »