#include <itkIterativeDeconvolutionImageFilter.h>

Detailed Description

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename 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 https://doi.org/10.54294/tvgfv1

Definition at line 55 of file itkIterativeDeconvolutionImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageType = TInputImage

using	KernelImageType = TKernelImage

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = IterativeDeconvolutionImageFilter

using	Superclass = FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >

Public Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >
using	ConstPointer = SmartPointer< const Self >

using	InputImageType = TInputImage

using	InputIndexType = typename InputImageType::IndexType

using	InputPixelType = typename InputImageType::PixelType

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	InternalComplexImagePointerType = typename InternalComplexImageType::Pointer

using	InternalComplexImageType = Image< InternalComplexType, TInputImage::ImageDimension >

using	InternalComplexType = std::complex< double >

using	InternalImagePointerType = typename InternalImageType::Pointer

using	InternalImageType = Image< double, TInputImage::ImageDimension >

using	InternalIndexType = typename InternalImageType::IndexType

using	InternalRegionType = typename InternalImageType::RegionType

using	InternalSizeType = typename InternalImageType::SizeType

using	KernelImageType = TInputImage

using	KernelIndexType = typename KernelImageType::IndexType

using	KernelPixelType = typename KernelImageType::PixelType

using	KernelRegionType = typename KernelImageType::RegionType

using	KernelSizeType = typename KernelImageType::SizeType

using	OutputImageType = TInputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	Pointer = SmartPointer< Self >

using	Self = FFTConvolutionImageFilter

using	SizeValueType = typename InputSizeType::SizeValueType

using	Superclass = ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage >

Public Types inherited from itk::ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage >
using	BoundaryConditionType = ImageBoundaryCondition< TInputImage >

using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage >

using	InputImageType = TInputImage

using	InputIndexType = typename InputImageType::IndexType

using	InputPixelType = typename InputImageType::PixelType

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	KernelImageType = TInputImage

using	KernelIndexType = typename KernelImageType::IndexType

using	KernelPixelType = typename KernelImageType::PixelType

using	KernelRegionType = typename KernelImageType::RegionType

using	KernelSizeType = typename KernelImageType::SizeType

using	OutputImageType = TInputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	Pointer = SmartPointer< Self >

using	Self = ConvolutionImageFilterBase

using	SizeValueType = typename InputSizeType::SizeValueType

using	Superclass = ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TInputImage >

Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual unsigned int	GetIteration () const

virtual InternalImageType *	GetModifiableCurrentEstimate ()

const char *	GetNameOfClass () const override


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, TInputImage, TInputImage, double >
const char *	GetNameOfClass () const override

virtual SizeValueType	GetSizeGreatestPrimeFactor ()

virtual void	SetSizeGreatestPrimeFactor (SizeValueType _arg)

Public Member Functions inherited from itk::ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage >
const char *	GetNameOfClass () const override

virtual void	SetBoundaryCondition (BoundaryConditionType *_arg)

virtual BoundaryConditionType *	GetBoundaryCondition () const

	itkSetInputMacro (KernelImage, KernelImageType)

	itkGetInputMacro (KernelImage, KernelImageType)

virtual void	SetNormalize (bool _arg)

virtual bool	GetNormalize () const

virtual void	NormalizeOn ()

virtual void	SetOutputRegionMode (const OutputRegionModeEnum _arg)

virtual OutputRegionModeEnum	GetOutputRegionMode () const

virtual void	SetOutputRegionModeToSame ()

virtual void	SetOutputRegionModeToValid ()

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

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

virtual void	SetInput (const InputImageType *input)

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< TInputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

void	GenerateData () override

void	GenerateInputRequestedRegion () override

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

virtual void	Iteration (ProgressAccumulator *, float)=0

	IterativeDeconvolutionImageFilter ()

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

	~IterativeDeconvolutionImageFilter () override

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

	FFTConvolutionImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

InternalSizeType	GetFFTPadSize () const

KernelSizeType	GetKernelRadius () 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	PrintSelf (std::ostream &os, Indent indent) const override

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

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

	~FFTConvolutionImageFilter () override=default

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

void	GenerateOutputInformation () override

OutputRegionType	GetValidRegion () const

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

void	VerifyInputInformation () const override

	~ConvolutionImageFilterBase () override=default

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

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

	~ImageSource () override=default

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

virtual void	PrintSelf (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 {}

Protected Attributes inherited from itk::ImageSource< TInputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

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, TInputImage, TInputImage, double >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes inherited from itk::FFTConvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ConvolutionImageFilterBase< TInputImage, TInputImage, TInputImage >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Types inherited from itk::FFTConvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >
using	FFTFilterType = RealToHalfHermitianForwardFFTImageFilter< InternalImageType, InternalComplexImageType >

using	IFFTFilterType = HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType, InternalImageType >

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkIterativeDeconvolutionImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputImageType = TInputImage

Other useful type alias.

Definition at line 68 of file itkIterativeDeconvolutionImageFilter.h.

◆ KernelImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelImageType = TKernelImage

Definition at line 69 of file itkIterativeDeconvolutionImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputImageType = TOutputImage

Definition at line 70 of file itkIterativeDeconvolutionImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkIterativeDeconvolutionImageFilter.h.

◆ Self

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Self = IterativeDeconvolutionImageFilter

Standard type alias.

Definition at line 62 of file itkIterativeDeconvolutionImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

using itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Superclass = FFTConvolutionImageFilter<TInputImage, TKernelImage, TOutputImage, TInternalPrecision>

Definition at line 63 of file itkIterativeDeconvolutionImageFilter.h.

Constructor & Destructor Documentation

◆ IterativeDeconvolutionImageFilter()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::IterativeDeconvolutionImageFilter ( )

protected

◆ ~IterativeDeconvolutionImageFilter()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::~IterativeDeconvolutionImageFilter ( )

overrideprotected

Member Function Documentation

◆ Finish()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Finish	(	ProgressAccumulator *	progress,
		float	progressWeight
	)

protectedvirtual

Runs after iterating.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

◆ GenerateData()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GenerateData ( )

overrideprotectedvirtual

Generate the output image data. Uses a minipipeline, so ThreadedGenerateData is not overridden.

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

This filter needs the entire image kernel, which in general is going to be a different size then the output requested region. As such, this filter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetIteration()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetIteration ( ) const

virtual

Get the current iteration.

◆ GetModifiableCurrentEstimate()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual InternalImageType * itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetModifiableCurrentEstimate ( )

virtual

Set/get the current estimate.

◆ GetNameOfClass()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

const char * itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, and itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double > >.

◆ GetNumberOfIterations()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetNumberOfIterations ( )

virtual

Set/get the number of iterations.

◆ GetStopIteration()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual bool itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetStopIteration ( ) const

virtual

Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.

◆ Initialize()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Initialize	(	ProgressAccumulator *	progress,
		float	progressWeight,
		float	iterationProgressWeight
	)

protectedvirtual

Runs before iterating .

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double > >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

◆ Iteration()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Iteration	(	ProgressAccumulator *	,
		float
	)

protectedpure virtual

Performs an iteration.

Implemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >, itk::ParametricBlindLeastSquaresDeconvolutionImageFilter< TInputImage, TKernelSource, TOutputImage >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double > >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

◆ PrintSelf()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TInputImage, TInputImage, double >.

◆ SetNumberOfIterations()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

virtual void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SetNumberOfIterations ( unsigned int _arg )

virtual

Set/get the number of iterations.

◆ SetStopIteration()

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

void itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SetStopIteration ( bool stop )

inline

Stop iteration. When this method is called, the iteration will halt after the current iteration has completed.

Definition at line 93 of file itkIterativeDeconvolutionImageFilter.h.

Member Data Documentation

◆ m_CurrentEstimate

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

InternalImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_CurrentEstimate {}

protected

Intermediate results. Protected for easy access by subclasses.

Definition at line 139 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_InputMTime

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

ModifiedTimeType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_InputMTime {}

private

Modified times for the input and kernel.

Definition at line 158 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_Iteration

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_Iteration {}

private

The current iteration.

Definition at line 152 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_KernelMTime

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

ModifiedTimeType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_KernelMTime {}

private

Definition at line 159 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_NumberOfIterations

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

unsigned int itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_NumberOfIterations {}

private

Number of iterations to run.

Definition at line 149 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_StopIteration

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

bool itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_StopIteration {}

private

Flag indicating whether iteration should be stopped.

Definition at line 155 of file itkIterativeDeconvolutionImageFilter.h.

◆ m_TransferFunction

template<typename TInputImage , typename TKernelImage = TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = double>

InternalComplexImagePointerType itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_TransferFunction {}

protected

Discrete Fourier transform of the padded kernel.

Definition at line 136 of file itkIterativeDeconvolutionImageFilter.h.

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

itkIterativeDeconvolutionImageFilter.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputImageType

◆ KernelImageType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ IterativeDeconvolutionImageFilter()

◆ ~IterativeDeconvolutionImageFilter()

Member Function Documentation

◆ Finish()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetIteration()

◆ GetModifiableCurrentEstimate()

◆ GetNameOfClass()

◆ GetNumberOfIterations()

◆ GetStopIteration()

◆ Initialize()

◆ Iteration()

◆ PrintSelf()

◆ SetNumberOfIterations()

◆ SetStopIteration()

Member Data Documentation

◆ m_CurrentEstimate

◆ m_InputMTime

◆ m_Iteration

◆ m_KernelMTime

◆ m_NumberOfIterations

◆ m_StopIteration

◆ m_TransferFunction