ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
#include <itkIterativeDeconvolutionImageFilter.h>
Abstract base class for filters that implement iterative deconvolution algorithms.
This filter implements methods common to iterative deconvolution algorithms. The input blurred image is set with the usual SetInput() method and the blurring kernel is set with the SetKernelImage() method.
The number of iterations can be set with the method SetNumberOfIterations(). This class emits an IterationEvent at the start of each iteration. Iteration can be terminated early by calling SetStopIteration( bool ) with the argument set to true. To resume iterating, you must call SetStopIteration( bool ) with the argument set to false before calling Update() a second time.
This code was adapted from the Insight Journal contribution:
"Deconvolution: infrastructure and reference algorithms" by Gaetan Lehmann https://hdl.handle.net/10380/3207
Definition at line 51 of file itkIterativeDeconvolutionImageFilter.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageType = TInputImage |
using | InternalComplexImagePointerType = typename Superclass::InternalComplexImagePointerType |
using | InternalComplexImageType = typename Superclass::InternalComplexImageType |
using | InternalComplexType = typename Superclass::InternalComplexType |
using | InternalImagePointerType = typename Superclass::InternalImagePointerType |
using | InternalImageType = typename Superclass::InternalImageType |
using | KernelImageType = TKernelImage |
using | OutputImageType = TOutputImage |
using | Pointer = SmartPointer< Self > |
using | Self = IterativeDeconvolutionImageFilter |
using | Superclass = FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > |
Public Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > | |
using | BoundaryConditionPointerType = typename Superclass::BoundaryConditionPointerType |
using | BoundaryConditionType = typename Superclass::BoundaryConditionType |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageType = TInputImage |
using | InputIndexType = typename InputImageType::IndexType |
using | InputPixelType = typename InputImageType::PixelType |
using | InputRegionType = typename InputImageType::RegionType |
using | InputSizeType = typename InputImageType::SizeType |
using | InternalComplexImagePointerType = typename InternalComplexImageType::Pointer |
using | InternalComplexImageType = Image< InternalComplexType, TInputImage::ImageDimension > |
using | InternalComplexType = std::complex< TInternalPrecision > |
using | InternalImagePointerType = typename InternalImageType::Pointer |
using | InternalImageType = Image< TInternalPrecision, TInputImage::ImageDimension > |
using | KernelImageType = TKernelImage |
using | KernelIndexType = typename KernelImageType::IndexType |
using | KernelPixelType = typename KernelImageType::PixelType |
using | KernelRegionType = typename KernelImageType::RegionType |
using | KernelSizeType = typename KernelImageType::SizeType |
using | OutputImageType = TOutputImage |
using | OutputIndexType = typename OutputImageType::IndexType |
using | OutputPixelType = typename OutputImageType::PixelType |
using | OutputRegionType = typename OutputImageType::RegionType |
using | OutputSizeType = typename OutputImageType::SizeType |
using | Pointer = SmartPointer< Self > |
using | Self = FFTConvolutionImageFilter |
using | SizeValueType = typename InputSizeType::SizeValueType |
using | Superclass = ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > |
Public Types inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > | |
using | BoundaryConditionPointerType = BoundaryConditionType * |
using | BoundaryConditionType = ImageBoundaryCondition< TInputImage > |
using | ConstPointer = SmartPointer< const Self > |
using | DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage > |
using | InputImageType = TInputImage |
using | InputIndexType = typename InputImageType::IndexType |
using | InputPixelType = typename InputImageType::PixelType |
using | InputRegionType = typename InputImageType::RegionType |
using | InputSizeType = typename InputImageType::SizeType |
using | KernelImageType = TKernelImage |
using | KernelIndexType = typename KernelImageType::IndexType |
using | KernelPixelType = typename KernelImageType::PixelType |
using | KernelRegionType = typename KernelImageType::RegionType |
using | KernelSizeType = typename KernelImageType::SizeType |
using | OutputImageType = TOutputImage |
using | OutputIndexType = typename OutputImageType::IndexType |
using | OutputPixelType = typename OutputImageType::PixelType |
enum | OutputRegionModeType { SAME = 0, VALID } |
using | OutputRegionType = typename OutputImageType::RegionType |
using | OutputSizeType = typename OutputImageType::SizeType |
using | Pointer = SmartPointer< Self > |
using | Self = ConvolutionImageFilterBase |
using | SizeValueType = typename InputSizeType::SizeValueType |
using | Superclass = ImageToImageFilter< TInputImage, TOutputImage > |
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
using | ConstPointer = SmartPointer< const Self > |
using | InputImageConstPointer = typename InputImageType::ConstPointer |
using | InputImagePixelType = typename InputImageType::PixelType |
using | InputImagePointer = typename InputImageType::Pointer |
using | InputImageRegionType = typename InputImageType::RegionType |
using | InputImageType = TInputImage |
using | OutputImagePixelType = typename Superclass::OutputImagePixelType |
using | OutputImageRegionType = typename Superclass::OutputImageRegionType |
using | Pointer = SmartPointer< Self > |
using | Self = ImageToImageFilter |
using | Superclass = ImageSource< TOutputImage > |
Public Types inherited from itk::ImageSource< TOutputImage > | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = Superclass::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType |
using | OutputImagePixelType = typename OutputImageType::PixelType |
using | OutputImagePointer = typename OutputImageType::Pointer |
using | OutputImageRegionType = typename OutputImageType::RegionType |
using | OutputImageType = TOutputImage |
using | Pointer = SmartPointer< Self > |
using | Self = ImageSource |
using | Superclass = ProcessObject |
Public Types inherited from itk::ProcessObject | |
using | ConstPointer = SmartPointer< const Self > |
using | DataObjectIdentifierType = DataObject::DataObjectIdentifierType |
using | DataObjectPointer = DataObject::Pointer |
using | DataObjectPointerArray = std::vector< DataObjectPointer > |
using | DataObjectPointerArraySizeType = DataObjectPointerArray::size_type |
using | MultiThreaderType = MultiThreaderBase |
using | NameArray = std::vector< DataObjectIdentifierType > |
using | Pointer = SmartPointer< Self > |
using | Self = ProcessObject |
using | Superclass = Object |
Public Types inherited from itk::Object | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = Object |
using | Superclass = LightObject |
Public Types inherited from itk::LightObject | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Protected Types | |
using | FFTFilterType = typename Superclass::FFTFilterType |
using | IFFTFilterType = typename Superclass::IFFTFilterType |
Protected Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > | |
using | FFTFilterType = RealToHalfHermitianForwardFFTImageFilter< InternalImageType, InternalComplexImageType > |
using | IFFTFilterType = HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType, InternalImageType > |
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
using | InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension > |
using | OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension > |
Protected Attributes | |
InternalImagePointerType | m_CurrentEstimate |
InternalComplexImagePointerType | m_TransferFunction |
Protected Attributes inherited from itk::ImageSource< TOutputImage > | |
bool | m_DynamicMultiThreading |
Protected Attributes inherited from itk::ProcessObject | |
TimeStamp | m_OutputInformationMTime |
bool | m_Updating |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount |
Private Attributes | |
ModifiedTimeType | m_InputMTime |
unsigned int | m_Iteration |
ModifiedTimeType | m_KernelMTime |
unsigned int | m_NumberOfIterations |
bool | m_StopIteration |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > | |
static constexpr unsigned int | ImageDimension = TInputImage::ImageDimension |
Static Public Attributes inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > | |
static constexpr unsigned int | ImageDimension = TInputImage::ImageDimension |
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
static constexpr unsigned int | InputImageDimension = TInputImage::ImageDimension |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Static Public Attributes inherited from itk::ImageSource< TOutputImage > | |
static constexpr unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage > | |
static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ConstPointer = SmartPointer< const Self > |
Definition at line 64 of file itkIterativeDeconvolutionImageFilter.h.
|
protected |
Definition at line 138 of file itkIterativeDeconvolutionImageFilter.h.
|
protected |
Definition at line 139 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputImageType = TInputImage |
Other useful type alias.
Definition at line 67 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImagePointerType = typename Superclass::InternalComplexImagePointerType |
Definition at line 76 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImageType = typename Superclass::InternalComplexImageType |
Definition at line 75 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexType = typename Superclass::InternalComplexType |
Definition at line 74 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImagePointerType = typename Superclass::InternalImagePointerType |
Definition at line 73 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImageType = typename Superclass::InternalImageType |
Internal types used by the FFT filters.
Definition at line 72 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelImageType = TKernelImage |
Definition at line 68 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputImageType = TOutputImage |
Definition at line 69 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Pointer = SmartPointer< Self > |
Definition at line 63 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Self = IterativeDeconvolutionImageFilter |
Standard type alias.
Definition at line 58 of file itkIterativeDeconvolutionImageFilter.h.
using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Superclass = FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > |
Definition at line 62 of file itkIterativeDeconvolutionImageFilter.h.
|
protected |
|
overrideprotected |
|
protectedvirtual |
Runs after iterating.
Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
|
overrideprotectedvirtual |
Generate the output image data. Uses a minipipeline, so ThreadedGenerateData is not overridden.
Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
|
overrideprotectedvirtual |
This filter needs the entire image kernel, which in general is going to be a different size then the output requested region. As such, this filter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.
Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
|
virtual |
|
virtual |
Get the current iteration.
|
virtual |
Set/get the current estimate.
|
virtual |
Runtime information support.
Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ProjectedLandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >.
|
virtual |
Set/get the number of iterations.
|
virtual |
Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.
|
protectedvirtual |
Runs before iterating .
Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >.
|
protectedpure virtual |
Performs an iteration.
Implemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.
|
virtual |
Set/get the number of iterations.
|
inline |
Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.
Definition at line 91 of file itkIterativeDeconvolutionImageFilter.h.
|
protected |
Intermediate results. Protected for easy access by subclasses.
Definition at line 136 of file itkIterativeDeconvolutionImageFilter.h.
|
private |
Modified times for the input and kernel.
Definition at line 154 of file itkIterativeDeconvolutionImageFilter.h.
|
private |
The current iteration.
Definition at line 148 of file itkIterativeDeconvolutionImageFilter.h.
|
private |
Definition at line 155 of file itkIterativeDeconvolutionImageFilter.h.
|
private |
Number of iterations to run.
Definition at line 145 of file itkIterativeDeconvolutionImageFilter.h.
|
private |
Flag indicating whether iteration should be stopped.
Definition at line 151 of file itkIterativeDeconvolutionImageFilter.h.
|
protected |
Discrete Fourier transform of the padded kernel.
Definition at line 133 of file itkIterativeDeconvolutionImageFilter.h.