File: classreal2DFFTData.html

package info (click to toggle)
mffm-fftw 1.7-3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 2,480 kB
  • ctags: 1,176
  • sloc: cpp: 711; makefile: 89
file content (161 lines) | stat: -rw-r--r-- 17,849 bytes parent folder | download | duplicates (5)
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!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: real2DFFTData 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>real2DFFTData Class Reference</h1><!-- doxytag: class="real2DFFTData" -->
<p>class <a class="el" href="classreal2DFFTData.html" title="class real2DFFTData controls and manipulates real 2D fft data">real2DFFTData</a> controls and manipulates real 2D fft data  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="real2DFFT_8H_source.html">real2DFFT.H</a>&gt;</code></p>

<p><a href="classreal2DFFTData-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="ad1c236952306fcead4c74b08a9ecdbbc"></a><!-- doxytag: member="real2DFFTData::real2DFFTData" ref="ad1c236952306fcead4c74b08a9ecdbbc" args="(int r, int c)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#ad1c236952306fcead4c74b08a9ecdbbc">real2DFFTData</a> (int r, int c)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with all memory to be allocated internally. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa31e47d5f92fddb65e1ac79abe564d76"></a><!-- doxytag: member="real2DFFTData::~real2DFFTData" ref="aa31e47d5f92fddb65e1ac79abe564d76" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#aa31e47d5f92fddb65e1ac79abe564d76">~real2DFFTData</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deconstructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f7050e9cf0270ea0f15f4b8399c2d57"></a><!-- doxytag: member="real2DFFTData::getXSize" ref="a0f7050e9cf0270ea0f15f4b8399c2d57" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a0f7050e9cf0270ea0f15f4b8399c2d57">getXSize</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The row count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cc42bdfe90c9ba98101abf70b378e37"></a><!-- doxytag: member="real2DFFTData::getYSize" ref="a6cc42bdfe90c9ba98101abf70b378e37" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a6cc42bdfe90c9ba98101abf70b378e37">getYSize</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The column count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfee72c9266bcda29fe4f0322c0664ff"></a><!-- doxytag: member="real2DFFTData::getXHalfSize" ref="acfee72c9266bcda29fe4f0322c0664ff" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#acfee72c9266bcda29fe4f0322c0664ff">getXHalfSize</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The half row count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0ee77426523ff06dc4cdaba91d2f330"></a><!-- doxytag: member="real2DFFTData::getYHalfSize" ref="ac0ee77426523ff06dc4cdaba91d2f330" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#ac0ee77426523ff06dc4cdaba91d2f330">getYHalfSize</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The half column count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77b3acac87b8920b1f2700eb85d4e466"></a><!-- doxytag: member="real2DFFTData::reScale" ref="a77b3acac87b8920b1f2700eb85d4e466" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a77b3acac87b8920b1f2700eb85d4e466">reScale</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scales the output down by the number of elements. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8768cf3a25b1b89b5ea6c8727126cf44"></a><!-- doxytag: member="real2DFFTData::compPowerSpec" ref="a8768cf3a25b1b89b5ea6c8727126cf44" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a8768cf3a25b1b89b5ea6c8727126cf44">compPowerSpec</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function computes the power spectrum and updates the totalPower, maxPower and minPower. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad095e4ce09a821659eec532eb9da5a09"></a><!-- doxytag: member="real2DFFTData::compLogPowerSpec" ref="ad095e4ce09a821659eec532eb9da5a09" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#ad095e4ce09a821659eec532eb9da5a09">compLogPowerSpec</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finds 10*log10(power spectrum) and updates the totalPower, maxPower and minPower. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b1ecff5d07fb6b7d529562d5a679a3a"></a><!-- doxytag: member="real2DFFTData::timeSpecAverage" ref="a9b1ecff5d07fb6b7d529562d5a679a3a" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a9b1ecff5d07fb6b7d529562d5a679a3a">timeSpecAverage</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates timeXSum. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af35d16aa01b5988c90c62dc1380eee8b"></a><!-- doxytag: member="real2DFFTData::complexSpecAverage" ref="af35d16aa01b5988c90c62dc1380eee8b" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#af35d16aa01b5988c90c62dc1380eee8b">complexSpecAverage</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates realXSum and imagXSum. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#aaa9e52745862dd84230b3b606f14562a">powerSpecAverage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9191df160ac56af766edcd35518e94e6"></a><!-- doxytag: member="real2DFFTData::findYSum" ref="a9191df160ac56af766edcd35518e94e6" args="(int start, int stop)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a9191df160ac56af766edcd35518e94e6">findYSum</a> (int start, int stop)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finds the y-sum between columns start and stop. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1b265e4b8671d81ed00f4d8783a342d"></a><!-- doxytag: member="real2DFFTData::findYMax" ref="ae1b265e4b8671d81ed00f4d8783a342d" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#ae1b265e4b8671d81ed00f4d8783a342d">findYMax</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finds the y-max for the ySum array, updates ySumMin, ySumMax, maxYSumIndex. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb4fbda6a7111741c130f22dede76828"></a><!-- doxytag: member="real2DFFTData::clearInput" ref="abb4fbda6a7111741c130f22dede76828" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#abb4fbda6a7111741c130f22dede76828">clearInput</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Zeros the in array. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7de72cd88625f3f4383beefb869b5fd0"></a><!-- doxytag: member="real2DFFTData::clearOutput" ref="a7de72cd88625f3f4383beefb869b5fd0" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a7de72cd88625f3f4383beefb869b5fd0">clearOutput</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Zeros the out awway. <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="aee22ddba7091e4c0a964b7aeb0a7a9d0"></a><!-- doxytag: member="real2DFFTData::in" ref="aee22ddba7091e4c0a964b7aeb0a7a9d0" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#aee22ddba7091e4c0a964b7aeb0a7a9d0">in</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The input data and power spectrum. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6598db3adc015855e298bb6f46b3789f"></a><!-- doxytag: member="real2DFFTData::power" ref="a6598db3adc015855e298bb6f46b3789f" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><b>power</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad843e1854cbc66973c1d8cec245f89fb"></a><!-- doxytag: member="real2DFFTData::out" ref="ad843e1854cbc66973c1d8cec245f89fb" args="" -->
fftw_complex *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#ad843e1854cbc66973c1d8cec245f89fb">out</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The output data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28a3d5aee1db4d73220ed40e4ea375f3"></a><!-- doxytag: member="real2DFFTData::xSum" ref="a28a3d5aee1db4d73220ed40e4ea375f3" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a28a3d5aee1db4d73220ed40e4ea375f3">xSum</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Arrays which sum across rows (x) and columns (y). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8d377a4d82923388671d868aa7d35b9"></a><!-- doxytag: member="real2DFFTData::ySum" ref="ac8d377a4d82923388671d868aa7d35b9" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><b>ySum</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4f6d73d8e8253f3214746924f3c6a76"></a><!-- doxytag: member="real2DFFTData::timeXSum" ref="af4f6d73d8e8253f3214746924f3c6a76" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#af4f6d73d8e8253f3214746924f3c6a76">timeXSum</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A sum across the input time signal. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63acc55247bb735f33ce8eea2ecdd2d3"></a><!-- doxytag: member="real2DFFTData::realXSum" ref="a63acc55247bb735f33ce8eea2ecdd2d3" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a63acc55247bb735f33ce8eea2ecdd2d3">realXSum</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power spectral sums across rows (x) and columns (y). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a28f685894ea476ddd553a390dd84a2"></a><!-- doxytag: member="real2DFFTData::imagXSum" ref="a8a28f685894ea476ddd553a390dd84a2" args="" -->
fftw_real *&nbsp;</td><td class="memItemRight" valign="bottom"><b>imagXSum</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cd2940771fcde698d5f7cfb8253e63b"></a><!-- doxytag: member="real2DFFTData::totalPower" ref="a3cd2940771fcde698d5f7cfb8253e63b" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#a3cd2940771fcde698d5f7cfb8253e63b">totalPower</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The total power in the power spectrum, the maximum and minimum powers too. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a742da27b5b6bffa09d2f95df76f01e84"></a><!-- doxytag: member="real2DFFTData::maxPower" ref="a742da27b5b6bffa09d2f95df76f01e84" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxPower</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a118ef1331c3f23cdaef91cd72bc3aeed"></a><!-- doxytag: member="real2DFFTData::minPower" ref="a118ef1331c3f23cdaef91cd72bc3aeed" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>minPower</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9311c5ec231402c7aa1fff9bdd7036d"></a><!-- doxytag: member="real2DFFTData::xSumMin" ref="aa9311c5ec231402c7aa1fff9bdd7036d" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#aa9311c5ec231402c7aa1fff9bdd7036d">xSumMin</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The minimum/maximum row (x) and column (y) sums. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae912d834fa17a6e53aae435296780c1f"></a><!-- doxytag: member="real2DFFTData::xSumMax" ref="ae912d834fa17a6e53aae435296780c1f" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>xSumMax</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dc45d1fd465a0ce88bc5ea514106b01"></a><!-- doxytag: member="real2DFFTData::ySumMin" ref="a1dc45d1fd465a0ce88bc5ea514106b01" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>ySumMin</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a920df95bcef09b2ad16b5e892a6dc1eb"></a><!-- doxytag: member="real2DFFTData::ySumMax" ref="a920df95bcef09b2ad16b5e892a6dc1eb" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>ySumMax</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab67a8c32bc2d288d7180c2e5122b84d"></a><!-- doxytag: member="real2DFFTData::maxXSumIndex" ref="aab67a8c32bc2d288d7180c2e5122b84d" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreal2DFFTData.html#aab67a8c32bc2d288d7180c2e5122b84d">maxXSumIndex</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Row (x) and Column (y) max sum indexes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b2549c18c571972ad201ceec42eac32"></a><!-- doxytag: member="real2DFFTData::maxYSumIndex" ref="a0b2549c18c571972ad201ceec42eac32" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxYSumIndex</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>class <a class="el" href="classreal2DFFTData.html" title="class real2DFFTData controls and manipulates real 2D fft data">real2DFFTData</a> controls and manipulates real 2D fft data </p>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="real2DFFTExample_8cc-example.html#_a0">real2DFFTExample.cc</a>.</p>
</dd>
</dl>
<p>Definition at line <a class="el" href="real2DFFT_8H_source.html#l00036">36</a> of file <a class="el" href="real2DFFT_8H_source.html">real2DFFT.H</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaa9e52745862dd84230b3b606f14562a"></a><!-- doxytag: member="real2DFFTData::powerSpecAverage" ref="aaa9e52745862dd84230b3b606f14562a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void real2DFFTData::powerSpecAverage </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Finds the power Spectrum averages and updates the xSumMin, xSumMax, ySumMin, ySumMax, xSum, ySum, maxXSumIndex, maxYSumIndex </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="real2DFFT_8H_source.html">real2DFFT.H</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Dec 17 00:32:35 2009 for MFFM FFTw Wrapper by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>