R: Class to Store G1SST Satellite-model Data

g1sst-class {oce} | R Documentation

## Class to Store G1SST Satellite-model Data

### Description

This class stores G1SST model-satellite products.

### Details

G1SST is an acronym for global 1-km sea surface temperature, a product that combines satellite data with the model output. It is provided by the JPO ROMS (Regional Ocean Modelling System) modelling group. See the JPL website [1] to learn more about the data, and see the `read.g1sst` documentation for an example of downloading and plotting.

It is important not to regard G1SST data in the same category as, say, `amsr-class` data, because the two products differ greatly with respect to cloud cover. The satellite used by `amsr-class` has the ability to sense water temperature even if there is cloud cover, whereas `g1sst` fills in cloud gaps with model simulations. It can be helpful to consult [1] for a given time, clicking and then unclicking the radio button that turns off the model-based filling of cloud gaps.

### Slots

`data`

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

`metadata`

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

`processingLog`

  As with all `oce` objects, the `processingLog` slot for `g1sst` 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 `g1sst` objects (see `[[<-,g1sst-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 `g1sst` object named `g1sst` may be retrieved in the standard R way. For example, `slot(g1sst, "data")` and `slot(g1sst, "metadata")` return the `data` and `metadata` slots, respectively. The `[[,g1sst-method` operator can also be used to access slots, with `g1sst[["data"]]` and `g1sst[["metadata"]]`, respectively. Furthermore, `[[,g1sst-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

### References

1. JPO OurOcean Portal `https://ourocean.jpl.nasa.gov/SST/` (link worked in 2016 but was seen to fail 2017 Feb 2).

### See Also

Other things related to satellite data: `plot,satellite-method`, `read.g1sst`, `satellite-class`, `summary,satellite-method`

[Package oce version 1.1-1 Index]