ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Private Member Functions
itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > Class Template Reference

#include <itkFFTConvolutionImageFilter.h>

+ Inheritance diagram for itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >:
+ Collaboration diagram for itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >:

List of all members.

Public Types

typedef
Superclass::BoundaryConditionPointerType 
BoundaryConditionPointerType
typedef
Superclass::BoundaryConditionType 
BoundaryConditionType
typedef SmartPointer< const SelfConstPointer
typedef TInputImage InputImageType
typedef InputImageType::IndexType InputIndexType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::RegionType InputRegionType
typedef InputImageType::SizeType InputSizeType
typedef
InternalComplexImageType::Pointer 
InternalComplexImagePointerType
typedef Image
< InternalComplexType,
TInputImage::ImageDimension > 
InternalComplexImageType
typedef std::complex
< TInternalPrecision > 
InternalComplexType
typedef InternalImageType::Pointer InternalImagePointerType
typedef Image
< TInternalPrecision,
TInputImage::ImageDimension > 
InternalImageType
typedef TKernelImage KernelImageType
typedef KernelImageType::IndexType KernelIndexType
typedef KernelImageType::PixelType KernelPixelType
typedef KernelImageType::RegionType KernelRegionType
typedef KernelImageType::SizeType KernelSizeType
typedef TOutputImage OutputImageType
typedef OutputImageType::IndexType OutputIndexType
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::RegionType OutputRegionType
typedef OutputImageType::SizeType OutputSizeType
typedef SmartPointer< SelfPointer
typedef FFTConvolutionImageFilter Self
typedef
InputSizeType::SizeValueType 
SizeValueType
typedef
ConvolutionImageFilterBase
< TInputImage, TKernelImage,
TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension

Protected Types

typedef
RealToHalfHermitianForwardFFTImageFilter
< InternalImageType,
InternalComplexImageType
FFTFilterType
typedef
HalfHermitianToRealInverseFFTImageFilter
< InternalComplexImageType,
InternalImageType
IFFTFilterType

Protected Member Functions

void CropOutput (InternalImageType *paddedOutput, ProgressAccumulator *progress, float progressWeight)
 FFTConvolutionImageFilter ()
void GenerateData ()
void GenerateInputRequestedRegion ()
InputSizeType GetPadLowerBound () const
InputSizeType GetPadSize () const
bool GetXDimensionIsOdd () const
void PadInput (const InputImageType *input, InternalImagePointerType &paddedInput, ProgressAccumulator *progress, float progressWeight)
void PrepareInput (const InputImageType *input, InternalComplexImagePointerType &preparedInput, ProgressAccumulator *progress, float progressWeight)
void PrepareInputs (const InputImageType *input, const KernelImageType *kernel, InternalComplexImagePointerType &preparedInput, InternalComplexImagePointerType &preparedKernel, ProgressAccumulator *progress, float progressWeight)
void PrepareKernel (const KernelImageType *kernel, InternalComplexImagePointerType &preparedKernel, ProgressAccumulator *progress, float progressWeight)
void ProduceOutput (InternalComplexImageType *paddedOutput, ProgressAccumulator *progress, float progressWeight)
void TransformPaddedInput (const InternalImageType *paddedInput, InternalComplexImagePointerType &transformedInput, ProgressAccumulator *progress, float progressWeight)
 ~FFTConvolutionImageFilter ()

Private Member Functions

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

Detailed Description

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
class itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >

Convolve a given image with an arbitrary image kernel using multiplication in the Fourier domain.

This filter produces output equivalent to the output of the ConvolutionImageFilter. However, it takes advantage of the convolution theorem to accelerate the convolution computation when the kernel is large.

Warning:
This filter ignores the spacing, origin, and orientation of the kernel image and treats them as identical to those in the input image.

This code was adapted from the Insight Journal contribution:

"FFT Based Convolution" by Gaetan Lehmann http://hdl.handle.net/10380/3154

See also:
ConvolutionImageFilter

Definition at line 54 of file itkFFTConvolutionImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef Superclass::BoundaryConditionPointerType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::BoundaryConditionPointerType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef Superclass::BoundaryConditionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::BoundaryConditionType

Typedef to describe the boundary condition.

Reimplemented from itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >.

Definition at line 102 of file itkFFTConvolutionImageFilter.h.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef SmartPointer< const Self > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ConstPointer
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef RealToHalfHermitianForwardFFTImageFilter< InternalImageType, InternalComplexImageType > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::FFTFilterType [protected]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef HalfHermitianToRealInverseFFTImageFilter< InternalComplexImageType, InternalImageType > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::IFFTFilterType [protected]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef TInputImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputImageType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InputImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputIndexType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InputImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputPixelType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InputImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputRegionType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InputImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InputSizeType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InternalComplexImageType::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImagePointerType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef Image< InternalComplexType, TInputImage::ImageDimension > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexImageType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef std::complex< TInternalPrecision > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalComplexType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InternalImageType::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImagePointerType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef Image< TInternalPrecision, TInputImage::ImageDimension > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::InternalImageType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef TKernelImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelImageType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef KernelImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelIndexType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef KernelImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelPixelType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef KernelImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelRegionType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef KernelImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::KernelSizeType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef TOutputImage itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputImageType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef OutputImageType::IndexType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputIndexType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef OutputImageType::PixelType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputPixelType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef OutputImageType::RegionType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputRegionType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef OutputImageType::SizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::OutputSizeType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef SmartPointer< Self > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Pointer
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef FFTConvolutionImageFilter itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Self
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef InputSizeType::SizeValueType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::SizeValueType
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
typedef ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::Superclass

Constructor & Destructor Documentation

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::FFTConvolutionImageFilter ( ) [protected]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::~FFTConvolutionImageFilter ( ) [inline, protected]

Definition at line 107 of file itkFFTConvolutionImageFilter.h.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::FFTConvolutionImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
virtual::itk::LightObject::Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::CreateAnother ( void  ) const [virtual]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::CropOutput ( InternalImageType paddedOutput,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Crop the padded version of the output.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GenerateData ( ) [protected, virtual]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GenerateInputRequestedRegion ( ) [protected, virtual]

FFTConvolutionImageFilter needs the entire image kernel, which in general is going to be a different size than the output requested region. As such, this filter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ProcessObject::GenerateInputRequestedRegion()

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

Reimplemented in itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
virtual const char* itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetNameOfClass ( ) const [virtual]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
InputSizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetPadLowerBound ( ) const [protected]

Get the lower bound for the padding of both the kernel and input images. Assuming that the regions of the kernel and input are the same, then this lower bound can be used to move the index of the padded kernel and padded input so that they are the same. This is important to avoid exceptions in filters that operate on these images.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
InputSizeType itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetPadSize ( ) const [protected]

Get the pad size.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
bool itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::GetXDimensionIsOdd ( ) const [protected]

Get whether the X dimension has an odd size.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
static Pointer itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::New ( ) [static]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::operator= ( const Self ) [private]
template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PadInput ( const InputImageType input,
InternalImagePointerType paddedInput,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Pad the input image.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareInput ( const InputImageType input,
InternalComplexImagePointerType preparedInput,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Prepare the input image. This includes padding the image and taking the Fourier transform of the padded image.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareInputs ( const InputImageType input,
const KernelImageType kernel,
InternalComplexImagePointerType preparedInput,
InternalComplexImagePointerType preparedKernel,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Prepare the input images for operations in the Fourier domain. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded inputs.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::PrepareKernel ( const KernelImageType kernel,
InternalComplexImagePointerType preparedKernel,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Prepare the kernel. This includes resizing the input and kernel images, normalizing the kernel if requested, shifting the kernel, and taking the Fourier transform of the padded kernel.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ProduceOutput ( InternalComplexImageType paddedOutput,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Produce output from the final Fourier domain image.

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
void itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::TransformPaddedInput ( const InternalImageType paddedInput,
InternalComplexImagePointerType transformedInput,
ProgressAccumulator progress,
float  progressWeight 
) [protected]

Take the Fourier transform of the padded input.


Member Data Documentation

template<class TInputImage, class TKernelImage = TInputImage, class TOutputImage = TInputImage, class TInternalPrecision = double>
const unsigned int itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >::ImageDimension = TInputImage::ImageDimension [static]

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