itk::FFTComplexToComplexImageFilter< TImage > Class Template Reference

#include <itkFFTComplexToComplexImageFilter.h>

Inheritance diagram for itk::FFTComplexToComplexImageFilter< TImage >:

Collaboration diagram for itk::FFTComplexToComplexImageFilter< TImage >:

List of all members.

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 InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageSource< TImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::Pointer	OutputImagePointer
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual const char *	GetNameOfClass () 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)
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)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New (void)

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 >

Protected Member Functions
virtual bool	FullMatrix ()=0
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
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 ()
	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)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) 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 (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) 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
virtual void	SetTransformDirection (TransformDirectionType _arg)
virtual TransformDirectionType	GetTransformDirection () const
	FFTComplexToComplexImageFilter ()
virtual	~FFTComplexToComplexImageFilter ()

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

---

Detailed Description

template<class 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.

---

Member Typedef Documentation

template<class TImage >

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

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 64 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

Image type typedef support.

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 86 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

Input and output image types.

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 56 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

Some convenient typedefs.

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 57 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TImage >.

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 58 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 63 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

Standard class typedefs.

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 61 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 62 of file itkFFTComplexToComplexImageFilter.h.

---

Member Enumeration Documentation

template<class TImage >

enum itk::FFTComplexToComplexImageFilter::TransformDirectionType

Transform Direction

Enumerator:

DIRECT
INVERSE

Definition at line 80 of file itkFFTComplexToComplexImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage >

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

inlineprotected

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,

Definition at line 95 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

inlineprotectedvirtual

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,

Definition at line 96 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

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

private

---

Member Function Documentation

template<class TImage >

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

protectedpure virtual

Implemented in itk::FFTWComplexToComplexImageFilter< TImage >.

template<class 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<class TImage >

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

protectedvirtual

methods needed for the image filter pipeline

Reimplemented from itk::ProcessObject.

template<class 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<class 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<class 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.

Reimplemented from itk::Object.

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

template<class TImage >

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

private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

template<class 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,

---

Member Data Documentation

template<class TImage >

const unsigned int itk::FFTComplexToComplexImageFilter< TImage >::ImageDimension = InputImageType::ImageDimension

static

Reimplemented in itk::FFTWComplexToComplexImageFilter< TImage >.

Definition at line 67 of file itkFFTComplexToComplexImageFilter.h.

template<class TImage >

TransformDirectionType itk::FFTComplexToComplexImageFilter< TImage >::m_TransformDirection

private

Definition at line 111 of file itkFFTComplexToComplexImageFilter.h.

---

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

• itkFFTComplexToComplexImageFilter.h