easysnowdata.optical.hls.load#

easysnowdata.optical.hls.load(aoi: Any = None, time: Any = None, *, items: Any = None, bands: str | Sequence[str] | None = None, source: str | None = None, products: str | Sequence[str] | None = None, resolution: float | None = 30, crs: Any = 'utm', groupby: str = 'solar_day', mask: Any = None, scale: bool = True, mask_nodata: bool = True, cloud_cover: float | None = None, chunks: dict[str, Any] | None = None, **kwargs: Any) → Dataset[source]#

Load HLS as a lazy xarray.Dataset (time, y, x).

Both products are loaded and stacked on time, with a product coordinate (L30/S30) and a platform coordinate.

Parameters:

  • aoi – The usual spatial and temporal inputs.

  • time – The usual spatial and temporal inputs.

  • items – A search result to load instead of searching again.

  • bands – Common band names (DEFAULT_BANDS by default). Bands that exist in only one product are loaded for that product alone.

  • source – "lpcloud-cmr-stac" (default, Earthdata Login) or "planetary-computer" (credential-free mirror).

  • products – "L30", "S30" or both (default).

  • mask – None/False (default) keeps every pixel; True or "fmask-default" removes cirrus, cloud, cloud-adjacent and shadow pixels; a sequence selects Fmask flags and aerosol levels. Fmask is unreliable over snow and ice.

  • scale – Convert reflectance to 0–1 floats and the angles to degrees.

  • mask_nodata – NaN-mask the fill values and keep them as the encoded nodata.

  • resolution – Passed to odc.stac.load.

  • crs – Passed to odc.stac.load.

  • groupby – Passed to odc.stac.load.

  • chunks – Passed to odc.stac.load.

  • **kwargs – Passed to odc.stac.load.