cfdm.core.Domain.del_data_axes

Domain.del_data_axes(key, default=ValueError())

Removes the keys of the axes spanned by the construct data.

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

New in version (cfdm): 1.7.0

See also

get_data_axes, has_data_axes, set_data_axes

Parameters

key: str

Specify a metadata construct, instead of the field 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 removed keys of the domain axis constructs spanned by the data.

Examples

>>> f.del_data_axes(key='dimensioncoordinate2')
('domainaxis1',)

>>> f.has_data_axes(key='auxiliarycoordinate0')
False
>>> f.has_data_axes(key='auxiliarycoordinate0', default='no axes')
'no axes'