SimpleITK  2.0.0rc2.post17
sitkDiscreteGaussianImageFilter.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 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 
61  public:
63 
65  virtual ~DiscreteGaussianImageFilter();
66 
70 
73 \
74 
77  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( std::vector<double> Variance ) { this->m_Variance = std::move(Variance); return *this; }
78 
80  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
81 
85  std::vector<double> GetVariance() const { return this->m_Variance; }\
86 
90  SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }
91 
95  unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\
96 
99  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( std::vector<double> MaximumError ) { this->m_MaximumError = std::move(MaximumError); return *this; }
100 
102  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError( double value ) { this->m_MaximumError = std::vector<double>(3, value); return *this; }
103 
107  std::vector<double> GetMaximumError() const { return this->m_MaximumError; }\
108 
112  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
113 
115  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
116  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
117 
121  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
122 
124  std::string GetName() const { return std::string ("DiscreteGaussianImageFilter"); }
125 
127  std::string ToString() const;
128 
129 
132  Image Execute ( const Image& image1 );
133 
134  private:
135 
138  using MemberFunctionType = Image (Self::*)( const Image& image1 );
139  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
140 
141 
143 
144  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
145 
146 
147  std::vector<double> m_Variance{std::vector<double>(3,1.0)};
148 
149  unsigned int m_MaximumKernelWidth{32u};
150 
151  std::vector<double> m_MaximumError{std::vector<double>(3, 0.01)};
152 
153  bool m_UseImageSpacing{true};
154 
155 
156  };
157 
168  SITKBasicFilters_EXPORT Image DiscreteGaussian ( const Image& image1, std::vector<double> variance = std::vector<double>(3,1.0), unsigned int maximumKernelWidth = 32u, std::vector<double> maximumError = std::vector<double>(3, 0.01), bool useImageSpacing = true );
169 
171  }
172 }
173 #endif
itk::simple::DiscreteGaussianImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDiscreteGaussianImageFilter.h:144
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::DiscreteGaussianImageFilter::GetMaximumError
std::vector< double > GetMaximumError() const
Definition: sitkDiscreteGaussianImageFilter.h:107
sitkBasicFilters.h
itk::simple::DiscreteGaussianImageFilter
Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian...
Definition: sitkDiscreteGaussianImageFilter.h:60
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::DiscreteGaussianImageFilter::GetName
std::string GetName() const
Definition: sitkDiscreteGaussianImageFilter.h:124
itk::simple::DiscreteGaussianImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDiscreteGaussianImageFilter.h:121
itk::simple::DiscreteGaussianImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkDiscreteGaussianImageFilter.h:72
itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDiscreteGaussianImageFilter.h:115
itk::simple::DiscreteGaussianImageFilter::SetVariance
Self & SetVariance(std::vector< double > Variance)
Definition: sitkDiscreteGaussianImageFilter.h:77
itk::simple::DiscreteGaussianImageFilter::SetMaximumKernelWidth
Self & SetMaximumKernelWidth(unsigned int MaximumKernelWidth)
Definition: sitkDiscreteGaussianImageFilter.h:90
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::DiscreteGaussianImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkDiscreteGaussianImageFilter.h:138
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...
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::DiscreteGaussianImageFilter::GetMaximumKernelWidth
unsigned int GetMaximumKernelWidth() const
Definition: sitkDiscreteGaussianImageFilter.h:95
itk::simple::DiscreteGaussianImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkDiscreteGaussianImageFilter.h:85
itk
itk::simple::DiscreteGaussianImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDiscreteGaussianImageFilter.h:112
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::DiscreteGaussianImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDiscreteGaussianImageFilter.h:116
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::DiscreteGaussianImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkDiscreteGaussianImageFilter.h:80
itk::simple::DiscreteGaussianImageFilter::SetMaximumError
Self & SetMaximumError(double value)
Definition: sitkDiscreteGaussianImageFilter.h:102
itk::simple::DiscreteGaussianImageFilter::SetMaximumError
Self & SetMaximumError(std::vector< double > MaximumError)
Definition: sitkDiscreteGaussianImageFilter.h:99