sitkBlackTopHatImageFilter.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright Insight Software Consortium
*
*  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 sitkKernelImageFilterTemplate.h.in to make changes.
 */

#include <memory>

#include "sitkImageFilter.h"
#include "sitkBasicFilters.h"
#include "sitkKernel.h"

namespace itk {
  namespace simple {

    class SITKBasicFilters_EXPORT BlackTopHatImageFilter : public ImageFilter<1> {
    public:
      typedef BlackTopHatImageFilter Self;

      virtual ~BlackTopHatImageFilter();

      BlackTopHatImageFilter();

      typedef BasicPixelIDTypeList  PixelIDTypeList;

    typedef enum{Annulus=sitkAnnulus, Ball=sitkBall, Box=sitkBox, Cross=sitkCross} KernelType;



      SITK_RETURN_SELF_TYPE_HEADER SetSafeBorder ( bool SafeBorder ) { this->m_SafeBorder = SafeBorder; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER SafeBorderOn() { return this->SetSafeBorder(true); }
      SITK_RETURN_SELF_TYPE_HEADER SafeBorderOff() { return this->SetSafeBorder(false); }

        bool GetSafeBorder() const { return this->m_SafeBorder; }
      SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(uint32_t r);

      SITK_RETURN_SELF_TYPE_HEADER SetKernelRadius(const std::vector<uint32_t>  &r );
      std::vector<uint32_t> GetKernelRadius() const;

      SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelEnum t);
#ifndef SWIG
      SITK_RETURN_SELF_TYPE_HEADER SetKernelType(KernelType t);
#endif
      KernelEnum GetKernelType() const;

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

      std::string ToString() const;


      Image Execute ( const Image& image1 );


      Image Execute ( const Image& image1, bool safeBorder );


    private:

      typedef Image (Self::*MemberFunctionType)( const Image& image1 );
      template <class TImageType> Image ExecuteInternal ( const Image& image1 );


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      /*  */
      bool  m_SafeBorder;

      /* Kernel Radius as a vector */
      std::vector<uint32_t> m_KernelRadius;

      KernelEnum m_KernelType;
    };


  Image SITKBasicFilters_EXPORT BlackTopHat ( const Image&,
                                          uint32_t radius = 1, KernelEnum kernel = sitkBall
                                          , bool safeBorder = true );


  Image SITKBasicFilters_EXPORT BlackTopHat ( const Image&,
                                          const std::vector<uint32_t> vectorRadius, KernelEnum kernel = sitkBall
                                          , bool safeBorder = true );
  }
}
#endif