IFFTOp.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/IFFTOp.h                       **
** Module : ICLFilter                                              **
** Authors: Christian Groszewski, 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 <ICLUtils/BasicTypes.h>
#include <ICLMath/DynMatrix.h>
#include <ICLMath/FFTUtils.h>
#include <ICLCore/Img.h>
#include <ICLFilter/UnaryOp.h>
#include <cmath>
#include <complex>

namespace icl{
  namespace filter{

    class ICLFilter_API IFFTOp : public UnaryOp{

      private:
      class Data;

      Data *m_data;

      //Applies ifft/idft 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 ifft/idft computation.
      template<class T>
      const core::Img<T> *adapt_source(const core::Img<T> *src);

      //Applies an inplace ifftshift  after computation of the ifft.
      template<typename T>
      void apply_inplace_ifftshift(math::DynMatrix<T> &m);

      public:


      enum SizeAdaptionMode{
        NO_SCALE,
        PAD_REMOVE,
        SCALE_UP,
        SCALE_DOWN
      };


      //Modes how the destinationimage will be created.
      enum ResultMode{
        REAL_ONLY,
        IMAG_ONLY,
        TWO_CHANNEL_COMPLEX
      };


      IFFTOp(ResultMode rm=REAL_ONLY, SizeAdaptionMode sam=NO_SCALE,
             utils::Rect roi=Rect(0,0,0,0),bool join=true,
             bool ifftshift=true, bool forceIDFT=false);

      ~IFFTOp();


      void setJoinMatrix(bool pJoin);


      bool getJoinMatrix();


      void setROI(utils::Rect roi);


      Rect getRoi();

      /*@param rm the resultmode to be set*/
      void setResultMode(ResultMode rm);


      int getResultMode();


      void setSizeAdaptionMode(SizeAdaptionMode sam);


      int getSizeAdaptionMode();


      bool getForceIDFT();


      void setForceIDFT(bool pForceDFT);


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

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