cf.Field.axis_name

Field.axis_name(axis=None, **kwargs)[source]

Return the canonical name for an axis.

Parameters:
axis, kwargs : optional

Select the unique axis which would be selected by this call of the field’s axes method: f.axes(axis, **kwargs). See cf.Field.axes for details.

Returns:
out : str

The canonical name for the axis.

Examples:
>>> f.axis_name('dim0')
'time'
>>> f.axis_name('dim1')
'domain%dim1'
>>> f.axis_name('dim2')
'ncdim%lat'

Previous topic

cf.Field.axis

Next topic

cf.Field.axis_size

This Page