itk::simple::ProjectedLandweberDeconvolutionImageFilter Class Reference

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

#include <sitkProjectedLandweberDeconvolutionImageFilter.h>

Inheritance diagram for itk::simple::ProjectedLandweberDeconvolutionImageFilter:

Collaboration diagram for itk::simple::ProjectedLandweberDeconvolutionImageFilter:

Public Types
enum	BoundaryConditionType {   ZERO_PAD,   ZERO_FLUX_NEUMANN_PAD,   PERIODIC_PAD }
enum	OutputRegionModeType {   SAME,   VALID }
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef ProjectedLandweberDeconvolutionImageFilter	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, ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType outputRegionMode)
double	GetAlpha () const
BoundaryConditionType	GetBoundaryCondition () const
std::string	GetName () const
bool	GetNormalize () const
int	GetNumberOfIterations () const
OutputRegionModeType	GetOutputRegionMode () const
Self &	NormalizeOff ()
Self &	NormalizeOn ()
	ProjectedLandweberDeconvolutionImageFilter ()
Self &	SetAlpha (double Alpha)
Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)
Self &	SetNormalize (bool Normalize)
Self &	SetNumberOfIterations (int NumberOfIterations)
Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)
std::string	ToString () const
	~ProjectedLandweberDeconvolutionImageFilter ()
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 projected Landweber deconvolution algorithm.

This filter performs the same calculation per iteration as the LandweberDeconvolutionImageFilter . However, at each iteration, negative pixels in the intermediate result are projected (set) to zero. This is useful if the solution is assumed to always be non-negative, which is the case when dealing with images formed by counting photons, for example.

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

LandweberDeconvolutionImageFilter

itk::simple::ProjectedLandweberDeconvolution for the procedural interface

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

Definition at line 56 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 144 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ProjectedLandweberDeconvolutionImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

typedef ProjectedLandweberDeconvolutionImageFilter itk::simple::ProjectedLandweberDeconvolutionImageFilter::Self

Definition at line 58 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Member Enumeration Documentation

enum itk::simple::ProjectedLandweberDeconvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 106 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

enum itk::simple::ProjectedLandweberDeconvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 116 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

itk::simple::ProjectedLandweberDeconvolutionImageFilter::ProjectedLandweberDeconvolutionImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::ProjectedLandweberDeconvolutionImageFilter::~ProjectedLandweberDeconvolutionImageFilter

(

)

Destructor

Member Function Documentation

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

Execute the filter on the input images

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

Execute the filter on the input images with the given parameters

template<class TImageType >

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

private

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

inline

Get the relaxation factor.

Definition at line 80 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 114 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 126 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 104 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Get the number of iterations.

Definition at line 90 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 124 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 100 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Set the value of Normalize to true or false respectfully.

Definition at line 99 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Set the relaxation factor.

Definition at line 75 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 110 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Normalize the output image by the sum of the kernel components

Definition at line 96 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

References itk::simple::Normalize().

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

inline

Set the number of iterations.

Definition at line 85 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

inline

Definition at line 120 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

std::string itk::simple::ProjectedLandweberDeconvolutionImageFilter::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 149 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Member Data Documentation

double itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_Alpha

private

Definition at line 154 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

BoundaryConditionType itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_BoundaryCondition

private

Definition at line 158 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

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

private

Definition at line 151 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

bool itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_Normalize

private

Definition at line 157 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

int itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_NumberOfIterations

private

Definition at line 155 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

OutputRegionModeType itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_OutputRegionMode

private

Definition at line 159 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

---

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

• sitkProjectedLandweberDeconvolutionImageFilter.h