sitkWienerDeconvolutionImageFilter.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 sitkWienerDeconvolutionImageFilter_h
#define sitkWienerDeconvolutionImageFilter_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 WienerDeconvolutionImageFilter : public ImageFilter {
    public:
      using Self = WienerDeconvolutionImageFilter;
 
      virtual ~WienerDeconvolutionImageFilter();
 
      WienerDeconvolutionImageFilter();
 
      using PixelIDTypeList = BasicPixelIDTypeList;
\
 
      SITK_RETURN_SELF_TYPE_HEADER SetNoiseVariance ( double NoiseVariance ) { this->m_NoiseVariance = NoiseVariance; return *this; }
 
      double GetNoiseVariance() const { return this->m_NoiseVariance; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
 
      SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
      SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
 
      bool GetNormalize() const { return this->m_Normalize; }
 
      typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
 
      SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
 
      BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
 
      typedef enum {SAME,VALID} OutputRegionModeType;\
 
      SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
 
      OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
 
      std::string GetName() const { return std::string ("WienerDeconvolutionImageFilter"); }
 
      std::string ToString() const;
 
 
      Image Execute ( const Image& image1, const Image& image2 );
 
    private:
 
      using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
      template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
 
 
      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
 
      std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
 
 
      double  m_NoiseVariance{0.0};
 
      /*  */
      bool  m_Normalize{false};
 
      BoundaryConditionType  m_BoundaryCondition{itk::simple::WienerDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD};
 
      OutputRegionModeType  m_OutputRegionMode{itk::simple::WienerDeconvolutionImageFilter::SAME};
 
 
    };
 
     SITKBasicFilters_EXPORT Image WienerDeconvolution ( const Image& image1, const Image& image2, double noiseVariance = 0.0, bool normalize = false, WienerDeconvolutionImageFilter::BoundaryConditionType boundaryCondition = itk::simple::WienerDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, WienerDeconvolutionImageFilter::OutputRegionModeType outputRegionMode = itk::simple::WienerDeconvolutionImageFilter::SAME );
 
}
#endif