cfdm.TiePointIndex.nc_set_interpolation_subarea_dimension

TiePointIndex.nc_set_interpolation_subarea_dimension(value)[source]

Set the netCDF interpolation subarea dimension name.

If there are any / (slash) characters in the netCDF name then these act as delimiters for a group hierarchy. By default, or if the name starts with a / character and contains no others, the name is assumed to be in the root group.

Added in version (cfdm): 1.10.0.0

See also

nc_del_interpolation_subarea_dimension, nc_get_interpolation_subarea_dimension, nc_has_interpolation_subarea_dimension

Parameters:
value: str

The value for the netCDF subsampled dimension name.

Returns:

None

Examples

>>> f.nc_set_interpolation_subarea_dimension('time')
>>> f.nc_has_interpolation_subarea_dimension()
True
>>> f.nc_get_interpolation_subarea_dimension()
'time'
>>> f.nc_del_interpolation_subarea_dimension()
'time'
>>> f.nc_has_interpolation_subarea_dimension()
False
>>> print(f.nc_get_interpolation_subarea_dimension(None))
None
>>> print(f.nc_del_interpolation_subarea_dimension(None))
None