Acoular 24.03 documentation

BeamformerOrth

«  BeamformerDamasPlus   ::   fbeamform   ::   BeamformerCleansc  »

BeamformerOrth

class acoular.fbeamform.BeamformerOrth

Bases: BeamformerBase

Orthogonal deconvolution, see Sarradj, 2010. New faster implementation without explicit (BeamformerEig).

beamformer = Trait(BeamformerEig)

(only for backward compatibility) BeamformerEig object if set, provides freq_data, steer, r_diag if not set, these have to be set explicitly

eva_list = CArray(dtype=int,

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:
acarray 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.

frarray 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

«  BeamformerDamasPlus   ::   fbeamform   ::   BeamformerCleansc  »