This class is a basic ancestor to all classes that represent CF axes. More useful classes use this class as ancestor.
ncdfCF::CFObject -> CFAxis
NCdimThe NCDimension that stores the netCDF dimension details.
This is NULL for CFAxisScalar instances.
orientationA character "X", "Y", "Z" or "T" to indicate the orientation of the axis, or an empty string if not known or different.
boundsThe boundary values of this axis, if set.
lblsA list of CFLabel instances, if any are defined for the axis.
friendlyClassName(read-only) A nice description of the class.
dimid(read-only) The netCDF dimension id of this axis.
length(read-only) The declared length of this axis.
coordinates(read-only) Retrieve the coordinate values of the axis.
labelsSet or retrieve the labels for the axis. On assignment, the value must be an instance of CFLabel.
unlimited(read-only) Logical to indicate if the axis has an unlimited dimension.
new()Create a new CF axis instance from a dimension and a
variable in a netCDF resource. This method is called upon opening a
netCDF resource by the initialize() method of a descendant class
suitable for the type of axis.
CFAxis$new(grp, nc_var, nc_dim, orientation)grpThe NCGroup that this axis is located in.
nc_varThe NCVariable instance upon which this CF axis is based.
nc_dimThe NCDimension instance upon which this CF axis is based.
orientationThe orientation of the axis: "X", "Y", "Z" "T", or "" when not known or relevant.
A basic CFAxis object.
print()Prints a summary of the axis to the console. This method is
typically called by the print() method of descendant classes.
CFAxis$print(...)...Arguments passed on to other functions. Of particular interest
is width = to indicate a maximum width of attribute columns.
self, invisibly.
brief()Some details of the axis.
CFAxis$brief()A 1-row data.frame with some details of the axis.
shard()Very concise information on the axis. The information returned by this function is very concise and most useful when combined with similar information from other axes.
CFAxis$shard()Character string with very basic axis information.
peek()Retrieve interesting details of the axis.
CFAxis$peek(with_groups = TRUE)with_groupsShould group information be included? The save option
is TRUE (default) when the netCDF resource has groups because names may
be duplicated among objects in different groups.
A 1-row data.frame with details of the axis.
time()Return the CFTime instance that represents time. This
method is only useful for CFAxisTime instances and CFAxisScalar
instances having time information. This stub is here to make the call
to this method succeed with no result for the other axis descendants.
CFAxis$time()NULL
sub_axis()Return an axis spanning a smaller dimension range. This
method is "virtual" in the sense that it does not do anything other
than return NULL. This stub is here to make the call to this method
succeed with no result for the other axis descendants that do not
implement this method.
CFAxis$sub_axis(group, rng = NULL)groupThe group to create the new axis in.
rngThe range of values from this axis to include in the returned
axis. If the value of the argument is NULL, return the entire axis
(possibly as a scalar axis).
NULL
indexOf()Find indices in the axis domain. Given a vector of
numerical, timestamp or categorical values x, find their indices in
the values of the axis. With method = "constant" this returns the
index of the value lower than the supplied values in x. With
method = "linear" the return value includes any fractional part.
If bounds are set on the numerical or time axis, the indices are taken
from those bounds. Returned indices may fall in between bounds if the
latter are not contiguous, with the exception of the extreme values in
x.
CFAxis$indexOf(x, method = "constant")xVector of numeric, timestamp or categorial values to find axis indices for. The timestamps can be either character, POSIXct or Date vectors. The type of the vector has to correspond to the type of the axis.
methodSingle character value of "constant" or "linear".
Numeric vector of the same length as x. If method = "constant",
return the index value for each match. If method = "linear", return
the index value with any fractional value. Values of x outside of the
range of the values in the axis are returned as 0 and
.Machine$integer.max, respectively.
label_set()Retrieve a set of character labels corresponding to the elements of an axis. An axis can have multiple sets of labels and by default the first set is returned.
CFAxis$label_set(index = 1L)indexAn integer value indicating which set of labels to retrieve.
A character vector of string labels with as many elements as the
axis has, or NULL when no labels have been set or when argument
index is not valid.
write()Write the axis to a netCDF file, including its attributes.
CFAxis$write(nc = NULL)ncThe handle of the netCDF file opened for writing or a group in
the netCDF file. If NULL, write to the file or group where the axis
was read from (the file must have been opened for writing). If not
NULL, the handle to a netCDF file or a group therein.
Self, invisibly.
clone()The objects of this class are cloneable with this method.
CFAxis$clone(deep = FALSE)deepWhether to make a deep clone.