Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Teledyne RDI supported instruments
This page lists the Teledyne RDI instrument Models which are supported by the toolbox, and the data formats required for each of them. If you have some data from an unsupported instrument or format, submit an issue with details and files examples, and I'll look into adding support for this new instrument/format.
The toolbox is able to parse current and wave data files retrieved from a Teledyne RDI Workhorse ADCP instrument using the workhorse parser.
IMPORTANT: The heading bias information accounting for electrical/magnetic bias (usually magnetic declination) found in the PD0 file Fixed Leader Data (see Current data below) and set up by a technician prior to the deployment or during post-processing with RDI's softwares is taken into account to decide whether the current and wave data is referring to magnetic North (heading bias is found to be 0) or true North (heading bias is found to be different from 0).
IMPORTANT: LSB bit 7 from the system configuration field in the fixed leader data format of a PD0 file is taken into account to tell whether the ADCP is upward or downward looking.
Current data raw files are read in the PD0 format (see the Workhorse H-ADCP Operation manual for a description of the format as it stands at November 2007). As the toolbox works from raw binary files, pre-processing with RDI software is not required.
A raw Workhorse current data file consists of a set of 'ensembles'. Each ensemble contains data for one sample period. An ensemble is made up of a number of sections, the last five of which may or may not be present:
- Header: Ensemble information (size/contents). Always present
- Fixed Leader Data: ADCP configuration, serial number etc. Always present
- Variable Leader Data: Time, temperature, salinity etc. Always present.
- Velocity: Current velocities for each depth (a.k.a 'bins' or 'cells').
- Correlation Magnitude: 'Magnitude of the normalized echo autocorrelation at the lag used for estimating the Doppler phase change'. This information is not vertically bin-mapped.
- Echo Intensity: Echo intensity data. This information is not vertically bin-mapped.
- Percent Good: Percentage of good data for each depth cell.
- Bottom Track Data: Bottom track data.
The toolbox reads in all of the ensembles and extracts the following:
- Temperature (at each time)
- Pressure (at each time, if present)
- Salinity (at each time, if present)
- Northward velocity (at each time and depth)
- Eastward velocity (at each time and depth)
- Water speed (at each time and depth, derived from northward/eastward velocities)
- Water direction (at each time and depth, derived from northward/eastward velocities)
- Acoustic backscatter intensity (at each time and depth, a separate variable for each beam, this information is not vertically bin-mapped)
- Particle distribution correlation magnitude (at each time and depth, a separate variable for each beam, this information is not vertically bin-mapped)
- Percentage of good three beam solutions (at each time and depth)
- Percentage of good transformations (at each time and depth)
- Percentage of measurements with more than one beam bad (at each time and depth)
- Percentage of measurements with four beam solutions (at each time and depth)
- Pitch (at each time, if present)
- Roll (at each time, if present)
- Heading (at each time, if present)
- Transmit voltage (at each time, if present)
The conversion from the ADCP velocity values currently assumes that the ADCP is using earth coordinates (see section 13.4 'Velocity Data Format' of the Workhorse H-ADCP Operation Manual).
Wave data raw files in the WVS format is not supported since there is no specifiation available for this binary format. However, it is possible to re-play a .WVS datset with RDIs WavesMon software and then output the wave data in ASCII files that are documented (see the WavesMon user's guide for a description of the formats as they stand at November 2011). In the deployment database, the toolbox looks for the PD0 file to read current data but then if a .WVS file with the same name exists in the same folder, then relevant wave data ASCII log9 and spectra files (
VSpec*.txt) files are looked for and read. The toolbox assumes there is only one set of .PD0, .WVS, .LOG9 and spectra files in the same folder.
A Workhorse set of wave data file consists in 5 files:
*_LOG9.txt: Includes time and ADCP's depth and many wave parameters such as significant wave height, peak wave period, peak wave direction (the laters also distinctively for wind and swell wave), maximum wave height, maximum peak wave period, mean wave direction, etc...
DSpecyyyymmddHHMM.txt: Includes the wave directional energy spectra at the time yyyymmddHHMM in the file's name and by default based on orbital velocity measurements.
VSpecyyyymmddHHMM.txt: Includes the wave non-directional energy spectra at the time yyyymmddHHMM in the file's name and based on orbital velocity measurements.
PSpecyyyymmddHHMM.txt: Includes the wave non-directional energy spectra at the time yyyymmddHHMM in the file's name and based on pressure measurements.
SSpecyyyymmddHHMM.txt: Includes the wave non-directional energy spectra at the time yyyymmddHHMM in the file's name and based on surface tracking measurements.