SimpleITK  
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::simple {
33 
62  public:
64 
67 
71 
74 \
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( std::vector<double> Variance ) { this->m_Variance = std::move(Variance); return *this; }
80 
82  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
83 
87  std::vector<double> GetVariance() const { return this->m_Variance; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( std::vector<unsigned int> Order ) { this->m_Order = std::move(Order); return *this; }
93 
95  SITK_RETURN_SELF_TYPE_HEADER SetOrder( unsigned int value ) { this->m_Order = std::vector<unsigned int>(3, value); return *this; }
96 
100  std::vector<unsigned int> GetOrder() const { return this->m_Order; }\
101 
105  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
106 
110  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\
111 
115  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
116 
120  double GetMaximumError() const { return this->m_MaximumError; }\
121 
125  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
126 
128  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
129  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
130 
134  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }\
135 
139  SITK_RETURN_SELF_TYPE_HEADER SetNormalizeAcrossScale ( bool NormalizeAcrossScale ) { this->m_NormalizeAcrossScale = NormalizeAcrossScale; return *this; }
140 
142  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOn() { return this->SetNormalizeAcrossScale(true); }
143  SITK_RETURN_SELF_TYPE_HEADER NormalizeAcrossScaleOff() { return this->SetNormalizeAcrossScale(false); }
144 
148  bool GetNormalizeAcrossScale() const { return this->m_NormalizeAcrossScale; }
149 
151  std::string GetName() const { return std::string ("DiscreteGaussianDerivativeImageFilter"); }
152 
154  std::string ToString() const;
155 
156 
159  Image Execute ( const Image& image1 );
160 
161  private:
162 
165  using MemberFunctionType = Image (Self::*)( const Image& image1 );
166  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
167 
168 
170 
171  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
172 
173 
174  std::vector<double> m_Variance{std::vector<double>(3, 0.0)};
175 
176  std::vector<unsigned int> m_Order{std::vector<unsigned int>(3, 1)};
177 
178  unsigned int m_MaximumKernelWidth{32u};
179 
180  double m_MaximumError{0.01};
181 
182  bool m_UseImageSpacing{true};
183 
184  bool m_NormalizeAcrossScale{false};
185 
186 
187  };
188 
199  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 );
200 
202 }
203 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:129
sitkBasicFilters.h
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:128
itk::simple::DiscreteGaussianDerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:134
itk::simple::DiscreteGaussianDerivativeImageFilter
Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gauss...
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:61
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:82
itk::simple::DiscreteGaussianDerivativeImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:165
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:105
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
sitkImageFilter.h
itk::simple::DiscreteGaussianDerivativeImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:87
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:95
itk::simple::DiscreteGaussianDerivativeImageFilter::SetNormalizeAcrossScale
Self & SetNormalizeAcrossScale(bool NormalizeAcrossScale)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:139
itk::simple::DiscreteGaussianDerivativeImageFilter::GetOrder
std::vector< unsigned int > GetOrder() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:100
itk::simple::DiscreteGaussianDerivativeImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:171
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOff
Self & NormalizeAcrossScaleOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:143
itk::simple::DiscreteGaussianDerivativeImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:73
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:151
itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumError
double GetMaximumError() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:120
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(std::vector< double > Variance)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:79
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOn
Self & NormalizeAcrossScaleOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:142
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(std::vector< unsigned int > Order)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:92
itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:110
itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumError
Self & SetMaximumError(double MaximumError)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:115
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
Definition: sitkAdditionalProcedures.h:28
itk::simple::DiscreteGaussianDerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:125
itk::simple::DiscreteGaussianDerivativeImageFilter::GetNormalizeAcrossScale
bool GetNormalizeAcrossScale() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:148