coincident.io.sliderule.subset_gedi02a#

coincident.io.sliderule.subset_gedi02a(gf, aoi=None, include_worldcover=False, include_3dep=False, sliderule_params=None)[source]#

Subsets GEDI L2A data based on a given GeoDataFrame and optional area of interest (AOI).

Parameters:
  • gf (GeoDataFrame) – A GeoDataFrame of results from coincident.search.search(dataset=’gedi’)

  • aoi (GeoDataFrame) – A GeoDataFrame with a POLYGON to subset The envelope of geometries is used to search.

  • include_worldcover (bool) – Whether to include WorldCover data in the processing. Default is False.

  • include_3dep (bool) – Whether to include 3DEP data in the processing. Default is False.

  • sliderule_params (dict[str, Any] | None) – A dictionary of additional parameters to be passed to SlideRule gedi02ax API.

Return type:

GeoDataFrame

Returns:

A GeoDataFrame containing the subsetted GEDI L2A data.

Notes

The function sets degrade_filter=True and l2_quality_filter=True by default.