SimpleITK  2.0.0rc2.post17
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 {
33  namespace simple {
34 
59  public:
61 
64 
68 
71 \
72 
75  SITK_RETURN_SELF_TYPE_HEADER SetTimeStep ( double TimeStep ) { this->m_TimeStep = TimeStep; return *this; }
76 
79  double GetTimeStep() const { return this->m_TimeStep; }\
80 
83  SITK_RETURN_SELF_TYPE_HEADER SetConductanceParameter ( double ConductanceParameter ) { this->m_ConductanceParameter = ConductanceParameter; return *this; }
84 
87  double GetConductanceParameter() const { return this->m_ConductanceParameter; }\
88 
91  SITK_RETURN_SELF_TYPE_HEADER SetConductanceScalingUpdateInterval ( unsigned int ConductanceScalingUpdateInterval ) { this->m_ConductanceScalingUpdateInterval = ConductanceScalingUpdateInterval; return *this; }
92 
95  unsigned int GetConductanceScalingUpdateInterval() const { return this->m_ConductanceScalingUpdateInterval; }\
96 
99  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
100 
103  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
104 
106  std::string GetName() const { return std::string ("GradientAnisotropicDiffusionImageFilter"); }
107 
109  std::string ToString() const;
110 
111 
113 #ifndef SWIG
114  Image Execute ( Image&& image1 );
115 #endif
116  Image Execute ( const Image& image1 );
117 
118 
120  double EstimateOptimalTimeStep(Image & inImage );
121 
122  private:
123 
126  using MemberFunctionType = Image (Self::*)( const Image& image1 );
127  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
128 
129 
131 
132  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
133 
134 
135  /* Time step for PDE solver */
136  double m_TimeStep{0.125};
137 
138  /* Conductance parameter governing sensitivity of the conductance equation. */
139  double m_ConductanceParameter{3};
140 
141  /* Interval at which a new scaling for the conductance term is calculated. */
142  unsigned int m_ConductanceScalingUpdateInterval{1u};
143 
144  /* Number of iterations to run */
145  uint32_t m_NumberOfIterations{5u};
146 
147 
148  bool m_InPlace{false};
149  };
150 
160 #ifndef SWIG
161  SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion ( Image&& image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
162 #endif
163  SITKBasicFilters_EXPORT Image GradientAnisotropicDiffusion ( const Image& image1, double timeStep = 0.125, double conductanceParameter = 3, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
164 
166  }
167 }
168 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceParameter
double GetConductanceParameter() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:87
itk::simple::RealPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:96
itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceParameter
Self & SetConductanceParameter(double ConductanceParameter)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:83
itk::simple::GradientAnisotropicDiffusionImageFilter
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:58
sitkImageFilter.h
itk::simple::GradientAnisotropicDiffusionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:126
itk::simple::GradientAnisotropicDiffusionImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:70
itk::simple::GradientAnisotropicDiffusionImageFilter::SetTimeStep
Self & SetTimeStep(double TimeStep)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:75
itk::simple::GradientAnisotropicDiffusionImageFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:103
itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval
Self & SetConductanceScalingUpdateInterval(unsigned int ConductanceScalingUpdateInterval)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:91
itk::simple::GradientAnisotropicDiffusionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:132
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)
itk::simple::GradientAnisotropicDiffusionImageFilter Procedural Interface
itk::simple::GradientAnisotropicDiffusionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:99
itk
itk::simple::GradientAnisotropicDiffusionImageFilter::GetName
std::string GetName() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:106
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::GradientAnisotropicDiffusionImageFilter::GetTimeStep
double GetTimeStep() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:79
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval
unsigned int GetConductanceScalingUpdateInterval() const
Definition: sitkGradientAnisotropicDiffusionImageFilter.h:95
itk::uint32_t
::uint32_t uint32_t