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

#include <itkForwardFFTImageFilter.h>

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

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

List of all members.

Public Types
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 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< TOutputImage >
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

Static Public Member Functions
static Pointer	New (void)

Protected Member Functions
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	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< TOutputImage >
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	GenerateOutputInformation ()
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
	ForwardFFTImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual const char *	GetNameOfClass () 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 TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
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 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 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 >
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

---

Detailed Description

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

Base class for forward Fast Fourier Transform.

This is a base class for the "forward" or "direct" discrete Fourier Transform. This is an abstract base class: the actual implementation is provided by the best child class available on the system when the object is created via the object factory system.

This class transforms a real input image into its full complex Fourier transform. The Fourier transform of a real input image has Hermitian symmetry: . That is, when the result of the transform is split in half along the x-dimension, the values in the second half of the transform are the complex conjugates of values in the first half reflected about the center of the image in each dimension.

This filter works only for real single-component input image types.

See also:

InverseFFTImageFilter, FFTComplexToComplexImageFilter

Definition at line 50 of file itkForwardFFTImageFilter.h.

---

Member Typedef Documentation

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

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

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 67 of file itkForwardFFTImageFilter.h.

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

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

Standard class typedefs.

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 55 of file itkForwardFFTImageFilter.h.

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

typedef InputImageType::IndexType itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::InputIndexType

Definition at line 57 of file itkForwardFFTImageFilter.h.

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

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 56 of file itkForwardFFTImageFilter.h.

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

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 58 of file itkForwardFFTImageFilter.h.

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

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 59 of file itkForwardFFTImageFilter.h.

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

typedef OutputImageType::IndexType itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::OutputIndexType

Definition at line 61 of file itkForwardFFTImageFilter.h.

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

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 60 of file itkForwardFFTImageFilter.h.

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

typedef OutputIndexType::SizeType itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::OutputSizeType

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkForwardFFTImageFilter.h.

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

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

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 66 of file itkForwardFFTImageFilter.h.

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

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

Standard class typedefs.

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 64 of file itkForwardFFTImageFilter.h.

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

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::Superclass

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

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

Definition at line 65 of file itkForwardFFTImageFilter.h.

---

Constructor & Destructor Documentation

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

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

inlineprotected

Definition at line 76 of file itkForwardFFTImageFilter.h.

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

virtual itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::~ForwardFFTImageFilter ( )

inlineprotectedvirtual

Definition at line 77 of file itkForwardFFTImageFilter.h.

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

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

private

---

Member Function Documentation

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

virtual void itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  output )

protectedvirtual

This class produces the entire output.

Reimplemented from itk::ProcessObject.

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

virtual void itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

protectedvirtual

This class requires the entire input.

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

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

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

static

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

Default implementation is VnlFFT.

Reimplemented from itk::Object.

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

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

void itk::ForwardFFTImageFilter< TInputImage, TOutputImage >::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< TInputImage, TOutputImage >.

Reimplemented in itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, and itk::VnlForwardFFTImageFilter< TInputImage, TOutputImage >.

---

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

• itkForwardFFTImageFilter.h