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

#include <itkFFTWHalfHermitianToRealInverseFFTImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef fftw::Proxy
< OutputPixelType > 		FFTWProxyType
typedef TInputImage InputImageType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::SizeType InputSizeType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::RegionType OutputRegionType
typedef OutputImageType::SizeType OutputSizeType
typedef SmartPointer< Self > Pointer
typedef
FFTWHalfHermitianToRealInverseFFTImageFilter 		Self
typedef
HalfHermitianToRealInverseFFTImageFilter
< InputImageType,
OutputImageType > 		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 ()
void SetPlanRigor (const std::string &name)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension

Protected Member Functions

virtual void BeforeThreadedGenerateData ()
 FFTWHalfHermitianToRealInverseFFTImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void UpdateOutputData (DataObject *output)
virtual ~FFTWHalfHermitianToRealInverseFFTImageFilter ()

Private Member Functions

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

Private Attributes

bool m_CanUseDestructiveAlgorithm
int m_PlanRigor

Detailed Description

template<class TInputImage, class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
class itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >

FFTW-based reverse Fast Fourier Transform.

This filter computes the reverse Fourier transform of an image. The implementation is based on the FFTW library.

This filter is multithreaded and supports input images of any size.

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
InverseFFTImageFilter

Definition at line 50 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef SmartPointer< const Self > itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 66 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef fftw::Proxy< OutputPixelType > itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::FFTWProxyType

The proxy type is a wrapper for the FFTW API since the proxy is only defined over 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 73 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef TInputImage itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::InputImageType

Standard class typedefs.

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

Definition at line 55 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef InputImageType::PixelType itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::InputPixelType

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

Definition at line 56 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef InputImageType::SizeType itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 57 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef TOutputImage itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

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

Definition at line 58 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef OutputImageType::PixelType itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::OutputPixelType

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

Definition at line 59 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef OutputImageType::RegionType itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::OutputRegionType

Definition at line 60 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef OutputImageType::SizeType itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::OutputSizeType

Definition at line 61 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef SmartPointer< Self > itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 65 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef FFTWHalfHermitianToRealInverseFFTImageFilter itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 63 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef HalfHermitianToRealInverseFFTImageFilter< InputImageType, OutputImageType > itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 64 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::FFTWHalfHermitianToRealInverseFFTImageFilter ( ) [protected]
template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::~FFTWHalfHermitianToRealInverseFFTImageFilter ( ) [inline, protected, virtual]

Definition at line 111 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

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< TOutputImage >.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::FFTWHalfHermitianToRealInverseFFTImageFilter< 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< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual const char* itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual const int& itk::FFTWHalfHermitianToRealInverseFFTImageFilter< 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< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
static Pointer itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

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

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< 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::HalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< 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< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< 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 92 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorName().

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::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 103 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

References itk::FFTWGlobalConfiguration::GetPlanRigorValue().

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
void itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputRegionType &  outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

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< TOutputImage >.

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

Actually generate new output

Reimplemented from itk::ProcessObject.

Member Data Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
const unsigned int itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::ImageDimension = InputImageType::ImageDimension [static]

Define the image dimension.

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

Definition at line 83 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
bool itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::m_CanUseDestructiveAlgorithm [private]

Definition at line 126 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
int itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::m_PlanRigor [private]

Definition at line 128 of file itkFFTWHalfHermitianToRealInverseFFTImageFilter.h.

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