SimpleITK  2.0.0rc2.post21
sitkCurvatureAnisotropicDiffusionImageFilter.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 sitkCurvatureAnisotropicDiffusionImageFilter_h
19 #define sitkCurvatureAnisotropicDiffusionImageFilter_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 
61  public:
63 
66 
70 
73 \
74 
77  SITK_RETURN_SELF_TYPE_HEADER SetTimeStep ( double TimeStep ) { this->m_TimeStep = TimeStep; return *this; }
78 
81  double GetTimeStep() const { return this->m_TimeStep; }\
82 
85  SITK_RETURN_SELF_TYPE_HEADER SetConductanceParameter ( double ConductanceParameter ) { this->m_ConductanceParameter = ConductanceParameter; return *this; }
86 
89  double GetConductanceParameter() const { return this->m_ConductanceParameter; }\
90 
93  SITK_RETURN_SELF_TYPE_HEADER SetConductanceScalingUpdateInterval ( unsigned int ConductanceScalingUpdateInterval ) { this->m_ConductanceScalingUpdateInterval = ConductanceScalingUpdateInterval; return *this; }
94 
97  unsigned int GetConductanceScalingUpdateInterval() const { return this->m_ConductanceScalingUpdateInterval; }\
98 
101  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
102 
105  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
106 
108  std::string GetName() const { return std::string ("CurvatureAnisotropicDiffusionImageFilter"); }
109 
111  std::string ToString() const;
112 
113 
115 #ifndef SWIG
116  Image Execute ( Image&& image1 );
117 #endif
118  Image Execute ( const Image& image1 );
119 
120 
122  double EstimateOptimalTimeStep(Image & inImage );
123 
124  private:
125 
128  using MemberFunctionType = Image (Self::*)( const Image& image1 );
129  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
130 
131 
133 
134  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
135 
136 
137  /* Time step for PDE solver */
138  double m_TimeStep{0.0625};
139 
140  /* Conductance parameter governing sensitivity of the conductance equation. */
141  double m_ConductanceParameter{3.0};
142 
143  /* Interval at which a new scaling for the conductance term is calculated. */
144  unsigned int m_ConductanceScalingUpdateInterval{1u};
145 
146  /* Number of iterations to run */
147  uint32_t m_NumberOfIterations{5u};
148 
149 
150  bool m_InPlace{false};
151  };
152 
162 #ifndef SWIG
163  SITKBasicFilters_EXPORT Image CurvatureAnisotropicDiffusion ( Image&& image1, double timeStep = 0.0625, double conductanceParameter = 3.0, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
164 #endif
165  SITKBasicFilters_EXPORT Image CurvatureAnisotropicDiffusion ( const Image& image1, double timeStep = 0.0625, double conductanceParameter = 3.0, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
166 
168  }
169 }
170 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval
Self & SetConductanceScalingUpdateInterval(unsigned int ConductanceScalingUpdateInterval)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:93
itk::simple::CurvatureAnisotropicDiffusionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:128
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:105
itk::simple::RealPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:96
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceParameter
double GetConductanceParameter() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:89
sitkImageFilter.h
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetTimeStep
Self & SetTimeStep(double TimeStep)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:77
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetTimeStep
double GetTimeStep() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:81
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval
unsigned int GetConductanceScalingUpdateInterval() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:97
itk::simple::CurvatureAnisotropicDiffusionImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:72
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceParameter
Self & SetConductanceParameter(double ConductanceParameter)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:85
itk::simple::CurvatureAnisotropicDiffusionImageFilter
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:60
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:134
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:101
itk::simple::CurvatureAnisotropicDiffusion
Image CurvatureAnisotropicDiffusion(Image &&image1, double timeStep=0.0625, double conductanceParameter=3.0, unsigned int conductanceScalingUpdateInterval=1u, uint32_t numberOfIterations=5u)
itk::simple::CurvatureAnisotropicDiffusionImageFilter Procedural Interface
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetName
std::string GetName() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:108