cfdm.DimensionCoordinate¶
-
class
cfdm.
DimensionCoordinate
(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.dimensioncoordinate.DimensionCoordinate
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 non-missing 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. CF-netCDF 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.NetCDF interface
The netCDF variable name of the construct may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
andnc_has_variable
methods.New in version 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': 'time'}
- data:
Data
, optional Set the data array. Ignored if the source parameter is set.
The data array may also 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.- source: optional
Initialize the properties, data and bounds from those of source.
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- properties:
Inspection¶
Methods
dump |
A full description of the dimension coordinate construct. |
identity |
Return the canonical identity. |
identities |
Return all possible identities. |
Attributes
construct_type |
Return a description of the construct type. |
Properties¶
Methods
del_property |
Remove a property. |
get_property |
Return a property. |
has_property |
Whether a property has been set. |
set_property |
Set a property. |
properties |
Return all properties. |
clear_properties |
Remove all properties. |
set_properties |
Set properties. |
Data¶
Methods
del_data |
Remove the data. |
get_data |
Return the data. |
has_data |
Whether a data has been set. |
set_data |
Set the data. |
insert_dimension |
Expand the shape of the data array. |
squeeze |
Remove size one axes from the data array. |
transpose |
Permute the axes of the data array. |
Attributes
data |
Return the data. |
Bounds¶
Methods
del_bounds |
Remove the bounds. |
get_bounds |
Return the bounds. |
has_bounds |
Whether or not there are bounds. |
set_bounds |
Set the bounds. |
Attributes
bounds |
Return the bounds. |
Miscellaneous¶
Methods
copy |
Return a deep copy. |
equals |
Whether two dimension coordinate constructs are the same. |
uncompress |
Uncompress the construct. |
NetCDF¶
Methods
nc_del_variable |
Remove the netCDF variable name. |
nc_get_variable |
Return the netCDF variable name. |
nc_has_variable |
Whether the netCDF variable name has been set. |
nc_set_variable |
Set the netCDF variable name. |
Special¶
Methods
__deepcopy__ |
Called by the copy.deepcopy function. |
__getitem__ |
Return a subspace of the construct defined by indices |
__repr__ |
Called by the repr built-in function. |
__str__ |
Called by the str built-in function. |