PCL
FourierTransform.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/FourierTransform.h - Released 2019-11-07T10:59:34Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_FourierTransform_h
53 #define __PCL_FourierTransform_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 #include <pcl/FFT1D.h>
61 #include <pcl/FFT2D.h>
63 #include <pcl/ParallelProcess.h>
64 
65 namespace pcl
66 {
67 
68 // ----------------------------------------------------------------------------
69 
79 namespace FFTDirection
80 {
81  enum value_type
82  {
83  Forward,
84  Backward
85  };
86 }
87 
88 // ----------------------------------------------------------------------------
89 
111 {
112 public:
113 
117  typedef FFTDirection::value_type transform_type;
118 
132  InPlaceFourierTransform( transform_type type = FFTDirection::Forward ) :
133  m_type( type )
134  {
135  }
136 
141 
146  {
147  }
148 
153  transform_type Type() const
154  {
155  return m_type;
156  }
157 
158 protected:
159 
160  transform_type m_type;
161 
162  // In-place FFT of complex images.
163  void Apply( pcl::ComplexImage& ) const override;
164  void Apply( pcl::DComplexImage& ) const override;
165 };
166 
167 // ----------------------------------------------------------------------------
168 
184 {
185 public:
186 
191  InPlaceFourierTransform( FFTDirection::Backward )
192  {
193  }
194 
199 
204  {
205  }
206 };
207 
208 // ----------------------------------------------------------------------------
209 
227 {
228 public:
229 
235  FourierTransform() = default;
236 
245  FourierTransform( const FourierTransform& ) = default;
246 
250  FourierTransform( FourierTransform&& ) = default;
251 
261  {
262  }
263 
273  FourierTransform& operator =( const FourierTransform& ) = default;
274 
278  FourierTransform& operator =( FourierTransform&& ) = default;
279 
289  const ImageVariant& DFT() const
290  {
291  return m_dft;
292  }
293 
304  {
305  return m_dft;
306  }
307 
311  const ImageVariant& operator *() const
312  {
313  return DFT();
314  }
315 
320  {
321  return DFT();
322  }
323 
337  {
338  ImageVariant r;
339  m_dft.ReleaseTo( r );
340  return r;
341  }
342 
350  void Clear()
351  {
352  m_dft.Free();
353  }
354 
355 protected:
356 
357  // Discrete 2-D Fourier Transform
358  ImageVariant m_dft;
359 
360  // Transform
361  void Transform( const pcl::Image& ) override;
362  void Transform( const pcl::DImage& ) override;
363  void Transform( const pcl::ComplexImage& ) override;
364  void Transform( const pcl::DComplexImage& ) override;
365  void Transform( const pcl::UInt8Image& ) override;
366  void Transform( const pcl::UInt16Image& ) override;
367  void Transform( const pcl::UInt32Image& ) override;
368 
369  // Inverse transform
370  void Apply( pcl::Image& ) const override;
371  void Apply( pcl::DImage& ) const override;
372  void Apply( pcl::ComplexImage& ) const override;
373  void Apply( pcl::DComplexImage& ) const override;
374  void Apply( pcl::UInt8Image& ) const override;
375  void Apply( pcl::UInt16Image& ) const override;
376  void Apply( pcl::UInt32Image& ) const override;
377 };
378 
379 // ----------------------------------------------------------------------------
380 
381 } // pcl
382 
383 #endif // __PCL_FourierTransform_h
384 
385 // ----------------------------------------------------------------------------
386 // EOF pcl/FourierTransform.h - Released 2019-11-07T10:59:34Z
Root base class for bidirectional PCL image transformations.
Complex< T1 > operator*(const Complex< T1 > &c1, const Complex< T2 > &c2)
Definition: Complex.h:539
ImageVariant ReleaseTransform()
PCL root namespace.
Definition: AbstractImage.h:76
In-place discrete Fourier transform of two-dimensional complex images.
ImageVariant & DFT()
transform_type Type() const
InPlaceFourierTransform(transform_type type=FFTDirection::Forward)
16-bit unsigned integer image.
Acts like a union for all types of images in PCL, with optional class-wide ownership of transported i...
Definition: ImageVariant.h:317
32-bit floating point complex image.
void Apply(FI i, FI j, F f)
Definition: Utility.h:249
64-bit floating point real image.
32-bit unsigned integer image.
8-bit unsigned integer image.
Out-of-place discrete Fourier transform of two-dimensional images.
Root base class of all PCL image transformations.
In-place discrete inverse Fourier transform of two-dimensional complex images.
FFTDirection::value_type transform_type
64-bit floating point complex image.
const ImageVariant & DFT() const
32-bit floating point real image.
A process using multiple concurrent execution threads.