Module: sarpyx.cli.worldsar
File: sarpyx/cli/worldsar.py
WorldSAR CLI pipelines for SAR product preprocessing and tiling. TODO: metadate reorganization. TODO: SUBAPERTURE PROCESSING for all missions. TODO: PolSAR support. TODO: InSAR support.
Exported Symbols (__all__)
No explicit __all__ list. Public symbols inferred from implementation.
Public Functions (13)
create_parser function
Create command-line argument parser.
File location: sarpyx/cli/worldsar.py:54
Signature
create_parser() -> argparse.ArgumentParserParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
argparse.ArgumentParser
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import create_parser
result = create_parser()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
extract_product_id function
Extract product ID from BEAM-DIMAP path.
File location: sarpyx/cli/worldsar.py:205
Signature
extract_product_id(path: str) -> str | NoneParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path | str | yes | - | inferred from implementation. |
Return Type
str | None
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import extract_product_id
result = extract_product_id(path=<path>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
infer_product_mode function
Infer product mode from product naming patterns.
File location: sarpyx/cli/worldsar.py:211
Signature
infer_product_mode(product_path: Path) -> strParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
Return Type
str
inferred from implementation.
Exceptions
ValueError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import infer_product_mode
result = infer_product_mode(product_path=<product_path>)Edge Cases
May raise: ValueError.
prefetch_sentinel_orbits function
inferred from implementation.
File location: sarpyx/cli/worldsar.py:339
Signature
prefetch_sentinel_orbits(years: list[int], orbit_type: str, satellites: list[str], outdir: Path, base_url: str) -> NoneParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
years | list[int] | yes | - | inferred from implementation. |
orbit_type | str | yes | - | inferred from implementation. |
satellites | list[str] | yes | - | inferred from implementation. |
outdir | Path | yes | - | inferred from implementation. |
base_url | str | yes | - | inferred from implementation. |
Return Type
None
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.cli.worldsar import prefetch_sentinel_orbits
result = prefetch_sentinel_orbits(years=<years>, orbit_type=<orbit_type>, satellites=<satellites>, outdir=<outdir>, base_url=<base_url>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
create_tile_database function
Create a database of tile metadata from h5 files.
File location: sarpyx/cli/worldsar.py:372
Signature
create_tile_database(input_folder: str, output_db_folder: str) -> pd.DataFrameParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input_folder | str | yes | - | inferred from implementation. |
output_db_folder | str | yes | - | inferred from implementation. |
Return Type
pd.DataFrame
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.cli.worldsar import create_tile_database
result = create_tile_database(input_folder=<input_folder>, output_db_folder=<output_db_folder>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
to_geotiff function
inferred from implementation.
File location: sarpyx/cli/worldsar.py:397
Signature
to_geotiff(product_path: Path, output_dir: Path, geo_region: str=None, output_name: str=None, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
geo_region | str | no | None | inferred from implementation. |
output_name | str | no | None | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
RuntimeError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import to_geotiff
result = to_geotiff(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
May raise: RuntimeError. Includes optional parameters with implementation-defined fallback behavior.
subset function
inferred from implementation.
File location: sarpyx/cli/worldsar.py:424
Signature
subset(product_path: Path, output_dir: Path, geo_region: str=None, output_name: str=None, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
geo_region | str | no | None | inferred from implementation. |
output_name | str | no | None | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
RuntimeError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import subset
result = subset(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
May raise: RuntimeError. Includes optional parameters with implementation-defined fallback behavior.
pipeline_sentinel function
Sentinel-1 pipeline.
File location: sarpyx/cli/worldsar.py:899
Signature
pipeline_sentinel(product_path: Path, output_dir: Path, is_TOPS: bool=False, subaperture: bool=False, use_graph: bool=False, orbit_type: str='Sentinel Precise (Auto Download)', orbit_continue_on_fail: bool=False, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
is_TOPS | bool | no | False | inferred from implementation. |
subaperture | bool | no | False | inferred from implementation. |
use_graph | bool | no | False | inferred from implementation. |
orbit_type | str | no | 'Sentinel Precise (Auto Download)' | inferred from implementation. |
orbit_continue_on_fail | bool | no | False | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
RuntimeError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import pipeline_sentinel
result = pipeline_sentinel(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
May raise: RuntimeError. Includes optional parameters with implementation-defined fallback behavior.
pipeline_terrasar function
Terrasar-X pipeline.
File location: sarpyx/cli/worldsar.py:1010
Signature
pipeline_terrasar(product_path: Path, output_dir: Path, use_graph: bool=False, orbit_type: str='Sentinel Precise (Auto Download)', orbit_continue_on_fail: bool=False, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
use_graph | bool | no | False | inferred from implementation. |
orbit_type | str | no | 'Sentinel Precise (Auto Download)' | inferred from implementation. |
orbit_continue_on_fail | bool | no | False | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import pipeline_terrasar
result = pipeline_terrasar(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
pipeline_cosmo function
COSMO-SkyMed pipeline.
File location: sarpyx/cli/worldsar.py:1030
Signature
pipeline_cosmo(product_path: Path, output_dir: Path, use_graph: bool=False, orbit_type: str='Sentinel Precise (Auto Download)', orbit_continue_on_fail: bool=False, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
use_graph | bool | no | False | inferred from implementation. |
orbit_type | str | no | 'Sentinel Precise (Auto Download)' | inferred from implementation. |
orbit_continue_on_fail | bool | no | False | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import pipeline_cosmo
result = pipeline_cosmo(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
pipeline_biomass function
BIOMASS pipeline.
File location: sarpyx/cli/worldsar.py:1050
Signature
pipeline_biomass(product_path: Path, output_dir: Path, use_graph: bool=False, orbit_type: str='Sentinel Precise (Auto Download)', orbit_continue_on_fail: bool=False, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
use_graph | bool | no | False | inferred from implementation. |
orbit_type | str | no | 'Sentinel Precise (Auto Download)' | inferred from implementation. |
orbit_continue_on_fail | bool | no | False | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
RuntimeError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import pipeline_biomass
result = pipeline_biomass(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
May raise: RuntimeError. Includes optional parameters with implementation-defined fallback behavior.
pipeline_nisar function
NISAR pipeline.
File location: sarpyx/cli/worldsar.py:1076
Signature
pipeline_nisar(product_path: Path, output_dir: Path, use_graph: bool=False, orbit_type: str='Sentinel Precise (Auto Download)', orbit_continue_on_fail: bool=False, gpt_memory: str | None=None, gpt_parallelism: int | None=None, gpt_timeout: int | None=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_path | Path | yes | - | inferred from implementation. |
output_dir | Path | yes | - | inferred from implementation. |
use_graph | bool | no | False | inferred from implementation. |
orbit_type | str | no | 'Sentinel Precise (Auto Download)' | inferred from implementation. |
orbit_continue_on_fail | bool | no | False | inferred from implementation. |
gpt_memory | str | None | no | None | inferred from implementation. |
gpt_parallelism | int | None | no | None | inferred from implementation. |
gpt_timeout | int | None | no | None | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.worldsar import pipeline_nisar
result = pipeline_nisar(product_path=<product_path>, output_dir=<output_dir>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
main function
inferred from implementation.
File location: sarpyx/cli/worldsar.py:1326
Signature
main()Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
ValueError
Side Effects
- io
Example Usage
from sarpyx.cli.worldsar import main
result = main()Edge Cases
May raise: ValueError.
Public Classes (0)
No public classes detected.