cf.Field.iscyclic

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

Returns True if the given axis is cyclic.

New in version 1.0.

See also

axis, cyclic, period

Parameters:
identity:

Select the domain axis construct by one of:

  • An identity or key of a 1-d coordinate construct that whose data spans the domain axis construct.
  • A domain axis construct identity or key.
  • The position of the domain axis construct in the field construct’s data.

The identity parameter selects the domain axis as returned by this call of the field construct’s domain_axis method: f.domain_axis(identity).

kwargs: deprecated at version 3.0.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)