cf.FieldList.expand_dims

FieldList.expand_dims(position=0, axes=None, i=False, **kwargs)[source]

For each field, insert a size 1 axis into the data array.

By default default a new size 1 axis is inserted which doesn’t yet exist, but a unique existing size 1 axis which is not already spanned by the data array may be selected.

See also

axes, flip, squeeze, transpose, unsqueeze

Examples 1:

Insert a new size axis in position 0:

>>> g = f.expand_dims()

Insert the existing, size 1 time axis in position 2:

>>> g = f.expand_dims(2, axes='T')
Parameters:
position: int, optional

Specify the position that the new axis will have in the data array. By default the new axis has position 0, the slowest varying position.

axes, kwargs: optional

Select axes. The axes parameter may be one, or a sequence, of:

  • None. If no kwargs arguments have been set then all axes are selected. This is the default.

  • An integer. Explicitly selects the axis corresponding to the given position in the list of axes of the field’s data array.

    Example:

    To select the third data array axis: axes=2. To select the last axis: axes=-1.

  • A slice object. Explicitly selects the axes corresponding to the given positions in the list of axes of the field’s data array.

    Example:

    To select the last three data array axes: axes=slice(-3, None)

  • A domain axis identifier. Explicitly selects this axis.

    Example:

    To select axis “dim1”: axes='dim1'.

  • Any value accepted by the items parameter of the field’s items method. Used in conjunction with the kwargs parameters to select the axes which span the items that would be identified by this call of the field’s items method: f.items(items=axes, axes=None, **kwargs). See cf.Field.items for details.

    Example:

    To select the axes spanned by one dimensionsal time coordinates: f.expand_dims('T', ndim=1).

If axes is a sequence of any combination of the above then the selected axes are the union of those selected by each element of the sequence. If the sequence is empty then no axes are selected.

i: bool, optional

If True then update the field list in place. By default a new field list is created. In either case, a field list is returned.
Returns:
out: cf.FieldList

For each field, , the expanded field.
Examples 2: