healpix_convolution.kernels.gaussian_kernel

healpix_convolution.kernels.gaussian_kernel#

healpix_convolution.kernels.gaussian_kernel(cell_ids, *, grid_info, sigma, truncate=4.0, kernel_size=None, weights_threshold=None)#

construct a gaussian kernel on the healpix grid

Parameters:

  • cell_ids (array-like) – The cell ids.

  • grid_info (xdggs.HealpixInfo) – The grid parameters.

  • sigma (float) – The standard deviation of the gaussian function in radians.

  • truncate (float, default: 4.0) – Truncate the kernel after this many multiples of sigma.

  • kernel_size (int, optional) – If given, will be used instead of truncate to determine the size of the kernel.

  • weights_threshold (float, optional) – If given, drop all kernel weights whose absolute value is smaller than this threshold.

Returns:

kernel (sparse.COO) – The constructed kernel

Notes

no dask support, yet

Contents