cfdm.core.Domain¶
-
class
cfdm.core.
Domain
(properties=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.mixin.fielddomain.FieldDomain
,cfdm.core.abstract.properties.Properties
A domain construct of the CF data model.
The domain represents a set of discrete “locations” in what generally would be a multi-dimensional space, either in the real world or in a model’s simulated world. The data array elements of a field construct correspond to individual location of a domain.
The domain construct is defined collectively by the following constructs of the CF data model: domain axis, dimension coordinate, auxiliary coordinate, cell measure, coordinate reference, and domain ancillary constructs; as well as properties to describe the domain.
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={'long_name': 'Domain for model'}
- source: optional
Initialise the metadata constructs from those of source.
Note that if source is a
Domain
instance thencfdm.core.Domain(source=source)
is equivalent tosource.copy()
.A new domain may also be instantiated with the
fromconstructs
class method.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
- properties:
Inspection¶
Attributes
Return a description of the construct type. |
Metadata constructs¶
Methods
Remove a metadata construct. |
|
Return a metadata construct. |
|
Whether a metadata construct exists. |
|
Set a metadata construct. |
|
Removes the keys of the axes spanned by the construct data. |
|
Gets the keys of the axes spanned by a construct’s data. |
|
Whether the axes spanned by the construct data have been set. |
|
Sets domain axis constructs spanned by the construct data. |
Attributes
Return the metadata constructs. |
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. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Return a new domain containing the given metadata constructs. |
|
Whether or not there are cell bounds. |
|
Whether or not the construct has data. |
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. |