cfdm.Bounds.identity

Bounds.identity(default='')[source]

Return the canonical identity.

By default the identity is the first found of the following:

  1. The standard_name property.

  2. The cf_role property, preceded by 'cf_role='.

  3. The long_name property, preceded by 'long_name='.

  4. The netCDF variable name, preceded by 'ncvar%'.

  5. The value of the default parameter.

Properties include any inherited properties.

Added in version (cfdm): 1.7.0

See also

identities

Parameters:
default: optional

If no identity can be found then return the value of the default parameter.

Returns:

The identity.

Examples

>>> f = cfdm.example_field(6)
>>> d = f.constructs('longitude').value()
>>> b = d.bounds
>>> b
<Bounds: longitude(2, 3, 4) degrees_east>
>>> b.identity()
'longitude'