cf.Field.iscyclic

Field.iscyclic(*identity, **filter_kwargs)

Returns True if the specified axis is cyclic.

New in version 1.0.

See also

axis, cyclic, period, domain_axis

Parameters

identity, filter_kwargs: optional

Select the unique domain axis construct returned by f.domain_axis(*identity, **filter_kwargs). See domain_axis for details.

Returns

bool

True if the selected axis is cyclic, otherwise False.

Examples

>>> f.iscyclic('X')
True
>>> f.iscyclic('latitude')
False

>>> x = f.iscyclic('long_name=Latitude')
>>> x = f.iscyclic('dimensioncoordinate1')
>>> x = f.iscyclic('domainaxis2')
>>> x = f.iscyclic('key%domainaxis2')
>>> x = f.iscyclic('ncdim%y')
>>> x = f.iscyclic(2)