/usr/share/doc/mffm-fftw-dev/html/classrealFFTData.html is in mffm-fftw-dev 1.7-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MFFM FFTw Wrapper: realFFTData Class Reference</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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>realFFTData Class Reference</h1><!-- doxytag: class="realFFTData" -->
<p>class <a class="el" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a> controls and manipulates fft data
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="realFFTData_8H_source.html">realFFTData.H</a>></code></p>
<p><a href="classrealFFTData-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67afb57ca1d578aa93d0cdcbc2c87bd2"></a><!-- doxytag: member="realFFTData::realFFTData" ref="a67afb57ca1d578aa93d0cdcbc2c87bd2" args="(int sz)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a67afb57ca1d578aa93d0cdcbc2c87bd2">realFFTData</a> (int sz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">All memory to be allocated internally. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a349904187c39e18fa518444092e608c2"></a><!-- doxytag: member="realFFTData::realFFTData" ref="a349904187c39e18fa518444092e608c2" args="(int sz, fftw_real *inp, fftw_real *outp)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a349904187c39e18fa518444092e608c2">realFFTData</a> (int sz, fftw_real *inp, fftw_real *outp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">input and output data arrays are to be allocated by another process <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f6e45f49bc476117a4ce9ff90acf941"></a><!-- doxytag: member="realFFTData::~realFFTData" ref="a9f6e45f49bc476117a4ce9ff90acf941" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a9f6e45f49bc476117a4ce9ff90acf941">~realFFTData</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deconstructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f6d6107bcc3044efb7ec9a7dbbdb265"></a><!-- doxytag: member="realFFTData::limitHalfPowerSpec" ref="a6f6d6107bcc3044efb7ec9a7dbbdb265" args="(double lim)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a6f6d6107bcc3044efb7ec9a7dbbdb265">limitHalfPowerSpec</a> (double lim)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Limits the maximum to 'lim' and returns the last fft bin with max. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba8afe3db78cc7f2750e68ad6cf675aa"></a><!-- doxytag: member="realFFTData::getSize" ref="aba8afe3db78cc7f2750e68ad6cf675aa" args="(void)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#aba8afe3db78cc7f2750e68ad6cf675aa">getSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in the input and output arrays. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa69ac758ccf6419488584c6259b2e29a"></a><!-- doxytag: member="realFFTData::getHalfSize" ref="aa69ac758ccf6419488584c6259b2e29a" args="(void)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#aa69ac758ccf6419488584c6259b2e29a">getHalfSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in the power spectrum array. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a516be7e9334456289adee398a24ee8"></a><!-- doxytag: member="realFFTData::findMaxIn" ref="a0a516be7e9334456289adee398a24ee8" args="(void)" -->
fftw_real </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a0a516be7e9334456289adee398a24ee8">findMaxIn</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum input variable. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5cc6bb701716ec9c25fb19d926da4cc"></a><!-- doxytag: member="realFFTData::findMaxMinPowerBins" ref="ad5cc6bb701716ec9c25fb19d926da4cc" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#ad5cc6bb701716ec9c25fb19d926da4cc">findMaxMinPowerBins</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills the max and min power spectrum bins. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a304eac736338b0c7c0bb990ab14d4399"></a><!-- doxytag: member="realFFTData::compPowerSpec" ref="a304eac736338b0c7c0bb990ab14d4399" args="()" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a304eac736338b0c7c0bb990ab14d4399">compPowerSpec</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function computes the power spectrum and returns the max bin. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a803b81e1aa2f367ce7efecfcfdb04308"></a><!-- doxytag: member="realFFTData::sqrtPowerSpec" ref="a803b81e1aa2f367ce7efecfcfdb04308" args="()" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a803b81e1aa2f367ce7efecfcfdb04308">sqrtPowerSpec</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function computes the square root of the power spectrum and returns the max bin. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a569439a4bdf72acfdca81437d938f962"></a><!-- doxytag: member="realFFTData::zeroFFTData" ref="a569439a4bdf72acfdca81437d938f962" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a569439a4bdf72acfdca81437d938f962">zeroFFTData</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function zeros the output data array (out). <br/></td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade1ad6037045e29b6d2562f852f178ef"></a><!-- doxytag: member="realFFTData::size" ref="ade1ad6037045e29b6d2562f852f178ef" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#ade1ad6037045e29b6d2562f852f178ef">size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies the size of the data array. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72ac9e7c12055dfbfe0fffdd541973f4"></a><!-- doxytag: member="realFFTData::minPowerBin" ref="a72ac9e7c12055dfbfe0fffdd541973f4" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a72ac9e7c12055dfbfe0fffdd541973f4">minPowerBin</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies the minimum and maximum power bins as used in the methods findMaxMinPowerBins and compPowerSpec. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2fe9fb08927718ee8968ac345d3f985"></a><!-- doxytag: member="realFFTData::maxPowerBin" ref="aa2fe9fb08927718ee8968ac345d3f985" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>maxPowerBin</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bf1dadc9fd55d2b1bc5371027c4ac8a"></a><!-- doxytag: member="realFFTData::in" ref="a2bf1dadc9fd55d2b1bc5371027c4ac8a" args="" -->
fftw_real * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#a2bf1dadc9fd55d2b1bc5371027c4ac8a">in</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the input, output and power_spectrum arrays <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96a783221e91a40f925d40e881a4c799"></a><!-- doxytag: member="realFFTData::out" ref="a96a783221e91a40f925d40e881a4c799" args="" -->
fftw_real * </td><td class="memItemRight" valign="bottom"><b>out</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c4e444e5a03f5a2b1889f2ebae52197"></a><!-- doxytag: member="realFFTData::power_spectrum" ref="a7c4e444e5a03f5a2b1889f2ebae52197" args="" -->
fftw_real * </td><td class="memItemRight" valign="bottom"><b>power_spectrum</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaada9a4bc631e8760365c89746359ee6"></a><!-- doxytag: member="realFFTData::totalPower" ref="aaada9a4bc631e8760365c89746359ee6" args="" -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classrealFFTData.html#aaada9a4bc631e8760365c89746359ee6">totalPower</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The total power (summed) of the power spectrum as used in the method compPowerSpec. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>class <a class="el" href="classrealFFTData.html" title="class realFFTData controls and manipulates fft data">realFFTData</a> controls and manipulates fft data </p>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="realFFTExample_8cc-example.html#_a0">realFFTExample.cc</a>.</p>
</dd>
</dl>
<p>Definition at line <a class="el" href="realFFTData_8H_source.html#l00032">32</a> of file <a class="el" href="realFFTData_8H_source.html">realFFTData.H</a>.</p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="realFFTData_8H_source.html">realFFTData.H</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Dec 17 00:33:56 2009 for MFFM FFTw Wrapper by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|