cf.Domain


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

Bases: cfdm.domain.Domain

A domain 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. These locations correspond to individual data array elements of a field construct

The domain 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.

Initialization

Parameters:
source: optional

Initialize the metadata constructs from those of source.

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 initialization. By default arguments are deep copied.

Inspection

Methods

dump A full description of the domain.

Metadata constructs

Methods

construct Select a metadata construct by its identity.
construct_key Select the key of a metadata construct by its identity.
del_construct Remove a metadata construct.
get_construct Return a metadata construct.
has_construct Whather a metadata construct exisits.
set_construct Set a metadata construct.
del_data_axes Remove the keys of the domain axis constructs spanned by the data of a metadata construct.
get_data_axes Return the keys of the domain axis constructs spanned by the data of a metadata construct.
has_data_axes Whether the domain axis constructs spanned by the data of a metadata construct have been set.
set_data_axes Set the domain axis constructs spanned by the data of a metadata construct.
domain_axis_key Return the key of the domain axis construct that is spanned by 1-d coordinate constructs.

Attributes

constructs Return the metdata constructs.
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.

Miscellaneous

Methods

copy Return a deep copy.
equals Whether two domains are the same.
fromconstructs Create a domain from existing metadata constructs.

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.