Mercurial > hg > vamp-docs
view code-docs/classVamp_1_1FFTComplex.html @ 7:66d125fb8b42 tip
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 |
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"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: Vamp::FFTComplex Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classVamp_1_1FFTComplex.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> | <a href="classVamp_1_1FFTComplex-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Vamp::FFTComplex 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_1FFTComplex.html#details">More...</a></p> <p><code>#include <<a class="el" href="FFT_8h_source.html">FFT.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ab73b793c7d1bf5ed175ff4aa0cec5190"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html#ab73b793c7d1bf5ed175ff4aa0cec5190">FFTComplex</a> (unsigned int n)</td></tr> <tr class="memdesc:ab73b793c7d1bf5ed175ff4aa0cec5190"><td class="mdescLeft"> </td><td class="mdescRight">Prepare to calculate transforms of size n. <a href="#ab73b793c7d1bf5ed175ff4aa0cec5190">More...</a><br /></td></tr> <tr class="separator:ab73b793c7d1bf5ed175ff4aa0cec5190"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5b108c655e5c73ee3ba6881ddd7c40a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html#a5b108c655e5c73ee3ba6881ddd7c40a6">~FFTComplex</a> ()</td></tr> <tr class="separator:a5b108c655e5c73ee3ba6881ddd7c40a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab09f93ce626fe41513f33dd9ab54518d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html#ab09f93ce626fe41513f33dd9ab54518d">forward</a> (const double *ci, double *co)</td></tr> <tr class="memdesc:ab09f93ce626fe41513f33dd9ab54518d"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a forward transform of size n. <a href="#ab09f93ce626fe41513f33dd9ab54518d">More...</a><br /></td></tr> <tr class="separator:ab09f93ce626fe41513f33dd9ab54518d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa392c6a7dbcc2cc6a1edeac6da4c435b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html#aa392c6a7dbcc2cc6a1edeac6da4c435b">inverse</a> (const double *ci, double *co)</td></tr> <tr class="memdesc:aa392c6a7dbcc2cc6a1edeac6da4c435b"><td class="mdescLeft"> </td><td class="mdescRight">Calculate an inverse transform of size n. <a href="#aa392c6a7dbcc2cc6a1edeac6da4c435b">More...</a><br /></td></tr> <tr class="separator:aa392c6a7dbcc2cc6a1edeac6da4c435b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr class="memitem:aa521eef4194d91d2c48d07ed5f6d7f5f"><td class="memItemLeft" align="right" valign="top">D * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html#aa521eef4194d91d2c48d07ed5f6d7f5f">m_d</a></td></tr> <tr class="separator:aa521eef4194d91d2c48d07ed5f6d7f5f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">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 complex-complex transforms.</p> <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> <p>The forward transform is unscaled; the inverse transform is scaled by 1/n. </p> <p class="definition">Definition at line <a class="el" href="FFT_8h_source.html#l00109">109</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="ab73b793c7d1bf5ed175ff4aa0cec5190"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab73b793c7d1bf5ed175ff4aa0cec5190">◆ </a></span>FFTComplex()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Vamp::FFTComplex::FFTComplex </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>n</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Prepare to calculate transforms of size n. </p> <p>n must be a multiple of 2. </p> </div> </div> <a id="a5b108c655e5c73ee3ba6881ddd7c40a6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5b108c655e5c73ee3ba6881ddd7c40a6">◆ </a></span>~FFTComplex()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Vamp::FFTComplex::~FFTComplex </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="ab09f93ce626fe41513f33dd9ab54518d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab09f93ce626fe41513f33dd9ab54518d">◆ </a></span>forward()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Vamp::FFTComplex::forward </td> <td>(</td> <td class="paramtype">const double * </td> <td class="paramname"><em>ci</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>co</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate a forward transform of size n. </p> <p>ci must point to the interleaved complex input data of size n (that is, 2n doubles in total).</p> <p>co must point to enough space to receive an interleaved complex output array of size n (that is, 2n doubles in total). </p> </div> </div> <a id="aa392c6a7dbcc2cc6a1edeac6da4c435b"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa392c6a7dbcc2cc6a1edeac6da4c435b">◆ </a></span>inverse()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Vamp::FFTComplex::inverse </td> <td>(</td> <td class="paramtype">const double * </td> <td class="paramname"><em>ci</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>co</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate an inverse transform of size n. </p> <p>ci must point to an interleaved complex input array of size n (that is, 2n doubles in total).</p> <p>co must point to enough space to receive the interleaved complex output data of size n (that is, 2n doubles in total). The output is scaled by 1/n. </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="aa521eef4194d91d2c48d07ed5f6d7f5f"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa521eef4194d91d2c48d07ed5f6d7f5f">◆ </a></span>m_d</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">D* Vamp::FFTComplex::m_d</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="FFT_8h_source.html#l00144">144</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</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><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1FFTComplex.html">FFTComplex</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>