cfdm.Field.cell_methods

Field.cell_methods(*identities, **filter_kwargs)[source]

Return cell method constructs.

New in version (cfdm): 1.7.0

See also

constructs, cell_method

Parameters
identities: optional

Select cell method constructs that have an identity, defined by their identities methods, that matches any of the given values.

Additionally, the values are matched against construct identifiers, with or without the 'key%' prefix.

Additionally, if for a given value, f.domain_axes(value) returns a unique domain axis construct then any cell method constructs that span exactly that axis are selected. See domain_axes for details.

If no values are provided then all cell method constructs are selected.

A value may be any object that can match via the

== operator, or a re.Pattern object that matches via its search method.

Note that in the output of a dump method or print

call, a construct is always described by an identity that will select it.

filter_kwargs: optional

Keyword arguments as accepted by Constructs.filter that define additional construct selection criteria. Also to configure the returned value.

New in version (cfdm): 1.8.9.0

Returns

The selected constructs in a new Constructs object, unless modified by any filter_kwargs parameters. The returned object will contain no constructs if none were selected.

Examples