ITK  5.2.0
Insight Toolkit
itkRichardsonLucyDeconvolutionImageFilter.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 itkRichardsonLucyDeconvolutionImageFilter_h
19 #define itkRichardsonLucyDeconvolutionImageFilter_h
20 
22 
25 #include "itkMultiplyImageFilter.h"
26 
27 namespace itk
28 {
59 template <typename TInputImage,
60  typename TKernelImage = TInputImage,
61  typename TOutputImage = TInputImage,
62  typename TInternalPrecision = double>
63 class ITK_TEMPLATE_EXPORT RichardsonLucyDeconvolutionImageFilter
64  : public IterativeDeconvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>
65 {
66 public:
67  ITK_DISALLOW_COPY_AND_MOVE(RichardsonLucyDeconvolutionImageFilter);
68 
74 
76  using InputImageType = TInputImage;
77  using KernelImageType = TKernelImage;
78  using OutputImageType = TOutputImage;
79 
81  using InternalImageType = typename Superclass::InternalImageType;
83  using InternalComplexType = typename Superclass::InternalComplexType;
84  using InternalComplexImageType = typename Superclass::InternalComplexImageType;
85  using InternalComplexImagePointerType = typename Superclass::InternalComplexImagePointerType;
86 
88  itkNewMacro(Self);
89 
92 
93 protected:
96 
97  void
98  Initialize(ProgressAccumulator * progress, float progressWeight, float iterationProgressWeight) override;
99 
100  void
101  Iteration(ProgressAccumulator * progress, float iterationProgressWeight) override;
102 
103  void
104  Finish(ProgressAccumulator * progress, float progressWeight) override;
105 
106  using FFTFilterType = typename Superclass::FFTFilterType;
107  using IFFTFilterType = typename Superclass::IFFTFilterType;
108 
109  void
110  PrintSelf(std::ostream & os, Indent indent) const override;
111 
112 private:
120 
122 
131 };
132 } // end namespace itk
133 
134 #ifndef ITK_MANUAL_INSTANTIATION
135 # include "itkRichardsonLucyDeconvolutionImageFilter.hxx"
136 #endif
137 
138 #endif
itk::RichardsonLucyDeconvolutionImageFilter::m_ConjugateAdaptor
ConjugateAdaptorType::Pointer m_ConjugateAdaptor
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:127
itk::ConvolutionImageFilterBase::KernelImageType
TKernelImage KernelImageType
Definition: itkConvolutionImageFilterBase.h:76
itk::RichardsonLucyDeconvolutionImageFilter::m_IFFTFilter2
IFFTFilterType::Pointer m_IFFTFilter2
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:129
itk::RichardsonLucyDeconvolutionImageFilter::m_MultiplyFilter
MultiplyFilterType::Pointer m_MultiplyFilter
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:130
itk::RealToHalfHermitianForwardFFTImageFilter
Base class for specialized real-to-complex forward Fast Fourier Transform.
Definition: itkRealToHalfHermitianForwardFFTImageFilter.h:56
itk::RichardsonLucyDeconvolutionImageFilter::m_ComplexMultiplyFilter2
ComplexConjugateMultiplyType::Pointer m_ComplexMultiplyFilter2
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:128
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::DivideOrZeroOutImageFilter
Definition: itkDivideOrZeroOutImageFilter.h:41
itk::FFTConvolutionImageFilter::InternalComplexImagePointerType
typename InternalComplexImageType::Pointer InternalComplexImagePointerType
Definition: itkFFTConvolutionImageFilter.h:101
itk::RichardsonLucyDeconvolutionImageFilter::m_PaddedInput
InternalImagePointerType m_PaddedInput
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:121
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::FFTConvolutionImageFilter::InternalComplexType
std::complex< TInternalPrecision > InternalComplexType
Definition: itkFFTConvolutionImageFilter.h:99
itk::IterativeDeconvolutionImageFilter::InternalImagePointerType
typename Superclass::InternalImagePointerType InternalImagePointerType
Definition: itkIterativeDeconvolutionImageFilter.h:74
itkDivideOrZeroOutImageFilter.h
itk::RichardsonLucyDeconvolutionImageFilter::m_ComplexMultiplyFilter1
ComplexMultiplyType::Pointer m_ComplexMultiplyFilter1
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:123
itkComplexConjugateImageAdaptor.h
itkMultiplyImageFilter.h
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::RichardsonLucyDeconvolutionImageFilter::m_FFTFilter
FFTFilterType::Pointer m_FFTFilter
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:126
itk::ProgressAccumulator
Facilitates progress reporting for filters that wrap around multiple other filters.
Definition: itkProgressAccumulator.h:40
itk::RichardsonLucyDeconvolutionImageFilter::m_DivideFilter
DivideFilterType::Pointer m_DivideFilter
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:125
itk::ComplexConjugateImageAdaptor
Presents each pixel of a complex image as its complex conjugate.
Definition: itkComplexConjugateImageAdaptor.h:64
itkIterativeDeconvolutionImageFilter.h
itk::IterativeDeconvolutionImageFilter
Abstract base class for filters that implement iterative deconvolution algorithms.
Definition: itkIterativeDeconvolutionImageFilter.h:55
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::RichardsonLucyDeconvolutionImageFilter
Deconvolve an image using the Richardson-Lucy deconvolution algorithm.
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:63
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::HalfHermitianToRealInverseFFTImageFilter
Base class for specialized complex-to-real inverse Fast Fourier Transform.
Definition: itkHalfHermitianToRealInverseFFTImageFilter.h:56
itk::MultiplyImageFilter
Pixel-wise multiplication of two images.
Definition: itkMultiplyImageFilter.h:43
itk::RichardsonLucyDeconvolutionImageFilter::m_IFFTFilter1
IFFTFilterType::Pointer m_IFFTFilter1
Definition: itkRichardsonLucyDeconvolutionImageFilter.h:124
itk::FFTConvolutionImageFilter::InternalImagePointerType
typename InternalImageType::Pointer InternalImagePointerType
Definition: itkFFTConvolutionImageFilter.h:98
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90