cf.Field.cyclic

Field.cyclic(identity=None, iscyclic=True, period=None, **kwargs)[source]

Set the cyclicity of an axis.

New in version 1.0.

See also

autocyclic, domain_axis, iscyclic, 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).

iscyclic: bool, optional

If False then the axis is set to be non-cyclic. By default the selected axis is set to be cyclic.

period: optional

The period for a dimension coordinate object which spans the selected axis. May be any numeric scalar object that can be converted to a Data object (which includes numpy array and Data objects). The absolute value of period is used. If period has units then they must be compatible with those of the dimension coordinates, otherwise it is assumed to have the same units as the dimension coordinates.

axes: deprecated at version 3.0.0

Use the identity parameter instead.

kwargs: deprecated at version 3.0.0
Returns:
set

The construct keys of the domain axes which were cyclic prior to the new setting, or the current cyclic domain axes if no axis was specified.

Examples:

>>> f.cyclic()
set()
>>> f.cyclic('X', period=360)
set()
>>> f.cyclic()
{'domainaxis2'}
>>> f.cyclic('X', iscyclic=False)
{'domainaxis2'}
>>> f.cyclic()
set()