cfdm.CellMeasure.identities

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

Return all possible identities.

The identities comprise:

  • The measure property, preceded by 'measure:'.

  • The standard_name property.

  • All properties, preceded by the property name and a colon, e.g. 'long_name:Air temperature'.

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

New 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.

New in version (cfdm): 1.8.9.0

kwargs: optional

Additional configuration parameters. Currently none. Unrecognised parameters are ignored.

New in version (cfdm): 1.8.9.0

Returns
list or generator

The identities.

Examples:

>>> f = cfdm.example_field(1)
>>> c = f.get_construct('cellmeasure0')
>>> c.get_measure()
'area'
>>> c.properties()
{'units': 'km2'}
>>> c.nc_get_variable()
'cell_measure'
>>> c.identities()
['measure:area', 'units=km2', 'ncvar%cell_measure']
>>> for i in c.identities(generator=True):
...     print(i)
...
measure:area
units=km2
ncvar%cell_measure