SimpleITK  2.0.0
sitkDiscreteGaussianDerivativeImageFilter.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 sitkDiscreteGaussianDerivativeImageFilter_h
19 #define sitkDiscreteGaussianDerivativeImageFilter_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 
63  public:
65 
68 
72 
75 \
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( std::vector<double> Variance ) { this->m_Variance = std::move(Variance); return *this; }
81 
83  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
84 
88  std::vector<double> GetVariance() const { return this->m_Variance; }\
89 
93  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( std::vector<unsigned int> Order ) { this->m_Order = std::move(Order); return *this; }
94 
96  SITK_RETURN_SELF_TYPE_HEADER SetOrder( unsigned int value ) { this->m_Order = std::vector<unsigned int>(3, value); return *this; }
97 
101  std::vector<unsigned int> GetOrder() const { return this->m_Order; }\
102 
106  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
107 
111  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\
112 
116  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
117 
121  double GetMaximumError() const { return this->m_MaximumError; }\
122 
126  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
127 
129  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
130  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
131 
135  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }\
136 
140  SITK_RETURN_SELF_TYPE_HEADER SetNormalizeAcrossScale ( bool NormalizeAcrossScale ) { this->m_NormalizeAcrossScale = NormalizeAcrossScale; return *this; }
141 
143  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOn() { return this->SetNormalizeAcrossScale(true); }
144  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOff() { return this->SetNormalizeAcrossScale(false); }
145 
149  bool GetNormalizeAcrossScale() const { return this->m_NormalizeAcrossScale; }
150 
152  std::string GetName() const { return std::string ("DiscreteGaussianDerivativeImageFilter"); }
153 
155  std::string ToString() const;
156 
157 
160  Image Execute ( const Image& image1 );
161 
162  private:
163 
166  using MemberFunctionType = Image (Self::*)( const Image& image1 );
167  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
168 
169 
171 
172  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
173 
174 
175  std::vector<double> m_Variance{std::vector<double>(3, 0.0)};
176 
177  std::vector<unsigned int> m_Order{std::vector<unsigned int>(3, 1)};
178 
179  unsigned int m_MaximumKernelWidth{32u};
180 
181  double m_MaximumError{0.01};
182 
183  bool m_UseImageSpacing{true};
184 
185  bool m_NormalizeAcrossScale{false};
186 
187 
188  };
189 
200  SITKBasicFilters_EXPORT Image DiscreteGaussianDerivative ( const Image& image1, std::vector<double> variance = std::vector<double>(3, 0.0), std::vector<unsigned int> order = std::vector<unsigned int>(3, 1), unsigned int maximumKernelWidth = 32u, double maximumError = 0.01, bool useImageSpacing = true, bool normalizeAcrossScale = false );
201 
203  }
204 }
205 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:130
sitkBasicFilters.h
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:129
itk::simple::DiscreteGaussianDerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:135
itk::simple::DiscreteGaussianDerivativeImageFilter
Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gauss...
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:62
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:83
itk::simple::DiscreteGaussianDerivativeImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:166
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:106
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::DiscreteGaussianDerivativeImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:88
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:96
itk::simple::DiscreteGaussianDerivativeImageFilter::SetNormalizeAcrossScale
Self & SetNormalizeAcrossScale(bool NormalizeAcrossScale)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:140
itk::simple::DiscreteGaussianDerivativeImageFilter::GetOrder
std::vector< unsigned int > GetOrder() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:101
itk::simple::DiscreteGaussianDerivativeImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:172
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOff
Self & NormalizeAcrossScaleOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:144
itk::simple::DiscreteGaussianDerivativeImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:74
itk::simple::DiscreteGaussianDerivative
Image DiscreteGaussianDerivative(const Image &image1, std::vector< double > variance=std::vector< double >(3, 0.0), std::vector< unsigned int > order=std::vector< unsigned int >(3, 1), unsigned int maximumKernelWidth=32u, double maximumError=0.01, bool useImageSpacing=true, bool normalizeAcrossScale=false)
Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gauss...
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::DiscreteGaussianDerivativeImageFilter::GetName
std::string GetName() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:152
itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumError
double GetMaximumError() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:121
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(std::vector< double > Variance)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:80
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOn
Self & NormalizeAcrossScaleOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:143
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(std::vector< unsigned int > Order)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:93
itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:111
itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumError
Self & SetMaximumError(double MaximumError)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:116
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::simple::DiscreteGaussianDerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:126
itk::simple::DiscreteGaussianDerivativeImageFilter::GetNormalizeAcrossScale
bool GetNormalizeAcrossScale() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:149