API reference#

The API reference provides an overview of public objects, functions, and methods implemented in coincident.

Search#

`search`	Perform a search for geospatial data using STAC or non-STAC APIs for a single dataset.
`cascading_search`	Perform an cascading search to find overlapping datasets acquired within specific time ranges.
`to_pystac_items`	Converts a `GeoDataFrame` to a list of PySTAC Items.
`to_geopandas`	Convert a STAC ItemCollection to a GeoDataFrame.
`wesm.read_wesm_csv`	Read WESM metadata from a remote CSV file.
`wesm.load_by_fid`	Extracts full geometry from remote WESM GPKG based on Feature ID (FID)
`wesm.get_swath_polygons`	Retrieve swath polygons from a remote URL and convert swath time to datetime.

`geographic_area`	Calculate the geographic area of each polygon in a GeoDataFrame in KM^2
`subset_by_minimum_area`	Subset a GeoDataFrame by a minimum area threshold.
`subset_by_temporal_overlap`	Subset GeoDataFrame with time intervals by a single temporal span.
`subset_by_maximum_duration`	Subset a GeoDataFrame by a maximum duration.

`sliderule.subset_gedi02a`	Subsets GEDI L2A data based on a given GeoDataFrame and optional area of interest (AOI).
`sliderule.subset_atl06`	Subset ATL06 data using provided GeoDataFrame and optional parameters.
`sliderule.process_atl06sr`	Generate Custom SlideRule ATL06 Product
`sliderule.sample_3dep`	Sample 3DEP 1-meter DEM with POINT geometries in GeoDataFrame.
`xarray.to_dataset`	Convert a GeoDataFrame to an xarray DataArray using odc.stac
`xarray.open_maxar_browse`	Open a browse image from a STAC item using the specified overview level.
`download.download_item`	Downloads a STAC item to a specified local path.

`plot_maxar_browse`	Map view of Maxar browse image from a STAC item using Matplotlib.
`plot_esa_worldcover`	Map view of ESA WorldCover data.
`plot_dem`	Map view of DEM with an option to plot a hillshade underneath
`compare_dems`	Create a panel figure comparing DEM and altimetry elevations.
`plot_altimeter_points`	Map view of laser altimeter point data with an optional hillshade background.
`boxplot_terrain_diff`	Box plots of elevation differences by terrain group for two input elevation datasets.
`hist_esa`	Histogram of elevation differences between DEMs or point data, grouped by ESA World Cover 2020 land cover class.

Essential metadata for supported datasets