SimpleITK  2.0.0
sitkRecursiveGaussianImageFilter.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 sitkRecursiveGaussianImageFilter_h
19 #define sitkRecursiveGaussianImageFilter_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 
54  public:
56 
59 
63 
65  using PixelIDTypeList = typelist::Append<BasicPixelIDTypeList, VectorPixelIDTypeList>::Type;
66 \
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( double Sigma ) { this->m_Sigma = Sigma; return *this; }
72 
76  double GetSigma() const { return this->m_Sigma; }\
77 
97  SITK_RETURN_SELF_TYPE_HEADER SetNormalizeAcrossScale ( bool NormalizeAcrossScale ) { this->m_NormalizeAcrossScale = NormalizeAcrossScale; return *this; }
98 
100  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOn() { return this->SetNormalizeAcrossScale(true); }
101  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOff() { return this->SetNormalizeAcrossScale(false); }
102 
105  bool GetNormalizeAcrossScale() const { return this->m_NormalizeAcrossScale; }
106 
107  typedef enum {ZeroOrder,FirstOrder,SecondOrder} OrderType;\
108 
118  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( OrderType Order ) { this->m_Order = Order; return *this; }
119 
129  OrderType GetOrder() const { return this->m_Order; }\
130 
133  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( unsigned int Direction ) { this->m_Direction = Direction; return *this; }
134 
137  unsigned int GetDirection() const { return this->m_Direction; }
138 
140  std::string GetName() const { return std::string ("RecursiveGaussianImageFilter"); }
141 
143  std::string ToString() const;
144 
145 
147 #ifndef SWIG
148  Image Execute ( Image&& image1 );
149 #endif
150  Image Execute ( const Image& image1 );
151 
152  private:
153 
156  using MemberFunctionType = Image (Self::*)( const Image& image1 );
157  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
158 
159 
161 
162  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
163 
164 
165  /* */
166  double m_Sigma{1.0};
167 
168  /* */
169  bool m_NormalizeAcrossScale{false};
170 
171  /* */
173 
174  /* */
175  unsigned int m_Direction{0u};
176 
177 
178  bool m_InPlace{false};
179  };
180 
190 #ifndef SWIG
191  SITKBasicFilters_EXPORT Image RecursiveGaussian ( Image&& image1, double sigma = 1.0, bool normalizeAcrossScale = false, RecursiveGaussianImageFilter::OrderType order = itk::simple::RecursiveGaussianImageFilter::ZeroOrder, unsigned int direction = 0u );
192 #endif
193  SITKBasicFilters_EXPORT Image RecursiveGaussian ( const Image& image1, double sigma = 1.0, bool normalizeAcrossScale = false, RecursiveGaussianImageFilter::OrderType order = itk::simple::RecursiveGaussianImageFilter::ZeroOrder, unsigned int direction = 0u );
194 
196  }
197 }
198 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::RecursiveGaussianImageFilter::SetOrder
Self & SetOrder(OrderType Order)
Definition: sitkRecursiveGaussianImageFilter.h:118
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RecursiveGaussianImageFilter::NormalizeAcrossScaleOn
Self & NormalizeAcrossScaleOn()
Definition: sitkRecursiveGaussianImageFilter.h:100
itk::simple::RecursiveGaussianImageFilter::SetSigma
Self & SetSigma(double Sigma)
Definition: sitkRecursiveGaussianImageFilter.h:71
itk::simple::RecursiveGaussianImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRecursiveGaussianImageFilter.h:162
itk::simple::RecursiveGaussianImageFilter::GetDirection
unsigned int GetDirection() const
Definition: sitkRecursiveGaussianImageFilter.h:137
itk::simple::RecursiveGaussianImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRecursiveGaussianImageFilter.h:156
itk::simple::RecursiveGaussianImageFilter::ZeroOrder
@ ZeroOrder
Definition: sitkRecursiveGaussianImageFilter.h:107
itk::simple::RecursiveGaussianImageFilter::NormalizeAcrossScaleOff
Self & NormalizeAcrossScaleOff()
Definition: sitkRecursiveGaussianImageFilter.h:101
itk::simple::RecursiveGaussianImageFilter::OrderType
OrderType
Definition: sitkRecursiveGaussianImageFilter.h:107
sitkImageFilter.h
itk::simple::RecursiveGaussianImageFilter::GetName
std::string GetName() const
Definition: sitkRecursiveGaussianImageFilter.h:140
itk::simple::RecursiveGaussianImageFilter::GetNormalizeAcrossScale
bool GetNormalizeAcrossScale() const
Definition: sitkRecursiveGaussianImageFilter.h:105
itk::simple::RecursiveGaussianImageFilter::SetDirection
Self & SetDirection(unsigned int Direction)
Definition: sitkRecursiveGaussianImageFilter.h:133
itk::simple::RecursiveGaussianImageFilter::SetNormalizeAcrossScale
Self & SetNormalizeAcrossScale(bool NormalizeAcrossScale)
Definition: sitkRecursiveGaussianImageFilter.h:97
itk::simple::RecursiveGaussianImageFilter::PixelIDTypeList
typelist::Append< BasicPixelIDTypeList, VectorPixelIDTypeList >::Type PixelIDTypeList
Definition: sitkRecursiveGaussianImageFilter.h:65
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RecursiveGaussianImageFilter::GetSigma
double GetSigma() const
Definition: sitkRecursiveGaussianImageFilter.h:76
itk::simple::RecursiveGaussianImageFilter::GetOrder
OrderType GetOrder() const
Definition: sitkRecursiveGaussianImageFilter.h:129
itk::simple::RecursiveGaussianImageFilter
Base class for computing IIR convolution with an approximation of a Gaussian kernel.
Definition: sitkRecursiveGaussianImageFilter.h:53
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::RecursiveGaussian
Image RecursiveGaussian(Image &&image1, double sigma=1.0, bool normalizeAcrossScale=false, RecursiveGaussianImageFilter::OrderType order=itk::simple::RecursiveGaussianImageFilter::ZeroOrder, unsigned int direction=0u)
Base class for computing IIR convolution with an approximation of a Gaussian kernel.
itk::Image
Definition: sitkPixelIDTypes.h:26