cf.DomainAxis.identities

DomainAxis.identities(generator=False, **kwargs)[source]

Return all possible identities.

The identities comprise:

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

Added in version (cfdm): 1.7.0

See also

identity

Parameters:
generator: bool, optional

If True then return a generator for the identities, rather than a list.

Added in version (cfdm): 1.8.9.0

kwargs: optional

Additional configuration parameters that may be used by subclasses.

Added in version (cfdm): 1.8.9.0

Returns:
list or generator

The identities.

Examples

>>> d = cf.DomainAxis(size=9)
>>> d.nc_set_dimension('time')
>>> d.identities()
['ncdim%time']
>>> d.nc_del_dimension()
'time'
>>> d.identities()
[]
>>> for i in d.identities(generator=True):
...     print(i)
...