cfdm.AuxiliaryCoordinate¶

class
cfdm.
AuxiliaryCoordinate
(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.coordinate.Coordinate
,cfdm.core.auxiliarycoordinate.AuxiliaryCoordinate
An auxiliary coordinate construct of the CF data model.
An auxiliary coordinate construct provides information which locate the cells of the domain and which depend on a subset of the domain axis constructs. Auxiliary coordinate constructs have to be used, instead of dimension coordinate constructs, when a single domain axis requires more then one set of coordinate values, when coordinate values are not numeric, strictly monotonic, or contain missing values, or when they vary along more than one domain axis construct simultaneously. CFnetCDF auxiliary coordinate variables and nonnumeric scalar coordinate variables correspond to auxiliary coordinate constructs.
The auxiliary coordinate construct consists of a data array of the coordinate values which spans a subset of the domain axis constructs, an optional array of cell bounds recording the extents of each cell (stored in a
Bounds
object), and properties to describe the coordinates. An array of cell bounds spans the same domain axes as its coordinate array, with the addition of an extra dimension whose size is that of the number of vertices of each cell. This extra dimension does not correspond to a domain axis construct since it does not relate to an independent axis of the domain. Note that, for climatological time axes, the bounds are interpreted in a special way indicated by the cell method constructs.NetCDF interface
The netCDF variable name may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
andnc_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
andnc_set_variable_groups
methods.{{netCDF variable group}}
New in version (cfdm): 1.7.0
Initialisation
 Parameters
 properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods. Parameter example:
properties={'standard_name': 'latitude'}
 data: data_like, optional
Set the data. Ignored if the source parameter is set.
A data_like object is any object that can be converted to a
Data
object, i.e.numpy
array_like objects,Data
objects, and cfdm instances that containData
objects.The data also may be set after initialisation with the
set_data
method. bounds:
Bounds
, optional Set the bounds array. Ignored if the source parameter is set.
The bounds array may also be set after initialisation with the
set_bounds
method. geometry:
str
, optional Set the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation with the
set_geometry
method. Parameter example:
geometry='polygon'
 interior_ring:
InteriorRing
, optional Set the interior ring variable. Ignored if the source parameter is set.
The interior ring variable may also be set after initialisation with the
set_interior_ring
method. source: optional
Initialise the properties, data and bounds from those of source.
Note that if source is a
AuxiliaryCoordinate
instance thencfdm.AuxiliaryCoordinate(source=source)
is equivalent tosource.copy()
. copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
 properties:
Inspection¶
Methods
A full description of the auxiliary coordinate construct. 

Return the canonical identity. 

Return all possible identities. 
Attributes
Return a description of the construct type. 
Properties¶
Methods
Remove a property. 

Return a property. 

Whether a property has been set. 

Set a property. 

Return all properties. 

Remove all properties. 

Set properties. 
Data¶
Methods
Apply masking as defined by the CF conventions. 

Remove the data. 

Return the data. 

Whether or not the construct has data. 

Set the data. 

Expand the shape of the data array. 

Remove size one axes from the data array. 

Permute the axes of the data array. 
Attributes
Return the data. 

Datatype of the data elements. 

The number of dimensions in the data array. 

A tuple of the data array’s dimension sizes. 

The number of elements in the data array. 
Bounds¶
Methods
Remove the bounds. 

Return the bounds. 

Whether or not there are bounds. 

Set the bounds. 

Return the bounds data. 
Attributes
Return the bounds. 
Geometries¶
Methods
Remove the geometry type. 

Return the geometry type. 

True if there is a geometry type. 

Set the geometry type. 

Remove the geometry type. 

Return the interior ring variable for polygon geometries. 

Whether or not there is an interior ring variable. 

Set the interior_ring. 

Remove the node count variable for geometry bounds. 

Return the node count variable for geometry bounds. 

Whether geometry bounds have a node count variable. 

Set the node count variable for geometry bounds. 

Remove the part node count variable for geometry bounds. 

Return the part node count variable for geometry bounds. 

Whether geometry bounds have a part node count variable. 

Set the part node count variable for geometry bounds. 
Attributes
Return the interior ring variable for polygon geometries. 
Climatology¶
Methods
Remove the climatology setting. 

Return the climatology setting. 

True if the coordinates are climatological. 

Set whether or not coordinates are climatological. 
Miscellaneous¶
Methods
Return a deep copy. 

Return the commands that would create the construct. 

Whether two instances are the same. 

Uncompress the construct. 

Return the name of the file or files containing the data. 
NetCDF¶
Methods
Remove the netCDF variable name. 

Return the netCDF variable name. 

Whether the netCDF variable name has been set. 

Set the netCDF variable name. 
Groups¶
Methods
Return the netCDF variable group hierarchy. 

Remove the netCDF variable group hierarchy. 

Set the netCDF variable group hierarchy. 
Special¶
Methods
Called by the 

Return a subspace of the construct defined by indices. 

Called by the 

Called by the 
Docstring substitutions¶
Methods
Return the special docstring substitutions. 

Returns the substitutions that apply to methods of the class. 

Returns the class {{package}} substitutions package depth. 

Returns method names excluded in the class substitutions. 