cfdm.core.Domain.get_data_axes

Domain.get_data_axes(key, default=<class 'ValueError'>)[source]

Gets the keys of the axes spanned by a construct’s data.

Specifically, returns the keys of the domain axis constructs spanned by the data of a metadata construct.

New in version (cfdm): 1.7.0

See also

del_data_axes, has_data_axes, set_data_axes

Parameters
key: str

Specify a metadata construct.

Parameter example:

key='auxiliarycoordinate0'

default: optional

Return the value of the default parameter if the data axes have not been set.

If set to an Exception instance then it will be raised instead.

Returns
tuple

The keys of the domain axis constructs spanned by the data.

Examples

>>> f.set_data_axes(['domainaxis0', 'domainaxis1'])
>>> f.get_data_axes()
('domainaxis0', 'domainaxis1')
>>> f.del_data_axes()
('domainaxis0', 'domainaxis1')
>>> print(f.del_dataxes(None))
None
>>> print(f.get_data_axes(default=None))
None