Difference between revisions of "Documentation/4.0/Modules/TractographyDisplay"

From Slicer Wiki
Jump to: navigation, search
m
m
Line 22: Line 22:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
+
Allows the user to manipulate several different characteristics of the traced white matter tracts. Examples are: change of color; display of the fractional anisotropy along the tract; display of the tracts as tubes or lines; interactive selection of the tracts; and cropping.
  
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
 
−
 
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
−
 
−
Using this later template, the final syntax would be:
 
−
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
Line 43: Line 33:
 
Most frequently used for these scenarios:
 
Most frequently used for these scenarios:
  
−
* Use Case 1:
+
* Use Case 1: Change the scalar quantity displayed along the tract, like Fractional Anisotropy or Color By Orientation
−
* Use Case 2:
+
* Use Case 2: Display the tracts as lines or tubes
 +
* Use Case 2: Interactive selection or cropping of a certain bundle.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 23:11, 25 November 2011

Home < Documentation < 4.0 < Modules < TractographyDisplay


Introduction and Acknowledgements

This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the NA-MIC website.
Author: Isaiah Norton, Goldby Lab
Author: Demian Wassermann, SPL
Contributor1: Steve Pieper, Isomics
Contributor1: Alex Yarmanovich, Isomics
Contact: Demian Wassermann, <email>demian@bwh.harvard.edu</email>

Surgical Planning Laboratory  


Module Description

Allows the user to manipulate several different characteristics of the traced white matter tracts. Examples are: change of color; display of the fractional anisotropy along the tract; display of the tracts as tubes or lines; interactive selection of the tracts; and cropping.


Use Cases

Most frequently used for these scenarios:

  • Use Case 1: Change the scalar quantity displayed along the tract, like Fractional Anisotropy or Color By Orientation
  • Use Case 2: Display the tracts as lines or tubes
  • Use Case 2: Interactive selection or cropping of a certain bundle.

Tutorials

Links to tutorials that use this module

Panels and their use

A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:

  • Input panel1:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 1
  • Input panel2:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 2

Similar Modules

  • Point to other modules that have similar functionality

References

Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation

Information for Developers

Work in progress
 Section under construction.


Note The section above is generated using the following wiki code: 

{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}

If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:

{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL: 

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be: 

{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Modules/TractographyDisplay&oldid=23363"