cf.FieldList.cyclic

FieldList.cyclic(axis=None, iscyclic=True, period=None, **kwargs)

Set the cyclicity of an axis for each field.

fl.cyclic() is equivalent to cf.List(f.cyclic() for f in fl).

See cf.Field.cyclic for details.

Parameters:

axis, kwargs : optional

Select the axis. See cf.Field.cyclic for details.

iscyclic : bool, optional

If False then the axis is set to be non-cyclic. See cf.Field.cyclic for details.

period : data-like, optional

Set the period for a dimension coordinate object which spans the selected axis. See cf.Field.cyclic for details.

Returns:

out : cf.List

The axes of each the field which were cyclic prior to the new setting, or the current cyclic axes if no axis was specified.