cfdm.Field.auxiliary_coordinates

Field.auxiliary_coordinates(*identities, **filter_kwargs)

Return auxiliary coordinate constructs.

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

New in version (cfdm): 1.7.0

See also

constructs, auxiliary_coordinate

Parameters

identities: optional

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

If no identities are provided then all auxiliary coordinate 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

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

>>> f.auxiliary_coordinates()
Constructs:
{'auxiliarycoordinate0': <AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
 'auxiliarycoordinate1': <AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
 'auxiliarycoordinate2': <AuxiliaryCoordinate: long_name:Grid latitude name(10) >}