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

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
doc/html/classTwoZero.html
View File

@@ -9,10 +9,7 @@
<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>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>TwoZero Class Reference</h1>STK two-zero filter class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="TwoZero_8h-source.html">TwoZero.h</a>&gt;</code>
<h1>TwoZero Class Reference</h1><code>#include &lt;<a class="el" href="TwoZero_8h-source.html">TwoZero.h</a>&gt;</code>
<p>
<p>Inheritance diagram for TwoZero:
<p><center><img src="classTwoZero.png" usemap="#TwoZero_map" border="0" alt=""></center>
@@ -20,7 +17,15 @@
<area href="classFilter.html" alt="Filter" shape="rect" coords="0,56,63,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,63,24">
</map>
<a href="classTwoZero-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classTwoZero-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
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 - 2004.
<p>
<p>
Definition at line <a class="el" href="TwoZero_8h-source.html#l00020">20</a> of file <a class="el" href="TwoZero_8h-source.html">TwoZero.h</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="a0" doxytag="TwoZero::TwoZero" ></a>
@@ -36,49 +41,44 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classT
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the internal states of the filter. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="TwoZero::setB0" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a3">setB0</a> (MY_FLOAT b0)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a3">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[0] coefficient value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="TwoZero::setB1" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a4">setB1</a> (MY_FLOAT b1)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a4">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[1] coefficient value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="TwoZero::setB2" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a5">setB2</a> (MY_FLOAT b2)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a5">setB2</a> (StkFloat b2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[2] coefficient value. <br><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> (MY_FLOAT frequency, MY_FLOAT 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#a6">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). </em> <a href="#a6"></a><em><br><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> (MY_FLOAT theGain)</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">Set the filter gain. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="TwoZero::getGain" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a8">getGain</a> (void) const </td></tr>
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">Return the current filter gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="TwoZero::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a9">lastOut</a> (void) const </td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a9">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="TwoZero::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a10">tick</a> (MY_FLOAT sample)</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a10">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><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="TwoZero::tick" ></a>
MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a11">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classTwoZero.html#a11">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input <em>vectorSize</em> samples to the filter and return an equal number of outputs in <em>vector</em>. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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 - 2002.
<p>
<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=1)</td></tr>
<p>
Definition at line <a class="el" href="TwoZero_8h-source.html#l00020">20</a> of file <a class="el" href="TwoZero_8h-source.html">TwoZero.h</a>.<hr><h2>Member Function Documentation</h2>
<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. </em> <a href="#a12"></a><em><br><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6" doxytag="TwoZero::setNotch" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -87,13 +87,13 @@ Definition at line <a class="el" href="TwoZero_8h-source.html#l00020">20</a> of
<tr>
<td class="md" nowrap valign="top"> void TwoZero::setNotch </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>frequency</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>MY_FLOAT&nbsp;</td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>radius</em></td>
</tr>
<tr>
@@ -127,8 +127,8 @@ This method determines the filter coefficients corresponding to two complex-conj
<tr>
<td class="md" nowrap valign="top"> void TwoZero::setGain </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>theGain</em> </td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>gain</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
@@ -152,12 +152,54 @@ 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="a12" doxytag="TwoZero::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; TwoZero::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the filter and replace with corresponding outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classFilter.html#a12">Filter</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TwoZero_8h-source.html">TwoZero.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>