cf.Field.period

Field.period(axis, **kwargs)[source]

Return the period of an axis.

Note that a non-cyclic axis may have a defined period.

New in version 1.0.

See also

axis, cyclic, iscyclic, cf.DimensionCoordinate.period

Parameters:
axis:

The cyclic axis, defined by that which would be selected by passing the given axis description to a call of the field construct’s domain_axis method. For example, for a value of 'X', the domain axis construct returned by f.domain_axis('X')) is selected.

axes: deprecated at version 3.0.0

Use the axis parameter instead.

kwargs: deprecated at version 3.0.0
Returns:
Data or None

The period of the cyclic axis’s dimension coordinates, or None no period has been set.

Examples:

>>> f.cyclic()
{}
>>> print(f.period('X'))
None
>>> f.dimension_coordinate('X').Units
<CF Units: degrees_east>
>>> f.cyclic('X', period=360)
{}
>>> print(f.period('X'))
<CF Data(): 360.0 'degrees_east'>
>>> f.cyclic('X', False)
{'dim3'}
>>> print(f.period('X'))
<CF Data(): 360.0 'degrees_east'>
>>> f.dimension_coordinate('X').period(None)
<CF Data(): 360.0 'degrees_east'>
>>> print(f.period('X'))
None