SimpleITK  1.0.1
sitkWienerDeconvolutionImageFilter.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 sitkWienerDeconvolutionImageFilter_h
19 #define sitkWienerDeconvolutionImageFilter_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 
55  public:
57 
61 
64 
67 
68 
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetNoiseVariance ( double NoiseVariance ) { this->m_NoiseVariance = NoiseVariance; return *this; }
74 
78  double GetNoiseVariance() const { return this->m_NoiseVariance; }
79 
84  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
85 
87  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
88  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
89 
92  bool GetNormalize() const { return this->m_Normalize; }
93 
94  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;
95 
98  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
99 
102  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
103 
104  typedef enum {SAME,VALID} OutputRegionModeType;
105 
108  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
109 
112  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
114  std::string GetName() const { return std::string ("WienerDeconvolutionImageFilter"); }
115 
117  std::string ToString() const;
118 
119 
121  Image Execute ( const Image& image1, const Image& image2 );
122 
123 
125  Image Execute ( const Image& image1, const Image& image2, double noiseVariance, bool normalize, WienerDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, WienerDeconvolutionImageFilter::OutputRegionModeType outputRegionMode );
126 
127 
128  private:
129 
132  typedef Image (Self::*MemberFunctionType)( const Image& image1, const Image& image2 );
133  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
134 
135 
136 
137  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
138 
139  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
140 
141 
143  /* */
147  };
148 
149 
150 
160 
161  }
162 }
163 #endif
#define SITKBasicFilters_EXPORT
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
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
The Wiener deconvolution image filter is designed to restore an image convolved with a blurring kerne...
The main Image class for SimpleITK.
Definition: sitkImage.h:54
Image WienerDeconvolution(const Image &image1, const Image &image2, double noiseVariance=0.0, bool normalize=false, WienerDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::WienerDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, WienerDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::WienerDeconvolutionImageFilter::SAME)
The Wiener deconvolution image filter is designed to restore an image convolved with a blurring kerne...
The base interface for SimpleITK filters that take one input image.