cf.Field.get_data_axes¶
-
Field.
get_data_axes
(*identity, default=ValueError(), **filter_kwargs)[source]¶ Return domain axis constructs spanned by data.
Specifically, returns the keys of the domain axis constructs spanned by the field’s data, or the data of a metadata construct.
New in version 3.0.0.
See also
- Parameters
- identity, filter_kwargs: optional
Select the unique construct returned by
f.construct(*identity, **filter_kwargs)
. Seeconstruct
for details.If neither identity nor filter_kwargs are set then the domain of the field constructs’s data are returned.
- 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
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