API Reference

This page provides an auto-generated summary of gediDB’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Top-level functions

GEDIDatabase(config[, credentials])	Manages creation and operation of global TileDB arrays for GEDI data storage.
GEDIGranule(download_path, data_info)	GEDIGranule handles the processing and management of GEDI granules, including parsing, joining, and saving the data to TileDB, as well as querying processed granules from a database.
GEDIProcessor([geometry, start_date, ...])	GEDIProcessor class is responsible for processing GEDI granules, handling metadata, and writing data into the database.
GEDIProvider([storage_type, s3_bucket, ...])	GEDIProvider class to interface with GEDI data stored in TileDB, with support for flexible storage types.

Downloading functions

GEDIDownloader()	Base class for GEDI data downloaders.
CMRDataDownloader(geom[, start_date, ...])	Downloader for GEDI granules from NASA's CMR service.
H5FileDownloader([download_path])	Safe downloader for HDF5 files using thread-local Sessions and non-streaming chunked reads to avoid SSL segfaults in threaded mode.
EarthDataAuthenticator([earth_data_dir, strict])	Handles Earthdata authentication by managing .netrc and cookie files for automated login.
CMRQuery()	Base class for constructing and handling CMR queries.

GEDI data processing functions

granule_handler(file_path)	Represents a GEDI Granule HDF5 file, providing access to metadata and beams.
GranuleParser(file[, data_info])	Base class for parsing GEDI granule data into a GeoDataFrame.
L2AGranule(file_path, field_mapping)	Represents a GEDI Level 2A granule, providing access to its beams and related data.
L2BGranule(file_path, field_mapping)	Represents a GEDI Level 2B granule, providing access to its beams and related data.
L4AGranule(file_path, field_mapping)	Represents a GEDI Level 4A granule, providing access to its beams and related data.
L4CGranule(file_path, field_mapping)	Represents a GEDI Level 4C granule, providing access to its beams and related data.
beam_handler(granule, beam, field_mapping)	Represents a single beam in a GEDI granule file, inheriting from h5py.Group.
L2ABeam(granule, beam, field_mapping)	Represents a Level 2A (L2A) GEDI beam and processes the beam data.
L2BBeam(granule, beam, field_mapping)	Represents a Level 2B (L2B) GEDI beam and processes the beam data.
L4ABeam(granule, beam, field_mapping)	Represents a Level 4A (L4A) GEDI beam and processes the beam data.
L4CBeam(granule, beam, field_mapping)	Represents a Level 4C (L4C) GEDI beam and processes the beam data.
GediNameMetadata(product, year, julian_day, ...)	Container for metadata derived from GEDI file name conventions.

TileDB functions

TileDBProvider([storage_type, s3_bucket, ...])	A base provider class for managing low-level interactions with TileDB arrays for GEDI data.
SpatialConsolidationPlan(plan_dict)
SpatialConsolidationPlanner()	Generate a spatial consolidation plan for a TileDB array.