Class BlackTopHatImageFilter


public class BlackTopHatImageFilter extends ImageFilter
Black top hat extracts local minima that are smaller than the structuring element. Black top hat extracts local minima that are smaller than the structuring element. It subtracts the background from the input image. The output of the filter transforms the black valleys into white peaks. Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003. Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. See: itk::simple::BlackTopHat for the procedural interface itk::BlackTopHatImageFilter for the Doxygen on the original ITK class. C++ includes: sitkBlackTopHatImageFilter.h
  • Constructor Details

    • BlackTopHatImageFilter

      protected BlackTopHatImageFilter(long cPtr, boolean cMemoryOwn)
    • BlackTopHatImageFilter

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

    • getCPtr

      protected static long getCPtr(BlackTopHatImageFilter obj)
    • swigRelease

      protected static long swigRelease(BlackTopHatImageFilter obj)
    • finalize

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

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

      public void setKernelRadius(VectorUInt32 KernelRadius)
      Self& itk::simple::BlackTopHatImageFilter::SetKernelRadius(unsigned int value) Set the values of the KernelRadius vector all to value
    • setKernelRadius

      public void setKernelRadius(long value)
      Self& itk::simple::BlackTopHatImageFilter::SetKernelRadius(unsigned int value) Set the values of the KernelRadius vector all to value
    • getKernelRadius

      public VectorUInt32 getKernelRadius()
      std::vector<unsigned int> itk::simple::BlackTopHatImageFilter::GetKernelRadius() const Get the radius of the kernel structuring element.
    • setKernelType

      public void setKernelType(KernelEnum KernelType)
      Self& itk::simple::BlackTopHatImageFilter::SetKernelType(KernelEnum KernelType) Set the kernel or structuring element used for the morphology.
    • getKernelType

      public KernelEnum getKernelType()
      KernelEnum itk::simple::BlackTopHatImageFilter::GetKernelType() const Get the kernel or structuring element used for the morphology.
    • setSafeBorder

      public void setSafeBorder(boolean SafeBorder)
      Self& itk::simple::BlackTopHatImageFilter::SetSafeBorder(bool SafeBorder) A safe border is added to input image to avoid borders effects and remove it once the closing is done
    • safeBorderOn

      public void safeBorderOn()
      Self& itk::simple::BlackTopHatImageFilter::SafeBorderOn() Set the value of SafeBorder to true or false respectfully.
    • safeBorderOff

      public void safeBorderOff()
      Self& itk::simple::BlackTopHatImageFilter::SafeBorderOff()
    • getSafeBorder

      public boolean getSafeBorder()
      bool itk::simple::BlackTopHatImageFilter::GetSafeBorder() const A safe border is added to input image to avoid borders effects and remove it once the closing is done
    • getName

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

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

      public Image execute(Image image1)
      Image itk::simple::BlackTopHatImageFilter::Execute(const Image &image1) Execute the filter on the input image