docs/html/PoleZero_8h_source.html

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arduino STK: PoleZero.h Source File</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Arduino STK
   &#160;<span id="projectnumber">4.6.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">PoleZero.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef STK_POLEZERO_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define STK_POLEZERO_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;Filter.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacestk.html">stk</a> {</div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html">   21</a></span>&#160;<span class="keyword">class </span><a class="code" href="classstk_1_1PoleZero.html">PoleZero</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Filter.html">Filter</a></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;{</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#ad9a46d21ee470d7afcd641807b5e314e">   26</a></span>&#160;  <a class="code" href="classstk_1_1PoleZero.html#ad9a46d21ee470d7afcd641807b5e314e">PoleZero</a>();</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#abeb7feab68b5d8370bd9c2aef94c8541">   29</a></span>&#160;  <a class="code" href="classstk_1_1PoleZero.html#abeb7feab68b5d8370bd9c2aef94c8541">~PoleZero</a>();</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#a8e4a45e4a5263c66e9d447688975ca0f">   32</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#a8e4a45e4a5263c66e9d447688975ca0f">setB0</a>( StkFloat b0 ) { b_[0] = b0; };</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#ae33d1e1f594b4cf9063518c7b065c5f5">   35</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#ae33d1e1f594b4cf9063518c7b065c5f5">setB1</a>( StkFloat b1 ) { b_[1] = b1; };</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#ae3f0fc1182eb06730f09b8137c01779f">   38</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#ae3f0fc1182eb06730f09b8137c01779f">setA1</a>( StkFloat a1 ) { a_[1] = a1; };</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#af34e485fbcaa1f4985a88a882ca9d5c5">   41</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#af34e485fbcaa1f4985a88a882ca9d5c5">setCoefficients</a>( StkFloat b0, StkFloat b1, StkFloat a1, <span class="keywordtype">bool</span> clearState = <span class="keyword">false</span> );</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#a51264d601b635aa0274c75ba1aa5a048">   50</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#a51264d601b635aa0274c75ba1aa5a048">setAllpass</a>( StkFloat coefficient );</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#acb7119d8964215546bbeeb6029f5c46f">   59</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classstk_1_1PoleZero.html#acb7119d8964215546bbeeb6029f5c46f">setBlockZero</a>( StkFloat thePole = 0.99 );</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#a985cb8be7ae204a4dd2223152eb9f37f">   62</a></span>&#160;  StkFloat <a class="code" href="classstk_1_1PoleZero.html#a985cb8be7ae204a4dd2223152eb9f37f">lastOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_[0]; };</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  StkFloat <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">tick</a>( StkFloat input );</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">tick</a>( <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">   79</a></span>&#160;<span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">PoleZero :: tick</a>( StkFloat input )</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;{</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  inputs_[0] = gain_ * input;</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  lastFrame_[0] = b_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  inputs_[1] = inputs_[0];</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  outputs_[1] = lastFrame_[0];</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keywordflow">return</span> lastFrame_[0];</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;}</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classstk_1_1PoleZero.html#a1b5e97a13c582d97cfaa7fcbd4211b47">   89</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; <a class="code" href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">PoleZero :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;{</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="preprocessor">#if defined(_STK_DEBUG_)</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="keywordflow">if</span> ( channel &gt;= frames.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>() ) {</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    oStream_ &lt;&lt; <span class="stringliteral">&quot;PoleZero::tick(): channel and StkFrames arguments are incompatible!&quot;</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">handleError</a>( StkError::FUNCTION_ARGUMENT );</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  }</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  StkFloat *samples = &amp;frames[channel];</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>();</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;frames.<a class="code" href="classstk_1_1StkFrames.html#a0fc22e21feecdee966f0203722b9c168">frames</a>(); i++, samples += hop ) {</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    inputs_[0] = gain_ * *samples;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    *samples = b_[0] * inputs_[0] + b_[1] * inputs_[1] - a_[1] * outputs_[1];</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    inputs_[1] = inputs_[0];</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    outputs_[1] = *samples;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  }</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  lastFrame_[0] = outputs_[1];</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  <span class="keywordflow">return</span> frames;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;}</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;} <span class="comment">// stk namespace</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstk_1_1Filter_html"><div class="ttname"><a href="classstk_1_1Filter.html">stk::Filter</a></div><div class="ttdoc">STK abstract filter class.</div><div class="ttdef"><b>Definition:</b> Filter.h:23</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html"><div class="ttname"><a href="classstk_1_1PoleZero.html">stk::PoleZero</a></div><div class="ttdoc">STK one-pole, one-zero filter class.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:22</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_a1a29ac6f3a2b75e71693c73554599228"><div class="ttname"><a href="classstk_1_1PoleZero.html#a1a29ac6f3a2b75e71693c73554599228">stk::PoleZero::tick</a></div><div class="ttdeci">StkFloat tick(StkFloat input)</div><div class="ttdoc">Input one sample to the filter and return one output.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:79</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_a51264d601b635aa0274c75ba1aa5a048"><div class="ttname"><a href="classstk_1_1PoleZero.html#a51264d601b635aa0274c75ba1aa5a048">stk::PoleZero::setAllpass</a></div><div class="ttdeci">void setAllpass(StkFloat coefficient)</div><div class="ttdoc">Set the filter for allpass behavior using coefficient.</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_a8e4a45e4a5263c66e9d447688975ca0f"><div class="ttname"><a href="classstk_1_1PoleZero.html#a8e4a45e4a5263c66e9d447688975ca0f">stk::PoleZero::setB0</a></div><div class="ttdeci">void setB0(StkFloat b0)</div><div class="ttdoc">Set the b[0] coefficient value.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:32</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_a985cb8be7ae204a4dd2223152eb9f37f"><div class="ttname"><a href="classstk_1_1PoleZero.html#a985cb8be7ae204a4dd2223152eb9f37f">stk::PoleZero::lastOut</a></div><div class="ttdeci">StkFloat lastOut(void) const</div><div class="ttdoc">Return the last computed output value.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:62</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_abeb7feab68b5d8370bd9c2aef94c8541"><div class="ttname"><a href="classstk_1_1PoleZero.html#abeb7feab68b5d8370bd9c2aef94c8541">stk::PoleZero::~PoleZero</a></div><div class="ttdeci">~PoleZero()</div><div class="ttdoc">Class destructor.</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_acb7119d8964215546bbeeb6029f5c46f"><div class="ttname"><a href="classstk_1_1PoleZero.html#acb7119d8964215546bbeeb6029f5c46f">stk::PoleZero::setBlockZero</a></div><div class="ttdeci">void setBlockZero(StkFloat thePole=0.99)</div><div class="ttdoc">Create a DC blocking filter with the given pole position in the z-plane.</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_ad9a46d21ee470d7afcd641807b5e314e"><div class="ttname"><a href="classstk_1_1PoleZero.html#ad9a46d21ee470d7afcd641807b5e314e">stk::PoleZero::PoleZero</a></div><div class="ttdeci">PoleZero()</div><div class="ttdoc">Default constructor creates a first-order pass-through filter.</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_ae33d1e1f594b4cf9063518c7b065c5f5"><div class="ttname"><a href="classstk_1_1PoleZero.html#ae33d1e1f594b4cf9063518c7b065c5f5">stk::PoleZero::setB1</a></div><div class="ttdeci">void setB1(StkFloat b1)</div><div class="ttdoc">Set the b[1] coefficient value.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:35</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_ae3f0fc1182eb06730f09b8137c01779f"><div class="ttname"><a href="classstk_1_1PoleZero.html#ae3f0fc1182eb06730f09b8137c01779f">stk::PoleZero::setA1</a></div><div class="ttdeci">void setA1(StkFloat a1)</div><div class="ttdoc">Set the a[1] coefficient value.</div><div class="ttdef"><b>Definition:</b> PoleZero.h:38</div></div>
<div class="ttc" id="aclassstk_1_1PoleZero_html_af34e485fbcaa1f4985a88a882ca9d5c5"><div class="ttname"><a href="classstk_1_1PoleZero.html#af34e485fbcaa1f4985a88a882ca9d5c5">stk::PoleZero::setCoefficients</a></div><div class="ttdeci">void setCoefficients(StkFloat b0, StkFloat b1, StkFloat a1, bool clearState=false)</div><div class="ttdoc">Set all filter coefficients.</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html"><div class="ttname"><a href="classstk_1_1StkFrames.html">stk::StkFrames</a></div><div class="ttdoc">An STK class to handle vectorized audio data.</div><div class="ttdef"><b>Definition:</b> Stk.h:287</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a0340d9e76707282658e49509a568f60e"><div class="ttname"><a href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">stk::StkFrames::channels</a></div><div class="ttdeci">unsigned int channels(void) const</div><div class="ttdoc">Return the number of channels represented by the data.</div><div class="ttdef"><b>Definition:</b> Stk.h:415</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a0fc22e21feecdee966f0203722b9c168"><div class="ttname"><a href="classstk_1_1StkFrames.html#a0fc22e21feecdee966f0203722b9c168">stk::StkFrames::frames</a></div><div class="ttdeci">unsigned int frames(void) const</div><div class="ttdoc">Return the number of sample frames represented by the data.</div><div class="ttdef"><b>Definition:</b> Stk.h:418</div></div>
<div class="ttc" id="aclassstk_1_1Stk_html_a48ac73a0d8ca28445ba1a054e1f061ff"><div class="ttname"><a href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff">stk::Stk::handleError</a></div><div class="ttdeci">static void handleError(const char *message, StkError::Type type)</div><div class="ttdoc">Static function for error reporting and handling using c-strings.</div></div>
<div class="ttc" id="anamespacestk_html"><div class="ttname"><a href="namespacestk.html">stk</a></div><div class="ttdoc">The STK namespace.</div><div class="ttdef"><b>Definition:</b> ADSR.h:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>