cfdm.core.Coordinate¶
-
class
cfdm.core.
Coordinate
(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.abstract.propertiesdatabounds.PropertiesDataBounds
Mixin for CF data model dimension and auxiliary coordinates.
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': 'longitude'}
- 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.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. 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, geometry type, data, bounds and interior ring from those of source.
Note that if source is a
Coordinate
instance thencfdm.core.Coordinate(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:
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
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. |
Modification¶
Methods
Remove the data. |
|
Set the data. |
|
Remove the bounds. |
|
Set the bounds. |
Miscellaneous¶
Methods
Return a deep copy. |
Special¶
Methods
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. |