sertit.rasters.get_nodata_mask

get_nodata_mask(xds: Union[xarray.core.dataset.Dataset, xarray.core.dataarray.DataArray]) numpy.ndarray[source]

Get nodata mask from a xarray.

>>> diag_arr = xr.DataArray(data=np.diag([1, 2, 3]))
>>> diag_arr.rio.write_nodata(0, inplace=True)
<xarray.DataArray (dim_0: 3, dim_1: 3)>
array([[1, 0, 0],
       [0, 2, 0],
       [0, 0, 3]])
Dimensions without coordinates: dim_0, dim_1

>>> get_nodata_mask(diag_arr)
array([[1, 0, 0],
       [0, 1, 0],
       [0, 0, 1]], dtype=uint8)
Parameters

xds (XDS_TYPE) – Array to evaluate

Returns

Pixelwise nodata array

Return type

np.ndarray