SimpleITK  2.0.0rc2.post38
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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
}
 
using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = ProjectedLandweberDeconvolutionImageFilter
 
- 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)
 
double GetAlpha () const
 
BoundaryConditionType GetBoundaryCondition () const
 
std::string GetName () const
 
bool GetNormalize () const
 
int GetNumberOfIterations () const
 
OutputRegionModeType GetOutputRegionMode () const
 
SelfNormalizeOff ()
 
SelfNormalizeOn ()
 
 ProjectedLandweberDeconvolutionImageFilter ()
 
SelfSetAlpha (double Alpha)
 
SelfSetBoundaryCondition (BoundaryConditionType BoundaryCondition)
 
SelfSetNormalize (bool Normalize)
 
SelfSetNumberOfIterations (int NumberOfIterations)
 
SelfSetOutputRegionMode (OutputRegionModeType OutputRegionMode)
 
std::string ToString () const
 
virtual ~ProjectedLandweberDeconvolutionImageFilter ()
 
- 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

double m_Alpha {0.1}
 
BoundaryConditionType m_BoundaryCondition {itk::simple::ProjectedLandweberDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_Normalize {false}
 
int m_NumberOfIterations {1}
 
OutputRegionModeType m_OutputRegionMode {itk::simple::ProjectedLandweberDeconvolutionImageFilter::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

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 60 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 144 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 72 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ Self

Member Enumeration Documentation

◆ BoundaryConditionType

Enumerator
ZERO_PAD 
ZERO_FLUX_NEUMANN_PAD 
PERIODIC_PAD 

Definition at line 109 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ OutputRegionModeType

Enumerator
SAME 
VALID 

Definition at line 119 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ ~ProjectedLandweberDeconvolutionImageFilter()

virtual itk::simple::ProjectedLandweberDeconvolutionImageFilter::~ProjectedLandweberDeconvolutionImageFilter ( )
virtual

Destructor

◆ ProjectedLandweberDeconvolutionImageFilter()

itk::simple::ProjectedLandweberDeconvolutionImageFilter::ProjectedLandweberDeconvolutionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input images

◆ ExecuteInternal()

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

◆ GetAlpha()

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

Get the relaxation factor.

Definition at line 83 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ GetBoundaryCondition()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 130 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ GetNormalize()

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

◆ GetNumberOfIterations()

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

Get the number of iterations.

Definition at line 93 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ GetOutputRegionMode()

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

◆ NormalizeOff()

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

◆ NormalizeOn()

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

Set the value of Normalize to true or false respectfully.

Definition at line 102 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ SetAlpha()

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

Set the relaxation factor.

Definition at line 78 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ SetBoundaryCondition()

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

◆ SetNormalize()

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

Normalize the output image by the sum of the kernel components

Definition at line 99 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

References itk::simple::Normalize().

◆ SetNumberOfIterations()

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

Set the number of iterations.

Definition at line 88 of file sitkProjectedLandweberDeconvolutionImageFilter.h.

◆ SetOutputRegionMode()

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

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Alpha

double itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_Alpha {0.1}
private

◆ m_BoundaryCondition

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

◆ m_MemberFactory

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

◆ m_Normalize

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

◆ m_NumberOfIterations

int itk::simple::ProjectedLandweberDeconvolutionImageFilter::m_NumberOfIterations {1}
private

◆ m_OutputRegionMode

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

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