Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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:

Public Types

enum  BoundaryConditionType {
enum  OutputRegionModeType {
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
SelfNormalizeOff ()
SelfNormalizeOn ()
 RichardsonLucyDeconvolutionImageFilter ()
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
SelfSetNormalize (bool Normalize)
SelfSetNumberOfIterations (int NumberOfIterations)
SelfSetOutputRegionMode (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. 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

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}


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

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::RichardsonLucyDeconvolution for the procedural interface
itk::RichardsonLucyDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 62 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 136 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 74 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ Self

Definition at line 64 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Member Enumeration Documentation

◆ BoundaryConditionType


Definition at line 101 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ OutputRegionModeType


Definition at line 111 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~RichardsonLucyDeconvolutionImageFilter()

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


◆ 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 

◆ GetBoundaryCondition()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ GetNormalize()

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

Definition at line 99 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ GetNumberOfIterations()

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

Get the number of iterations.

Definition at line 85 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ GetOutputRegionMode()

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

◆ NormalizeOff()

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

Definition at line 95 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ NormalizeOn()

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

Set the value of Normalize to true or false respectfully.

Definition at line 94 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ SetBoundaryCondition()

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

◆ SetNormalize()

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

Normalize the output image by the sum of the kernel components

Definition at line 91 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References itk::simple::Normalize().

◆ SetNumberOfIterations()

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

Set the number of iterations.

Definition at line 80 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

◆ SetOutputRegionMode()

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

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BoundaryCondition

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

◆ m_MemberFactory

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

◆ m_Normalize

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

◆ m_NumberOfIterations

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

◆ m_OutputRegionMode

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

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