sitkTikhonovDeconvolutionImageFilter.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 sitkTikhonovDeconvolutionImageFilter_h
#define sitkTikhonovDeconvolutionImageFilter_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 {
  namespace simple {

    class SITKBasicFilters_EXPORT TikhonovDeconvolutionImageFilter : public ImageFilter<2> {
    public:
      typedef TikhonovDeconvolutionImageFilter Self;

      virtual ~TikhonovDeconvolutionImageFilter();

      TikhonovDeconvolutionImageFilter();

      typedef BasicPixelIDTypeList  PixelIDTypeList;



      SITK_RETURN_SELF_TYPE_HEADER SetRegularizationConstant ( double RegularizationConstant ) { this->m_RegularizationConstant = RegularizationConstant; return *this; }

        double GetRegularizationConstant() const { return this->m_RegularizationConstant; }

      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 ("TikhonovDeconvolutionImageFilter"); }

      std::string ToString() const;


      Image Execute ( const Image& image1, const Image& image2 );


      Image Execute ( const Image& image1, const Image& image2, double regularizationConstant, bool normalize, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode );

    private:

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


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

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


      double  m_RegularizationConstant;
      /*  */
      bool  m_Normalize;
      BoundaryConditionType  m_BoundaryCondition;
      OutputRegionModeType  m_OutputRegionMode;
    };


     SITKBasicFilters_EXPORT Image TikhonovDeconvolution ( const Image& image1, const Image& image2, double regularizationConstant = 0.0, bool normalize = false, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition = itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode = itk::simple::TikhonovDeconvolutionImageFilter::SAME );

  }
}
#endif