cf.FieldAncillary.squeeze

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

Remove size one axes from the data array.

By default all size one axes are removed, but particular size one axes may be selected for removal.

New in version 1.7.0.

See also

insert_dimension, transpose

Parameters
axes: (sequence of) int

The positions of the size one axes to be removed. By default all size one axes are removed. Each axis is identified by its original integer position. Negative integers counting from the last position are allowed.

Parameter example:

axes=0

Parameter example:

axes=-2

Parameter example:

axes=[2, 0]

inplace: bool, optional

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

Returns

A new instance with removed data axes. If the operation was in-place then None is returned.

Examples:

>>> f.shape
(1, 73, 1, 96)
>>> f.squeeze().shape
(73, 96)
>>> f.squeeze(0).shape
(73, 1, 96)
>>> f.squeeze([-3, 2]).shape
(73, 96)