SimpleITK  1.3.0.dev216
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 {
  ZERO_PAD,
  ZERO_FLUX_NEUMANN_PAD,
  PERIODIC_PAD
}
 
enum  OutputRegionModeType {
  SAME,
  VALID
}
 
typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef RichardsonLucyDeconvolutionImageFilter 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, int numberOfIterations, bool normalize, RichardsonLucyDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, RichardsonLucyDeconvolutionImageFilter::OutputRegionModeType outputRegionMode)
 
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< 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

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::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
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::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 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
LandweberDeconvolutionImageFilter
ProjectedLandweberDeconvolutionImageFilter
itk::simple::RichardsonLucyDeconvolution for the procedural interface
itk::RichardsonLucyDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 59 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 136 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Define the pixels types supported by this filter

Definition at line 71 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Definition at line 61 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Member Enumeration Documentation

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 99 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Enumerator
SAME 
VALID 

Definition at line 109 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

itk::simple::RichardsonLucyDeconvolutionImageFilter::RichardsonLucyDeconvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::RichardsonLucyDeconvolutionImageFilter::Execute ( const Image image1,
const Image image2,
int  numberOfIterations,
bool  normalize,
RichardsonLucyDeconvolutionImageFilter::BoundaryConditionType  boundaryCondition,
RichardsonLucyDeconvolutionImageFilter::OutputRegionModeType  outputRegionMode 
)

Execute the filter on the input images with the given parameters

template<class TImageType >
Image itk::simple::RichardsonLucyDeconvolutionImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private
BoundaryConditionType itk::simple::RichardsonLucyDeconvolutionImageFilter::GetBoundaryCondition ( ) const
inline
std::string itk::simple::RichardsonLucyDeconvolutionImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 119 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

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

Definition at line 97 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

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

Get the number of iterations.

Definition at line 83 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

OutputRegionModeType itk::simple::RichardsonLucyDeconvolutionImageFilter::GetOutputRegionMode ( ) const
inline
Self& itk::simple::RichardsonLucyDeconvolutionImageFilter::NormalizeOff ( )
inline

Definition at line 93 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

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

Set the value of Normalize to true or false respectfully.

Definition at line 92 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Self& itk::simple::RichardsonLucyDeconvolutionImageFilter::SetBoundaryCondition ( BoundaryConditionType  BoundaryCondition)
inline
Self& itk::simple::RichardsonLucyDeconvolutionImageFilter::SetNormalize ( bool  Normalize)
inline

Normalize the output image by the sum of the kernel components

Definition at line 89 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

References itk::simple::Normalize().

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

Set the number of iterations.

Definition at line 78 of file sitkRichardsonLucyDeconvolutionImageFilter.h.

Self& itk::simple::RichardsonLucyDeconvolutionImageFilter::SetOutputRegionMode ( OutputRegionModeType  OutputRegionMode)
inline
std::string itk::simple::RichardsonLucyDeconvolutionImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Member Data Documentation

BoundaryConditionType itk::simple::RichardsonLucyDeconvolutionImageFilter::m_BoundaryCondition
private
nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::RichardsonLucyDeconvolutionImageFilter::m_MemberFactory
private
bool itk::simple::RichardsonLucyDeconvolutionImageFilter::m_Normalize
private
int itk::simple::RichardsonLucyDeconvolutionImageFilter::m_NumberOfIterations
private
OutputRegionModeType itk::simple::RichardsonLucyDeconvolutionImageFilter::m_OutputRegionMode
private

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