cf.Field.get_construct

Field.get_construct(key, default=ValueError())[source]

Return a metadata construct.

Added in version (cfdm): 1.7.0

See also

constructs, del_construct, has_construct, set_construct

Parameters:
key: str

The key of the metadata construct.

Parameter example:

key='domainaxis1'

default: optional

Return the value of the default parameter if the construct does not exist.

If set to an Exception instance then it will be raised instead.

Returns:

The metadata construct.

Examples

>>> f.constructs()
{'auxiliarycoordinate0': <CF AuxiliaryCoordinate: latitude(10, 9) degree_N>,
 'auxiliarycoordinate1': <CF AuxiliaryCoordinate: longitude(9, 10) degreeE>,
 'auxiliarycoordinate2': <CF AuxiliaryCoordinate: long_name:greek_letters(10) >,
 'coordinatereference1': <CF CoordinateReference: rotated_latitude_longitude>,
 'dimensioncoordinate1': <CF DimensionCoordinate: grid_latitude(10) degrees>,
 'dimensioncoordinate2': <CF DimensionCoordinate: grid_longitude(9) degrees>,
 'domainaxis1': <CF DomainAxis: 10>,
 'domainaxis2': <CF DomainAxis: 9>}
>>> f.get_construct('dimensioncoordinate1')
<CF DimensionCoordinate: grid_latitude(10) degrees>