cf.Field.domain_ancillaries

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

Return domain ancillary constructs.

Note that f.domain_ancillaries(*identities, **filter_kwargs) is equivalent to f.constructs.filter(filter_by_type=["domain_ancillary"], filter_by_identity=identities, **filter_kwargs).

New in version (cfdm): 1.7.0

See also

constructs, domain_ancillary

Parameters
identities: optional

Select domain 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

>>> f.domain_ancillaries()
Constructs:
{}

>>> f.domain_ancillaries()
Constructs:
{'domainancillary0': <CF DomainAncillary: ncvar%a(1) m>,
 'domainancillary1': <CF DomainAncillary: ncvar%b(1) >,
 'domainancillary2': <CF DomainAncillary: surface_altitude(10, 9) m>}