SimpleITK  
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::simple {
33 
60  public:
62 
65 
69 
72 \
73 
76  SITK_RETURN_SELF_TYPE_HEADER SetTimeStep ( double TimeStep ) { this->m_TimeStep = TimeStep; return *this; }
77 
80  double GetTimeStep() const { return this->m_TimeStep; }\
81 
84  SITK_RETURN_SELF_TYPE_HEADER SetConductanceParameter ( double ConductanceParameter ) { this->m_ConductanceParameter = ConductanceParameter; return *this; }
85 
88  double GetConductanceParameter() const { return this->m_ConductanceParameter; }\
89 
92  SITK_RETURN_SELF_TYPE_HEADER SetConductanceScalingUpdateInterval ( unsigned int ConductanceScalingUpdateInterval ) { this->m_ConductanceScalingUpdateInterval = ConductanceScalingUpdateInterval; return *this; }
93 
96  unsigned int GetConductanceScalingUpdateInterval() const { return this->m_ConductanceScalingUpdateInterval; }\
97 
100  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
101 
104  uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }
105 
107  std::string GetName() const { return std::string ("CurvatureAnisotropicDiffusionImageFilter"); }
108 
110  std::string ToString() const;
111 
112 
114 #ifndef SWIG
115  Image Execute ( Image&& image1 );
116 #endif
117  Image Execute ( const Image& image1 );
118 
119 
121  double EstimateOptimalTimeStep(Image & inImage );
122 
123  private:
124 
127  using MemberFunctionType = Image (Self::*)( const Image& image1 );
128  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
129 
130 
132 
133  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
134 
135 
136  /* Time step for PDE solver */
137  double m_TimeStep{0.0625};
138 
139  /* Conductance parameter governing sensitivity of the conductance equation. */
140  double m_ConductanceParameter{3.0};
141 
142  /* Interval at which a new scaling for the conductance term is calculated. */
143  unsigned int m_ConductanceScalingUpdateInterval{1u};
144 
145  /* Number of iterations to run */
146  uint32_t m_NumberOfIterations{5u};
147 
148 
149  bool m_InPlace{false};
150  };
151 
161 #ifndef SWIG
162  SITKBasicFilters_EXPORT Image CurvatureAnisotropicDiffusion ( Image&& image1, double timeStep = 0.0625, double conductanceParameter = 3.0, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
163 #endif
164  SITKBasicFilters_EXPORT Image CurvatureAnisotropicDiffusion ( const Image& image1, double timeStep = 0.0625, double conductanceParameter = 3.0, unsigned int conductanceScalingUpdateInterval = 1u, uint32_t numberOfIterations = 5u );
165 
167 }
168 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval
Self & SetConductanceScalingUpdateInterval(unsigned int ConductanceScalingUpdateInterval)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:92
itk::simple::CurvatureAnisotropicDiffusionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:127
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetNumberOfIterations
uint32_t GetNumberOfIterations() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:104
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceParameter
double GetConductanceParameter() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:88
sitkImageFilter.h
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetTimeStep
Self & SetTimeStep(double TimeStep)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:76
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetTimeStep
double GetTimeStep() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:80
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval
unsigned int GetConductanceScalingUpdateInterval() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:96
itk::simple::CurvatureAnisotropicDiffusionImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:71
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetConductanceParameter
Self & SetConductanceParameter(double ConductanceParameter)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:84
itk::simple::CurvatureAnisotropicDiffusionImageFilter
This filter performs anisotropic diffusion on a scalar itk::Image using the modified curvature diffus...
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:59
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::CurvatureAnisotropicDiffusionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:133
itk::simple::CurvatureAnisotropicDiffusionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(uint32_t NumberOfIterations)
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:100
itk::simple::CurvatureAnisotropicDiffusion
Image CurvatureAnisotropicDiffusion(Image &&image1, double timeStep=0.0625, double conductanceParameter=3.0, unsigned int conductanceScalingUpdateInterval=1u, uint32_t numberOfIterations=5u)
This filter performs anisotropic diffusion on a scalar itk::Image using the modified curvature diffus...
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::CurvatureAnisotropicDiffusionImageFilter::GetName
std::string GetName() const
Definition: sitkCurvatureAnisotropicDiffusionImageFilter.h:107