cfdm.Field.field_ancillaries

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

Return field ancillary constructs.

f.field_ancillaries(*identities, **filter_kwargs) is equivalent to f.constructs.filter(filter_by_type=["field_ancillary"], filter_by_identity=identities, **filter_kwargs).

New in version (cfdm): 1.7.0

See also

constructs, field_ancillary

Parameters
identities: optional

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

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

>>> print(f.field_ancillaries())
Constructs:
{}

>>> print(f.field_ancillaries())
Constructs:
{'cellmethod1': <CellMethod: domainaxis1: domainaxis2: mean where land (interval: 0.1 degrees)>,
 'cellmethod0': <CellMethod: domainaxis3: maximum>}

>>> f.cell_methods.ordered()
OrderedDict([('cellmethod0', <CellMethod: domainaxis1: domainaxis2: mean where land (interval: 0.1 degrees)>),
             ('cellmethod1', <CellMethod: domainaxis3: maximum>)])