Module: sarpyx.snapflow.snap2stamps
+ File: sarpyx/snapflow/snap2stamps.py
Processing-only SNAP2StaMPS workflows implemented on top of :mod:`snapflow`. + +This module covers the upstream SNAP2StaMPS processing branches without +recreating the original script/config runner UX. The focus is: + +- processing branch selection for TOPSAR and Stripmap data +- reusable Python-callable helpers for the graph families used upstream +- backward-compatible access to the narrower workflow helpers that previously + lived in ``snap2stamps_pipelines.py``
+ +Exported Symbols (__all__)
+ PAIRWISE_GRAPH_NAMESPairProductsPipelineDefinitionPipelineStepSNAP2STAMPS_GRAPH_PIPELINESSNAP2STAMPS_PIPELINESSNAP2STAMPS_WORKFLOWSSNAP2STAMPS_WORKFLOW_INPUTSTopsarCoregIfgResultbuild_gptget_pipeline_definitionlist_pipeline_namespipeline_requires_multi_inputpipeline_requires_pairprepare_pairrun_graph_pipelinerun_pair_graph_pipelinerun_pair_workflowrun_processing_pipelinerun_stripmap_coregrun_stripmap_exportrun_stripmap_ifgrun_stripmap_subsetrun_topsar_coreg_ifgrun_topsar_exportrun_topsar_split_apply_orbitrun_workflowselect_stripmap_coreg_pipelineselect_stripmap_ifg_pipelineselect_topsar_coreg_ifg_pipelineselect_topsar_export_pipelineselect_topsar_split_pipeline
Public Functions (23)
+ +list_pipeline_names function
+ Return known processing pipeline names, optionally filtered by branch.
+File location: sarpyx/snapflow/snap2stamps.py:355
Signature
+list_pipeline_names(branch: 'BranchName | None' = None) -> 'tuple[str, ...]' -> tuple[str, ...]Parameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
branch | BranchName | None | no | None | inferred from implementation. |
Return Type
+tuple[str, ...]
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import list_pipeline_names
+
+result = list_pipeline_names()Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+get_pipeline_definition function
+ Return a pipeline definition by name.
+File location: sarpyx/snapflow/snap2stamps.py:365
Signature
+get_pipeline_definition(name: 'str') -> 'PipelineDefinition' -> PipelineDefinitionParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | str | yes | - | inferred from implementation. |
Return Type
+PipelineDefinition
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import get_pipeline_definition
+
+result = get_pipeline_definition(name=<name>)Edge Cases
+No explicit edge-case section found; behavior is inferred from implementation.
+pipeline_requires_pair function
+ Return ``True`` when a processing branch requires explicit master/slave inputs.
+File location: sarpyx/snapflow/snap2stamps.py:374
Signature
+pipeline_requires_pair(name: 'str') -> 'bool' -> boolParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | str | yes | - | inferred from implementation. |
Return Type
+bool
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import pipeline_requires_pair
+
+result = pipeline_requires_pair(name=<name>)Edge Cases
+No explicit edge-case section found; behavior is inferred from implementation.
+pipeline_requires_multi_input function
+ Return ``True`` when a processing branch requires more than one source product.
+File location: sarpyx/snapflow/snap2stamps.py:379
Signature
+pipeline_requires_multi_input(name: 'str') -> 'bool' -> boolParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | str | yes | - | inferred from implementation. |
Return Type
+bool
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import pipeline_requires_multi_input
+
+result = pipeline_requires_multi_input(name=<name>)Edge Cases
+No explicit edge-case section found; behavior is inferred from implementation.
+select_topsar_split_pipeline function
+ Select the upstream-equivalent TOPSAR split/apply-orbit branch.
+File location: sarpyx/snapflow/snap2stamps.py:384
Signature
+select_topsar_split_pipeline(source_count: 'int') -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_count | int | yes | - | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import select_topsar_split_pipeline
+
+result = select_topsar_split_pipeline(source_count=<source_count>)Edge Cases
+No explicit edge-case section found; behavior is inferred from implementation.
+select_topsar_coreg_ifg_pipeline function
+ Select the upstream-equivalent TOPSAR coreg/IFG pipeline variant.
+File location: sarpyx/snapflow/snap2stamps.py:391
Signature
+select_topsar_coreg_ifg_pipeline(*, master_count: 'int', burst_count: 'int', external_dem_file: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
master_count | int | yes | - | inferred from implementation. |
burst_count | int | yes | - | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import select_topsar_coreg_ifg_pipeline
+
+result = select_topsar_coreg_ifg_pipeline(master_count=<master_count>, burst_count=<burst_count>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+select_topsar_export_pipeline function
+ Select the upstream-equivalent TOPSAR StaMPS export branch.
+File location: sarpyx/snapflow/snap2stamps.py:413
Signature
+select_topsar_export_pipeline(*, master_count: 'int', external_dem_file: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
master_count | int | yes | - | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import select_topsar_export_pipeline
+
+result = select_topsar_export_pipeline(master_count=<master_count>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+select_stripmap_coreg_pipeline function
+ Select the upstream-equivalent Stripmap coregistration branch.
+File location: sarpyx/snapflow/snap2stamps.py:430
Signature
+select_stripmap_coreg_pipeline(external_dem_file: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_dem_file | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import select_stripmap_coreg_pipeline
+
+result = select_stripmap_coreg_pipeline()Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+select_stripmap_ifg_pipeline function
+ Select the upstream-equivalent Stripmap IFG/topo branch.
+File location: sarpyx/snapflow/snap2stamps.py:439
Signature
+select_stripmap_ifg_pipeline(external_dem_file: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_dem_file | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import select_stripmap_ifg_pipeline
+
+result = select_stripmap_ifg_pipeline()Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+build_gpt function
+ Convenience constructor aligned with SNAP2StaMPS-like batch processing.
+File location: sarpyx/snapflow/snap2stamps.py:469
Signature
+build_gpt(product: 'str | Path', outdir: 'str | Path', *, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'GPT' -> GPTParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product | str | Path | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+GPT
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import build_gpt
+
+result = build_gpt(product=<product>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_graph_pipeline function
+ Run a single-input stage from the legacy graph-pipeline catalog.
+File location: sarpyx/snapflow/snap2stamps.py:493
Signature
+run_graph_pipeline(gpt: 'GPT', graph_name: 'str', overrides: 'dict[str, dict[str, Any]] | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
gpt | GPT | yes | - | inferred from implementation. |
graph_name | str | yes | - | inferred from implementation. |
overrides | dict[str, dict[str, Any]] | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_graph_pipeline
+
+result = run_graph_pipeline(gpt=<gpt>, graph_name=<graph_name>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_pair_graph_pipeline function
+ Run a graph pipeline that consumes explicit master and slave products.
+File location: sarpyx/snapflow/snap2stamps.py:517
Signature
+run_pair_graph_pipeline(gpt: 'GPT', graph_name: 'str', pair: 'PairProducts', overrides: 'dict[str, dict[str, Any]] | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
gpt | GPT | yes | - | inferred from implementation. |
graph_name | str | yes | - | inferred from implementation. |
pair | PairProducts | yes | - | inferred from implementation. |
overrides | dict[str, dict[str, Any]] | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_pair_graph_pipeline
+
+result = run_pair_graph_pipeline(gpt=<gpt>, graph_name=<graph_name>, pair=<pair>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+prepare_pair function
+ Prepare master and slave independently for pairwise TOPSAR processing.
+File location: sarpyx/snapflow/snap2stamps.py:538
Signature
+prepare_pair(pair: 'PairProducts', outdir: 'str | Path', *, preprocess_graphs: 'tuple[str, ...]' = ('split_orbit',), format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None, overrides: 'dict[str, dict[str, Any]] | None' = None) -> 'PairProducts' -> PairProductsParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pair | PairProducts | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
preprocess_graphs | tuple[str, ...] | no | ('split_orbit',) | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
overrides | dict[str, dict[str, Any]] | None | no | None | inferred from implementation. |
Return Type
+PairProducts
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import prepare_pair
+
+result = prepare_pair(pair=<pair>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_pair_workflow function
+ Run a pairwise TOPSAR workflow from split/deburst through final output.
+File location: sarpyx/snapflow/snap2stamps.py:570
Signature
+run_pair_workflow(pair: 'PairProducts', outdir: 'str | Path', workflow: 'str' = 'stamps_prep', *, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None, overrides: 'dict[str, dict[str, Any]] | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pair | PairProducts | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
workflow | str | no | 'stamps_prep' | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
overrides | dict[str, dict[str, Any]] | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_pair_workflow
+
+result = run_pair_workflow(pair=<pair>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_workflow function
+ Run a composed single-input workflow from the convenience catalog.
+File location: sarpyx/snapflow/snap2stamps.py:632
Signature
+run_workflow(gpt: 'GPT', workflow: 'str', overrides: 'dict[str, dict[str, Any]] | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
gpt | GPT | yes | - | inferred from implementation. |
workflow | str | yes | - | inferred from implementation. |
overrides | dict[str, dict[str, Any]] | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_workflow
+
+result = run_workflow(gpt=<gpt>, workflow=<workflow>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_topsar_split_apply_orbit function
+ Run the upstream-equivalent TOPSAR split/apply-orbit branch.
+File location: sarpyx/snapflow/snap2stamps.py:656
Signature
+run_topsar_split_apply_orbit(source_products: 'Iterable[str | Path]', outdir: 'str | Path', *, subswath: 'str', polarisation: 'str | None' = None, polygon_wkt: 'str | None' = None, output_name: 'str | None' = None, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None, apply_orbit_kwargs: 'dict[str, Any] | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_products | Iterable[str | Path] | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
subswath | str | yes | - | inferred from implementation. |
polarisation | str | None | no | None | inferred from implementation. |
polygon_wkt | str | None | no | None | inferred from implementation. |
output_name | str | None | no | None | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
apply_orbit_kwargs | dict[str, Any] | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_topsar_split_apply_orbit
+
+result = run_topsar_split_apply_orbit(source_products=<source_products>, outdir=<outdir>, subswath=<subswath>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_processing_pipeline function
+ Run a named upstream-equivalent processing branch from :data:`SNAP2STAMPS_PIPELINES`.
+File location: sarpyx/snapflow/snap2stamps.py:711
Signature
+run_processing_pipeline(pipeline_name: 'str', *, outdir: 'str | Path', format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None, source_product: 'str | Path | None' = None, source_products: 'Iterable[str | Path] | None' = None, pair: 'PairProducts | None' = None, target_folder: 'str | Path | None' = None, **kwargs: 'Any') -> 'str | TopsarCoregIfgResult' -> str | TopsarCoregIfgResultParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pipeline_name | str | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
source_product | str | Path | None | no | None | inferred from implementation. |
source_products | Iterable[str | Path] | None | no | None | inferred from implementation. |
pair | PairProducts | None | no | None | inferred from implementation. |
target_folder | str | Path | None | no | None | inferred from implementation. |
kwargs | Any | yes | - | inferred from implementation. |
Return Type
+str | TopsarCoregIfgResult
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_processing_pipeline
+
+result = run_processing_pipeline(pipeline_name=<pipeline_name>, outdir=<outdir>, kwargs=<kwargs>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_topsar_coreg_ifg function
+ Run the upstream-equivalent TOPSAR coregistration/interferogram branch.
+File location: sarpyx/snapflow/snap2stamps.py:803
Signature
+run_topsar_coreg_ifg(pair: 'PairProducts', outdir: 'str | Path', *, master_count: 'int | None' = None, burst_count: 'int | None' = None, pipeline_name: 'str | None' = None, polygon_wkt: 'str | None' = None, subset_region: 'str' = '0,0,0,0', external_dem_file: 'str | Path | None' = None, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None, output_name_prefix: 'str' = 'pair') -> 'TopsarCoregIfgResult' -> TopsarCoregIfgResultParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pair | PairProducts | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
master_count | int | None | no | None | inferred from implementation. |
burst_count | int | None | no | None | inferred from implementation. |
pipeline_name | str | None | no | None | inferred from implementation. |
polygon_wkt | str | None | no | None | inferred from implementation. |
subset_region | str | no | '0,0,0,0' | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
output_name_prefix | str | no | 'pair' | inferred from implementation. |
Return Type
+TopsarCoregIfgResult
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_topsar_coreg_ifg
+
+result = run_topsar_coreg_ifg(pair=<pair>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_topsar_export function
+ Run the upstream-equivalent TOPSAR StaMPS export branch.
+File location: sarpyx/snapflow/snap2stamps.py:957
Signature
+run_topsar_export(coreg_products: 'Iterable[str | Path]', ifg_products: 'Iterable[str | Path]', outdir: 'str | Path', *, target_folder: 'str | Path', master_count: 'int', polygon_wkt: 'str | None' = None, subset_region: 'str' = '0,0,0,0', external_dem_file: 'str | Path | None' = None, selected_polarisations: 'list[str] | None' = None, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
coreg_products | Iterable[str | Path] | yes | - | inferred from implementation. |
ifg_products | Iterable[str | Path] | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
target_folder | str | Path | yes | - | inferred from implementation. |
master_count | int | yes | - | inferred from implementation. |
polygon_wkt | str | None | no | None | inferred from implementation. |
subset_region | str | no | '0,0,0,0' | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
selected_polarisations | list[str] | None | no | None | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_topsar_export
+
+result = run_topsar_export(coreg_products=<coreg_products>, ifg_products=<ifg_products>, outdir=<outdir>, target_folder=<target_folder>, master_count=<master_count>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_stripmap_subset function
+ Run the Stripmap subset branch.
+File location: sarpyx/snapflow/snap2stamps.py:1086
Signature
+run_stripmap_subset(product: 'str | Path', outdir: 'str | Path', *, region: 'str | None' = None, polygon_wkt: 'str | None' = None, output_name: 'str | None' = None, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product | str | Path | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
region | str | None | no | None | inferred from implementation. |
polygon_wkt | str | None | no | None | inferred from implementation. |
output_name | str | None | no | None | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_stripmap_subset
+
+result = run_stripmap_subset(product=<product>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_stripmap_coreg function
+ Run the Stripmap DEM-assisted coregistration branch.
+File location: sarpyx/snapflow/snap2stamps.py:1122
Signature
+run_stripmap_coreg(pair: 'PairProducts', outdir: 'str | Path', *, external_dem_file: 'str | Path | None' = None, output_name: 'str | None' = None, format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pair | PairProducts | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
output_name | str | None | no | None | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_stripmap_coreg
+
+result = run_stripmap_coreg(pair=<pair>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_stripmap_ifg function
+ Run the Stripmap interferogram/topographic-phase branch.
+File location: sarpyx/snapflow/snap2stamps.py:1158
Signature
+run_stripmap_ifg(coreg_product: 'str | Path', outdir: 'str | Path', *, external_dem_file: 'str | Path | None' = None, output_name_prefix: 'str' = 'stripmap', format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
coreg_product | str | Path | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
external_dem_file | str | Path | None | no | None | inferred from implementation. |
output_name_prefix | str | no | 'stripmap' | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_stripmap_ifg
+
+result = run_stripmap_ifg(coreg_product=<coreg_product>, outdir=<outdir>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+run_stripmap_export function
+ Run the Stripmap StaMPS export branch.
+File location: sarpyx/snapflow/snap2stamps.py:1198
Signature
+run_stripmap_export(coreg_product: 'str | Path', ifg_product: 'str | Path', outdir: 'str | Path', *, target_folder: 'str | Path', format: 'str' = 'BEAM-DIMAP', gpt_path: 'str' = '/usr/local/snap/bin/gpt', memory: 'str | None' = None, parallelism: 'int | None' = 14, timeout: 'int | None' = 7200, snap_userdir: 'str | Path | None' = None) -> 'str' -> strParameters
+| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
coreg_product | str | Path | yes | - | inferred from implementation. |
ifg_product | str | Path | yes | - | inferred from implementation. |
outdir | str | Path | yes | - | inferred from implementation. |
target_folder | str | Path | yes | - | inferred from implementation. |
format | str | no | 'BEAM-DIMAP' | inferred from implementation. |
gpt_path | str | no | '/usr/local/snap/bin/gpt' | inferred from implementation. |
memory | str | None | no | None | inferred from implementation. |
parallelism | int | None | no | 14 | inferred from implementation. |
timeout | int | None | no | 7200 | inferred from implementation. |
snap_userdir | str | Path | None | no | None | inferred from implementation. |
Return Type
+str
inferred from implementation.
+Exceptions
+None explicitly documented; inferred from implementation.
+Side Effects
+- inferred from implementation
Example Usage
+from sarpyx.snapflow.snap2stamps import run_stripmap_export
+
+result = run_stripmap_export(coreg_product=<coreg_product>, ifg_product=<ifg_product>, outdir=<outdir>, target_folder=<target_folder>)Edge Cases
+Includes optional parameters with implementation-defined fallback behavior.
+Public Classes (4)
+ +PipelineStep class
+ Single operator call in a SNAP pipeline.
+File location: sarpyx/snapflow/snap2stamps.py:25
Class Signature
+class PipelineStep(method: 'str', kwargs: 'dict[str, Any]' = <factory>) -> NoneConstructor Parameters
+ +Return Type
+PipelineStep instances.
Exceptions
+Construction/runtime exceptions are inferred from implementation and method-level documentation.
+Side Effects
+See method-level side effects below.
+Example Usage
+from sarpyx.snapflow.snap2stamps import PipelineStep
+
+obj = PipelineStep(...) # inferred from implementation
+Edge Cases
+No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
+Public Methods (0)
+No public methods detected.
+PairProducts class
+ Master/slave product pair used for pairwise InSAR preparation.
+File location: sarpyx/snapflow/snap2stamps.py:33
Class Signature
+class PairProducts(master: 'str | Path', slave: 'str | Path') -> NoneConstructor Parameters
+ +Return Type
+PairProducts instances.
Exceptions
+Construction/runtime exceptions are inferred from implementation and method-level documentation.
+Side Effects
+See method-level side effects below.
+Example Usage
+from sarpyx.snapflow.snap2stamps import PairProducts
+
+obj = PairProducts(...) # inferred from implementation
+Edge Cases
+No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
+Public Methods (0)
+No public methods detected.
+PipelineDefinition class
+ Description of an upstream-equivalent processing pipeline variant.
+File location: sarpyx/snapflow/snap2stamps.py:45
Class Signature
+class PipelineDefinition(name: 'str', branch: 'BranchName', input_kind: 'InputKind', stages: 'tuple[str, ...]', upstream_graph: 'str | None' = None, description: 'str' = '') -> NoneConstructor Parameters
+ +Return Type
+PipelineDefinition instances.
Exceptions
+Construction/runtime exceptions are inferred from implementation and method-level documentation.
+Side Effects
+See method-level side effects below.
+Example Usage
+from sarpyx.snapflow.snap2stamps import PipelineDefinition
+
+obj = PipelineDefinition(...) # inferred from implementation
+Edge Cases
+No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
+Public Methods (0)
+No public methods detected.
+TopsarCoregIfgResult class
+ Outputs of the TOPSAR coregistration/interferogram branch.
+File location: sarpyx/snapflow/snap2stamps.py:57
Class Signature
+class TopsarCoregIfgResult(coreg_path: 'str', ifg_path: 'str', pipeline_name: 'str') -> NoneConstructor Parameters
+ +Return Type
+TopsarCoregIfgResult instances.
Exceptions
+Construction/runtime exceptions are inferred from implementation and method-level documentation.
+Side Effects
+See method-level side effects below.
+Example Usage
+from sarpyx.snapflow.snap2stamps import TopsarCoregIfgResult
+
+obj = TopsarCoregIfgResult(...) # inferred from implementation
+Edge Cases
+No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
+Public Methods (0)
+No public methods detected.
+