ref: c38b5b8fbda3d691abd51b3e10410a95b5b1a10a
dir: /docs/leaf/group__tbutterworth.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: tButterworth</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">tButterworth<div class="ingroups"><a class="el" href="group__filters.html">Filters</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Butterworth filter.
<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:ga567582dd961193c6a49ebcb5f78db211"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#ga567582dd961193c6a49ebcb5f78db211">tButterworth_initToPool</a> (tButterworth *const, int N, float f1, float f2, tMempool *const)</td></tr>
<tr class="memdesc:ga567582dd961193c6a49ebcb5f78db211"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tButterworth to a specified mempool. <a href="group__tbutterworth.html#ga567582dd961193c6a49ebcb5f78db211">More...</a><br /></td></tr>
<tr class="separator:ga567582dd961193c6a49ebcb5f78db211"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga340f64a2f39d6a75dddbff0664c6a0c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#ga340f64a2f39d6a75dddbff0664c6a0c2">tButterworth_free</a> (tButterworth *const)</td></tr>
<tr class="memdesc:ga340f64a2f39d6a75dddbff0664c6a0c2"><td class="mdescLeft"> </td><td class="mdescRight">Free a tButterworth from its mempool. <a href="group__tbutterworth.html#ga340f64a2f39d6a75dddbff0664c6a0c2">More...</a><br /></td></tr>
<tr class="separator:ga340f64a2f39d6a75dddbff0664c6a0c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac4729b8e622da0d570efe80ac1c54707"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#gac4729b8e622da0d570efe80ac1c54707">tButterworth_tick</a> (tButterworth *const, float input)</td></tr>
<tr class="separator:gac4729b8e622da0d570efe80ac1c54707"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12a4c927d24d1664d0beb425cf64e284"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#ga12a4c927d24d1664d0beb425cf64e284">tButterworth_setF1</a> (tButterworth *const, float in)</td></tr>
<tr class="separator:ga12a4c927d24d1664d0beb425cf64e284"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga86218245c60fb73eec98edcdce565a1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#ga86218245c60fb73eec98edcdce565a1c">tButterworth_setF2</a> (tButterworth *const, float in)</td></tr>
<tr class="separator:ga86218245c60fb73eec98edcdce565a1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5cde91a986d40a6764d07ffde532a1a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tbutterworth.html#ga5cde91a986d40a6764d07ffde532a1a7">tButterworth_setFreqs</a> (tButterworth *const, float f1, float f2)</td></tr>
<tr class="separator:ga5cde91a986d40a6764d07ffde532a1a7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Butterworth filter. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga567582dd961193c6a49ebcb5f78db211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga567582dd961193c6a49ebcb5f78db211">◆ </a></span>tButterworth_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tButterworth_initToPool </td>
<td>(</td>
<td class="paramtype">tButterworth * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></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">float </td>
<td class="paramname"><em>f1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>f2</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 tButterworth 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 tButterworth to initialize. </td></tr>
<tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
<tr><td class="paramname">order</td><td>Order of the filter. </td></tr>
<tr><td class="paramname">lowCutoff</td><td>Lower cutoff frequency. </td></tr>
<tr><td class="paramname">upperCutoff</td><td>Upper cutoff frequency. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga340f64a2f39d6a75dddbff0664c6a0c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga340f64a2f39d6a75dddbff0664c6a0c2">◆ </a></span>tButterworth_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tButterworth_free </td>
<td>(</td>
<td class="paramtype">tButterworth * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tButterworth 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 tButterworth to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac4729b8e622da0d570efe80ac1c54707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4729b8e622da0d570efe80ac1c54707">◆ </a></span>tButterworth_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tButterworth_tick </td>
<td>(</td>
<td class="paramtype">tButterworth * 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 tButterworth. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga12a4c927d24d1664d0beb425cf64e284"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12a4c927d24d1664d0beb425cf64e284">◆ </a></span>tButterworth_setF1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tButterworth_setF1 </td>
<td>(</td>
<td class="paramtype">tButterworth * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>in</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 tButterworth. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga86218245c60fb73eec98edcdce565a1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga86218245c60fb73eec98edcdce565a1c">◆ </a></span>tButterworth_setF2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tButterworth_setF2 </td>
<td>(</td>
<td class="paramtype">tButterworth * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>in</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 tButterworth. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5cde91a986d40a6764d07ffde532a1a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5cde91a986d40a6764d07ffde532a1a7">◆ </a></span>tButterworth_setFreqs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tButterworth_setFreqs </td>
<td>(</td>
<td class="paramtype">tButterworth * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>f1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>f2</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 tButterworth.  </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>