cf.CoordinateBounds.name¶
-
CoordinateBounds.name(default=None, identity=False, ncvar=False)[source]¶ Return a name.
By default the name is the first found of the following:
- The
standard_nameCF property. - The
long_nameCF property, preceeded by the string'long_name:'. - The
idattribute. - The
ncvarattribute, preceeded by the string'ncvar%'. - The value of the default parameter.
Note that
f.name(identity=True)is equivalent tof.identity().See also
Examples 1: >>> n = f.name() >>> n = f.name(default='NO NAME'))
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 only 1., 3. and 5. are considered as possible names.
- ncvar : bool, optional
If True then only 4. and 5. are considered as possible names.
Returns: - out :
The name.
Examples 2: >>> 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