ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::FFTWComplexToComplexImageFilter< TImage > Class Template Reference
FourierTransform | MultiThreaded Filters | Module ITKReview

#include <itkFFTWComplexToComplexImageFilter.h>

+ Inheritance diagram for itk::FFTWComplexToComplexImageFilter< TImage >:
+ Collaboration diagram for itk::FFTWComplexToComplexImageFilter< TImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef fftw::Proxy< typename
PixelType::value_type > 		FFTWProxyType
typedef ImageType::SizeType ImageSizeType
typedef TImage ImageType
typedef Superclass::InputImageType InputImageType
typedef OutputImageType::RegionType OutputImageRegionType
typedef Superclass::OutputImageType OutputImageType
typedef ImageType::PixelType PixelType
typedef SmartPointer< Self > Pointer
typedef
FFTWComplexToComplexImageFilter 		Self
typedef
FFTComplexToComplexImageFilter
< TImage > 		Superclass
- Public Types inherited from itk::FFTComplexToComplexImageFilter< TImage >
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
- 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 ::itk::LightObject::Pointer CreateAnother (void) const
virtual bool FullMatrix ()
virtual const char * GetNameOfClass () const
virtual void SetPlanRigor (const int &value)
virtual const int & GetPlanRigor ()
void SetPlanRigor (const std::string &name)
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)
- 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 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 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 ()

Static Public Attributes

static const unsigned int ImageDimension = ImageType::ImageDimension
- Static Public Attributes inherited from itk::FFTComplexToComplexImageFilter< TImage >
- 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 void BeforeThreadedGenerateData ()
 FFTWComplexToComplexImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void UpdateOutputData (DataObject *output)
virtual ~FFTWComplexToComplexImageFilter ()
- Protected Member Functions inherited from itk::FFTComplexToComplexImageFilter< TImage >
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
 FFTComplexToComplexImageFilter ()
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 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 GenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
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

 FFTWComplexToComplexImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_CanUseDestructiveAlgorithm
int m_PlanRigor

Detailed Description

template<class TImage>
class itk::FFTWComplexToComplexImageFilter< TImage >

Implements an API to enable the Fourier transform or the inverse Fourier transform of images with complex valued voxels to be computed using either FFTW from MIT or the FFTW interface in Intel MKL. This filter is multithreaded and supports input images with sizes which are not a power of two.

This code was contributed in the Insight Journal paper: "FFT Complex to Complex filters and helper classes" by Warfield S. http://hdl.handle.net/1926/326 http://www.insight-journal.org/browse/publication/128

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.
See also:
FFTWGlobalConfiguration

Definition at line 56 of file itkFFTWComplexToComplexImageFilter.h.

Member Typedef Documentation

template<class TImage >
typedef SmartPointer< const Self > itk::FFTWComplexToComplexImageFilter< TImage >::ConstPointer

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 63 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef fftw::Proxy< typename PixelType::value_type > itk::FFTWComplexToComplexImageFilter< TImage >::FFTWProxyType

Definition at line 79 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef ImageType::SizeType itk::FFTWComplexToComplexImageFilter< TImage >::ImageSizeType

Image type typedef support.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 92 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef TImage itk::FFTWComplexToComplexImageFilter< TImage >::ImageType

Standard class typedefs.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 66 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef Superclass::InputImageType itk::FFTWComplexToComplexImageFilter< TImage >::InputImageType

Some convenient typedefs.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 68 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef OutputImageType::RegionType itk::FFTWComplexToComplexImageFilter< TImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 70 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef Superclass::OutputImageType itk::FFTWComplexToComplexImageFilter< TImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 69 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef ImageType::PixelType itk::FFTWComplexToComplexImageFilter< TImage >::PixelType

Definition at line 67 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef SmartPointer< Self > itk::FFTWComplexToComplexImageFilter< TImage >::Pointer

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 62 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef FFTWComplexToComplexImageFilter itk::FFTWComplexToComplexImageFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 60 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
typedef FFTComplexToComplexImageFilter< TImage > itk::FFTWComplexToComplexImageFilter< TImage >::Superclass

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 61 of file itkFFTWComplexToComplexImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >
itk::FFTWComplexToComplexImageFilter< TImage >::FFTWComplexToComplexImageFilter ( )
inlineprotected

Definition at line 124 of file itkFFTWComplexToComplexImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigor().

template<class TImage >
virtual itk::FFTWComplexToComplexImageFilter< TImage >::~FFTWComplexToComplexImageFilter ( )
inlineprotectedvirtual

Definition at line 128 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
itk::FFTWComplexToComplexImageFilter< TImage >::FFTWComplexToComplexImageFilter ( const Self &  )
private

Member Function Documentation

template<class TImage >
virtual void itk::FFTWComplexToComplexImageFilter< TImage >::BeforeThreadedGenerateData ( void  )
protectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TImage >.

template<class TImage >
virtual::itk::LightObject::Pointer itk::FFTWComplexToComplexImageFilter< TImage >::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 TImage >
virtual bool itk::FFTWComplexToComplexImageFilter< TImage >::FullMatrix ( )
virtual

Implements itk::FFTComplexToComplexImageFilter< TImage >.

template<class TImage >
virtual const char* itk::FFTWComplexToComplexImageFilter< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

template<class TImage >
virtual const int& itk::FFTWComplexToComplexImageFilter< TImage >::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 TImage >
static Pointer itk::FFTWComplexToComplexImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

template<class TImage >
void itk::FFTWComplexToComplexImageFilter< 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::FFTComplexToComplexImageFilter< TImage >.

template<class TImage >
void itk::FFTWComplexToComplexImageFilter< TImage >::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< TImage, TImage >.

template<class TImage >
virtual void itk::FFTWComplexToComplexImageFilter< TImage >::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 106 of file itkFFTWComplexToComplexImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorName().

template<class TImage >
void itk::FFTWComplexToComplexImageFilter< TImage >::SetPlanRigor ( const std::string &  name)
inline

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 117 of file itkFFTWComplexToComplexImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorValue().

template<class TImage >
void itk::FFTWComplexToComplexImageFilter< TImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TImage >.

template<class TImage >
virtual void itk::FFTWComplexToComplexImageFilter< TImage >::UpdateOutputData ( DataObject *  output)
protectedvirtual

Actually generate new output

Reimplemented from itk::ProcessObject.

Member Data Documentation

template<class TImage >
const unsigned int itk::FFTWComplexToComplexImageFilter< TImage >::ImageDimension = ImageType::ImageDimension
static

Reimplemented from itk::FFTComplexToComplexImageFilter< TImage >.

Definition at line 89 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
bool itk::FFTWComplexToComplexImageFilter< TImage >::m_CanUseDestructiveAlgorithm
private

Definition at line 143 of file itkFFTWComplexToComplexImageFilter.h.

template<class TImage >
int itk::FFTWComplexToComplexImageFilter< TImage >::m_PlanRigor
private

Definition at line 145 of file itkFFTWComplexToComplexImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:02:53 for ITK by doxygen 1.8.1