#include <itkIterativeDeconvolutionImageFilter.h>

Inheritance diagram for itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >:

Collaboration diagram for itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >:

Detailed Description

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
class itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >

Abstract base class for filters that implement iterative deconvolution algorithms.

This filter implements methods common to iterative deconvolution algorithms. The input blurred image is set with the usual SetInput() method and the blurring kernel is set with the SetKernelImage() method.

The number of iterations can be set with the method SetNumberOfIterations(). This class emits an IterationEvent at the start of each iteration. Iteration can be terminated early by calling SetStopIteration( bool ) with the argument set to true. To resume iterating, you must call SetStopIteration( bool ) with the argument set to false before calling Update() a second time.

This code was adapted from the Insight Journal contribution:

"Deconvolution: infrastructure and reference algorithms" by Gaetan Lehmann http://hdl.handle.net/10380/3207

Definition at line 51 of file itkIterativeDeconvolutionImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef TInputImage	InputImageType

typedef Superclass::InternalComplexImagePointerType	InternalComplexImagePointerType

typedef Superclass::InternalComplexImageType	InternalComplexImageType

typedef Superclass::InternalComplexType	InternalComplexType

typedef Superclass::InternalImagePointerType	InternalImagePointerType

typedef Superclass::InternalImageType	InternalImageType

typedef TKernelImage	KernelImageType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef IterativeDeconvolutionImageFilter	Self

typedef FFTConvolutionImageFilter < TInputImage, TKernelImage, TOutputImage, TInternalPrecision >	Superclass

Public Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
typedef Superclass::BoundaryConditionPointerType	BoundaryConditionPointerType

typedef Superclass::BoundaryConditionType	BoundaryConditionType

typedef SmartPointer< const Self >	ConstPointer

typedef TInputImage	InputImageType

typedef InputImageType::IndexType	InputIndexType

typedef InputImageType::PixelType	InputPixelType

typedef InputImageType::RegionType	InputRegionType

typedef InputImageType::SizeType	InputSizeType

typedef InternalComplexImageType::Pointer	InternalComplexImagePointerType

typedef Image < InternalComplexType, TInputImage::ImageDimension >	InternalComplexImageType

typedef std::complex < TInternalPrecision >	InternalComplexType

typedef InternalImageType::Pointer	InternalImagePointerType

typedef Image < TInternalPrecision, TInputImage::ImageDimension >	InternalImageType

typedef TKernelImage	KernelImageType

typedef KernelImageType::IndexType	KernelIndexType

typedef KernelImageType::PixelType	KernelPixelType

typedef KernelImageType::RegionType	KernelRegionType

typedef KernelImageType::SizeType	KernelSizeType

typedef TOutputImage	OutputImageType

typedef OutputImageType::IndexType	OutputIndexType

typedef OutputImageType::PixelType	OutputPixelType

typedef OutputImageType::RegionType	OutputRegionType

typedef OutputImageType::SizeType	OutputSizeType

typedef SmartPointer< Self >	Pointer

typedef FFTConvolutionImageFilter	Self

typedef InputSizeType::SizeValueType	SizeValueType

typedef ConvolutionImageFilterBase < TInputImage, TKernelImage, TOutputImage >	Superclass

Public Types inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
typedef BoundaryConditionType *	BoundaryConditionPointerType

typedef ImageBoundaryCondition < TInputImage >	BoundaryConditionType

typedef SmartPointer< const Self >	ConstPointer

typedef ZeroFluxNeumannBoundaryCondition < TInputImage >	DefaultBoundaryConditionType

typedef TInputImage	InputImageType

typedef InputImageType::IndexType	InputIndexType

typedef InputImageType::PixelType	InputPixelType

typedef InputImageType::RegionType	InputRegionType

typedef InputImageType::SizeType	InputSizeType

typedef TKernelImage	KernelImageType

typedef KernelImageType::IndexType	KernelIndexType

typedef KernelImageType::PixelType	KernelPixelType

typedef KernelImageType::RegionType	KernelRegionType

typedef KernelImageType::SizeType	KernelSizeType

typedef TOutputImage	OutputImageType

typedef OutputImageType::IndexType	OutputIndexType

typedef OutputImageType::PixelType	OutputPixelType

enum	OutputRegionModeType { SAME = 0, VALID }

typedef OutputImageType::RegionType	OutputRegionType

typedef OutputImageType::SizeType	OutputSizeType

typedef SmartPointer< Self >	Pointer

typedef ConvolutionImageFilterBase	Self

typedef InputSizeType::SizeValueType	SizeValueType

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const InternalImageType *	GetCurrentEstimate () const

virtual unsigned int	GetIteration () const

virtual InternalImageType *	GetModifiableCurrentEstimate ()

virtual const char *	GetNameOfClass () const


virtual void	SetNumberOfIterations (unsigned int _arg)

virtual unsigned int	GetNumberOfIterations ()


void	SetStopIteration (bool stop)

virtual bool	GetStopIteration () const

Public Member Functions inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

Public Member Functions inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
virtual void	SetBoundaryCondition (BoundaryConditionPointerType _arg)

virtual BoundaryConditionPointerType	GetBoundaryCondition () const

virtual void	SetKernelImage (const KernelImageType *input)

virtual const KernelImageType *	GetKernelImage () const

virtual void	SetNormalize (bool _arg)

virtual bool	GetNormalize () const

virtual void	NormalizeOn ()

virtual void	NormalizeOff ()

virtual void	SetOutputRegionMode (const OutputRegionModeType _arg)

virtual OutputRegionModeType	GetOutputRegionMode () const

virtual void	SetOutputRegionModeToSame ()

virtual void	SetOutputRegionModeToValid ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress ()

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	SetProgress (float _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Protected Types
typedef Superclass::FFTFilterType	FFTFilterType

typedef Superclass::IFFTFilterType	IFFTFilterType

Protected Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
typedef RealToHalfHermitianForwardFFTImageFilter < InternalImageType, InternalComplexImageType >	FFTFilterType

typedef HalfHermitianToRealInverseFFTImageFilter < InternalComplexImageType, InternalImageType >	IFFTFilterType

Protected Member Functions
virtual void	Finish (ProgressAccumulator *progress, float progressWeight)

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	Initialize (ProgressAccumulator *progress, float progressWeight, float iterationProgressWeight)

virtual void	Iteration (ProgressAccumulator *, float)=0

	IterativeDeconvolutionImageFilter ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual	~IterativeDeconvolutionImageFilter ()

Protected Member Functions inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
void	CropOutput (InternalImageType paddedOutput, ProgressAccumulator progress, float progressWeight)

	FFTConvolutionImageFilter ()

InputSizeType	GetPadLowerBound () const

InputSizeType	GetPadSize () const

bool	GetXDimensionIsOdd () const

void	PadInput (const InputImageType input, InternalImagePointerType &paddedInput, ProgressAccumulator progress, float progressWeight)

void	PrepareInput (const InputImageType input, InternalComplexImagePointerType &preparedInput, ProgressAccumulator progress, float progressWeight)

void	PrepareInputs (const InputImageType input, const KernelImageType kernel, InternalComplexImagePointerType &preparedInput, InternalComplexImagePointerType &preparedKernel, ProgressAccumulator *progress, float progressWeight)

void	PrepareKernel (const KernelImageType kernel, InternalComplexImagePointerType &preparedKernel, ProgressAccumulator progress, float progressWeight)

void	ProduceOutput (InternalComplexImageType paddedOutput, ProgressAccumulator progress, float progressWeight)

void	TransformPaddedInput (const InternalImageType paddedInput, InternalComplexImagePointerType &transformedInput, ProgressAccumulator progress, float progressWeight)

	~FFTConvolutionImageFilter ()

Protected Member Functions inherited from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >
	ConvolutionImageFilterBase ()

void	GenerateOutputInformation ()

OutputRegionType	GetValidRegion () const

virtual void	VerifyInputInformation ()

	~ConvolutionImageFilterBase ()

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

virtual	~ImageSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
InternalImagePointerType	m_CurrentEstimate

InternalComplexImagePointerType	m_TransferFunction

Private Member Functions
	IterativeDeconvolutionImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
ModifiedTimeType	m_InputMTime

unsigned int	m_Iteration

ModifiedTimeType	m_KernelMTime

unsigned int	m_NumberOfIterations

bool	m_StopIteration

Additional Inherited Members
Static Public Member Functions inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
static Pointer	New ()

Static Public Attributes inherited from itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >
static const unsigned int	ImageDimension = TInputImage::ImageDimension

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)