+ +
+ +
+

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_NAMES
  • PairProducts
  • PipelineDefinition
  • PipelineStep
  • SNAP2STAMPS_GRAPH_PIPELINES
  • SNAP2STAMPS_PIPELINES
  • SNAP2STAMPS_WORKFLOWS
  • SNAP2STAMPS_WORKFLOW_INPUTS
  • TopsarCoregIfgResult
  • build_gpt
  • get_pipeline_definition
  • list_pipeline_names
  • pipeline_requires_multi_input
  • pipeline_requires_pair
  • prepare_pair
  • run_graph_pipeline
  • run_pair_graph_pipeline
  • run_pair_workflow
  • run_processing_pipeline
  • run_stripmap_coreg
  • run_stripmap_export
  • run_stripmap_ifg
  • run_stripmap_subset
  • run_topsar_coreg_ifg
  • run_topsar_export
  • run_topsar_split_apply_orbit
  • run_workflow
  • select_stripmap_coreg_pipeline
  • select_stripmap_ifg_pipeline
  • select_topsar_coreg_ifg_pipeline
  • select_topsar_export_pipeline
  • select_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

+
ParameterTypeRequiredDefaultDescription
branchBranchName | NonenoNoneinferred 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' -> PipelineDefinition
+

Parameters

+
ParameterTypeRequiredDefaultDescription
namestryes-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' -> bool
+

Parameters

+
ParameterTypeRequiredDefaultDescription
namestryes-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' -> bool
+

Parameters

+
ParameterTypeRequiredDefaultDescription
namestryes-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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
source_countintyes-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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
master_countintyes-inferred from implementation.
burst_countintyes-inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
master_countintyes-inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
external_dem_filestr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
external_dem_filestr | Path | NonenoNoneinferred 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' -> GPT
+

Parameters

+
ParameterTypeRequiredDefaultDescription
productstr | Pathyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
gptGPTyes-inferred from implementation.
graph_namestryes-inferred from implementation.
overridesdict[str, dict[str, Any]] | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
gptGPTyes-inferred from implementation.
graph_namestryes-inferred from implementation.
pairPairProductsyes-inferred from implementation.
overridesdict[str, dict[str, Any]] | NonenoNoneinferred 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' -> PairProducts
+

Parameters

+
ParameterTypeRequiredDefaultDescription
pairPairProductsyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
preprocess_graphstuple[str, ...]no('split_orbit',)inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred from implementation.
overridesdict[str, dict[str, Any]] | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
pairPairProductsyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
workflowstrno'stamps_prep'inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred from implementation.
overridesdict[str, dict[str, Any]] | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
gptGPTyes-inferred from implementation.
workflowstryes-inferred from implementation.
overridesdict[str, dict[str, Any]] | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
source_productsIterable[str | Path]yes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
subswathstryes-inferred from implementation.
polarisationstr | NonenoNoneinferred from implementation.
polygon_wktstr | NonenoNoneinferred from implementation.
output_namestr | NonenoNoneinferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred from implementation.
apply_orbit_kwargsdict[str, Any] | NonenoNoneinferred 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 | TopsarCoregIfgResult
+

Parameters

+
ParameterTypeRequiredDefaultDescription
pipeline_namestryes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred from implementation.
source_productstr | Path | NonenoNoneinferred from implementation.
source_productsIterable[str | Path] | NonenoNoneinferred from implementation.
pairPairProducts | NonenoNoneinferred from implementation.
target_folderstr | Path | NonenoNoneinferred from implementation.
kwargsAnyyes-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' -> TopsarCoregIfgResult
+

Parameters

+
ParameterTypeRequiredDefaultDescription
pairPairProductsyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
master_countint | NonenoNoneinferred from implementation.
burst_countint | NonenoNoneinferred from implementation.
pipeline_namestr | NonenoNoneinferred from implementation.
polygon_wktstr | NonenoNoneinferred from implementation.
subset_regionstrno'0,0,0,0'inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred from implementation.
output_name_prefixstrno'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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
coreg_productsIterable[str | Path]yes-inferred from implementation.
ifg_productsIterable[str | Path]yes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
target_folderstr | Pathyes-inferred from implementation.
master_countintyes-inferred from implementation.
polygon_wktstr | NonenoNoneinferred from implementation.
subset_regionstrno'0,0,0,0'inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred from implementation.
selected_polarisationslist[str] | NonenoNoneinferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
productstr | Pathyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
regionstr | NonenoNoneinferred from implementation.
polygon_wktstr | NonenoNoneinferred from implementation.
output_namestr | NonenoNoneinferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
pairPairProductsyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred from implementation.
output_namestr | NonenoNoneinferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
coreg_productstr | Pathyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
external_dem_filestr | Path | NonenoNoneinferred from implementation.
output_name_prefixstrno'stripmap'inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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' -> str
+

Parameters

+
ParameterTypeRequiredDefaultDescription
coreg_productstr | Pathyes-inferred from implementation.
ifg_productstr | Pathyes-inferred from implementation.
outdirstr | Pathyes-inferred from implementation.
target_folderstr | Pathyes-inferred from implementation.
formatstrno'BEAM-DIMAP'inferred from implementation.
gpt_pathstrno'/usr/local/snap/bin/gpt'inferred from implementation.
memorystr | NonenoNoneinferred from implementation.
parallelismint | Noneno14inferred from implementation.
timeoutint | Noneno7200inferred from implementation.
snap_userdirstr | Path | NonenoNoneinferred 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>) -> None
+

Constructor 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') -> None
+

Constructor 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' = '') -> None
+

Constructor 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') -> None
+

Constructor 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.

+
+
+ +
+ +
+
+

Generated from repository sources on 2026-03-12 13:39 UTC.

+
+