cf.InteriorRing

---

class cf.InteriorRing(*args, **kwargs)

An interior ring array with properties.

If a cell is composed of multiple polygon parts, an individual polygon may define an “interior ring”, i.e. a region that is to be omitted from, as opposed to included in, the cell extent. In this case an interior ring array is required that records whether each polygon is to be included or excluded from the cell, and is supplied by an interior ring variable in CF-netCDF. The interior ring array spans the same domain axis constructs as its coordinate array, with the addition of an extra dimension that indexes the parts for each cell. For example, a cell describing the land area surrounding a lake would require two polygon parts: one defines the outer boundary of the land area; the other, recorded as an interior ring, is the lake boundary, defining the inner boundary of the land area.

NetCDF interface

The netCDF variable name may be accessed with the nc_set_variable, nc_get_variable, nc_del_variable, and nc_has_variable methods.

The netCDF variable group structure may be accessed with the nc_set_variable, nc_get_variable, nc_variable_groups, nc_clear_variable_groups, and nc_set_variable_groups methods.

The dataset chunks may be accessed with the nc_dataset_chunksizes, nc_set_dataset_chunksizes, and nc_clear_datset_chunksizes methods.

The name of the netCDF dimension spanned by the interior ring variable’s data (which does not correspond to a domain axis construct) may be accessed with the nc_set_dimension, nc_get_dimension, nc_del_dimension, and nc_has_dimension methods.

Added in version (cfdm): 1.8.0

Initialisation

Parameters:

properties: dict, optional

Set descriptive properties. The dictionary keys are property names, with corresponding values.

Properties may also be set after initialisation with the set_properties and set_property methods.

Parameter example:

properties={'standard_name': 'altitude'}

data: data_like, optional

Set the data.

A data_like object is any object that can be converted to a Data object, i.e. numpy array_like objects, Data objects, and cf instances that contain Data objects.

The data also may be set after initialisation with the set_data method.

source: optional

Convert source, which can be any type of object, to a InteriorRing instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the InteriorRing API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a InteriorRing instance then cf.InteriorRing(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

Methods

Methods

T	True if and only if the data are coordinates for a CF 'T' axis.
X	True if and only if the data are coordinates for a CF 'X' axis.
Y	True if and only if the data are coordinates for a CF 'Y' axis.
Z	True if and only if the data are coordinates for a CF 'Z' axis.
autoperiod	Set the period of cyclicity where it can be determined.
axis	The axis CF property.
ctype	The CF coordinate type.
identities	Return all possible identities.
identity	Return the canonical identity.
positive	The positive CF property.