cf.Field.measure

Field.measure(items=None, axes=None, exact=False, inverse=False, match_and=True, ndim=None, strict_axes=False, key=False)

Return a cf.CellMeasure object of the domain, or its domain identifier.

f.measure(items, **kwargs) is equivalent to f.item(items, role='m', **kwargs). See cf.Field.item for details.

See also

aux, measures, coord, ref, dim, item, remove_item,

Parameters:

items : optional

Select the cell measure whose properties satisfy the given conditions. Set as for the items parameter of cf.Field.item.

axes : optional

Select the cell measure which span at least one of the specified axes, taken in any order (as well as possibly spanning other, unspecified axes). Set as for the axes parameter of cf.Field.item.

ndim : optional

Select the cell measure whose number of data array axes satisfy the given condition. Set as for the ndim parameter of cf.Field.item.

exact : bool, optional

The exact parameter applies to the interpretation of conditions given by the items parameter. Set as for the exact parameter of cf.Field.item.

inverse : bool, optional

If True then select the cell measure other than those selected by all other criteria.

match_and : bool, optional

Set as for the match_and parameter of cf.Field.item.

strict_axes : bool, optional

The strict_axes argument applies to the interpretation of strict_axes argument. Set as for the axes parameter of cf.Field.item.

key : bool, optional

If True then return the domain’s identifier for the cell measure, rather than the cell measure itself.

Returns:

out :

The unique cell measure object or its domain identifier or, if there is not one, None.

Examples:

>>> f.measure('area')
<CF CellMeasure: area(73, 96) m 2>