File: classrealFFTData.html

package info (click to toggle)
mffm-fftw 1.4-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,204 kB
  • ctags: 295
  • sloc: cpp: 704; makefile: 88
file content (88 lines) | stat: -rw-r--r-- 7,917 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>realFFTData class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="examples.html">Examples</a> &nbsp; </center>
<hr><h1>realFFTData Class Reference</h1>class realFFTData controls and manipulates fft data 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="realFFTData_8H-source.html">realFFTData.H</a>&gt;</code>
<p>
<a href="classrealFFTData-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="realFFTData::realFFTData"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a0">realFFTData</a> (int sz)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>All memory to be allocated internally.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="realFFTData::realFFTData"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a1">realFFTData</a> (int sz, fftw_real *inp, fftw_real *outp)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>input and output data arrays are to be allocated by another process</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="realFFTData::~realFFTData"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a2">~realFFTData</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Deconstructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="realFFTData::limitHalfPowerSpec"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a3">limitHalfPowerSpec</a> (double lim)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Limits the maximum to 'lim' and returns the last fft bin with max.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="realFFTData::getSize"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a4">getSize</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the number of elements in the input and output arrays.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="realFFTData::getHalfSize"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a5">getHalfSize</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the number of elements in the power spectrum array.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="realFFTData::findMaxIn"></a>
fftw_real&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a6">findMaxIn</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the maximum input variable.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="realFFTData::findMaxMinPowerBins"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a7">findMaxMinPowerBins</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Fills the max and min power spectrum bins.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="realFFTData::compPowerSpec"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a8">compPowerSpec</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This function computes the power spectrum and returns the max bin.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="realFFTData::sqrtPowerSpec"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a9">sqrtPowerSpec</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This function computes the square root of the power spectrum and returns the max bin.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="realFFTData::zeroFFTData"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#a10">zeroFFTData</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This function zeros the output data array (out).</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="m0" doxytag="realFFTData::size"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m0">size</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Specifies the size of the data array.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m1" doxytag="realFFTData::minPowerBin"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m1">minPowerBin</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Specifies the minimum and maximum power bins as used in the methods findMaxMinPowerBins and compPowerSpec.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m2" doxytag="realFFTData::maxPowerBin"></a>
int&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m2">maxPowerBin</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Specifies the minimum and maximum power bins as used in the methods findMaxMinPowerBins and compPowerSpec.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m3" doxytag="realFFTData::in"></a>
fftw_real *&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m3">in</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>the input, output and power_spectrum arrays</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m4" doxytag="realFFTData::out"></a>
fftw_real *&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m4">out</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>the input, output and power_spectrum arrays</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m5" doxytag="realFFTData::power_spectrum"></a>
fftw_real *&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m5">power_spectrum</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>the input, output and power_spectrum arrays</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m6" doxytag="realFFTData::totalPower"></a>
double&nbsp;</td><td valign=bottom><a class="el" href="classrealFFTData.html#m6">totalPower</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The total power (summed) of the power spectrum as used in the method compPowerSpec.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
class realFFTData controls and manipulates fft data<dl compact><dt><b>Examples: </b></dt><dd>

<p>
<a class="el" href="realFFTExample_8cc-example.html#_a0">realFFTExample.cc</a>.</dl>
<p>

<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>.<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></ul>
<hr><address style="align: right;"><small>Generated on Sun Aug 10 20:34:00 2003 for MFFM FFTw Wrapper by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>