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.

Overlaps

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.

IO

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.
xarray.load_usgs_dem	Load and merge USGS 1-meter DEM tiles based on an AOI by querying the TNM API.
xarray.load_neon_dem	Load and merge NEON LiDAR tiles (DSM, DTM, or CHM) based on an AOI by querying the NEON API.
xarray.load_noaa_dem	Process NOAA coastal lidar DEM data from S3 based on a dataset identifier and an AOI.
xarray.load_ncalm_dem	Load NCALM DEM (DTM or DSM) tiles directly from OpenTopography S3 and return as xarray DataArray.
download.download_item	Downloads a STAC item to a specified local path.
download.read_href	Open and read a STAC asset href into local memory
download.build_usgs_ept_pipeline	Finds the relevant USGS 3DEP EPT dataset for an AOI and returns a dictionary structured as a PDAL pipeline JSON to subset the data based on the AOI, without downloading point data.
download.download_usgs_dem	Download USGS 1-meter DEM tiles based on an AOI by querying the TNM API.
download.download_neon_dem	Download NEON LiDAR tiles (DSM, DTM, or CHM) based on an AOI by querying the NEON API.
download.download_noaa_dem	Download NOAA coastal lidar DEM data from S3 based on a dataset identifier and an AOI.
download.download_ncalm_dem	Download NCALM (or OpenTopo user-hosted) data from OpenTopography S3 based on a dataset identifier and an AOI.
download.fetch_lpc_tiles	Unified fetch for LPC tiles across providers: USGS, NOAA, NCALM, NEON.
download.build_usgs_ept_pipeline	Finds the relevant USGS 3DEP EPT dataset for an AOI and returns a dictionary structured as a PDAL pipeline JSON to subset the data based on the AOI, without downloading point data.
download.download_files	Download files from remote URLs (cloud storage, web servers, etc.) Used in the download_dem and fetch_lpc_tiles functions

Plot

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 2021 land cover class.

Datasets

general.Dataset

Essential metadata for supported datasets