cf.Field.roll

Field.roll(axis, shift, i=False, **kwargs)[source]

Roll the field along a cyclic axis.

New in version 1.0.

Parameters:
axis, kwargs :

Select the unique axis which would be selected by this call of the field’s axes method: f.axes(axis, **kwargs). See cf.Field.axes for details.

shift : int

The number of places by which the selected cyclic axis is to be rolled.

i : bool, optional

If True then update the field in place. By default a new field is created.

Returns:
out : cf.Field

The rolled field.

Examples:

Previous topic

cf.Field.rint

Next topic

cf.Field.sample_size

This Page