e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 06:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
doc/html/classstk_1_1BiQuad.html
View File

@@ -8,101 +8,85 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1BiQuad.html">BiQuad</a>
</div>
<div class="contents">
<h1>stk::BiQuad Class Reference</h1><!-- doxytag: class="stk::BiQuad" --><!-- doxytag: inherits="stk::Filter" -->STK biquad (two-pole, two-zero) filter class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="BiQuad_8h-source.html">BiQuad.h</a>&gt;</code>
<p>
<h1>stk::BiQuad Class Reference</h1><!-- doxytag: class="stk::BiQuad" --><!-- doxytag: inherits="stk::Filter" -->
<p>STK biquad (two-pole, two-zero) filter class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="BiQuad_8h_source.html">BiQuad.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::BiQuad:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1BiQuad.png" usemap="#stk::BiQuad_map" border="0" alt=""></center>
<map name="stk::BiQuad_map">
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,75,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,75,24">
<div class="center">
<img src="classstk_1_1BiQuad.png" usemap="#stk::BiQuad_map" alt=""/>
<map id="stk::BiQuad_map" name="stk::BiQuad_map">
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,75,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,75,24"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1BiQuad-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91aab9d1b4833e156edcf59cbe276e3f"></a><!-- doxytag: member="stk::BiQuad::BiQuad" ref="91aab9d1b4833e156edcf59cbe276e3f" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#91aab9d1b4833e156edcf59cbe276e3f">BiQuad</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a second-order pass-through filter. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7e81be1c4e5c5ab69474f6df2610984"></a><!-- doxytag: member="stk::BiQuad::~BiQuad" ref="d7e81be1c4e5c5ab69474f6df2610984" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#d7e81be1c4e5c5ab69474f6df2610984">~BiQuad</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab468cd1aa79b95442b15bb04d8bb211"></a><!-- doxytag: member="stk::BiQuad::ignoreSampleRateChange" ref="ab468cd1aa79b95442b15bb04d8bb211" args="(bool ignore=true)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ab468cd1aa79b95442b15bb04d8bb211">ignoreSampleRateChange</a> (bool ignore=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A function to enable/disable the automatic updating of class data when the STK sample rate changes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eed58196cf798f664cddbb9a8564c7b5"></a><!-- doxytag: member="stk::BiQuad::setCoefficients" ref="eed58196cf798f664cddbb9a8564c7b5" args="(StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#eed58196cf798f664cddbb9a8564c7b5">setCoefficients</a> (StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set all filter coefficients. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26ee25d08116b20f326001166f087853"></a><!-- doxytag: member="stk::BiQuad::setB0" ref="26ee25d08116b20f326001166f087853" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#26ee25d08116b20f326001166f087853">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[0] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd364ed410b3ed2a2b29b8a5fea127c8"></a><!-- doxytag: member="stk::BiQuad::setB1" ref="dd364ed410b3ed2a2b29b8a5fea127c8" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#dd364ed410b3ed2a2b29b8a5fea127c8">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[1] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="208a654dd3393ed0b2b86ad56d9cf3e1"></a><!-- doxytag: member="stk::BiQuad::setB2" ref="208a654dd3393ed0b2b86ad56d9cf3e1" args="(StkFloat b2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#208a654dd3393ed0b2b86ad56d9cf3e1">setB2</a> (StkFloat b2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[2] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c9799e47163fe8a59fd85196c089cb3"></a><!-- doxytag: member="stk::BiQuad::setA1" ref="1c9799e47163fe8a59fd85196c089cb3" args="(StkFloat a1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#1c9799e47163fe8a59fd85196c089cb3">setA1</a> (StkFloat a1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a[1] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e28afd560df11435ea54f128d23b9383"></a><!-- doxytag: member="stk::BiQuad::setA2" ref="e28afd560df11435ea54f128d23b9383" args="(StkFloat a2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#e28afd560df11435ea54f128d23b9383">setA2</a> (StkFloat a2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a[2] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#55aaa01fd4156f1fac1168f526e3d969">setResonance</a> (StkFloat frequency, StkFloat radius, bool normalize=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz). <a href="#55aaa01fd4156f1fac1168f526e3d969"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#e10a26fc319ba357bc92df4e528c2d8f">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter coefficients for a notch at <em>frequency</em> (in Hz). <a href="#e10a26fc319ba357bc92df4e528c2d8f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#28881f5876ce5bdcc846367cca9363f7">setEqualGainZeroes</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter zeroes for equal resonance gain. <a href="#28881f5876ce5bdcc846367cca9363f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="412f224363b1a222423ecf0cd7be9063"></a><!-- doxytag: member="stk::BiQuad::lastOut" ref="412f224363b1a222423ecf0cd7be9063" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#412f224363b1a222423ecf0cd7be9063">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="648086962c3cddcaa09c46a002c3e635"></a><!-- doxytag: member="stk::BiQuad::tick" ref="648086962c3cddcaa09c46a002c3e635" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#648086962c3cddcaa09c46a002c3e635">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the filter and return a reference to one output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#f903e41217838470a5f267a20b905a12">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#f903e41217838470a5f267a20b905a12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#c9836f0e074ea9516727f27eb9b411aa">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#c9836f0e074ea9516727f27eb9b411aa"></a><br></td></tr>
<p><a href="classstk_1_1BiQuad-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91aab9d1b4833e156edcf59cbe276e3f"></a><!-- doxytag: member="stk::BiQuad::BiQuad" ref="a91aab9d1b4833e156edcf59cbe276e3f" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a91aab9d1b4833e156edcf59cbe276e3f">BiQuad</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a second-order pass-through filter. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7e81be1c4e5c5ab69474f6df2610984"></a><!-- doxytag: member="stk::BiQuad::~BiQuad" ref="ad7e81be1c4e5c5ab69474f6df2610984" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ad7e81be1c4e5c5ab69474f6df2610984">~BiQuad</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab468cd1aa79b95442b15bb04d8bb211"></a><!-- doxytag: member="stk::BiQuad::ignoreSampleRateChange" ref="aab468cd1aa79b95442b15bb04d8bb211" args="(bool ignore=true)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#aab468cd1aa79b95442b15bb04d8bb211">ignoreSampleRateChange</a> (bool ignore=true)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A function to enable/disable the automatic updating of class data when the STK sample rate changes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeed58196cf798f664cddbb9a8564c7b5"></a><!-- doxytag: member="stk::BiQuad::setCoefficients" ref="aeed58196cf798f664cddbb9a8564c7b5" args="(StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#aeed58196cf798f664cddbb9a8564c7b5">setCoefficients</a> (StkFloat b0, StkFloat b1, StkFloat b2, StkFloat a1, StkFloat a2, bool clearState=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set all filter coefficients. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26ee25d08116b20f326001166f087853"></a><!-- doxytag: member="stk::BiQuad::setB0" ref="a26ee25d08116b20f326001166f087853" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a26ee25d08116b20f326001166f087853">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[0] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add364ed410b3ed2a2b29b8a5fea127c8"></a><!-- doxytag: member="stk::BiQuad::setB1" ref="add364ed410b3ed2a2b29b8a5fea127c8" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#add364ed410b3ed2a2b29b8a5fea127c8">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[1] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a208a654dd3393ed0b2b86ad56d9cf3e1"></a><!-- doxytag: member="stk::BiQuad::setB2" ref="a208a654dd3393ed0b2b86ad56d9cf3e1" args="(StkFloat b2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a208a654dd3393ed0b2b86ad56d9cf3e1">setB2</a> (StkFloat b2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[2] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c9799e47163fe8a59fd85196c089cb3"></a><!-- doxytag: member="stk::BiQuad::setA1" ref="a1c9799e47163fe8a59fd85196c089cb3" args="(StkFloat a1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a1c9799e47163fe8a59fd85196c089cb3">setA1</a> (StkFloat a1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a[1] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae28afd560df11435ea54f128d23b9383"></a><!-- doxytag: member="stk::BiQuad::setA2" ref="ae28afd560df11435ea54f128d23b9383" args="(StkFloat a2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ae28afd560df11435ea54f128d23b9383">setA2</a> (StkFloat a2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the a[2] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a55aaa01fd4156f1fac1168f526e3d969">setResonance</a> (StkFloat frequency, StkFloat radius, bool normalize=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz). <a href="#a55aaa01fd4156f1fac1168f526e3d969"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ae10a26fc319ba357bc92df4e528c2d8f">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter coefficients for a notch at <em>frequency</em> (in Hz). <a href="#ae10a26fc319ba357bc92df4e528c2d8f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a28881f5876ce5bdcc846367cca9363f7">setEqualGainZeroes</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter zeroes for equal resonance gain. <a href="#a28881f5876ce5bdcc846367cca9363f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a412f224363b1a222423ecf0cd7be9063"></a><!-- doxytag: member="stk::BiQuad::lastOut" ref="a412f224363b1a222423ecf0cd7be9063" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a412f224363b1a222423ecf0cd7be9063">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a648086962c3cddcaa09c46a002c3e635"></a><!-- doxytag: member="stk::BiQuad::tick" ref="a648086962c3cddcaa09c46a002c3e635" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#a648086962c3cddcaa09c46a002c3e635">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the filter and return a reference to one output. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#af903e41217838470a5f267a20b905a12">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#af903e41217838470a5f267a20b905a12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BiQuad.html#ac9836f0e074ea9516727f27eb9b411aa">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#ac9836f0e074ea9516727f27eb9b411aa"></a><br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK biquad (two-pole, two-zero) filter class.
<p>
This class implements a two-pole, two-zero digital filter. Methods are provided for creating a resonance or notch in the frequency response while maintaining a constant filter gain.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="55aaa01fd4156f1fac1168f526e3d969"></a><!-- doxytag: member="stk::BiQuad::setResonance" ref="55aaa01fd4156f1fac1168f526e3d969" args="(StkFloat frequency, StkFloat radius, bool normalize=false)" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK biquad (two-pole, two-zero) filter class. </p>
<p>This class implements a two-pole, two-zero digital filter. Methods are provided for creating a resonance or notch in the frequency response while maintaining a constant filter gain.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a55aaa01fd4156f1fac1168f526e3d969"></a><!-- doxytag: member="stk::BiQuad::setResonance" ref="a55aaa01fd4156f1fac1168f526e3d969" args="(StkFloat frequency, StkFloat radius, bool normalize=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::BiQuad::setResonance </td>
<td class="memname">void stk::BiQuad::setResonance </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>frequency</em>, </td>
@@ -128,18 +112,17 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
</div>
<div class="memdoc">
<p>
Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz).
<p>
This method determines the filter coefficients corresponding to two complex-conjugate poles with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. If <em>normalize</em> is true, the filter zeros are placed at z = 1, z = -1, and the coefficients are then normalized to produce a constant unity peak gain (independent of the filter <em>gain</em> parameter). The resulting filter frequency response has a resonance at the given <em>frequency</em>. The closer the poles are to the unit-circle (<em>radius</em> close to one), the narrower the resulting resonance width.
<p>Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz). </p>
<p>This method determines the filter coefficients corresponding to two complex-conjugate poles with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. If <em>normalize</em> is true, the filter zeros are placed at z = 1, z = -1, and the coefficients are then normalized to produce a constant unity peak gain (independent of the filter <em>gain</em> parameter). The resulting filter frequency response has a resonance at the given <em>frequency</em>. The closer the poles are to the unit-circle (<em>radius</em> close to one), the narrower the resulting resonance width. </p>
</div>
</div><p>
<a class="anchor" name="e10a26fc319ba357bc92df4e528c2d8f"></a><!-- doxytag: member="stk::BiQuad::setNotch" ref="e10a26fc319ba357bc92df4e528c2d8f" args="(StkFloat frequency, StkFloat radius)" -->
</div>
<a class="anchor" id="ae10a26fc319ba357bc92df4e528c2d8f"></a><!-- doxytag: member="stk::BiQuad::setNotch" ref="ae10a26fc319ba357bc92df4e528c2d8f" args="(StkFloat frequency, StkFloat radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::BiQuad::setNotch </td>
<td class="memname">void stk::BiQuad::setNotch </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>frequency</em>, </td>
@@ -159,21 +142,20 @@ This method determines the filter coefficients corresponding to two complex-conj
</div>
<div class="memdoc">
<p>
Set the filter coefficients for a notch at <em>frequency</em> (in Hz).
<p>
This method determines the filter coefficients corresponding to two complex-conjugate zeros with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. No filter normalization is attempted.
<p>Set the filter coefficients for a notch at <em>frequency</em> (in Hz). </p>
<p>This method determines the filter coefficients corresponding to two complex-conjugate zeros with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. No filter normalization is attempted. </p>
</div>
</div><p>
<a class="anchor" name="28881f5876ce5bdcc846367cca9363f7"></a><!-- doxytag: member="stk::BiQuad::setEqualGainZeroes" ref="28881f5876ce5bdcc846367cca9363f7" args="(void)" -->
</div>
<a class="anchor" id="a28881f5876ce5bdcc846367cca9363f7"></a><!-- doxytag: member="stk::BiQuad::setEqualGainZeroes" ref="a28881f5876ce5bdcc846367cca9363f7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::BiQuad::setEqualGainZeroes </td>
<td class="memname">void stk::BiQuad::setEqualGainZeroes </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
@@ -181,18 +163,17 @@ This method determines the filter coefficients corresponding to two complex-conj
</div>
<div class="memdoc">
<p>
Sets the filter zeroes for equal resonance gain.
<p>
When using the filter as a resonator, zeroes places at z = 1, z = -1 will result in a constant gain at resonance of 1 / (1 - R), where R is the pole radius setting.
<p>Sets the filter zeroes for equal resonance gain. </p>
<p>When using the filter as a resonator, zeroes places at z = 1, z = -1 will result in a constant gain at resonance of 1 / (1 - R), where R is the pole radius setting. </p>
</div>
</div><p>
<a class="anchor" name="f903e41217838470a5f267a20b905a12"></a><!-- doxytag: member="stk::BiQuad::tick" ref="f903e41217838470a5f267a20b905a12" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
</div>
<a class="anchor" id="af903e41217838470a5f267a20b905a12"></a><!-- doxytag: member="stk::BiQuad::tick" ref="af903e41217838470a5f267a20b905a12" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::BiQuad::tick </td>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::BiQuad::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
@@ -212,20 +193,19 @@ When using the filter as a resonator, zeroes places at z = 1, z = -1 will result
</div>
<div class="memdoc">
<p>
Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs.
<p>
The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Implements <a class="el" href="classstk_1_1Filter.html#3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
<p>Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. </p>
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Filter.html#a3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
</div>
</div><p>
<a class="anchor" name="c9836f0e074ea9516727f27eb9b411aa"></a><!-- doxytag: member="stk::BiQuad::tick" ref="c9836f0e074ea9516727f27eb9b411aa" args="(StkFrames &amp;iFrames, StkFrames &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
</div>
<a class="anchor" id="ac9836f0e074ea9516727f27eb9b411aa"></a><!-- doxytag: member="stk::BiQuad::tick" ref="ac9836f0e074ea9516727f27eb9b411aa" args="(StkFrames &amp;iFrames, StkFrames &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::BiQuad::tick </td>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::BiQuad::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>iFrames</em>, </td>
@@ -257,20 +237,20 @@ The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handl
</div>
<div class="memdoc">
<p>
Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object.
<p>
The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BiQuad_8h-source.html">BiQuad.h</a></ul>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BiQuad_8h_source.html">BiQuad.h</a></li>
</ul>
</div>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>