Skip to content

Commit 89a928a

Browse files
authored
update help on arguments
1 parent 0aa8765 commit 89a928a

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Depending on the shell, it might be necessary to quote the echo times:
3434
```
3535
$ romeo
3636
usage: <PROGRAM> [-m MAGNITUDE] [-o OUTPUT] [-t ECHO-TIMES] [-k MASK]
37-
[-e UNWRAP-ECHOES] [-w WEIGHTS] [-B]
37+
[-u] [-e UNWRAP-ECHOES] [-w WEIGHTS] [-B]
3838
[--phase-offset-correction] [-i]
3939
[--template TEMPLATE] [-N] [--no-rescale]
4040
[--threshold THRESHOLD] [-v] [-g] [-q] [-Q]
@@ -61,6 +61,8 @@ optional arguments:
6161
allowed!! ("[1, 2, 3]" is invalid!)
6262
-k, --mask MASK nomask | robustmask | <mask_file> (default:
6363
"robustmask")
64+
-u, --mask-unwrapped Apply the mask on the unwrapped result. If
65+
mask is "nomask", sets it to "robustmask".
6466
-e, --unwrap-echoes UNWRAP-ECHOES
6567
Load only the specified echoes from disk
6668
(default: ":")
@@ -93,7 +95,7 @@ optional arguments:
9395
default the input phase is rescaled to the
9496
range [-π;π]. This option allows inputting
9597
already unwrapped phase images without
96-
wrapping them first.
98+
manually wrapping them first.
9799
--threshold THRESHOLD
98100
<maximum number of wraps>. Threshold the
99101
unwrapped phase to the maximum number of wraps

0 commit comments

Comments
 (0)