ref: c38b5b8fbda3d691abd51b3e10410a95b5b1a10a
dir: /docs/leaf/group__tsvf.html/
<!-- HTML header for doxygen 1.8.18-->
<!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.16" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LEAF: tSVF</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>
<script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
<!-- <script src="/js/template.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
<div>
<!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
</div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<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>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tSVF<div class="ingroups"><a class="el" href="group__filters.html">Filters</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>State Variable Filter, algorithm from Andy Simper.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaec95a0aaf02ed9170ea1a4e968acd82d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#gaec95a0aaf02ed9170ea1a4e968acd82d">tSVF_init</a> (tSVF *const, SVFType type, float freq, float Q, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gaec95a0aaf02ed9170ea1a4e968acd82d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tSVF to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tsvf.html#gaec95a0aaf02ed9170ea1a4e968acd82d">More...</a><br /></td></tr>
<tr class="separator:gaec95a0aaf02ed9170ea1a4e968acd82d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcf663debbb880724f1c423c9d37d143"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#gabcf663debbb880724f1c423c9d37d143">tSVF_initToPool</a> (tSVF *const, SVFType type, float freq, float Q, tMempool *const)</td></tr>
<tr class="memdesc:gabcf663debbb880724f1c423c9d37d143"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tSVF to a specified mempool. <a href="group__tsvf.html#gabcf663debbb880724f1c423c9d37d143">More...</a><br /></td></tr>
<tr class="separator:gabcf663debbb880724f1c423c9d37d143"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga364e2d82cc7d843ccf63c32f6b6f6c28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#ga364e2d82cc7d843ccf63c32f6b6f6c28">tSVF_free</a> (tSVF *const)</td></tr>
<tr class="memdesc:ga364e2d82cc7d843ccf63c32f6b6f6c28"><td class="mdescLeft"> </td><td class="mdescRight">Free a tSVF from its mempool. <a href="group__tsvf.html#ga364e2d82cc7d843ccf63c32f6b6f6c28">More...</a><br /></td></tr>
<tr class="separator:ga364e2d82cc7d843ccf63c32f6b6f6c28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef34c602f1f798b4e3200c02a09e193b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#gaef34c602f1f798b4e3200c02a09e193b">tSVF_tick</a> (tSVF *const, float v0)</td></tr>
<tr class="separator:gaef34c602f1f798b4e3200c02a09e193b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b3d320a8d7991a002fa344d23780c78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#ga3b3d320a8d7991a002fa344d23780c78">tSVF_setFreq</a> (tSVF *const, float freq)</td></tr>
<tr class="separator:ga3b3d320a8d7991a002fa344d23780c78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29e6205846d379ffdd4131d0174c8784"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#ga29e6205846d379ffdd4131d0174c8784">tSVF_setQ</a> (tSVF *const, float Q)</td></tr>
<tr class="separator:ga29e6205846d379ffdd4131d0174c8784"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf86bb651efd0ad3c7e782c71719e7a0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsvf.html#gaf86bb651efd0ad3c7e782c71719e7a0f">tSVF_setFreqAndQ</a> (tSVF *const svff, float freq, float Q)</td></tr>
<tr class="separator:gaf86bb651efd0ad3c7e782c71719e7a0f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>State Variable Filter, algorithm from Andy Simper. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaec95a0aaf02ed9170ea1a4e968acd82d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec95a0aaf02ed9170ea1a4e968acd82d">◆ </a></span>tSVF_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_init </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SVFType </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>Q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td>
<td class="paramname"><em>leaf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tSVF to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the tSVF to initialize. </td></tr>
<tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabcf663debbb880724f1c423c9d37d143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabcf663debbb880724f1c423c9d37d143">◆ </a></span>tSVF_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_initToPool </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SVFType </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>Q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tMempool * const </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tSVF to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the tSVF to initialize. </td></tr>
<tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga364e2d82cc7d843ccf63c32f6b6f6c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga364e2d82cc7d843ccf63c32f6b6f6c28">◆ </a></span>tSVF_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_free </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tSVF from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the tSVF to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaef34c602f1f798b4e3200c02a09e193b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef34c602f1f798b4e3200c02a09e193b">◆ </a></span>tSVF_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tSVF_tick </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>v0</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the relevant tSVF. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3b3d320a8d7991a002fa344d23780c78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b3d320a8d7991a002fa344d23780c78">◆ </a></span>tSVF_setFreq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_setFreq </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>freq</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the relevant tSVF. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga29e6205846d379ffdd4131d0174c8784"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29e6205846d379ffdd4131d0174c8784">◆ </a></span>tSVF_setQ()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_setQ </td>
<td>(</td>
<td class="paramtype">tSVF * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>Q</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the relevant tSVF. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf86bb651efd0ad3c7e782c71719e7a0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf86bb651efd0ad3c7e782c71719e7a0f">◆ </a></span>tSVF_setFreqAndQ()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tSVF_setFreqAndQ </td>
<td>(</td>
<td class="paramtype">tSVF *const </td>
<td class="paramname"><em>svff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>Q</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>A pointer to the relevant tSVF.  </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>