cfdm.Field.identity

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

Return the canonical identity.

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

  • The standard_name property.

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

  • The axis property, preceded by 'axis='.

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

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

  • The value of the default parameter.

New 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.Field()
>>> f.set_properties({'foo': 'bar',
...                   'long_name': 'Air Temperature',
...                   'standard_name': 'air_temperature'})
>>> f.nc_set_variable('tas')
>>> f.identity()
'air_temperature'
>>> f.del_property('standard_name')
'air_temperature'
>>> f.identity(default='no identity')
'air_temperature'
>>> f.identity()
'long_name=Air Temperature'
>>> f.del_property('long_name')
>>> f.identity()
'ncvar%tas'
>>> f.nc_del_variable()
'tas'
>>> f.identity()
'ncvar%tas'
>>> f.identity()
''
>>> f.identity(default='no identity')
'no identity'