ITK  4.1.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::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage > Class Template Reference
FourierTransform | MultiThreaded Filters | Module ITKFFT

#include <itkFFTWRealToHalfHermitianForwardFFTImageFilter.h>

+ Inheritance diagram for itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >:

List of all members.

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
FFTWRealToHalfHermitianForwardFFTImageFilter 		Self
typedef
RealToHalfHermitianForwardFFTImageFilter
< TInputImage, TOutputImage > 		Superclass

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 Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension

Protected Member Functions

 FFTWRealToHalfHermitianForwardFFTImageFilter ()
virtual void GenerateData ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void UpdateOutputData (DataObject *output)
 ~FFTWRealToHalfHermitianForwardFFTImageFilter ()

Private Member Functions

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

Private Attributes

bool m_CanUseDestructiveAlgorithm
int m_PlanRigor

Detailed Description

template<class TInputImage, class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
class itk::FFTWRealToHalfHermitianForwardFFTImageFilter< 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, USE_FFTWF must be set to ON in the CMake configuration to support float images, and 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
RealToHalfHermitianForwardFFTImageFilter

Definition at line 54 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef SmartPointer< const Self > itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 69 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef fftw::Proxy< InputPixelType > itk::FFTWRealToHalfHermitianForwardFFTImageFilter< 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 itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

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

Standard class typedefs.

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

Definition at line 59 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef InputImageType::PixelType itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::InputPixelType

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

Definition at line 60 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef InputImageType::SizeType itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::InputSizeType

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

Definition at line 61 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

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

Some convenient typedefs.

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

Definition at line 62 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef OutputImageType::PixelType itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::OutputPixelType

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

Definition at line 63 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef OutputImageType::SizeType itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::OutputSizeType

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

Definition at line 64 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef SmartPointer< Self > itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 68 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

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

Standard class typedefs.

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

Definition at line 66 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
typedef RealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage > itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 67 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::FFTWRealToHalfHermitianForwardFFTImageFilter ( ) [protected]
template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::~FFTWRealToHalfHermitianForwardFFTImageFilter ( ) [inline, protected]

Definition at line 111 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::FFTWRealToHalfHermitianForwardFFTImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::FFTWRealToHalfHermitianForwardFFTImageFilter< 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::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

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::FFTWRealToHalfHermitianForwardFFTImageFilter< 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::FFTWRealToHalfHermitianForwardFFTImageFilter< 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::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

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

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
void itk::FFTWRealToHalfHermitianForwardFFTImageFilter< 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::RealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
void itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor ( const int &  value) [inline, 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

Definition at line 96 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorName().

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
virtual void itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::UpdateOutputData ( DataObject *  output) [protected, virtual]

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::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::ImageDimension = InputImageType::ImageDimension [static]

Define the image dimension.

Definition at line 86 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
bool itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::m_CanUseDestructiveAlgorithm [private]

Definition at line 123 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< std::complex<typename TInputImage::PixelType>, TInputImage::ImageDimension>>
int itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::m_PlanRigor [private]

Definition at line 125 of file itkFFTWRealToHalfHermitianForwardFFTImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 00:06:43 for ITK by doxygen 1.7.6.1