API Reference

The public surface of s1bursts, grouped by the stage of the pipeline it belongs to. The top-level s1bursts namespace re-exports what a pipeline is built from; what a pipeline produces is imported from the module that defines it.

Searching and downloading

Query the CDSE burst catalog and fetch single bursts over OData or S3.

query.SearchQuery: Query parameters for searching Sentinel-1 bursts via the CDSE API.
time_range.TimeRange: An inclusive window of calendar days, start through end.
catalog.BurstCatalog: Search and download Sentinel-1 bursts from the CDSE catalog.

Burst data model

The acquisitions a search returns, and the interferometric pairs built from them.

burst.Burst: Represents a single Sentinel-1 burst.
burst.BurstPair: Represents a pair of Sentinel-1 bursts for interferometric processing.
burst.BurstCollection: Collection of Sentinel-1 bursts with geospatial and temporal data.
burst.BurstPairCollection: Collection of Sentinel-1 burst pairs for interferometric processing.

Processing

Batch SNAP GPT execution and the runtime budget it runs under.

processor.BurstProcessor: Batch processor for Sentinel-1 bursts and burst pairs.
snap_client.SNAPConfig: Runtime configuration for SNAP GPT processing.
snap_client.SNAPClient: Low-level client for SNAP GPT processing.

Graph configuration

The shape of the generated SNAP graph, one config per product type. Every config carries the shared Terrain-Correction tail parameters.

snap_graph.RTCConfig: Configuration for terrain-flattened backscatter (RTC).
snap_graph.GTCConfig: Configuration for geocoded backscatter (GTC).
snap_graph.CoherenceConfig: Configuration for the coherence pipeline.
snap_graph.BackscatterConfig: Settings shared by the backscatter pipelines, RTC and GTC.
snap_graph.GeocodingConfig: Terrain-Correction tail parameters shared by every product type.

Storage

Deterministic product paths and discovery, on local disk or S3.

filemanager.FileManager: Manages file system operations for Sentinel-1 products.

Compositing

Locally resolution weighted and per-pass composites on the 10 km squares of the MGRS grid, re-exported from freezebase.

resolution_weighter.ResolutionWeighter: Compute LRW and per-pass composites for Sentinel-1 products.
MGRSGrid: The 10 km MGRS squares intersecting an area of interest.
MGRSGeoBox: A 10 x 10 km MGRS square backed by odc.geo.GeoBox.

Single-burst products

Metadata records returned by the processing services. They describe a product; the pixels live in the GeoTIFF at its FileManager path.

product.RTCProduct: Radiometrically Terrain Corrected (RTC) backscatter product.
product.GTCProduct: Geometrically Terrain Corrected (GTC) backscatter product.
product.CoherenceProduct: Coherence product from burst pair.

Composite products

MGRS grid-square composites. Each holds its measurement and, optionally, its quality-assurance layers.

product.RTCLRWComposite: Locally resolution weighted RTC intensity composite.
product.CohLRWComposite: Locally resolution weighted coherence composite.
product.RTCPassComposite: Unweighted temporal mean composite for a single pass direction.
product.CohPassComposite: Unweighted temporal mean coherence composite for a single pass direction.
product.GTCPassComposite: Unweighted temporal composite of GTC beta0 for a single pass direction.
product.Layer: One file of a composite product: its measurement or one of its quality layers.

Results and errors

What a batch operation reports, and the exception hierarchy that separates per-item failures from environment-wide ones.

summary.OperationSummary: Summary of batch operation results (processing, downloading, etc.).
summary.OkResult: Successful or skipped operation result.
summary.ErrorResult: Failed operation result.
errors.S1BurstsError: Base class for all s1bursts errors.
errors.OperationFailedError: Items of a batch download or processing run failed.
errors.ConfigurationError: Invalid or missing configuration or environment.
errors.TransformationGridError: A PROJ grid needed for a DEM’s vertical conversion is missing or could not be downloaded.
errors.BurstMapUnavailableError: The Sentinel-1 burst-ID map is needed but not downloaded or unreadable.
errors.CatalogError: A CDSE catalog request failed, or its response cannot be used.
errors.TooManyResultsError: More bursts match a search than one catalog request returns.
errors.BurstNotInMapError: A burst’s (burst_id, sub_swath) is not in the Sentinel-1 burst-ID map.
errors.ProductSettingsMismatchError: An existing product was made with other settings than requested.
errors.BurstError: Base class for recoverable, per-item burst failures.
errors.BurstNotFoundError: A requested burst or its parent product is not available at the source.
errors.BurstDownloadError: Downloading or extracting a single burst failed.
errors.NoUTMZoneError: A burst’s footprint lies outside the UTM zones, so crs="auto" has none for it.
errors.SnapProcessingError: Processing a single burst or burst pair with SNAP failed.
errors.CompositeError: Compositing one grid cell failed; another cell may still succeed.
errors.EmptyCompositeError: No input observation has a valid pixel in the target cell.
errors.InconsistentInputsError: The input products passed to compose_* cannot be composited together.
errors.CompositeInputError: An input product of a cell is missing or cannot be read.

Reference data and low-level access

The optional SAR-MPC burst-ID map, external-DEM preparation, and the CDSE clients the high-level services are built on.

burstmap.download_burst_map(): Download and prepare the Sentinel-1 burst-ID map for a given acquisition mode.
burstmap.Sentinel1Bursts: Sentinel-1 Burst ID map.
dem.prepare_dem_for_snap(): Return an external DEM prepared for SNAP’s sampling and height conventions.
cdse.CDSEAuth: CDSE authentication handler using OpenIDConnect bearer tokens.
cdse.CDSEBurstClient: Client for searching and downloading Sentinel-1 bursts from CDSE using the OData API.
cdse.CDSEResponse: Response object for Sentinel-1 burst search operations.
burst_extractor.extract_burst_from_s3(): Extract a single Sentinel-1 SLC burst from CDSE S3.
snap_graph.xml_to_mermaid(): Convert a SNAP GPT XML processing graph (string) to a Mermaid script.
snap_graph.build_backscatter_graph(): Emit the SNAP GPT XML for the backscatter (RTC or GTC) pipeline.
snap_graph.build_coherence_graph(): Single-shot SLC→Coherence→Terrain-Correction graph.