Class MaskImageFilter


public class MaskImageFilter extends ImageFilter
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
  • 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

      protected static long getCPtr(MaskImageFilter obj)
    • swigRelease

      protected static long swigRelease(MaskImageFilter obj)
    • finalize

      protected void finalize()
      Overrides:
      finalize in class ImageFilter
    • delete

      public void delete()
      virtual itk::simple::MaskImageFilter::~MaskImageFilter() Destructor
      Overrides:
      delete in class ImageFilter
    • 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

      public String getName()
      std::string itk::simple::MaskImageFilter::GetName() const Name of this class
      Overrides:
      getName in class ProcessObject
    • toString

      public String toString()
      std::string itk::simple::MaskImageFilter::ToString() const Print ourselves out
      Overrides:
      toString in class ProcessObject
    • execute

      public Image execute(Image image, Image maskImage)
      Image itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input image