An inverse deconvolution filter regularized in the Tikhonov sense. More...

#include <sitkTikhonovDeconvolutionImageFilter.h>

Inheritance diagram for itk::simple::TikhonovDeconvolutionImageFilter:

Collaboration diagram for itk::simple::TikhonovDeconvolutionImageFilter:

Detailed Description

An inverse deconvolution filter regularized in the Tikhonov sense.

The Tikhonov deconvolution filter is the inverse deconvolution filter with a regularization term added to the denominator. The filter minimizes the equation

\[ ||\hat{f} \otimes h - g||_{L_2}^2 + \mu||\hat{f}||^2 \]

where \(\hat{f}\) is the estimate of the unblurred image, \(h\) is the blurring kernel, \(g\) is the blurred image, and \(\mu\) is a non-negative real regularization function.

The filter applies a kernel described in the Fourier domain as \(H^*(\omega) / (|H(\omega)|^2 + \mu)\) where \(H(\omega)\) is the Fourier transform of \(h\) . The term \(\mu\) is called RegularizationConstant in this filter. If \(\mu\) is set to zero, this filter is equivalent to the InverseDeconvolutionImageFilter .

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

Definition at line 48 of file sitkTikhonovDeconvolutionImageFilter.h.

Public Types
enum	BoundaryConditionType { ZERO_PAD, ZERO_FLUX_NEUMANN_PAD, PERIODIC_PAD }

enum	OutputRegionModeType { SAME, VALID }

using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = TikhonovDeconvolutionImageFilter

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

OutputRegionModeType	GetOutputRegionMode () const

double	GetRegularizationConstant () const

Self &	NormalizeOff ()

Self &	NormalizeOn ()

Self &	SetBoundaryCondition (BoundaryConditionType BoundaryCondition)

Self &	SetNormalize (bool Normalize)

Self &	SetOutputRegionMode (OutputRegionModeType OutputRegionMode)

Self &	SetRegularizationConstant (double RegularizationConstant)

	TikhonovDeconvolutionImageFilter ()

std::string	ToString () const

virtual	~TikhonovDeconvolutionImageFilter ()

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::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_Normalize {false}

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

double	m_RegularizationConstant {0.0}

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. 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::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::TikhonovDeconvolutionImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 )

private

Setup for member function dispatching

Definition at line 122 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ PixelIDTypeList

using itk::simple::TikhonovDeconvolutionImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ Self

using itk::simple::TikhonovDeconvolutionImageFilter::Self = TikhonovDeconvolutionImageFilter

Definition at line 50 of file sitkTikhonovDeconvolutionImageFilter.h.

Member Enumeration Documentation

◆ BoundaryConditionType

enum itk::simple::TikhonovDeconvolutionImageFilter::BoundaryConditionType

Enumerator
ZERO_PAD
ZERO_FLUX_NEUMANN_PAD
PERIODIC_PAD

Definition at line 87 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ OutputRegionModeType

enum itk::simple::TikhonovDeconvolutionImageFilter::OutputRegionModeType

Enumerator
SAME
VALID

Definition at line 97 of file sitkTikhonovDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~TikhonovDeconvolutionImageFilter()

virtual itk::simple::TikhonovDeconvolutionImageFilter::~TikhonovDeconvolutionImageFilter ( )

virtual

Destructor

◆ TikhonovDeconvolutionImageFilter()

itk::simple::TikhonovDeconvolutionImageFilter::TikhonovDeconvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ GetBoundaryCondition()

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

inline

Definition at line 95 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 108 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ GetNormalize()

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

inline

Definition at line 85 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ GetOutputRegionMode()

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

inline

Definition at line 105 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ GetRegularizationConstant()

double itk::simple::TikhonovDeconvolutionImageFilter::GetRegularizationConstant ( ) const

inline

The regularization factor. Larger values reduce the dominance of noise in the solution, but results in higher approximation error in the deblurred image. Default value is 0.0, yielding the same results as the InverseDeconvolutionImageFilter .

Definition at line 71 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ NormalizeOff()

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

inline

Definition at line 81 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ NormalizeOn()

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

inline

Set the value of Normalize to true or false respectfully.

Definition at line 80 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ SetBoundaryCondition()

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

inline

Definition at line 91 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ SetNormalize()

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

inline

Normalize the output image by the sum of the kernel components

Definition at line 77 of file sitkTikhonovDeconvolutionImageFilter.h.

References itk::simple::Normalize().

◆ SetOutputRegionMode()

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

inline

Definition at line 101 of file sitkTikhonovDeconvolutionImageFilter.h.

◆ SetRegularizationConstant()

Self& itk::simple::TikhonovDeconvolutionImageFilter::SetRegularizationConstant ( double RegularizationConstant )

inline

The regularization factor. Larger values reduce the dominance of noise in the solution, but results in higher approximation error in the deblurred image. Default value is 0.0, yielding the same results as the InverseDeconvolutionImageFilter .

Definition at line 66 of file sitkTikhonovDeconvolutionImageFilter.h.