cf.Field.remove_axis

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

Remove and return an axis from the field.

The axis may be selected with the keyword arguments. If no unique axis can be found then no axis is removed and None is returned.

If the axis has size greater than 1 then it is not possible to remove it if it is spanned by the field’s data array or any multidimensional coordinate or cell measure object of the field.

Parameters :
axis, kwargs : optional

Select the unique axis (it it exists) 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 :

The domain identifier of the removed axis, or None if there isn’t one.

Examples

Previous topic

cf.Field.remove_axes

Next topic

cf.Field.remove_data

This Page