BeamformerCleantSq¶

class acoular.tbeamform.BeamformerCleantSq¶

Bases: BeamformerCleant

CLEANT deconvolution method with optional removal of autocorrelation.

An implementation of the CLEAN method in time domain. This class can only be used for static sources. See [20] for details on the method and [21] for details on the autocorrelation removal.

r_diag = Bool(True, desc='removal of diagonal')¶

Boolean flag, if ‘True’ (default), the main diagonal is removed before beamforming.

result(num=2048)¶

Python generator that yields the squared deconvolved time-domain beamformer output.

The output starts for signals that were emitted from the Grid at t=0. Per default, block-wise removal of autocorrelation is performed, which can be turned of by setting r_diag to False.

Parameters:

numint

This parameter defines the size of the blocks to be yielded (i.e. the number of samples per block). Defaults to 2048.

Yields:

numpy.ndarray

Samples in blocks of shape (num, num_channels).

num_channels is usually very large (number of grid points). The last block returned by the generator may be shorter than num.