Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1FFT.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@3 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@3 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@3 3 <head>
Chris@3 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@3 8 <title>VampPluginSDK: Vamp::FFT Class Reference</title>
Chris@3 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@3 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@3 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@3 15 <script type="text/javascript" src="navtree.js"></script>
Chris@3 16 <script type="text/javascript">
Chris@3 17 $(document).ready(initResizable);
Chris@3 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@3 20 </head>
Chris@3 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@3 23 <div id="titlearea">
Chris@3 24 <table cellspacing="0" cellpadding="0">
Chris@3 25 <tbody>
Chris@3 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@3 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@3 30 </div>
Chris@3 31 </td>
Chris@3 32 </tr>
Chris@3 33 </tbody>
Chris@3 34 </table>
Chris@3 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@3 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@3 48 <div id="nav-tree">
Chris@3 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@3 51 </div>
Chris@3 52 </div>
Chris@3 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@3 54 class="ui-resizable-handle">
Chris@3 55 </div>
Chris@3 56 </div>
Chris@3 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('classVamp_1_1FFT.html','');});
Chris@3 59 </script>
Chris@3 60 <div id="doc-content">
Chris@3 61 <div class="header">
Chris@3 62 <div class="summary">
Chris@6 63 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
Chris@6 64 <a href="classVamp_1_1FFT-members.html">List of all members</a> </div>
Chris@3 65 <div class="headertitle">
Chris@3 66 <div class="title">Vamp::FFT Class Reference</div> </div>
Chris@3 67 </div><!--header-->
Chris@3 68 <div class="contents">
Chris@3 69
Chris@6 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.
Chris@3 71 <a href="classVamp_1_1FFT.html#details">More...</a></p>
Chris@3 72
Chris@3 73 <p><code>#include &lt;<a class="el" href="FFT_8h_source.html">FFT.h</a>&gt;</code></p>
Chris@3 74 <table class="memberdecls">
Chris@6 75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Chris@3 76 Static Public Member Functions</h2></td></tr>
Chris@3 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>
Chris@6 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>
Chris@6 79 <tr class="separator:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 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>
Chris@6 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>
Chris@6 82 <tr class="separator:aff98a3610275024cd3cb421e6283ee7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 83 </table>
Chris@6 84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@6 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>
Chris@6 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>
Chris@6 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>
Chris@6 88 <p>The forward transform is unscaled; the inverse transform is scaled by 1/n. </p>
Chris@3 89
Chris@6 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>
Chris@6 91 </div><h2 class="groupheader">Member Function Documentation</h2>
Chris@6 92 <a id="a219e3f6f0392dbdacad4a47d912f9aca"></a>
Chris@6 93 <h2 class="memtitle"><span class="permalink"><a href="#a219e3f6f0392dbdacad4a47d912f9aca">&#9670;&nbsp;</a></span>forward()</h2>
Chris@6 94
Chris@3 95 <div class="memitem">
Chris@3 96 <div class="memproto">
Chris@6 97 <table class="mlabels">
Chris@6 98 <tr>
Chris@6 99 <td class="mlabels-left">
Chris@3 100 <table class="memname">
Chris@3 101 <tr>
Chris@6 102 <td class="memname">static void Vamp::FFT::forward </td>
Chris@3 103 <td>(</td>
Chris@3 104 <td class="paramtype">unsigned int&#160;</td>
Chris@3 105 <td class="paramname"><em>n</em>, </td>
Chris@3 106 </tr>
Chris@3 107 <tr>
Chris@3 108 <td class="paramkey"></td>
Chris@3 109 <td></td>
Chris@3 110 <td class="paramtype">const double *&#160;</td>
Chris@3 111 <td class="paramname"><em>ri</em>, </td>
Chris@3 112 </tr>
Chris@3 113 <tr>
Chris@3 114 <td class="paramkey"></td>
Chris@3 115 <td></td>
Chris@3 116 <td class="paramtype">const double *&#160;</td>
Chris@3 117 <td class="paramname"><em>ii</em>, </td>
Chris@3 118 </tr>
Chris@3 119 <tr>
Chris@3 120 <td class="paramkey"></td>
Chris@3 121 <td></td>
Chris@3 122 <td class="paramtype">double *&#160;</td>
Chris@3 123 <td class="paramname"><em>ro</em>, </td>
Chris@3 124 </tr>
Chris@3 125 <tr>
Chris@3 126 <td class="paramkey"></td>
Chris@3 127 <td></td>
Chris@3 128 <td class="paramtype">double *&#160;</td>
Chris@3 129 <td class="paramname"><em>io</em>&#160;</td>
Chris@3 130 </tr>
Chris@3 131 <tr>
Chris@3 132 <td></td>
Chris@3 133 <td>)</td>
Chris@6 134 <td></td><td></td>
Chris@3 135 </tr>
Chris@3 136 </table>
Chris@6 137 </td>
Chris@6 138 <td class="mlabels-right">
Chris@6 139 <span class="mlabels"><span class="mlabel">static</span></span> </td>
Chris@6 140 </tr>
Chris@6 141 </table>
Chris@6 142 </div><div class="memdoc">
Chris@3 143
Chris@6 144 <p>Calculate a one-shot forward transform of size n. </p>
Chris@6 145 <p>n must be a multiple of 2.</p>
Chris@3 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>
Chris@3 147 <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p>
Chris@3 148 <p>All input and output arrays are of size n. </p>
Chris@3 149
Chris@3 150 </div>
Chris@3 151 </div>
Chris@6 152 <a id="aff98a3610275024cd3cb421e6283ee7f"></a>
Chris@6 153 <h2 class="memtitle"><span class="permalink"><a href="#aff98a3610275024cd3cb421e6283ee7f">&#9670;&nbsp;</a></span>inverse()</h2>
Chris@6 154
Chris@3 155 <div class="memitem">
Chris@3 156 <div class="memproto">
Chris@6 157 <table class="mlabels">
Chris@6 158 <tr>
Chris@6 159 <td class="mlabels-left">
Chris@3 160 <table class="memname">
Chris@3 161 <tr>
Chris@6 162 <td class="memname">static void Vamp::FFT::inverse </td>
Chris@3 163 <td>(</td>
Chris@3 164 <td class="paramtype">unsigned int&#160;</td>
Chris@3 165 <td class="paramname"><em>n</em>, </td>
Chris@3 166 </tr>
Chris@3 167 <tr>
Chris@3 168 <td class="paramkey"></td>
Chris@3 169 <td></td>
Chris@3 170 <td class="paramtype">const double *&#160;</td>
Chris@3 171 <td class="paramname"><em>ri</em>, </td>
Chris@3 172 </tr>
Chris@3 173 <tr>
Chris@3 174 <td class="paramkey"></td>
Chris@3 175 <td></td>
Chris@3 176 <td class="paramtype">const double *&#160;</td>
Chris@3 177 <td class="paramname"><em>ii</em>, </td>
Chris@3 178 </tr>
Chris@3 179 <tr>
Chris@3 180 <td class="paramkey"></td>
Chris@3 181 <td></td>
Chris@3 182 <td class="paramtype">double *&#160;</td>
Chris@3 183 <td class="paramname"><em>ro</em>, </td>
Chris@3 184 </tr>
Chris@3 185 <tr>
Chris@3 186 <td class="paramkey"></td>
Chris@3 187 <td></td>
Chris@3 188 <td class="paramtype">double *&#160;</td>
Chris@3 189 <td class="paramname"><em>io</em>&#160;</td>
Chris@3 190 </tr>
Chris@3 191 <tr>
Chris@3 192 <td></td>
Chris@3 193 <td>)</td>
Chris@6 194 <td></td><td></td>
Chris@3 195 </tr>
Chris@3 196 </table>
Chris@6 197 </td>
Chris@6 198 <td class="mlabels-right">
Chris@6 199 <span class="mlabels"><span class="mlabel">static</span></span> </td>
Chris@6 200 </tr>
Chris@6 201 </table>
Chris@6 202 </div><div class="memdoc">
Chris@3 203
Chris@6 204 <p>Calculate a one-shot inverse transform of size n. </p>
Chris@6 205 <p>n must be a power of 2, greater than 1.</p>
Chris@3 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>
Chris@3 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>
Chris@3 208 <p>All input and output arrays are of size n. </p>
Chris@3 209
Chris@3 210 </div>
Chris@3 211 </div>
Chris@3 212 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@3 213 <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li>
Chris@3 214 </ul>
Chris@3 215 </div><!-- contents -->
Chris@6 216 </div><!-- doc-content -->
Chris@6 217 <!-- start footer part -->
Chris@6 218 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 219 <ul>
Chris@6 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>
Chris@6 221 <li class="footer">Generated by
Chris@6 222 <a href="http://www.doxygen.org/index.html">
Chris@6 223 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 224 </ul>
Chris@3 225 </div>
Chris@3 226 </body>
Chris@3 227 </html>