LPJmLGridData: LPJmL grid data class
In lpjmlkit: Toolkit for Basic LPJmL Handling
LPJmLGridData R Documentation
LPJmL grid data class
Description
A dedicated data class for an LPJmL input or output grid.
LPJmLGridData serves the spatial reference for any LPJmLData objects and
matches its spatial dimensions ("cell" or "lon", "lat") when attached as an
grid attribute to it.\
LPJmLGridData holds the information which longitude and latitude correspond
to each cell center assuming WGS84 as the coordinate reference system or
the corresponding cell index when the data comes with longitude and latitude
dimension.
As in LPJmLData the data array can be accessed via $data,
the meta data via $meta.
Super class
lpjmlkit::LPJmLData -> LPJmLGridData
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
Inherited methods
Method add_grid()
! Not allowed to add a grid to an LPJmLGridData object.
Usage
LPJmLGridData$add_grid(...)
Arguments
...See add_grid().
Method subset()
! Not allowed to use dimension names of LPJmLGridData$data
array directly to subset each dimension to match the supplied vectors.
Usage
LPJmLGridData$subset(...)
Arguments
...See subset.LPJmLData()
Method transform()
! Not allowed to transform inner LPJmLGridData$data array
into another space or time format.
Usage
LPJmLGridData$transform(...)
Arguments
...See transform().
Method as_raster()
! Not allowed to coerce (convert) an LPJmLGridData object into a
raster or brick object.
Usage
LPJmLGridData$as_raster(...)
Arguments
...See as_raster().
Method as_terra()
! Not allowed to coerce (convert) an LPJmLGridData object into a
rast object.
Usage
LPJmLGridData$as_terra(...)
Arguments
...See as_terra().
Method .__subset_space__()
! Internal method only to be used for package development.
Usage
LPJmLGridData$.__subset_space__(...)
Arguments
...See subset().
Method .__transform_space__()
! Internal method only to be used for package development.
Usage
LPJmLGridData$.__transform_space__(...)
Arguments
...See transform().
Method new()
!Internal method only to be used for package development!
Usage
LPJmLGridData$new(lpjml_data)
Arguments
lpjml_dataLPJmLData object with variable "grid" or "LPJGRID"
Method print()
Method to print the LPJmLGridData.
See also print
Usage
LPJmLGridData$print()
Method clone()
The objects of this class are cloneable with this method.
Usage
LPJmLGridData$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
lpjmlkit documentation built on March 31, 2023, 9:35 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| LPJmLGridData | R Documentation |
LPJmL grid data class
Description
A dedicated data class for an LPJmL input or output grid.
LPJmLGridData serves the spatial reference for any LPJmLData objects and
matches its spatial dimensions ("cell" or "lon", "lat") when attached as an
grid attribute to it.\
LPJmLGridData holds the information which longitude and latitude correspond
to each cell center assuming WGS84 as the coordinate reference system or
the corresponding cell index when the data comes with longitude and latitude
dimension.
As in LPJmLData the data array can be accessed via $data,
the meta data via $meta.
Super class
lpjmlkit::LPJmLData -> LPJmLGridData
Methods
Public methods
Inherited methods
Method add_grid()
! Not allowed to add a grid to an LPJmLGridData object.
Usage
LPJmLGridData$add_grid(...)
Arguments
...See
add_grid().
Method subset()
! Not allowed to use dimension names of LPJmLGridData$data
array directly to subset each dimension to match the supplied vectors.
Usage
LPJmLGridData$subset(...)
Arguments
...See
subset.LPJmLData()
Method transform()
! Not allowed to transform inner LPJmLGridData$data array
into another space or time format.
Usage
LPJmLGridData$transform(...)
Arguments
...See
transform().
Method as_raster()
! Not allowed to coerce (convert) an LPJmLGridData object into a
raster or brick object.
Usage
LPJmLGridData$as_raster(...)
Arguments
...See
as_raster().
Method as_terra()
! Not allowed to coerce (convert) an LPJmLGridData object into a
rast object.
Usage
LPJmLGridData$as_terra(...)
Arguments
...See
as_terra().
Method .__subset_space__()
! Internal method only to be used for package development.
Usage
LPJmLGridData$.__subset_space__(...)
Arguments
...See
subset().
Method .__transform_space__()
! Internal method only to be used for package development.
Usage
LPJmLGridData$.__transform_space__(...)
Arguments
...See
transform().
Method new()
!Internal method only to be used for package development!
Usage
LPJmLGridData$new(lpjml_data)
Arguments
lpjml_dataLPJmLData object with variable
"grid"or"LPJGRID"
Method print()
Method to print the LPJmLGridData.
See also print
Usage
LPJmLGridData$print()
Method clone()
The objects of this class are cloneable with this method.
Usage
LPJmLGridData$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.