R: Class to Hold adv Data

adv-class {oce} | R Documentation

## Class to Hold adv Data

### Description

This class holds data from acoustic-Dopper velocimeters.

### Details

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 and the second 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. 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.

Data may be extracted with `[[,adv-method` and inserted with `[[<-,adv-method`. Type `?"[[,adv-method"` or `?"[[<-,adv-method"` to learn more.

### See Also

A file containing ADV data is usually recognized by Oce, and so `read.oce` will usually read the data. If not, one may use the general ADV function `read.adv` or specialized variants `read.adv.nortek`, `read.adv.sontek.adr` or `read.adv.sontek.text`.

ADV data may be plotted with `plot,adv-method` function, which is a generic function so it may be called simply as `plot(x)`, where `x` is an object inheriting from `adv-class`.

Statistical summaries of ADV data are provided by the generic function `summary,adv-method`.

Conversion from beam to xyz coordinates may be done with `beamToXyzAdv`, and from xyz to enu (east north up) may be done with `xyzToEnuAdv`. `toEnuAdv` 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 `enuToOtherAdv`.

Other classes provided by `oce`: `adp-class`, `argo-class`, `bremen-class`, `cm-class`, `coastline-class`, `ctd-class`, `echosounder-class`, `lisst-class`, `lobo-class`, `met-class`, `oce-class`, `odf-class`, `rsk-class`, `sealevel-class`, `section-class`, `topo-class`, `windrose-class`

Other things related to `adv` data: `[[,adv-method`, `[[<-,adv-method`, `adv`, `beamName`, `beamToXyz`, `enuToOtherAdv`, `enuToOther`, `plot,adv-method`, `read.adv.nortek`, `read.adv.sontek.adr`, `read.adv.sontek.serial`, `read.adv.sontek.text`, `read.adv`, `subset,adv-method`, `summary,adv-method`, `toEnuAdv`, `toEnu`, `velocityStatistics`, `xyzToEnuAdv`, `xyzToEnu`

### Examples

    data(adv)
    adv[["v"]] <- 0.001 + adv[["v"]] # add 1mm/s to all velocity components

[Package oce version 0.9-20 Index]