Skip to content

Commit

Permalink
Doc expansion for sfs
Browse files Browse the repository at this point in the history
  • Loading branch information
oleg-alexandrov committed Dec 21, 2024
1 parent 63a6bdf commit f766e9f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/tools/parallel_sfs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Command-line options for ``parallel_sfs``:
computation benefit from parallelization.

--prep-step <string (default: None)>
Run parallel_sfs twice, before mosaicking the final results. First time
Run ``parallel_sfs`` twice, before mosaicking the final results. First time
add these options to the ``sfs`` program. Second time add the options in
``--main-step``. Must use this as ``--prep-step="options"``. Without the
equal sign it will fail to parse the options because of the Python
``argparse`` module. See an example in :numref:`sfs_earth`.
equal sign it will fail to parse the options because of limitations of the
Python ``argparse`` module. See an example in :numref:`sfs_earth`.

--main-step <string (default: None)>
See: ``--prep-step``.
Expand Down
11 changes: 11 additions & 0 deletions docs/tools/sfs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,17 @@ Command-line options for sfs
is on. The final haze values will be saved to ``<output
prefix>-haze.txt``.

--read-exposures
If set, read the image exposures with the current output prefix.
Useful with a repeat invocation. See the options ``--prep-step`` and
``--main-step`` in ``parallel_sfs`` (:numref:`parallel_sfs`).

--read-haze
If set, read the haze values with the current output prefix. See also ``--read-exposures``.

--read-albedo
If set, read the computed albedo with the current output prefix. See also ``--read-exposures``.

--gradient-weight <float (default: 0.0)>
The weight given to the cost function term which consists of sums
of squares of first-order derivatives. A larger value will result
Expand Down
2 changes: 1 addition & 1 deletion src/asp/Tools/parallel_sfs
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ def main(argsIn):
help = 'Run parallel_sfs twice, before mosaicking the final results. First time '
'add these options to the sfs program. Second time add the options in --main-step.'
'Must use this as --prep-step="options". Without the equal sign it will fail '
'to parse the options because of of the Python argparse module.')
'to parse the options because of limitations of the Python argparse module.')

parser.add_argument('--main-step', dest='main_step', default = None,
help = 'See --prep-step.')
Expand Down

0 comments on commit f766e9f

Please sign in to comment.