as.adp: Create an ADP Object

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/adp.R

Description

Create an ADP Object

Usage

1
2
3
4
5
6
7
8
9
as.adp(
  time,
  distance,
  v,
  a = NULL,
  q = NULL,
  orientation = "upward",
  coordinate = "enu"
)

Arguments

time

of observations in POSIXct format

distance

to centre of bins

v

array of velocities, with first index for time, second for bin number, and third for beam number

a

amplitude, a raw() array with dimensions matching u

q

quality, a raw() array with dimensions matching u

orientation

a string indicating sensor orientation, e.g. "upward" and "downward"

coordinate

a string indicating the coordinate system, "enu", "beam", "xy", or "other"

Details

Construct an adp object. Only a basic subset of the typical data slot is represented in the arguments to this function, on the assumption that typical usage in reading data is to set up a nearly-blank adp object, the data slot of which is then inserted. However, in some testing situations it can be useful to set up artificial adp objects, so the other arguments may be useful.

Value

An adp object.

Author(s)

Dan Kelley

See Also

Other things related to adp data: [[,adp-method, [[<-,adp-method, ad2cpHeaderValue(), adp-class, adpEnsembleAverage(), adp_rdi.000, adp, beamName(), beamToXyzAdpAD2CP(), beamToXyzAdp(), beamToXyzAdv(), beamToXyz(), beamUnspreadAdp(), binmapAdp(), enuToOtherAdp(), enuToOther(), handleFlags,adp-method, is.ad2cp(), plot,adp-method, read.adp.ad2cp(), read.adp.nortek(), read.adp.rdi(), read.adp.sontek.serial(), read.adp.sontek(), read.adp(), read.aquadoppHR(), read.aquadoppProfiler(), read.aquadopp(), rotateAboutZ(), setFlags,adp-method, subset,adp-method, subtractBottomVelocity(), summary,adp-method, toEnuAdp(), toEnu(), velocityStatistics(), xyzToEnuAdpAD2CP(), xyzToEnuAdp(), xyzToEnu()

Examples

1
2
3
4
5
6
7
data(adp)
t <- adp[["time"]]
d <- adp[["distance"]]
v <- adp[["v"]]
a <- as.adp(time=t, distance=d, v=v)

plot(a)

dankelley/oce documentation built on April 8, 2021, 3:47 a.m.