cfdm.Constructs.domain_axis_identity

Constructs.domain_axis_identity(key)[source]

Return the canonical identity for a domain axis construct.

The identity is the first found of the following:

  1. The canonical identity of a dimension coordinate construct that span the domain axis construct.

  2. The identity of a one-dimensional auxiliary coordinate construct that spans the domain axis construct. This will either be the value of a standard_name, cf_role (preceded by 'cf_role=') or axis (preceded by 'axis=') property, as appropriate.

  3. The netCDF dimension name, preceded by ‘ncdim%’.

  4. The domain axis construct key, preceded by ‘key%’.

Parameters
key: str

The construct key for the domain axis construct.

Parameter example:

key='domainaxis2'

Returns
str

The identity.

Examples:

>>> c.domain_axis_identity('domainaxis1')
'longitude'
>>> c.domain_axis_identity('domainaxis2')
'axis=Y'
>>> c.domain_axis_identity('domainaxis3')
'cf_role=timeseries_id'
>>> c.domain_axis_identity('domainaxis4')
'key%domainaxis4')