SimpleITK  1.1.0
sitkDiscreteGaussianImageFilter.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 sitkDiscreteGaussianImageFilter_h
19 #define sitkDiscreteGaussianImageFilter_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 
67  virtual ~DiscreteGaussianImageFilter();
68 
72 
75 
76 
77 
80  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( const std::vector<double> & Variance ) { this->m_Variance = Variance; return *this; }
81 
83  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
84 
85 
89  std::vector<double> GetVariance() const { return this->m_Variance; }
90 
94  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
95 
99  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }
100 
103  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( const std::vector<double> & MaximumError ) { this->m_MaximumError = MaximumError; return *this; }
104 
106  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError( double value ) { this->m_MaximumError = std::vector<double>(3, value); return *this; }
107 
108 
112  std::vector<double> GetMaximumError() const { return this->m_MaximumError; }
113 
117  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
118 
120  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
121  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
122 
126  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
128  std::string GetName() const { return std::string ("DiscreteGaussianImageFilter"); }
129 
131  std::string ToString() const;
132 
133 
135  Image Execute ( const Image& image1 );
136 
137 
139  Image Execute ( const Image& image1, const std::vector<double> & variance, unsigned int maximumKernelWidth, const std::vector<double> & maximumError, bool useImageSpacing );
140 
141  private:
142 
145  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
146  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
147 
148 
149  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
150 
151  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
152 
153 
154  std::vector<double> m_Variance;
155  unsigned int m_MaximumKernelWidth;
156  std::vector<double> m_MaximumError;
158  };
159 
160 
169  SITKBasicFilters_EXPORT Image DiscreteGaussian ( const Image& image1, const std::vector<double> & variance = std::vector<double>(3,1.0), unsigned int maximumKernelWidth = 32u, const std::vector<double> & maximumError = std::vector<double>(3, 0.01), bool useImageSpacing = true );
170 
171  }
172 }
173 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::DiscreteGaussianImageFilter::GetMaximumError
std::vector< double > GetMaximumError() const
Definition: sitkDiscreteGaussianImageFilter.h:112
sitkBasicFilters.h
itk::simple::DiscreteGaussianImageFilter
Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian...
Definition: sitkDiscreteGaussianImageFilter.h:62
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::DiscreteGaussianImageFilter::GetName
std::string GetName() const
Definition: sitkDiscreteGaussianImageFilter.h:128
itk::simple::DiscreteGaussianImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDiscreteGaussianImageFilter.h:126
itk::simple::DiscreteGaussianImageFilter::m_Variance
std::vector< double > m_Variance
Definition: sitkDiscreteGaussianImageFilter.h:154
itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDiscreteGaussianImageFilter.h:120
itk::simple::DiscreteGaussianImageFilter::m_UseImageSpacing
bool m_UseImageSpacing
Definition: sitkDiscreteGaussianImageFilter.h:157
itk::simple::DiscreteGaussianImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDiscreteGaussianImageFilter.h:151
itk::simple::DiscreteGaussianImageFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkDiscreteGaussianImageFilter.h:94
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::DiscreteGaussian
Image DiscreteGaussian(const Image &image1, double variance, unsigned int maximumKernelWidth=32u, double maximumError=0.01, bool useImageSpacing=true)
Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian...
itk::simple::DiscreteGaussianImageFilter::m_MaximumError
std::vector< double > m_MaximumError
Definition: sitkDiscreteGaussianImageFilter.h:156
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::DiscreteGaussianImageFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkDiscreteGaussianImageFilter.h:99
itk::simple::DiscreteGaussianImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkDiscreteGaussianImageFilter.h:74
itk::simple::DiscreteGaussianImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkDiscreteGaussianImageFilter.h:89
itk
itk::simple::DiscreteGaussianImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDiscreteGaussianImageFilter.h:117
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::DiscreteGaussianImageFilter::m_MaximumKernelWidth
unsigned int m_MaximumKernelWidth
Definition: sitkDiscreteGaussianImageFilter.h:155
itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDiscreteGaussianImageFilter.h:121
itk::simple::DiscreteGaussianImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkDiscreteGaussianImageFilter.h:83
itk::simple::DiscreteGaussianImageFilter::SetMaximumError
Self & SetMaximumError(double value)
Definition: sitkDiscreteGaussianImageFilter.h:106
itk::simple::DiscreteGaussianImageFilter::Self
DiscreteGaussianImageFilter Self
Definition: sitkDiscreteGaussianImageFilter.h:64
itk::simple::DiscreteGaussianImageFilter::SetVariance
Self & SetVariance(const std::vector< double > &Variance)
Definition: sitkDiscreteGaussianImageFilter.h:80
itk::simple::DiscreteGaussianImageFilter::SetMaximumError
Self & SetMaximumError(const std::vector< double > &MaximumError)
Definition: sitkDiscreteGaussianImageFilter.h:103