mask_attenuated_signal

echopype.clean.mask_attenuated_signal(ds_Sv: Dataset, upper_limit_sl: str = '400.0m', lower_limit_sl: str = '500.0m', num_side_pings: int = 15, attenuation_signal_threshold: str = '8.0dB', range_var: str = 'depth') → DataArray

Locate attenuated signals and create an attenuated signal mask.

Parameters

ds_Svxarray.Dataset

Calibrated Sv data with depth data variable.

upper_limit_slstr, default “400m”

Upper limit of deep scattering layer line (m).

lower_limit_slstr, default “500m”

Lower limit of deep scattering layer line (m).

num_side_pingsint, default 15

Number of preceding & subsequent pings defining the block.

attenuation_signal_thresholdstr, default “8.0dB”

Attenuation signal threshold value (dB) for the ping-block comparison.

range_varstr, default “depth”

Vertical Axis Range Variable. Can be either depth or echo_range.

Returns

xr.Dataset

Xarray boolean array attenuated signal mask.

References

This function’s implementation is based on the following text reference:

Ryan et al. (2015) Reducing bias due to noise and attenuation in open-ocean echo integration data, ICES Journal of Marine Science, 72: 2482–2493.

Additionally, code was derived from echopy’s numpy single-channel implementation of attenuation signal masking and translated into xarray code: open-ocean-sounding/echopy # noqa