Difference between revisions of "Modules:Volumes:Diffusion Editor-Documentation"

From Slicer Wiki
Jump to: navigation, search
Line 62: Line 62:
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
 +
 +
[[Image:Diffusion Editor v1.jpg|thumb|right|overview]]
 +
 
<font color="Red"> TODO:
 
<font color="Red"> TODO:
 
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
 
List all the panels in your interface, their features, what they mean, and how to use them. For instance:

Revision as of 19:48, 24 April 2008

Home < Modules:Volumes:Diffusion Editor-Documentation

Return to Slicer Documentation


Diffusion Editor

Diffusion Editor, showing tracts and glyphs on helix example
tracts and glyphs view
tracts and glyphs view - +90° rotation of measurement frame

General Information

Module Type & Category

Type: Interactive

Category: Diffusion Imaging

Authors, Collaborators & Contact

  • Author: Kerstin Kessel
  • Supervisor: Steve Pieper, Ron Kikinis

Module Description

TODO: Overview of what the module does goes here.

The goal of this project is to add a Gradient Editor for DWI data in the Volumes module of Slicer3. As the documentation of gradients in dicom data is not standardized, MRI scanners handle them differently. Because of that there is a big need to add/modify gradients manually.

  • 1.Step: Generate a Nrrd-header of your DWI data. Use the "Dicom to Nrrd" module in Slicer3 (Modules->Converters->Dicom to Nrrd).
    • -> A .nhdr file will be created.
  • 2.Step: Use the output (.nhdr file) as an input of the Volumes module.
    • -> The Gradient Editor will be enabled. If you load any other type of dataset the editor will be disabled.

What you can do with the Gradient Editor

TODO: more details.

  1. Choose measurement frame.
    1. Negative: Select the columns you want to negative.
    2. Swap: Select two columns you want to swap.
    3. Rotate: Select one column you want to rotate by an angle you can choose from a given set of values or set yourself.
    4. Idendity: Set the measurement frame to the idendity matrix.
    5. Set your own values.
  2. Define gradients.
    1. If the .nhdr file has the information about the gradients, the editor will put them in the text field.
    2. You can copy/paste your own gradients in the text field.
    3. You can load gradients from a plain text file or .nhdr file.
  3. Undo: Undo the last change of measurement/gradient values.
  4. Redo: Redo the last change of measurement/gradient values.
  5. Restore: All parameters are restored to original.
  6. Run test.
    1. Add a Fiducial List. To see if the chosen parameters are reasonable, you can run a test that automatically
      1. computes the Tensor and
      2. visualizes them by Tractography Seeding. (both with standard values)
  7. Display DTI: Select a DTI volume from the current mrml scene and see its tracts.

Usage

Examples, Use Cases & Tutorials

TODO:

  • Note use cases for which this module is especially appropriate, and/or link to examples.
  • Link to examples of the module's use
  • Link to any existing tutorials

Quick Tour of Features and Use

overview

TODO: List all the panels in your interface, their features, what they mean, and how to use them. For instance:

  • Measurement Frame panel:
  • Gradients panel:
  • Testing panel:

Development

Status / Implementation Progress

The editor is now successfully integrated in the Volumes module of the trunk version of Slicer3.

  • measurement frame (gui/load/change/save): 100%
  • gradients (gui/load/change/save): 100%
  • undo/redo/restore mechanism: 100%
  • test: 75%
    • tensor estimation with existing clm: 100%
    • glyphs view in all32 planes with the possibility to change resolution: 100%
    • alternative tensor estimation with new filter: 0%
      • filter for tensor rotation: 0%
    • tractography fiducial seeding: 100%
  • testing: 0%
  • documentation, tutorials (videos): 40%
  • writing master thesis: 5% :-)

Known bugs

Follow this link to the Slicer3 bug tracker to see known bugs, or to report a new one. Please select the usability issue category when browsing or contributing:

http://na-mic.org/Mantis/main_page.php

Source code & documentation

Source code is available here:

http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientEditorWidget.cxx http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientEditorWidget.h

http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientEditorLogic.cxx http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientEditorLogic.h

http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerMeasurementFrameWidget.cxx http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerMeasurementFrameWidget.h

http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientsWidget.cxx http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerGradientsWidget.h

http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerDWITestingWidget.cxx http://www.na-mic.org/ViewVC/index.cgi/trunk/Modules/Volumes/vtkSlicerDWITestingWidget.h

Links to documentation generated by doxygen:

http://www.na-mic.org/Slicer/Documentation/Slicer3/html/

More Information

Acknowledgement

Include funding and other support here.

References

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

Nrrd format: http://wiki.na-mic.org/Wiki/index.php/NAMIC_Wiki:DTI:Nrrd_format

DTMRI: http://wiki.na-mic.org/Wiki/index.php/Slicer3:DTMRI

DICOM for DWI and DTI : http://wiki.na-mic.org/Wiki/index.php/NAMIC_Wiki:DTI:DICOM_for_DWI_and_DTI