Slicer3:Module Documentation-3.5 Template - Revision history

Nicole: /* Source code & documentation */

2010-01-15T22:29:54Z

Source code & documentation

Elhawary: Undo revision 9943 by Elhawary (Talk)

2009-06-29T22:59:03Z

Undo revision 9943 by Elhawary (Talk)

Elhawary at 22:52, 29 June 2009

2009-06-29T22:52:32Z

Sylvainjaume: create template for Slicer 3 documentation 3.5

2009-06-06T13:47:49Z

create template for Slicer 3 documentation 3.5

New page

[[Documentation-3.5|Return to Slicer 3.5 Documentation]]

[[Announcements:Slicer3.5#Highlights|Gallery of New Features]]

__NOTOC__
===Module Name===
MyModule

{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
|}

== General Information ==
===Module Type & Category===

Type: Interactive or CLI

Category: Base or (Filtering, Registration, ''etc.'')

===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
* Contributor1: Affiliation & logo, if desired
* Contributor2: Affiliation & logo, if desired
* Contact: name, email

===Module Description===
Overview of what the module does goes here.

== Usage ==

===Examples, Use Cases & Tutorials===

* 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===
List all the panels in your interface, their features, what they mean, and how to use them. For instance:

* '''Input panel:'''
* '''Parameters panel:'''
* '''Output panel:'''
* '''Viewing panel:'''

== Development ==

===Dependencies===

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

===Known bugs===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker.

===Usability issues===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.

===Source code & documentation===

Customize following [http://viewvc.slicer.org/viewcvs.cgi/ links] for your module.

[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.

== More Information ==

===Acknowledgment===
Include funding and other support here.

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

@@ Line 62: / Line 62: @@
 ===Source code & documentation===
-Customize following [http://viewvc.slicer.org/viewcvs.cgi/ links] for your module.
+Customize following links for your module:
 == More Information ==

@@ Line 4: / Line 4: @@
 __NOTOC__
-===Registration Metrics===
+===Module Name===
 MyModule
 {|
-|[[Image:RegistrationMetricsScreenshot.png|thumb|280px|Screen shot of Registration Metrics module showing an axial slice with a color map representing alignment error between the two label map images]]
+|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
-|[[Image:SlicerPanel.PNG|thumb|280px|Screen shot of panel for Registration Metrics Module]]
+|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
 |}
@@ Line 15: / Line 16: @@
 ===Module Type & Category===
-Type: CLI
+Type: Interactive or CLI
-Category: Registration
+Category: Base or (Filtering, Registration, ''etc.'')
 ===Authors, Collaborators & Contact===
-* Haytham Elhawary: Brigham and Women's Hospital, SPL
+* Author1: Affiliation & logo, if desired
-* Sota Oguro: Brigham and Women's Hospital, SPL
+* Contributor1: Affiliation & logo, if desired
-* Nobuhiko Hata: Brigham and Women's Hospital, SPL
+* Contributor2: Affiliation & logo, if desired
-* Contact: Haytham Elhawary, elhawary [at] bwh.harvard.edu
+* Contact: name, email
 ===Module Description===
-This module is capable of calculating the 95% Hausdorff distance (HD) and the Dice Similarity Coefficient (DSC) between two label map images. If the two label map images represent registered segmented structures then the 95% HD and DSC will provide a measure of contour and volumetric alignment between the images. The HD is the maximum distance of a set to the nearest point in another set and gives a measure of contour alignment between structures. The DSC gives a measure of the volumetric overlap between the two segmented structures, and indicates twice the number of voxels which are shared by or are common to both structures divided by the total number of non-zero voxels in both structures. The DSC can range from zero to one, where zero is no alignment between images and one is perfect alignment. These two metrics are explained more formally in papers presented in the References section.
+Overview of what the module does goes here.
 == Usage ==
-* Image Volume 1 and Image Volume 2 are two label map images which you wish to load and compare
+===Examples, Use Cases & Tutorials===
-===Examples, Use Cases & Tutorials===
+* Note use cases for which this module is especially appropriate, and/or link to examples.
-* Here are two example label map images, CTlabel.nrrd and Defolabel.nrrd: [[Media: ExampleData.tar.gz | ExampleData]]
+* '''Input panel:'''
-* Load them into the RegistrationMetrics Module, which can be found under the Registration category in the Modules menu.
+* '''Parameters panel:'''
-* The DSC should be 0.959906 and the 95% HD is 3.66408mm, which is printed into the Log Viewer in Slicer and the Terminal
+* '''Output panel:'''
-* An output volume named "Registration Metrics Volume" should be created, which shows the contour of one of the input images.
+* '''Viewing panel:'''
 == Development ==
@@ Line 49: / Line 49: @@
 ===Dependencies===
-No dependencies are required, except the Volume module to load images into Slicer.
+Other modules or packages that are required for this module's use.
 ===Source code & documentation===
-Source code, color map and example data can be found [http://svn.na-mic.org/NAMICSandBox/trunk/IGTLoadableModules/RegistrationMetrics here].
+Customize following [http://viewvc.slicer.org/viewcvs.cgi/ links] for your module.
 == More Information ==
 ===Acknowledgment===
-This work was made possible by Grants Number 5U41RR019703, 1R01CA124377 and 5U54EB005149 from NIH, and by Intelligent Surgical Instruments Project of METI (Japan).
+Include funding and other support here.
 ===References===
-The first publication refers to an explanation of the 95% Hausdorff distance and the second to the use of the Dice Similarity Coefficient.
+Publications related to this module go here. Links to pdfs would be useful.