cf.FieldList.anchor

FieldList.anchor(axis, value, i=False, _dry_run=False, **kwargs)

Roll a cyclic axis of each field so that the given value lies in the first coordinate cell.

fl.anchor() is equivalent to cf.FieldList(f.anchor() for f in fl).

See cf.Field.anchor for details.

Parameters :

axis, kwargs : optional

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.

value : data-like

Anchor the dimension coordinate values for the selected cyclic axis to this value. See cf.Field.anchor for details.

i : bool, optional

If True then update the field list and its fields in place. By default a new field list containing new fields is created.

_dry_run : bool, optional

Return a dictionary of parameters which describe the anchoring process. See cf.Field.anchor for details.

Returns :

out : cf.FieldList

Examples