Package org.itk.simple
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 Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::MaskImageFilter::MaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
MaskImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::MaskImageFilter::~MaskImageFilter() DestructorImage itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input imageprotected void
finalize()
protected static long
getCPtr
(MaskImageFilter obj) double
double 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 classdouble
double itk::simple::MaskImageFilter::GetOutsideValue() constvoid
setMaskingValue
(double MaskingValue) Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask.void
setOutsideValue
(double OutsideValue) Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask.protected static long
toString()
std::string itk::simple::MaskImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, 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
-
MaskImageFilter
protected MaskImageFilter(long cPtr, boolean cMemoryOwn) -
MaskImageFilter
public MaskImageFilter()itk::simple::MaskImageFilter::MaskImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::MaskImageFilter::~MaskImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setOutsideValue
public void setOutsideValue(double OutsideValue) Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask. Defaults to 0 -
getOutsideValue
public double getOutsideValue()double itk::simple::MaskImageFilter::GetOutsideValue() const -
setMaskingValue
public void setMaskingValue(double MaskingValue) Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask. Defaults to 0 -
getMaskingValue
public double getMaskingValue()double 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 class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::MaskImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input image
-