FFTOp.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLFilter/src/ICLFilter/FFTOp.h                        **
** Module : ICLFilter                                              **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLMath/FFTUtils.h>
#include <ICLCore/Img.h>
#include <ICLFilter/UnaryOp.h>
#include <cmath>

namespace icl{
  namespace filter{


  class ICLFilter_API FFTOp : public UnaryOp{

  private:
        class Data;

        Data *m_data;

        //Applies fft/dft on all channel of sourceimage.
        template<class SrcT, class DstT>
        void apply_internal(const core::Img<SrcT> &src, core::Img<DstT> &dst,
                            math::DynMatrix<std::complex<DstT> > &buf,
                            math::DynMatrix<std::complex<DstT> > &dstBuf);

        //Adapts sourceimage before fft/dft computation.
        template<class T>
        const core::Img<T> *adapt_source(const core::Img<T> *src);

        //Applies an inplace fftshift  after computation of the fft (if possible).
        template<typename T>
        void apply_inplace_fftshift(math::DynMatrix<T> &m);

  public:

        enum SizeAdaptionMode{
          NO_SCALE,
          PAD_ZERO,
          PAD_COPY,
          PAD_MIRROR,
          SCALE_UP,
          SCALE_DOWN 
        };


        enum ResultMode{
          TWO_CHANNEL_COMPLEX,
          IMAG_ONLY,
          REAL_ONLY,
          POWER_SPECTRUM,
          LOG_POWER_SPECTRUM,
          MAGNITUDE_ONLY,
          PHASE_ONLY,
          TWO_CHANNEL_MAGNITUDE_PHASE
        };


        FFTOp(ResultMode rm=LOG_POWER_SPECTRUM, SizeAdaptionMode sam=NO_SCALE,
              bool fftshift=true,bool forceDFT=false);

        ~FFTOp();


        void setResultMode(ResultMode rm);


        int getResultMode();


        void setSizeAdaptionMode(SizeAdaptionMode sam);


        int getSizeAdaptionMode();


        bool getForceDFT();


        void setForceDFT(bool pForceDFT);


        void setFFTShift(bool pFFTShift);


        bool getFFTShift();


        virtual void apply(const core::ImgBase *src, core::ImgBase **dst);

        using UnaryOp::apply;
    };
  } // namespace filter
}