cf.DomainTopology.identity

DomainTopology.identity(default='', strict=None, relaxed=False, nc_only=False, relaxed_identity=None)[source]

Return the canonical identity.

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

  • The cell type type, preceded by 'cell:'.

  • The standard_name property.

  • The id attribute, preceded by 'id%'.

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

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

  • The value of the default parameter.

Added in version 3.16.0.

See also

id, identities, long_name, cell, nc_get_variable, standard_name

Parameters:
default: optional

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

strict: bool, optional

If True then the identity is the first found of only the cell attribute, “standard_name” property or the “id” attribute.

relaxed: bool, optional

If True then the identity is the first found of only the cell attribute, the “standard_name” property, the “id” attribute, the “long_name” property or the netCDF variable name.

nc_only: bool, optional

If True then only take the identity from the netCDF variable name.

Returns:

The identity.