CFAxisLatitude: Latitude CF axis object

In ncdfCF: Easy Access to NetCDF Files with CF Metadata Conventions

Latitude CF axis object

Description

This class represents a latitude axis. Its values are numeric. This class adds some logic that is specific to latitudes, such as their range, orientation and meaning.

Super classes

ncdfCF::CFObject -> ncdfCF::CFAxis -> ncdfCF::CFAxisNumeric -> CFAxisLatitude

Active bindings

friendlyClassName

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

Methods

Public methods

• CFAxisLatitude$new()

• CFAxisLatitude$subset()

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

---

Method new()

Create a new instance of this class.

Usage

CFAxisLatitude$new(grp, nc_var, nc_dim, values)

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 coordinates of this axis.

---

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

CFAxisLatitude$subset(group, rng = NULL)

Arguments

group

The group to create the new axis in.

rng

The range of values from this axis to include in the returned axis.

Returns

A CFAxisLatitude instance covering the indicated range of indices. If the rng argument includes only a single value, an CFAxisScalar instance is returned with the value from this axis. If the value of the argument is NULL, return the entire axis (possibly as a scalar axis).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CFAxisLatitude$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

ncdfCF documentation built on April 16, 2025, 9:08 a.m.