SimpleITK  1.1.0
sitkLandweberDeconvolutionImageFilter.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 sitkLandweberDeconvolutionImageFilter_h
19 #define sitkLandweberDeconvolutionImageFilter_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 
62  public:
64 
67 
71 
74 
75 
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
81 
85  double GetAlpha() const { return this->m_Alpha; }
86 
90  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
91 
95  int GetNumberOfIterations() const { return this->m_NumberOfIterations; }
96 
101  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
102 
104  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
105  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
106 
109  bool GetNormalize() const { return this->m_Normalize; }
110 
111  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;
112 
115  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
116 
119  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
120 
121  typedef enum {SAME,VALID} OutputRegionModeType;
122 
125  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
126 
129  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
131  std::string GetName() const { return std::string ("LandweberDeconvolutionImageFilter"); }
132 
134  std::string ToString() const;
135 
136 
138  Image Execute ( const Image& image1, const Image& image2 );
139 
140 
142  Image Execute ( const Image& image1, const Image& image2, double alpha, int numberOfIterations, bool normalize, LandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, LandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode );
143 
144  private:
145 
148  typedef Image (Self::*MemberFunctionType)( const Image& image1, const Image& image2 );
149  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
150 
151 
152  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
153 
154  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
155 
156 
157  double m_Alpha;
159  /* */
163  };
164 
165 
175 
176  }
177 }
178 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::LandweberDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkLandweberDeconvolutionImageFilter.h:129
itk::simple::Normalize
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
itk::simple::LandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkLandweberDeconvolutionImageFilter.h:111
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::LandweberDeconvolutionImageFilter::GetNumberOfIterations
int GetNumberOfIterations() const
Definition: sitkLandweberDeconvolutionImageFilter.h:95
itk::simple::LandweberDeconvolutionImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkLandweberDeconvolutionImageFilter.h:85
itk::simple::LandweberDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkLandweberDeconvolutionImageFilter.h:109
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::LandweberDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkLandweberDeconvolutionImageFilter.h:121
itk::simple::LandweberDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkLandweberDeconvolutionImageFilter.h:111
itk::simple::LandweberDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkLandweberDeconvolutionImageFilter.h:125
itk::simple::LandweberDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkLandweberDeconvolutionImageFilter.h:131
itk::simple::LandweberDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkLandweberDeconvolutionImageFilter.h:104
itk::simple::LandweberDeconvolutionImageFilter::m_OutputRegionMode
OutputRegionModeType m_OutputRegionMode
Definition: sitkLandweberDeconvolutionImageFilter.h:162
itk::simple::LandweberDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkLandweberDeconvolutionImageFilter.h:105
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::LandweberDeconvolutionImageFilter::m_NumberOfIterations
int m_NumberOfIterations
Definition: sitkLandweberDeconvolutionImageFilter.h:158
itk::simple::LandweberDeconvolutionImageFilter::m_BoundaryCondition
BoundaryConditionType m_BoundaryCondition
Definition: sitkLandweberDeconvolutionImageFilter.h:161
itk::simple::LandweberDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkLandweberDeconvolutionImageFilter.h:73
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::LandweberDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkLandweberDeconvolutionImageFilter.h:111
itk::simple::LandweberDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkLandweberDeconvolutionImageFilter.h:101
itk::simple::LandweberDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkLandweberDeconvolutionImageFilter.h:119
itk::simple::LandweberDeconvolution
Image LandweberDeconvolution(const Image &image1, const Image &image2, double alpha=0.1, int numberOfIterations=1, bool normalize=false, LandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::LandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, LandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::LandweberDeconvolutionImageFilter::SAME)
Deconvolve an image using the Landweber deconvolution algorithm.
itk::simple::LandweberDeconvolutionImageFilter::Self
LandweberDeconvolutionImageFilter Self
Definition: sitkLandweberDeconvolutionImageFilter.h:63
itk::simple::LandweberDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkLandweberDeconvolutionImageFilter.h:115
itk::simple::LandweberDeconvolutionImageFilter
Deconvolve an image using the Landweber deconvolution algorithm.
Definition: sitkLandweberDeconvolutionImageFilter.h:61
itk::simple::LandweberDeconvolutionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(int NumberOfIterations)
Definition: sitkLandweberDeconvolutionImageFilter.h:90
itk::simple::LandweberDeconvolutionImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkLandweberDeconvolutionImageFilter.h:154
itk::simple::LandweberDeconvolutionImageFilter::m_Alpha
double m_Alpha
Definition: sitkLandweberDeconvolutionImageFilter.h:157
itk::simple::LandweberDeconvolutionImageFilter::m_Normalize
bool m_Normalize
Definition: sitkLandweberDeconvolutionImageFilter.h:160
itk::simple::LandweberDeconvolutionImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkLandweberDeconvolutionImageFilter.h:80
itk::simple::LandweberDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkLandweberDeconvolutionImageFilter.h:121