Processor
The InSARHub Processor module provides functionality specifically for interferogram processing.
-
Import processor
Import the Processor class to access all processor functionality
-
View available processors
List all registered processors
Available Processors
The HyP3 InSAR processor is a cloud-based processing service provided by the ASF HyP3 system for generating interferograms from Sentinel-1 SAR data. InSARHub wrapped hyp3_sdk as one of its process backends.
The Hyp3_S1 specifically wraps insar_job in hyp3_sdk to provide InSAR SLC processing workflows.
Source code in src/insarhub/processor/hyp3_s1.py
Usage
-
Create Processor with Parameters
Initialize a processor instance with search criteria
ORORparams = { "workdir": '/your/work/path', "pairs": pairs, } processor = Processor.create('Hyp3_S1', **params)from insarhub.config.defaultconfig import Hyp3_S1_Config cfg = Hyp3_S1_Config(workdir='/your/work/path', pairs=pairs) processor = Processor.create('Hyp3_S1', config=cfg)Attributes:
Name Type Description workdirPath | strDirectory where downloaded products will be stored. If provided as a string, it will be converted to a resolved
Pathobject during initialization.saved_job_pathPath | str | NoneOptional path to a saved job JSON file for reloading previously submitted jobs. If provided as a string, it will be converted to a resolved
Pathobject.earthdata_credentials_pooldict[str, str] | NoneDictionary mapping usernames to passwords for managing multiple Earthdata accounts. Used for parallel or quota-aware submissions.
skip_existingboolIf True, skip submission or download of products that already exist locally.
submission_chunk_sizeintNumber of jobs submitted per batch request to the API. Helps avoid request size limits and API throttling.
max_workersintMaximum number of worker threads used for concurrent submissions or downloads. Recommended to keep below 8 to avoid overwhelming the API or triggering rate limits.
Attributes:
Name Type Description pairslist[tuple[str, str]] | NoneList of Sentinel-1 scene ID pairs in the form [(reference_scene, secondary_scene), ...]. If None, pairs must be provided during submission.
name_prefixstr | NonePrefix added to generated HyP3 job names.
include_look_vectorsboolIf True, include look vector layers in the output product.
include_los_displacementboolIf True, include line-of-sight (LOS) displacement maps.
include_inc_mapboolIf True, include incidence angle maps.
looksstrMulti-looking factor in the format "range x azimuth" (e.g., "20x4").
include_demboolIf True, include the DEM used during processing.
include_wrapped_phaseboolIf True, include wrapped interferometric phase output.
apply_water_maskboolIf True, apply a water mask during processing.
include_displacement_mapsboolIf True, include unwrapped displacement maps.
phase_filter_parameterfloatPhase filtering strength parameter (typically between 0 and 1). Higher values apply stronger filtering.
Source code in
src/insarhub/config/defaultconfig.py623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
@dataclass class Hyp3_S1_Config(Hyp3_Base_Config): """ Configuration options for `hyp3_sdk` InSAR GAMMA processing jobs. This dataclass defines all parameters used when submitting InSAR jobs to the ASF HyP3 service using the GAMMA workflow. UI metadata is stored in ``_ui_groups`` / ``_ui_fields`` and consumed by the API layer to auto-generate the settings panel. Attributes: pairs (list[tuple[str, str]] | None): List of Sentinel-1 scene ID pairs in the form [(reference_scene, secondary_scene), ...]. If None, pairs must be provided during submission. name_prefix (str | None): Prefix added to generated HyP3 job names. include_look_vectors (bool): If True, include look vector layers in the output product. include_los_displacement (bool): If True, include line-of-sight (LOS) displacement maps. include_inc_map (bool): If True, include incidence angle maps. looks (str): Multi-looking factor in the format "range x azimuth" (e.g., "20x4"). include_dem (bool): If True, include the DEM used during processing. include_wrapped_phase (bool): If True, include wrapped interferometric phase output. apply_water_mask (bool): If True, apply a water mask during processing. include_displacement_maps (bool): If True, include unwrapped displacement maps. phase_filter_parameter (float): Phase filtering strength parameter (typically between 0 and 1). Higher values apply stronger filtering. """ # ── UI metadata consumed by the API / settings panel ───────────────────── _ui_groups: ClassVar[list] = [ {"label": "Processing", "fields": ["looks", "phase_filter_parameter", "name_prefix", "apply_water_mask"]}, {"label": "Outputs", "fields": ["include_dem", "include_look_vectors", "include_inc_map", "include_los_displacement", "include_wrapped_phase", "include_displacement_maps"]}, {"label": "Job", "fields": ["skip_existing", "submission_chunk_size", "max_workers"]}, ] _ui_fields: ClassVar[dict] = { "looks": {"type": "select", "options": ["20x4", "10x2"], "hint": "Range × azimuth looks (20x4 ≈ 80 m, 10x2 ≈ 40 m)"}, "phase_filter_parameter": {"type": "number", "min": 0, "max": 1, "step": 0.1, "default": 0.6, "hint": "Goldstein filter strength (0 = off, 1 = maximum)"}, "name_prefix": {"type": "text"}, "apply_water_mask": {"type": "bool"}, "include_dem": {"type": "bool"}, "include_look_vectors": {"type": "bool"}, "include_inc_map": {"type": "bool"}, "include_los_displacement": {"type": "bool"}, "include_wrapped_phase": {"type": "bool"}, "include_displacement_maps":{"type": "bool"}, "skip_existing": {"type": "bool", "hint": "Skip re-downloading already-completed jobs"}, "submission_chunk_size": {"type": "number", "min": 1, "max": 500, "step": 1, "default": 200, "hint": "Jobs per API batch request"}, "max_workers": {"type": "number", "min": 1, "max": 16, "step": 1, "default": 4, "hint": "Parallel download threads for completed job outputs (default 4)"}, } # ───────────────────────────────────────────────────────────────────────── name: str = "Hyp3_S1_Config" pairs: list[tuple[str, str]] | None = None name_prefix: str | None = 'ifg' include_look_vectors:bool=True include_los_displacement:bool=False include_inc_map:bool=True looks:str='20x4' include_dem :bool=True include_wrapped_phase :bool=False apply_water_mask :bool=True include_displacement_maps:bool=True # 0.5 aligns the Goldstein filter strength with ISCE2_S1.filter_strength # and GMTSAR's phasefilt (hardcoded alpha=0.5), so the three backends # are comparable. ASF's own HyP3 default is 0.6. phase_filter_parameter :float=0.5 -
Submit Jobs
Submit InSAR jobs to HyP3 based on the current configuration.
-
Refresh Jobs
Refresh the status of all jobs.
-
Retry Failed Jobs
Retry all failed jobs by re-submitting them.
-
Download Succeeded Jobs
Download all succeeded jobs for all users.
-
Save Current Jobs
Save the current job batch information to a JSON file.
-
Watch Jobs
Continuously monitor jobs and download completed outputs.
-
Load Saved Job
Load a previously saved JSON file and resume work.
When loaded, you can resume checking or downloading jobs submitted to the HyP3 server.
The ISCE2_S1 processor runs ISCE2 stackSentinel locally to generate Sentinel-1 interferograms from downloaded SLC .SAFE files. It generates a numbered sequence of run scripts and executes them sequentially, parallelising independent commands within each step.
-
Import processor
-
Create processor
from insarhub.config import ISCE2_S1_Config cfg = ISCE2_S1_Config( workdir='/data/p100_f466', bbox=[33.0, 38.0, -120.0, -115.0], # [S, N, W, E] ) pairs = [('20200101', '20200113'), ('20200113', '20200125')] processor = Processor.create('ISCE2_S1', pairs=pairs, config=cfg)Attributes:
Name Type Description workdirPath | strProcessing root. All outputs (run_files/, merged/, etc.) live here.
slc_dirPath | strDirectory containing all Sentinel-1 SLC .SAFE files (or .zips).
orbit_dirPath | str | NoneDirectory with .EOF orbit files. Created automatically if absent.
aux_dirPath | str | NoneDirectory with Sentinel-1 AUX_CAL files. Defaults to workdir/aux; ISCE2 downloads missing files there on first run.
dem_pathPath | str | NoneISCE2-binary DEM (dem.wgs84 + .xml sidecar). When None, GLO-30 is pre-downloaded, preferring the joint footprint of the actual SLCs found in slc_dir/workdir (union of every scene's manifest corners, covering every frame in a merged multi-frame stack) over bbox -- the search AOI only reflects what was searched for, not what ASF actually returned (whole-scene footprints extend beyond it) or what a merge combined. bbox is used only as a fallback when no SLCs are on disk yet to derive a footprint from.
isce_homePath | str | NoneISCE2 installation root. Falls back to $ISCE_HOME env var.
bboxlist[float] | NoneArea of interest as [S, N, W, E] degrees. Only used as a DEM bbox fallback when no SLCs are present yet to auto-derive a footprint from (see dem_path above); otherwise informational.
num_overlap_connectionsintConnections used for NESD azimuth coregistration.
reference_datestr | NoneStack reference date YYYYMMDD. None = stackSentinel auto-selects.
coregistrationstr'NESD' (default, more accurate) or 'geometry' (faster).
max_workersintParallel commands within each run step. This is the knob that controls concurrency for every step except topo -- InSARHub runs each run-file line itself under a ThreadPoolExecutor.
num_proc4topointISCE2's own multiprocessing pool size for the topo step (run_01), written into config_reference as
numProcess. run_01 is a single command, so max_workers cannot parallelise it and this is the only knob that will. On HPC it is overridden by run_01'ssbatch_options.jsoncpus_per_task.num_procintNo effect under InSARHub. Hidden from the GUI for that reason; kept as a field so saved configs round-trip and because
_resolve_num_proc()still reads it as the HPC fallback.stackSentinel's
--num_procdoes exactly one thing: decide which lines of a run file get a trailing&and wherewaitgoes (Stack.py::write_wrapper_config2run_file), i.e. shell-level parallelism. InSARHub strips those&in_fix_cmd-- it has to, sincesubprocess.run("cmd &", shell=True)returns instantly with rc=0 and reports orphaned work as success -- and schedules the commands under its own pool instead. So the value never reaches ISCE2 as a process count: of the 51 configs stackSentinel writes for a 4-scene stack, only config_reference carriesnumProcess, and that one comes from num_proc4topo. Set max_workers instead. -
Submit (local mode)
Generate run scripts and start sequential execution in a background process. Returns immediately; use
refresh()to monitor progress. -
Submit (HPC / SLURM mode)
Set
hpc_mode=Trueto use the sliding-window SLURM manager. Steps are first grouped: consecutive steps with equal per-scene/per-pair command counts are merged into a single group-manager (e.g.run_02_unpack_secondary_slc+run_03_average_baselinewhen both have one command per scene); every other step gets its own single-step manager. Each manager keeps at mostmax_concurrent_hpcchild jobs active at all times, submitting new ones immediately as slots open. Each sbatch script logsSTART/DONE/FAILwith elapsed seconds per command.Only the first group's manager is submitted directly by
submit(). Every manager chain-submits the next group's manager itself right after it succeeds — via its own trailingsbatchcall, not a SLURM--dependency— so at most one manager (plus its own ≤max_concurrent_hpcchildren) is ever sitting in the queue at a time, instead of every group's manager being pre-submitted up front. This matters because SLURM's submitted-jobs-per-user QOS limit counts jobs that are merely waiting on a dependency just as much as running ones; pre-submitting the whole chain could exhaust that limit on managers doing nothing but waiting their turn. A failed or cancelled manager simply never submits the next one, so the chain halts on its own — no separate cleanup needed for the not-yet-submitted remainder.refresh()picks up each newly chain-submitted job's ID automatically (written to a smallchained_job_id.txtnext to the group's logs) as soon as it's submitted.Manager job names are short and state which run(s) they own:
i<NN>_mgrfor a single-step manager (e.g.i04_mgrforrun_04_...),i<NN>-<MM>_grpfor a group manager spanning steps NN–MM (e.g.i02-03_grp) — handy for readingsqueueat a glance.cfg = ISCE2_S1_Config( workdir='/data/p100_f466', bbox=[33.0, 38.0, -120.0, -115.0], hpc_mode=True, max_concurrent_hpc=12, # default; tune to your cluster's fair-share limit ) processor = Processor.create('ISCE2_S1', pairs=pairs, config=cfg) processor.submit()retry()auto-detects HPC mode from saved job metadata (slurm_job_ids/hpc_manager/hpc_array) — passinghpc_mode=Trueagain is not required. -
Dry run
Preview the run scripts and path checks without executing anything.
-
Refresh
Read step and command statuses from disk.
-
Retry failed steps
Re-run all steps that have
FAILEDstatus. -
Cancel
Terminate the running background process (local mode) or
scancelall active SLURM jobs (HPC mode). -
Watch
Poll step statuses at regular intervals until all steps complete.
-
Save / Load
Job state is saved automatically after
submit(). To reload and resume from a saved job file: -
Running without a local ISCE2 install
Set the
containerfield to a path to an Apptainer/Singularity.sifimage, or a Docker image reference (name[:tag]), andsubmit()/retry()/refresh()/watch()/cancel()all re-invoke the sameinsarhub processor ...CLI call inside that container instead of on the host — the workdir is bind-mounted at the identical path, so output lands exactly where a native run would put it, and ISCE2 never needs to be discovered on the host at all. The container image just needsinsarhubinstalled alongside ISCE2/topsStack (seedocker/dev/Dockerfile.isce2-mintpyfor a ready-to-build example). The host running the app/CLI needs a container runtime (docker, orapptainer/singularityfor a.sif) on itsPATH; the container image itself does not need one — the pipeline runs directly inside it, never nesting anotherdocker run.cfg = ISCE2_S1_Config( workdir='/data/p100_f466', bbox=[33.0, 38.0, -120.0, -115.0], container='ghcr.io/jldz9/insarhub-isce2-mintpy:0.4.0', ) processor = Processor.create('ISCE2_S1', pairs=pairs, config=cfg) processor.submit()The CLI form is the same:
insarhub processor -N ISCE2_S1 -w /data/p100_f466 submit \\ --container ghcr.io/jldz9/insarhub-isce2-mintpy:0.4.0containeris persisted to the workdir'sinsarhub_config.json, so a laterretry()/refresh()/cancel()(and, from the GUI, a retry) re-runs inside the same image without re-passing it. An explicit--container/container=on a later call overrides the saved value; a bare--container(no value) resolves to the processor'scontainer_defaultimage.container_defaultis a fixed per-processor suggestion (the image the GUI's "Run in Container" checkbox pre-fills) and is never persisted — only your actualcontainerchoice is. In HPC mode only each stage's child jobs run inside the container; the sbatch manager scaffolding stays on the host.
Runs GMTSAR's Python pipeline locally to build Sentinel-1 interferograms from .SAFE SLCs. The entry point is chosen by subswath:
- one IW (e.g.
2) — single-subswath, viap2p_processing - several (e.g.
"1 2 3", the default) — multi-subswath merged, viap2p_S1_TOPS_Frame
Either way callers pass raw .SAFE/.EOF names; the subswath and polarization are extracted internally.
GMTSAR runs in its own conda environment. gmtsar_root and gmtsar_env_bin locate it and both auto-detect, so pass them only when detection fails. Alternatively set container to a .sif/Docker image carrying insarhub+GMTSAR and skip local discovery.
-
Import processor
-
Create processor
from insarhub.config import GMTSAR_S1_Config cfg = GMTSAR_S1_Config( workdir = '/data/stack', slc_dir = '/data/slcs', orbit_dir = '/data/orbits', dem_path = '/data/dem.grd', # GMTSAR-format DEM; auto-downloaded at staging if unset subswath = 2, # IW2 only -- single-subswath. "1 2 3" (default) = multi-subswath merged gmtsar_root = '/path/to/gmtsar', # optional -- auto-detected if unset gmtsar_env_bin= '/path/to/conda/envs/gmtsar/bin', # optional -- auto-detected if unset ) pairs = [ ("REF.SAFE", "REF.EOF", "SEC.SAFE", "SEC.EOF"), ] processor = Processor.create('GMTSAR_S1', pairs=pairs, config=cfg)Set
dem_pathfor multi-subswath runsMulti-subswath gives each pair its own case directory. With
dem_pathunset the DEM is auto-downloaded at staging time — once per pair. On a 27-pair network that is the same DEM fetched 27 times.Attributes:
Name Type Description workdirPath | strProcessing root. gmtsar/ (raw/, topo/, config.py, intf/ or per-pair subdirs) lives here.
slc_dirPath | str | NoneDirectory containing Sentinel-1 SLC .SAFE dirs (or .zips).
orbit_dirPath | str | NoneDirectory with .EOF orbit files.
dem_pathPath | str | NoneGMTSAR-format DEM grid (topo/dem.grd). Unlike ISCE2_S1, bbox-driven auto-download is NOT implemented yet -- must be supplied explicitly. See gmtsar_s1.py's module docstring for the concrete "known gaps" list.
satstrp2p_processing's SAT argument (single-subswath mode only). Exposed (not hardcoded) for forward-compat -- GMTSAR already supports 14 sensor families beyond S1_TOPS (see gmtsar/python/tests/cases.py upstream), this processor is just the first one wired in.
subswathint | strIW subswath(s), ISCE-style space-separated (e.g. "1 2 3" = full frame merged via p2p_S1_TOPS_Frame, "2" = single-subswath via p2p_processing). p2p_processing itself does not read .SAFE directories -- it expects one subswath's .tiff/.xml files already extracted to matching-stem files in raw/ (confirmed against GMTSAR's own bundled single-subswath test fixture, H_res/raw/: its per-stem files are plain symlinks into the equivalent Frame-mode F
/ subswath files pulled from the same .SAFE). GMTSAR_S1 does this extraction itself. Default "1 2 3" (full frame, matching stack_mode's own default). parallelboolp2p_S1_TOPS_Frame's own internal subswath parallelism flag (0=sequential, 1=parallel). Only used in multi-subswath mode.
config_templatePath | str | NonePath to a GMTSAR config.py to reuse as-is. If None, one is auto-generated per case via
pop_config <sat>(GMTSAR's own default-config tool), matching p2p_processing's own "no config.py given" behavior.max_workersintIndependent pairs processed concurrently.
skip_existingboolDon't redo a pair whose output dir already has a .succeeded status marker.
gmtsar_rootPath | str | NoneGMTSAR repo root ($GMTSAR). Required -- GMTSAR_S1 raises at construction time if unset. Its bin/ is prepended to every GMTSAR subprocess call's PATH.
gmtsar_env_binPath | str | Nonebin/ dir of the conda env GMTSAR needs (provides the real
gmtbinary plus numba/scipy). Required -- InSARHub's own env does not providegmtat all (confirmed via a real end-to-end test, 2026-07-21), so subprocess calls fail near-instantly without this. See gmtsar_s1.py's _subprocess_env() docstring for the full writeup. -
Submit
Stage the GMTSAR case directory (and, for single-subswath mode, extract each pair's subswath), then launch
p2p_processing/p2p_S1_TOPS_Framein the background, up tomax_workersconcurrent pairs. Returns immediately; userefresh()/watch()to monitor progress. -
Submit (HPC / SLURM mode)
Both modes support
hpc_mode=True.p2p mode (
stack_mode=False, the default) is the simpler of the two: every pair is completely independent — multi-subswath gives each its own case directory, and single-subswath output is namespacedintf/<julian_pair>/— so a single sliding-window manager fans every pair out at once,max_concurrent_hpclive at a time, with no chaining at all. Each child job runs that pair's whole chain (align → interferogram → filter → unwrap → geocode) via the internalrun-stage-unit --stage pair --index Nre-entry. Job names areg_p2p_mgr/g_p2p_<idx>.cfg = GMTSAR_S1_Config(workdir='/data/stack', hpc_mode=True) Processor.create('GMTSAR_S1', pairs=pairs, config=cfg).submit()stack_mode instead runs each stack stage (
align_F<N>/intf_F<N>/merge, or the flatalign/intffor a single subswath) as its own sliding-window SLURM manager, instead of_run_stack()running as a background thread in the submitting process. Same chain-submission design asISCE2_S1(see its HPC-mode docs above): only the first stage's manager is submitted directly, and each chain-submits the next stage's manager itself right after it succeeds — never a--dependencychain pre-submitted up front — so at most one manager (plus its own ≤max_concurrent_hpcchildren) is ever sitting in the queue at a time. Manager job names areg_<stage>_mgr/ childreng_<stage>_<idx>(e.g.g_intf_F2_0007), the same short/self-describing convention as ISCE'si<NN>_mgr.One real difference from
ISCE2_S1:GMTSAR_S1has no flat shell-command-list generator the waystackSentinel.py'srun_NN_*files give ISCE — each stage's real work lives in Python methods (_run_align_unit/_run_intf_unit/_run_merge_unit), so every HPC child job's "command" re-entersinsarhubitself (the internalrun-stage-unitCLI action) to call one of those methods in a fresh process, rather than a raw shell command line calling a GMTSAR binary directly. -
Refresh
Read per-pair status from GMTSAR's own output markers (
.succeeded/.failedunderintf/<julian_date_pair>/(GMTSAR-assigned) ormerge/). -
Retry failed pairs
Re-run only the pairs whose status is
FAILED. -
Watch
Poll pair statuses at regular intervals until all pairs reach
SUCCEEDEDorFAILED. -
Cancel (HPC mode)
scancelevery SLURM job (managers + their children) for an HPC submission, in either mode. p2p jobs are found from thehpc/p2p/directory rather thanconfig.hpc_mode, so a barecancellocates them without repeating--hpc-mode; any pair stillPENDING/RUNNINGis markedFAILEDsorefreshdoes not report it as in flight. Local (non-HPC)stack_moderuns have nothing to cancel from a separate CLI invocation —_run_stack()runs as a background thread inside whichever process calledsubmit(), not a detached background process the wayISCE2_S1's local mode is, so there's no separate process left running once that call returns. -
Save
Job state is saved automatically after
submit()to<workdir>/gmtsar/gmtsar_jobs.json. -
Output layout
Single-subswath:
<workdir>/gmtsar/intf/<julian_date_pair>/(e.g.intf/2019184_2019196/— GMTSAR's own Julian-date pair naming, not ref/sec stems) — GMTSAR's native file names (corr_ll.grd,phasefilt_ll.grd,*.PRMfiles), which is exactly what MintPy'sprep_gmtsar.pyexpects directly.Multi-subswath:
<workdir>/gmtsar/<ref_safe>_<sec_safe>/merge/— the merged, geocoded product across every subswath named (phasefilt_ll.grd,corr_ll.grd, plus PNG/KML previews). -
Time series: use MintPy, not GMTSAR's own
sbasThis is a direct consequence of choosing p2p. GMTSAR's
sbasworks in radar coordinates and needs every SLC resampled onto one common grid — which per-pair alignment does not provide. MintPy'sprep_gmtsarreads the geocoded*_ll.grd, so all pairs already share a geographic grid and no common alignment reference is required. Use theGMTSAR_Mintpy_SBASanalyzer. -
Running without a local GMTSAR install
As with
ISCE2_S1, setcontainerto a.sifor Docker image carryinginsarhub+ GMTSAR and local discovery is skipped entirely:insarhub processor -N GMTSAR_S1 -w /data/stack submit \\ --container ghcr.io/jldz9/insarhub-gmtsar-mintpy:0.4.0In HPC mode only each stage's child jobs run inside the container; the sbatch manager scaffolding stays on the host.
Builds an interferogram stack from ASF SLC-BURST granules using ISCE3/COMPASS for geocoding and dolphin downstream. Pair it with the S1_Burst downloader.
There is no coregistration: COMPASS geocodes every acquisition independently onto absolute UTM, so two dates of the same burst are pixel-aligned by construction.
Nine stages, run in order:
| stage | tool | output |
|---|---|---|
dem |
sardem |
Copernicus DEM + NASADEM water mask |
tec |
COMPASS | one IONEX map per acquisition date |
cslc |
s1_geocode_stack.py → run_*.sh |
geocoded CSLC per burst-date |
static |
s1_static_layers.py |
LOS/incidence geometry, then mosaicked onto the stack grid |
crop |
dolphin | each burst cut to the AOI |
ifg |
dolphin | interferograms (see ifg_mode) |
stitch |
dolphin | each pair's bursts merged into one raster |
filt |
dolphin | multilook → Goldstein → coherence |
unwrap |
snaphu | unwrapped phase + connected components |
Choosing the estimator — ifg_mode
| value | pairs come from | notes |
|---|---|---|
phase_link (default) |
full-covariance estimation | every pair contributes; pl_* fields tune it |
network |
a rule | n_connections, or max_temporal_baseline |
user_defined |
this folder's stack_*.json |
exactly the pairs select_pairs chose |
phase_link is the default because it measurably outperforms a pairwise network: on a test stack it gave one connected component at 83% coverage against three at 55%, and cut closure error from 0.157 to 0.067 rad. Its parameters match dolphin's own shipped configuration (glrt / 0.001, half-window 7×14, ministack 15).
Under phase_link + pl_ifg_network=single_reference (the defaults) a user-defined network is ignored — the estimator's output already is that network. Set pl_ifg_network=bandwidth if you want your pairs honoured there.
Processing extent
AOI is seeded automatically from the folder's downloader intersectsWith, so it is normally already filled in. Tick process_full_extent to process the whole downloaded burst footprint instead. Note crop_buffer_deg (0.05° by default) is added on every side — on a small AOI that buffer can approach the burst footprint on its own, so lower it if you want the AOI to actually bite.
dem and cslc run before anything is geocoded, so they always use AOI; process_full_extent applies from crop onward.
Notes
- Stages are decomposed for SLURM — see HPC (SLURM).
cslcis one job per burst-date and dominates runtime;ifgunderphase_linkis a single job, because the estimator has no per-pair unit. - The interferogram network is the intersection of dates across bursts. Where ASF has no coverage for one burst on one day, that date is excluded and named, so every pair stays formable on every burst.
- Time series is via the
ISCE3_Dolphin_S1_PLanalyzer, which serves both estimator modes.
Source code in src/insarhub/processor/isce3_burst.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 | |
Builds an interferogram stack from NISAR L2 GSLC granules using dolphin for phase-linking, interferograms and unwrapping. Pair it with the NISAR_GSLC downloader and the ISCE3_Dolphin_NISAR_PL analyzer.
Same dolphin engine as ISCE3_Burst but no geocoding — a GSLC is already geocoded, one frame per date, so the dem/tec/cslc/static stages are dropped and ifg is a single wrapped_phase.run over the whole stack.
Three stages, run in order:
| stage | tool | output |
|---|---|---|
ifg |
dolphin | PS + phase-link + interferograms (one wrapped_phase.run over the stack) |
stitch |
dolphin | correlation + mosaic (trivial for one frame per date) |
unwrap |
snaphu | unwrapped phase + connected components |
AOI cropping — why it matters here
A NISAR GSLC frame is enormous (e.g. 69840 × 68688 pixels), but the AOI is usually a small window. ISCE3_Burst gets its AOI cut for free from COMPASS's geocode --bbox; ISCE3_NISAR has no geocode step to do that, so it does the cut itself: at the ifg stage each GSLC's complex-SLC subdataset is windowed to the AOI into a lightweight VRT (gdal_translate -of VRT -projwin, cached in workdir/cropped_gslc/), and dolphin phase-links only that window.
Without the crop, dolphin would phase-link the entire frame and the stitch gdal_merge step would run out of memory on the full-frame rasters (the AOI would otherwise only be applied as a final output clip — too late to save the intermediate memory). On a real stack the crop reduced each input from 69840 × 68688 to ~8953 × 8728 (~60× smaller), turning a ~12 GB memory spike into a few hundred MB. Tick process_full_extent to disable the crop and process the whole geocoded frame instead (needs a large-memory host).
Configuration
nisar_frequency(Adefault /B) andnisar_polarization(HHdefault,HV,VV,VH) select which GSLC grid group dolphin reads —/science/LSAR/GSLC/grids/frequency<freq>/<pol>. Keep these constant across a stack.AOIis seeded from the folder's downloaderintersectsWith, same asISCE3_Burst; the crop uses it directly.- The
pl_*,n_connections/max_temporal_baseline, andunwrap_*fields tune phase-linking, the interferogram network, and snaphu exactly as they do forISCE3_Burst.
Notes
- The GSLC download itself is a full geocoded frame — the crop happens at processing time, not download time, so the
.h5products inslc/are untouched and re-usable across AOIs. - Runs on the
insarhub-isce3-dolphinimage (same asISCE3_Burst/Dolphin_SBAS); setcontainerto run without a local ISCE3/dolphin install, exactly as for the other processors.
Source code in src/insarhub/processor/isce3_nisar.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | |