Mercurial > hg > vamp-docs
view code-docs/classVamp_1_1FFT.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
author | Chris Cannam |
---|---|
date | Fri, 13 Jul 2012 13:30:27 +0100 |
parents | |
children | 27319718b1f8 |
line wrap: on
line source
<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>VampPluginSDK: Vamp::FFT Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.4</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.8.0 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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="dirs.html"><span>Directories</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classVamp_1_1FFT.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Vamp::FFT Class Reference</div> </div> </div><!--header--> <div class="contents"> <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. <a href="classVamp_1_1FFT.html#details">More...</a></p> <p><code>#include <<a class="el" href="FFT_8h_source.html">FFT.h</a>></code></p> <p><a href="classVamp_1_1FFT-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memItemLeft" align="right" valign="top">static void </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> <tr class="memdesc:a219e3f6f0392dbdacad4a47d912f9aca"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a forward transform of size n. <a href="#a219e3f6f0392dbdacad4a47d912f9aca"></a><br/></td></tr> <tr class="memitem:aff98a3610275024cd3cb421e6283ee7f"><td class="memItemLeft" align="right" valign="top">static void </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> <tr class="memdesc:aff98a3610275024cd3cb421e6283ee7f"><td class="mdescLeft"> </td><td class="mdescRight">Calculate an inverse transform of size n. <a href="#aff98a3610275024cd3cb421e6283ee7f"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <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> <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> <p>The inverse transform is scaled by 1/n.</p> <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> <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> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a219e3f6f0392dbdacad4a47d912f9aca"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#a219e3f6f0392dbdacad4a47d912f9aca">Vamp::FFT::forward</a> </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double * </td> <td class="paramname"><em>ri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double * </td> <td class="paramname"><em>ii</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>ro</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>io</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Calculate a forward transform of size n. </p> <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> <p>ro and io must point to enough space to receive the real and imaginary component arrays of the output.</p> <p>All input and output arrays are of size n. </p> </div> </div> <a class="anchor" id="aff98a3610275024cd3cb421e6283ee7f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void <a class="el" href="classVamp_1_1FFT.html#aff98a3610275024cd3cb421e6283ee7f">Vamp::FFT::inverse</a> </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double * </td> <td class="paramname"><em>ri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double * </td> <td class="paramname"><em>ii</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>ro</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>io</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Calculate an inverse transform of size n. </p> <p>ri and ii must point to the real and imaginary component arrays of the input. For real input, ii may be NULL.</p> <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> <p>All input and output arrays are of size n. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="FFT_8h_source.html">FFT.h</a></li> </ul> </div><!-- contents --> </div> <div id="nav-path" class="navpath"> <ul> <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> <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div> </body> </html>