dctools.utilities.xarray_utils.subsample_dataset_uniform

dctools.utilities.xarray_utils.subsample_dataset_uniform(ds, subsample_steps=None)

Uniformly subsample an xarray Dataset using a specified step size for each dimension.

Parameters:

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

• subsample_steps (dict of {str: int}, optional) – Dictionary specifying the step size for each dimension. For example, {‘time’: 2, ‘depth’: 3} will keep every 2nd time value and every 3rd depth value.

Returns:

Subsampled xarray Dataset.

Return type:

xr.Dataset

Examples

Take every 2nd time value, every 3rd depth value, and every 4th latitude and longitude value:

>>> subsample_steps = {
...     'time': 2,
...     'depth': 3,
...     'lat': 4,
...     'lon': 4
... }
>>> ds_sub = subsample_dataset_uniform(ds, subsample_steps)