SimpleITK  
sitkGradientAnisotropicDiffusionImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18 #ifndef sitkGradientAnisotropicDiffusionImageFilter_h
19 #define sitkGradientAnisotropicDiffusionImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk::simple {
33 
58  public:
60 
63 
67 
70 \
71 
74  SITK_RETURN_SELF_TYPE_HEADER SetTimeStep ( double TimeStep ) { this->m_TimeStep = TimeStep; return *this; }
75 
78  double GetTimeStep() const { return this->m_TimeStep; }\
79 
82  SITK_RETURN_SELF_TYPE_HEADER SetConductanceParameter ( double ConductanceParameter ) { this->m_ConductanceParameter = ConductanceParameter; return *this; }
83 
86  double GetConductanceParameter() const { return this->m_ConductanceParameter; }\
87 
90  SITK_RETURN_SELF_TYPE_HEADER SetConductanceScalingUpdateInterval ( unsigned int ConductanceScalingUpdateInterval ) { this->m_ConductanceScalingUpdateInterval = ConductanceScalingUpdateInterval; return *this; }
91 
94  unsigned int GetConductanceScalingUpdateInterval() const { return this->m_ConductanceScalingUpdateInterval; }\
95 
98  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
99 
102  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
103 
105  std::string GetName() const { return std::string ("GradientAnisotropicDiffusionImageFilter"); }
106 
108  std::string ToString() const;
109 
110 
112 #ifndef SWIG
113  Image Execute ( Image&& image1 );
114 #endif
115  Image Execute ( const Image& image1 );
116 
117 
119  double EstimateOptimalTimeStep(Image & inImage );
120 
121  private:
122 
125  using MemberFunctionType = Image (Self::*)( const Image& image1 );
126  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
127 
128 
130 
131  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
132 
133 
134  /* Time step for PDE solver */
135  double m_TimeStep{0.125};
136 
137  /* Conductance parameter governing sensitivity of the conductance equation. */
138  double m_ConductanceParameter{3};
139 
140  /* Interval at which a new scaling for the conductance term is calculated. */
141  unsigned int m_ConductanceScalingUpdateInterval{1u};
142 
143  /* Number of iterations to run */
144  uint32_t m_NumberOfIterations{5u};
145 
146 
147  bool m_InPlace{false};
148  };
149 
159 #ifndef SWIG
160  SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion ( Image&& image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
161 #endif
162  SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion ( const Image& image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
163 
165 }
166 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceParameter
double GetConductanceParameter() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:86
itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceParameter
Self & SetConductanceParameter(double ConductanceParameter)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:82
itk::simple::GradientAnisotropicDiffusionImageFilter
This filter performs anisotropic diffusion on a scalar itk::Image using the classic Perona-Malik,...
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:57
sitkImageFilter.h
itk::simple::GradientAnisotropicDiffusionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:125
itk::simple::GradientAnisotropicDiffusionImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:69
itk::simple::GradientAnisotropicDiffusionImageFilter::SetTimeStep
Self & SetTimeStep(double TimeStep)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:74
itk::simple::GradientAnisotropicDiffusionImageFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:102
itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval
Self & SetConductanceScalingUpdateInterval(unsigned int ConductanceScalingUpdateInterval)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:90
itk::simple::GradientAnisotropicDiffusionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:131
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::GradientAnisotropicDiffusion
Image GradientAnisotropicDiffusion(Image &&image1, double timeStep=0.125, double conductanceParameter=3, unsigned int conductanceScalingUpdateInterval=1u, uint32_t numberOfIterations=5u)
This filter performs anisotropic diffusion on a scalar itk::Image using the classic Perona-Malik,...
itk::simple::GradientAnisotropicDiffusionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:98
itk::simple::GradientAnisotropicDiffusionImageFilter::GetName
std::string GetName() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:105
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::GradientAnisotropicDiffusionImageFilter::GetTimeStep
double GetTimeStep() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:78
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval
unsigned int GetConductanceScalingUpdateInterval() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:94
itk::simple
Definition: sitkAdditionalProcedures.h:28