apply_nan_mask#

rojak.core.indexing.apply_nan_mask(target_array, nan_mask, drop=False)[source]#

Replace values in target_array with NaN wherever nan_mask is True

Parameters:

  • target_array (T) – Array to mask

  • nan_mask (T) – Boolean array of where to set values to NaN. Must be broadcastable against target_array.

  • drop (bool) – If True, drop the masked-out values (via xarray.DataArray.where()’s drop argument) instead of just replacing them with NaN. Defaults to False.

Returns:

target_array with values masked by NaN wherever nan_mask is True

Return type:

T