SimpleITK  2.0.0rc2.post17
sitkInverseDeconvolutionImageFilter.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 sitkInverseDeconvolutionImageFilter_h
19 #define sitkInverseDeconvolutionImageFilter_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 
48  public:
50 
53 
57 
60 \
61 
65  SITK_RETURN_SELF_TYPE_HEADER SetKernelZeroMagnitudeThreshold ( double KernelZeroMagnitudeThreshold ) { this->m_KernelZeroMagnitudeThreshold = KernelZeroMagnitudeThreshold; return *this; }
66 
70  double GetKernelZeroMagnitudeThreshold() const { return this->m_KernelZeroMagnitudeThreshold; }\
71 
76  SITK_RETURN_SELF_TYPE_HEADER SetNormalize ( bool Normalize ) { this->m_Normalize = Normalize; return *this; }
77 
79  SITK_RETURN_SELF_TYPE_HEADER NormalizeOn() { return this->SetNormalize(true); }
80  SITK_RETURN_SELF_TYPE_HEADER NormalizeOff() { return this->SetNormalize(false); }
81 
84  bool GetNormalize() const { return this->m_Normalize; }
85 
86  typedef enum {ZERO_PAD,ZERO_FLUX_NEUMANN_PAD,PERIODIC_PAD} BoundaryConditionType;\
87 
90  SITK_RETURN_SELF_TYPE_HEADER SetBoundaryCondition ( BoundaryConditionType BoundaryCondition ) { this->m_BoundaryCondition = BoundaryCondition; return *this; }
91 
94  BoundaryConditionType GetBoundaryCondition() const { return this->m_BoundaryCondition; }
95 
96  typedef enum {SAME,VALID} OutputRegionModeType;\
97 
100  SITK_RETURN_SELF_TYPE_HEADER SetOutputRegionMode ( OutputRegionModeType OutputRegionMode ) { this->m_OutputRegionMode = OutputRegionMode; return *this; }
101 
104  OutputRegionModeType GetOutputRegionMode() const { return this->m_OutputRegionMode; }
105 
107  std::string GetName() const { return std::string ("InverseDeconvolutionImageFilter"); }
108 
110  std::string ToString() const;
111 
112 
115  Image Execute ( const Image& image1, const Image& image2 );
116 
117  private:
118 
121  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
122  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
123 
124 
126 
127  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
128 
129 
130  double m_KernelZeroMagnitudeThreshold{1.0e-4};
131 
132  /* */
133  bool m_Normalize{false};
134 
136 
138 
139 
140  };
141 
153 
155  }
156 }
157 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::InverseDeconvolutionImageFilter::NormalizeOff
Self & NormalizeOff()
Definition: sitkInverseDeconvolutionImageFilter.h:80
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::InverseDeconvolution
Image InverseDeconvolution(const Image &image1, const Image &image2, double kernelZeroMagnitudeThreshold=1.0e-4, bool normalize=false, InverseDeconvolutionImageFilter::BoundaryConditionType boundaryCondition=itk::simple::InverseDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD, InverseDeconvolutionImageFilter::OutputRegionModeType outputRegionMode=itk::simple::InverseDeconvolutionImageFilter::SAME)
The direct linear inverse deconvolution filter.
itk::simple::InverseDeconvolutionImageFilter::SetOutputRegionMode
Self & SetOutputRegionMode(OutputRegionModeType OutputRegionMode)
Definition: sitkInverseDeconvolutionImageFilter.h:100
itk::simple::InverseDeconvolutionImageFilter::GetBoundaryCondition
BoundaryConditionType GetBoundaryCondition() const
Definition: sitkInverseDeconvolutionImageFilter.h:94
itk::simple::InverseDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD
@ ZERO_FLUX_NEUMANN_PAD
Definition: sitkInverseDeconvolutionImageFilter.h:86
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::InverseDeconvolutionImageFilter
The direct linear inverse deconvolution filter.
Definition: sitkInverseDeconvolutionImageFilter.h:47
itk::simple::InverseDeconvolutionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkInverseDeconvolutionImageFilter.h:121
itk::ImageBoundaryCondition
itk::simple::InverseDeconvolutionImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkInverseDeconvolutionImageFilter.h:59
itk::simple::InverseDeconvolutionImageFilter::OutputRegionModeType
OutputRegionModeType
Definition: sitkInverseDeconvolutionImageFilter.h:96
itk::simple::InverseDeconvolutionImageFilter::GetOutputRegionMode
OutputRegionModeType GetOutputRegionMode() const
Definition: sitkInverseDeconvolutionImageFilter.h:104
itk::simple::InverseDeconvolutionImageFilter::SetNormalize
Self & SetNormalize(bool Normalize)
Definition: sitkInverseDeconvolutionImageFilter.h:76
itk::simple::InverseDeconvolutionImageFilter::ZERO_PAD
@ ZERO_PAD
Definition: sitkInverseDeconvolutionImageFilter.h:86
itk::simple::InverseDeconvolutionImageFilter::SetBoundaryCondition
Self & SetBoundaryCondition(BoundaryConditionType BoundaryCondition)
Definition: sitkInverseDeconvolutionImageFilter.h:90
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::InverseDeconvolutionImageFilter::GetNormalize
bool GetNormalize() const
Definition: sitkInverseDeconvolutionImageFilter.h:84
itk::simple::InverseDeconvolutionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkInverseDeconvolutionImageFilter.h:127
itk::simple::InverseDeconvolutionImageFilter::SAME
@ SAME
Definition: sitkInverseDeconvolutionImageFilter.h:96
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::InverseDeconvolutionImageFilter::GetName
std::string GetName() const
Definition: sitkInverseDeconvolutionImageFilter.h:107
itk::simple::InverseDeconvolutionImageFilter::GetKernelZeroMagnitudeThreshold
double GetKernelZeroMagnitudeThreshold() const
Definition: sitkInverseDeconvolutionImageFilter.h:70
itk::simple::InverseDeconvolutionImageFilter::BoundaryConditionType
BoundaryConditionType
Definition: sitkInverseDeconvolutionImageFilter.h:86
itk::simple::InverseDeconvolutionImageFilter::NormalizeOn
Self & NormalizeOn()
Definition: sitkInverseDeconvolutionImageFilter.h:79
itk::simple::InverseDeconvolutionImageFilter::SetKernelZeroMagnitudeThreshold
Self & SetKernelZeroMagnitudeThreshold(double KernelZeroMagnitudeThreshold)
Definition: sitkInverseDeconvolutionImageFilter.h:65