cf.BoundedVariable.squeeze

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

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

New in version 2.0.

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

Returns:

out : cf.BoundedVariable

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