cf.Domain.iscyclic

Domain.iscyclic(*identity, **filter_kwargs)[source]

Returns True if the given axis is cyclic.

If zero or two or more constructs are selected then an exception is raised, or the default parameter is returned.

New in version 1.0.

See also

cyclic, period, domain_axis

Parameters
identity: optional

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

filter_kwargs: optional

Keyword arguments as accepted by Constructs.filter that define additional construct selection criteria.

New in version (cfdm): 3.9.0

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)