cf.FieldAncillary.cyclic

FieldAncillary.cyclic(axes=None, iscyclic=True)

Set the cyclicity of axes of the data array.

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:

out: set

Examples:

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