mask#
- geowombat.mask(data, dataframe, query=None, keep='in')#
Masks a DataArray by vector polygon geometry.
- Parameters:
data (DataArray) – The
xarray.DataArray
to mask.dataframe (GeoDataFrame or str) – The
geopandas.GeoDataFrame
or filename to use for masking.query (Optional[str]) – A query to apply to
dataframe
.keep (Optional[str]) – If
keep
= ‘in’, mask values outside of the geometry (keep inside). Otherwise, ifkeep
= ‘out’, mask values inside (keep outside).
- Return type:
DataArray
- Returns:
xarray.DataArray
Examples
>>> import geowombat as gw >>> >>> with gw.open('image.tif') as ds: >>> ds = ds.gw.mask(df)