#include <itkFFTComplexToComplexImageFilter.h>

Inheritance diagram for itk::FFTComplexToComplexImageFilter< TImage >:

Collaboration diagram for itk::FFTComplexToComplexImageFilter< TImage >:

Detailed Description

template<typename TImage>
class itk::FFTComplexToComplexImageFilter< TImage >

Implements an API to enable the Fourier transform or the inverse Fourier transform of images with complex valued voxels to be computed.

Author: Simon K. Warfield simon.nosp@m..war.nosp@m.field.nosp@m.@chi.nosp@m.ldren.nosp@m.s.ha.nosp@m.rvard.nosp@m..edu

Note: Attribution Notice. This research work was made possible by Grant Number R01 RR021885 (PI Simon K. Warfield, Ph.D.) from the National Center for Research Resources (NCRR), a component of the National Institutes of Health (NIH). Its contents are solely the responsibility of the authors and do not necessarily represent the official view of NCRR or NIH.

This class was taken from the Insight Journal paper: http://hdl.handle.net/1926/326

See Also: ForwardFFTImageFilter

Definition at line 51 of file itkFFTComplexToComplexImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef ImageType::SizeType	ImageSizeType

typedef TImage	ImageType

typedef TImage	InputImageType

typedef TImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef FFTComplexToComplexImageFilter	Self

typedef ImageToImageFilter < InputImageType, OutputImageType >	Superclass

enum	TransformDirectionType { DIRECT = 1, INVERSE }

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

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TImage >	Superclass

Public Types inherited from itk::ImageSource< TImage >
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 TImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

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

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const char *	GetNameOfClass () const


virtual void	SetTransformDirection (TransformDirectionType _arg)

virtual TransformDirectionType	GetTransformDirection () const

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

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TImage *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< TImage >
OutputImageType *	GetOutput (unsigned int idx)

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

virtual void	GraftOutput (DataObject *output)

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

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

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

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

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 LightObject::Pointer	CreateAnother () const ITK_OVERRIDE

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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

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 = InputImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImage >
static const unsigned int	OutputImageDimension

Protected Member Functions
	FFTComplexToComplexImageFilter ()

virtual bool	FullMatrix ()=0

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual	~FFTComplexToComplexImageFilter ()

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

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

	ImageToImageFilter ()

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

virtual void	VerifyInputInformation ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	GenerateData () ITK_OVERRIDE

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) 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)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

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

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
	FFTComplexToComplexImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
TransformDirectionType	m_TransformDirection

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

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

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Static Protected Member Functions inherited from itk::ImageSource< TImage >
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
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TImage >

typedef SmartPointer< const Self > itk::FFTComplexToComplexImageFilter< TImage >::ConstPointer

Definition at line 64 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef ImageType::SizeType itk::FFTComplexToComplexImageFilter< TImage >::ImageSizeType

Image type typedef support.

Definition at line 86 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef TImage itk::FFTComplexToComplexImageFilter< TImage >::ImageType

Input and output image types.

Definition at line 56 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef TImage itk::FFTComplexToComplexImageFilter< TImage >::InputImageType

Definition at line 57 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef TImage itk::FFTComplexToComplexImageFilter< TImage >::OutputImageType

Definition at line 58 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef SmartPointer< Self > itk::FFTComplexToComplexImageFilter< TImage >::Pointer

Definition at line 63 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef FFTComplexToComplexImageFilter itk::FFTComplexToComplexImageFilter< TImage >::Self

Standard class typedefs.

Definition at line 61 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::FFTComplexToComplexImageFilter< TImage >::Superclass

Definition at line 62 of file itkFFTComplexToComplexImageFilter.h.

Member Enumeration Documentation

template<typename TImage >

enum itk::FFTComplexToComplexImageFilter::TransformDirectionType

Transform Direction

Enumerator
DIRECT
INVERSE

Definition at line 80 of file itkFFTComplexToComplexImageFilter.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::FFTComplexToComplexImageFilter< TImage >::FFTComplexToComplexImageFilter ( )

inlineprotected

Definition at line 97 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

virtual itk::FFTComplexToComplexImageFilter< TImage >::~FFTComplexToComplexImageFilter ( )

inlineprotectedvirtual

Definition at line 98 of file itkFFTComplexToComplexImageFilter.h.

template<typename TImage >

itk::FFTComplexToComplexImageFilter< TImage >::FFTComplexToComplexImageFilter ( const Self & )

private

Member Function Documentation

template<typename TImage >

virtual bool itk::FFTComplexToComplexImageFilter< TImage >::FullMatrix ( )

protectedpure virtual

Implemented in itk::FFTWComplexToComplexImageFilter< TImage >.

template<typename TImage >

virtual void itk::FFTComplexToComplexImageFilter< TImage >::GenerateInputRequestedRegion ( void )

protectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<typename TImage >

virtual void itk::FFTComplexToComplexImageFilter< TImage >::GenerateOutputInformation ( )

protectedvirtual

methods needed for the image filter pipeline

Reimplemented from itk::ProcessObject.

template<typename TImage >

virtual const char* itk::FFTComplexToComplexImageFilter< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

template<typename TImage >

virtual TransformDirectionType itk::FFTComplexToComplexImageFilter< TImage >::GetTransformDirection ( ) const

virtual

Set/Get the direction in which the transform will be applied. By selecting DIRECT, this filter will perform a direct Fourier Transform, By selecting INVERSE, this filter will perform an inverse Fourier Transform,

template<typename TImage >

static Pointer itk::FFTComplexToComplexImageFilter< TImage >::New ( void )

static

Customized object creation methods that support configuration-based selection of FFT implementation.

Default implementation is FFTW.

template<typename TImage >

void itk::FFTComplexToComplexImageFilter< TImage >::operator= ( const Self & )

private

template<typename TImage >

virtual void itk::FFTComplexToComplexImageFilter< TImage >::SetTransformDirection ( TransformDirectionType _arg )

virtual

Set/Get the direction in which the transform will be applied. By selecting DIRECT, this filter will perform a direct Fourier Transform, By selecting INVERSE, this filter will perform an inverse Fourier Transform,