cfdm.Data.squeeze

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

Remove size 1 axes from the data.

By default all size 1 axes are removed, but particular axes may be selected with the keyword arguments.

New in version (cfdm): 1.7.0

See also

flatten, insert_dimension, transpose

Parameters
axes: (sequence of) int, optional

The positions of the size one axes to be removed. By default all size one axes are removed.

Each axis is identified by its integer position in the data. Negative integers counting from the last position are allowed.

Parameter example:

axes=0

Parameter example:

axes=-1

Parameter example:

axes=[1, -2]

inplace: bool, optional

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

Returns
Data or None

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

Examples

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