Field-class: Field-class contains data

In MagicForrest/DGVMTools: DGVM Processing, Analysis and Plotting Tools

Field-class contains data

Description

Field is a key class of the package as it actually holds the data (most other classes are for metadata). A Field stores the data and metadata for one quantity that comes from a dataset or vegetation model run (including information about the run itself). For example LAI (Leaf Area Index), or evapotranspiration. The data can be aggregated across space, and across and within years, and manipulated and plotted by many functions in this package.

Details

Generally these are not created directly by the user, but rather by functions like getField.

Slots

id

A unique character string to identify this particular vegetation object. Recommended to be alphanumeric because it is used to construct file names.

data

A data.table object. This is used because is it very much faster for calculations that data.frame or raster layers.

quant

A Quantity object to define what output this Field contains

first.year

The first year of data

last.year

The last year of data

year.aggregate.method

A character string describing the method by which the years have been aggregated. Will be the zero character ("character(0)") if data it not yearly aggregated

spatial.extent

An object which can be used to crop or select gridcells. Can be anything from which a raster::extent can be derived (in which case raster::crop is used) or a list of gridcells used by selectGridcells (see that documentation for how to format the gridcell list).

spatial.extent.id

A character id to handily record this spatial domain if some spatial subselection has been called, for example "Europe" or "Duke_Forest" or whatever

spatial.aggregate.method

Set to TRUE is this.Field has been spatially averaged

subannual.aggregate.method

Method by which this Field has been subannually aggregated

subannual.original

Original subannual resolution of this field

source

A Source object which contains the metadata about the run which this Field belongs too.

Author(s)

Matthew Forrest [e-mail]

MagicForrest/DGVMTools documentation built on Aug. 23, 2024, 8:05 a.m.