cfdm.mixin.PropertiesData.squeeze

PropertiesData.squeeze(axes=None)[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]

Returns:

A new instance with removed data axes.

Examples:

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