healpix_convolution.xarray.convolve

Contents

healpix_convolution.xarray.convolve#

healpix_convolution.xarray.convolve(ds, kernel, *, dim='cells', mode='constant', constant_value=0)#

convolve data on a DGGS grid

Parameters:

  • ds (xarray.Dataset) – The input data. Must be compatible with xdggs.

  • kernel (xarray.DataArray) – The sparse kernel matrix.

  • dim (str, default: "cells") – The input dimension name. Will also be the output dimension name.

  • mode (str, default: "constant") – Mode used to pad the array before convolving. Only used for regional maps. See pad() for a list of available modes.

  • constant_values (int or float, default: 0) – The constant value to pad with when mode is "constant".

Returns:

convolved (xarray.Dataset) – The result of the convolution.

See also

healpix_convolution.xarray.pad, healpix_convolution.pad

Contents