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 multidimensional 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.
Properties may also be set after initialisation with the
set_properties
andset_property
methods. Parameter example:
properties={'long_name': 'Domain for model'}
 source: optional
Convert source, which can be any type of object, to a
Domain
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
Domain
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 aDomain
instance thencfdm.core.Domain(source=x)
is equivalent tox.copy()
.A new domain may also be instantiated with the
fromconstructs
class method. 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:
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. 