Mercurial > hg > vamp-docs

comparison code-docs/classVamp_1_1FFT.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: Vamp::FFT Class Reference</title> 8 <title>VampPluginSDK: Vamp::FFT Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34
35 </td> 31 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
59 </ul>
60 </div>
61 </div>
62 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
63 <div id="nav-tree"> 48 <div id="nav-tree">
64 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
65 </div> 51 </div>
66 </div> 52 </div>
67 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
69 </div> 55 </div>
70 </div> 56 </div>
71 <script type="text/javascript"> 57 <script type="text/javascript">
72 initNavTree('classVamp_1_1FFT.html',''); 58 $(document).ready(function(){initNavTree('classVamp_1_1FFT.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-static-methods">Static Public Member Functions</a> </div> 63 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
64 <a href="classVamp_1_1FFT-members.html">List of all members</a> </div>
78 <div class="headertitle"> 65 <div class="headertitle">
79 <div class="title">Vamp::FFT Class Reference</div> </div> 66 <div class="title">Vamp::FFT Class Reference</div> </div>
80 </div><!--header--> 67 </div><!--header-->
81 <div class="contents"> 68 <div class="contents">
82 69
83 <p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> implementation provided for convenience of plugin authors. 70 <p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors.
84 <a href="classVamp_1_1FFT.html#details">More...</a></p> 71 <a href="classVamp_1_1FFT.html#details">More...</a></p>
85 72
86 <p><code>#include &lt;<a class="el" href="FFT_8h_source.html">FFT.h</a>&gt;</code></p> 73 <p><code>#include &lt;<a class="el" href="FFT_8h_source.html">FFT.h</a>&gt;</code></p>
87
88 <p><a href="classVamp_1_1FFT-members.html">List of all members.</a></p>
89 <table class="memberdecls"> 74 <table class="memberdecls">
90 <tr><td colspan="2"><h2><a name="pub-static-methods"></a> 75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
91 Static Public Member Functions</h2></td></tr> 76 Static Public Member Functions</h2></td></tr>
92 <tr class="memitem:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">forward</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr> 77 <tr class="memitem:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">forward</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr>
93 <tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca"></a><br/></td></tr> 78 <tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a one-shot forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca">More...</a><br /></td></tr>
79 <tr class="separator:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:aff98a3610275024cd3cb421e6283ee7f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">inverse</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr> 80 <tr class="memitem:aff98a3610275024cd3cb421e6283ee7f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">inverse</a> (unsigned int n, const double *ri, const double *ii, double *ro, double *io)</td></tr>
95 <tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate an inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f"></a><br/></td></tr> 81 <tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a one-shot inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f">More...</a><br /></td></tr>
96 </table> 82 <tr class="separator:aff98a3610275024cd3cb421e6283ee7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 83 </table>
98 <div class="textblock"><p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> implementation provided for convenience of plugin authors. </p> 84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
99 <p>This class provides double-precision FFTs in power-of-two sizes only. It is slower than more sophisticated library implementations. If these requirements aren't suitable, make other arrangements.</p> 85 <div class="textblock"><p>A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors. </p>
100 <p>The inverse transform is scaled by 1/n.</p> 86 <p>This class provides one-shot (i.e. fixed table state is recalculated every time) double-precision complex-complex transforms. For repeated transforms from real time-domain data, use an <a class="el" href="classVamp_1_1FFTComplex.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFTComplex</a> or <a class="el" href="classVamp_1_1FFTReal.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFTReal</a> object instead.</p>
101 <p>The implementation is from Don Cross's public domain <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> code. </p> 87 <p>Note: If the SDK has been compiled with the SINGLE_PRECISION_FFT flag, then all FFTs will use single precision internally. The default is double precision. The API uses doubles in either case.</p>
102 88 <p>The forward transform is unscaled; the inverse transform is scaled by 1/n. </p>
103 <p>Definition at line <a class="el" href="FFT_8h_source.html#l00058">58</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p> 89
104 </div><hr/><h2>Member Function Documentation</h2> 90 <p class="definition">Definition at line <a class="el" href="FFT_8h_source.html#l00059">59</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p>
105 <a class="anchor" id="a219e3f6f0392dbdacad4a47d912f9aca"></a> 91 </div><h2 class="groupheader">Member Function Documentation</h2>
92 <a id="a219e3f6f0392dbdacad4a47d912f9aca"></a>
93 <h2 class="memtitle"><span class="permalink"><a href="#a219e3f6f0392dbdacad4a47d912f9aca">&#9670;&nbsp;</a></span>forward()</h2>
94
106 <div class="memitem"> 95 <div class="memitem">
107 <div class="memproto"> 96 <div class="memproto">
97 <table class="mlabels">
98 <tr>
99 <td class="mlabels-left">
108 <table class="memname"> 100 <table class="memname">
109 <tr> 101 <tr>
110 <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">Vamp::FFT::forward</a> </td> 102 <td class="memname">static void Vamp::FFT::forward </td>
111 <td>(</td> 103 <td>(</td>
112 <td class="paramtype">unsigned int&#160;</td> 104 <td class="paramtype">unsigned int&#160;</td>
113 <td class="paramname"><em>n</em>, </td> 105 <td class="paramname"><em>n</em>, </td>
114 </tr> 106 </tr>
115 <tr> 107 <tr>
137 <td class="paramname"><em>io</em>&#160;</td> 129 <td class="paramname"><em>io</em>&#160;</td>
138 </tr> 130 </tr>
139 <tr> 131 <tr>
140 <td></td> 132 <td></td>
141 <td>)</td> 133 <td>)</td>
142 <td></td><td><code> [static]</code></td> 134 <td></td><td></td>
143 </tr> 135 </tr>
144 </table> 136 </table>
145 </div> 137 </td>
146 <div class="memdoc"> 138 <td class="mlabels-right">
147 139 <span class="mlabels"><span class="mlabel">static</span></span> </td>
148 <p>Calculate a forward transform of size n. </p> 140 </tr>
141 </table>
142 </div><div class="memdoc">
143
144 <p>Calculate a one-shot forward transform of size n. </p>
145 <p>n must be a multiple of 2.</p>
149 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> 146 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p>
150 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p> 147 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p>
151 <p>All input and output arrays are of size n. </p> 148 <p>All input and output arrays are of size n. </p>
152 149
153 </div> 150 </div>
154 </div> 151 </div>
155 <a class="anchor" id="aff98a3610275024cd3cb421e6283ee7f"></a> 152 <a id="aff98a3610275024cd3cb421e6283ee7f"></a>
153 <h2 class="memtitle"><span class="permalink"><a href="#aff98a3610275024cd3cb421e6283ee7f">&#9670;&nbsp;</a></span>inverse()</h2>
154
156 <div class="memitem"> 155 <div class="memitem">
157 <div class="memproto"> 156 <div class="memproto">
157 <table class="mlabels">
158 <tr>
159 <td class="mlabels-left">
158 <table class="memname"> 160 <table class="memname">
159 <tr> 161 <tr>
160 <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">Vamp::FFT::inverse</a> </td> 162 <td class="memname">static void Vamp::FFT::inverse </td>
161 <td>(</td> 163 <td>(</td>
162 <td class="paramtype">unsigned int&#160;</td> 164 <td class="paramtype">unsigned int&#160;</td>
163 <td class="paramname"><em>n</em>, </td> 165 <td class="paramname"><em>n</em>, </td>
164 </tr> 166 </tr>
165 <tr> 167 <tr>
187 <td class="paramname"><em>io</em>&#160;</td> 189 <td class="paramname"><em>io</em>&#160;</td>
188 </tr> 190 </tr>
189 <tr> 191 <tr>
190 <td></td> 192 <td></td>
191 <td>)</td> 193 <td>)</td>
192 <td></td><td><code> [static]</code></td> 194 <td></td><td></td>
193 </tr> 195 </tr>
194 </table> 196 </table>
195 </div> 197 </td>
196 <div class="memdoc"> 198 <td class="mlabels-right">
197 199 <span class="mlabels"><span class="mlabel">static</span></span> </td>
198 <p>Calculate an inverse transform of size n. </p> 200 </tr>
201 </table>
202 </div><div class="memdoc">
203
204 <p>Calculate a one-shot inverse transform of size n. </p>
205 <p>n must be a power of 2, greater than 1.</p>
199 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> 206 <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p>
200 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output. The output is scaled by 1/n. The output pointers may not be NULL, even if the output is expected to be real.</p> 207 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output. The output is scaled by 1/n. The output pointers may not be NULL, even if the output is expected to be real.</p>
201 <p>All input and output arrays are of size n. </p> 208 <p>All input and output arrays are of size n. </p>
202 209
203 </div> 210 </div>
204 </div> 211 </div>
205 <hr/>The documentation for this class was generated from the following file:<ul> 212 <hr/>The documentation for this class was generated from the following file:<ul>
206 <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li> 213 <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li>
207 </ul> 214 </ul>
208 </div><!-- contents --> 215 </div><!-- contents -->
209 </div> 216 </div><!-- doc-content -->
210 <div id="nav-path" class="navpath"> 217 <!-- start footer part -->
211 <ul> 218 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
212 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 219 <ul>
213 <li class="navelem"><a class="el" href="classVamp_1_1FFT.html">FFT</a> </li> 220 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1FFT.html">FFT</a></li>
214 221 <li class="footer">Generated by
215 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
216 <a href="http://www.doxygen.org/index.html"> 222 <a href="http://www.doxygen.org/index.html">
217 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 223 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
218 </ul> 224 </ul>
219 </div> 225 </div>
220
221
222 </body> 226 </body>
223 </html> 227 </html>