<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>norns/docs</title>
    <link rel="stylesheet" href="../ldoc_pale.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>norns</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Class_filters_mean">Class filters.mean </a></li>
<li><a href="#Class_filters_median">Class filters.median </a></li>
<li><a href="#Class_filters_smoother">Class filters.smoother </a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/clock.html">clock</a></li>
  <li><a href="../modules/crow.html">crow</a></li>
  <li><a href="../modules/softcut.html">softcut</a></li>
  <li><a href="../modules/er.html">er</a></li>
  <li><strong>filters</strong></li>
  <li><a href="../modules/formatters.html">formatters</a></li>
  <li><a href="../modules/intonation.html">intonation</a></li>
  <li><a href="../modules/MusicUtil.html">MusicUtil</a></li>
  <li><a href="../modules/tabutil.html">tabutil</a></li>
  <li><a href="../modules/util.html">util</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
  <li><a href="../classes/arc.html">arc</a></li>
  <li><a href="../classes/audio.html">audio</a></li>
  <li><a href="../classes/controlspec.html">controlspec</a></li>
  <li><a href="../classes/encoders.html">encoders</a></li>
  <li><a href="../classes/engine.html">engine</a></li>
  <li><a href="../classes/grid.html">grid</a></li>
  <li><a href="../classes/hid.html">hid</a></li>
  <li><a href="../classes/metro.html">metro</a></li>
  <li><a href="../classes/midi.html">midi</a></li>
  <li><a href="../classes/osc.html">osc</a></li>
  <li><a href="../classes/control.html">control</a></li>
  <li><a href="../classes/paramset.html">paramset</a></li>
  <li><a href="../classes/poll.html">poll</a></li>
  <li><a href="../classes/screen.html">screen</a></li>
  <li><a href="../classes/script.html">script</a></li>
  <li><a href="../classes/BeatClock.html">BeatClock</a></li>
  <li><a href="../classes/elca.html">elca</a></li>
  <li><a href="../classes/EnvGraph.html">EnvGraph</a></li>
  <li><a href="../classes/FilterGraph.html">FilterGraph</a></li>
  <li><a href="../classes/Graph.html">Graph</a></li>
  <li><a href="../classes/pattern.html">pattern</a></li>
  <li><a href="../classes/UI.html">UI</a></li>
  <li><a href="../classes/voice.html">voice</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>filters</code></h1>
<p></p>
<p></p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#f:clear">f:clear ()</a></td>
	<td class="summary">clear a filter's history</td>
	</tr>
</table>
<h2><a href="#Class_filters_mean">Class filters.mean </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#mean.new">mean.new (bufsize:)</a></td>
	<td class="summary">constructor</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#mean:next">mean:next (x:)</a></td>
	<td class="summary">process a new input value and update the average</td>
	</tr>
</table>
<h2><a href="#Class_filters_median">Class filters.median </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#median.new">median.new (bufsize:)</a></td>
	<td class="summary">constructor</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#median:next">median:next (x:)</a></td>
	<td class="summary">process a new input value and update the average</td>
	</tr>
</table>
<h2><a href="#Class_filters_smoother">Class filters.smoother </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#smoother.new">smoother.new (time:, sr:)</a></td>
	<td class="summary">constructor</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#f.mean">f.mean</a></td>
	<td class="summary">TODO: what else would be useful?</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "f:clear"></a>
    <strong>f:clear ()</strong>
    </dt>
    <dd>
    clear a filter's history







</dd>
</dl>
    <h2 class="section-header "><a name="Class_filters_mean"></a>Class filters.mean </h2>

    <dl class="function">
    <dt>
    <a name = "mean.new"></a>
    <strong>mean.new (bufsize:)</strong>
    </dt>
    <dd>
    constructor


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bufsize:</span>
         window size, cannot change after creation
        </li>
    </ul>





</dd>
    <dt>
    <a name = "mean:next"></a>
    <strong>mean:next (x:)</strong>
    </dt>
    <dd>
    process a new input value and update the average


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">x:</span>
         new input
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        scaled sum of stored history
    </ol>




</dd>
</dl>
    <h2 class="section-header "><a name="Class_filters_median"></a>Class filters.median </h2>

    <dl class="function">
    <dt>
    <a name = "median.new"></a>
    <strong>median.new (bufsize:)</strong>
    </dt>
    <dd>
    constructor


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bufsize:</span>
         window size, cannot change after creation
        </li>
    </ul>





</dd>
    <dt>
    <a name = "median:next"></a>
    <strong>median:next (x:)</strong>
    </dt>
    <dd>
    process a new input value and update the average


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">x:</span>
         new input
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        median of last N values
    </ol>




</dd>
</dl>
    <h2 class="section-header "><a name="Class_filters_smoother"></a>Class filters.smoother </h2>

    <dl class="function">
    <dt>
    <a name = "smoother.new"></a>
    <strong>smoother.new (time:, sr:)</strong>
    </dt>
    <dd>
    constructor


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">time:</span>
         -60db convergence time
        </li>
        <li><span class="parameter">sr:</span>
         expected sample rate
        </li>
    </ul>





</dd>
    <dt>
    <a name = "f.mean"></a>
    <strong>f.mean</strong>
    </dt>
    <dd>
    TODO: what else would be useful?
<p> quantile estimator?
 constant time ramp?
 some kind of hysteresis / latching?







</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-03-28 23:45:19 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
