mirror of
https://github.com/thestk/stk
synced 2026-01-14 21:41:53 +00:00
333 lines
18 KiB
HTML
333 lines
18 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"> <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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Filter Class Reference</h1><!-- doxytag: class="Filter" --><!-- doxytag: inherits="Stk" --><code>#include <<a class="el" href="Filter_8h-source.html">Filter.h</a>></code>
|
|
<p>
|
|
<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">
|
|
<area href="classDelay.html" alt="Delay" shape="rect" coords="123,112,195,136">
|
|
<area href="classOnePole.html" alt="OnePole" shape="rect" coords="205,112,277,136">
|
|
<area href="classOneZero.html" alt="OneZero" shape="rect" coords="287,112,359,136">
|
|
<area href="classPoleZero.html" alt="PoleZero" shape="rect" coords="369,112,441,136">
|
|
<area href="classTwoPole.html" alt="TwoPole" shape="rect" coords="451,112,523,136">
|
|
<area href="classTwoZero.html" alt="TwoZero" shape="rect" coords="533,112,605,136">
|
|
<area href="classFormSwep.html" alt="FormSwep" shape="rect" coords="0,168,72,192">
|
|
<area href="classDelayA.html" alt="DelayA" shape="rect" coords="82,168,154,192">
|
|
<area href="classDelayL.html" alt="DelayL" shape="rect" coords="164,168,236,192">
|
|
</map>
|
|
<a href="classFilter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK filter class.
|
|
<p>
|
|
This class implements a generic structure that 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 - 2007.
|
|
<p>
|
|
<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"></a><!-- doxytag: member="Filter::Filter" ref="a0" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a0">Filter</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor creates a zero-order pass-through "filter". <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a1">Filter</a> (std::vector< StkFloat > &bCoefficients, std::vector< StkFloat > &aCoefficients)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor which takes filter coefficients. <a href="#a1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Filter::~Filter" ref="a2" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a2">~Filter</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Filter::clear" ref="a3" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a3">clear</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets all internal states of the filter to zero. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a4">setCoefficients</a> (std::vector< StkFloat > &bCoefficients, std::vector< StkFloat > &aCoefficients, bool clearState=false)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set filter coefficients. <a href="#a4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a5">setNumerator</a> (std::vector< StkFloat > &bCoefficients, bool clearState=false)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set numerator coefficients. <a href="#a5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a6">setDenominator</a> (std::vector< StkFloat > &aCoefficients, bool clearState=false)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set denominator coefficients. <a href="#a6"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a7">setGain</a> (StkFloat gain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Filter::getGain" ref="a8" args="(void) const " -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a8">getGain</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Filter::lastOut" ref="a9" args="(void) const " -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a9">lastOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Filter::tick" ref="a10" args="(StkFloat input)" -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a10">tick</a> (StkFloat input)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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">virtual <a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFilter.html#a11">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a1"></a><!-- doxytag: member="Filter::Filter" ref="a1" args="(std::vector< StkFloat > &bCoefficients, std::vector< StkFloat > &aCoefficients)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">Filter::Filter </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>bCoefficients</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>aCoefficients</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Overloaded constructor which takes filter coefficients.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> can be thrown if either of the coefficient vector sizes is zero, or if the a[0] coefficient is equal to zero. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a4"></a><!-- doxytag: member="Filter::setCoefficients" ref="a4" args="(std::vector< StkFloat > &bCoefficients, std::vector< StkFloat > &aCoefficients, bool clearState=false)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void Filter::setCoefficients </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>bCoefficients</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>aCoefficients</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>bool </td>
|
|
<td class="mdname" nowrap> <em>clearState</em> = <code>false</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set filter coefficients.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> can be thrown if either of the coefficient vector sizes is zero, 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]. The internal state of the filter is not cleared unless the <em>clearState</em> flag is <code>true</code>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a5"></a><!-- doxytag: member="Filter::setNumerator" ref="a5" args="(std::vector< StkFloat > &bCoefficients, bool clearState=false)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void Filter::setNumerator </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>bCoefficients</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>bool </td>
|
|
<td class="mdname" nowrap> <em>clearState</em> = <code>false</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set numerator coefficients.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> can be thrown if coefficient vector is empty. Any previously set denominator coefficients are left unaffected. Note that the default constructor sets the single denominator coefficient a[0] to 1.0. The internal state of the filter is not cleared unless the <em>clearState</em> flag is <code>true</code>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6"></a><!-- doxytag: member="Filter::setDenominator" ref="a6" args="(std::vector< StkFloat > &aCoefficients, bool clearState=false)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void Filter::setDenominator </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::vector< StkFloat > & </td>
|
|
<td class="mdname" nowrap> <em>aCoefficients</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>bool </td>
|
|
<td class="mdname" nowrap> <em>clearState</em> = <code>false</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set denominator coefficients.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> can be thrown if the coefficient vector is empty 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. The internal state of the filter is not cleared unless the <em>clearState</em> flag is <code>true</code>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a7"></a><!-- doxytag: member="Filter::setGain" ref="a7" args="(StkFloat gain)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual void Filter::setGain </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">StkFloat </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>gain</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></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 in <a class="el" href="classBiQuad.html#a12">BiQuad</a>, <a class="el" href="classOnePole.html#a7">OnePole</a>, <a class="el" href="classOneZero.html#a7">OneZero</a>, <a class="el" href="classPoleZero.html#a8">PoleZero</a>, <a class="el" href="classTwoPole.html#a8">TwoPole</a>, and <a class="el" href="classTwoZero.html#a8">TwoZero</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a11"></a><!-- doxytag: member="Filter::tick" ref="a11" args="(StkFrames &frames, unsigned int channel=0)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual <a class="el" href="classStkFrames.html">StkFrames</a>& Filter::tick </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
|
<td class="mdname" nowrap> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</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 zero or greater (the first channel is specified by 0). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is equal to or greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
|
<p>
|
|
Reimplemented in <a class="el" href="classBiQuad.html#a16">BiQuad</a>, <a class="el" href="classDelay.html#a12">Delay</a>, <a class="el" href="classOnePole.html#a11">OnePole</a>, <a class="el" href="classOneZero.html#a11">OneZero</a>, <a class="el" href="classPoleZero.html#a12">PoleZero</a>, <a class="el" href="classTwoPole.html#a12">TwoPole</a>, and <a class="el" href="classTwoZero.html#a12">TwoZero</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Filter_8h-source.html">Filter.h</a></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|