Learn R Programming
oce (version 0.8-2)

beamToXyz: Convert ADV or ADP data between various coordinate systems

Description

Convert velocity data from an acoustic-doppler velocimeter or acoustic-doppler profiler from one coordinate system to another.

Usage

beamToXyz(x, ...)
xyzToEnu(x, ...)
enuToOther(x, ...)
toEnu(x, ...)

Arguments

x
an object of class "adv" or "adp".
...
extra arguments that are passed on to the called function.

Value

  • An object of the same type as x, but with x@data$v converted from beam coordinates to xyz coordinates, and with x@metadata$oceCoordinate changed from "beam" to "xyz".

Details

Each of these functions checks the type of object, and calls the corresponding function, as appropriate. For example, beamToXyz calls beamToXyzAdp for an object that inhertis from "adp" or beamToXyzAdv for an object that inhertis from "adv".

See Also

The real work is done with specialized routines, beamToXyzAdp, beamToXyzAdv, xyzToEnuAdp, xyzToEnuAdv, enuToOtherAdp, enuToOtherAdv, toEnuAdp, and toEnuAdv.