xarray_unmask_var

PlasmaCalcs.tools.xarray_tools.xarray_masks.xarray_unmask_var(ds, var, mask=None, stackdim='_mask_stack', *, reindex=True, _upcast_bool=True)

unmask a single variable from a Dataset. returns a DataArray of the unmasked var.

Equivalent: xarray_unmask(ds[[‘_mask’, var]], …) if ‘_mask’ in ds.data_vars

else xarray_unmask(ds[[var]], mask=mask, …)

ds: xarray.Dataset

will unmask ds[var].

var: str

variable whose unmasked value should be returned

mask: None or xarray.DataArray

mask to use. If None, use mask stored in ds[‘_mask’].

stackdim: str, default ‘_mask_stack’

dimension along which the mask stacking occurred.

reindex: bool

whether to result.reindex_like(mask). Highly recommended, but not required…

_upcast_bool: bool

whether to upcast dtype=bool array or data_vars to int8 before unstacking.

when False, unstacking produces a dtype=object array due to the nans for missing values.

(when True, unstacking makes dtype=float32, using 0 for False, 1 for True, nan for nan.)