SimpleITK  2.0.0rc2.post23
sitkTikhonovDeconvolutionImageFilter.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 sitkTikhonovDeconvolutionImageFilter_h
19 #define sitkTikhonovDeconvolutionImageFilter_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 
50  public:
52 
55 
59 
62 \
63 
67  SITK_RETURN_SELF_TYPE_HEADER SetRegularizationConstant ( double RegularizationConstant ) { this->m_RegularizationConstant = RegularizationConstant; return *this; }
68 
72  double GetRegularizationConstant() const { return this->m_RegularizationConstant; }\
73 
78  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
79 
81  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
82  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
83 
86  bool GetNormalize() const { return this->m_Normalize; }
87 
88  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
89 
92  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
93 
96  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
97 
98  typedef enum {SAME,VALID} OutputRegionModeType;\
99 
102  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
103 
106  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
107 
109  std::string GetName() const { return std::string ("TikhonovDeconvolutionImageFilter"); }
110 
112  std::string ToString() const;
113 
114 
117  Image Execute ( const Image& image1, const Image& image2 );
118 
119  private:
120 
123  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
124  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
125 
126 
128 
129  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
130 
131 
132  double m_RegularizationConstant{0.0};
133 
134  /* */
135  bool m_Normalize{false};
136 
138 
140 
141 
142  };
143 
155 
157  }
158 }
159 #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::TikhonovDeconvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkTikhonovDeconvolutionImageFilter.h:129
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::TikhonovDeconvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkTikhonovDeconvolutionImageFilter.h:123
itk::simple::TikhonovDeconvolution
Image TikhonovDeconvolution(const Image &image1, const Image &image2, double regularizationConstant=0.0, bool normalize=false, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::TikhonovDeconvolutionImageFilter::SAME)
An inverse deconvolution filter regularized in the Tikhonov sense.
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::TikhonovDeconvolutionImageFilter::SetRegularizationConstant
Self & SetRegularizationConstant(double RegularizationConstant)
Definition: sitkTikhonovDeconvolutionImageFilter.h:67
sitkImageFilter.h
itk::simple::TikhonovDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkTikhonovDeconvolutionImageFilter.h:78
itk::simple::TikhonovDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkTikhonovDeconvolutionImageFilter.h:106
itk::ImageBoundaryCondition
itk::simple::TikhonovDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkTikhonovDeconvolutionImageFilter.h:88
itk::simple::TikhonovDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkTikhonovDeconvolutionImageFilter.h:82
itk::simple::TikhonovDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkTikhonovDeconvolutionImageFilter.h:109
itk::simple::TikhonovDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkTikhonovDeconvolutionImageFilter.h:61
itk::simple::TikhonovDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkTikhonovDeconvolutionImageFilter.h:98
itk::simple::TikhonovDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkTikhonovDeconvolutionImageFilter.h:96
itk::simple::TikhonovDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkTikhonovDeconvolutionImageFilter.h:88
itk::simple::TikhonovDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkTikhonovDeconvolutionImageFilter.h:98
itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkTikhonovDeconvolutionImageFilter.h:88
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::TikhonovDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkTikhonovDeconvolutionImageFilter.h:81
itk
itk::simple::TikhonovDeconvolutionImageFilter::GetRegularizationConstant
double GetRegularizationConstant() const
Definition: sitkTikhonovDeconvolutionImageFilter.h:72
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::TikhonovDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkTikhonovDeconvolutionImageFilter.h:102
itk::simple::TikhonovDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkTikhonovDeconvolutionImageFilter.h:92
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::TikhonovDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkTikhonovDeconvolutionImageFilter.h:86
itk::simple::TikhonovDeconvolutionImageFilter
An inverse deconvolution filter regularized in the Tikhonov sense.
Definition: sitkTikhonovDeconvolutionImageFilter.h:49