cf.AuxiliaryCoordinate.squeeze

AuxiliaryCoordinate.squeeze(axes=None, i=False)

Remove size 1 dimensions from the data array and bounds in place.

See also

expand_dims, flip, transpose

Parameters:

axes : (sequence of) int, optional

The size 1 axes to remove. By default, all size 1 axes are removed. Size 1 axes for removal may be identified by the integer positions of dimensions in the data array.

i : bool, optional

If True then update the auxiliary coordinate in place. By default a new auxiliary coordinate is created. In either case, a auxiliary coordinate is returned.

Returns:

out : cf.Coordinate

Examples:

>>> c.squeeze()
>>> c.squeeze(1)
>>> c.squeeze([1, 2])