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

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

294
doc/html/classFilter.html
View File

@@ -5,17 +5,17 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Filter Class Reference</h1>STK filter class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Filter Class Reference</h1>STK filter class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Filter_8h-source.html">Filter.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Filter::
<p><center><img src="classFilter.gif" usemap="#Filter_map" border="0"></center>
<p>Inheritance diagram for Filter:
<p><center><img src="classFilter.png" usemap="#Filter_map" border="0" alt=""></center>
<map name="Filter_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="287,0,359,24">
<area href="classBiQuad.html" alt="BiQuad" shape="rect" coords="0,112,72,136">
@@ -30,85 +30,98 @@
<area href="classDelayL.html" alt="DelayL" shape="rect" coords="164,168,236,192">
</map>
<a href="classFilter-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="Filter::Filter"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a0">Filter</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor creates a zero-order pass-through "filter".</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a1">Filter</a> (int nb, MY_FLOAT *bCoefficients, int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Overloaded constructor which takes filter coefficients.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Filter::~Filter"></a>
virtual&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a2">~Filter</a> (void)</td></tr>
<tr><td>&nbsp;</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="Filter::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a3">clear</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Clears all internal states of the filter.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a4">setCoefficients</a> (int nb, MY_FLOAT *bCoefficients, int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set filter coefficients.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a5">setNumerator</a> (int nb, MY_FLOAT *bCoefficients)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set numerator coefficients.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a6">setDenominator</a> (int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set denominator coefficients.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a7">setGain</a> (MY_FLOAT theGain)</td></tr>
<tr><td>&nbsp;</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="Filter::getGain"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a8">getGain</a> (void) const</td></tr>
<tr><td>&nbsp;</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="Filter::lastOut"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a9">lastOut</a> (void) const</td></tr>
<tr><td>&nbsp;</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="Filter::tick"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a10">tick</a> (MY_FLOAT sample)</td></tr>
<tr><td>&nbsp;</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="Filter::tick"></a>
virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classFilter.html#a11">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</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="Filter::Filter" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a0">Filter</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a zero-order pass-through "filter". <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a1">Filter</a> (int nb, MY_FLOAT *bCoefficients, int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor which takes filter coefficients. <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Filter::~Filter" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a2">~Filter</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Filter::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a3">clear</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears all internal states of the filter. <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="classFilter.html#a4">setCoefficients</a> (int nb, MY_FLOAT *bCoefficients, int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set filter coefficients. <a href="#a4"></a><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="classFilter.html#a5">setNumerator</a> (int nb, MY_FLOAT *bCoefficients)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set numerator coefficients. <a href="#a5"></a><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="classFilter.html#a6">setDenominator</a> (int na, MY_FLOAT *aCoefficients)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set denominator coefficients. <a href="#a6"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a7">setGain</a> (MY_FLOAT theGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Filter::getGain" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.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="Filter::lastOut" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.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="Filter::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a10">tick</a> (MY_FLOAT 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="Filter::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFilter.html#a11">tick</a> (MY_FLOAT *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 filter class.
<p>
This class implements a generic structure which can be used to create a wide range of filters. It can function independently or be subclassed to provide more specific controls based on a particular filter type.
<p>
In particular, this class implements the standard difference equation:
<p>
a[0]*y[n] = b[0]*x[n] + ... + b[nb]*x[n-nb] - a[1]*y[n-1] - ... - a[na]*y[n-na]
<p>
If a[0] is not equal to 1, the filter coeffcients are normalized by a[0].
<p>
The <em>gain</em> parameter is applied at the filter input and does not affect the coefficient values. The default gain value is 1.0. This structure results in one extra multiply per computed sample, but allows easy control of the overall filter gain.
STK filter class.
<p>
This class implements a generic structure which can be used to create a wide range of filters. It can function independently or be subclassed to provide more specific controls based on a particular filter type.<p>
In particular, this class implements the standard difference equation:<p>
a[0]*y[n] = b[0]*x[n] + ... + b[nb]*x[n-nb] - a[1]*y[n-1] - ... - a[na]*y[n-na]<p>
If a[0] is not equal to 1, the filter coeffcients are normalized by a[0].<p>
The <em>gain</em> parameter is applied at the filter input and does not affect the coefficient values. The default gain value is 1.0. This structure results in one extra multiply per computed sample, but allows easy control of the overall filter gain.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a1" doxytag="Filter::Filter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<p>
Definition at line <a class="el" href="Filter_8h-source.html#l00035">35</a> of file <a class="el" href="Filter_8h-source.html">Filter.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a1" doxytag="Filter::Filter" ></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>
Filter::Filter (
</b></td>
<td valign="bottom"><b>
int <em>nb</em>,
</b></td>
<td class="md" nowrap valign="top"> Filter::Filter </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap> <em>nb</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>bCoefficients</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>na</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>aCoefficients</em></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>bCoefficients</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>na</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>aCoefficients</em>&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -123,42 +136,45 @@ MY_FLOAT * <em>aCoefficients</em>&nbsp;)
<td>
<p>
Overloaded constructor which takes filter coefficients.
Overloaded constructor which takes filter coefficients.
<p>
An <a class="el" href="classStkError.html">StkError</a> can be thrown if either <em>nb</em> or <em>na</em> is less than one, or if the a[0] coefficient is equal to zero. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="Filter::setCoefficients"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="a4" doxytag="Filter::setCoefficients" ></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 Filter::setCoefficients (
</b></td>
<td valign="bottom"><b>
int <em>nb</em>,
</b></td>
<td class="md" nowrap valign="top"> void Filter::setCoefficients </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap> <em>nb</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>bCoefficients</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>na</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>aCoefficients</em></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>bCoefficients</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>na</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>aCoefficients</em>&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -173,29 +189,32 @@ MY_FLOAT * <em>aCoefficients</em>&nbsp;)
<td>
<p>
Set filter coefficients.
Set filter coefficients.
<p>
An <a class="el" href="classStkError.html">StkError</a> can be thrown if either <em>nb</em> or <em>na</em> is less than one, or if the a[0] coefficient is equal to zero. If a[0] is not equal to 1, the filter coeffcients are normalized by a[0]. </td>
</tr>
</table>
<a name="a5" doxytag="Filter::setNumerator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="a5" doxytag="Filter::setNumerator" ></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 Filter::setNumerator (
</b></td>
<td valign="bottom"><b>
int <em>nb</em>,
</b></td>
<td class="md" nowrap valign="top"> void Filter::setNumerator </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap> <em>nb</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>bCoefficients</em></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>bCoefficients</em>&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -210,29 +229,32 @@ MY_FLOAT * <em>bCoefficients</em>&nbsp;)
<td>
<p>
Set numerator coefficients.
Set numerator coefficients.
<p>
An <a class="el" href="classStkError.html">StkError</a> can be thrown if <em>nb</em> is less than one. Any previously set denominator coefficients are left unaffected. Note that the default constructor sets the single denominator coefficient a[0] to 1.0. </td>
</tr>
</table>
<a name="a6" doxytag="Filter::setDenominator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="a6" doxytag="Filter::setDenominator" ></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 Filter::setDenominator (
</b></td>
<td valign="bottom"><b>
int <em>na</em>,
</b></td>
<td class="md" nowrap valign="top"> void Filter::setDenominator </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap> <em>na</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>MY_FLOAT *&nbsp;</td>
<td class="mdname" nowrap> <em>aCoefficients</em></td>
</tr>
<tr>
<td></td>
<td><b>
MY_FLOAT * <em>aCoefficients</em>&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -247,23 +269,23 @@ MY_FLOAT * <em>aCoefficients</em>&nbsp;)
<td>
<p>
Set denominator coefficients.
Set denominator coefficients.
<p>
An <a class="el" href="classStkError.html">StkError</a> can be thrown if <em>na</em> is less than one or if the a[0] coefficient is equal to zero. Previously set numerator coefficients are unaffected unless a[0] is not equal to 1, in which case all coeffcients are normalized by a[0]. Note that the default constructor sets the single numerator coefficient b[0] to 1.0. </td>
</tr>
</table>
<a name="a7" doxytag="Filter::setGain"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<a class="anchor" name="a7" doxytag="Filter::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 Filter::setGain (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>theGain</em>&nbsp;)<code> [virtual]</code>
</b></td>
<td class="md" nowrap valign="top"> virtual void Filter::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" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
@@ -278,7 +300,7 @@ MY_FLOAT <em>theGain</em>&nbsp;)<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>
@@ -291,7 +313,7 @@ Reimplemented in <a class="el" href="classBiQuad.html#a11">BiQuad</a>, <a class=
<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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>