cf.Field.remove_axis

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

Remove and return a unique 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.

See also

axis, remove_axes, remove_item, remove_items

Parameters:
axes, kwargs: optional

Select axes. The axes parameter may be one, or a sequence, of:

  • None. If no kwargs arguments have been set then all axes are selected. This is the default.

  • An integer. Explicitly selects the axis corresponding to the given position in the list of axes of the field’s data array.

    Example:

    To select the third data array axis: axes=2. To select the last axis: axes=-1.

  • A slice object. Explicitly selects the axes corresponding to the given positions in the list of axes of the field’s data array.

    Example:

    To select the last three data array axes: axes=slice(-3, None)

  • A domain axis identifier. Explicitly selects this axis.

    Example:

    To select axis “dim1”: axes='dim1'.

  • Any value accepted by the description parameter of the field’s items method. Used in conjunction with the kwargs parameters to select the axes which span the items that would be identified by this call of the field’s items method: f.items(items=axes, axes=None, **kwargs). See cf.Field.items for details.

    Example:

    To select the axes spanned by one dimensionsal time coordinates: f.remove_axis('T', ndim=1).

If axes is a sequence of any combination of the above then the selected axes are the union of those selected by each element of the sequence. If the sequence is empty then no axes are selected.

size: optional

Select axes whose sizes equal size. Axes whose sizes lie within a range sizes may be selected if size is a cf.Query object.

Example:

size=1 selects size 1 axes.

Example:

size=cf.ge(2) selects axes with sizes greater than 1 (see cf.ge).
Returns:
out: str

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