Difference between revisions of "Modules:IGTToolSelector-Documentation-3.5"

From Slicer Wiki
Jump to: navigation, search
(Created page with 'Return to Slicer 3.5 Documentation Gallery of New Features __NOTOC__ ===Module Name=== IGTToolSelector == General …')
 
Line 6: Line 6:
 
===Module Name===
 
===Module Name===
 
IGTToolSelector
 
IGTToolSelector
 +
 +
<!-- {|
 +
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
 +
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
 +
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
 +
|} -->
  
 
== General Information ==
 
== General Information ==
Line 15: Line 21:
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
+
* Andrew D. Wiles, Ph.D.: NDI (Northern Digital Inc., http://www.ndigital.com)
* Contributor1: Affiliation & logo, if desired
+
* Contact: awiles [at] ndigital.com
* Contributor2: Affiliation & logo, if desired
 
* Contact: name, email
 
  
 
===Module Description===
 
===Module Description===
Overview of what the module does goes here.
+
This module allows you to change the model of a tracked tool for image-guided therapy.  Used with the [[Modules:OpenIGTLinkIF-Documentation-3.4 | OpenIGTLink IF Module]], a vtkPolyData model can be assigned to a transformation from the tracking system.  This module has PolyData models for a needle and a probe.  The user can also choose to toggle on/off (i) the target (tip) location and (ii) the tool projection.  It is assumed that the projection of the tool is in the negative ''z''-direction.
  
 
== Usage ==
 
== Usage ==
Line 27: Line 31:
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
  
* Note use cases for which this module is especially appropriate, and/or link to examples.
+
* This is intended for IGT applications where virtual representation of the surgical tool is needed for interaction with an image.  Currently, this module is limited to a single tool but plans are in place to expand it to multiple tools.
* Link to examples of the module's use
 
* Link to any existing tutorials
 
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
 
  
* '''Input panel:'''
+
* '''Tool Properties Panel:'''
* '''Parameters panel:'''
+
** Probe Transform: Select the MRML node that contains the probe transform being served up from the tracking system via the [[Modules:OpenIGTLinkIF-Documentation-3.4 | OpenIGTLink IF Module]].
* '''Output panel:'''
+
** Tool Type List: Select the tool type being tracked.  Currently only three types are available: the OpenIGTLink Default, Needle and a Pointer Probe.  It is easy to added other models by adding functions to the Logic code.
* '''Viewing panel:'''
+
** Enable Tool PolyDdata Checkbox: Toggle the tool on and off.
 +
** Show Axes Checkbox: Toggle the tool axes on and off.
 +
** Show Tool Projection: Toggle the projection line on and off.
 +
** Set Projection Length Slider: Control the length of the projection line.  250mm is the maximum (Is this reasonable?).
 +
** Set Projection Diamater Slider: Control the size of the radius of the projection line.  10mm is the maximum.
 +
** Show Tool Tip Location Checkbox: Toggle the tool tip sphere on and off.
 +
** Set Target Diameter Slider: Control the size of the sphere at the tool tip location.  10mm is the maximum.
 +
 
  
 
== Development ==
 
== Development ==

Revision as of 20:13, 18 March 2010

Home < Modules:IGTToolSelector-Documentation-3.5

Return to Slicer 3.5 Documentation

Gallery of New Features


Module Name

IGTToolSelector


General Information

Module Type & Category

Type: Interactive

Category: IGT

Authors, Collaborators & Contact

Module Description

This module allows you to change the model of a tracked tool for image-guided therapy. Used with the OpenIGTLink IF Module, a vtkPolyData model can be assigned to a transformation from the tracking system. This module has PolyData models for a needle and a probe. The user can also choose to toggle on/off (i) the target (tip) location and (ii) the tool projection. It is assumed that the projection of the tool is in the negative z-direction.

Usage

Examples, Use Cases & Tutorials

  • This is intended for IGT applications where virtual representation of the surgical tool is needed for interaction with an image. Currently, this module is limited to a single tool but plans are in place to expand it to multiple tools.

Quick Tour of Features and Use

  • Tool Properties Panel:
    • Probe Transform: Select the MRML node that contains the probe transform being served up from the tracking system via the OpenIGTLink IF Module.
    • Tool Type List: Select the tool type being tracked. Currently only three types are available: the OpenIGTLink Default, Needle and a Pointer Probe. It is easy to added other models by adding functions to the Logic code.
    • Enable Tool PolyDdata Checkbox: Toggle the tool on and off.
    • Show Axes Checkbox: Toggle the tool axes on and off.
    • Show Tool Projection: Toggle the projection line on and off.
    • Set Projection Length Slider: Control the length of the projection line. 250mm is the maximum (Is this reasonable?).
    • Set Projection Diamater Slider: Control the size of the radius of the projection line. 10mm is the maximum.
    • Show Tool Tip Location Checkbox: Toggle the tool tip sphere on and off.
    • Set Target Diameter Slider: Control the size of the sphere at the tool tip location. 10mm is the maximum.


Development

Dependencies

Other modules or packages that are required for this module's use.

Known bugs

Follow this link to the Slicer3 bug tracker.


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Customize following links for your module:

Source code:

Doxygen documentation:

More Information

Acknowledgment

Include funding and other support here.

References

Publications related to this module go here. Links to pdfs would be useful.