SimpleITK  2.0.0rc2.post21
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::InverseDeconvolutionImageFilter Class Reference

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
}
 
using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = InverseDeconvolutionImageFilter
 
- 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
 
double GetKernelZeroMagnitudeThreshold () const
 
std::string GetName () const
 
bool GetNormalize () const
 
OutputRegionModeType GetOutputRegionMode () const
 
 InverseDeconvolutionImageFilter ()
 
SelfNormalizeOff ()
 
SelfNormalizeOn ()
 
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
 
SelfSetKernelZeroMagnitudeThreshold (double KernelZeroMagnitudeThreshold)
 
SelfSetNormalize (bool Normalize)
 
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
 
std::string ToString () const
 
virtual ~InverseDeconvolutionImageFilter ()
 
- 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::InverseDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}
 
double m_KernelZeroMagnitudeThreshold {1.0e-4}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_Normalize {false}
 
OutputRegionModeType m_OutputRegionMode {itk::simple::InverseDeconvolutionImageFilter::SAME}
 

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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *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

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 47 of file sitkInverseDeconvolutionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::InverseDeconvolutionImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 )
private

Setup for member function dispatching

Definition at line 121 of file sitkInverseDeconvolutionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 59 of file sitkInverseDeconvolutionImageFilter.h.

◆ Self

Definition at line 49 of file sitkInverseDeconvolutionImageFilter.h.

Member Enumeration Documentation

◆ BoundaryConditionType

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 86 of file sitkInverseDeconvolutionImageFilter.h.

◆ OutputRegionModeType

Enumerator
SAME 
VALID 

Definition at line 96 of file sitkInverseDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~InverseDeconvolutionImageFilter()

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

Destructor

◆ InverseDeconvolutionImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::InverseDeconvolutionImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private

◆ GetBoundaryCondition()

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

Definition at line 94 of file sitkInverseDeconvolutionImageFilter.h.

◆ GetKernelZeroMagnitudeThreshold()

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

Set/get the threshold value used 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.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 107 of file sitkInverseDeconvolutionImageFilter.h.

◆ GetNormalize()

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

Definition at line 84 of file sitkInverseDeconvolutionImageFilter.h.

◆ GetOutputRegionMode()

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

Definition at line 104 of file sitkInverseDeconvolutionImageFilter.h.

◆ NormalizeOff()

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

Definition at line 80 of file sitkInverseDeconvolutionImageFilter.h.

◆ NormalizeOn()

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

Set the value of Normalize to true or false respectfully.

Definition at line 79 of file sitkInverseDeconvolutionImageFilter.h.

◆ SetBoundaryCondition()

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

Definition at line 90 of file sitkInverseDeconvolutionImageFilter.h.

◆ SetKernelZeroMagnitudeThreshold()

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

Set/get the threshold value used 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.

◆ SetNormalize()

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().

◆ SetOutputRegionMode()

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

Definition at line 100 of file sitkInverseDeconvolutionImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 125 of file sitkInverseDeconvolutionImageFilter.h.

Member Data Documentation

◆ m_BoundaryCondition

BoundaryConditionType itk::simple::InverseDeconvolutionImageFilter::m_BoundaryCondition {itk::simple::InverseDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}
private

Definition at line 135 of file sitkInverseDeconvolutionImageFilter.h.

◆ m_KernelZeroMagnitudeThreshold

double itk::simple::InverseDeconvolutionImageFilter::m_KernelZeroMagnitudeThreshold {1.0e-4}
private

Definition at line 130 of file sitkInverseDeconvolutionImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::InverseDeconvolutionImageFilter::m_MemberFactory
private

Definition at line 127 of file sitkInverseDeconvolutionImageFilter.h.

◆ m_Normalize

bool itk::simple::InverseDeconvolutionImageFilter::m_Normalize {false}
private

Definition at line 133 of file sitkInverseDeconvolutionImageFilter.h.

◆ m_OutputRegionMode

OutputRegionModeType itk::simple::InverseDeconvolutionImageFilter::m_OutputRegionMode {itk::simple::InverseDeconvolutionImageFilter::SAME}
private

Definition at line 137 of file sitkInverseDeconvolutionImageFilter.h.


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