Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Oceans 2.0 API filterdataProductCode=BSTS

Revision History

  • 2011XXXX20110618: Initial data products released in manufacturer DT4 and MATLab mat formats. This initial version is based on Rick Pawlowicz's code, with additions from Asa Parker (BioSonics) and others
  • 20140420: Improved speed

Formats

This data is available in DT4 and MAT formats. Content descriptions and example files are provided below.

...

  • A new DT4 file is started at the beginning of each day (midnight UTC exactly), or when the driver is restarted (this should account for configuration changes, site changes, etc).
  • The instrument date/time field is replaced using the NEPTUNE ONC timestamp at the beginning of the log file (since this timestamp is more accurate than the instrument clock).
  • MAT files are made from DT4 files. MAT files are made on the hour every hour, except when the data is truncated, then small files are created. The date-from and date-to of a DT4 file and the MAT files created from it may not agree if the DT4 file doesn't contain data for it's full time range.
  • Although each channel/frequency pings simultaneously, simultaneous ping packets will have slightly different time stamps, usually separated by 100 milliseconds. This means simultaneous ping packets may end up in different DT4 files if they occur on either side of midnight. The only way to sort this out is to look at the times in the MAT files.

...

A new file is generated each day, and whenever the driver is restarted. The reference time in the time tuple and the ping time in the ping tuples correspond to the times the measurements were received at the NEPTUNE ONC Canada shore station (in place of the internal instrument clock values).

...

Each MAT file contains the following structures: meta, data, units. Entries in italic not applicable to the type of BioSonics Echosounders deployed, but are standard data fields in the DT4 file specification.

meta: structure containing the following metadata fields, generated entirely from NEPTUNE's database.

deviceID: A unique identifier to represent the instrument within the NEPTUNE Canada network.

creationDate:Date and time (using ISO8601 format) that the data product was produced. This is a valuable indicator for comparing to other revisions of the same data product.

deviceName: A name given to the instrument.

deviceCode: A unique string for the instrument which is used to generate data product filenames.

deviceCategory: Device category to list under data search ('Echosounder').

lat: Obtained at time of deployment.

lon: Obtained at time of deployment.

depth: Obtained at time of deployment.

deviceHeading: Obtained at time of deployment.

siteName: Name corresponding to its latitude, longitude, depth position.

locationName: The node of the NEPTUNE Canada observatory. Each location contains many sites.

deploymentDateFrom: The date of the deployment on which the data was acquired

deploymentDateTo: The date of the end of the deployment on which the data was acquired

samplingPeriod: Sampling rate of the instrument in seconds.

searchID: The search ID from the data search details structure used to find this data (not applicable to post-processed MAT files)Image Added

data: structured array containing the BioSonics data (one structure per configuration in cycle), having the following fields which pertain to the dt4 contents (for details, refer to the manufacturer manual).

...

time: datenum vector, UTC timestamp (time source is NEPTUNE Canada ONC shore station)

range: vector of distance to each bin

pingnum: ping number

 

vals: amplitude of return signal (A/D Counts - main data matrix - data type uint32)

nsamps: number of samples in the ping tuples (read from the ping tuple)

Image Added

env: structure containing environmental configuration values

 

 

  • absorb: configuration absorption coefficient (dB/m - specific to each channel/frequency)
  • sv: configuration sound velocity (m/s)
  • temperature: configuration temperature (degrees C)
  • salinity: configuration salinity (ppt)
  • power: transmit power reduction factor
  • numChan: total number of frequencies/channels/configurations in the dt4 file

snd: structure containing details of the channel descriptor tuple

Image Added

  • address: configuration/channel number
  • npings: total number of pings in the dt4
  • npingsExtracted: total number of pings extracted from the dt4
  • sampperping: samples per ping (this is usually equal to max(data.nsamps) )
  • sampperiod: time between successive samples in a ping (microseconds)
  • pingperiod: number of seconds between successive pings
  • pulselen: duration of transmitted pulse (milliseconds)
  • blank: initial blanking (number of samples skipped before data recording begins for each ping)
  • threshold: data collection threshold (dB)
  • rxee: receiver EEPROM image structure (can ignore split-beam options since that feature is not included in this instrument)
  • Image Added
    • ssn: transducer SN
    • calDateNum: last calibration date (Matlab datenum)
    • calDateStr: last calibration date (datestring)
    • calTech: initials of technician performing calibration
    • sl: source level (0.1 dB)
    • rs: receiver sensitivity for main element (0.1 dB)
    • rsw: receiver sensitivity for wide-beam (0.1 dB)
    • pdpy: sign of split beam y-axis (zero=positive, nonzero=negative)
    • pdpx: sign of split beam x-axis (zero=positive, nonzero=negative)
    • noiseFloor: noise floor of transducer (AD Counts) due to system noise
    • transducerType: transducer hardware type (0 for single-beam, 3 for dual-beam, 4 for split-beam)
    • frequency: transducer frequency (Hz)
    • pdy: absolute value of the split-beam y-axis element separation (0.01 mm)
    • pdx: absolute value of the split-beam x-axis element separation (0.01 mm)
    • phpy: split-beam y-axis element polarity
    • phpx: split-beam x-axis element polarity
    • aoy: split-beam y-axis angle offset (0.01 degrees)
    • aox: split-beam x-axis angle offset (0.01 degrees)
    • bwy: y-axis -3dB one-way beam width for the main element (0.1 degrees)
    • bwx: x-axis -3dB one-way beam width for the main element (0.1 degrees)
    • sampleRate: sampling rate of the A/D converter (Hz), usually 41667.
    • bwwwy: y-axis -3dB one-way beam width for wide-beam or phase elements (0.1 degrees)
    • bwwx: x-axis -3dB one-way beam width for wide-beam or phase elements (0.1 degrees)
    • phy: split-beam y-axis phase aperture (0.1 degrees)
    • phx: split-beam x-axis phase aperture (0.1 degrees)
  • ccor: calibration correction

...

units: structure containing unit of measure for fields in structures above. For instance, units.lat='degrees N'.

Include Page
MAT file Metadata structure - Complex
MAT file Metadata structure - Complex

Oceans 2.0 API filterextension=mat

...