cfdm.core.Field.get_data_axes

Field.get_data_axes(key=None, default=ValueError())

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

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

New in version (cfdm): 1.7.0

See also

del_data_axes, get_data, set_data_axes

Parameters

key: str, optional

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 keys of the domain axis constructs spanned by the data.

Examples

>>> f = cfdm.core.example_field(0)
>>> f.get_data_axes()
('domainaxis0', 'domainaxis1')
>>> f.get_data_axes(key='dimensioncoordinate2')
('domainaxis2',)
>>> f.has_data_axes()
True

>>> f.del_data_axes()
('domainaxis0', 'domainaxis1')
>>> f.has_data_axes()
False
>>> f.get_data_axes(default='no axes')
'no axes'