The [[ method works for all oce objects, i.e.
objects inheriting from oce-class. The purpose
is to insulate users from the internal details of oce
objects, by looking for items within the various storage
slots of the object. Items not actually stored can also be
extracted, including derived data, units of measurement,
and data-quality flags.
# S4 method for adp
[[(x, i, j, ...)An adp object, i.e. one inheriting from adp-class.
Character string indicating the name of item to extract.
Optional additional information on the i item.
Optional additional information (ignored).
If the specialized method produces no matches, the following generalized
method is applied. As with the specialized method, the procedure hinges
first on the value of i.
First, a check is made as to whether i names one of the standard
oce slots, and returns the slot contents if so. Thus,
x[["metadata"]] will retrieve the metadata slot,
while x[["data"]] and x[["processingLog"]] return
those slots.
Next, if i is a string ending in the
"Unit", then the characters preceding that string
are taken to be the name of an item in the data object, and a list
containing the unit is returned. This list consists of an item
named unit, which is an expression, and
an item named scale, which is a string describing the
measurement scale. If the string ends in " unit", e.g.
x[["temperature unit"]], then just the expression is returned,
and if it ends in " scale", then just the scale is returned.
Next, if i is a string ending in "Flag", then the corresponding
data-quality flag is returned (or NULL if there is no such flag).
For example, x[["salinityFlag"]] returns a vector of salinity
flags if x is a ctd object.
If none of the preceding conditions are met, a check is done
to see if the metadata slot contains an item with
the provided name, and that is returned, if so. A direct match
is required for this condition.
Finally, the data slot is checked to see if it contains
an item with the name indicated by i. In this case, a partial
match will work; this is accomplished by using pmatch.
If none of the above-listed conditions holds, then NULL is returned.
In addition to the usual extraction of elements by name, some shortcuts
are also provided, e.g. x[["u1"]] retrieves v[,1], and similarly
for the other velocity components. The a and q
data can be retrieved in raw form or numeric
form (see examples). The coordinate system may be
retrieved with e.g. x[["coordinate"]].
A two-step process is used to try to find the
requested information. First, a class-specific function
tries to find it (see
“Details of the specialized ... method”), but
if that fails, then a general function is used
(see ‘Details of the general method’). If both
fail, NULL is returned.
Other functions that extract parts of oce objects: [[,adv-method,
[[,amsr-method,
[[,argo-method,
[[,bremen-method,
[[,cm-method,
[[,coastline-method,
[[,ctd-method,
[[,echosounder-method,
[[,g1sst-method,
[[,gps-method,
[[,ladp-method,
[[,landsat-method,
[[,lisst-method,
[[,lobo-method,
[[,met-method, [[,odf-method,
[[,rsk-method,
[[,sealevel-method,
[[,section-method,
[[,tidem-method,
[[,topo-method,
[[,windrose-method,
[[<-,adv-method
Other things related to adp data: [[<-,adp-method,
adp-class,
adpEnsembleAverage, adp,
as.adp, beamName,
beamToXyzAdp, beamToXyzAdv,
beamToXyz, beamUnspreadAdp,
binmapAdp, enuToOtherAdp,
enuToOther,
handleFlags,adp-method,
plot,adp-method, read.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,
summary,adp-method, toEnuAdp,
toEnu, velocityStatistics,
xyzToEnuAdp, xyzToEnu
# NOT RUN {
data(adp)
# Tests for beam 1, distance bin 1, first 5 observation times
adp[["v"]][1:5,1,1]
adp[["a"]][1:5,1,1]
adp[["a", "numeric"]][1:5,1,1]
as.numeric(adp[["a"]][1:5,1,1]) # same as above
# }
Run the code above in your browser using DataLab