cf.Domain.aux_coords

Domain.aux_coords(dim=None)[source]

Return a dictionary whose values are the auxiliary coordinates which span the given dimension and keys of the domain’s auxiliary coordinate identifiers.

Parameters :
dim : str, optional

The identifier of the dimension to be spanned. By default all dimensions are considered (so all auxiliary coordinates are returned).

Returns :
out : dict

The auxiliary coordinates and their identifiers.

Examples

>>> d.dimensions
{'data': ['dim0', 'dim1', 'dim2'],
 'dim0': ['dim0'],
 'dim1': ['dim1'],
 'dim2': ['dim2'],
 'dim3': ['dim3'],
 'aux0': ['dim1', 'dim2'],
 'aux1': ['dim0'],
 'aux2': ['dim2', 'dim1']}
>>> d.aux_coords()
{'aux0': <CF Coordinate: ...>,
 'aux1': <CF Coordinate: ...>,
 'aux2': <CF Coordinate: ...>}
>>> d.aux_coords('dim2')
{'aux0': <CF Coordinate: ...>,
 'aux2': <CF Coordinate: ...>}
>>> d.aux_coords('dim3')
{}

Previous topic

cf.Domain.analyse

Next topic

cf.Domain.cell_measures

This Page