read_mask

mhm_tools.pre.fill_nearest.read_mask(mask_file, mask_var)

Read a fixed output mask from a NetCDF variable.

Parameters:

• mask_file (str or pathlib.Path or None) – NetCDF file containing the mask variable. If omitted, no mask is used.

• mask_var (str or None) – Variable whose NaN cells define masked output cells. If omitted, no mask is used.

Returns:

Boolean array with true values where output cells must remain masked, or None when masking is disabled.

Return type:

numpy.ndarray or None