SimpleITK  1.1.0
sitkProjectedLandweberDeconvolutionImageFilter.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 sitkProjectedLandweberDeconvolutionImageFilter_h
19 #define sitkProjectedLandweberDeconvolutionImageFilter_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 
57  public:
59 
62 
66 
69 
70 
71 
75  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
76 
80  double GetAlpha() const { return this->m_Alpha; }
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
86 
90  int GetNumberOfIterations() const { return this->m_NumberOfIterations; }
91 
96  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
97 
99  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
100  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
101 
104  bool GetNormalize() const { return this->m_Normalize; }
105 
106  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;
107 
110  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
111 
114  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
115 
116  typedef enum {SAME,VALID} OutputRegionModeType;
117 
120  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
121 
124  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
126  std::string GetName() const { return std::string ("ProjectedLandweberDeconvolutionImageFilter"); }
127 
129  std::string ToString() const;
130 
131 
133  Image Execute ( const Image& image1, const Image& image2 );
134 
135 
137  Image Execute ( const Image& image1, const Image& image2, double alpha, int numberOfIterations, bool normalize, ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode );
138 
139  private:
140 
143  typedef Image (Self::*MemberFunctionType)( const Image& image1, const Image& image2 );
144  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
145 
146 
147  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
148 
149  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
150 
151 
152  double m_Alpha;
154  /* */
158  };
159 
160 
170 
171  }
172 }
173 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::Normalize
Image Normalize(const Image &image1)
Normalize an image by setting its mean to zero and variance to one.
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ProjectedLandweberDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:68
itk::simple::ProjectedLandweberDeconvolutionImageFilter
Deconvolve an image using the projected Landweber deconvolution algorithm.
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:56
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:116
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_OutputRegionMode
OutputRegionModeType m_OutputRegionMode
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:157
itk::simple::ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:116
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_NumberOfIterations
int m_NumberOfIterations
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:153
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
itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:106
sitkImageFilter.h
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:149
itk::simple::ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:106
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:120
itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:106
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_Alpha
double m_Alpha
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:152
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(int NumberOfIterations)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:85
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_BoundaryCondition
BoundaryConditionType m_BoundaryCondition
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:156
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:96
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:114
itk
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:75
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:99
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetNumberOfIterations
int GetNumberOfIterations() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:90
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::ProjectedLandweberDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:104
itk::simple::ProjectedLandweberDeconvolutionImageFilter::Self
ProjectedLandweberDeconvolutionImageFilter Self
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:58
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:100
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:126
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:110
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_Normalize
bool m_Normalize
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:155
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:124
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:80
itk::simple::ProjectedLandweberDeconvolution
Image ProjectedLandweberDeconvolution(const Image &image1, const Image &image2, double alpha=0.1, int numberOfIterations=1, bool normalize=false, ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::ProjectedLandweberDeconvolutionImageFilter::SAME)
Deconvolve an image using the projected Landweber deconvolution algorithm.