ConvertAZFP

class echopype.convert.ConvertAZFP(_filename='', _xml_path='')

Bases: echopype.convert.convertbase.ConvertBase

Class for converting AZFP .01A files.

Methods Summary

calc_Sv_offset(f, pulse_length)	Calculate a compensation for the effects of finite response times of both the receiving and transmitting parts of the transducer.
check_uniqueness()	Check for ping-by-ping consistency of sampling parameters and reduce if identical.
get_fields()	Returns the fields contained in each header of the raw file.
get_ping_time()	Returns the ping times
loadAZFPxml()	Parses the AZFP XML file.
parse_raw(raw)	Parses a raw AZFP file of the 01A file format
save(file_format[, save_path, combine_opt, …])	Save data from raw 01A format to a netCDF4 or Zarr file

Methods Documentation

calc_Sv_offset(f, pulse_length)

Calculate a compensation for the effects of finite response times of both the receiving and transmitting parts of the transducer. The correction magnitude depends on the length of the transmitted pulse and the response time (transmission and reception) of the transducer. The numbers used below are documented on p.91 in GU-100-AZFP-01-R50 Operator’s Manual. This subfunction is called by _set_beam_dict().

Parameters

f

frequency in Hz

pulse_length

pulse length in ms

check_uniqueness()

Check for ping-by-ping consistency of sampling parameters and reduce if identical.

Those included in this function should be identical throughout all pings. Therefore raise error if not identical.

static get_fields()

Returns the fields contained in each header of the raw file.

get_ping_time()

Returns the ping times

loadAZFPxml()

Parses the AZFP XML file.

parse_raw(raw)

Parses a raw AZFP file of the 01A file format

Parameters

rawlist

raw filename

save(file_format, save_path=None, combine_opt=False, overwrite=False, compress=True)

Save data from raw 01A format to a netCDF4 or Zarr file

Parameters

file_formatstr

format of output file. “.nc” for netCDF4 or “.zarr” for Zarr

save_pathstr

Path to save output to. Must be a directory if converting multiple files. Must be a filename if combining multiple files. If False, outputs in the same location as the input raw file.

combine_optbool

Whether or not to combine a list of input raw files. Raises error if combine_opt is true and there is only one file being converted.

overwritebool

Whether or not to overwrite the file if the output path already exists.

compressbool

Whether or not to compress backscatter data. Defaults to True