Mercurial > hg > vamp-docs

view 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
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::FFT 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
   &#160;<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_1FFT.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classVamp_1_1FFT-members.html">List of all members</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 &lt;<a class="el" href="FFT_8h_source.html">FFT.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><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&#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>
<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>
<tr class="separator:a219e3f6f0392dbdacad4a47d912f9aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:aff98a3610275024cd3cb421e6283ee7f"><td class="memSeparator" colspan="2">&#160;</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 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>
<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#l00059">59</a> of file <a class="el" href="FFT_8h_source.html">FFT.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a219e3f6f0392dbdacad4a47d912f9aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a219e3f6f0392dbdacad4a47d912f9aca">&#9670;&nbsp;</a></span>forward()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void Vamp::FFT::forward </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const double *&#160;</td>
          <td class="paramname"><em>ri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const double *&#160;</td>
          <td class="paramname"><em>ii</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>ro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>io</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Calculate a one-shot forward transform of size n. </p>
<p>n must be a multiple of 2.</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 id="aff98a3610275024cd3cb421e6283ee7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff98a3610275024cd3cb421e6283ee7f">&#9670;&nbsp;</a></span>inverse()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void Vamp::FFT::inverse </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const double *&#160;</td>
          <td class="paramname"><em>ri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const double *&#160;</td>
          <td class="paramname"><em>ii</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>ro</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>io</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Calculate a one-shot inverse transform of size n. </p>
<p>n must be a power of 2, greater than 1.</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><!-- 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_1FFT.html">FFT</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>