cfdm.core.DomainAxis

---

class cfdm.core.DomainAxis(size=None, source=None, copy=True)

Bases: cfdm.core.abstract.container.Container

A domain axis construct of the CF data model.

A domain axis construct specifies the number of points along an independent axis of the domain. It comprises a positive integer representing the size of the axis. In CF-netCDF it is usually defined either by a netCDF dimension or by a scalar coordinate variable, which implies a domain axis of size one. The field construct’s data array spans the domain axis constructs of the domain, with the optional exception of size one axes, because their presence makes no difference to the order of the elements.

New in version (cfdm): 1.7.0

Initialisation

Parameters

size: int, optional

The size of the domain axis.

Parameter example:

size=192

The size may also be set after initialisation with the set_size method.

source: optional

Convert source, which can be any type of object, to a DomainAxis instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the DomainAxis 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 a DomainAxis instance then cfdm.core.DomainAxis(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

Inspection

Attributes

construct_type

Return a description of the construct type.

Size

Methods

del_size	Remove the size.
get_size	Return the size.
has_size	Whether the size has been set.
set_size	Set the size.

Miscellaneous

Methods

copy	Return a deep copy.

Special

Methods

__deepcopy__

Called by the copy.deepcopy function.

Docstring substitutions

Methods

_docstring_special_substitutions	Return the special docstring substitutions.
_docstring_substitutions	Returns the substitutions that apply to methods of the class.
_docstring_package_depth	Returns the class {{package}} substitutions package depth.
_docstring_method_exclusions	Returns method names excluded in the class substitutions.