ProcessEK80

class echopype.process.ProcessEK80(file_path='')

Bases: echopype.process.processbase.ProcessBase

Class for manipulating EK80 echo data already converted to netCDF.

Attributes Summary

ch_ids

tau_effective

Methods Summary

calc_range([range_bins, path])

Calculates range [m] using parameters stored in the .nc file.

calc_sample_thickness([path])

gets sample thickness using parameters stored in the .nc file.

calc_seawater_absorption([src, path])

Returns the seawater absorption

calc_sound_speed([src])

gets sound speed [m/s] using parameters stored in the .nc file.

calc_transmit_signal()

Generate transmit signal as replica for pulse compression.

calibrate([mode, save, save_path, save_postfix])

Perform echo-integration to get volume backscattering strength (Sv) or target strength (TS) from EK80 power data.

calibrate_TS([save, save_path, save_postfix])

Base method to be overridden for target strength calibration and echo-integration for different sonar models.

calibrate_cw([mode, file_path, save, …])

Perform echo-integration to get volume backscattering strength (Sv) from EK80 power data.

get_pressure()

get_salinity()

get_temperature([path])

pulse_compression()

Pulse compression using transmit signal as replica.

Attributes Documentation

ch_ids
tau_effective

Methods Documentation

calc_range(range_bins=None, path='')

Calculates range [m] using parameters stored in the .nc file. Will use a custom path if one is provided

calc_sample_thickness(path='')

gets sample thickness using parameters stored in the .nc file. Will use a custom path if one is provided

calc_seawater_absorption(src='user', path='')

Returns the seawater absorption

Parameters
srcstr

‘file’ will return the seawater absoption recorded in the .nc file ‘user’ will calculate the seawater absorption. Default (Francois and Garrison, 1982).

Returns
Seawater absorption value
calc_sound_speed(src='file')

gets sound speed [m/s] using parameters stored in the .nc file. Will use a custom path if one is provided

calc_transmit_signal()

Generate transmit signal as replica for pulse compression.

calibrate(mode='Sv', save=False, save_path=None, save_postfix=None)

Perform echo-integration to get volume backscattering strength (Sv) or target strength (TS) from EK80 power data.

Parameters
modestr

‘Sv’ for volume backscattering strength calibration (default) ‘TS’ for target strength calibration

savebool, optional

whether to save calibrated output default to False

save_pathstr

Full filename to save to, overwriting the RAWFILENAME_Sv.nc default

save_postfixstr

Filename postfix, default to ‘_Sv’ or ‘_TS’

calibrate_TS(save=False, save_path=None, save_postfix=None)

Base method to be overridden for target strength calibration and echo-integration for different sonar models.

calibrate_cw(mode='Sv', file_path='', save=False, save_path=None, save_postfix=None)

Perform echo-integration to get volume backscattering strength (Sv) from EK80 power data.

Parameters
modestr

‘Sv’ for volume backscattering strength (default) ‘TS’ for target strength

file_pathstr

Path to CW data

savebool, optional

whether to save calibrated Sv output default to False

save_pathstr

Full filename to save to, overwriting the RAWFILENAME_Sv.nc default

save_postfixstr

Filename postfix

get_pressure()
get_salinity()
get_temperature(path='')
pulse_compression()

Pulse compression using transmit signal as replica.