Difference between revisions of "Modules:MaskImage-Documentation-3.5"
From Slicer Wiki
| Line 31: | Line 31: | ||
===Quick Tour of Features and Use=== | ===Quick Tour of Features and Use=== | ||
| − | *Input Volume: the image to be masked | + | *'''Input Volume:''' the image to be masked |
| − | *Mask Volume: labelmap containing the region to be preserved as a specific (single) label value | + | *'''Mask Volume:''' labelmap containing the region to be preserved as a specific (single) label value |
| − | *Masked Volume: result image created. Equals the Input Volume with all voxels not part of the mask replaced. | + | *'''Masked Volume:''' result image created. Equals the Input Volume with all voxels not part of the mask replaced. |
| − | *Label Value: value of the Mask Volume to use as ROI. All voxels '''not''' matching this value will be replaced. All voxels matching this value will be preserved. | + | *'''Label Value:''' value of the Mask Volume to use as ROI. All voxels '''not''' matching this value will be replaced. All voxels matching this value will be preserved. |
| − | *Replace Value: value to set for all voxels "outside" the mask. To remove unwanted structure, zero (0) is the common default. All voxels not matching the Label Value above will be set to this Replace Value. | + | *'''Replace Value:''' value to set for all voxels "outside" the mask. To remove unwanted structure, zero (0) is the common default. All voxels not matching the Label Value above will be set to this Replace Value. |
== Development == | == Development == | ||
Revision as of 17:15, 28 January 2010
Home < Modules:MaskImage-Documentation-3.5Return to Slicer 3.4 Documentation
Mask Image
Mask Image
General Information
Module Type & Category
Type:
Category: Filtering, Arithmetic
Authors, Collaborators & Contact
- Contact:
Module Description
Apply a labelmap as a mask and set all pixels outside the mask (i.e. not matching the label value) to zero (or a given replacement value)
Usage
Examples, Use Cases & Tutorials
- Useful for masking unwanted structures in processes that do not support masking directly.
Quick Tour of Features and Use
- Input Volume: the image to be masked
- Mask Volume: labelmap containing the region to be preserved as a specific (single) label value
- Masked Volume: result image created. Equals the Input Volume with all voxels not part of the mask replaced.
- Label Value: value of the Mask Volume to use as ROI. All voxels not matching this value will be replaced. All voxels matching this value will be preserved.
- Replace Value: value to set for all voxels "outside" the mask. To remove unwanted structure, zero (0) is the common default. All voxels not matching the Label Value above will be set to this Replace Value.
Development
Dependencies
The Volumes module is required for this module's use.
WARNING: This module is available in Slicer 3.4 release only after 3.4.1 version (builds of Dec 10, 2009 and on)!
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
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.
