cf.AncillaryVariables.match

AncillaryVariables.match(match=None, items=None, rank=None, ndim=None, exact=False, match_all=True, inverse=False)

Test whether or not each field satisfies the given conditions.

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

See cf.Field.match for details.

Parameters:

match : optional

Set conditions on the field property values. See cf.Field.match for details.

coord : optional

csize : dict, optional

A dictionary which identifies coordinate objects of the fields with corresponding tests on their cell sizes. See cf.Field.match for details.

rank : int or cf.Query, optional

Specifiy a condition on the field domain ranks, where the domain rank is the number of domain axes. See cf.Field.match for details.

ndim : int or cf.Query, optional

DCH

exact : bool, optional

The exact argument applies to the interpretion of particular conditions given by values of the match argument and by keys of the cvalue and csize arguments. See cf.Field.match for details.

match_all : bool, optional

By default match_all is True and the field matches if it satisfies all of the conditions specified by all of the test types (properties, coordinate object values, coordinate object cell sizes, domain rank and data array rank). See cf.Field.match for details.

inverse : bool, optional

If True then return a field matches if it does not satisfy the given conditions. See cf.Field.match for details.

Returns:

out : cf.List of bools

For each field, True if it satisfies the given criteria, False otherwise.