cf.Field.iscyclic

Field.iscyclic(axis, **kwargs)[source]

Whether or not a particular axis is cyclic.

Parameters :
axis, kwargs :

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.

Returns :
out : bool

True if the selected axis is cyclic, otherwise False.

See also

axes, cyclic, period

Examples

>>> f.cyclic()
[]
>>> f.iscyclic('X')
False
>>> f.cyclic('X', period=360)
[]
>>> f.iscyclic('X')
True

Next topic

cf.Field.item

This Page