ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__tpowerfollower.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: tPowerFollower</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">tPowerFollower<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Measure and follow the power of an input signal using an exponential moving average for smoothing.
<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:gab8b92e4b8a0819f2d0a779f3b20d3f25"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#gab8b92e4b8a0819f2d0a779f3b20d3f25">tPowerFollower_init</a> (tPowerFollower *const, float factor, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gab8b92e4b8a0819f2d0a779f3b20d3f25"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPowerFollower 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__tpowerfollower.html#gab8b92e4b8a0819f2d0a779f3b20d3f25">More...</a><br /></td></tr>
<tr class="separator:gab8b92e4b8a0819f2d0a779f3b20d3f25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga726f0b8ec4ab97346fb8521934452a2e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#ga726f0b8ec4ab97346fb8521934452a2e">tPowerFollower_initToPool</a> (tPowerFollower *const, float factor, tMempool *const)</td></tr>
<tr class="memdesc:ga726f0b8ec4ab97346fb8521934452a2e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPowerFollower to a specified mempool. <a href="group__tpowerfollower.html#ga726f0b8ec4ab97346fb8521934452a2e">More...</a><br /></td></tr>
<tr class="separator:ga726f0b8ec4ab97346fb8521934452a2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga479317d7fd22a86a832ebec92eae4782"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#ga479317d7fd22a86a832ebec92eae4782">tPowerFollower_free</a> (tPowerFollower *const)</td></tr>
<tr class="memdesc:ga479317d7fd22a86a832ebec92eae4782"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPowerFollower from its mempool. <a href="group__tpowerfollower.html#ga479317d7fd22a86a832ebec92eae4782">More...</a><br /></td></tr>
<tr class="separator:ga479317d7fd22a86a832ebec92eae4782"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b422a35ef8ccdd72b3db45fc53c1e96"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#ga0b422a35ef8ccdd72b3db45fc53c1e96">tPowerFollower_tick</a> (tPowerFollower *const, float input)</td></tr>
<tr class="memdesc:ga0b422a35ef8ccdd72b3db45fc53c1e96"><td class="mdescLeft"> </td><td class="mdescRight">Pass a sample into the power follower and return the current power. <a href="group__tpowerfollower.html#ga0b422a35ef8ccdd72b3db45fc53c1e96">More...</a><br /></td></tr>
<tr class="separator:ga0b422a35ef8ccdd72b3db45fc53c1e96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a423e1c15b581b4430112ed2897f6d2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#ga0a423e1c15b581b4430112ed2897f6d2">tPowerFollower_getPower</a> (tPowerFollower *const)</td></tr>
<tr class="memdesc:ga0a423e1c15b581b4430112ed2897f6d2"><td class="mdescLeft"> </td><td class="mdescRight">Get the current power. <a href="group__tpowerfollower.html#ga0a423e1c15b581b4430112ed2897f6d2">More...</a><br /></td></tr>
<tr class="separator:ga0a423e1c15b581b4430112ed2897f6d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac7ab521ba7345c90b2455acc66a7caf1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpowerfollower.html#gac7ab521ba7345c90b2455acc66a7caf1">tPowerFollower_setFactor</a> (tPowerFollower *const, float factor)</td></tr>
<tr class="memdesc:gac7ab521ba7345c90b2455acc66a7caf1"><td class="mdescLeft"> </td><td class="mdescRight">Set the smoothing factor for the moving average. <a href="group__tpowerfollower.html#gac7ab521ba7345c90b2455acc66a7caf1">More...</a><br /></td></tr>
<tr class="separator:gac7ab521ba7345c90b2455acc66a7caf1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Measure and follow the power of an input signal using an exponential moving average for smoothing. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab8b92e4b8a0819f2d0a779f3b20d3f25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8b92e4b8a0819f2d0a779f3b20d3f25">◆ </a></span>tPowerFollower_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPowerFollower_init </td>
<td>(</td>
<td class="paramtype">tPowerFollower * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</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 tPowerFollower 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">follower</td><td>A pointer to the tPowerFollower to initialize. </td></tr>
<tr><td class="paramname">factor</td><td>Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly. </td></tr>
<tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga726f0b8ec4ab97346fb8521934452a2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga726f0b8ec4ab97346fb8521934452a2e">◆ </a></span>tPowerFollower_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPowerFollower_initToPool </td>
<td>(</td>
<td class="paramtype">tPowerFollower * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</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 tPowerFollower to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">follower</td><td>A pointer to the tPowerFollower to initialize. </td></tr>
<tr><td class="paramname">factor</td><td>Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly. </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="ga479317d7fd22a86a832ebec92eae4782"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga479317d7fd22a86a832ebec92eae4782">◆ </a></span>tPowerFollower_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPowerFollower_free </td>
<td>(</td>
<td class="paramtype">tPowerFollower * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tPowerFollower from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">follower</td><td>A pointer to the tPowerFollower to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0b422a35ef8ccdd72b3db45fc53c1e96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0b422a35ef8ccdd72b3db45fc53c1e96">◆ </a></span>tPowerFollower_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPowerFollower_tick </td>
<td>(</td>
<td class="paramtype">tPowerFollower * 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">
<p>Pass a sample into the power follower and return the current power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">follower</td><td>A pointer to the relevant tPowerFollower. </td></tr>
<tr><td class="paramname">input</td><td>The input sample </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current power. </dd></dl>
</div>
</div>
<a id="ga0a423e1c15b581b4430112ed2897f6d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a423e1c15b581b4430112ed2897f6d2">◆ </a></span>tPowerFollower_getPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPowerFollower_getPower </td>
<td>(</td>
<td class="paramtype">tPowerFollower * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current power. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">follower</td><td>A pointer to the relevant tPowerFollower. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current power. </dd></dl>
</div>
</div>
<a id="gac7ab521ba7345c90b2455acc66a7caf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7ab521ba7345c90b2455acc66a7caf1">◆ </a></span>tPowerFollower_setFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tPowerFollower_setFactor </td>
<td>(</td>
<td class="paramtype">tPowerFollower * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the smoothing factor for the moving average. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">follower</td><td>A pointer to the relevant tPowerFollower. </td></tr>
<tr><td class="paramname">factor</td><td>Smoothing factor of the moving average. 0.0-1.0, with a higher value discounting older inputs more quickly.  </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>