acoular / acoular

Acoular - Acoustic testing and source mapping software
https://www.acoular.org
BSD 3-Clause "New" or "Revised" License
471 stars 126 forks source link

New Beamformer-class function "condense" for replacing/enhancing synthetic+integrate? #175

Closed gherold closed 3 months ago

gherold commented 6 months ago

Suggestion to add a new function in the BeamformerBase function that comprises the functionality of both ".synthetic" and ".integrate". Purpose is to compress the result data and extract the actually interesting info (e.g. third-octave bands in defined sectors).

Most of the arguments passed to the function should be optional, so that it can be used more or less in the same way as .synthetic or .integrate alone. This would also make using the corresponding standalone functions after first applying .synthetic or .integrate unnecessary.

Important differences to the old functions are

The implementation of this could include a deprecation warning for .synthetic and .integrate

Any thoughts or naming ideas? (condense/compress/extract ... )

esarradj commented 6 months ago

We could implement a private helper synthetic + integrate = condense function. In addition, we alter the interface of the existing functions

def synthetic( self, f, num=0, sector=None):

def integrate( self, sector, f=0, num=0):

gherold commented 6 months ago

This could work as well.