cf.FieldAncillary.flip

FieldAncillary.flip(axes=None, inplace=False, i=False)[source]

Flip (reverse the direction of) data dimensions.

See also

flatten, insert_dimension, squeeze, transpose, unsqueeze

Parameters:
axes: optional

Select the domain axes to flip. One, or a sequence, of:

  • The position of the dimension in the data.

If no axes are specified then all axes are flipped.

inplace: bool, optional

If True then do the operation in-place and return None.

i: deprecated at version 3.0.0

Use the inplace parameter instead.
Returns:

The construct with flipped axes, or None if the operation was in-place.

Examples:

>>> f.flip()
>>> f.flip(1)
>>> f.flip([0, 1])

>>> g = f[::-1, :, ::-1]
>>> f.flip([2, 0]).equals(g)
True