cf.AuxiliaryCoordinate.squeeze

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

Remove size 1 dimensions from the data array

Examples 1:
>>> f.squeeze()
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 are identified by their integer positions 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.AuxiliaryCoordinate

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