File: realFFT_8H-source.html

package info (click to toggle)
mffm-fftw 1.7-4
  • links: PTS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 3,724 kB
  • ctags: 1,182
  • sloc: cpp: 711; makefile: 72
file content (91 lines) | stat: -rw-r--r-- 8,980 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MFFM FFTw Wrapper: realFFT.H Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>realFFT.H</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright 2001,2002 Matt Flax &lt;[email protected]&gt;</span>
<a name="l00002"></a>00002 <span class="comment">   This file is part of the MFFM FFTw Wrapper library.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">   MFFM MFFM FFTw Wrapper library is free software; you can </span>
<a name="l00005"></a>00005 <span class="comment">   redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment">   it under the terms of the GNU General Public License as published by</span>
<a name="l00007"></a>00007 <span class="comment">   the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment">   (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment">   </span>
<a name="l00010"></a>00010 <span class="comment">   MFFM FFTw Wrapper library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">   but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00013"></a>00013 <span class="comment">   GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment">   </span>
<a name="l00015"></a>00015 <span class="comment">   You have received a copy of the GNU General Public License</span>
<a name="l00016"></a>00016 <span class="comment">   along with the MFFM FFTw Wrapper library</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef REALFFT_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define REALFFT_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "realFFTData.H"</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;fftw3.h&gt;</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;iostream&gt;</span>
<a name="l00025"></a>00025 <span class="keyword">using namespace </span>std;
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a>;
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#define PLANTYPE FFTW_ESTIMATE</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">///class realFFT controls fftw plans and executes fwd/inv transforms</span>
<a name="l00032"></a><a class="code" href="classrealFFT.html">00032</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classrealFFT.html" title="class realFFT controls fftw plans and executes fwd/inv transforms">realFFT</a> {<span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">  /// The fwd/inv plans</span>
<a name="l00034"></a>00034 <span class="comment"></span>  fftw_plan fwdPlan, invPlan;
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">  /// Method to create the plans</span>
<a name="l00037"></a>00037 <span class="comment"></span>  <span class="keywordtype">void</span> createPlan(<span class="keywordtype">void</span>);<span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">  /// Method to destroy the plans</span>
<a name="l00039"></a>00039 <span class="comment"></span>  <span class="keywordtype">void</span> destroyPlan(<span class="keywordtype">void</span>);
<a name="l00040"></a>00040 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">  /// The pointer to the relevant data</span>
<a name="l00042"></a><a class="code" href="classrealFFT.html#624fdf46935b31d56bff53abadae44e5">00042</a> <span class="comment"></span>  <a class="code" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a> *<a class="code" href="classrealFFT.html#624fdf46935b31d56bff53abadae44e5" title="The pointer to the relevant data.">data</a>;
<a name="l00043"></a>00043 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">  /// fft init ... don't forget to associate data using switchData</span>
<a name="l00045"></a>00045 <span class="comment"></span>  <a class="code" href="classrealFFT.html#2f5ed277e1bb3f93c01dda499aa70c0c" title="fft init ... don&amp;#39;t forget to associate data using switchData">realFFT</a>(<span class="keywordtype">void</span>);<span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">  /// fft init ... data pointed to by 'd'</span>
<a name="l00047"></a>00047 <span class="comment"></span>  <a class="code" href="classrealFFT.html#2f5ed277e1bb3f93c01dda499aa70c0c" title="fft init ... don&amp;#39;t forget to associate data using switchData">realFFT</a>(<a class="code" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a> *d);<span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">  /// fft deconstructor</span>
<a name="l00049"></a>00049 <span class="comment"></span>  <a class="code" href="classrealFFT.html#d958619634a27f16a0dcd32c3b6f957c" title="fft deconstructor">~realFFT</a>(<span class="keywordtype">void</span>);
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">  /// Use this to change associated fft data (for fft'ing)</span>
<a name="l00052"></a>00052 <span class="comment"></span>  <span class="keywordtype">void</span> <a class="code" href="classrealFFT.html#e60c80220c36a0835ec20708fa01586d" title="Use this to change associated fft data (for fft&amp;#39;ing).">switchData</a>(<a class="code" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a> *d);
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">  /// Forward transform the data (in to out)</span>
<a name="l00055"></a>00055 <span class="comment"></span>  <span class="keywordtype">void</span> <a class="code" href="classrealFFT.html#c41a7dcecd3246a439a31f59cf8e266f" title="Forward transform the data (in to out).">fwdTransform</a>(); <span class="comment">// Forward fft</span><span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">  /// Inverse transform the data (out to in)</span>
<a name="l00057"></a>00057 <span class="comment"></span>  <span class="keywordtype">void</span> <a class="code" href="classrealFFT.html#0d8793bbdca4f51cfc063e6b35c524ec" title="Inverse transform the data (out to in).">invTransform</a>(); <span class="comment">// Inverse fft</span>
<a name="l00058"></a>00058 };<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">/** \example realFFTExample.cc</span>
<a name="l00060"></a>00060 <span class="comment"> * This is an example of how to use the class.</span>
<a name="l00061"></a>00061 <span class="comment"> * It transforms a sine tone stored in the .dat file and saves the</span>
<a name="l00062"></a>00062 <span class="comment"> * in, out, and power_spectrum results of using the class</span>
<a name="l00063"></a>00063 <span class="comment"> */</span>
<a name="l00064"></a>00064 <span class="preprocessor">#endif // REALFFT_H_</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 26 11:52:20 2009 for MFFM FFTw Wrapper by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>