sitkUnsharpMaskImageFilter.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 sitkUnsharpMaskImageFilter_h
#define sitkUnsharpMaskImageFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.in to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
 
namespace itk::simple {

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

      virtual ~UnsharpMaskImageFilter();

      UnsharpMaskImageFilter();

      using PixelIDTypeList = RealPixelIDTypeList;
      SITK_RETURN_SELF_TYPE_HEADER SetSigmas(double s) { this->m_Sigmas = std::vector<double>(3, s ); return *this; }
 
\

      SITK_RETURN_SELF_TYPE_HEADER SetSigmas ( std::vector<double> Sigmas ) { this->m_Sigmas = std::move(Sigmas); return *this; }

      std::vector<double> GetSigmas() const { return this->m_Sigmas; }\

      SITK_RETURN_SELF_TYPE_HEADER SetAmount ( double Amount ) { this->m_Amount = Amount; return *this; }

      double GetAmount() const { return this->m_Amount; }\

      SITK_RETURN_SELF_TYPE_HEADER SetThreshold ( double Threshold ) { this->m_Threshold = Threshold; return *this; }

      double GetThreshold() const { return this->m_Threshold; }\

      SITK_RETURN_SELF_TYPE_HEADER SetClamp ( bool Clamp ) { this->m_Clamp = Clamp; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER ClampOn() { return this->SetClamp(true); }
      SITK_RETURN_SELF_TYPE_HEADER ClampOff() { return this->SetClamp(false); }

      bool GetClamp() const { return this->m_Clamp; }

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

      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>;
 
      std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
 
 
      std::vector<double>  m_Sigmas{std::vector<double>(3, 1.0)};
 
      double  m_Amount{0.5};
 
      double  m_Threshold{0.0};
 
      bool  m_Clamp{true};
 
 
    };

 
     SITKBasicFilters_EXPORT Image UnsharpMask ( const Image& image1, std::vector<double> sigmas = std::vector<double>(3, 1.0), double amount = 0.5, double threshold = 0.0, bool clamp = true );

}
#endif