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

From Slicer Wiki
Jump to: navigation, search
 
(23 intermediate revisions by 2 users not shown)
Line 8: Line 8:
  
 
{|
 
{|
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
+
|[[Image:mulpanel.png|thumb|280px|User Interface]]
|[[Image:screenshotBlank.png|thumb|280px|Output]]
+
|[[Image:mulimage1.png|thumb|280px|Input Image 1]]
|[[Image:screenshotBlank.png|thumb|280px|Caption]]
+
[[Image:mulimage2.png|thumb|280px|Input Image 2]]
 +
|[[Image:mulresult.png|thumb|280px|Result Image]]
 +
 
 
|}
 
|}
  
Line 21: Line 23:
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
* Author1: Bill Lorensen
+
* Author: Bill Lorensen
* Contributor1: Affiliation & logo, if desired
+
* Contact: bill.lorensen at gmail.com
* Contact: Name, email
+
* Documentation: Harini Veeraraghavan
 +
* Contact: veerarag at ge.com
  
 
===Module Description===
 
===Module Description===
Multiply two volumes together.
+
Module performs pixel-wise multiplication of two images. The module automatically handles different resolution of the input images. The module supports input images of any data type.
  
 
== Usage ==
 
== Usage ==
 
+
Load the input volumes(images). The default setting of the parameter Interpolation Setting is 1. For input images of the same size, this setting will work correctly. In general, its best to use input images of the same size for the multiplication operation.
===Use Cases, Examples===
+
===Examples, Use Cases & Tutorials===
 
+
This module can be used for producing intermediate results that can then be as inputs to other modules. Multiplication can also implicitly serve as a masking operation (when the portions of the image to be masked out are set to 0 in one of the input images). The example result depicted on this page, shows the multiplication of two images (input image 1) and a (input image 2) and the result depicts the input volume contained in the input image 2. Note that the multiple will produce a valid masking operation only when the regions to be masked out are 0. In general, this may not be the case and its best to use the MaskImages module.
This module is especially appropriate for these use cases:
 
 
 
* Use Case 1:
 
* Use Case 2:
 
 
 
Examples of the module in use:
 
 
 
* Example 1
 
* Example 2
 
 
 
===Tutorials===
 
 
 
Links to tutorials explaining how to use this module:
 
 
 
* Tutorial 1
 
** Data Set 1
 
  
 
===Quick Tour of Features and Use===
 
===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 an output image of the same size as the first input image.
A list panels in the interface, their features, what they mean, and how to use them. For instance:
+
*"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-sampling it to the same size as the first input image. The default setting is 1.
 
 
{|
 
|
 
* '''Input panel:'''
 
** '''First input'''
 
** '''Second input'''
 
* '''Parameters panel:'''
 
** '''First parameter'''
 
** '''Second parameter'''
 
* '''Output panel:'''
 
** '''First output'''
 
** '''Second output'''
 
* '''Viewing panel:'''
 
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
 
|}
 
  
 
== Development ==
 
== Development ==
Line 72: Line 44:
 
===Notes from the Developer(s)===
 
===Notes from the Developer(s)===
  
Algorithms used, library classes depended upon, use cases, etc.
+
This module depends on the ITK libraries.
  
 
===Dependencies===
 
===Dependencies===
  
Other modules or packages that are required for this module's use.
+
The Volumes modules is required for this module's use.
  
 
===Tests===
 
===Tests===
Line 88: Line 60:
 
Links to known bugs in the Slicer3 bug tracker
 
Links to known bugs in the Slicer3 bug tracker
  
* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]  
+
<!--
 
+
* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]
 +
-->
  
 
===Usability issues===
 
===Usability issues===
Line 109: Line 82:
  
 
===Acknowledgment===
 
===Acknowledgment===
Include funding and other support here.
+
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 [http://www.ncbcs.org/ National Centers for Biomedical Computing].
  
 
===References===
 
===References===
Publications related to this module go here. Links to pdfs would be useful.
 

Latest revision as of 20:32, 10 May 2010

Home < Modules:MultiplyImages-Documentation-3.6

Return to Slicer 3.6 Documentation

Gallery of New Features


Multiply Images

Multiply

User Interface
Input Image 1
Input Image 2
Result Image

General Information

Module Type & Category

Type: CLI

Category: Filtering.Arithmetic

Authors, Collaborators & Contact

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

Module Description

Module performs pixel-wise multiplication of two images. The module automatically handles different resolution of the input images. The module supports input images of any data type.

Usage

Load the input volumes(images). The default setting of the parameter Interpolation Setting is 1. For input images of the same size, this setting will work correctly. In general, its best to use input images of the same size for the multiplication operation.

Examples, Use Cases & Tutorials

This module can be used for producing intermediate results that can then be as inputs to other modules. Multiplication can also implicitly serve as a masking operation (when the portions of the image to be masked out are set to 0 in one of the input images). The example result depicted on this page, shows the multiplication of two images (input image 1) and a (input image 2) and the result depicts the input volume contained in the input image 2. Note that the multiple will produce a valid masking operation only when the regions to be masked out are 0. In general, this may not be the case and its best to use the MaskImages module.

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 an output image of the same size as the first input image.
  • "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-sampling it to the same size as the first input image. The default setting is 1.

Development

Notes from the Developer(s)

This module depends on the ITK libraries.

Dependencies

The Volumes modules is required for this module's use.

Tests

On the Dashboard, these tests verify that the module is working on various platforms:

Known bugs

Links to known bugs in 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

Links to the module's source code:

Source code:

Doxygen documentation:

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