The direct linear inverse deconvolution filter. More...

#include <sitkInverseDeconvolutionImageFilter.h>

Inheritance diagram for itk::simple::InverseDeconvolutionImageFilter:

Collaboration diagram for itk::simple::InverseDeconvolutionImageFilter:

Public Types
enum	BoundaryConditionType { ZERO_PAD, ZERO_FLUX_NEUMANN_PAD, PERIODIC_PAD }

enum	OutputRegionModeType { SAME, VALID }

typedef BasicPixelIDTypeList	PixelIDTypeList

typedef InverseDeconvolutionImageFilter	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 kernelZeroMagnitudeThreshold, bool normalize, InverseDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, InverseDeconvolutionImageFilter::OutputRegionModeType outputRegionMode)

BoundaryConditionType	GetBoundaryCondition () const

double	GetKernelZeroMagnitudeThreshold () const

std::string	GetName () const

bool	GetNormalize () const

OutputRegionModeType	GetOutputRegionMode () const

	InverseDeconvolutionImageFilter ()

Self &	NormalizeOff ()

Self &	NormalizeOn ()

Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)

Self &	SetKernelZeroMagnitudeThreshold (double KernelZeroMagnitudeThreshold)

Self &	SetNormalize (bool Normalize)

Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)

std::string	ToString () const

virtual	~InverseDeconvolutionImageFilter ()

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

double	m_KernelZeroMagnitudeThreshold

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

bool	m_Normalize

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

The direct linear inverse deconvolution filter.

The inverse filter is the most straightforward deconvolution method. Considering that convolution of two images in the spatial domain is equivalent to multiplying the Fourier transform of the two images, the inverse filter consists of inverting the multiplication. In other words, this filter computes the following:

$hat{F}(\omega) = \begin{cases} G(\omega) / H(\omega) & \text{if \f$|H(\omega)| \geq \epsilon\f$} \\ 0 & \text{otherwise} \end{cases}$

where $\hat{F}(\omega)$ is the Fourier transform of the estimate produced by this filter, $G(\omega)$ is the Fourier transform of the input blurred image, $H(\omega)$ is the Fourier transform of the blurring kernel, and $\epsilon$ is a constant real non-negative threshold (called KernelZeroMagnitudeThreshold in this filter) that determines when the magnitude of a complex number is considered zero.

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: itk::simple::InverseDeconvolution for the procedural interface; itk::InverseDeconvolutionImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkInverseDeconvolutionImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 123 of file sitkInverseDeconvolutionImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::InverseDeconvolutionImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkInverseDeconvolutionImageFilter.h.

typedef InverseDeconvolutionImageFilter itk::simple::InverseDeconvolutionImageFilter::Self

Definition at line 48 of file sitkInverseDeconvolutionImageFilter.h.

Member Enumeration Documentation

enum itk::simple::InverseDeconvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 86 of file sitkInverseDeconvolutionImageFilter.h.

enum itk::simple::InverseDeconvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 96 of file sitkInverseDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::InverseDeconvolutionImageFilter::~InverseDeconvolutionImageFilter ( )

virtual

Destructor

itk::simple::InverseDeconvolutionImageFilter::InverseDeconvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::InverseDeconvolutionImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		double	kernelZeroMagnitudeThreshold,
		bool	normalize,
		InverseDeconvolutionImageFilter::BoundaryConditionType	boundaryCondition,
		InverseDeconvolutionImageFilter::OutputRegionModeType	outputRegionMode
	)

Execute the filter on the input images with the given parameters

template<class TImageType >

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

private

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

inline

Definition at line 94 of file sitkInverseDeconvolutionImageFilter.h.

double itk::simple::InverseDeconvolutionImageFilter::GetKernelZeroMagnitudeThreshold ( ) const

inline

Set/get the threshold value uused to determine whether a frequency of the Fourier transform of the blurring kernel is considered to be zero. Default value is 1.0e-4.

Definition at line 70 of file sitkInverseDeconvolutionImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Definition at line 84 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Definition at line 104 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Definition at line 80 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Set the value of Normalize to true or false respectfully.

Definition at line 79 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Definition at line 90 of file sitkInverseDeconvolutionImageFilter.h.

Self& itk::simple::InverseDeconvolutionImageFilter::SetKernelZeroMagnitudeThreshold ( double KernelZeroMagnitudeThreshold )

inline

Set/get the threshold value uused to determine whether a frequency of the Fourier transform of the blurring kernel is considered to be zero. Default value is 1.0e-4.

Definition at line 65 of file sitkInverseDeconvolutionImageFilter.h.

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

inline

Normalize the output image by the sum of the kernel components

Definition at line 76 of file sitkInverseDeconvolutionImageFilter.h.

References itk::simple::Normalize().

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

inline

Definition at line 100 of file sitkInverseDeconvolutionImageFilter.h.

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

virtual

Print ourselves out