cf.DimensionCoordinate.squeeze

DimensionCoordinate.squeeze(axes=None, i=False)[source]

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

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 dimension coordinate in place. By default a new dimension coordinate is created. In either case, a dimension coordinate is returned.

Returns:

out : cf.Coordinate

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

Previous topic

cf.DimensionCoordinate.sin

Next topic

cf.DimensionCoordinate.sum

This Page