Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LandweberDeconvolutionImageFilter Class Reference

Deconvolve an image using the Landweber deconvolution algorithm. More...

#include <sitkLandweberDeconvolutionImageFilter.h>

+ Inheritance diagram for itk::simple::LandweberDeconvolutionImageFilter:
+ Collaboration diagram for itk::simple::LandweberDeconvolutionImageFilter:

Public Types

enum  BoundaryConditionType {
enum  OutputRegionModeType {
using PixelIDTypeList = BasicPixelIDTypeList
using Self = LandweberDeconvolutionImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

Image Execute (const Image &image1, const Image &image2)
double GetAlpha () const
BoundaryConditionType GetBoundaryCondition () const
std::string GetName () const
bool GetNormalize () const
int GetNumberOfIterations () const
OutputRegionModeType GetOutputRegionMode () const
 LandweberDeconvolutionImageFilter ()
SelfNormalizeOff ()
SelfNormalizeOn ()
SelfSetAlpha (double Alpha)
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
SelfSetNormalize (bool Normalize)
SelfSetNumberOfIterations (int NumberOfIterations)
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
std::string ToString () const
virtual ~LandweberDeconvolutionImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const
virtual void SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int GetNumberOfWorkUnits () const

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1, const Image &image2)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1, const Image &image2)

Private Attributes

double m_Alpha {0.1}
BoundaryConditionType m_BoundaryCondition {itk::simple::LandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
bool m_Normalize {false}
int m_NumberOfIterations {1}
OutputRegionModeType m_OutputRegionMode {itk::simple::LandweberDeconvolutionImageFilter::SAME}


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 NonCopyable (const NonCopyable &)=delete
NonCopyableoperator= (const NonCopyable &)=delete
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Deconvolve an image using the Landweber deconvolution algorithm.

This filter implements the Landweber deconvolution algorithm as defined in Bertero M and Boccacci P, "Introduction to Inverse Problems in Imaging", 1998. The algorithm assumes that the input image has been formed by a linear shift-invariant system with a known kernel.

The Landweber algorithm converges to a solution that minimizes the sum of squared errors \(||f \otimes h - g||\) where \(f\) is the estimate of the unblurred image, \(\otimes\) is the convolution operator, \(h\) is the blurring kernel, and \(g\) is the blurred input image. As such, it is best suited for images that have zero-mean Gaussian white noise.

This is the base implementation of the Landweber algorithm. It may produce results with negative values. For a version of this algorithm that enforces a positivity constraint on each intermediate solution, see ProjectedLandweberDeconvolutionImageFilter .

This code was adapted from the Insight Journal contribution:

"Deconvolution: infrastructure and reference algorithms" by Gaetan Lehmann

Gaetan Lehmann, Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France
Cory Quammen, The University of North Carolina at Chapel Hill
See also
itk::simple::LandweberDeconvolution for the procedural interface
itk::LandweberDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 64 of file sitkLandweberDeconvolutionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::LandweberDeconvolutionImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 )

Setup for member function dispatching

Definition at line 148 of file sitkLandweberDeconvolutionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 76 of file sitkLandweberDeconvolutionImageFilter.h.

◆ Self

Definition at line 66 of file sitkLandweberDeconvolutionImageFilter.h.

Member Enumeration Documentation

◆ BoundaryConditionType


Definition at line 113 of file sitkLandweberDeconvolutionImageFilter.h.

◆ OutputRegionModeType


Definition at line 123 of file sitkLandweberDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~LandweberDeconvolutionImageFilter()

virtual itk::simple::LandweberDeconvolutionImageFilter::~LandweberDeconvolutionImageFilter ( )


◆ LandweberDeconvolutionImageFilter()

itk::simple::LandweberDeconvolutionImageFilter::LandweberDeconvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::LandweberDeconvolutionImageFilter::Execute ( const Image image1,
const Image image2 

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::LandweberDeconvolutionImageFilter::ExecuteInternal ( const Image image1,
const Image image2 

◆ GetAlpha()

double itk::simple::LandweberDeconvolutionImageFilter::GetAlpha ( ) const

Set/get relaxation factor.

Definition at line 87 of file sitkLandweberDeconvolutionImageFilter.h.

◆ GetBoundaryCondition()

BoundaryConditionType itk::simple::LandweberDeconvolutionImageFilter::GetBoundaryCondition ( ) const

Definition at line 121 of file sitkLandweberDeconvolutionImageFilter.h.

◆ GetName()

std::string itk::simple::LandweberDeconvolutionImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 134 of file sitkLandweberDeconvolutionImageFilter.h.

◆ GetNormalize()

bool itk::simple::LandweberDeconvolutionImageFilter::GetNormalize ( ) const

Definition at line 111 of file sitkLandweberDeconvolutionImageFilter.h.

◆ GetNumberOfIterations()

int itk::simple::LandweberDeconvolutionImageFilter::GetNumberOfIterations ( ) const

Get the number of iterations.

Definition at line 97 of file sitkLandweberDeconvolutionImageFilter.h.

◆ GetOutputRegionMode()

OutputRegionModeType itk::simple::LandweberDeconvolutionImageFilter::GetOutputRegionMode ( ) const

Definition at line 131 of file sitkLandweberDeconvolutionImageFilter.h.

◆ NormalizeOff()

Self& itk::simple::LandweberDeconvolutionImageFilter::NormalizeOff ( )

Definition at line 107 of file sitkLandweberDeconvolutionImageFilter.h.

◆ NormalizeOn()

Self& itk::simple::LandweberDeconvolutionImageFilter::NormalizeOn ( )

Set the value of Normalize to true or false respectfully.

Definition at line 106 of file sitkLandweberDeconvolutionImageFilter.h.

◆ SetAlpha()

Self& itk::simple::LandweberDeconvolutionImageFilter::SetAlpha ( double  Alpha)

Set/get relaxation factor.

Definition at line 82 of file sitkLandweberDeconvolutionImageFilter.h.

◆ SetBoundaryCondition()

Self& itk::simple::LandweberDeconvolutionImageFilter::SetBoundaryCondition ( BoundaryConditionType  BoundaryCondition)

Definition at line 117 of file sitkLandweberDeconvolutionImageFilter.h.

◆ SetNormalize()

Self& itk::simple::LandweberDeconvolutionImageFilter::SetNormalize ( bool  Normalize)

Normalize the output image by the sum of the kernel components

Definition at line 103 of file sitkLandweberDeconvolutionImageFilter.h.

References itk::simple::Normalize().

◆ SetNumberOfIterations()

Self& itk::simple::LandweberDeconvolutionImageFilter::SetNumberOfIterations ( int  NumberOfIterations)

Set the number of iterations.

Definition at line 92 of file sitkLandweberDeconvolutionImageFilter.h.

◆ SetOutputRegionMode()

Self& itk::simple::LandweberDeconvolutionImageFilter::SetOutputRegionMode ( OutputRegionModeType  OutputRegionMode)

Definition at line 127 of file sitkLandweberDeconvolutionImageFilter.h.

◆ ToString()

std::string itk::simple::LandweberDeconvolutionImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 152 of file sitkLandweberDeconvolutionImageFilter.h.

Member Data Documentation

◆ m_Alpha

double itk::simple::LandweberDeconvolutionImageFilter::m_Alpha {0.1}

Definition at line 157 of file sitkLandweberDeconvolutionImageFilter.h.

◆ m_BoundaryCondition

BoundaryConditionType itk::simple::LandweberDeconvolutionImageFilter::m_BoundaryCondition {itk::simple::LandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}

Definition at line 164 of file sitkLandweberDeconvolutionImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::LandweberDeconvolutionImageFilter::m_MemberFactory

Definition at line 154 of file sitkLandweberDeconvolutionImageFilter.h.

◆ m_Normalize

bool itk::simple::LandweberDeconvolutionImageFilter::m_Normalize {false}

Definition at line 162 of file sitkLandweberDeconvolutionImageFilter.h.

◆ m_NumberOfIterations

int itk::simple::LandweberDeconvolutionImageFilter::m_NumberOfIterations {1}

Definition at line 159 of file sitkLandweberDeconvolutionImageFilter.h.

◆ m_OutputRegionMode

OutputRegionModeType itk::simple::LandweberDeconvolutionImageFilter::m_OutputRegionMode {itk::simple::LandweberDeconvolutionImageFilter::SAME}

Definition at line 166 of file sitkLandweberDeconvolutionImageFilter.h.

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