cf.Domain

---

class cf.Domain(properties=None, source=None, copy=True, _use_data=True)

Bases: cf.mixin.fielddomain.FieldDomain, cf.mixin.properties.Properties, cfdm.domain.Domain

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.

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 and set_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 then cf.Domain(source=source) is equivalent to source.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.

Inspection

Methods

dump	A full description of the domain construct.

Metadata constructs

Methods

auxiliary_coordinates	Return auxiliary coordinate constructs.
cell_measures	Return cell measure constructs.
coordinates	Return dimension and auxiliary coordinate constructs.
coordinate_references	Return coordinate reference constructs.
dimension_coordinates	Return dimension coordinate constructs.
domain_ancillaries	Return domain ancillary constructs.
domain_axes	Return domain axis constructs.
construct	Select a metadata construct by its identity.
construct_item	Return a metadata construct and its identifier.
construct_key	Return the identifier of a metadata construct.
del_construct	Remove a metadata construct.
get_construct	Return a metadata construct.
has_construct	Whether a metadata construct exists.
set_construct	Set a metadata construct.
del_data_axes	Removes the keys of the axes spanned by the construct data.
get_data_axes	Return the keys of the domain axis constructs spanned by the data of a metadata construct.
has_data_axes	Whether the axes spanned by the construct data have been set.
set_data_axes	Sets domain axis constructs spanned by the construct data.
domain_axis_key	Returns the domain axis key spanned by 1-d coordinates.
climatological_time_axes	Return all axes which are climatological time axes.

Attributes

constructs

Return the metadata constructs.

Miscellaneous

Methods

copy	Return a deep copy.
equals	Whether two constructs are the same.
fromconstructs	Return a new domain containing the given metadata constructs.
apply_masking	Apply masking as defined by the CF conventions.
get_filenames	Return the file names containing the metadata construct data.
has_data	Whether or not the construct has data.
get_data	Return a default value when data is requested.

Attributes

has_geometry

Return whether or not any coordinates have cell geometries.

Special

Methods

__deepcopy__	Called by the copy.deepcopy function.
__repr__	Called by the repr built-in function.
__str__	Called by the str built-in function.