itk::simple::RichardsonLucyDeconvolutionImageFilter Class Reference

Deconvolve an image using the Richardson-Lucy deconvolution algorithm. More...

#include <sitkRichardsonLucyDeconvolutionImageFilter.h>

Inheritance diagram for itk::simple::RichardsonLucyDeconvolutionImageFilter:

Collaboration diagram for itk::simple::RichardsonLucyDeconvolutionImageFilter:

Detailed Description

Deconvolve an image using the Richardson-Lucy deconvolution algorithm.

This filter implements the Richardson-Lucy 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 Richardson-Lucy algorithm assumes that noise in the image follows a Poisson distribution and that the distribution for each pixel is independent of the other pixels.

This code was adapted from the Insight Journal contribution:

"Deconvolution: infrastructure and reference algorithms" by Gaetan Lehmann https://doi.org/10.54294/tvgfv1

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

LandweberDeconvolutionImageFilter

ProjectedLandweberDeconvolutionImageFilter

itk::simple::RichardsonLucyDeconvolution for the procedural interface

itk::RichardsonLucyDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 62 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Public Types
enum	BoundaryConditionType {   ZERO_PAD ,   ZERO_FLUX_NEUMANN_PAD ,   PERIODIC_PAD }
enum	OutputRegionModeType {   SAME ,   VALID }
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = RichardsonLucyDeconvolutionImageFilter
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)
BoundaryConditionType	GetBoundaryCondition () const
std::string	GetName () const
bool	GetNormalize () const
int	GetNumberOfIterations () const
OutputRegionModeType	GetOutputRegionMode () const
Self &	NormalizeOff ()
Self &	NormalizeOn ()
	RichardsonLucyDeconvolutionImageFilter ()
Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)
Self &	SetNormalize (bool Normalize)
Self &	SetNumberOfIterations (int NumberOfIterations)
Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)
std::string	ToString () const
virtual	~RichardsonLucyDeconvolutionImageFilter ()
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.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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
BoundaryConditionType	m_BoundaryCondition {itk::simple::RichardsonLucyDeconvolutionImageFilter::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::RichardsonLucyDeconvolutionImageFilter::SAME}

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 double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
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::ProcessObject *	GetActiveProcess ()
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
NonCopyable &	operator= (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::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)

Member Typedef Documentation

MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 136 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

PixelIDTypeList

using itk::simple::RichardsonLucyDeconvolutionImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 74 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Self

using itk::simple::RichardsonLucyDeconvolutionImageFilter::Self = RichardsonLucyDeconvolutionImageFilter

Definition at line 64 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Member Enumeration Documentation

BoundaryConditionType

enum itk::simple::RichardsonLucyDeconvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 101 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

OutputRegionModeType

enum itk::simple::RichardsonLucyDeconvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 111 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

~RichardsonLucyDeconvolutionImageFilter()

virtual itk::simple::RichardsonLucyDeconvolutionImageFilter::~RichardsonLucyDeconvolutionImageFilter ( )

virtual

Destructor

RichardsonLucyDeconvolutionImageFilter()

itk::simple::RichardsonLucyDeconvolutionImageFilter::RichardsonLucyDeconvolutionImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

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

Execute the filter on the input images

ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetBoundaryCondition()

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

inline

Definition at line 109 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_BoundaryCondition.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

GetNormalize()

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

inline

Definition at line 99 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_Normalize.

GetNumberOfIterations()

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

inline

Get the number of iterations.

Definition at line 85 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_NumberOfIterations.

GetOutputRegionMode()

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

inline

Definition at line 119 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_OutputRegionMode.

NormalizeOff()

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

inline

Definition at line 95 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References SetNormalize().

NormalizeOn()

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

inline

Set the value of Normalize to true or false respectfully.

Definition at line 94 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References SetNormalize().

SetBoundaryCondition()

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

inline

Definition at line 105 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_BoundaryCondition.

SetNormalize()

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

inline

Normalize the output image by the sum of the kernel components

Definition at line 91 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_Normalize, and itk::simple::Normalize().

Referenced by NormalizeOff(), and NormalizeOn().

SetNumberOfIterations()

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

inline

Set the number of iterations.

Definition at line 80 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_NumberOfIterations.

SetOutputRegionMode()

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

inline

Definition at line 115 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References m_OutputRegionMode.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 137 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_BoundaryCondition

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

private

Definition at line 150 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Referenced by GetBoundaryCondition(), and SetBoundaryCondition().

m_MemberFactory

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

private

Definition at line 142 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

m_Normalize

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

private

Definition at line 148 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Referenced by GetNormalize(), and SetNormalize().

m_NumberOfIterations

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

private

Definition at line 145 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Referenced by GetNumberOfIterations(), and SetNumberOfIterations().

m_OutputRegionMode

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

private

Definition at line 152 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Referenced by GetOutputRegionMode(), and SetOutputRegionMode().

---

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

• sitkRichardsonLucyDeconvolutionImageFilter.h