Class ConvolutionImageFilter


public class ConvolutionImageFilter extends ImageFilter
Convolve a given image with an arbitrary image kernel. This filter operates by centering the flipped kernel at each pixel in the image and computing the inner product between pixel values in the image and pixel values in the kernel. The center of the kernel is defined as $ \\lfloor (2*i+s-1)/2 \\rfloor $ where $i$ is the index and $s$ is the size of the largest possible region of the kernel image. For kernels with odd sizes in all dimensions, this corresponds to the center pixel. If a dimension of the kernel image has an even size, then the center index of the kernel in that dimension will be the largest integral index that is less than the continuous index of the image center. The kernel can optionally be normalized to sum to 1 using NormalizeOn() . Normalization is off by default. WARNING: This filter ignores the spacing, origin, and orientation of the kernel image and treats them as identical to those in the input image. This code was contributed in the Insight Journal paper: "Image Kernel Convolution" by Tustison N., Gee J. https://insight-journal.org/browse/publication/208 Nicholas J. Tustison James C. Gee See: itk::simple::Convolution for the procedural interface itk::ConvolutionImageFilter for the Doxygen on the original ITK class. C++ includes: sitkConvolutionImageFilter.h
  • Constructor Details

    • ConvolutionImageFilter

      protected ConvolutionImageFilter(long cPtr, boolean cMemoryOwn)
    • ConvolutionImageFilter

      public ConvolutionImageFilter()
      itk::simple::ConvolutionImageFilter::ConvolutionImageFilter() Default Constructor that takes no arguments and initializes default parameters
  • Method Details

    • getCPtr

      protected static long getCPtr(ConvolutionImageFilter obj)
    • swigRelease

      protected static long swigRelease(ConvolutionImageFilter obj)
    • finalize

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

      public void delete()
      virtual itk::simple::ConvolutionImageFilter::~ConvolutionImageFilter() Destructor
      Overrides:
      delete in class ImageFilter
    • setNormalize

      public void setNormalize(boolean Normalize)
      Self& itk::simple::ConvolutionImageFilter::SetNormalize(bool Normalize) Normalize the output image by the sum of the kernel components
    • normalizeOn

      public void normalizeOn()
      Self& itk::simple::ConvolutionImageFilter::NormalizeOn() Set the value of Normalize to true or false respectfully.
    • normalizeOff

      public void normalizeOff()
      Self& itk::simple::ConvolutionImageFilter::NormalizeOff()
    • getNormalize

      public boolean getNormalize()
      bool itk::simple::ConvolutionImageFilter::GetNormalize() const
    • setBoundaryCondition

      public void setBoundaryCondition(ConvolutionImageFilter.BoundaryConditionType BoundaryCondition)
      Self& itk::simple::ConvolutionImageFilter::SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
    • getBoundaryCondition

      public ConvolutionImageFilter.BoundaryConditionType getBoundaryCondition()
      BoundaryConditionType itk::simple::ConvolutionImageFilter::GetBoundaryCondition() const
    • setOutputRegionMode

      public void setOutputRegionMode(ConvolutionImageFilter.OutputRegionModeType OutputRegionMode)
      Self& itk::simple::ConvolutionImageFilter::SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
    • getOutputRegionMode

      public ConvolutionImageFilter.OutputRegionModeType getOutputRegionMode()
      OutputRegionModeType itk::simple::ConvolutionImageFilter::GetOutputRegionMode() const
    • getName

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

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

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