CFAxisNumeric {ncdfCF} | R Documentation |
Numeric CF axis object
Description
This class represents a numeric axis. Its values are numeric. This class is used for axes with numeric values but without further knowledge of their nature. More specific classes descend from this class.
Super classes
ncdfCF::CFObject
-> ncdfCF::CFAxis
-> CFAxisNumeric
Active bindings
friendlyClassName
(read-only) A nice description of the class.
dimnames
(read-only) The coordinates of the axis as a vector. These are by default the values of the axis, but it could also be a set of auxiliary coordinates, if they have been set.
Methods
Public methods
Inherited methods
ncdfCF::CFObject$add_coordinates()
ncdfCF::CFObject$append_attribute()
ncdfCF::CFObject$attribute()
ncdfCF::CFObject$delete_attribute()
ncdfCF::CFObject$print_attributes()
ncdfCF::CFObject$set_attribute()
ncdfCF::CFObject$write_attributes()
ncdfCF::CFAxis$can_append()
ncdfCF::CFAxis$peek()
ncdfCF::CFAxis$shard()
ncdfCF::CFAxis$time()
ncdfCF::CFAxis$write()
Method new()
Create a new instance of this class.
Creating a new axis is more easily done with the makeAxis()
function.
Usage
CFAxisNumeric$new(nc_var, nc_dim, orientation, values)
Arguments
nc_var
The netCDF variable that describes this instance.
nc_dim
The netCDF dimension that describes the dimensionality.
orientation
The orientation (
X
,Y
,Z
, orT
) or""
if different or unknown.values
The coordinates of this axis.
Method print()
Summary of the axis printed to the console.
Usage
CFAxisNumeric$print(...)
Arguments
...
Arguments passed on to other functions. Of particular interest is
width =
to indicate a maximum width of attribute columns.
Returns
self
, invisibly.
Method brief()
Some details of the axis.
Usage
CFAxisNumeric$brief()
Returns
A 1-row data.frame
with some details of the axis.
Method range()
Retrieve the range of coordinate values in the axis.
Usage
CFAxisNumeric$range()
Returns
A numeric vector with two elements with the minimum and maximum values in the axis, respectively.
Method indexOf()
Retrieve the indices of supplied coordinates on the axis. If the axis has bounds then the supplied coordinates must fall within the bounds to be considered valid.
Usage
CFAxisNumeric$indexOf(x, method = "constant", rightmost.closed = TRUE)
Arguments
x
A numeric vector of coordinates whose indices into the axis to extract.
method
Extract index values without ("constant", the default) or with ("linear") fractional parts.
rightmost.closed
Whether or not to include the upper limit. This parameter is ignored for this class, effectively it always is
TRUE
.
Returns
A vector giving the indices in x
of valid coordinates provided.
Values of x
outside of the range of the coordinates in the axis are
returned as NA
.
Method identical()
Tests if the axis passed to this method is identical to
self
.
Usage
CFAxisNumeric$identical(axis)
Arguments
axis
The
CFAxisNumeric
or sub-class instance to test.
Returns
TRUE
if the two axes are identical, FALSE
if not.
Method append()
Append a vector of values at the end of the current values of the axis.
Usage
CFAxisNumeric$append(from)
Arguments
from
An instance of
CFAxisNumeric
or any of its descendants whose values to append to the values ofself
.
Returns
A new CFAxisNumeric
or descendant instance with values from
self and the from
axis appended.
Method subset()
Return an axis spanning a smaller coordinate range. This
method returns an axis which spans the range of indices given by the
rng
argument.
Usage
CFAxisNumeric$subset(group, rng = NULL)
Arguments
group
The group to create the new axis in.
rng
The range of indices whose values from this axis to include in the returned axis.
Returns
A CFAxisNumeric
instance covering the indicated range of
indices. If the value of the argument is NULL
, return the entire
axis.
Method clone()
The objects of this class are cloneable with this method.
Usage
CFAxisNumeric$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.