SimpleITK  1.3.0.dev165
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::TikhonovDeconvolutionImageFilter Class Reference

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:

Public Types

enum  BoundaryConditionType {
  ZERO_PAD,
  ZERO_FLUX_NEUMANN_PAD,
  PERIODIC_PAD
}
 
enum  OutputRegionModeType {
  SAME,
  VALID
}
 
typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef TikhonovDeconvolutionImageFilter 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 regularizationConstant, bool normalize, TikhonovDeconvolutionImageFilter::BoundaryConditionType boundaryCondition, TikhonovDeconvolutionImageFilter::OutputRegionModeType outputRegionMode)
 
BoundaryConditionType GetBoundaryCondition () const
 
std::string GetName () const
 
bool GetNormalize () const
 
OutputRegionModeType GetOutputRegionMode () const
 
double GetRegularizationConstant () const
 
SelfNormalizeOff ()
 
SelfNormalizeOn ()
 
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
 
SelfSetNormalize (bool Normalize)
 
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
 
SelfSetRegularizationConstant (double RegularizationConstant)
 
 TikhonovDeconvolutionImageFilter ()
 
std::string ToString () const
 
virtual ~TikhonovDeconvolutionImageFilter ()
 
- 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
 
OutputRegionModeType m_OutputRegionMode
 
double m_RegularizationConstant
 

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

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.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 125 of file sitkTikhonovDeconvolutionImageFilter.h.

Define the pixels types supported by this filter

Definition at line 60 of file sitkTikhonovDeconvolutionImageFilter.h.

Definition at line 50 of file sitkTikhonovDeconvolutionImageFilter.h.

Member Enumeration Documentation

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 88 of file sitkTikhonovDeconvolutionImageFilter.h.

Enumerator
SAME 
VALID 

Definition at line 98 of file sitkTikhonovDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::TikhonovDeconvolutionImageFilter::Execute ( const Image image1,
const Image image2,
double  regularizationConstant,
bool  normalize,
TikhonovDeconvolutionImageFilter::BoundaryConditionType  boundaryCondition,
TikhonovDeconvolutionImageFilter::OutputRegionModeType  outputRegionMode 
)

Execute the filter on the input images with the given parameters

template<class TImageType >
Image itk::simple::TikhonovDeconvolutionImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private
BoundaryConditionType itk::simple::TikhonovDeconvolutionImageFilter::GetBoundaryCondition ( ) const
inline

Definition at line 96 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 108 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Definition at line 86 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Definition at line 106 of file sitkTikhonovDeconvolutionImageFilter.h.

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 72 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Definition at line 82 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Set the value of Normalize to true or false respectfully.

Definition at line 81 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Definition at line 92 of file sitkTikhonovDeconvolutionImageFilter.h.

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

Normalize the output image by the sum of the kernel components

Definition at line 78 of file sitkTikhonovDeconvolutionImageFilter.h.

References itk::simple::Normalize().

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

Definition at line 102 of file sitkTikhonovDeconvolutionImageFilter.h.

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 67 of file sitkTikhonovDeconvolutionImageFilter.h.

std::string itk::simple::TikhonovDeconvolutionImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 129 of file sitkTikhonovDeconvolutionImageFilter.h.

Member Data Documentation

BoundaryConditionType itk::simple::TikhonovDeconvolutionImageFilter::m_BoundaryCondition
private

Definition at line 137 of file sitkTikhonovDeconvolutionImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::TikhonovDeconvolutionImageFilter::m_MemberFactory
private

Definition at line 131 of file sitkTikhonovDeconvolutionImageFilter.h.

bool itk::simple::TikhonovDeconvolutionImageFilter::m_Normalize
private

Definition at line 136 of file sitkTikhonovDeconvolutionImageFilter.h.

OutputRegionModeType itk::simple::TikhonovDeconvolutionImageFilter::m_OutputRegionMode
private

Definition at line 138 of file sitkTikhonovDeconvolutionImageFilter.h.

double itk::simple::TikhonovDeconvolutionImageFilter::m_RegularizationConstant
private

Definition at line 134 of file sitkTikhonovDeconvolutionImageFilter.h.


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