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::FFTWInverseFFTImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkFFTWInverseFFTImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef fftw::Proxy
< OutputPixelType
FFTWProxyType
typedef TInputImage InputImageType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::SizeType InputSizeType
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::SizeType OutputSizeType
typedef SmartPointer< SelfPointer
typedef FFTWInverseFFTImageFilter Self
typedef InverseFFTImageFilter
< InputImageType,
OutputImageType
Superclass
- Public Types inherited from itk::InverseFFTImageFilter< TInputImage, TOutputImage >
- 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
- 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

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
- Static Public Attributes inherited from itk::InverseFFTImageFilter< TInputImage, TOutputImage >
- 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 Member Functions

virtual void BeforeThreadedGenerateData ()
 FFTWInverseFFTImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~FFTWInverseFFTImageFilter ()
- Protected Member Functions inherited from itk::InverseFFTImageFilter< TInputImage, TOutputImage >
void EnlargeOutputRequestedRegion (DataObject *)
virtual void GenerateInputRequestedRegion ()
 InverseFFTImageFilter ()
virtual ~InverseFFTImageFilter ()
- 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 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 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 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 ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () 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

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

Private Attributes

int m_PlanRigor

Detailed Description

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

FFTW-based inverse Fast Fourier Transform.

This filter computes the inverse 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

Definition at line 49 of file itkFFTWInverseFFTImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef SmartPointer< const Self > itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
typedef fftw::Proxy< OutputPixelType > itk::FFTWInverseFFTImageFilter< 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 71 of file itkFFTWInverseFFTImageFilter.h.

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

Standard class typedefs.

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

Definition at line 54 of file itkFFTWInverseFFTImageFilter.h.

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

Definition at line 56 of file itkFFTWInverseFFTImageFilter.h.

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

Superclass typedefs.

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

Definition at line 73 of file itkFFTWInverseFFTImageFilter.h.

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

Some convenient typedefs.

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

Definition at line 57 of file itkFFTWInverseFFTImageFilter.h.

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

Definition at line 59 of file itkFFTWInverseFFTImageFilter.h.

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

Standard class typedefs.

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

Definition at line 61 of file itkFFTWInverseFFTImageFilter.h.

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

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::FFTWInverseFFTImageFilter ( )
protected
template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::~FFTWInverseFFTImageFilter ( )
inlineprotectedvirtual

Definition at line 111 of file itkFFTWInverseFFTImageFilter.h.

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

Member Function Documentation

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

template<class TInputImage , class TOutputImage = Image< typename TInputImage::PixelType::value_type, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::FFTWInverseFFTImageFilter< 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::FFTWInverseFFTImageFilter< 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::FFTWInverseFFTImageFilter< 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::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

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

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

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

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

References itk::FFTWGlobalConfiguration::GetPlanRigorName().

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

References itk::FFTWGlobalConfiguration::GetPlanRigorValue().

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


Member Data Documentation

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

Define the image dimension.

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

Definition at line 83 of file itkFFTWInverseFFTImageFilter.h.

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

Definition at line 123 of file itkFFTWInverseFFTImageFilter.h.


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