cfdm.TiePointIndex.nc_get_interpolation_subarea_dimension

TiePointIndex.nc_get_interpolation_subarea_dimension(default=ValueError())[source]

Return the netCDF interpolation subarea dimension name.

Added in version (cfdm): 1.10.0.0

See also

nc_del_interpolation_subarea_dimension, nc_has_interpolation_subarea_dimension, nc_set_interpolation_subarea_dimension

Parameters:
default: optional

Return the value of the default parameter if the netCDF subsampled dimension name has not been set. If set to an Exception instance then it will be raised instead.

Returns:
str

The netCDF subsampled dimension name.

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