cfdm.core.DimensionCoordinate¶

class
cfdm.core.
DimensionCoordinate
(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.abstract.coordinate.Coordinate
A dimension coordinate construct of the CF data model.
A dimension coordinate construct provides information which locate the cells of the domain and which depend on a subset of the domain axis constructs. The dimension coordinate construct is able to unambiguously describe cell locations because a domain axis can be associated with at most one dimension coordinate construct, whose data array values must all be nonmissing and strictly monotonically increasing or decreasing. They must also all be of the same numeric data type. If cell bounds are provided, then each cell must have exactly two vertices. CFnetCDF coordinate variables and numeric scalar coordinate variables correspond to dimension coordinate constructs.
The dimension 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.New in version (cfdm): 1.7.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
andset_property
methods. Parameter example:
properties={'standard_name': 'longitude'}
 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 cfdm.core instances that containData
objects.The data also may be set after initialisation with the
set_data
method. bounds:
Bounds
, optional Set the bounds array.
The bounds array may also be set after initialisation with the
set_bounds
method. geometry:
str
, optional Set the geometry type.
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.
The interior ring variable may also be set after initialisation with the
set_interior_ring
method. source: optional
Convert source, which can be any type of object, to a
DimensionCoordinate
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
DimensionCoordinate
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 aDimensionCoordinate
instance thencfdm.core.DimensionCoordinate(source=x)
is equivalent tox.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.
 properties:
Properties¶
Methods
Remove a property. 

Return a property. 

Whether a property has been set. 

Set a property. 

Return all properties. 

Remove all properties. 

Remove properties. 

Set properties. 
Data¶
Methods
Remove the data. 

Return the data. 

Whether or not the construct has data. 

Set the data. 
Attributes
Return the data. 
Bounds¶
Methods
Remove the bounds. 

Return the bounds. 

Whether or not there are bounds. 

Set the bounds. 
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. 
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. 
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. 