cfdm.TiePointIndex.nc_subsampled_dimension_groups

TiePointIndex.nc_subsampled_dimension_groups()

Return the netCDF subsampled dimension group hierarchy.

The group hierarchy is defined by the netCDF name. Groups are delimited by / (slash) characters in the netCDF name. The groups are returned, in hierarchical order, as a sequence of strings. If the name is not set, or contains no / characters then an empty sequence is returned, signifying the root group.

Added in version (cfdm): 1.10.0.0

See also

nc_clear_subsampled_dimension_groups, nc_set_subsampled_dimension_groups

Returns:

tuple of str

The group structure.

Examples

>>> f.nc_set_subsampled_dimension('element')
>>> f.nc_subsampled_dimension_groups()
()
>>> f.nc_set_subsampled_dimension_groups(['forecast', 'model'])
>>> f.nc_subsampled_dimension_groups()
('forecast', 'model')
>>> f.nc_get_subsampled_dimension()
'/forecast/model/element'
>>> f.nc_clear_subsampled_dimension_groups()
('forecast', 'model')
>>> f.nc_get_subsampled_dimension()
'element'

>>> f.nc_set_subsampled_dimension('/forecast/model/element')
>>> f.nc_subsampled_dimension_groups()
('forecast', 'model')
>>> f.nc_del_subsampled_dimension('/forecast/model/element')
'/forecast/model/element'
>>> f.nc_subsampled_dimension_groups()
()