mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
157 lines
8.4 KiB
HTML
157 lines
8.4 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>TwoPole Class Reference</h1>STK two-pole filter class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="TwoPole_8h-source.html">TwoPole.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for TwoPole::
|
|
<p><center><img src="classTwoPole.gif" usemap="#TwoPole_map" border="0"></center>
|
|
<map name="TwoPole_map">
|
|
<area href="classFilter.html" alt="Filter" shape="rect" coords="0,56,60,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,60,24">
|
|
</map>
|
|
<a href="classTwoPole-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="TwoPole::TwoPole"></a>
|
|
</td><td valign=bottom><a class="el" href="classTwoPole.html#a0">TwoPole</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor creates a second-order pass-through filter.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="TwoPole::~TwoPole"></a>
|
|
</td><td valign=bottom><a class="el" href="classTwoPole.html#a1">~TwoPole</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a2" doxytag="TwoPole::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classTwoPole.html#a2">clear</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Clears the internal states of the filter.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="TwoPole::setB0"></a>
|
|
void </td><td valign=bottom><a class="el" href="classTwoPole.html#a3">setB0</a> (MY_FLOAT b0)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the b[0] coefficient value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="TwoPole::setA1"></a>
|
|
void </td><td valign=bottom><a class="el" href="classTwoPole.html#a4">setA1</a> (MY_FLOAT a1)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the a[1] coefficient value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="TwoPole::setA2"></a>
|
|
void </td><td valign=bottom><a class="el" href="classTwoPole.html#a5">setA2</a> (MY_FLOAT a2)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the a[2] coefficient value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTwoPole.html#a6">setResonance</a> (MY_FLOAT frequency, MY_FLOAT radius, bool normalize=FALSE)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz).</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTwoPole.html#a7">setGain</a> (MY_FLOAT theGain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the filter gain.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="TwoPole::getGain"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classTwoPole.html#a8">getGain</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current filter gain.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="TwoPole::lastOut"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classTwoPole.html#a9">lastOut</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the last computed output value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="TwoPole::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classTwoPole.html#a10">tick</a> (MY_FLOAT sample)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Input one sample to the filter and return one output.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="TwoPole::tick"></a>
|
|
MY_FLOAT* </td><td valign=bottom><a class="el" href="classTwoPole.html#a11">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Input <em>vectorSize</em> samples to the filter and return an equal number of outputs in <em>vector</em>.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK two-pole filter class.
|
|
<p>
|
|
This protected <a class="el" href="classFilter.html">Filter</a> subclass implements a two-pole digital filter. A method is provided for creating a resonance in the frequency response while maintaining a nearly constant filter gain.
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a6" doxytag="TwoPole::setResonance"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void TwoPole::setResonance (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>frequency</em>,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
MY_FLOAT <em>radius</em>,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
bool <em>normalize</em> = FALSE )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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 coefficients are then normalized to produce unity gain at <em>frequency</em> (the actual maximum filter gain tends to be slightly greater than unity when <em>radius</em> is not close to one). 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. An unstable filter will result for <em>radius</em> >= 1.0. For a better resonance filter, use a <a class="el" href="classBiQuad.html">BiQuad</a> filter. <dl compact><dt>
|
|
<b>See also: </b><dd>
|
|
<a class="el" href="classBiQuad.html">BiQuad</a> filter class </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="TwoPole::setGain"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void TwoPole::setGain (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>theGain</em> )<code> [virtual]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the filter gain.
|
|
<p>
|
|
The gain is applied at the filter input and does not affect the coefficient values. The default gain value is 1.0.
|
|
<p>
|
|
Reimplemented from <a class="el" href="classFilter.html#a7">Filter</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="TwoPole_8h-source.html">TwoPole.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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|