SimpleITK  2.0.0rc2.post21
sitkRichardsonLucyDeconvolutionImageFilter.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 sitkRichardsonLucyDeconvolutionImageFilter_h
19 #define sitkRichardsonLucyDeconvolutionImageFilter_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 
64  public:
66 
69 
73 
76 \
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
82 
86  int GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
87 
92  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
93 
95  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
96  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
97 
100  bool GetNormalize() const { return this->m_Normalize; }
101 
102  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
103 
106  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
107 
110  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
111 
112  typedef enum {SAME,VALID} OutputRegionModeType;\
113 
116  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
117 
120  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
121 
123  std::string GetName() const { return std::string ("RichardsonLucyDeconvolutionImageFilter"); }
124 
126  std::string ToString() const;
127 
128 
131  Image Execute ( const Image& image1, const Image& image2 );
132 
133  private:
134 
137  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
138  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
139 
140 
142 
143  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
144 
145 
146  int m_NumberOfIterations{1};
147 
148  /* */
149  bool m_Normalize{false};
150 
152 
154 
155 
156  };
157 
169 
171  }
172 }
173 #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::RichardsonLucyDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:96
itk::simple::RichardsonLucyDeconvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:143
itk::simple::RichardsonLucyDeconvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:137
itk::simple::RichardsonLucyDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:102
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::RichardsonLucyDeconvolution
Image RichardsonLucyDeconvolution(const Image &image1, const Image &image2, int numberOfIterations=1, bool normalize=false, RichardsonLucyDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::RichardsonLucyDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, RichardsonLucyDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::RichardsonLucyDeconvolutionImageFilter::SAME)
Deconvolve an image using the Richardson-Lucy deconvolution algorithm.
itk::ImageBoundaryCondition
itk::simple::RichardsonLucyDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:102
itk::simple::RichardsonLucyDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:116
itk::simple::RichardsonLucyDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:75
itk::simple::RichardsonLucyDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:112
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RichardsonLucyDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:100
itk::simple::RichardsonLucyDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:112
itk::simple::RichardsonLucyDeconvolutionImageFilter::GetNumberOfIterations
int GetNumberOfIterations() const
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:86
itk
itk::simple::RichardsonLucyDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:110
itk::simple::RichardsonLucyDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:102
itk::simple::RichardsonLucyDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:95
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::RichardsonLucyDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:106
itk::simple::RichardsonLucyDeconvolutionImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(int NumberOfIterations)
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:81
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::RichardsonLucyDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:123
itk::simple::RichardsonLucyDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:92
itk::simple::RichardsonLucyDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:120
itk::simple::RichardsonLucyDeconvolutionImageFilter
Deconvolve an image using the Richardson-Lucy deconvolution algorithm.
Definition: sitkRichardsonLucyDeconvolutionImageFilter.h:63