ref: cc0694e2a5c399faada2396980745338930e1c38
dir: /docs/leaf/group__tonezero.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: tOneZero</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">tOneZero<div class="ingroups"><a class="el" href="group__filters.html">Filters</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>OneZero filter, reimplemented from STK (Cook and Scavone).
<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:gabbd3ddafbab517a2c66e91d8e68f71f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#gabbd3ddafbab517a2c66e91d8e68f71f7">tOneZero_init</a> (tOneZero *const, float theZero, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gabbd3ddafbab517a2c66e91d8e68f71f7"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tOneZero 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__tonezero.html#gabbd3ddafbab517a2c66e91d8e68f71f7">More...</a><br /></td></tr>
<tr class="separator:gabbd3ddafbab517a2c66e91d8e68f71f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8148897bb39a76c5368f740d532c774b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga8148897bb39a76c5368f740d532c774b">tOneZero_initToPool</a> (tOneZero *const, float theZero, tMempool *const)</td></tr>
<tr class="memdesc:ga8148897bb39a76c5368f740d532c774b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tOneZero to a specified mempool. <a href="group__tonezero.html#ga8148897bb39a76c5368f740d532c774b">More...</a><br /></td></tr>
<tr class="separator:ga8148897bb39a76c5368f740d532c774b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga06bbbfdb22d7b291f73489981c311bc0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga06bbbfdb22d7b291f73489981c311bc0">tOneZero_free</a> (tOneZero *const)</td></tr>
<tr class="memdesc:ga06bbbfdb22d7b291f73489981c311bc0"><td class="mdescLeft"> </td><td class="mdescRight">Free a tOneZero from its mempool. <a href="group__tonezero.html#ga06bbbfdb22d7b291f73489981c311bc0">More...</a><br /></td></tr>
<tr class="separator:ga06bbbfdb22d7b291f73489981c311bc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d49fd94313454e219b43e1fa3175d12"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga5d49fd94313454e219b43e1fa3175d12">tOneZero_tick</a> (tOneZero *const, float input)</td></tr>
<tr class="separator:ga5d49fd94313454e219b43e1fa3175d12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga98cda6f603769e6ad842f869c751b5b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga98cda6f603769e6ad842f869c751b5b8">tOneZero_setB0</a> (tOneZero *const, float b0)</td></tr>
<tr class="separator:ga98cda6f603769e6ad842f869c751b5b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga02db3ca6e4e8d321a4730e4ea2b58f6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga02db3ca6e4e8d321a4730e4ea2b58f6c">tOneZero_setB1</a> (tOneZero *const, float b1)</td></tr>
<tr class="separator:ga02db3ca6e4e8d321a4730e4ea2b58f6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0827232a84f1d39e418459d9d53c977"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#gaf0827232a84f1d39e418459d9d53c977">tOneZero_setZero</a> (tOneZero *const, float theZero)</td></tr>
<tr class="separator:gaf0827232a84f1d39e418459d9d53c977"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf460819e3f35c5759cc1f6707f2bda86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#gaf460819e3f35c5759cc1f6707f2bda86">tOneZero_setCoefficients</a> (tOneZero *const, float b0, float b1)</td></tr>
<tr class="separator:gaf460819e3f35c5759cc1f6707f2bda86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f7ad30df1a802a5db5b8b4f6465c993"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#ga6f7ad30df1a802a5db5b8b4f6465c993">tOneZero_setGain</a> (tOneZero *const, float gain)</td></tr>
<tr class="separator:ga6f7ad30df1a802a5db5b8b4f6465c993"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae93bd56798868c1022fa025c62126bfe"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tonezero.html#gae93bd56798868c1022fa025c62126bfe">tOneZero_getPhaseDelay</a> (tOneZero *f, float frequency)</td></tr>
<tr class="separator:gae93bd56798868c1022fa025c62126bfe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>OneZero filter, reimplemented from STK (Cook and Scavone). </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabbd3ddafbab517a2c66e91d8e68f71f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabbd3ddafbab517a2c66e91d8e68f71f7">◆ </a></span>tOneZero_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_init </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>theZero</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 tOneZero 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 tSlide 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="ga8148897bb39a76c5368f740d532c774b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8148897bb39a76c5368f740d532c774b">◆ </a></span>tOneZero_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_initToPool </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>theZero</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 tOneZero 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 tOneZero 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="ga06bbbfdb22d7b291f73489981c311bc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06bbbfdb22d7b291f73489981c311bc0">◆ </a></span>tOneZero_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_free </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tOneZero 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 tOneZero to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5d49fd94313454e219b43e1fa3175d12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d49fd94313454e219b43e1fa3175d12">◆ </a></span>tOneZero_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tOneZero_tick </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>input</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga98cda6f603769e6ad842f869c751b5b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga98cda6f603769e6ad842f869c751b5b8">◆ </a></span>tOneZero_setB0()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_setB0 </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>b0</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga02db3ca6e4e8d321a4730e4ea2b58f6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga02db3ca6e4e8d321a4730e4ea2b58f6c">◆ </a></span>tOneZero_setB1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_setB1 </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>b1</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf0827232a84f1d39e418459d9d53c977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0827232a84f1d39e418459d9d53c977">◆ </a></span>tOneZero_setZero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_setZero </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>theZero</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf460819e3f35c5759cc1f6707f2bda86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf460819e3f35c5759cc1f6707f2bda86">◆ </a></span>tOneZero_setCoefficients()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_setCoefficients </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>b0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>b1</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6f7ad30df1a802a5db5b8b4f6465c993"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f7ad30df1a802a5db5b8b4f6465c993">◆ </a></span>tOneZero_setGain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOneZero_setGain </td>
<td>(</td>
<td class="paramtype">tOneZero * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>gain</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 tOneZero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae93bd56798868c1022fa025c62126bfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae93bd56798868c1022fa025c62126bfe">◆ </a></span>tOneZero_getPhaseDelay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tOneZero_getPhaseDelay </td>
<td>(</td>
<td class="paramtype">tOneZero * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>frequency</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 tOneZero.  </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>