mirror of
https://github.com/thestk/stk
synced 2026-01-17 22:51:53 +00:00
Release 4.1.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
d12ef806ac
commit
5d63b50e85
@@ -5,78 +5,92 @@
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#FFFFFF">
|
||||
<CENTER>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.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>OnePole Class Reference</h1>STK one-pole filter class.
|
||||
<!-- Generated by Doxygen 1.3.6 -->
|
||||
<h1>OnePole Class Reference</h1>STK one-pole filter class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="OnePole_8h-source.html">OnePole.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for OnePole::
|
||||
<p><center><img src="classOnePole.gif" usemap="#OnePole_map" border="0"></center>
|
||||
<p>Inheritance diagram for OnePole:
|
||||
<p><center><img src="classOnePole.png" usemap="#OnePole_map" border="0" alt=""></center>
|
||||
<map name="OnePole_map">
|
||||
<area href="classFilter.html" alt="Filter" shape="rect" coords="0,56,61,80">
|
||||
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,61,24">
|
||||
</map>
|
||||
<a href="classOnePole-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="OnePole::OnePole"></a>
|
||||
</td><td valign=bottom><a class="el" href="classOnePole.html#a0">OnePole</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Default constructor creates a first-order low-pass filter.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a1" doxytag="OnePole::OnePole"></a>
|
||||
</td><td valign=bottom><a class="el" href="classOnePole.html#a1">OnePole</a> (MY_FLOAT thePole)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Overloaded constructor which sets the pole position during instantiation.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a2" doxytag="OnePole::~OnePole"></a>
|
||||
</td><td valign=bottom><a class="el" href="classOnePole.html#a2">~OnePole</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="a3" doxytag="OnePole::clear"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classOnePole.html#a3">clear</a> (void)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Clears the internal state of the filter.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a4" doxytag="OnePole::setB0"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classOnePole.html#a4">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="a5" doxytag="OnePole::setA1"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classOnePole.html#a5">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>void </td><td valign=bottom><a class="el" href="classOnePole.html#a6">setPole</a> (MY_FLOAT thePole)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the pole position in the z-plane.</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="classOnePole.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="OnePole::getGain"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classOnePole.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="OnePole::lastOut"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classOnePole.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="OnePole::tick"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classOnePole.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="OnePole::tick"></a>
|
||||
MY_FLOAT* </td><td valign=bottom><a class="el" href="classOnePole.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>
|
||||
<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="OnePole::OnePole" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a0">OnePole</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor creates a first-order low-pass filter. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="OnePole::OnePole" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a1">OnePole</a> (MY_FLOAT thePole)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor which sets the pole position during instantiation. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="OnePole::~OnePole" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a2">~OnePole</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="OnePole::clear" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a3">clear</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears the internal state of the filter. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="OnePole::setB0" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a4">setB0</a> (MY_FLOAT b0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="a5" doxytag="OnePole::setA1" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a5">setA1</a> (MY_FLOAT a1)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the a[1] coefficient value. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a6">setPole</a> (MY_FLOAT thePole)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pole position in the z-plane. <a href="#a6"></a><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a7">setGain</a> (MY_FLOAT theGain)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filter gain. <a href="#a7"></a><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="OnePole::getGain" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a8">getGain</a> (void) const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="OnePole::lastOut" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a9">lastOut</a> (void) const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="OnePole::tick" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a10">tick</a> (MY_FLOAT sample)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="OnePole::tick" ></a>
|
||||
MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classOnePole.html#a11">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 one-pole filter class.
|
||||
<p>
|
||||
This protected <a class="el" href="classFilter.html">Filter</a> subclass implements a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain.
|
||||
STK one-pole filter class.
|
||||
<p>
|
||||
This protected <a class="el" href="classFilter.html">Filter</a> subclass implements a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
||||
<p>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a name="a6" doxytag="OnePole::setPole"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="OnePole_8h-source.html#l00020">20</a> of file <a class="el" href="OnePole_8h-source.html">OnePole.h</a>.<hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="a6" doxytag="OnePole::setPole" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void OnePole::setPole (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
MY_FLOAT <em>thePole</em> )
|
||||
</b></td>
|
||||
<td class="md" nowrap valign="top"> void OnePole::setPole </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">MY_FLOAT </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>thePole</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
@@ -91,23 +105,23 @@ MY_FLOAT <em>thePole</em> )
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Set the pole position in the z-plane.
|
||||
Set the pole position in the z-plane.
|
||||
<p>
|
||||
This method sets the pole position along the real-axis of the z-plane and normalizes the coefficients for a maximum gain of one. A positive pole value produces a low-pass filter, while a negative pole value produces a high-pass filter. This method does not affect the filter <em>gain</em> value. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a7" doxytag="OnePole::setGain"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<a class="anchor" name="a7" doxytag="OnePole::setGain" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void OnePole::setGain (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
MY_FLOAT <em>theGain</em> )<code> [virtual]</code>
|
||||
</b></td>
|
||||
<td class="md" nowrap valign="top"> void OnePole::setGain </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">MY_FLOAT </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>theGain</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap><code> [virtual]</code></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
@@ -122,7 +136,7 @@ MY_FLOAT <em>theGain</em> )<code> [virtual]</code>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Set the filter gain.
|
||||
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>
|
||||
@@ -135,7 +149,7 @@ Reimplemented from <a class="el" href="classFilter.html#a7">Filter</a>. </td>
|
||||
|
||||
<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>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user