ncdfCF (version 0.4.0)

CFAxisVertical: Parametric vertical CF axis object

Description

This class represents a parametric vertical axis. It is defined through an index value that is contained in the axis, with additional NCVariable instances that hold ancillary data with which to calculate dimensional axis values. It is used in atmosphere and ocean data sets. Non-parametric vertical axes are stored in an CFAxisNumeric instance.

Super classes

ncdfCF::CFObject -> ncdfCF::CFAxis -> ncdfCF::CFAxisNumeric -> CFAxisVertical

Public fields

parameter_name

The 'standard_name' attribute of the NCVariable that identifies the parametric form of this axis.

computed_name

The standard name for the computed values of the axis.

computed_units

The unit of the computed values of the axis.

Active bindings

friendlyClassName

(read-only) A nice description of the class.

formula_terms

A data.frame with the "formula_terms" to calculate the parametric axis values.

dimnames

(read-only) The coordinates of the axis.

Methods

Public methods

• CFAxisVertical$new()

• CFAxisVertical$clone()

Inherited methods

• 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$label_set()
• ncdfCF::CFAxis$peek()
• ncdfCF::CFAxis$shard()
• ncdfCF::CFAxis$time()
• ncdfCF::CFAxis$write()
• ncdfCF::CFAxisNumeric$brief()
• ncdfCF::CFAxisNumeric$indexOf()
• ncdfCF::CFAxisNumeric$print()
• ncdfCF::CFAxisNumeric$range()
• ncdfCF::CFAxisNumeric$sub_axis()

---

Method new()

Create a new instance of this class.

Usage

CFAxisVertical$new(grp, nc_var, nc_dim, values, standard_name)

Arguments

grp

The group that contains the netCDF variable.

nc_var

The netCDF variable that describes this instance.

nc_dim

The netCDF dimension that describes the dimensionality.

values

The dimension values of this axis.

standard_name

Character string with the "standard_name" that defines the meaning, and processing of coordinates, of this axis.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CFAxisVertical$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

References

https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#parametric-vertical-coordinate