#include <itkFFTConvolutionImageFilter.h>

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

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

Detailed Description

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

Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain.

This filter produces output equivalent to the output of the ConvolutionImageFilter. However, it takes advantage of the convolution theorem to accelerate the convolution computation when the kernel is large.

Warning: This filter ignores the spacing, origin, and orientation of the kernel image and treats them as identical to those in the input image.

This code was adapted from the Insight Journal contribution:

"FFT Based Convolution" by Gaetan Lehmann http://hdl.handle.net/10380/3154

See Also: ConvolutionImageFilter

Definition at line 54 of file itkFFTConvolutionImageFilter.h.

Public Types
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 ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

virtual SizeValueType	GetSizeGreatestPrimeFactor ()

virtual void	SetSizeGreatestPrimeFactor (SizeValueType _arg)

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

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

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 (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

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

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

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

const MetaDataDictionary &	GetMetaDataDictionary () 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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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

Static Public Member Functions
static Pointer	New ()

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension

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

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
typedef RealToHalfHermitianForwardFFTImageFilter < InternalImageType, InternalComplexImageType >	FFTFilterType

typedef HalfHermitianToRealInverseFFTImageFilter < InternalComplexImageType, InternalImageType >	IFFTFilterType

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Member Functions
void	CropOutput (InternalImageType paddedOutput, ProgressAccumulator progress, float progressWeight)

	FFTConvolutionImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

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)

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

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

void	GenerateOutputInformation () override

OutputRegionType	GetValidRegion () const

virtual void	VerifyInputInformation () override

	~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) override

void	PushFrontInput (const DataObject *input) override

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, 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)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

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

	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)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

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	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

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

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

Private Member Functions
	FFTConvolutionImageFilter (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
SizeValueType	m_SizeGreatestPrimeFactor

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

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

typedef Superclass::BoundaryConditionPointerType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::BoundaryConditionPointerType

Definition at line 103 of file itkFFTConvolutionImageFilter.h.

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

typedef Superclass::BoundaryConditionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::BoundaryConditionType

Typedef to describe the boundary condition.

Definition at line 102 of file itkFFTConvolutionImageFilter.h.

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

typedef SmartPointer< const Self > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ConstPointer

Definition at line 65 of file itkFFTConvolutionImageFilter.h.

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

typedef RealToHalfHermitianForwardFFTImageFilter< InternalImageType, InternalComplexImageType > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::FFTFilterType

protected

Because the inputs are real, we can use the specialized filters for real-to-complex Fourier transforms.

Definition at line 116 of file itkFFTConvolutionImageFilter.h.

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

typedef HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType, InternalImageType > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::IFFTFilterType

protected

Definition at line 119 of file itkFFTConvolutionImageFilter.h.

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

typedef TInputImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputImageType

Definition at line 77 of file itkFFTConvolutionImageFilter.h.

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

typedef InputImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputIndexType

Definition at line 83 of file itkFFTConvolutionImageFilter.h.

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

typedef InputImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputPixelType

Definition at line 80 of file itkFFTConvolutionImageFilter.h.

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

typedef InputImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputRegionType

Definition at line 90 of file itkFFTConvolutionImageFilter.h.

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

typedef InputImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputSizeType

Definition at line 86 of file itkFFTConvolutionImageFilter.h.

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

typedef InternalComplexImageType::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImagePointerType

Definition at line 99 of file itkFFTConvolutionImageFilter.h.

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

typedef Image< InternalComplexType, TInputImage::ImageDimension > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImageType

Definition at line 98 of file itkFFTConvolutionImageFilter.h.

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

typedef std::complex< TInternalPrecision > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexType

Definition at line 97 of file itkFFTConvolutionImageFilter.h.

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

typedef InternalImageType::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImagePointerType

Definition at line 96 of file itkFFTConvolutionImageFilter.h.

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

typedef Image< TInternalPrecision, TInputImage::ImageDimension > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImageType

Internal types used by the FFT filters.

Definition at line 95 of file itkFFTConvolutionImageFilter.h.

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

typedef TKernelImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelImageType

Definition at line 79 of file itkFFTConvolutionImageFilter.h.

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

typedef KernelImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelIndexType

Definition at line 85 of file itkFFTConvolutionImageFilter.h.

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

typedef KernelImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelPixelType

Definition at line 82 of file itkFFTConvolutionImageFilter.h.

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

typedef KernelImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelRegionType

Definition at line 92 of file itkFFTConvolutionImageFilter.h.

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

typedef KernelImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelSizeType

Definition at line 88 of file itkFFTConvolutionImageFilter.h.

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

typedef TOutputImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputImageType

Definition at line 78 of file itkFFTConvolutionImageFilter.h.

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

typedef OutputImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputIndexType

Definition at line 84 of file itkFFTConvolutionImageFilter.h.

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

typedef OutputImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputPixelType

Definition at line 81 of file itkFFTConvolutionImageFilter.h.

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

typedef OutputImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputRegionType

Definition at line 91 of file itkFFTConvolutionImageFilter.h.

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

typedef OutputImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputSizeType

Definition at line 87 of file itkFFTConvolutionImageFilter.h.

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

typedef SmartPointer< Self > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Pointer

Definition at line 64 of file itkFFTConvolutionImageFilter.h.

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

typedef FFTConvolutionImageFilter itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Self

Definition at line 59 of file itkFFTConvolutionImageFilter.h.

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

typedef InputSizeType::SizeValueType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SizeValueType

Definition at line 89 of file itkFFTConvolutionImageFilter.h.

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

typedef ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Superclass

Definition at line 63 of file itkFFTConvolutionImageFilter.h.

Constructor & Destructor Documentation

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

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

protected

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

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

inlineprotected

Definition at line 110 of file itkFFTConvolutionImageFilter.h.

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

itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::FFTConvolutionImageFilter ( const Self & )

private

Member Function Documentation

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

virtual::itk::LightObject::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ProjectedLandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >, and itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::CropOutput	(	InternalImageType *	paddedOutput,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Crop the padded version of the output.

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

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

overrideprotectedvirtual

This filter uses a minipipeline to compute the output.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

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

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

overrideprotectedvirtual

FFTConvolutionImageFilter needs the entire image kernel, which in general is going to be a different size than 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::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >.

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

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

virtual

Run-time type information ( and related methods )

Reimplemented from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >.

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

InputSizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetPadLowerBound ( ) const

protected

Get the lower bound for the padding of both the kernel and input images. Assuming that the regions of the kernel and input are the same, then this lower bound can be used to move the index of the padded kernel and padded input so that they are the same. This is important to avoid exceptions in filters that operate on these images.

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

InputSizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetPadSize ( ) const

protected

Get the pad size.

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

virtual SizeValueType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetSizeGreatestPrimeFactor ( )

virtual

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

bool itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetXDimensionIsOdd ( ) const

protected

Get whether the X dimension has an odd size.

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

static Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::New ( )

static

Method for creation through the object factory.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::operator= ( const Self & )

private

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PadInput	(	const InputImageType *	input,
		InternalImagePointerType &	paddedInput,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Pad the input image.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareInput	(	const InputImageType *	input,
		InternalComplexImagePointerType &	preparedInput,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Prepare the input image. This includes padding the image and taking the Fourier transform of the padded image.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareInputs	(	const InputImageType *	input,
		const KernelImageType *	kernel,
		InternalComplexImagePointerType &	preparedInput,
		InternalComplexImagePointerType &	preparedKernel,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Prepare the input images for operations in the Fourier domain. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded inputs.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareKernel	(	const KernelImageType *	kernel,
		InternalComplexImagePointerType &	preparedKernel,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Prepare the kernel. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded kernel.

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

virtual void itk::FFTConvolutionImageFilter< 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::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >.

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ProduceOutput	(	InternalComplexImageType *	paddedOutput,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Produce output from the final Fourier domain image.

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

virtual void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SetSizeGreatestPrimeFactor ( SizeValueType _arg )

virtual

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

void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::TransformPaddedInput	(	const InternalImageType *	paddedInput,
		InternalComplexImagePointerType &	transformedInput,
		ProgressAccumulator *	progress,
		float	progressWeight
	)

protected

Take the Fourier transform of the padded input.

Member Data Documentation

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

const unsigned int itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ImageDimension = TInputImage::ImageDimension

static

Dimensionality of input and output data is assumed to be the same.

Definition at line 75 of file itkFFTConvolutionImageFilter.h.

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

SizeValueType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::m_SizeGreatestPrimeFactor

private

Definition at line 196 of file itkFFTConvolutionImageFilter.h.

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

itkFFTConvolutionImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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