Difference between revisions of "Modules:RegistrationMetrics-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
Line 29: Line 29:
  
 
== Usage ==
 
== Usage ==
 +
 +
* Image Volume 1 and Image Volume 2 are two label map images which you wish to load and compare
 +
* The module will provide the DSC and 95% HD between the two images, and will also provide an output volume. The output volume represents the contour of one of the images with each pixel value representing the Hausdorff Distance to the contour of the other image. Both the DSC and 95% HD will be printed onto the Log viewer in Slicer (can be accessed by clicking on the "X" icon that is located at the bottom right hand corner of the Slicer window) and on the Terminal for operating systems other than Windows.
 +
* For improved visualization, the output image should be viewed with a color map. The code provides a color map entitled "Matlab_colormap.txt" which should be used for visualization of the output volume. Change the lower bound of the Threshold in the Display panel of the Volume Module to 0.01.
  
 
===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 label map images:
* 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===

Revision as of 22:20, 29 June 2009

Home < Modules:RegistrationMetrics-Documentation-3.4

Return to Slicer 3.4 Documentation

Gallery of New Features


Registration Metrics

MyModule

Screen shot of Registration Metrics module showing an axial slice with a color map representing alignment error between the two label map images
Screen shot of panel for Registration Metrics Module

General Information

Module Type & Category

Type: CLI

Category: Registration

Authors, Collaborators & Contact

  • Haytham Elhawary: Brigham and Women's Hospital, SPL
  • Sota Oguro: Brigham and Women's Hospital, SPL
  • Nobuhiko Hata: Brigham and Women's Hospital, SPL
  • Contact: Haytham Elhawary, elhawary [at] bwh.harvard.edu

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.

Usage

  • Image Volume 1 and Image Volume 2 are two label map images which you wish to load and compare
  • The module will provide the DSC and 95% HD between the two images, and will also provide an output volume. The output volume represents the contour of one of the images with each pixel value representing the Hausdorff Distance to the contour of the other image. Both the DSC and 95% HD will be printed onto the Log viewer in Slicer (can be accessed by clicking on the "X" icon that is located at the bottom right hand corner of the Slicer window) and on the Terminal for operating systems other than Windows.
  • For improved visualization, the output image should be viewed with a color map. The code provides a color map entitled "Matlab_colormap.txt" which should be used for visualization of the output volume. Change the lower bound of the Threshold in the Display panel of the Volume Module to 0.01.

Examples, Use Cases & Tutorials

  • Here are two label map images:

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 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.

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.