Skip to content

Commit 9ece1db

Browse files
committed
DOC: Add application options in the sphinx doc
1 parent c180f17 commit 9ece1db

46 files changed

Lines changed: 509 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

applications/rtkadmmtotalvariation/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,15 @@ This script uses the SheppLogan phantom
77

88
```{literalinclude} TotalVariationRegularizedReconstruction.sh
99
```
10+
11+
12+
## Command line options
13+
14+
::::{container} argparse-no-usage
15+
```{eval-rst}
16+
.. argparse::
17+
:filename: applications/rtkadmmtotalvariation/rtkadmmtotalvariation.py
18+
:func: build_parser
19+
:nodescription:
20+
```
21+
::::

applications/rtkadmmwavelets/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,15 @@ This script uses the SheppLogan phantom
77

88
```{literalinclude} DaubechiesWavelets.sh
99
```
10+
11+
12+
## Command line options
13+
14+
::::{container} argparse-no-usage
15+
```{eval-rst}
16+
.. argparse::
17+
:filename: applications/rtkadmmwavelets/rtkadmmwavelets.py
18+
:func: build_parser
19+
:nodescription:
20+
```
21+
::::

applications/rtkamsterdamshroud/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,16 @@ rtkextractshroudsignal --input shroud.mha \
2626
Phase is commonly measured in radians, with values in $[0,2\pi[$, but in RTK it is normalized to $[0,1[$, where 0.3 corresponds to 30% in the respiratory cycle, i.e., frame 3 if you have a 10-frames 4D reconstruction or frame 6 if you have a 20-frames 4D reconstruction. The [resulting phase](https://data.kitware.com/api/v1/item/5be99af98d777f2179a2e160/download) is in green on top of the blue respiratory signal and the detected end-exhale peaks:
2727

2828
![Signal](../../documentation/docs/ExternalData/Signal.jpg){w=800px alt="Phase signal"}
29+
30+
31+
## Command line options
32+
33+
34+
::::{container} argparse-no-usage
35+
```{eval-rst}
36+
.. argparse::
37+
:filename: applications/rtkamsterdamshroud/rtkamsterdamshroud.py
38+
:func: build_parser
39+
:nodescription:
40+
```
41+
::::

applications/rtkbackprojections/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,16 @@ Backprojects a volume according to a geometry file. See available projectors [he
77

88
```{literalinclude} BackProjections.sh
99
```
10+
11+
12+
## Command line options
13+
14+
15+
::::{container} argparse-no-usage
16+
```{eval-rst}
17+
.. argparse::
18+
:filename: applications/rtkbackprojections/rtkbackprojections.py
19+
:func: build_parser
20+
:nodescription:
21+
```
22+
::::

applications/rtkbioscangeometry/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,15 @@ rtkbioscangeometry \
1313
--regexp 'bioscan.dcm' \
1414
--verbose
1515
```
16+
17+
18+
## Command line options
19+
20+
::::{container} argparse-no-usage
21+
```{eval-rst}
22+
.. argparse::
23+
:filename: applications/rtkbioscangeometry/rtkbioscangeometry.py
24+
:func: build_parser
25+
:nodescription:
26+
```
27+
::::

applications/rtkcheckimagequality/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,16 @@ rtkcheckimagequality -i ref1.mha ref2.mha -j rec1.mha rec2.mha -t 1e-3 2e-3
1414
# Broadcast a single threshold to multiple comparisons
1515
rtkcheckimagequality -i ref1.mha ref2.mha -j rec1.mha rec2.mha -t 2e-3
1616
```
17+
18+
19+
## Command line options
20+
21+
22+
::::{container} argparse-no-usage
23+
```{eval-rst}
24+
.. argparse::
25+
:filename: applications/rtkcheckimagequality/rtkcheckimagequality.py
26+
:func: build_parser
27+
:nodescription:
28+
```
29+
::::

applications/rtkconjugategradient/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,16 @@ In the presence of noise, all projection data may not be equally reliable. The c
3939
```
4040
````
4141
`````
42+
43+
44+
## Command line options
45+
46+
47+
::::{container} argparse-no-usage
48+
```{eval-rst}
49+
.. argparse::
50+
:filename: applications/rtkconjugategradient/rtkconjugategradient.py
51+
:func: build_parser
52+
:nodescription:
53+
```
54+
::::

applications/rtkdigisensgeometry/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,15 @@ rtkdigisensgeometry \
99
--xml_file calibration.cal \
1010
-o geometry.xml
1111
```
12+
13+
## Command line options
14+
15+
16+
::::{container} argparse-no-usage
17+
```{eval-rst}
18+
.. argparse::
19+
:filename: applications/rtkdigisensgeometry/rtkdigisensgeometry.py
20+
:func: build_parser
21+
:nodescription:
22+
```
23+
::::

applications/rtkdrawgeometricphantom/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,16 @@ This script uses the file [Gammex.txt](https://data.kitware.com/api/v1/file/6762
88
# Create a 3D Gammex phantom
99
rtkdrawgeometricphantom --phantomfile Gammex.txt -o gammex.mha
1010
```
11+
12+
13+
## Command line options
14+
15+
16+
::::{container} argparse-no-usage
17+
```{eval-rst}
18+
.. argparse::
19+
:filename: applications/rtkdrawgeometricphantom/rtkdrawgeometricphantom.py
20+
:func: build_parser
21+
:nodescription:
22+
```
23+
::::

applications/rtkdrawshepploganphantom/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,16 @@ See rtkfdk example:
77
```{literalinclude} ../rtkfdk/FDK3D.sh
88

99
```
10+
11+
12+
## Command line options
13+
14+
15+
::::{container} argparse-no-usage
16+
```{eval-rst}
17+
.. argparse::
18+
:filename: applications/rtkdrawshepploganphantom/rtkdrawshepploganphantom.py
19+
:func: build_parser
20+
:nodescription:
21+
```
22+
::::

0 commit comments

Comments
 (0)