PlasmaCalcs.tools.xarray_tools.xarray_sci.xarray_gaussian_filter

PlasmaCalcs.tools.xarray_tools.xarray_sci.xarray_gaussian_filter(array, dim=None, sigma=None, *, promote_dims_if_needed=True, missing_dims='raise', **kw_scipy_gaussian_filter)

returns array after applying scipy.ndimage.gaussian_filter to it.

array: xarray.DataArray or Dataset

filters this array, or each data_var in a dataset.

dim: None or str or iterable of strs

dimensions to filter along.

if None, filter along all dims.

sigma: None, number, or iterable of numbers

standard deviation for Gaussian kernel.

if iterable, must have same length as dim.

if None, will use DEFAULTS.GAUSSIAN_FILTER_SIGMA (default: 1.0).

promote_dims_if_needed: bool

whether to promote non-dimension coords to dimensions.

if False, raise DimensionKeyError if any relevant coord is not already a dimension.

missing_dims: str in (‘ignore’, ‘warn’, ‘raise’)

what to do if any coord is not found:

‘ignore’ –> do nothing.

‘warn’ –> raise a warning.

‘raise’ –> raise DimensionKeyError.

additional kwargs go to scipy.ndimage.gaussian_filter.