Skip to main content

burst_extractor.extract_burst_from_s3()

Extract a single Sentinel-1 SLC burst from CDSE S3.

Usage

Source

burst_extractor.extract_burst_from_s3(
    save_path, *, parent_product_name, polarization, sub_swath, burst_id
)

All intermediate files (edited XMLs, extracted TIFF) are written to a local temporary directory. Only the final .zip is moved or uploaded to save_path, which may be a local path or a remote UPath (e.g. S3).

Parameters

save_path: str | Path | UPath

Full destination path (including filename) for the .zip.

parent_product_name: str

Name of the parent *.SAFE product on CDSE.

polarization: str

Polarization channel, e.g. "VV", "VH", "HH", "HV".

sub_swath: str

Subswath identifier, e.g. "IW1", "IW2", "IW3".

burst_id: int
Relative burst ID within the subswath.

Returns

Path or UPath
Path to the produced .zip file.

Raises

ValueError

If sub_swath is not a recognized subswath identifier.

BurstNotFoundError

If the parent product or the requested burst cannot be found.

BurstDownloadError

If the product’s annotation, calibration, noise, RFI or manifest file is malformed. The parse error is kept as the cause.

ConfigurationError
If the CDSE S3 credentials are not configured.