xarray_store_mask

PlasmaCalcs.tools.xarray_tools.xarray_masks.xarray_store_mask(array, mask)

return Dataset like input but containing data_var ‘_mask’.

crash with DimensionKeyError if ‘_mask’ already exists in input.

if mask.dims not already in array.dims, rename mask dims d to ‘_mask_{d}’.

(this will occur when storing mask in a stacked result,

because the stacked result will have stackdim instead of mask dims.)

array: xarray.DataArray or xarray.Dataset

if DataArray, will be converted to Dataset with data_var array.name.