# 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.SearchQuery.md#s1bursts.query.SearchQuery)  
Query parameters for searching Sentinel-1 bursts via the CDSE API.

[time_range.TimeRange](time_range.TimeRange.md#s1bursts.time_range.TimeRange)  
An inclusive window of calendar days, `start` through `end`.

[catalog.BurstCatalog](catalog.BurstCatalog.md#s1bursts.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](burst.Burst.md#s1bursts.burst.Burst)  
Represents a single Sentinel-1 burst.

[burst.BurstPair](burst.BurstPair.md#s1bursts.burst.BurstPair)  
Represents a pair of Sentinel-1 bursts for interferometric processing.

[burst.BurstCollection](burst.BurstCollection.md#s1bursts.burst.BurstCollection)  
Collection of Sentinel-1 bursts with geospatial and temporal data.

[burst.BurstPairCollection](burst.BurstPairCollection.md#s1bursts.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](processor.BurstProcessor.md#s1bursts.processor.BurstProcessor)  
Batch processor for Sentinel-1 bursts and burst pairs.

[snap_client.SNAPConfig](snap_client.SNAPConfig.md#s1bursts.snap_client.SNAPConfig)  
Runtime configuration for SNAP GPT processing.

[snap_client.SNAPClient](snap_client.SNAPClient.md#s1bursts.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](snap_graph.RTCConfig.md#s1bursts.snap_graph.RTCConfig)  
Configuration for terrain-flattened backscatter (RTC).

[snap_graph.GTCConfig](snap_graph.GTCConfig.md#s1bursts.snap_graph.GTCConfig)  
Configuration for geocoded backscatter (GTC).

[snap_graph.CoherenceConfig](snap_graph.CoherenceConfig.md#s1bursts.snap_graph.CoherenceConfig)  
Configuration for the coherence pipeline.

[snap_graph.BackscatterConfig](snap_graph.BackscatterConfig.md#s1bursts.snap_graph.BackscatterConfig)  
Settings shared by the backscatter pipelines, RTC and GTC.

[snap_graph.GeocodingConfig](snap_graph.GeocodingConfig.md#s1bursts.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](filemanager.FileManager.md#s1bursts.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](resolution_weighter.ResolutionWeighter.md#s1bursts.resolution_weighter.ResolutionWeighter)  
Compute LRW and per-pass composites for Sentinel-1 products.

[MGRSGrid](MGRSGrid.md#s1bursts.MGRSGrid)  
The 10 km MGRS squares intersecting an area of interest.

[MGRSGeoBox](MGRSGeoBox.md#s1bursts.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](product.RTCProduct.md#s1bursts.product.RTCProduct)  
Radiometrically Terrain Corrected (RTC) backscatter product.

[product.GTCProduct](product.GTCProduct.md#s1bursts.product.GTCProduct)  
Geometrically Terrain Corrected (GTC) backscatter product.

[product.CoherenceProduct](product.CoherenceProduct.md#s1bursts.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](product.RTCLRWComposite.md#s1bursts.product.RTCLRWComposite)  
Locally resolution weighted RTC intensity composite.

[product.CohLRWComposite](product.CohLRWComposite.md#s1bursts.product.CohLRWComposite)  
Locally resolution weighted coherence composite.

[product.RTCPassComposite](product.RTCPassComposite.md#s1bursts.product.RTCPassComposite)  
Unweighted temporal mean composite for a single pass direction.

[product.CohPassComposite](product.CohPassComposite.md#s1bursts.product.CohPassComposite)  
Unweighted temporal mean coherence composite for a single pass direction.

[product.GTCPassComposite](product.GTCPassComposite.md#s1bursts.product.GTCPassComposite)  
Unweighted temporal composite of GTC beta0 for a single pass direction.

[product.Layer](product.Layer.md#s1bursts.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.OperationSummary.md#s1bursts.summary.OperationSummary)  
Summary of batch operation results (processing, downloading, etc.).

[summary.OkResult](summary.OkResult.md#s1bursts.summary.OkResult)  
Successful or skipped operation result.

[summary.ErrorResult](summary.ErrorResult.md#s1bursts.summary.ErrorResult)  
Failed operation result.

[errors.S1BurstsError](errors.S1BurstsError.md#s1bursts.errors.S1BurstsError)  
Base class for all s1bursts errors.

[errors.OperationFailedError](errors.OperationFailedError.md#s1bursts.errors.OperationFailedError)  
Items of a batch download or processing run failed.

[errors.ConfigurationError](errors.ConfigurationError.md#s1bursts.errors.ConfigurationError)  
Invalid or missing configuration or environment.

[errors.TransformationGridError](errors.TransformationGridError.md#s1bursts.errors.TransformationGridError)  
A PROJ grid needed for a DEM's vertical conversion is missing or could not be downloaded.

[errors.BurstMapUnavailableError](errors.BurstMapUnavailableError.md#s1bursts.errors.BurstMapUnavailableError)  
The Sentinel-1 burst-ID map is needed but not downloaded or unreadable.

[errors.CatalogError](errors.CatalogError.md#s1bursts.errors.CatalogError)  
A CDSE catalog request failed, or its response cannot be used.

[errors.TooManyResultsError](errors.TooManyResultsError.md#s1bursts.errors.TooManyResultsError)  
More bursts match a search than one catalog request returns.

[errors.BurstNotInMapError](errors.BurstNotInMapError.md#s1bursts.errors.BurstNotInMapError)  
A burst's `(burst_id, sub_swath)` is not in the Sentinel-1 burst-ID map.

[errors.ProductSettingsMismatchError](errors.ProductSettingsMismatchError.md#s1bursts.errors.ProductSettingsMismatchError)  
An existing product was made with other settings than requested.

[errors.BurstError](errors.BurstError.md#s1bursts.errors.BurstError)  
Base class for recoverable, per-item burst failures.

[errors.BurstNotFoundError](errors.BurstNotFoundError.md#s1bursts.errors.BurstNotFoundError)  
A requested burst or its parent product is not available at the source.

[errors.BurstDownloadError](errors.BurstDownloadError.md#s1bursts.errors.BurstDownloadError)  
Downloading or extracting a single burst failed.

[errors.NoUTMZoneError](errors.NoUTMZoneError.md#s1bursts.errors.NoUTMZoneError)  
A burst's footprint lies outside the UTM zones, so `crs="auto"` has none for it.

[errors.SnapProcessingError](errors.SnapProcessingError.md#s1bursts.errors.SnapProcessingError)  
Processing a single burst or burst pair with SNAP failed.

[errors.CompositeError](errors.CompositeError.md#s1bursts.errors.CompositeError)  
Compositing one grid cell failed; another cell may still succeed.

[errors.EmptyCompositeError](errors.EmptyCompositeError.md#s1bursts.errors.EmptyCompositeError)  
No input observation has a valid pixel in the target cell.

[errors.InconsistentInputsError](errors.InconsistentInputsError.md#s1bursts.errors.InconsistentInputsError)  
The input products passed to `compose_*` cannot be composited together.

[errors.CompositeInputError](errors.CompositeInputError.md#s1bursts.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()](burstmap.download_burst_map.md#s1bursts.burstmap.download_burst_map)  
Download and prepare the Sentinel-1 burst-ID map for a given acquisition mode.

[burstmap.Sentinel1Bursts](burstmap.Sentinel1Bursts.md#s1bursts.burstmap.Sentinel1Bursts)  
Sentinel-1 Burst ID map.

[dem.prepare_dem_for_snap()](dem.prepare_dem_for_snap.md#s1bursts.dem.prepare_dem_for_snap)  
Return an external DEM prepared for SNAP's sampling and height conventions.

[cdse.CDSEAuth](cdse.CDSEAuth.md#s1bursts.cdse.CDSEAuth)  
CDSE authentication handler using OpenIDConnect bearer tokens.

[cdse.CDSEBurstClient](cdse.CDSEBurstClient.md#s1bursts.cdse.CDSEBurstClient)  
Client for searching and downloading Sentinel-1 bursts from CDSE using the OData API.

[cdse.CDSEResponse](cdse.CDSEResponse.md#s1bursts.cdse.CDSEResponse)  
Response object for Sentinel-1 burst search operations.

[burst_extractor.extract_burst_from_s3()](burst_extractor.extract_burst_from_s3.md#s1bursts.burst_extractor.extract_burst_from_s3)  
Extract a single Sentinel-1 SLC burst from CDSE S3.

[snap_graph.xml_to_mermaid()](snap_graph.xml_to_mermaid.md#s1bursts.snap_graph.xml_to_mermaid)  
Convert a SNAP GPT XML processing graph (string) to a Mermaid script.

[snap_graph.build_backscatter_graph()](snap_graph.build_backscatter_graph.md#s1bursts.snap_graph.build_backscatter_graph)  
Emit the SNAP GPT XML for the backscatter (RTC or GTC) pipeline.

[snap_graph.build_coherence_graph()](snap_graph.build_coherence_graph.md#s1bursts.snap_graph.build_coherence_graph)  
Single-shot SLC→Coherence→Terrain-Correction graph.