# s1bursts

> Sentinel-1 download, processing and compositing in Python.

## Docs

### API Reference

#### Searching and downloading
> Query the CDSE burst catalog and fetch single bursts over OData or S3.

- [query.SearchQuery](https://lqgentner.github.io/s1bursts/reference/query.SearchQuery.html)
- [time_range.TimeRange](https://lqgentner.github.io/s1bursts/reference/time_range.TimeRange.html)
- [catalog.BurstCatalog](https://lqgentner.github.io/s1bursts/reference/catalog.BurstCatalog.html)

#### Burst data model
> The acquisitions a search returns, and the interferometric pairs built from them.

- [burst.Burst](https://lqgentner.github.io/s1bursts/reference/burst.Burst.html)
- [burst.BurstPair](https://lqgentner.github.io/s1bursts/reference/burst.BurstPair.html)
- [burst.BurstCollection](https://lqgentner.github.io/s1bursts/reference/burst.BurstCollection.html)
- [burst.BurstPairCollection](https://lqgentner.github.io/s1bursts/reference/burst.BurstPairCollection.html)

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

- [processor.BurstProcessor](https://lqgentner.github.io/s1bursts/reference/processor.BurstProcessor.html)
- [snap_client.SNAPConfig](https://lqgentner.github.io/s1bursts/reference/snap_client.SNAPConfig.html)
- [snap_client.SNAPClient](https://lqgentner.github.io/s1bursts/reference/snap_client.SNAPClient.html)

#### 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](https://lqgentner.github.io/s1bursts/reference/snap_graph.RTCConfig.html)
- [snap_graph.GTCConfig](https://lqgentner.github.io/s1bursts/reference/snap_graph.GTCConfig.html)
- [snap_graph.CoherenceConfig](https://lqgentner.github.io/s1bursts/reference/snap_graph.CoherenceConfig.html)
- [snap_graph.BackscatterConfig](https://lqgentner.github.io/s1bursts/reference/snap_graph.BackscatterConfig.html)
- [snap_graph.GeocodingConfig](https://lqgentner.github.io/s1bursts/reference/snap_graph.GeocodingConfig.html)

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

- [filemanager.FileManager](https://lqgentner.github.io/s1bursts/reference/filemanager.FileManager.html)

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

- [resolution_weighter.ResolutionWeighter](https://lqgentner.github.io/s1bursts/reference/resolution_weighter.ResolutionWeighter.html)
- [MGRSGrid](https://lqgentner.github.io/s1bursts/reference/MGRSGrid.html): The 10 km MGRS squares intersecting an area of interest
- [MGRSGeoBox](https://lqgentner.github.io/s1bursts/reference/MGRSGeoBox.html): 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](https://lqgentner.github.io/s1bursts/reference/product.RTCProduct.html)
- [product.GTCProduct](https://lqgentner.github.io/s1bursts/reference/product.GTCProduct.html)
- [product.CoherenceProduct](https://lqgentner.github.io/s1bursts/reference/product.CoherenceProduct.html)

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

- [product.RTCLRWComposite](https://lqgentner.github.io/s1bursts/reference/product.RTCLRWComposite.html)
- [product.CohLRWComposite](https://lqgentner.github.io/s1bursts/reference/product.CohLRWComposite.html)
- [product.RTCPassComposite](https://lqgentner.github.io/s1bursts/reference/product.RTCPassComposite.html)
- [product.CohPassComposite](https://lqgentner.github.io/s1bursts/reference/product.CohPassComposite.html)
- [product.GTCPassComposite](https://lqgentner.github.io/s1bursts/reference/product.GTCPassComposite.html)
- [product.Layer](https://lqgentner.github.io/s1bursts/reference/product.Layer.html)

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

- [summary.OperationSummary](https://lqgentner.github.io/s1bursts/reference/summary.OperationSummary.html)
- [summary.OkResult](https://lqgentner.github.io/s1bursts/reference/summary.OkResult.html)
- [summary.ErrorResult](https://lqgentner.github.io/s1bursts/reference/summary.ErrorResult.html)
- [errors.S1BurstsError](https://lqgentner.github.io/s1bursts/reference/errors.S1BurstsError.html)
- [errors.OperationFailedError](https://lqgentner.github.io/s1bursts/reference/errors.OperationFailedError.html)
- [errors.ConfigurationError](https://lqgentner.github.io/s1bursts/reference/errors.ConfigurationError.html)
- [errors.TransformationGridError](https://lqgentner.github.io/s1bursts/reference/errors.TransformationGridError.html)
- [errors.BurstMapUnavailableError](https://lqgentner.github.io/s1bursts/reference/errors.BurstMapUnavailableError.html)
- [errors.CatalogError](https://lqgentner.github.io/s1bursts/reference/errors.CatalogError.html)
- [errors.TooManyResultsError](https://lqgentner.github.io/s1bursts/reference/errors.TooManyResultsError.html)
- [errors.BurstNotInMapError](https://lqgentner.github.io/s1bursts/reference/errors.BurstNotInMapError.html)
- [errors.ProductSettingsMismatchError](https://lqgentner.github.io/s1bursts/reference/errors.ProductSettingsMismatchError.html)
- [errors.BurstError](https://lqgentner.github.io/s1bursts/reference/errors.BurstError.html)
- [errors.BurstNotFoundError](https://lqgentner.github.io/s1bursts/reference/errors.BurstNotFoundError.html)
- [errors.BurstDownloadError](https://lqgentner.github.io/s1bursts/reference/errors.BurstDownloadError.html)
- [errors.NoUTMZoneError](https://lqgentner.github.io/s1bursts/reference/errors.NoUTMZoneError.html)
- [errors.SnapProcessingError](https://lqgentner.github.io/s1bursts/reference/errors.SnapProcessingError.html)
- [errors.CompositeError](https://lqgentner.github.io/s1bursts/reference/errors.CompositeError.html)
- [errors.EmptyCompositeError](https://lqgentner.github.io/s1bursts/reference/errors.EmptyCompositeError.html)
- [errors.InconsistentInputsError](https://lqgentner.github.io/s1bursts/reference/errors.InconsistentInputsError.html)
- [errors.CompositeInputError](https://lqgentner.github.io/s1bursts/reference/errors.CompositeInputError.html)

#### 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](https://lqgentner.github.io/s1bursts/reference/burstmap.download_burst_map.html)
- [burstmap.Sentinel1Bursts](https://lqgentner.github.io/s1bursts/reference/burstmap.Sentinel1Bursts.html)
- [dem.prepare_dem_for_snap](https://lqgentner.github.io/s1bursts/reference/dem.prepare_dem_for_snap.html)
- [cdse.CDSEAuth](https://lqgentner.github.io/s1bursts/reference/cdse.CDSEAuth.html)
- [cdse.CDSEBurstClient](https://lqgentner.github.io/s1bursts/reference/cdse.CDSEBurstClient.html)
- [cdse.CDSEResponse](https://lqgentner.github.io/s1bursts/reference/cdse.CDSEResponse.html)
- [burst_extractor.extract_burst_from_s3](https://lqgentner.github.io/s1bursts/reference/burst_extractor.extract_burst_from_s3.html)
- [snap_graph.xml_to_mermaid](https://lqgentner.github.io/s1bursts/reference/snap_graph.xml_to_mermaid.html)
- [snap_graph.build_backscatter_graph](https://lqgentner.github.io/s1bursts/reference/snap_graph.build_backscatter_graph.html)
- [snap_graph.build_coherence_graph](https://lqgentner.github.io/s1bursts/reference/snap_graph.build_coherence_graph.html)