Difference between revisions of "Modules:Fiducials-Documentation"

From Slicer Wiki
Jump to: navigation, search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Documentation|Return to Slicer Documentation]]
+
[[Documentation|Return to Slicer Documentation]]
  
 
== Fiducials Module GUI ==
 
== Fiducials Module GUI ==
Line 5: Line 5:
 
The Fiducials Module creates and manages lists of Fiducial points.  
 
The Fiducials Module creates and manages lists of Fiducial points.  
  
[[Image:FiducialsGUI.jpg]]
+
{| border="1"
 +
|-
 +
| rowspan="5"| [[Image:FiducialsGUI.jpg]]
 +
|-
 +
| colspan="3" | '''Create and Select Fiducial Lists''' icons.
 +
|- valign="top"
 +
| [[image:SlicerFiducialsSelectAll.png]] Select all fiducial points from all lists.
 +
| [[image:SlicerFiducialsSelectNone.png]] Deselect all fiducial points from all lists.
 +
| [[image:SlicerFiducialsDeleteAll.png]] Delete all fiducials lists and the fiducials they contain.
 +
|-
 +
| colspan="5" | '''Add, Configure, & Delete Fiducials''' icons.
 +
|- valign="top"
 +
| [[image:SlicerFiducialsAddNew.png]] Add a fiducial point to the current fiducial list, at (0,0,0).
 +
| [[image:SlicerFiducialsSelectAllInList.png]] Select all fiducial points from this fiducial list.
 +
| [[image:SlicerFiducialsSelectNoneInList.png]] Deselect all fiducial points from this fiducial list.
 +
| [[image:SlicerFiducialsDeleteLastClicked.png]] Delete the last fiducial that was clicked on in the table.
 +
| [[image:SlicerFiducialsDeleteAll.png]] Delete all fiducial points from this fiducial list.
 +
|}
  
 
== Making New Fiducials ==
 
== Making New Fiducials ==
Line 17: Line 34:
 
You can also place fiducials while in 'tranform view' mode by positioning the mouse over a 2D slice plane in the Slice view windows (it must be the active window) and pressing the 'P' key.  
 
You can also place fiducials while in 'tranform view' mode by positioning the mouse over a 2D slice plane in the Slice view windows (it must be the active window) and pressing the 'P' key.  
  
 
+
You can also add a new fiducial from the Fiducials module GUI, using the add button: [[image:SlicerFiducialsAddNew.png]]. This places a new fiducial at the origin, (0,0,0).
  
 
== Interaction ==
 
== Interaction ==
  
You can then click and drag the fiducial using the mouse in 'transform view' mode. 3D interactions are possible by clicking and dragging the fiducials in the 3D window.  
+
You can right click and drag a fiducial in the 2D slice windows using the mouse in 'transform view' mode. 3D interactions are possible by clicking and dragging the fiducial glyph in the 3D window.  
  
You can reset the positions of the fiducials in the table that appears in the 'Add, Configure and Delete' section of the Fiducials GUI.
+
You can reset the positions of the fiducials in the table that appears in the ''Add, Configure and Delete'' section of the Fiducials GUI.
  
 
[[Image:FiducialsGUIList.jpg]]
 
[[Image:FiducialsGUIList.jpg]]
  
Double click on the fiducial name, or position, to edit it manually. Each fiducial can also be selected or unselected, and visible or invisible. The 'Adjust Display Properties' tab controls the visibility of the list as a whole.
+
Click on a value and hit the 'Enter' key (or double click) on one of the X, Y, or Z position values to edit it manually. You can do the same on the fiducial name to change it. The default name is generated from the name of the list, which can be changed in the Data Module. Each fiducial can also be selected or unselected, and set to be visible or invisible. The ''Adjust Display Properties'' tab controls the visibility of the list as a whole.
  
 
The distance between the first two selected fiducials in the list will be computed automatically and appear in a label below the list of fiducials. This distance is in milimetres.
 
The distance between the first two selected fiducials in the list will be computed automatically and appear in a label below the list of fiducials. This distance is in milimetres.
  
To align slices with fiducials, move the fiducial while holding down the Control key. You can use the '`' (backtick) key to jump to the next fiducial, Shift-` to jump backwards through the list.  
+
To align slices with fiducials, move the fiducial while holding down the Control key. You can use the '`' (backtick) key to jump to the next fiducial, Control-` to jump backwards through the list.  
  
 
Use the backspace or delete key to delete a fiducial over which you are hovering in 2D.
 
Use the backspace or delete key to delete a fiducial over which you are hovering in 2D.
Line 41: Line 58:
 
== Display ==
 
== Display ==
  
The display properties of the fiducials in the list can be adjusted by expanding the 'Adjust Display Properties' tab:
+
The display properties of the fiducials in the list can be adjusted by expanding the ''Adjust Display Properties'' tab:
  
 
[[Image:FiducialsAdjustDisplayProperties2.jpg]]
 
[[Image:FiducialsAdjustDisplayProperties2.jpg]]
Line 53: Line 70:
 
[[Image:FiducialGlyphs.jpg]]
 
[[Image:FiducialGlyphs.jpg]]
  
The various lists have had their fiducial glyph sizes scaled, and the selected colours changed by selecting the appropriate list from Fiducial List drop down menu and then using the 'Adjust Display Properties' widgets. The text size can be scaled as well, as well as the visibility of all the fiducials in the list toggled on or off. The opacity of the fiducials can also be adjusted between 0 and 1.
+
The various lists have had their fiducial glyph sizes scaled, and the selected colours changed by selecting the appropriate list from Fiducial List drop down menu and then using the ''Adjust Display Properties'' widgets. The text size can be scaled as well, as well as the visibility of all the fiducials in the list toggled on or off. The opacity of the fiducials can also be adjusted between 0 and 1.

Latest revision as of 22:36, 12 December 2008

Home < Modules:Fiducials-Documentation

Return to Slicer Documentation

Fiducials Module GUI

The Fiducials Module creates and manages lists of Fiducial points.

FiducialsGUI.jpg
Create and Select Fiducial Lists icons.
SlicerFiducialsSelectAll.png Select all fiducial points from all lists. SlicerFiducialsSelectNone.png Deselect all fiducial points from all lists. SlicerFiducialsDeleteAll.png Delete all fiducials lists and the fiducials they contain.
Add, Configure, & Delete Fiducials icons.
SlicerFiducialsAddNew.png Add a fiducial point to the current fiducial list, at (0,0,0). SlicerFiducialsSelectAllInList.png Select all fiducial points from this fiducial list. SlicerFiducialsSelectNoneInList.png Deselect all fiducial points from this fiducial list. SlicerFiducialsDeleteLastClicked.png Delete the last fiducial that was clicked on in the table. SlicerFiducialsDeleteAll.png Delete all fiducial points from this fiducial list.

Making New Fiducials

New fiducials can be created in multiple ways:

Click on the tool bar icon of an arrow pointing to a starburst fiducial to enter the 'place a new object mode', then use the mouse to left click on 3D models or on 2D slices to show where you wish to place your fiducials.

FiducialsIcon.jpg

You can also place fiducials while in 'tranform view' mode by positioning the mouse over a 2D slice plane in the Slice view windows (it must be the active window) and pressing the 'P' key.

You can also add a new fiducial from the Fiducials module GUI, using the add button: SlicerFiducialsAddNew.png. This places a new fiducial at the origin, (0,0,0).

Interaction

You can right click and drag a fiducial in the 2D slice windows using the mouse in 'transform view' mode. 3D interactions are possible by clicking and dragging the fiducial glyph in the 3D window.

You can reset the positions of the fiducials in the table that appears in the Add, Configure and Delete section of the Fiducials GUI.

FiducialsGUIList.jpg

Click on a value and hit the 'Enter' key (or double click) on one of the X, Y, or Z position values to edit it manually. You can do the same on the fiducial name to change it. The default name is generated from the name of the list, which can be changed in the Data Module. Each fiducial can also be selected or unselected, and set to be visible or invisible. The Adjust Display Properties tab controls the visibility of the list as a whole.

The distance between the first two selected fiducials in the list will be computed automatically and appear in a label below the list of fiducials. This distance is in milimetres.

To align slices with fiducials, move the fiducial while holding down the Control key. You can use the '`' (backtick) key to jump to the next fiducial, Control-` to jump backwards through the list.

Use the backspace or delete key to delete a fiducial over which you are hovering in 2D.

Argument Lists

Fiducials can be passed as a list of points to a command line module, for example to do ACPC registration. Only the points that are selected in the list are passed to the command line module, so you can adjust which points are used for calculating the output.

Display

The display properties of the fiducials in the list can be adjusted by expanding the Adjust Display Properties tab:

FiducialsAdjustDisplayProperties2.jpg

There is a long list of glyph types available, each list can have a different glyph type, as well as colour and size properties. The default is the 2D starburst, but 3D glyphs are also available.

FiducialsGlyphTypes.jpg

The following image shows what these types of glyphs look like in 3D:

FiducialGlyphs.jpg

The various lists have had their fiducial glyph sizes scaled, and the selected colours changed by selecting the appropriate list from Fiducial List drop down menu and then using the Adjust Display Properties widgets. The text size can be scaled as well, as well as the visibility of all the fiducials in the list toggled on or off. The opacity of the fiducials can also be adjusted between 0 and 1.