satin-class: Class "satin"

In satin: Visualisation and Analysis of Ocean Data Derived from Satellites

Class "satin"

Description

class for ocean data derived from satellites, imported from netCDF files.

Objects from the Class

Objects of class "satin" are created by importing functions: read.nasaoc, read.ghrsst, read.cmems, and read.osunpp. They can also be created, though not recommended, by direct calls to satin.

Slots

lon

Object of class "numeric"; vector of longitudes of the area of interest (aoi).

lat

Object of class "numeric"; vector of latitudes of the aoi.

data

Object of class "array"; three or four dimensions array of ocean data corresponding to the lengths of lat, lon, period$tmStart, and depth vectors. The fourth dimension associated to depth levels will only be present in "satin" objects derived from Copernicus data files.

attribs

Object of class "list"; attributes of the data stored in the netCDF file: title: title attribute from netCDF file; longname: long name of ocean data variable; name: short name of ocean data variable; units: ocean data variable measurement units; temporal_range: averaging period length, i.e. daily, monthly, etc.; spatial_resolution: spatial resolution of the ocean data variable.

period

Object of class "list"; a vector with start time (tmStart) and a vector with end time (tmEnd) of the averaging period of the data. Both vectors are of class "POSIXct".

depth

Object of class "numeric"; vector of depth levels in the data. Only meaningful for "satin" objects derived from Copernicus data files.

Methods

plot

signature(x = "satin", y = "missing"): plot method for "satin" objects. See details in plot.satin

show

signature(object = "satin"): display a summary of the object. See example below

Author(s)

Héctor Villalobos

See Also

See read.nasaoc; read.osunpp; read.ghrsst; and read.cmems for functions producing "satin" objects, and plot.satin for a complete description of plotting arguments.

Examples

data(dsst)
class(dsst)
dsst
str(dsst)

satin documentation built on Sept. 23, 2022, 1:06 a.m.