SimpleITK  
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::simple {
33 
60  public:
62 
65 
69 
72 \
73 
77  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
78 
82  double GetAlpha() const { return this->m_Alpha; }\
83 
87  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
88 
92  int GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
93 
98  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
99 
101  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
102  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
103 
106  bool GetNormalize() const { return this->m_Normalize; }
107 
108  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
109 
112  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
113 
116  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
117 
118  typedef enum {SAME,VALID} OutputRegionModeType;\
119 
122  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
123 
126  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
127 
129  std::string GetName() const { return std::string ("ProjectedLandweberDeconvolutionImageFilter"); }
130 
132  std::string ToString() const;
133 
134 
137  Image Execute ( const Image& image1, const Image& image2 );
138 
139  private:
140 
143  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
144  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
145 
146 
148 
149  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
150 
151 
152  double m_Alpha{0.1};
153 
154  int m_NumberOfIterations{1};
155 
156  /* */
157  bool m_Normalize{false};
158 
160 
162 
163 
164  };
165 
177 
179 }
180 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
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:28
itk::simple::ProjectedLandweberDeconvolutionImageFilter
Deconvolve an image using the projected Landweber deconvolution algorithm.
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:59
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:118
itk::simple::ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:118
itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:108
sitkImageFilter.h
itk::simple::ProjectedLandweberDeconvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:143
itk::ImageBoundaryCondition
itk::simple::ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:108
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:122
itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:108
itk::simple::ProjectedLandweberDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:71
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(int NumberOfIterations)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:87
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:149
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:98
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:116
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:77
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:101
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetNumberOfIterations
int GetNumberOfIterations() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:92
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:106
itk::simple::ProjectedLandweberDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:102
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:129
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::ProjectedLandweberDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:112
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:126
itk::simple::ProjectedLandweberDeconvolutionImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkProjectedLandweberDeconvolutionImageFilter.h:82
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.