cfdm.core.Domain


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

Bases: cfdm.core.mixin.constructaccess.ConstructAccess, cfdm.core.abstract.container.Container

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.

New in version (cfdm): 1.7.0

Initialization

Parameters
source: optional

Initialize the metadata constructs from those of source.

Note that if source is a Domain instance then cfdm.core.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 initialization. By default arguments are deep copied.

Metadata constructs

Methods

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

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.

Attributes

constructs

Return the metadata constructs.

Miscellaneous

Methods

copy

Return a deep copy.

fromconstructs

Create a domain from existing metadata constructs.

Special

Methods

__deepcopy__

Called by the copy.deepcopy function.

Docstring substitutions

Methods

_docstring_special_substitutions

Return the special docstring substitutions.

_docstring_substitutions

Return the docstring substitutions that apply to methods of the given class.

_docstring_package_depth

Return the package depth, N, for {{package}} docstring substitutions for the given class.

_docstring_method_exclusions

Return the names of methods to exclude from docstring substitutions for the given class.