Built-in commands¶
The commands that inspect results, draw pictures, write notebooks and run pipeline files. Their help is captured from moraine COMMAND --help; what to do with them is on Checking results and Workflows.
list¶
load:
load-gamma-flatten-rslc Generate flatten rslc data from gamma command and convert them into zarr format
load-gamma-lat-lon-hgt Function to load longitude and latitude from gamma binary format to zarr
load-gamma-look-vector Load look vector (elevation angle and orientation angle) in map geometry from gamma binary
load-gamma-range Generate slant range distance and save to zarr.
load-gamma-metadata Load necessary metadata into a toml file.
transform:
transform Coordinate transformation
tnet:
image-pairs Write the image pairs of a temporal network to a text file, for the `image_pairs` argument
math:
math Basic math manipulation
polygon:
polygon-mask Mask of the pixels or points inside (or outside) the polygons of a GeoJSON file
pc:
gix2bool Convert pc grid index to bool 2d array
bool2gix Convert bool 2d array to grid index
ras2pc Convert raster data to point cloud data
pc-concat concatenate (and sort) point cloud dataset.
ras2pc-ras-chunk Convert raster data to point cloud data that sorted by ras chunk
pc2ras Convert point cloud data to raster data, filled with nan
pc-hix Compute the hillbert index from grid index for point cloud data.
pc-gix Compute the grid index from hillbert index for point cloud data.
pc-sort Sort point cloud data according to the indices that sort `idx_in`.
pc-union Get the union of two point cloud datasets
pc-intersect Get the intersection of two point cloud datasets.
pc-diff Get the points of the first point cloud dataset that are not in the second one.
pc-logic-ras generate point cloud index based on logical operation of one raster image.
pc-logic-pc generate point cloud index and data based on logical operation one point cloud data.
pc-select-data generate point cloud data based on its index and one point cloud data
ps:
amp-disp calculation the amplitude dispersion index from SLC stack.
shp:
shp-test SHP identification through hypothesis test, and the selection of the SHPs at the level `al
select-shp Select SHP based on pvalue of SHP test.
co:
emperical-co-pc estimate emperical coherence matrix on point cloud data.
pl:
emi Phase linking with EMI estimator.
ds-temp-coh DS temporal coherence, optionally also weighted by the coherence of the image pairs.
emperical-co-emi-temp-coh-pc estimating emperical coherence matrix, phase linking and estimating temporal coherence on
dl:
n2f Noise2Fringe (n2f) filtering of raster interferograms
n2ft Noise2Fringe Transformer (n2ft) filtering of point cloud interferograms
pqm:
temp-coh temporal coherence.
pu:
gamma-mcf-pt A wrapper for mcf_pt in GAMMA software.
mcf-pc Minimum cost flow phase unwrapping of point cloud interferograms
emcf-pc Extended minimum cost flow (EMCF) phase unwrapping of point cloud interferograms
unwrap-correct-closure-pc Correction of unwrapping errors of point cloud interferograms by phase closure, to the unw
plot:
ras-pyramid render raster data to pyramid of difference zoom levels.
pc-pyramid render point cloud data to pyramid of difference zoom levels.
Other: info, quicklook, view, run, status. `moraine COMMAND --help` for details.
info¶
usage: moraine info [-h] [--json] [--traceback] [--log FILE] [-q] paths [paths ...]
positional arguments:
paths
options:
-h, --help show this help message and exit
output:
--json print a machine readable JSON result on stdout
--traceback show the full traceback on errors
--log FILE also write the log to FILE
-q, --quiet only log warnings and errors
quicklook¶
usage: moraine quicklook [-h] [-o OUT] [--index I [I ...]]
[--show {phase,intf_0,intf_seq,intf_all,coh,coh_abs}] [--width WIDTH]
[--extent EXTENT] [--json] [--traceback] [--log FILE] [-q]
pyramid
positional arguments:
pyramid pyramid directory made by `moraine ras-pyramid` or `moraine pc-
pyramid`
options:
-h, --help show this help message and exit
-o OUT, --out OUT output PNG (default: <pyramid name>.png)
--index I [I ...] image of a stack, or two images (ref sec) with --show intf_all / coh
(default: the first)
--show {phase,intf_0,intf_seq,intf_all,coh,coh_abs}, --post_proc {phase,intf_0,intf_seq,intf_all,coh,coh_abs}
what to show of a stack, see moraine.cli.view (default: the phase for
complex data)
--width WIDTH image width in pixels (default: 1000)
--extent EXTENT part to draw, finer levels for smaller parts: "west,south,east,north"
degrees (web mercator) or
"range_min,azimuth_min,range_max,azimuth_max" pixels (radar grid);
default: the whole scene
output:
--json print a machine readable JSON result on stdout
--traceback show the full traceback on errors
--log FILE also write the log to FILE
-q, --quiet only log warnings and errors
view¶
usage: moraine view [-h] [-o OUT] [--show {phase,intf_0,intf_seq,intf_all,coh,coh_abs}]
[--dates DATES] [--terrain] [--overwrite] [--json] [--traceback]
[--log FILE] [-q]
pyramids [pyramids ...]
positional arguments:
pyramids pyramid directories made by `moraine ras-pyramid` / `moraine pc-
pyramid`
options:
-h, --help show this help message and exit
-o OUT, --out OUT notebook to write (default: view.ipynb)
--show {phase,intf_0,intf_seq,intf_all,coh,coh_abs}, --post_proc {phase,intf_0,intf_seq,intf_all,coh,coh_abs}
what to show of stacks, see moraine.cli.view (default: the phase for
complex data)
--dates DATES toml file with the image dates, e.g. the metadata of load-gamma-
metadata
--terrain 3D maps over the terrain (public elevation tiles); web mercator
pyramids only
--overwrite replace an existing notebook
output:
--json print a machine readable JSON result on stdout
--traceback show the full traceback on errors
--log FILE also write the log to FILE
-q, --quiet only log warnings and errors
run¶
usage: moraine run [-h] [--dry-run] [--from STEP] [--only STEP] [--force] [--no-quicklook]
[--workdir DIR] [--var NAME=VALUE] [--json] [--traceback] [--log FILE] [-q]
pipeline
positional arguments:
pipeline
options:
-h, --help show this help message and exit
--dry-run check the file and print the plan only
--from STEP rerun from this step on
--only STEP run only this step (repeatable)
--force rerun steps that are already done
--no-quicklook do not save quicklook images
--workdir DIR working directory, overrides [pipeline] workdir
--var NAME=VALUE set a variable used as ${NAME} (repeatable)
output:
--json print a machine readable JSON result on stdout
--traceback show the full traceback on errors
--log FILE also write the log to FILE
-q, --quiet only log warnings and errors
status¶
usage: moraine status [-h] [--workdir DIR] [--var NAME=VALUE] [--json] [--traceback]
[--log FILE] [-q]
pipeline
positional arguments:
pipeline
options:
-h, --help show this help message and exit
--workdir DIR working directory, overrides [pipeline] workdir
--var NAME=VALUE set a variable used as ${NAME} (repeatable)
output:
--json print a machine readable JSON result on stdout
--traceback show the full traceback on errors
--log FILE also write the log to FILE
-q, --quiet only log warnings and errors
The processing commands¶
The output of moraine list:
load:
load-gamma-flatten-rslc Generate flatten rslc data from gamma command and convert them into zarr format
load-gamma-lat-lon-hgt Function to load longitude and latitude from gamma binary format to zarr
load-gamma-look-vector Load look vector (elevation angle and orientation angle) in map geometry from gamma binary
load-gamma-range Generate slant range distance and save to zarr.
load-gamma-metadata Load necessary metadata into a toml file.
transform:
transform Coordinate transformation
tnet:
image-pairs Write the image pairs of a temporal network to a text file, for the `image_pairs` argument
math:
math Basic math manipulation
polygon:
polygon-mask Mask of the pixels or points inside (or outside) the polygons of a GeoJSON file
pc:
gix2bool Convert pc grid index to bool 2d array
bool2gix Convert bool 2d array to grid index
ras2pc Convert raster data to point cloud data
pc-concat concatenate (and sort) point cloud dataset.
ras2pc-ras-chunk Convert raster data to point cloud data that sorted by ras chunk
pc2ras Convert point cloud data to raster data, filled with nan
pc-hix Compute the hillbert index from grid index for point cloud data.
pc-gix Compute the grid index from hillbert index for point cloud data.
pc-sort Sort point cloud data according to the indices that sort `idx_in`.
pc-union Get the union of two point cloud datasets
pc-intersect Get the intersection of two point cloud datasets.
pc-diff Get the points of the first point cloud dataset that are not in the second one.
pc-logic-ras generate point cloud index based on logical operation of one raster image.
pc-logic-pc generate point cloud index and data based on logical operation one point cloud data.
pc-select-data generate point cloud data based on its index and one point cloud data
ps:
amp-disp calculation the amplitude dispersion index from SLC stack.
shp:
shp-test SHP identification through hypothesis test, and the selection of the SHPs at the level `al
select-shp Select SHP based on pvalue of SHP test.
co:
emperical-co-pc estimate emperical coherence matrix on point cloud data.
pl:
emi Phase linking with EMI estimator.
ds-temp-coh DS temporal coherence, optionally also weighted by the coherence of the image pairs.
emperical-co-emi-temp-coh-pc estimating emperical coherence matrix, phase linking and estimating temporal coherence on
dl:
n2f Noise2Fringe (n2f) filtering of raster interferograms
n2ft Noise2Fringe Transformer (n2ft) filtering of point cloud interferograms
pqm:
temp-coh temporal coherence.
pu:
gamma-mcf-pt A wrapper for mcf_pt in GAMMA software.
mcf-pc Minimum cost flow phase unwrapping of point cloud interferograms
emcf-pc Extended minimum cost flow (EMCF) phase unwrapping of point cloud interferograms
unwrap-correct-closure-pc Correction of unwrapping errors of point cloud interferograms by phase closure, to the unw
plot:
ras-pyramid render raster data to pyramid of difference zoom levels.
pc-pyramid render point cloud data to pyramid of difference zoom levels.
Other: info, quicklook, view, run, status. `moraine COMMAND --help` for details.