FourierTransform.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.4.7
// ----------------------------------------------------------------------------
// pcl/FourierTransform.h - Released 2020-12-17T15:46:29Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2020 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------

#ifndef __PCL_FourierTransform_h
#define __PCL_FourierTransform_h


#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>

#include <pcl/FFT1D.h>
#include <pcl/FFT2D.h>
#include <pcl/ImageTransformation.h>
#include <pcl/ParallelProcess.h>

namespace pcl
{

// ----------------------------------------------------------------------------

namespace FFTDirection
{
   enum value_type
   {
      Forward,
      Backward
   };
}

// ----------------------------------------------------------------------------

class PCL_CLASS InPlaceFourierTransform : public ImageTransformation, public ParallelProcess
{
public:

   typedef FFTDirection::value_type    transform_type;

   InPlaceFourierTransform( transform_type type = FFTDirection::Forward )
      : m_type( type )
   {
   }

   InPlaceFourierTransform( const InPlaceFourierTransform& ) = default;

   virtual ~InPlaceFourierTransform()
   {
   }

   transform_type Type() const
   {
      return m_type;
   }

protected:

   transform_type m_type;

   // In-place FFT of complex images.
   void Apply( pcl::ComplexImage& ) const override;
   void Apply( pcl::DComplexImage& ) const override;
};

// ----------------------------------------------------------------------------

class PCL_CLASS InPlaceInverseFourierTransform : public InPlaceFourierTransform
{
public:

   InPlaceInverseFourierTransform()
      : InPlaceFourierTransform( FFTDirection::Backward )
   {
   }

   InPlaceInverseFourierTransform( const InPlaceInverseFourierTransform& ) = default;

   virtual ~InPlaceInverseFourierTransform()
   {
   }
};

// ----------------------------------------------------------------------------

class PCL_CLASS FourierTransform : public BidirectionalImageTransformation, public ParallelProcess
{
public:

   FourierTransform() = default;

   FourierTransform( const FourierTransform& ) = default;

   FourierTransform( FourierTransform&& ) = default;

   virtual ~FourierTransform()
   {
   }

   FourierTransform& operator =( const FourierTransform& ) = default;

   FourierTransform& operator =( FourierTransform&& ) = default;

   const ImageVariant& DFT() const
   {
      return m_dft;
   }

   ImageVariant& DFT()
   {
      return m_dft;
   }

   const ImageVariant& operator *() const
   {
      return DFT();
   }

   ImageVariant& operator *()
   {
      return DFT();
   }

   ImageVariant ReleaseTransform()
   {
      ImageVariant r;
      m_dft.ReleaseTo( r );
      return r;
   }

   void Clear()
   {
      m_dft.Free();
   }

protected:

   // Discrete 2-D Fourier Transform
   ImageVariant m_dft;

   // Transform
   void Transform( const pcl::Image& ) override;
   void Transform( const pcl::DImage& ) override;
   void Transform( const pcl::ComplexImage& ) override;
   void Transform( const pcl::DComplexImage& ) override;
   void Transform( const pcl::UInt8Image& ) override;
   void Transform( const pcl::UInt16Image& ) override;
   void Transform( const pcl::UInt32Image& ) override;

   // Inverse transform
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::ComplexImage& ) const override;
   void Apply( pcl::DComplexImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
};

// ----------------------------------------------------------------------------

} // pcl

#endif   // __PCL_FourierTransform_h

// ----------------------------------------------------------------------------
// EOF pcl/FourierTransform.h - Released 2020-12-17T15:46:29Z