echosounder-class {oce}R Documentation

Class to Store Echosounder Data

Description

This class stores echosounder data. Echosounder objects may be read with read.echosounder, summarized with summary,echosounder-method, and plotted with plot,echosounder-method. The findBottom function infers the ocean bottom from tracing the strongest reflector from ping to ping.

Details

Slots

data

As with all oce objects, the data slot for echosounder objects is a list containing the main data for the object.

metadata

As with all oce objects, the metadata slot for echosounder objects is a list containing information about the data or about the object itself.

processingLog

As with all oce objects, the processingLog slot for echosounder objects is a list with entries describing the creation and evolution of the object. The contents are updated by various oce functions to keep a record of processing steps. Object summaries and processingLogShow both display the log.

Modifying slot contents

Although the [[<- operator may permit modification of the contents of echosounder objects (see [[<-,echosounder-method), it is better to use oceSetData and oceSetMetadata, because that will save an entry in the processingLog to describe the change.

Retrieving slot contents

The full contents of the data and metadata slots of a echosounder object named echosounder may be retrieved in the standard R way. For example, slot(echosounder, "data") and slot(echosounder, "metadata") return the data and metadata slots, respectively. The [[,echosounder-method operator can also be used to access slots, with echosounder[["data"]] and echosounder[["metadata"]], respectively. Furthermore, [[,echosounder-method can be used to retrieve named items (and potentially some derived items) within the metadata and data slots, the former taking precedence over the latter in the lookup. It is also possible to find items more directly, using oceGetData and oceGetMetadata, but this cannot retrieve derived items.

Author(s)

Dan Kelley

See Also

Other things related to echosounder data: [[,echosounder-method, [[<-,echosounder-method, as.echosounder, echosounder, findBottom, plot,echosounder-method, read.echosounder, subset,echosounder-method, summary,echosounder-method


[Package oce version 1.0-1 Index]