xarray.Dataset.cumprod

Dataset.cumprod(dim=None, keep_attrs=False, skipna=None, **kwargs)

Apply cumprod along some dimension of Dataset.

Parameters:

dim : str or sequence of str, optional

Dimension over which to apply cumprod.

axis : int or sequence of int, optional

Axis over which to apply cumprod. Only one of the ‘dim’ and ‘axis’ arguments can be supplied.

skipna : bool, optional

If True, skip missing values (as marked by NaN). By default, only skips missing values for float dtypes; other dtypes either do not have a sentinel missing value (int) or skipna=True has not been implemented (object, datetime64 or timedelta64).

keep_attrs : bool, optional

If True, the attributes (attrs) will be copied from the original object to the new one. If False (default), the new object will be returned without attributes.

**kwargs : dict

Additional keyword arguments passed on to cumprod.

Returns:

cumvalue : Dataset

New Dataset object with cumprod applied to its data along the indicated dimension.