SimpleITK  
sitkGradientRecursiveGaussianImageFilter.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 sitkGradientRecursiveGaussianImageFilter_h
19 #define sitkGradientRecursiveGaussianImageFilter_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 
44  public:
46 
49 
53 
55  using PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, VectorPixelIDTypeList>::type;
56 \
57 
61  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( double Sigma ) { this->m_Sigma = Sigma; return *this; }
62 
66  double GetSigma() const { return this->m_Sigma; }\
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetNormalizeAcrossScale ( bool NormalizeAcrossScale ) { this->m_NormalizeAcrossScale = NormalizeAcrossScale; return *this; }
72 
74  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOn() { return this->SetNormalizeAcrossScale(true); }
75  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOff() { return this->SetNormalizeAcrossScale(false); }
76 
80  bool GetNormalizeAcrossScale() const { return this->m_NormalizeAcrossScale; }\
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetUseImageDirection ( bool UseImageDirection ) { this->m_UseImageDirection = UseImageDirection; return *this; }
86 
88  SITK_RETURN_SELF_TYPE_HEADER UseImageDirectionOn() { return this->SetUseImageDirection(true); }
89  SITK_RETURN_SELF_TYPE_HEADER UseImageDirectionOff() { return this->SetUseImageDirection(false); }
90 
94  bool GetUseImageDirection() const { return this->m_UseImageDirection; }
95 
97  std::string GetName() const { return std::string ("GradientRecursiveGaussianImageFilter"); }
98 
100  std::string ToString() const;
101 
102 
105  Image Execute ( const Image& image1 );
106 
107  private:
108 
111  using MemberFunctionType = Image (Self::*)( const Image& image1 );
112  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
113 
114 
116 
117  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
118 
119 
120  /* */
121  double m_Sigma{1.0};
122 
123  /* */
124  bool m_NormalizeAcrossScale{false};
125 
126  bool m_UseImageDirection{false};
127 
128 
129  };
130 
141  SITKBasicFilters_EXPORT Image GradientRecursiveGaussian ( const Image& image1, double sigma = 1.0, bool normalizeAcrossScale = false, bool useImageDirection = false );
142 
144 }
145 #endif
itk::simple::GradientRecursiveGaussianImageFilter::SetNormalizeAcrossScale
Self & SetNormalizeAcrossScale(bool NormalizeAcrossScale)
Definition: sitkGradientRecursiveGaussianImageFilter.h:71
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::GradientRecursiveGaussianImageFilter::UseImageDirectionOn
Self & UseImageDirectionOn()
Definition: sitkGradientRecursiveGaussianImageFilter.h:88
itk::simple::GradientRecursiveGaussianImageFilter::NormalizeAcrossScaleOn
Self & NormalizeAcrossScaleOn()
Definition: sitkGradientRecursiveGaussianImageFilter.h:74
itk::simple::GradientRecursiveGaussianImageFilter::SetUseImageDirection
Self & SetUseImageDirection(bool UseImageDirection)
Definition: sitkGradientRecursiveGaussianImageFilter.h:85
itk::simple::GradientRecursiveGaussianImageFilter::NormalizeAcrossScaleOff
Self & NormalizeAcrossScaleOff()
Definition: sitkGradientRecursiveGaussianImageFilter.h:75
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::GradientRecursiveGaussianImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkGradientRecursiveGaussianImageFilter.h:111
itk::simple::GradientRecursiveGaussianImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGradientRecursiveGaussianImageFilter.h:117
itk::simple::GradientRecursiveGaussianImageFilter::UseImageDirectionOff
Self & UseImageDirectionOff()
Definition: sitkGradientRecursiveGaussianImageFilter.h:89
sitkImageFilter.h
itk::simple::GradientRecursiveGaussianImageFilter::GetNormalizeAcrossScale
bool GetNormalizeAcrossScale() const
Definition: sitkGradientRecursiveGaussianImageFilter.h:80
itk::simple::GradientRecursiveGaussianImageFilter::GetName
std::string GetName() const
Definition: sitkGradientRecursiveGaussianImageFilter.h:97
itk::simple::GradientRecursiveGaussianImageFilter::SetSigma
Self & SetSigma(double Sigma)
Definition: sitkGradientRecursiveGaussianImageFilter.h:61
itk::simple::GradientRecursiveGaussianImageFilter::GetSigma
double GetSigma() const
Definition: sitkGradientRecursiveGaussianImageFilter.h:66
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GradientRecursiveGaussianImageFilter
Computes the gradient of an image by convolution with the first derivative of a Gaussian.
Definition: sitkGradientRecursiveGaussianImageFilter.h:43
itk::simple::GradientRecursiveGaussian
Image GradientRecursiveGaussian(const Image &image1, double sigma=1.0, bool normalizeAcrossScale=false, bool useImageDirection=false)
Computes the gradient of an image by convolution with the first derivative of a Gaussian.
itk::simple::GradientRecursiveGaussianImageFilter::GetUseImageDirection
bool GetUseImageDirection() const
Definition: sitkGradientRecursiveGaussianImageFilter.h:94
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::GradientRecursiveGaussianImageFilter::PixelIDTypeList
typelist2::append< BasicPixelIDTypeList, VectorPixelIDTypeList >::type PixelIDTypeList
Definition: sitkGradientRecursiveGaussianImageFilter.h:55