easysnowdata.remote_sensing.get_seasonal_mountain_snow_mask#

easysnowdata.remote_sensing.get_seasonal_mountain_snow_mask(bbox_input: GeoDataFrame | tuple | BaseGeometry | None = None, data_product: str = 'mountain_snow', mask_nodata: bool = False, **kwargs) → DataArray[source]#

Deprecated since version 0.1.0: easysnowdata.remote_sensing.get_seasonal_mountain_snow_mask is deprecated since easysnowdata 0.1.0 and will be removed in 0.3.0. Use easysnowdata.snow.mountain_snow_mask.load instead. The archive is cached after the first call, the clouds layer is reachable with layer=’clouds’, and the class table is CF flag attrs.

Fetches ~1km static global seasonal (mountain snow / snow) mask for a given bounding box.

Deprecated since version 0.1.0: Use easysnowdata.snow.mountain_snow_mask.load(), whose layer= also reaches the clouds layer and which caches the Zenodo archive instead of re-reading it on every call.

Parameters:

  • bbox_input (geopandas.GeoDataFrame or tuple or shapely.Geometry) – GeoDataFrame containing the bounding box, or a tuple of (xmin, ymin, xmax, ymax), or a Shapely geometry.

  • data_product (str, optional) – Data product to fetch. Choose from ‘snow’ or ‘mountain_snow’. Default is ‘mountain_snow’.

  • mask_nodata (bool, optional) – Whether to mask no data values. Default is False. If False: (dtype=uint8, rio.nodata=255, rio.encoded_nodata=None) If True: (dtype=float32, rio.nodata=nan, rio.encoded_nodata=255)

  • **kwargs – Additional keyword arguments passed to easysnowdata.snow.mountain_snow_mask.load() (and on to rioxarray.open_rasterio).

Returns:

xarray.DataArray – Mountain snow DataArray with CF flag attributes.

Notes

Data citation: Wrzesien, M., Pavelsky, T., Durand, M., Lundquist, J., & Dozier, J. (2019). Global Seasonal Mountain Snow Mask from MODIS MOD10A2 [Data set]. Zenodo. https://doi.org/10.5281/zenodo.2626737