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

From Slicer Wiki
Jump to: navigation, search
Line 72: Line 72:
 
# If the active volume is a DWI the editor will put the gradients in the text field; otherwise this frame is disabled.
 
# If the active volume is a DWI the editor will put the gradients in the text field; otherwise this frame is disabled.
 
# You can copy/paste your own gradients in the text field or change them manually.
 
# You can copy/paste your own gradients in the text field or change them manually.
# You can load gradients from a text file or .nhdr file. For the .txt file the format of gradients is easy, it can contain only values <font color="Red">(see example data)</font> .
+
# You can load gradients from a text file or .nhdr file. For the .txt file the format of gradients is easy, it can contain only values ([[ media:DiffusionEditor_ExampleData.zip | see example data ]]).
  
 
* '''Undo/Redo/Restore:'''
 
* '''Undo/Redo/Restore:'''

Revision as of 21:17, 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.

Usage

Examples & Tutorials

TODO:

title used data short description
Load ___ Load a DWI dicom data set in Slicer.
Measurement frame ___ Change the measurement frame by rotating, swaping, negating or changing to idendity.
Gradients ___ Change gradients manually or load them from a file.
Testing ___ Run tensor estimation and show glyphs and tracts;

Run second estimation with 90°rotation and switch between both tensors and see the impact of that change.

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.

  • Measurement frame:
  1. The determinant of the measurement frame has to be 1. This is checked by the editor.
  2. Negate: Select the columns you want to negate.
  3. Swap: Select two columns you want to swap.
  4. Rotate: Select one column you want to rotate by an angle you can choose from a given set of values or set yourself.
  5. Idendity: Set the measurement frame to the idendity matrix.
  6. Set your own values.
  • Gradients frame:
  1. If the active volume is a DWI the editor will put the gradients in the text field; otherwise this frame is disabled.
  2. You can copy/paste your own gradients in the text field or change them manually.
  3. You can load gradients from a text file or .nhdr file. For the .txt file the format of gradients is easy, it can contain only values ( see example data ).
  • Undo/Redo/Restore:
  1. Undo: Undo the last change of measurement/gradient values.
  2. Redo: Redo the last change of measurement/gradient values.
  3. Restore: All parameters are restored to original.

NOTE: You lose all previous changes when a new active volume is loaded or selected.

  • Testing frame:
  1. Run tensor estimation. The new tensor node shows up in the DTI selector.
  2. Select a DTI node from the current mrml scene and
    1. view glyphs. Select the planes on which you want to see glyphs.
    2. view tracts with Tractography Fiducial Seeding. Add some fiducials and choose the fiducial list in the selector.

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