Difference between revisions of "Modules:SubtractImages-Documentation-3.6"

From Slicer Wiki
Jump to: navigation, search
(Created page with 'Return to Slicer 3.6 Documentation Gallery of New Features __NOTOC__ ===Module Name=== Filtering:Subtract {| |[[Ima…')
 
 
(18 intermediate revisions by the same user not shown)
Line 7: Line 7:
  
 
{|
 
{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
+
|[[Image:SubtractImagesPanel.png|thumb|280px|Screenshot of the module depicts the inputs, outputs, and parameters]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
+
|[[Image:image1.png|thumb|280px|Example input mask (1) along with the original image]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
+
||[[Image:image2.png|thumb|280px|Example input mask (2) along with the original image]]
 +
|[[Image:resultsubtractImage1.png|thumb|280px|Output of subtracting mask (1) and mask (2)]]
 
|}
 
|}
  
Line 22: Line 23:
 
* Author: Bill Lorensen
 
* Author: Bill Lorensen
 
* Contact: bill.lorensen at gmail.com
 
* Contact: bill.lorensen at gmail.com
 +
* Documentation: Harini Veeraraghavan
 +
* Contact: veerarag at ge.com
  
 
===Module Description===
 
===Module Description===
The module performs pixel-wise subtraction
+
The module performs pixel-wise subtraction of images. The module automatically handles images of different resolution. The module supports operations on input images of any data type.
Overview of what the module does goes here.
 
 
 
Note: the module performs pixel-size subtraction. Currently, it is the responsibility of the user to make sure that the input images have the same size.
 
  
 
== Usage ==
 
== Usage ==
 
+
Load the input images. The default setting of the input parameter ''Interpolation Order'' is 1. The Interpolation Order is relevant only for rescaling one of the input images in the case when the two input images are not of the same size.
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
 
+
This module can be used for the following:
* Note use cases for which this module is especially appropriate, and/or link to examples.
+
* Producing intermediate results that can then be plugged as inputs to other filters and modules.  
* Link to examples of the module's use
+
* Compare the results produced by two different algorithms. The example depicted on this page shows the subtraction performed on two different segmentation masks. The segmentation masks were produced by two different algorithms.
* Link to any existing tutorials
+
* Additionally, this module can also be used to directly visualize the results of segmentation compared with a ground truth mask.
  
 
===Quick Tour of Features and Use===
 
===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:
+
*"Inputs/Outputs:" This module requires two input volumes(images), and the specification of an output volume(image). The module produces the output volume(image) of the same size as the first input.  
 
+
*"Parameters:" The module uses one parameter ''Interpolation Order''. The interpolation order sets the degree of B-spline interpolation to be performed on the second input image for re-scaling it to the same size as the first input image. The default setting is 1.
* '''Input panel:'''
 
* '''Parameters panel:'''
 
* '''Output panel:'''
 
* '''Viewing panel:'''
 
  
 
== Development ==
 
== Development ==
Line 49: Line 45:
 
===Dependencies===
 
===Dependencies===
  
Other modules or packages that are required for this module's use.
+
The module uses the ITK filters.
  
 
===Known bugs===
 
===Known bugs===
Line 62: Line 58:
 
===Source code & documentation===
 
===Source code & documentation===
  
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/]
+
Source Code:  
 +
*[http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/Subtract.cxx Subtract.cxx]
 +
*[http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/Subtract.xml Subtract.xml]
  
Documentation:
+
Test Code:  
 +
*[http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/Testing/SubtractTest.cxx SubtractTest.cxx]
  
 
== More Information ==  
 
== More Information ==  

Latest revision as of 14:20, 26 April 2010

Home < Modules:SubtractImages-Documentation-3.6

Return to Slicer 3.6 Documentation

Gallery of New Features

Module Name

Filtering:Subtract

Screenshot of the module depicts the inputs, outputs, and parameters
Example input mask (1) along with the original image
Example input mask (2) along with the original image
Output of subtracting mask (1) and mask (2)

General Information

Module Type & Category

Type: CLI

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

Authors, Collaborators & Contact

  • Author: Bill Lorensen
  • Contact: bill.lorensen at gmail.com
  • Documentation: Harini Veeraraghavan
  • Contact: veerarag at ge.com

Module Description

The module performs pixel-wise subtraction of images. The module automatically handles images of different resolution. The module supports operations on input images of any data type.

Usage

Load the input images. The default setting of the input parameter Interpolation Order is 1. The Interpolation Order is relevant only for rescaling one of the input images in the case when the two input images are not of the same size.

Examples, Use Cases & Tutorials

This module can be used for the following:

  • Producing intermediate results that can then be plugged as inputs to other filters and modules.
  • Compare the results produced by two different algorithms. The example depicted on this page shows the subtraction performed on two different segmentation masks. The segmentation masks were produced by two different algorithms.
  • Additionally, this module can also be used to directly visualize the results of segmentation compared with a ground truth mask.

Quick Tour of Features and Use

  • "Inputs/Outputs:" This module requires two input volumes(images), and the specification of an output volume(image). The module produces the output volume(image) of the same size as the first input.
  • "Parameters:" The module uses one parameter Interpolation Order. The interpolation order sets the degree of B-spline interpolation to be performed on the second input image for re-scaling it to the same size as the first input image. The default setting is 1.

Development

Dependencies

The module uses the ITK filters.

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

Source Code:

Test Code:

More Information

Acknowledgment

This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from National Centers for Biomedical Computing.

References