<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: FFTPlan 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classFFTPlan-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FFTPlan Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Thas class represents an plan object that allows to calculate FFTs and IFFTs.
<a href="classFFTPlan.html#details">More...</a></p>
<p><code>#include <<a class="el" href="FFTPlan_8h_source.html">FFTPlan.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:af8ca7ead6119f929384dba50deed8101"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#af8ca7ead6119f929384dba50deed8101">FFTPlan</a> (double measureTime=0)</td></tr>
<tr class="memdesc:af8ca7ead6119f929384dba50deed8101"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object with DEFAULT_N size (4096). <a href="#af8ca7ead6119f929384dba50deed8101">More...</a><br /></td></tr>
<tr class="separator:af8ca7ead6119f929384dba50deed8101"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a546396172e855f6abe2852558dd7aa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#a8a546396172e855f6abe2852558dd7aa">FFTPlan</a> (int n, double measureTime=0)</td></tr>
<tr class="memdesc:a8a546396172e855f6abe2852558dd7aa"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object with a custom size. <a href="#a8a546396172e855f6abe2852558dd7aa">More...</a><br /></td></tr>
<tr class="separator:a8a546396172e855f6abe2852558dd7aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a071743939a5c3148e87a32acdac87097"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#a071743939a5c3148e87a32acdac87097">getSize</a> ()</td></tr>
<tr class="memdesc:a071743939a5c3148e87a32acdac87097"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the size of the FFT plan. <a href="#a071743939a5c3148e87a32acdac87097">More...</a><br /></td></tr>
<tr class="separator:a071743939a5c3148e87a32acdac87097"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a795d16974d3ba4556ac4e9eaca4b4a37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#a795d16974d3ba4556ac4e9eaca4b4a37">FFT</a> (void *buffer)</td></tr>
<tr class="memdesc:a795d16974d3ba4556ac4e9eaca4b4a37"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the FFT of an input buffer with the current plan. <a href="#a795d16974d3ba4556ac4e9eaca4b4a37">More...</a><br /></td></tr>
<tr class="separator:a795d16974d3ba4556ac4e9eaca4b4a37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4e9871770c3f4da6cb4fcfec6f0aa6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#ad4e9871770c3f4da6cb4fcfec6f0aa6a">IFFT</a> (void *buffer)</td></tr>
<tr class="memdesc:ad4e9871770c3f4da6cb4fcfec6f0aa6a"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the IFFT of an input buffer with the current plan. <a href="#ad4e9871770c3f4da6cb4fcfec6f0aa6a">More...</a><br /></td></tr>
<tr class="separator:ad4e9871770c3f4da6cb4fcfec6f0aa6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64b7ff5f8a706f62ad38ecaf7feb925d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#a64b7ff5f8a706f62ad38ecaf7feb925d">getBuffer</a> ()</td></tr>
<tr class="memdesc:a64b7ff5f8a706f62ad38ecaf7feb925d"><td class="mdescLeft"> </td><td class="mdescRight">Reserves memory for a buffer that can be used for inplace transformations with this plan. <a href="#a64b7ff5f8a706f62ad38ecaf7feb925d">More...</a><br /></td></tr>
<tr class="separator:a64b7ff5f8a706f62ad38ecaf7feb925d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa10f7a78469ec8688441f593096e6b16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFTPlan.html#aa10f7a78469ec8688441f593096e6b16">freeBuffer</a> (void *buffer)</td></tr>
<tr class="memdesc:aa10f7a78469ec8688441f593096e6b16"><td class="mdescLeft"> </td><td class="mdescRight">Frees one of the buffers reserved with the getRealOnlyBuffer(), getComplexOnlyBuffer() or getInplaceBuffer() method. <a href="#aa10f7a78469ec8688441f593096e6b16">More...</a><br /></td></tr>
<tr class="separator:aa10f7a78469ec8688441f593096e6b16"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Thas class represents an plan object that allows to calculate FFTs and IFFTs. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="af8ca7ead6119f929384dba50deed8101"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8ca7ead6119f929384dba50deed8101">◆ </a></span>FFTPlan() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FFTPlan::FFTPlan </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>measureTime</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object with DEFAULT_N size (4096). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">measureTime</td><td>The aproximate amount of seconds that FFTW will spend searching for the optimal plan, which means faster FFTs and IFFTs while using this plan. If measureTime is negative, it will take all the time it needs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8a546396172e855f6abe2852558dd7aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a546396172e855f6abe2852558dd7aa">◆ </a></span>FFTPlan() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FFTPlan::FFTPlan </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>measureTime</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> object with a custom size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The size of the FFT plan. Values that are a power of two are faster. The useful range usually is between 2048 and 8192, but bigger values can be useful in certain situations (when using the <a class="el" href="classStreamBuffer.html" title="This sound creates a buffer out of a reader.">StreamBuffer</a> class per example). Generally, low values use more CPU power and are a bit faster than large ones, there is also a huge decrease in efficiency when n is lower than 2048. </td></tr>
<tr><td class="paramname">measureTime</td><td>The aproximate amount of seconds that FFTW will spend searching for the optimal plan, which means faster FFTs while using this plan. If measureTime is negative, it will take all the time it needs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a795d16974d3ba4556ac4e9eaca4b4a37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a795d16974d3ba4556ac4e9eaca4b4a37">◆ </a></span>FFT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FFTPlan::FFT </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the FFT of an input buffer with the current plan. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>A buffer with the input data an in which the output data will be written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa10f7a78469ec8688441f593096e6b16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa10f7a78469ec8688441f593096e6b16">◆ </a></span>freeBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FFTPlan::freeBuffer </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees one of the buffers reserved with the getRealOnlyBuffer(), getComplexOnlyBuffer() or getInplaceBuffer() method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>A pointer to the buufer taht must be freed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a64b7ff5f8a706f62ad38ecaf7feb925d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64b7ff5f8a706f62ad38ecaf7feb925d">◆ </a></span>getBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* FFTPlan::getBuffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserves memory for a buffer that can be used for inplace transformations with this plan. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a buffer of size ((N/2)+1)*2*sizeof(fftwf_complex). </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The returned buffer must be freed with the freeBuffer method of this class. </dd></dl>
</div>
</div>
<a id="a071743939a5c3148e87a32acdac87097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a071743939a5c3148e87a32acdac87097">◆ </a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FFTPlan::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the size of the FFT plan. </p>
<dl class="section return"><dt>Returns</dt><dd>The size of the plan. </dd></dl>
</div>
</div>
<a id="ad4e9871770c3f4da6cb4fcfec6f0aa6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4e9871770c3f4da6cb4fcfec6f0aa6a">◆ </a></span>IFFT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FFTPlan::IFFT </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the IFFT of an input buffer with the current plan. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>A buffer with the input data an in which the output data will be written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>util/<a class="el" href="FFTPlan_8h_source.html">FFTPlan.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
985
