sitkGradientAnisotropicDiffusionImageFilter.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 sitkGradientAnisotropicDiffusionImageFilter_h
#define sitkGradientAnisotropicDiffusionImageFilter_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 GradientAnisotropicDiffusionImageFilter : public ImageFilter {
public:
  using Self = GradientAnisotropicDiffusionImageFilter;

  virtual ~GradientAnisotropicDiffusionImageFilter();

  GradientAnisotropicDiffusionImageFilter();

  using PixelIDTypeList = RealPixelIDTypeList;
 
 
 

  void
  SetTimeStep(double TimeStep )
    { this->m_TimeStep = TimeStep; }

  double
  GetTimeStep() const { return this->m_TimeStep; }
 

  void
  SetConductanceParameter(double ConductanceParameter )
    { this->m_ConductanceParameter = ConductanceParameter; }

  double
  GetConductanceParameter() const { return this->m_ConductanceParameter; }
 

  void
  SetConductanceScalingUpdateInterval(unsigned int ConductanceScalingUpdateInterval )
    { this->m_ConductanceScalingUpdateInterval = ConductanceScalingUpdateInterval; }

  unsigned int
  GetConductanceScalingUpdateInterval() const { return this->m_ConductanceScalingUpdateInterval; }
 

  void
  SetNumberOfIterations(uint32_t NumberOfIterations )
    { this->m_NumberOfIterations = NumberOfIterations; }

  uint32_t
  GetNumberOfIterations() const { return this->m_NumberOfIterations; }
 

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

  std::string ToString() const;
 

#ifndef SWIG
    Image Execute(Image&& image1);
#endif
  Image Execute(const Image &image1);
  double EstimateOptimalTimeStep(
      Image & inImage
  );
 
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image &image1);
  template <class TImageType> Image ExecuteInternal(const Image &image1);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
  /* Time step for PDE solver */
    double m_TimeStep{ 0.125 };
 
  /* Conductance parameter governing sensitivity of the conductance equation. */
    double m_ConductanceParameter{ 3 };
 
  /* Interval at which a new scaling for the conductance term is calculated. */
    unsigned int m_ConductanceScalingUpdateInterval{ 1u };
 
  /* Number of iterations to run */
    uint32_t m_NumberOfIterations{ 5u };
 
 
 
 
 
 
 
      bool m_InPlace{false};
 
};
 

#ifndef SWIG
SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion(
    Image&& image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u
);
 
 
#endif
SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion(
    const Image &image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u
);

 
}
#endif