cf.DomainAxis.identity

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

Return the canonical identity.

The identity is the first found of the following:

  1. The netCDF dimension name, preceeded by ‘ncdim%’.

  2. The value of the default parameter.

New in version 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:

>>> d.nc_get_dimension()
'time'
>>> d.identity()
'ncdim%time'
>>> d.identity(default='no identity')
'ncdim%time'
>>> d.nc_del_dimension()
'time'
>>> d.identity()
''
>>> d.identity(default='no identity')
'no identity'