ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage > Class Template Reference

#include <itkIterativeDeconvolutionImageFilter.h>

+ Inheritance diagram for itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >:
+ Collaboration diagram for itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TInputImage InputImageType
typedef
Superclass::InternalComplexImagePointerType 
InternalComplexImagePointerType
typedef
Superclass::InternalComplexImageType 
InternalComplexImageType
typedef
Superclass::InternalComplexType 
InternalComplexType
typedef
Superclass::InternalImagePointerType 
InternalImagePointerType
typedef
Superclass::InternalImageType 
InternalImageType
typedef TKernelImage KernelImageType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef
IterativeDeconvolutionImageFilter 
Self
typedef
FFTConvolutionImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual const InternalImageTypeGetCurrentEstimate ()
virtual unsigned int GetIteration () const
virtual const char * GetNameOfClass () const
virtual void SetNumberOfIterations (unsigned int _arg)
virtual unsigned int GetNumberOfIterations ()
void SetStopIteration (bool stop)
virtual bool GetStopIteration () const

Protected Types

typedef Superclass::FFTFilterType FFTFilterType
typedef Superclass::IFFTFilterType IFFTFilterType

Protected Member Functions

virtual void Finish (ProgressAccumulator *progress, float progressWeight)
virtual void GenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void Initialize (ProgressAccumulator *progress, float progressWeight, float iterationProgressWeight)
virtual void Iteration (ProgressAccumulator *, float)=0
 IterativeDeconvolutionImageFilter ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual ~IterativeDeconvolutionImageFilter ()

Protected Attributes

InternalImagePointerType m_CurrentEstimate
InternalComplexImagePointerType m_TransferFunction

Private Member Functions

 IterativeDeconvolutionImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

unsigned long m_InputMTime
unsigned int m_Iteration
unsigned long m_KernelMTime
unsigned int m_NumberOfIterations
bool m_StopIteration

Detailed Description

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage>
class itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >

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 http://hdl.handle.net/10380/3207

Definition at line 51 of file itkIterativeDeconvolutionImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::ConstPointer
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::FFTFilterType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::FFTFilterType [protected]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::IFFTFilterType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::IFFTFilterType [protected]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TInputImage itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InputImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InternalComplexImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InternalComplexImagePointerType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InternalComplexImageType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InternalComplexImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InternalComplexType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InternalComplexType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InternalImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InternalImagePointerType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InternalImageType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::InternalImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TKernelImage itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::KernelImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TOutputImage itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::OutputImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Pointer
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef IterativeDeconvolutionImageFilter itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Self
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef FFTConvolutionImageFilter< TInputImage, TOutputImage > itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::IterativeDeconvolutionImageFilter ( ) [protected]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::~IterativeDeconvolutionImageFilter ( ) [protected, virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::IterativeDeconvolutionImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Finish ( ProgressAccumulator progress,
float  progressWeight 
) [protected, virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GenerateData ( ) [protected, virtual]

Generate the output image data. Uses a minipipeline, so ThreadedGenerateData is not overridden.

Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

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.

See also:
ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual const InternalImageType* itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetCurrentEstimate ( ) [virtual]

Set/get the current estimate.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetIteration ( ) const [virtual]

Get the current iteration.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual const char* itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetNumberOfIterations ( ) [virtual]

Set/get the number of iterations.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual bool itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::GetStopIteration ( ) const [virtual]

Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Initialize ( ProgressAccumulator progress,
float  progressWeight,
float  iterationProgressWeight 
) [protected, virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::Iteration ( ProgressAccumulator ,
float   
) [protected, pure virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage > >, and itk::ProjectedLandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::SetNumberOfIterations ( unsigned int  _arg) [virtual]

Set/get the number of iterations.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::SetStopIteration ( bool  stop) [inline]

Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.

Definition at line 86 of file itkIterativeDeconvolutionImageFilter.h.


Member Data Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
InternalImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_CurrentEstimate [protected]

Intermediate results. Protected for easy access by subclasses.

Definition at line 131 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
unsigned long itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_InputMTime [private]

Modified times for the input and kernel.

Definition at line 152 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_Iteration [private]

The current iteration.

Definition at line 146 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
unsigned long itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_KernelMTime [private]

Definition at line 153 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_NumberOfIterations [private]

Number of iterations to run.

Definition at line 143 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
bool itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_StopIteration [private]

Flag indicating whether iteration should be stopped.

Definition at line 149 of file itkIterativeDeconvolutionImageFilter.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
InternalComplexImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >::m_TransferFunction [protected]

Discrete Fourier transform of the padded kernel.

Definition at line 128 of file itkIterativeDeconvolutionImageFilter.h.


The documentation for this class was generated from the following file: