accessors: Access or modify part of an Oce object

Description

Access or modify part of an Oce object

Usage

elevation(x, time)
heading(x, time)
heading(x) <- value
latitude(x, time, byDepth=TRUE)
latitude(x) <- value
longitude(x, time, byDepth=TRUE)
longitude(x) <- value
pitch(x, time)
pitch(x) <- value
pressure(x, time)
pressure(x) <- value
roll(x, time)
roll(x) <- value
salinity(x, time)
salinity(x) <- value
sigmaTheta(x, time)
sigmaTheta(x) <- value
temperature(x, time)
temperature(x) <- value
time(x)
velocity(x)

Arguments

an oce object.

time

optional vector of POSIX times, or object containing times in a field named data$time or data$timeSlow. (If missing, values at all the times in x are returned.)

byDepth

flag usd only for "section" objects, which indicates whether to repeat the latitude or longitude values so that there is a value for each depth in each profile.

value

value to assign to the relevant item in the x object.

Value

Value of indicated portion of x.

Details

These accessor functions provide a convenient way to discover, or set, data within oce objects. This prevents the user from having to know the details of storage, e.g. that Nortek Vector velocimeters record angles on slow timescales compared with velocities (stored in x$data$timeSlow, x$data$headingSlow, etc), whereas Sontek ADV velocimeters record them on the same timescale as velocity (stored in x$data$time, x$data$heading, etc.)

Examples

Run this code

library(oce)
data(adp)
print(heading(adp))
heading(adp) <- 5 + heading(adp) # add 5 degrees to the heading
print(heading(adp))