PlasmaCalcs.tools.xarray_tools.xarray_coords.xarray_mod_coords

PlasmaCalcs.tools.xarray_tools.xarray_coords.xarray_mod_coords(array, mod=None, *, missing_ok=True, modshift=0, **mod_as_kw)

return copy of array with coords modded (via np.mod) by mod.

mod: None or dict of {coord: mod}

dict –> mod each coord by the corresponding number.

None –> provide as kwargs (mod_as_kw) instead.

mod_as_kw: if mod is None, can provide mod dict as kwargs instead. modshift: value

shift each coord by modshift before modding, then -modshift after modding.

E.g. if modshift=90, mod=180, then modded coord = np.mod(coord+90, 180)-90.

missing_ok: bool

whether it is okay if some coords are missing (if yes, skip missing coords).