Skip to content

Commit

Permalink
Docs: Update docs for GUI commands
Browse files Browse the repository at this point in the history
Manual correction of documentation generation for #2818, given issues encountered in #2822.
  • Loading branch information
Lestropie committed Feb 27, 2024
1 parent c72da9a commit afde624
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 16 deletions.
20 changes: 7 additions & 13 deletions docs/reference/commands/mrview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,7 @@ Description

Any images listed as arguments will be loaded and available through the image menu, with the first listed displayed initially. Any subsequent command-line options will be processed as if the corresponding action had been performed through the GUI.

Note that because images loaded as arguments (i.e. simply listed on the command-line) are opened before the GUI is shown, subsequent actions to be performed via the various command-line options must appear after the last argument. This is to avoid confusion about which option will apply to which image. If you need fine control over this, please use the -load or -select_image options. For example:

$ mrview -load image1.mif -interpolation 0 -load image2.mif -interpolation 0

or

$ mrview image1.mif image2.mif -interpolation 0 -select_image 2 -interpolation 0
Note that because images loaded as arguments (i.e. simply listed on the command-line) are opened before the GUI is shown, subsequent actions to be performed via the various command-line options must appear after the last argument. This is to avoid confusion about which option will apply to which image. If you need fine control over this, please use the -load or -select_image options. For example:"mrview -load image1.mif -interpolation 0 -load image2.mif -interpolation 0" or "mrview image1.mif image2.mif -interpolation 0 -select_image 2 -interpolation 0"

Options
-------
Expand All @@ -44,17 +38,17 @@ View options

- **-fov value** *(multiple uses permitted)* Set the field of view, in mm.

- **-focus x,y,z or boolean** *(multiple uses permitted)* Either set the position of the crosshairs in scanner coordinates, with the new position supplied as a comma-separated list of floating-point values or show or hide the focus cross hair using a boolean value as argument.
- **-focus spec** *(multiple uses permitted)* Either set the position of the crosshairs in scanner coordinates, with the new position supplied as a comma-separated list of floating-point values, or show or hide the focus cross hair using a boolean value as argument.

- **-target x,y,z** *(multiple uses permitted)* Set the target location for the viewing window (the scanner coordinate that will appear at the centre of the viewing window
- **-target x,y,z** *(multiple uses permitted)* Set the target location for the viewing window (the scanner coordinate that will appear at the centre of the viewing window)

- **-orientation w,x,y,z** Set the orientation of the camera for the viewing window, in the form of a quaternion representing the rotation away from the z-axis. This should be provided as a list of 4 comma-separated floating point values (this will be automatically normalised).

- **-voxel x,y,z** *(multiple uses permitted)* Set the position of the crosshairs in voxel coordinates, relative the image currently displayed. The new position should be supplied as a comma-separated list of floating-point values.

- **-volume idx** *(multiple uses permitted)* Set the volume index for the image displayed, as a comma-separated list of integers.

- **-plane index** *(multiple uses permitted)* Set the viewing plane, according to the mappping 0: sagittal; 1: coronal; 2: axial.
- **-plane index** *(multiple uses permitted)* Set the viewing plane, according to the mappping: 0: sagittal; 1: coronal; 2: axial.

- **-lock yesno** *(multiple uses permitted)* Set whether view is locked to image axes (0: no, 1: yes).

Expand Down Expand Up @@ -138,11 +132,11 @@ Tractography tool options

- **-tractography.load tracks** *(multiple uses permitted)* Load the specified tracks file into the tractography tool.

- **-tractography.thickness value** *(multiple uses permitted)* Line thickness of tractography display, [-1.0, 1.0], default is 0.0.
- **-tractography.thickness value** *(multiple uses permitted)* Line thickness of tractography display, [-1.0, 1.0]; default is 0.0.

- **-tractography.geometry value** *(multiple uses permitted)* The geometry type to use when rendering tractograms (options are: pseudotubes, lines, points)

- **-tractography.opacity value** *(multiple uses permitted)* Opacity of tractography display, [0.0, 1.0], default is 1.0.
- **-tractography.opacity value** *(multiple uses permitted)* Opacity of tractography display, [0.0, 1.0]; default is 1.0.

- **-tractography.slab value** *(multiple uses permitted)* Slab thickness of tractography display, in mm. -1 to turn off crop to slab.

Expand Down Expand Up @@ -218,7 +212,7 @@ Tournier, J.-D.; Smith, R. E.; Raffelt, D.; Tabbara, R.; Dhollander, T.; Pietsch



**Author:** J-Donald Tournier (jdtournier@gmail.com), Dave Raffelt (david.raffelt@florey.edu.au), Robert E. Smith (robert.smith@florey.edu.au), Rami Tabbara (rami.tabbara@florey.edu.au), Max Pietsch (maximilian.pietsch@kcl.ac.uk), Thijs Dhollander (thijs.dhollander@gmail.com)
**Author:** J-Donald Tournier (jdtournier@gmail.com) and Dave Raffelt (david.raffelt@florey.edu.au) and Robert E. Smith (robert.smith@florey.edu.au) and Rami Tabbara (rami.tabbara@florey.edu.au) and Max Pietsch (maximilian.pietsch@kcl.ac.uk) and Thijs Dhollander (thijs.dhollander@gmail.com)

**Copyright:** Copyright (c) 2008-2024 the MRtrix3 contributors.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/shview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Usage
Options
-------

- **-response** assume SH coefficients file only contains m=0 terms (zonal harmonics). Used to display the response function as produced by estimate_response
- **-response** assume SH coefficients file only contains m=0 terms (zonal harmonics). Used to display the response function as produced by eg. amp2response

Standard options
^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commands_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ List of MRtrix3 commands
|cpp.png|, :ref:`mrthreshold`, "Create bitwise image by thresholding image intensity"
|cpp.png|, :ref:`mrtransform`, "Apply spatial transformations to an image"
|python.png|, :ref:`mrtrix_cleanup`, "Clean up residual temporary files & scratch directories from MRtrix3 commands"
|cpp.png|, :ref:`mrview`, ""
|cpp.png|, :ref:`mrview`, "The MRtrix image viewer"
|cpp.png|, :ref:`mtnormalise`, "Multi-tissue informed log-domain intensity normalisation"
|cpp.png|, :ref:`peaks2amp`, "Extract amplitudes from a peak directions image"
|cpp.png|, :ref:`peaks2fixel`, "Convert peak directions image to a fixel directory"
Expand All @@ -236,7 +236,7 @@ List of MRtrix3 commands
|cpp.png|, :ref:`sh2response`, "Generate an appropriate response function from the image data for spherical deconvolution"
|cpp.png|, :ref:`shbasis`, "Examine the values in spherical harmonic images to estimate (and optionally change) the SH basis used"
|cpp.png|, :ref:`shconv`, "Perform spherical convolution"
|cpp.png|, :ref:`shview`, ""
|cpp.png|, :ref:`shview`, "View spherical harmonics surface plots"
|cpp.png|, :ref:`tck2connectome`, "Generate a connectome matrix from a streamlines file and a node parcellation image"
|cpp.png|, :ref:`tck2fixel`, "Compute a fixel TDI map from a tractogram"
|cpp.png|, :ref:`tckconvert`, "Convert between different track file formats"
Expand Down

0 comments on commit afde624

Please sign in to comment.