SimpleITK  1.1.0
sitkDiscreteGaussianDerivativeImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
59  public:
61 
64 
68 
71 
72 
73 
77  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( const std::vector<double> & Variance ) { this->m_Variance = Variance; return *this; }
78 
80  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
81 
82 
86  std::vector<double> GetVariance() const { return this->m_Variance; }
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( const std::vector<unsigned int> & Order ) { this->m_Order = Order; return *this; }
92 
94  SITK_RETURN_SELF_TYPE_HEADER SetOrder( unsigned int value ) { this->m_Order = std::vector<unsigned int>(3, value); return *this; }
95 
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; }
150  std::string GetName() const { return std::string ("DiscreteGaussianDerivativeImageFilter"); }
151 
153  std::string ToString() const;
154 
155 
157  Image Execute ( const Image& image1 );
158 
159 
161  Image Execute ( const Image& image1, const std::vector<double> & variance, const std::vector<unsigned int> & order, unsigned int maximumKernelWidth, double maximumError, bool useImageSpacing, bool normalizeAcrossScale );
162 
163  private:
164 
167  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
168  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
169 
170 
171  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
172 
173  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
174 
175 
176  std::vector<double> m_Variance;
177  std::vector<unsigned int> m_Order;
178  unsigned int m_MaximumKernelWidth;
182  };
183 
184 
193  SITKBasicFilters_EXPORT Image DiscreteGaussianDerivative ( const Image& image1, const std::vector<double> & variance = std::vector<double>(3, 0.0), const 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 );
194 
195  }
196 }
197 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:129
sitkBasicFilters.h
itk::simple::DiscreteGaussianDerivativeImageFilter::Self
DiscreteGaussianDerivativeImageFilter Self
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:60
itk::simple::DiscreteGaussianDerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:128
itk::simple::DiscreteGaussianDerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:134
itk::simple::DiscreteGaussianDerivativeImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:70
itk::simple::DiscreteGaussianDerivativeImageFilter
Calculates image derivatives using discrete derivative gaussian kernels. This filter calculates Gauss...
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:58
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(const std::vector< unsigned int > &Order)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:91
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:80
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::DiscreteGaussianDerivativeImageFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:105
itk::simple::DiscreteGaussianDerivativeImageFilter::m_Variance
std::vector< double > m_Variance
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:176
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:86
itk::simple::DiscreteGaussianDerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int value)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:94
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_UseImageSpacing
bool m_UseImageSpacing
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:180
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOff
Self & NormalizeAcrossScaleOff()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:143
itk::simple::DiscreteGaussianDerivative
Image DiscreteGaussianDerivative(const Image &image1, const std::vector< double > &variance=std::vector< double >(3, 0.0), const 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...
itk::simple::DiscreteGaussianDerivativeImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:173
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::DiscreteGaussianDerivativeImageFilter::SetVariance
Self & SetVariance(const std::vector< double > &Variance)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:77
itk::simple::DiscreteGaussianDerivativeImageFilter::m_NormalizeAcrossScale
bool m_NormalizeAcrossScale
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:181
itk::simple::DiscreteGaussianDerivativeImageFilter::GetName
std::string GetName() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:150
itk::simple::DiscreteGaussianDerivativeImageFilter::GetMaximumError
double GetMaximumError() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:120
itk::simple::DiscreteGaussianDerivativeImageFilter::NormalizeAcrossScaleOn
Self & NormalizeAcrossScaleOn()
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:142
itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumKernelWidth
unsigned int m_MaximumKernelWidth
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:178
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
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::DiscreteGaussianDerivativeImageFilter::m_MaximumError
double m_MaximumError
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:179
itk::simple::DiscreteGaussianDerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:125
itk::simple::DiscreteGaussianDerivativeImageFilter::m_Order
std::vector< unsigned int > m_Order
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:177
itk::simple::DiscreteGaussianDerivativeImageFilter::GetNormalizeAcrossScale
bool GetNormalizeAcrossScale() const
Definition: sitkDiscreteGaussianDerivativeImageFilter.h:148