/usr/share/doc/mffm-fftw-dev/html/complexFFT_8H-source.html is in mffm-fftw-dev 1.7-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | <!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: complexFFT.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 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 List</span></a></li>
</ul>
</div>
<h1>complexFFT.H</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright 2001,2002 Matt Flax <flatmax@ieee.org></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 COMPLEXFFT_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define COMPLEXFFT_H_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <fftw3.h></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef fftw_real</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define fftw_real double</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define c_re(c) ((c)[0])</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define c_im(c) ((c)[1])</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iomanip></span>
<a name="l00030"></a>00030 <span class="keyword">using namespace </span>std;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#define PLANTYPE FFTW_ESTIMATE</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/// class complexFFTData controls and manipulates complex fft data</span>
<a name="l00035"></a><a class="code" href="classcomplexFFTData.html">00035</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classcomplexFFTData.html" title="class complexFFTData controls and manipulates complex fft data">complexFFTData</a> {
<a name="l00036"></a>00036 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /// Specifies the size of the data array</span>
<a name="l00038"></a><a class="code" href="classcomplexFFTData.html#e6e35601defcf29c45e5ab73280fde53">00038</a> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classcomplexFFTData.html#e6e35601defcf29c45e5ab73280fde53" title="Specifies the size of the data array.">size</a>;<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /// the input and output arrays</span>
<a name="l00040"></a><a class="code" href="classcomplexFFTData.html#1d0e919466631bb9c40339a6cb53925e">00040</a> <span class="comment"></span> fftw_complex *<a class="code" href="classcomplexFFTData.html#1d0e919466631bb9c40339a6cb53925e" title="the input and output arrays">in</a>, *out;<span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"> /// the power_spectrum array</span>
<a name="l00042"></a><a class="code" href="classcomplexFFTData.html#7a5a433a16ad31e04adee9833da51ebe">00042</a> <span class="comment"></span> fftw_real *<a class="code" href="classcomplexFFTData.html#7a5a433a16ad31e04adee9833da51ebe" title="the power_spectrum array">power_spectrum</a>;<span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /// The total power (summed) of the power spectrum as used in the method compPowerSpec</span>
<a name="l00044"></a><a class="code" href="classcomplexFFTData.html#3f063249c6a6496d45c3663b7c343cfd">00044</a> <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="classcomplexFFTData.html#3f063249c6a6496d45c3663b7c343cfd" title="The total power (summed) of the power spectrum as used in the method compPowerSpec...">totalPower</a>;
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /// Constructor with all memory to be allocated internally</span>
<a name="l00047"></a>00047 <span class="comment"></span> <a class="code" href="classcomplexFFTData.html#f9b10ed747d02f4600c101d2f4e34d70" title="Constructor with all memory to be allocated internally.">complexFFTData</a>(<span class="keywordtype">int</span> sz);<span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment"> /// Deconstructor</span>
<a name="l00049"></a>00049 <span class="comment"></span> <a class="code" href="classcomplexFFTData.html#310283d7eacd8bf948e7560e900168d2" title="Deconstructor.">~complexFFTData</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="classcomplexFFTData.html#e91ed9ce3c1fb7514f875eae29492d2d" title="Use this to change associated fft data (for fft&#39;ing).">switchData</a>(<a class="code" href="classcomplexFFTData.html" title="class complexFFTData controls and manipulates complex fft data">complexFFTData</a> *d);
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /// Limits the maximum to 'lim' and returns the last fft bin with max </span>
<a name="l00055"></a>00055 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classcomplexFFTData.html#eff15b3efb0be321faef3fbc69627197" title="Limits the maximum to &#39;lim&#39; and returns the last fft bin with max.">limitHalfPowerSpec</a>(<span class="keywordtype">double</span> lim);
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /// Returns the number of elements in the input and output arrays</span>
<a name="l00058"></a><a class="code" href="classcomplexFFTData.html#e8677f19a245e5a66d42095be1d53b81">00058</a> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classcomplexFFTData.html#e8677f19a245e5a66d42095be1d53b81" title="Returns the number of elements in the input and output arrays.">getSize</a>(){<span class="keywordflow">return</span> <a class="code" href="classcomplexFFTData.html#e6e35601defcf29c45e5ab73280fde53" title="Specifies the size of the data array.">size</a>;}
<a name="l00059"></a>00059 <span class="comment">// int getHalfSize(){ if (!(size%2)) return size/2; else return size/2+1;}</span>
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /// This function computes the power spectrum and returns the max bin</span>
<a name="l00062"></a>00062 <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classcomplexFFTData.html#96f361cf90565d27dbfa7c82527783d6" title="This function computes the power spectrum and returns the max bin.">compPowerSpec</a>();
<a name="l00063"></a>00063 <span class="comment">// int powerSpecDeriv(); // Find the derivative of the power spectrum</span>
<a name="l00064"></a>00064 };
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">///class complexFFT controls fftw plans and executes fwd/inv transforms</span>
<a name="l00067"></a><a class="code" href="classcomplexFFT.html">00067</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classcomplexFFT.html" title="class complexFFT controls fftw plans and executes fwd/inv transforms">complexFFT</a> {<span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /// The fwd/inv plans</span>
<a name="l00069"></a>00069 <span class="comment"></span> fftw_plan fwdPlan, invPlan;<span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /// Method to create the plans</span>
<a name="l00071"></a>00071 <span class="comment"></span> <span class="keywordtype">void</span> createPlan(<span class="keywordtype">void</span>);<span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /// Method to destroy the plans</span>
<a name="l00073"></a>00073 <span class="comment"></span> <span class="keywordtype">void</span> destroyPlan(<span class="keywordtype">void</span>);
<a name="l00074"></a>00074 <span class="keyword">protected</span>:
<a name="l00075"></a>00075 <span class="comment">// int size;</span><span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /// The pointer to the relevant data</span>
<a name="l00077"></a><a class="code" href="classcomplexFFT.html#a4c912a63325dce65b09da8379f5b2ec">00077</a> <span class="comment"></span> <a class="code" href="classcomplexFFTData.html" title="class complexFFTData controls and manipulates complex fft data">complexFFTData</a> *<a class="code" href="classcomplexFFT.html#a4c912a63325dce65b09da8379f5b2ec" title="The pointer to the relevant data.">data</a>;
<a name="l00078"></a>00078 <span class="keyword">public</span>:
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">// complexFFT(int sz, char *ws=NULL);</span><span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /// fft init ... data pointed to by 'd'</span>
<a name="l00082"></a>00082 <span class="comment"></span> <a class="code" href="classcomplexFFT.html#5bb171e502a8324fbfc3afd02897cdab" title="fft init ... data pointed to by &#39;d&#39;">complexFFT</a>(<a class="code" href="classcomplexFFTData.html" title="class complexFFTData controls and manipulates complex fft data">complexFFTData</a> *d);<span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /// fft deconstructor</span>
<a name="l00084"></a>00084 <span class="comment"></span> <a class="code" href="classcomplexFFT.html#f4d2cf165a95b9ff1f31b327c45eb8b5" title="fft deconstructor">~complexFFT</a>();
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /// Use this to change associated fft data (for fft'ing)</span>
<a name="l00087"></a>00087 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classcomplexFFT.html#c2d5bee1cf9d333b4d9bc98a1b37ab6a" title="Use this to change associated fft data (for fft&#39;ing).">switchData</a>(<a class="code" href="classcomplexFFTData.html" title="class complexFFTData controls and manipulates complex fft data">complexFFTData</a> *d);
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /// Forward transform the data (in to out)</span>
<a name="l00090"></a>00090 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classcomplexFFT.html#2cc76318664e524b70aade4d57b5f1a2" title="Forward transform the data (in to out).">fwdTransform</a>(); <span class="comment">// Forward fft</span><span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment"> /// Inverse transform the data (out to in)</span>
<a name="l00092"></a>00092 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classcomplexFFT.html#c83e61199195800b7a97ee3e8a9cfa5e" title="Inverse transform the data (out to in).">invTransform</a>(); <span class="comment">// Inverse fft</span>
<a name="l00093"></a>00093 };<span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/** \example complexFFTExample.cc</span>
<a name="l00095"></a>00095 <span class="comment"> * This is an example of how to use the class.</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 <span class="preprocessor">#endif // COMPLEXFFT_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
<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>
|