easysnowdata.snow.snow_classification.load#
- easysnowdata.snow.snow_classification.load(aoi: Any = None, *, source: str | None = None, resolution: str = '10arcsec', region: str = 'GL', chunks: Any = 'easysnowdata-default', mask: bool = False, **kwargs: Any) DataArray[source]#
Load the seasonal snow classification for aoi.
- Parameters:
aoi – Any form
easysnowdata.aoi.parse_aoi()accepts.source –
"nsidc"(default, needs Earthdata Login) or"hosted-cog"(credential-free, 10 arcsec global only, location likely to change).resolution – NSIDC route only: one of
RESOLUTIONSand"GL"or"NA".region – NSIDC route only: one of
RESOLUTIONSand"GL"or"NA".chunks – Dask chunks;
Noneloads eagerly.mask –
False(default, §2.5 for categorical products) keeps the 9 (Fill) sentinel withrio.nodataset;Truemasks it to NaN.**kwargs – Passed to
rioxarray.open_rasterio.
- Returns:
xarray.DataArray–snow_class, uint8 class values with CF flag attributes foreasysnowdata.plotting.categorical().- Raises:
easysnowdata.auth.CredentialError – When the NSIDC route is asked for without Earthdata credentials; the message names
source="hosted-cog"as the credential-free route.