oce (version 0.8-6)

adp-class: Class to store acoustic Doppler profiler data

Description

Class to store acoustic Doppler profiler data, holding the three standard slots used in all objects in Oce. The metadata slot contains various items relating to the dataset, including source file name, sampling rate, velocity resolution and scale, etc. The processingLog is in standard form and needs little comment. The data slot holds a numeric matrix v of velocities in m/s, with the first index indicating time, the second indicating bin number, and the third indicating beam number. The meanings of the beams depends on whether the object is in beam coordinates, frame coordinates, or earth coordinates. The data slot also contains identically-dimensioned raw matrices a and q, holding measures of signal strength and data quality quality, respectively. It also contains a series of vectors, e.g. time, temperature and pressure, etc., depending on what sensors are included in the package. Finally, there is a vector distance that indicates the bin locations. For all of these quantities, the details can be different for different instrument types, and it is assumed that the user will be familiar with the details.

Methods

Extracting values{Matrix data may be accessed as e.g. for an adv object named d, the data are provided by d[["v"]], d[["a"]], and d[["q"]]. As a convenience, the last two of these can be accessed as numeric (as opposed to raw) values by e.g. d[["a", "numeric"]]. The vectors are accessed in a similar way, e.g. d[["heading"]], etc. Quantities in the metadata slot are also available by name, e.g. d[["velocityResolution"]], etc.}

Assigning values{This follows the standard form, e.g. to increase all velocity data by 1 cm/s, use d[["v"]] <- 0.01 + d[["v"]].}

Overview of contents{The show method (e.g. show(d)) displays information about an ADV object named d.}

See Also

A file containing ADP data is usually recognized by Oce, and so read.oce will usually read the data. If not, one may use the general ADP function read.adp or specialized variants read.adp.rdi, read.adp.nortek or read.adp.sontek or read.adp.sontek.serial.

ADV data may be plotted with plot.adp function, which is a generic function so it may be called simply as plot.

Statistical summaries of ADV data are provided by the generic function summary, while briefer overviews are provided with show.

Conversion from beam to xyz coordinates may be done with beamToXyzAdp, and from xyz to enu (east north up) may be done with xyzToEnuAdp. toEnuAdp may be used to transfer either beam or xyz to enu. Enu may be converted to other coordinates (e.g. aligned with a coastline) with enuToOtherAdp.