cf.Field.iscyclic

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

Whether or not a particular axis is cyclic.

New in version 1.0.

See also

axis, cyclic, period

Parameters:
axis, kwargs :

Select the axis which would be selected by this call of the field’s axis method: f.axis(axis, **kwargs). See cf.Field.axis for details.

Returns:
out : bool

True if the selected axis is cyclic, otherwise False.

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

Previous topic

cf.Field.insert_ref

Next topic

cf.Field.item

This Page