Skip to content

tnet: Temporal network (image pairs) for the CLI

Commands of moraine.cli.tnet (source); the same functions are called in Python as mc.<name>(...) with import moraine.cli as mc. The help below is generated from the docstrings, like moraine COMMAND --help.

command summary
image-pairs Write the image pairs of a temporal network to a text file, for the image_pairs arguments.

image-pairs

Write the image pairs of a temporal network to a text file, for the image_pairs arguments.

moraine image-pairs --out STR [--rslc STR] [--nimages VALUE] [--bandwidth VALUE]
argument type default description
--out str required output text file with two columns, reference and secondary image index
--rslc str None input rslc stack (..., nimages), used to get the number of images; alternative to nimages
--nimages int None number of images; alternative to rslc
--bandwidth int None connect every image with the next bandwidth images (1: sequential interferograms); all image pairs by default

Global options: --json, --traceback, --log FILE, -q / --quiet (conventions).

In a pipeline (examples/02_ps.toml, step pairs_seq):

[[step]]
name = "pairs_seq"                # sequential image pairs (bandwidth 1)
run = "image-pairs"
rslc = "raw/rslc.zarr"
bandwidth = 1
out = "ps/pairs_seq.txt"

Also in examples/04_refine.toml (step pairs_seq), examples/05_unwrap.toml (step pairs_seq).

In Python:

import moraine.cli as mc
mc.image_pairs(out, rslc=None, nimages=None, bandwidth=None)