cfdm.Datum¶
-
class
cfdm.
Datum
(parameters=None, source=None, copy=True)[source]¶ Bases:
cfdm.mixin.parameters.Parameters
,cfdm.mixin.netcdf.NetCDFVariable
,cfdm.core.datum.Datum
A datum component of a coordinate reference construct of the CF data model.
A datum is a complete or partial definition of the zeroes of the dimension and auxiliary coordinate constructs which define a coordinate system.
The datum may contain the definition of a geophysical surface which corresponds to the zero of a vertical coordinate construct, and this may be required for both horizontal and vertical coordinate systems.
Elements of the datum not specified may be implied by the properties of the dimension and auxiliary coordinate constructs referenced by the
CoordinateReference
instance that contains the datum.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.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.New in version 1.7.0.
Initialization
- Parameters
- parameters:
dict
, optional Set parameters. The dictionary keys are parameter names, with corresponding values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with the
set_parameters
andset_parameter
methods.- Parameter example:
parameters={'earth_radius': 6371007.}
- source: optional
Initialize the parameters 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.
- parameters:
Parameter terms¶
Methods
Delete a parameter. |
|
Get a parameter value. |
|
Whether a parameter has been set. |
|
Set a parameter-valued term. |
|
Return all parameters. |
|
Set parameters. |
|
Remove all parameters. |
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. |
|
Set the netCDF variable group hierarchy. |
|
Remove the netCDF variable group hierarchy. |