dctools.utilities.xarray_utils.subsample_dataset_by_indices

dctools.utilities.xarray_utils.subsample_dataset_by_indices(ds, subsample_indices=None)

Subsample an xarray Dataset using indices instead of values.

Parameters:

• ds (xr.Dataset) – Input xarray Dataset.

• subsample_indices (dict of {str: list of int or np.ndarray or slice}, optional) – Dictionary specifying which indices to keep for each dimension.

Returns:

Subsampled xarray Dataset.

Return type:

xr.Dataset

Examples

Keep only certain time and depth indices:

>>> subsample_indices = {
...     'time': [0, 2, 4, 6],      # Keep indices 0, 2, 4, 6
...     'depth': slice(0, 10, 2)   # Keep indices 0, 2, 4, 6, 8
... }
>>> ds_sub = subsample_dataset_by_indices(ds, subsample_indices)