SimpleITK  2.0.0rc2.post17
sitkProjectedLandweberDeconvolutionImageFilter.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 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 
61  public:
63 
66 
70 
73 \
74 
78  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
79 
83  double GetAlpha() const { return this->m_Alpha; }\
84 
88  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
89 
93  int GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
94 
99  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
100 
102  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
103  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
104 
107  bool GetNormalize() const { return this->m_Normalize; }
108 
109  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
110 
113  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
114 
117  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
118 
119  typedef enum {SAME,VALID} OutputRegionModeType;\
120 
123  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
124 
127  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
128 
130  std::string GetName() const { return std::string ("ProjectedLandweberDeconvolutionImageFilter"); }
131 
133  std::string ToString() const;
134 
135 
138  Image Execute ( const Image& image1, const Image& image2 );
139 
140  private:
141 
144  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
145  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
146 
147 
149 
150  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
151 
152 
153  double m_Alpha{0.1};
154 
155  int m_NumberOfIterations{1};
156 
157  /* */
158  bool m_Normalize{false};
159 
161 
163 
164 
165  };
166 
178 
180  }
181 }
182 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
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
Deconvolve an image using the projected Landweber deconvolution algorithm.
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:60
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:119
itk::simple::ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:119
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:109
sitkImageFilter.h
itk::simple::ProjectedLandweberDeconvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:144
itk::ImageBoundaryCondition
itk::simple::ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:109
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:123
itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:109
itk::simple::ProjectedLandweberDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:72
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(int NumberOfIterations)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:88
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:150
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:99
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:117
itk
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:78
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:102
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetNumberOfIterations
int GetNumberOfIterations() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:93
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:107
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:103
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:130
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:113
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:127
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:83
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.