cfdm.FieldAncillary.squeeze

FieldAncillary.squeeze(*args, **kwargs)

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 (cfdm): 1.7.0

See also

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

FieldAncillary or None

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

Examples

>>> f = cfdm.FieldAncillary()
>>> d = cfdm.Data(numpy.arange(7008).reshape((1, 73, 1, 96)))
>>> f.set_data(d)
>>> 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)