cf.FieldAncillary.roll

FieldAncillary.roll(iaxis, shift, i=False)[source]

Roll the field ancillary along an axis.

Parameters:

iaxis: int

i: bool, optional

If True then update the field ancillary in place. By default a new field ancillary is created. In either case, a field ancillary is returned.

Returns:

out: cf.FieldAncillary

Examples: