cf.DomainAncillary.iscyclic

DomainAncillary.iscyclic(axis)[source]

Whether or not a given axis is cyclic.

New in version 3.5.0.

See also

cyclic, period, isperiodic

Parameters
axis: int, optional

Select the axis by its position in the data dimensions.

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)