hydrac.instruments.adcp

Adcp instruments (hydrac.instruments.adcp)

class hydrac.instruments.adcp.Adcp(name)

Bases: hydrac.instruments.acoustique.Acoustic

Adcp instruments class

Base class : hydrac.instruments.acoustique.Acoustic

The ADCP is a single frequency Doppler velocity profiler. It measures the Doppler phase shifts induced by the moving targets (suspended particles) in the water column. As well as measuring the multi-component velocity, it is also capable of recording the backscattered intensity, which itself is of interest in hydrac.

The Adcp class reads the raw binary files from ADCPs instruments and stores the valuable information into the param modified dictionnary with the common shape handled by hydrac (see hydrac.instruments.acoustique).

The way the data are to be considered is similar to the example shown in hydrac.instruments.aquascat.

Parameters:

name : str, {‘Campaign_1’}

Tag name, for personal usage, for instance to add a campaign name.

_set_calib_adcp(self)

Calibration coefficients for each transducer are unique to each transducer. As such, each instrument comes with a different set of calibration coefficients Kt. Those are stored in xml file generated (if non-existant) or updated (with _update_calib_aqa()) with the instrument serial number and the Kts. This xml is accessed/generated through the class hydrac.util.paramcontainer.ParamContainer.

_update_calib_adcp(self, a, b=None, remove_elem=False)

Update the calibration xml file either by adding a new instrument or deleting the coefficients of a particular instrument. This xml is accessed/generated through the class hydrac.util.paramcontainer.ParamContainer.

Parameters:

a : str

Instrument serial number read from binary files and stored in param

b=None : dict

Contains the calibration coefficients, prompted by the user if the instrument is used for the first time in hydrac.

remove_elem=False : bool

Removes the information relative to the serial number a in the xml.

file_select(self)

User input selection of the target files to read

param_shape_ADCP(self, inp)

Reshapes the modified dictionnary param to fit the standard key names and data shape used throughout hydrac

load_ADCP(self)

Launch decryption of the target files - Two possibilities given the file extension : ReadAdcpA (standard format) or ReadAdcpP (standard + GPS tracking

class hydrac.instruments.adcp.ReadAdcpA(obj)

Bases: object

Reads standard RDI fileformat.

Parameters:

obj : Adcp object hydrac.instruments.ascp.Adcp

class hydrac.instruments.adcp.ReadAdcpP(obj)

Bases: object

Reads -p RDI fileformat meant for en route acquisition.

Parameters:

obj : Adcp object hydrac.instruments.ascp.Adcp

Classes

Adcp(name)	Adcp instruments class
ReadAdcpA(obj)	Reads standard RDI fileformat.
ReadAdcpP(obj)	Reads -p RDI fileformat meant for en route acquisition.

Exceptions

WrongFileTypeError