read.adv {oce} | R Documentation |
Read an ADV data file, producing an object of type adv
.
read.adv(file, from=0, to, by=1, type=c("nortek", "sontek", "sontek.adr", "sontek.text"), withHeader=TRUE, sampling.start, deltat, tz=getOption("oce.tz"), debug=getOption("oce.debug"), monitor=TRUE, log.action) read.adv.nortek(file, from=0, to, by=1, type="vector", withHeader=TRUE, sampling.start, deltat, tz=getOption("oce.tz"), debug=getOption("oce.debug"), monitor=TRUE, log.action) read.adv.sontek(file, from=0, to, by=1, type="default", withHeader=TRUE, sampling.start, deltat, tz=getOption("oce.tz"), debug=getOption("oce.debug"), monitor=TRUE, log.action) read.adv.sontek.adr(file, from=0, to, by=1, tz=getOption("oce.tz"), debug=getOption("oce.debug"), monitor=TRUE, log.action) read.adv.sontek.text(basefile, from=0, to, by=1, coordinate.system="xyz", transformation.matrix, tz=getOption("oce.tz"), debug=getOption("oce.debug"), log.action)
file |
a connection or a character string giving the name of the file to load. |
basefile |
character string giving the base name of files to load
(used only by read.adv.sontek.text). The actual filenames are constructed
by appending ".hd1" and ".ts1" to the base name. |
from |
number of profiles to skip at start, or the POSIXt time at
which to start reading. See “Examples”, and make careful
note of the use of the tz argument. (IGNORED AT PRESENT.) |
to |
optional number of profiles to read, or the last POSIXt time to read. (IGNORED AT PRESENT.) |
by |
an indication of the stride length to use while walking
through the file. If this is an integer, then by-1
profiles are skipped between each pair of profiles that is read.
This may not make much sense, if the data are not equi-spaced in
time. If by is a string representing a time interval, in
colon-separated format, then this interval is divided by the
sampling interval, to get the stride length (this does not
work, at present). |
type |
a character string indicating the type of file. |
withHeader |
a boolean indicating whether the file has a proper header or is a partial file, chopped out into smaller time chunks with a deck unit. |
sampling.start |
a POSIXct time corresponding to the first sample.
(This is mandatory if withHeader=FALSE .) |
coordinate.system |
character string indicating coordinate system, one
of "beam" , "xyz" , "enu" or "other" . |
transformation.matrix |
transformation matrix to use, over-riding
anything in the data file e.g. rbind(c(2.710, -1.409, -1.299), c(0.071, 2.372, -2.442), c(0.344, 0.344, 0.344)) .
This is only relevant if the coordinate system is "beam" . |
tz |
character string indicating time zone to be assumed in the data. |
deltat |
the time between samples.
(This is mandatory if withHeader=FALSE .) |
debug |
a flag that turns on debugging. Set to 1 to get a moderate amount of debugging information, or to 2 to get more. |
monitor |
boolean, set to TRUE to provide an indication
(with numbers and dots) of every profile read. |
log.action |
if provided, the action item to be stored in the log. (Typically only provided for internal calls; the default that it provides is better for normal calls by a user.) |
Reads a binary-format ADV file. This is preliminary code, and the function calls could very well change through the summer of 2009.
It is crucial to pay careful attention if withHeader
is
FALSE
, since that condition forces read.adv
to make
guesses about important things. In particular, it will set
metadata$deltat=1
,
metadata$orientation="downward"
and
metadata$oce.coordinate="beam"
. It is up to the user to
modify these values if they are wrong.
Special notes:
Nortek adr files: the file format assumed here is not the same as in the documentation that I have available. The documentation is for Firmware Version 4.0 (October 1997), but this does not match a data file used for testing. The following are the differences:
RecordedData
byte does not agree with the docs (bit 0
is 0 in the file, but we *do* have amplitude and correlation data).
An object of class
"adv"
, which
contains measurements made with an ADV device. For information on
data stored in the object, see “Details”.
Dan Kelley
Objects of class adv
may be plotted with
plot.adv
or summarized with summary.adv
.
Coordinate transformations are done with adv.beam2xyz
,
adv.xyz2enu
, and adv.enu2other
, in
that order.
## Not run: library(oce) adv <- read.adv("~/data/sleiwex-archive/2008/mooring/m6/autopod/day183/SL08A183.015", sampling.start=as.POSIXct("2008-07-01 15:00:00", tz="UTC"), deltat=0.1) summary(adv) plot(adv) ## End(Not run)