Difference between revisions of "Modules:MultiplyImages-Documentation-3.6"
(21 intermediate revisions by 2 users not shown) | |||
Line 8: | Line 8: | ||
{| | {| | ||
− | |[[Image: | + | |[[Image:mulpanel.png|thumb|280px|User Interface]] |
− | |[[Image: | + | |[[Image:mulimage1.png|thumb|280px|Input Image 1]] |
− | |[[Image: | + | [[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=== | ||
− | * | + | * Author: Bill Lorensen |
− | * | + | * Contact: bill.lorensen at gmail.com |
− | * Contact: | + | * Documentation: Harini Veeraraghavan |
+ | * Contact: veerarag at ge.com | ||
===Module Description=== | ===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 == | == 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, 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 | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===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. | |
− | + | *"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 == | == Development == | ||
Line 72: | Line 44: | ||
===Notes from the Developer(s)=== | ===Notes from the Developer(s)=== | ||
− | + | This module depends on the ITK libraries. | |
===Dependencies=== | ===Dependencies=== | ||
− | + | The Volumes modules is required for this module's use. | |
===Tests=== | ===Tests=== | ||
Line 110: | Line 82: | ||
===Acknowledgment=== | ===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 [http://www.ncbcs.org/ National Centers for Biomedical Computing]. | ||
===References=== | ===References=== | ||
− |
Latest revision as of 20:32, 10 May 2010
Home < Modules:MultiplyImages-Documentation-3.6Return to Slicer 3.6 Documentation
Multiply Images
Multiply
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:
- MultiplyTest MultiplyTest.cxx
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.