ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__tpolezero.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: tPoleZero</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">tPoleZero<div class="ingroups"><a class="el" href="group__filters.html">Filters</a></div></div> </div> </div><!--header--> <div class="contents"> <p>PoleZero 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:ga6b6829aefeb5180022ae0b7e8d5b9b1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga6b6829aefeb5180022ae0b7e8d5b9b1c">tPoleZero_init</a> (tPoleZero *const, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:ga6b6829aefeb5180022ae0b7e8d5b9b1c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPoleZero 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__tpolezero.html#ga6b6829aefeb5180022ae0b7e8d5b9b1c">More...</a><br /></td></tr> <tr class="separator:ga6b6829aefeb5180022ae0b7e8d5b9b1c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadb9f2207e2217190013543ce210c5dda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#gadb9f2207e2217190013543ce210c5dda">tPoleZero_initToPool</a> (tPoleZero *const, tMempool *const)</td></tr> <tr class="memdesc:gadb9f2207e2217190013543ce210c5dda"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPoleZero to a specified mempool. <a href="group__tpolezero.html#gadb9f2207e2217190013543ce210c5dda">More...</a><br /></td></tr> <tr class="separator:gadb9f2207e2217190013543ce210c5dda"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf66d289f3a48e83eb6d77acedd7cea74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#gaf66d289f3a48e83eb6d77acedd7cea74">tPoleZero_free</a> (tPoleZero *const)</td></tr> <tr class="memdesc:gaf66d289f3a48e83eb6d77acedd7cea74"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPoleZero from its mempool. <a href="group__tpolezero.html#gaf66d289f3a48e83eb6d77acedd7cea74">More...</a><br /></td></tr> <tr class="separator:gaf66d289f3a48e83eb6d77acedd7cea74"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4e024338fe577882f52494f525488d32"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga4e024338fe577882f52494f525488d32">tPoleZero_tick</a> (tPoleZero *const, float input)</td></tr> <tr class="separator:ga4e024338fe577882f52494f525488d32"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga896a83342ee3ea486f171d872b9809b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga896a83342ee3ea486f171d872b9809b0">tPoleZero_setB0</a> (tPoleZero *const, float b0)</td></tr> <tr class="separator:ga896a83342ee3ea486f171d872b9809b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4c6d29a676d98f4d57e0f8078ab61279"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga4c6d29a676d98f4d57e0f8078ab61279">tPoleZero_setB1</a> (tPoleZero *const, float b1)</td></tr> <tr class="separator:ga4c6d29a676d98f4d57e0f8078ab61279"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga118daf1002dcd0d5c24b2d86af9196fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga118daf1002dcd0d5c24b2d86af9196fb">tPoleZero_setA1</a> (tPoleZero *const, float a1)</td></tr> <tr class="separator:ga118daf1002dcd0d5c24b2d86af9196fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9b72bcea9b5912e4ecd62c7ea7d99b86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga9b72bcea9b5912e4ecd62c7ea7d99b86">tPoleZero_setCoefficients</a> (tPoleZero *const, float b0, float b1, float a1)</td></tr> <tr class="separator:ga9b72bcea9b5912e4ecd62c7ea7d99b86"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab978639dd9badc640b1f3a8b6a945b06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#gab978639dd9badc640b1f3a8b6a945b06">tPoleZero_setAllpass</a> (tPoleZero *const, float coeff)</td></tr> <tr class="separator:gab978639dd9badc640b1f3a8b6a945b06"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga863c1114d2a571d158fc74dd7f1ec06c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga863c1114d2a571d158fc74dd7f1ec06c">tPoleZero_setBlockZero</a> (tPoleZero *const, float thePole)</td></tr> <tr class="separator:ga863c1114d2a571d158fc74dd7f1ec06c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8bdd8dfb8e5c22c7ec820bea559e2fa7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpolezero.html#ga8bdd8dfb8e5c22c7ec820bea559e2fa7">tPoleZero_setGain</a> (tPoleZero *const, float gain)</td></tr> <tr class="separator:ga8bdd8dfb8e5c22c7ec820bea559e2fa7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>PoleZero filter, reimplemented from STK (Cook and Scavone). </p> <h2 class="groupheader">Function Documentation</h2> <a id="ga6b6829aefeb5180022ae0b7e8d5b9b1c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6b6829aefeb5180022ae0b7e8d5b9b1c">◆ </a></span>tPoleZero_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_init </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname">, </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 tPoleZero 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 tPoleZero 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="gadb9f2207e2217190013543ce210c5dda"></a> <h2 class="memtitle"><span class="permalink"><a href="#gadb9f2207e2217190013543ce210c5dda">◆ </a></span>tPoleZero_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_initToPool </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname">, </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 tPoleZero 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 tPoleZero 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="gaf66d289f3a48e83eb6d77acedd7cea74"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf66d289f3a48e83eb6d77acedd7cea74">◆ </a></span>tPoleZero_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_free </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tPoleZero 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 tPoleZero to free. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga4e024338fe577882f52494f525488d32"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4e024338fe577882f52494f525488d32">◆ </a></span>tPoleZero_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPoleZero_tick </td> <td>(</td> <td class="paramtype">tPoleZero * 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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga896a83342ee3ea486f171d872b9809b0"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga896a83342ee3ea486f171d872b9809b0">◆ </a></span>tPoleZero_setB0()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setB0 </td> <td>(</td> <td class="paramtype">tPoleZero * 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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga4c6d29a676d98f4d57e0f8078ab61279"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4c6d29a676d98f4d57e0f8078ab61279">◆ </a></span>tPoleZero_setB1()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setB1 </td> <td>(</td> <td class="paramtype">tPoleZero * 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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga118daf1002dcd0d5c24b2d86af9196fb"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga118daf1002dcd0d5c24b2d86af9196fb">◆ </a></span>tPoleZero_setA1()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setA1 </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>a1</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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga9b72bcea9b5912e4ecd62c7ea7d99b86"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9b72bcea9b5912e4ecd62c7ea7d99b86">◆ </a></span>tPoleZero_setCoefficients()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setCoefficients </td> <td>(</td> <td class="paramtype">tPoleZero * 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 class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>a1</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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="gab978639dd9badc640b1f3a8b6a945b06"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab978639dd9badc640b1f3a8b6a945b06">◆ </a></span>tPoleZero_setAllpass()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setAllpass </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>coeff</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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga863c1114d2a571d158fc74dd7f1ec06c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga863c1114d2a571d158fc74dd7f1ec06c">◆ </a></span>tPoleZero_setBlockZero()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setBlockZero </td> <td>(</td> <td class="paramtype">tPoleZero * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>thePole</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 tPoleZero. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga8bdd8dfb8e5c22c7ec820bea559e2fa7"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8bdd8dfb8e5c22c7ec820bea559e2fa7">◆ </a></span>tPoleZero_setGain()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPoleZero_setGain </td> <td>(</td> <td class="paramtype">tPoleZero * 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 tPoleZero.</td></tr> </table> </dd> </dl> <p> </p> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>