cf.CellMeasure.name¶
-
CellMeasure.name(default=None, identity=False, ncvar=False)[source]¶ Return a name for the cell measure.
By default the name is the first found of the following:
- The
measureattribute. - The
standard_nameCF property. - The
idattribute. - The
long_nameCF property, preceeded by the string'long_name:'. - The
ncvarattribute, preceeded by the string'ncvar:'. - The value of the default parameter.
Note that
c.name(identity=True)is equivalent toc.identity().See also
Parameters: - default : optional
If no name can be found then return the value of the default parameter. By default the default is None.
- identity : bool, optional
If True then 3. and 4. are not considered as possible names.
- ncvar : bool, optional
If True then 1., 2., 3. and 4. are not considered as possible names.
Returns: - out : str
A name for the cell measure.
Examples: >>> f.standard_name = 'air_temperature' >>> f.long_name = 'temperature of the air' >>> f.ncvar = 'tas' >>> f.name() 'air_temperature' >>> del f.standard_name >>> f.name() 'long_name:temperature of the air' >>> del f.long_name >>> f.name() 'ncvar:tas' >>> del f.ncvar >>> f.name() None >>> f.name('no_name') 'no_name' >>> f.standard_name = 'air_temperature' >>> f.name('no_name') 'air_temperature'
- The