Class MaskImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.MaskImageFilter
Mask an image with a mask.
This class is templated over the types of the input image type, the
mask image type and the type of the output image. Numeric conversions
(castings) are done by the C++ defaults.
The pixel type of the input 2 image must have a valid definition of
the operator != with zero. This condition is required because
internally this filter will perform the operation
The pixel from the input 1 is cast to the pixel type of the output
image.
Note that the input and the mask images must be of the same size.
WARNING:
Any pixel value other than masking value (0 by default) will not be
masked out.
See:
 MaskNegatedImageFilter
 itk::simple::Mask for the procedural interface
 itk::MaskImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkMaskImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::MaskImageFilter::MaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedMaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::MaskImageFilter::~MaskImageFilter() DestructorImage itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input imageprotected voidfinalize()protected static longgetCPtr(MaskImageFilter obj) doubledouble itk::simple::MaskImageFilter::GetMaskingValue() const Method to get the masking value of the mask.getName()std::string itk::simple::MaskImageFilter::GetName() const Name of this classdoubledouble itk::simple::MaskImageFilter::GetOutsideValue() constvoidsetMaskingValue(double MaskingValue) Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask.voidsetOutsideValue(double OutsideValue) Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask.protected static longtoString()std::string itk::simple::MaskImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
- 
Constructor Details- 
MaskImageFilterprotected MaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
MaskImageFilterpublic MaskImageFilter()itk::simple::MaskImageFilter::MaskImageFilter() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::MaskImageFilter::~MaskImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setOutsideValuepublic void setOutsideValue(double OutsideValue) Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask. Defaults to 0
- 
getOutsideValuepublic double getOutsideValue()double itk::simple::MaskImageFilter::GetOutsideValue() const
- 
setMaskingValuepublic void setMaskingValue(double MaskingValue) Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask. Defaults to 0
- 
getMaskingValuepublic double getMaskingValue()double itk::simple::MaskImageFilter::GetMaskingValue() const Method to get the masking value of the mask.
- 
getNamestd::string itk::simple::MaskImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::MaskImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-