CFCellMeasure {ncdfCF} | R Documentation |
CF cell measure variable
Description
This class represents a CF cell measure variable, the object that indicates the area or volume of every grid cell in referencing data variables.
If a cell measure variable is external to the current file, an instance will still be created for it, but the user must link the external file to this instance before it can be used in analysis.
Public fields
group
The NCGroup that this object is located in.
measure
The measure of this instance. Either "area" or "volume".
name
The name of this instance, which must refer to a NC variable or an external variable.
Methods
Public methods
Method new()
Create an instance of this class.
Usage
CFCellMeasure$new(grp, measure, name = NULL, nc_var = NULL, axes = NULL)
Arguments
grp
The group that this CF cell measure variable lives in.
measure
The measure of this object. Must be either of "area" or "volume".
name
The name of the cell measure variable. May be omitted if argument
nc_var
is specified.nc_var
The netCDF variable that defines this CF cell measure object.
NULL
for an external variable.axes
List of CFAxis instances that describe the dimensions of the cell measure object.
NULL
for an external variable.
Returns
An instance of this class.
Method print()
Print a summary of the cell measure variable to the console.
Usage
CFCellMeasure$print(...)
Arguments
...
Arguments passed on to other functions. Of particular interest is
width =
to indicate a maximum width of attribute columns.
Method data()
Retrieve the values of the cell measure variable.
Usage
CFCellMeasure$data()
Returns
The values of the cell measure as a CFArray instance.
Method register()
Register a CFVariable which is using this cell measure variable. A check is performed on the compatibility between the data variable and this cell measure variable.
Usage
CFCellMeasure$register(var)
Arguments
var
A
CFVariable
instance to link to this instance.
Returns
Self, invisibly.
Method link()
Link the cell measure variable to an external netCDF resource. The resource will be opened and the appropriate data variable will be linked to this instance. If the axes or other properties of the external resource are not compatible with this instance, an error will be raised.
Usage
CFCellMeasure$link(resource)
Arguments
resource
The name of the netCDF resource to open, either a local file name or a remote URI.
Returns
Self, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
CFCellMeasure$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.