e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 14:36:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
doc/html/classstk_1_1OneZero.html
View File

@@ -8,82 +8,72 @@
<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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1OneZero.html">OneZero</a>
</div>
<div class="contents">
<h1>stk::OneZero Class Reference</h1><!-- doxytag: class="stk::OneZero" --><!-- doxytag: inherits="stk::Filter" -->STK one-zero filter class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="OneZero_8h-source.html">OneZero.h</a>&gt;</code>
<p>
<h1>stk::OneZero Class Reference</h1><!-- doxytag: class="stk::OneZero" --><!-- doxytag: inherits="stk::Filter" -->
<p>STK one-zero filter class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="OneZero_8h_source.html">OneZero.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::OneZero:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1OneZero.png" usemap="#stk::OneZero_map" border="0" alt=""></center>
<map name="stk::OneZero_map">
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,85,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,85,24">
<div class="center">
<img src="classstk_1_1OneZero.png" usemap="#stk::OneZero_map" alt=""/>
<map id="stk::OneZero_map" name="stk::OneZero_map">
<area href="classstk_1_1Filter.html" alt="stk::Filter" shape="rect" coords="0,56,85,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,85,24"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1OneZero-members.html">List of all members.</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="da639198d28be5d170508a301ba854da"></a><!-- doxytag: member="stk::OneZero::OneZero" ref="da639198d28be5d170508a301ba854da" args="(StkFloat theZero=&#45;1.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#da639198d28be5d170508a301ba854da">OneZero</a> (StkFloat theZero=-1.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor creates a low-pass filter (zero at z = -1.0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8abe6156bad57d3a5cfebcf2ddc9b703"></a><!-- doxytag: member="stk::OneZero::~OneZero" ref="8abe6156bad57d3a5cfebcf2ddc9b703" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#8abe6156bad57d3a5cfebcf2ddc9b703">~OneZero</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef2a8aa1759762649a74fc031198ebca"></a><!-- doxytag: member="stk::OneZero::setB0" ref="ef2a8aa1759762649a74fc031198ebca" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#ef2a8aa1759762649a74fc031198ebca">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[0] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4eda332f920e43a33871c8beb6f3042"></a><!-- doxytag: member="stk::OneZero::setB1" ref="d4eda332f920e43a33871c8beb6f3042" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#d4eda332f920e43a33871c8beb6f3042">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[1] coefficient value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6113bf1dce0cb23719e30ee29e7c6735"></a><!-- doxytag: member="stk::OneZero::setCoefficients" ref="6113bf1dce0cb23719e30ee29e7c6735" args="(StkFloat b0, StkFloat b1, bool clearState=false)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#6113bf1dce0cb23719e30ee29e7c6735">setCoefficients</a> (StkFloat b0, StkFloat b1, bool clearState=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set all filter coefficients. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#f8301fdb6a893ec6eb74fbcbeeaa463c">setZero</a> (StkFloat theZero)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the zero position in the z-plane. <a href="#f8301fdb6a893ec6eb74fbcbeeaa463c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54e160f62354939876477d9c5a65890c"></a><!-- doxytag: member="stk::OneZero::lastOut" ref="54e160f62354939876477d9c5a65890c" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#54e160f62354939876477d9c5a65890c">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</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="9f52fa395257b15cb7351c6ccb2199da"></a><!-- doxytag: member="stk::OneZero::tick" ref="9f52fa395257b15cb7351c6ccb2199da" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#9f52fa395257b15cb7351c6ccb2199da">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#2ca42a158bed919d8578c4a2dd184b3d">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#2ca42a158bed919d8578c4a2dd184b3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#8568a0d8c4aacc64b656b9fe46f217a4">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#8568a0d8c4aacc64b656b9fe46f217a4"></a><br></td></tr>
<p><a href="classstk_1_1OneZero-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada639198d28be5d170508a301ba854da"></a><!-- doxytag: member="stk::OneZero::OneZero" ref="ada639198d28be5d170508a301ba854da" args="(StkFloat theZero=&#45;1.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#ada639198d28be5d170508a301ba854da">OneZero</a> (StkFloat theZero=-1.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor creates a low-pass filter (zero at z = -1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8abe6156bad57d3a5cfebcf2ddc9b703"></a><!-- doxytag: member="stk::OneZero::~OneZero" ref="a8abe6156bad57d3a5cfebcf2ddc9b703" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a8abe6156bad57d3a5cfebcf2ddc9b703">~OneZero</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef2a8aa1759762649a74fc031198ebca"></a><!-- doxytag: member="stk::OneZero::setB0" ref="aef2a8aa1759762649a74fc031198ebca" args="(StkFloat b0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#aef2a8aa1759762649a74fc031198ebca">setB0</a> (StkFloat b0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[0] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4eda332f920e43a33871c8beb6f3042"></a><!-- doxytag: member="stk::OneZero::setB1" ref="ad4eda332f920e43a33871c8beb6f3042" args="(StkFloat b1)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#ad4eda332f920e43a33871c8beb6f3042">setB1</a> (StkFloat b1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the b[1] coefficient value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6113bf1dce0cb23719e30ee29e7c6735"></a><!-- doxytag: member="stk::OneZero::setCoefficients" ref="a6113bf1dce0cb23719e30ee29e7c6735" args="(StkFloat b0, StkFloat b1, bool clearState=false)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a6113bf1dce0cb23719e30ee29e7c6735">setCoefficients</a> (StkFloat b0, StkFloat b1, bool clearState=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set all filter coefficients. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#af8301fdb6a893ec6eb74fbcbeeaa463c">setZero</a> (StkFloat theZero)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the zero position in the z-plane. <a href="#af8301fdb6a893ec6eb74fbcbeeaa463c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54e160f62354939876477d9c5a65890c"></a><!-- doxytag: member="stk::OneZero::lastOut" ref="a54e160f62354939876477d9c5a65890c" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a54e160f62354939876477d9c5a65890c">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f52fa395257b15cb7351c6ccb2199da"></a><!-- doxytag: member="stk::OneZero::tick" ref="a9f52fa395257b15cb7351c6ccb2199da" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a9f52fa395257b15cb7351c6ccb2199da">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input one sample to the filter and return one output. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a2ca42a158bed919d8578c4a2dd184b3d">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. <a href="#a2ca42a158bed919d8578c4a2dd184b3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1OneZero.html#a8568a0d8c4aacc64b656b9fe46f217a4">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. <a href="#a8568a0d8c4aacc64b656b9fe46f217a4"></a><br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK one-zero filter class.
<p>
This class implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f8301fdb6a893ec6eb74fbcbeeaa463c"></a><!-- doxytag: member="stk::OneZero::setZero" ref="f8301fdb6a893ec6eb74fbcbeeaa463c" args="(StkFloat theZero)" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK one-zero filter class. </p>
<p>This class implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af8301fdb6a893ec6eb74fbcbeeaa463c"></a><!-- doxytag: member="stk::OneZero::setZero" ref="af8301fdb6a893ec6eb74fbcbeeaa463c" args="(StkFloat theZero)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::OneZero::setZero </td>
<td class="memname">void stk::OneZero::setZero </td>
<td>(</td>
<td class="paramtype">StkFloat&nbsp;</td>
<td class="paramname"> <em>theZero</em> </td>
<td class="paramname"> <em>theZero</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
@@ -91,18 +81,17 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
</div>
<div class="memdoc">
<p>
Set the zero position in the z-plane.
<p>
This method sets the zero position along the real-axis of the z-plane and normalizes the coefficients for a maximum gain of one. A positive zero value produces a high-pass filter, while a negative zero value produces a low-pass filter. This method does not affect the filter <em>gain</em> value.
<p>Set the zero position in the z-plane. </p>
<p>This method sets the zero position along the real-axis of the z-plane and normalizes the coefficients for a maximum gain of one. A positive zero value produces a high-pass filter, while a negative zero value produces a low-pass filter. This method does not affect the filter <em>gain</em> value. </p>
</div>
</div><p>
<a class="anchor" name="2ca42a158bed919d8578c4a2dd184b3d"></a><!-- doxytag: member="stk::OneZero::tick" ref="2ca42a158bed919d8578c4a2dd184b3d" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
</div>
<a class="anchor" id="a2ca42a158bed919d8578c4a2dd184b3d"></a><!-- doxytag: member="stk::OneZero::tick" ref="a2ca42a158bed919d8578c4a2dd184b3d" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::OneZero::tick </td>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::OneZero::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
@@ -122,20 +111,19 @@ This method sets the zero position along the real-axis of the z-plane and normal
</div>
<div class="memdoc">
<p>
Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs.
<p>
The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Implements <a class="el" href="classstk_1_1Filter.html#3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
<p>Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the filter and replace with corresponding outputs. </p>
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Filter.html#a3260a238824c4a748ac057b84b7d3f21">stk::Filter</a>.</p>
</div>
</div><p>
<a class="anchor" name="8568a0d8c4aacc64b656b9fe46f217a4"></a><!-- doxytag: member="stk::OneZero::tick" ref="8568a0d8c4aacc64b656b9fe46f217a4" args="(StkFrames &amp;iFrames, StkFrames &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
</div>
<a class="anchor" id="a8568a0d8c4aacc64b656b9fe46f217a4"></a><!-- doxytag: member="stk::OneZero::tick" ref="a8568a0d8c4aacc64b656b9fe46f217a4" args="(StkFrames &amp;iFrames, StkFrames &amp;oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::OneZero::tick </td>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::OneZero::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>iFrames</em>, </td>
@@ -167,20 +155,20 @@ The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handl
</div>
<div class="memdoc">
<p>
Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object.
<p>
The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Take a channel of the <code>iFrames</code> object as inputs to the filter and write outputs to the <code>oFrames</code> object. </p>
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OneZero_8h-source.html">OneZero.h</a></ul>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OneZero_8h_source.html">OneZero.h</a></li>
</ul>
</div>
<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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>