cf.AuxiliaryCoordinate.squeeze

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

Remove size 1 dimensions from the data array

See also

insert_dimension, 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 are identified by their integer positions in the data array.

inplace: bool, optional

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

i: deprecated at version 3.0.0

Use inplace parameter instead.
Returns:

The construct with squeezed data. If the operation was in-place then None is returned.

Examples:

TODO

>>> f.squeeze()

>>> f.squeeze(1)

>>> f.squeeze([2, -1])