itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkFFTWForwardFFTImageFilter.h>

Inheritance diagram for itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<class TInputImage, class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
class itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >

FFTW-based forward Fast Fourier Transform.

This filter computes the forward Fourier transform of an image. The implementation is based on the FFTW library.

This filter is multithreaded and supports input images of any size.

In order to use this class, ITK_USE_FFTWF must be set to ON in the CMake configuration to support float images, and ITK_USE_FFTWD must set to ON to support double images.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/10380/3154 or http://insight-journal.com/browse/publication/717

Author

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See Also

FFTWGlobalConfiguration

ForwardFFTImageFilter

Definition at line 54 of file itkFFTWForwardFFTImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef fftw::Proxy < InputPixelType >	FFTWProxyType
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::SizeType	InputSizeType
typedef TOutputImage	OutputImageType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputImageType::SizeType	OutputSizeType
typedef SmartPointer< Self >	Pointer
typedef FFTWForwardFFTImageFilter	Self
typedef ForwardFFTImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ForwardFFTImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::IndexType	InputIndexType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::SizeType	InputSizeType
typedef TOutputImage	OutputImageType
typedef OutputImageType::IndexType	OutputIndexType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputIndexType::SizeType	OutputSizeType
typedef SmartPointer< Self >	Pointer
typedef ForwardFFTImageFilter	Self
typedef ImageToImageFilter < InputImageType, OutputImageType >	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 (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetPlanRigor (const int &value)
virtual const int &	GetPlanRigor ()

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ForwardFFTImageFilter< TInputImage, TOutputImage >
static Pointer	New (void)

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

Protected Member Functions
	FFTWForwardFFTImageFilter ()
virtual void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	UpdateOutputData (DataObject *output)
	~FFTWForwardFFTImageFilter ()
Protected Member Functions inherited from itk::ForwardFFTImageFilter< TInputImage, TOutputImage >
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
	ForwardFFTImageFilter ()
virtual void	GenerateInputRequestedRegion ()
virtual	~ForwardFFTImageFilter ()
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 ()
virtual void	VerifyInputInformation ()
	~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	GenerateOutputInformation ()
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 ()

Private Member Functions
	FFTWForwardFFTImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_CanUseDestructiveAlgorithm
int	m_PlanRigor

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
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

Member Typedef Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef SmartPointer< const Self > itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 69 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef fftw::Proxy< InputPixelType > itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::FFTWProxyType

The proxy type is a wrapper for the FFTW API. Because the proxy is defined only for double and float, trying to use any other pixel type is unsupported, as is trying to use double if only the float FFTW version is configured in, or float if only double is configured.

Definition at line 76 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef TInputImage itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::InputImageType

Standard class typedefs.

Definition at line 59 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef InputImageType::PixelType itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 60 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef InputImageType::SizeType itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 61 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef TOutputImage itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 62 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef OutputImageType::PixelType itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 63 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef OutputImageType::SizeType itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::OutputSizeType

Definition at line 64 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef SmartPointer< Self > itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 68 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef FFTWForwardFFTImageFilter itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::Self

Definition at line 66 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

typedef ForwardFFTImageFilter< TInputImage, TOutputImage > itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 67 of file itkFFTWForwardFFTImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::FFTWForwardFFTImageFilter ( )

protected

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::~FFTWForwardFFTImageFilter ( )

inlineprotected

Definition at line 111 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::FFTWForwardFFTImageFilter ( const Self &  )

private

Member Function Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual::itk::LightObject::Pointer itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) 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.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual void itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::GenerateData ( )

protectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See Also

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual const char* itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual const int& itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::GetPlanRigor ( )

virtual

Set/Get the behavior of wisdom plan creation. The default is provided by FFTWGlobalConfiguration::GetPlanRigor().

The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.

/sa FFTWGlobalConfiguration

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

static Pointer itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

void itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

private

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

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

protectedvirtual

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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual void itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor ( const int &  value )

inlinevirtual

Set/Get the behavior of wisdom plan creation. The default is provided by FFTWGlobalConfiguration::GetPlanRigor().

The parameter is one of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE provided by FFTWGlobalConfiguration.

/sa FFTWGlobalConfiguration

Definition at line 96 of file itkFFTWForwardFFTImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorName().

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

virtual void itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::UpdateOutputData ( DataObject *  output )

protectedvirtual

Actually generate new output

Reimplemented from itk::ProcessObject.

Member Data Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

const unsigned int itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::ImageDimension = InputImageType::ImageDimension

static

Define the image dimension.

Definition at line 86 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

bool itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::m_CanUseDestructiveAlgorithm

private

Definition at line 123 of file itkFFTWForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>

int itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::m_PlanRigor

private

Definition at line 125 of file itkFFTWForwardFFTImageFilter.h.

---

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

• itkFFTWForwardFFTImageFilter.h