cfdm.Domain.dimension_coordinates¶
-
Domain.
dimension_coordinates
(*identities, **filter_kwargs)[source]¶ Return dimension coordinate constructs.
Note that
f.dimension_coordinates(*identities, **filter_kwargs)
is equivalent tof.constructs.filter(filter_by_type=["dimension_coordinate"], filter_by_identity=identities, **filter_kwargs)
.New in version (cfdm): 1.7.0
See also
- Parameters
- identities: optional
Select dimension 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 dimension coordinate constructs are selected.
A value may be any object that can match via the
==
operator, or are.Pattern
object that matches via itssearch
method.Note that in the output of a
dump
method orprint
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.dimension_coordinates() Constructs: {}
>>> f.dimension_coordinates() Constructs: {'dimensioncoordinate0': <DimensionCoordinate: atmosphere_hybrid_height_coordinate(1) >, 'dimensioncoordinate1': <DimensionCoordinate: grid_latitude(10) degrees>, 'dimensioncoordinate2': <DimensionCoordinate: grid_longitude(9) degrees>, 'dimensioncoordinate3': <DimensionCoordinate: time(1) days since 2018-12-01 >}