sitkBlackTopHatImageFilter.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright NumFOCUS
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*         http://www.apache.org/licenses/LICENSE-2.0.txt
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
*=========================================================================*/
#ifndef sitkBlackTopHatImageFilter_h
#define sitkBlackTopHatImageFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.jinja to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
#include "sitkProcessObjectDeleter.h"
 
namespace itk::simple {

class SITKBasicFilters_EXPORT BlackTopHatImageFilter : public ImageFilter {
public:
  using Self = BlackTopHatImageFilter;

  virtual ~BlackTopHatImageFilter();

  BlackTopHatImageFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

  void
  SetKernelRadius(std::vector<unsigned int> KernelRadius )
    { this->m_KernelRadius = std::move(KernelRadius); }

  void
  SetKernelRadius( unsigned int value ) { this->m_KernelRadius = std::vector<unsigned int>(3, value); }
  std::vector<unsigned int>
  GetKernelRadius() const { return this->m_KernelRadius; }
 

  void
  SetKernelType(KernelEnum KernelType )
    { this->m_KernelType = KernelType; }

  KernelEnum
  GetKernelType() const { return this->m_KernelType; }
 

  void
  SetSafeBorder(bool SafeBorder )
    { this->m_SafeBorder = SafeBorder; }

  void
  SafeBorderOn() { return this->SetSafeBorder(true); }
  void
  SafeBorderOff() { return this->SetSafeBorder(false); }
  bool
  GetSafeBorder() const { return this->m_SafeBorder; }
 

  std::string GetName() const { return std::string("BlackTopHatImageFilter"); }

  std::string ToString() const;
 

  Image Execute(const Image &image1);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image &image1);
  template <class TImageType> Image ExecuteInternal(const Image &image1);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    std::vector<unsigned int> m_KernelRadius{ std::vector<uint32_t>(3, 1) };
 
    KernelEnum m_KernelType{ itk::simple::sitkBall };
 
    bool m_SafeBorder{ true };
 
 
 
 
 
 
 
};
 

SITKBasicFilters_EXPORT Image BlackTopHat(
    const Image &image1, std::vector<unsigned int> kernelRadius = std::vector<uint32_t>(3, 1), KernelEnum kernelType = itk::simple::sitkBall, bool safeBorder = true
);

 
}
#endif