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 { ZERO_PAD, ZERO_FLUX_NEUMANN_PAD, PERIODIC_PAD }

enum	OutputRegionModeType { SAME, VALID }

typedef BasicPixelIDTypeList	PixelIDTypeList

typedef LandweberDeconvolutionImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, const Image &image2, double alpha, int numberOfIterations, bool normalize, LandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, LandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode)

double	GetAlpha () const

BoundaryConditionType	GetBoundaryCondition () const

std::string	GetName () const

bool	GetNormalize () const

int	GetNumberOfIterations () const

OutputRegionModeType	GetOutputRegionMode () const

	LandweberDeconvolutionImageFilter ()

Self &	NormalizeOff ()

Self &	NormalizeOn ()

Self &	SetAlpha (double Alpha)

Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)

Self &	SetNormalize (bool Normalize)

Self &	SetNumberOfIterations (int NumberOfIterations)

Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)

std::string	ToString () const

	~LandweberDeconvolutionImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

Private Types
typedef Image(Self::*	MemberFunctionType) (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

BoundaryConditionType	m_BoundaryCondition

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_Normalize

int	m_NumberOfIterations

OutputRegionModeType	m_OutputRegionMode

Friends
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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

static const itk::EventObject &	GetITKEventObject (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 algorthm 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 https://hdl.handle.net/10380/3207

Author: 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: IterativeDeconvolutionImageFilter; RichardsonLucyDeconvolutionImageFilter; ProjectedLandweberDeconvolutionImageFilter; itk::simple::LandweberDeconvolution for the procedural interface; itk::LandweberDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 61 of file sitkLandweberDeconvolutionImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 149 of file sitkLandweberDeconvolutionImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::LandweberDeconvolutionImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 73 of file sitkLandweberDeconvolutionImageFilter.h.

typedef LandweberDeconvolutionImageFilter itk::simple::LandweberDeconvolutionImageFilter::Self

Definition at line 63 of file sitkLandweberDeconvolutionImageFilter.h.

Member Enumeration Documentation

enum itk::simple::LandweberDeconvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 111 of file sitkLandweberDeconvolutionImageFilter.h.

enum itk::simple::LandweberDeconvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 121 of file sitkLandweberDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

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

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::LandweberDeconvolutionImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		double	alpha,
		int	numberOfIterations,
		bool	normalize,
		LandweberDeconvolutionImageFilter::BoundaryConditionType	boundaryCondition,
		LandweberDeconvolutionImageFilter::OutputRegionModeType	outputRegionMode
	)

Execute the filter on the input images with the given parameters

template<class TImageType >

Image itk::simple::LandweberDeconvolutionImageFilter::ExecuteInternal	(	const Image &	image1,
		const Image &	image2
	)

private

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

inline

Set/get relaxation factor.

Definition at line 85 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 119 of file sitkLandweberDeconvolutionImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 131 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 109 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Get the number of iterations.

Definition at line 95 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 129 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 105 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Set the value of Normalize to true or false respectfully.

Definition at line 104 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Set/get relaxation factor.

Definition at line 80 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 115 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Normalize the output image by the sum of the kernel components

Definition at line 101 of file sitkLandweberDeconvolutionImageFilter.h.

References itk::simple::Normalize().

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

inline

Set the number of iterations.

Definition at line 90 of file sitkLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 125 of file sitkLandweberDeconvolutionImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 154 of file sitkLandweberDeconvolutionImageFilter.h.

Member Data Documentation

double itk::simple::LandweberDeconvolutionImageFilter::m_Alpha

private

Definition at line 159 of file sitkLandweberDeconvolutionImageFilter.h.

BoundaryConditionType itk::simple::LandweberDeconvolutionImageFilter::m_BoundaryCondition

private

Definition at line 163 of file sitkLandweberDeconvolutionImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::LandweberDeconvolutionImageFilter::m_MemberFactory

private

Definition at line 156 of file sitkLandweberDeconvolutionImageFilter.h.

bool itk::simple::LandweberDeconvolutionImageFilter::m_Normalize

private

Definition at line 162 of file sitkLandweberDeconvolutionImageFilter.h.

int itk::simple::LandweberDeconvolutionImageFilter::m_NumberOfIterations

private

Definition at line 160 of file sitkLandweberDeconvolutionImageFilter.h.

OutputRegionModeType itk::simple::LandweberDeconvolutionImageFilter::m_OutputRegionMode

private

Definition at line 164 of file sitkLandweberDeconvolutionImageFilter.h.

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

sitkLandweberDeconvolutionImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation