sitkTikhonovDeconvolutionImageFilter.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 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.jinja to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
#include "sitkProcessObjectDeleter.h"
 
namespace itk::simple {

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

  virtual ~TikhonovDeconvolutionImageFilter();

  TikhonovDeconvolutionImageFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

  void
  SetRegularizationConstant(double RegularizationConstant )
    { this->m_RegularizationConstant = RegularizationConstant; }

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

  void
  SetNormalize(bool Normalize )
    { this->m_Normalize = Normalize; }

  void
  NormalizeOn() { return this->SetNormalize(true); }
  void
  NormalizeOff() { return this->SetNormalize(false); }
  bool
  GetNormalize() const { return this->m_Normalize; }
 
    typedef enum { ZERO_PAD, ZERO_FLUX_NEUMANN_PAD, PERIODIC_PAD } BoundaryConditionType;

  void
  SetBoundaryCondition(BoundaryConditionType BoundaryCondition )
    { this->m_BoundaryCondition = BoundaryCondition; }

  BoundaryConditionType
  GetBoundaryCondition() const { return this->m_BoundaryCondition; }
 
    typedef enum { SAME, VALID } OutputRegionModeType;

  void
  SetOutputRegionMode(OutputRegionModeType OutputRegionMode )
    { this->m_OutputRegionMode = OutputRegionMode; }

  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);
 
 
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>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    double m_RegularizationConstant{ 0.0 };
 
    bool m_Normalize{ false };
 
    BoundaryConditionType m_BoundaryCondition{ itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD };
 
    OutputRegionModeType m_OutputRegionMode{ itk::simple::TikhonovDeconvolutionImageFilter::SAME };
 
 
 
 
 
 
 
};
 

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