cf.FieldAncillary.cyclic

FieldAncillary.cyclic(axes=None, iscyclic=True)[source]

Get or set the cyclicity of an axis.

See also

iscyclic

Parameters
axes: (sequence of) int

The axes to be set. Each axis is identified by its integer position. By default no axes are set.

iscyclic: bool, optional

If False then the axis is set to be non-cyclic. By default the axis is set to be cyclic.

Returns

set

Examples

>>> f.cyclic()
set()
>>> f.cyclic(1)
set()
>>> f.cyclic()
{1} TODO