cf.FieldList.item

FieldList.item(items=None, role=None, axes=None, ctype=None, exact=False, inverse=False, match_all=True, rank=None, regex=False, strict_axes=False, key=False)

Return a domain item, or its domain identifier, from each field.

fl.item() is equivalent to cf.List(f.item() for f in fl).

See cf.Field.item for details.

Parameters :

items : optional

Select items whose properties satisfy the given conditions. See cf.Field.item for details.

role : (sequence of) str, optional

Select items of the given roles. See cf.Field.item for details.

ctype : (sequence of) str, optional

Select dimension and auxiliary coordinate object items of the given CF types. See cf.Field.item for details.

axes : optional

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

rank : int or cf.Comparison, optional

Select items whose ranks satisfy the given condition, where an item’s rank is the number of axes which it spans. See cf.Field.item for details.

exact : bool, optional

The exact argument applies to the interpretion of particular conditions given by values of the items argument. See cf.Field.item for details.

inverse : bool, optional

If True then select items other than those selected by all other criteria. See cf.Field.item for details.

match_all : bool, optional

The match_all argument applies to the interpretion of dictionaries given by the items argument. See cf.Field.item for details.

regex : bool, optional

By default regex is False and all strings given by values of the items argument are considered to be arbitrary abbreviations or else exact (see the exact argument). See cf.Field.item for details.

strict_axes : bool, optional

The strict_axes argument applies to the interpretion of strict_axes argument. See cf.Field.item for details.

key : bool, optional

If True then return the domain’s identifier for the item, rather than the item itself. See cf.Field.item for details.

Returns :

out : cf.List

For each field, the item or its domain identifier or, if there isn’t a unique item, None.