e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-17 22:51:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.3.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:41:50 +02:00
committed by Stephen Sinclair
parent 554a74374b
commit 1a8403e203
462 changed files with 4751 additions and 3397 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc/html/classTwoZero.html
View File

@@ -6,7 +6,7 @@
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<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="tutorial.html">Tutorial</a></CENTER>
<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.4.4 -->
<h1>TwoZero Class Reference</h1><!-- doxytag: class="TwoZero" --><!-- doxytag: inherits="Filter" --><code>#include &lt;<a class="el" href="TwoZero_8h-source.html">TwoZero.h</a>&gt;</code>
@@ -21,7 +21,7 @@
STK two-zero filter class.
<p>
This protected <a class="el" href="classFilter.html">Filter</a> subclass implements a two-zero digital filter. A method is provided for creating a "notch" in the frequency response while maintaining a constant filter gain.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
@@ -34,46 +34,50 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a1">~TwoZero</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="a2"></a><!-- doxytag: member="TwoZero::clear" ref="a2" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a2">clear</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="TwoZero::ignoreSampleRateChange" ref="a2" args="(bool ignore=true)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a2">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="a3"></a><!-- doxytag: member="TwoZero::clear" ref="a3" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a3">clear</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the internal states of the filter. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="TwoZero::setB0" ref="a3" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a3">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="TwoZero::setB0" ref="a4" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a4">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="a4"></a><!-- doxytag: member="TwoZero::setB1" ref="a4" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a4">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="TwoZero::setB1" ref="a5" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a5">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="a5"></a><!-- doxytag: member="TwoZero::setB2" ref="a5" args="(StkFloat b2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a5">setB2</a> (StkFloat b2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="TwoZero::setB2" ref="a6" args="(StkFloat b2)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a6">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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a6">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a7">setNotch</a> (StkFloat frequency, StkFloat radius)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter coefficients for a "notch" at <em>frequency</em> (in Hz). <a href="#a6"></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="classTwoZero.html#a7">setGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filter coefficients for a "notch" at <em>frequency</em> (in Hz). <a href="#a7"></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="classTwoZero.html#a8">setGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter gain. <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="TwoZero::getGain" ref="a8" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a8">getGain</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the filter gain. <a href="#a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="TwoZero::getGain" ref="a9" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a9">getGain</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the current filter gain. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="TwoZero::lastOut" ref="a9" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a9">lastOut</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="TwoZero::lastOut" ref="a10" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a10">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="a10"></a><!-- doxytag: member="TwoZero::tick" ref="a10" args="(StkFloat sample)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a10">tick</a> (StkFloat sample)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="TwoZero::tick" ref="a11" args="(StkFloat sample)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a11">tick</a> (StkFloat sample)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the filter and return one output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a11">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTwoZero.html#a12">tick</a> (<a class="el" href="classStkFrames.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="classStkFrames.html">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#a11"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#a12"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6"></a><!-- doxytag: member="TwoZero::setNotch" ref="a6" args="(StkFloat frequency, StkFloat radius)" --><p>
<a class="anchor" name="a7"></a><!-- doxytag: member="TwoZero::setNotch" ref="a7" args="(StkFloat frequency, StkFloat radius)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -112,7 +116,7 @@ Sets the filter coefficients for a "notch" at <em>frequency</em> (in Hz).
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. The coefficients are then normalized to produce a maximum filter gain of one (independent of the filter <em>gain</em> parameter). The resulting filter frequency response has a "notch" or anti-resonance at the given <em>frequency</em>. The closer the zeros are to the unit-circle (<em>radius</em> close to or equal to one), the narrower the resulting notch width. </td>
</tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="TwoZero::setGain" ref="a7" args="(StkFloat gain)" --><p>
<a class="anchor" name="a8"></a><!-- doxytag: member="TwoZero::setGain" ref="a8" args="(StkFloat gain)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -144,7 +148,7 @@ The gain is applied at the filter input and does not affect the coefficient valu
Reimplemented from <a class="el" href="classFilter.html#a7">Filter</a>. </td>
</tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="TwoZero::tick" ref="a11" args="(StkFrames &amp;frames, unsigned int channel=0)" --><p>
<a class="anchor" name="a12"></a><!-- doxytag: member="TwoZero::tick" ref="a12" args="(StkFrames &amp;frames, unsigned int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -191,7 +195,7 @@ Reimplemented from <a class="el" href="classFilter.html#a11">Filter</a>. </td
<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-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>