itkFFTWComplexToComplexImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFFTWComplexToComplexImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-07-03 18:41:16 $
  Version:   $Revision: 1.2 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef __itkFFTWComplexToComplexImageFilter_h
#define __itkFFTWComplexToComplexImageFilter_h

#if defined(USE_FFTWF) || defined(USE_FFTWD)

#include "itkFFTComplexToComplexImageFilter.h"
#include "fftw3.h"

namespace itk
{
template <typename TPixel,unsigned int NDimension = 3 >
class FFTWComplexToComplexImageFilter:
    public FFTComplexToComplexImageFilter< TPixel, NDimension >
{
//#error Invalid Type Listed for TPixel
};

template <unsigned int NDimension>
class FFTWComplexToComplexImageFilter<float,NDimension>:
    public FFTComplexToComplexImageFilter<float,NDimension>
{
// TODO:  There should be compile time type checks so that
//        if only USE_FFTWF is defined, then only floats are valid.
//        and if USE_FFTWD is defined, then only doubles are valid.
public:
  typedef float                                       TPixel;
  typedef FFTWComplexToComplexImageFilter             Self;
  typedef FFTComplexToComplexImageFilter<
    TPixel,NDimension>                                Superclass;
  typedef SmartPointer<Self>                          Pointer;
  typedef SmartPointer<const Self>                    ConstPointer;

  typedef typename Superclass::InputImageType         InputImageType;
  typedef typename Superclass::OutputImageType        OutputImageType;

  itkNewMacro(Self);

  itkTypeMacro(FFTWComplexToComplexImageFilter,
               FFTComplexToComplexImageFilter);

  typedef InputImageType                          ImageType;
  typedef typename ImageType::SizeType            ImageSizeType;


protected:

  FFTWComplexToComplexImageFilter()
    {
    this->m_PlanComputed= false;
    }

  virtual ~FFTWComplexToComplexImageFilter()
    {
    if(m_PlanComputed)
      {
      fftwf_destroy_plan(m_Plan);
      }
    }
  
  virtual void GenerateData();  // generates output from input
  virtual bool FullMatrix();


  void PrintSelf(std::ostream& os, Indent indent) const;

private:
  FFTWComplexToComplexImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  bool            m_PlanComputed;
  fftwf_plan      m_Plan;
};


template <unsigned int NDimension>
class FFTWComplexToComplexImageFilter<double,NDimension>:
    public FFTComplexToComplexImageFilter<double,NDimension>
{
// TODO:  There should be compile time type checks so that
//        if only USE_FFTWF is defined, then only floats are valid.
//        and if USE_FFTWD is defined, then only doubles are valid.
public:
  typedef double                                  TPixel;
  typedef FFTWComplexToComplexImageFilter         Self;
  typedef FFTComplexToComplexImageFilter<
    TPixel,NDimension>                            Superclass;
  typedef SmartPointer<Self>                      Pointer;
  typedef SmartPointer<const Self>                ConstPointer;

  typedef typename Superclass::InputImageType     InputImageType;
  typedef typename Superclass::OutputImageType    OutputImageType;

  itkNewMacro(Self);

  itkTypeMacro(FFTWComplexToComplexImageFilter,
               FFTComplexToComplexImageFilter);

  typedef InputImageType                          ImageType;
  typedef typename ImageType::SizeType            ImageSizeType;

protected:

  FFTWComplexToComplexImageFilter()
    {
    m_PlanComputed= false;
    }

  virtual ~FFTWComplexToComplexImageFilter()
    {
    if( this->m_PlanComputed )
      {
      fftw_destroy_plan( this->m_Plan );
      }
    }

  void PrintSelf(std::ostream& os, Indent indent) const;

  //
  // these should be defined in every FFT filter class
  virtual void GenerateData();  // generates output from input
  virtual bool FullMatrix();

private:
  FFTWComplexToComplexImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  bool                      m_PlanComputed;
  fftw_plan                 m_Plan;
};

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFFTWComplexToComplexImageFilter.txx"
#endif

#endif // defined(USE_FFTWF) || defined(USE_FFTWD)

#endif //__itkFFTWComplexToComplexImageFilter_h