mirror of
https://github.com/thestk/stk
synced 2026-04-20 06:26:55 +00:00
Release 4.4.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
c37de52787
commit
7fcf920d3e
@@ -8,66 +8,60 @@
|
||||
<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.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_1ReedTable.html">ReedTable</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>stk::ReedTable Class Reference</h1><!-- doxytag: class="stk::ReedTable" --><!-- doxytag: inherits="stk::Function" -->STK reed table class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="ReedTable_8h-source.html">ReedTable.h</a>></code>
|
||||
<p>
|
||||
<h1>stk::ReedTable Class Reference</h1><!-- doxytag: class="stk::ReedTable" --><!-- doxytag: inherits="stk::Function" -->
|
||||
<p>STK reed table class.
|
||||
<a href="#_details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="ReedTable_8h_source.html">ReedTable.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for stk::ReedTable:</div>
|
||||
<div class="dynsection">
|
||||
|
||||
<p><center><img src="classstk_1_1ReedTable.png" usemap="#stk::ReedTable_map" border="0" alt=""></center>
|
||||
<map name="stk::ReedTable_map">
|
||||
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,93,80">
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,93,24">
|
||||
<div class="center">
|
||||
<img src="classstk_1_1ReedTable.png" usemap="#stk::ReedTable_map" alt=""/>
|
||||
<map id="stk::ReedTable_map" name="stk::ReedTable_map">
|
||||
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,93,80"/>
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,93,24"/>
|
||||
</map>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
<a href="classstk_1_1ReedTable-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="138db7619ec28a4feeaf2a00988e4f0d"></a><!-- doxytag: member="stk::ReedTable::ReedTable" ref="138db7619ec28a4feeaf2a00988e4f0d" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#138db7619ec28a4feeaf2a00988e4f0d">ReedTable</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#b40ffd675bd7242a210e8630f8919556">setOffset</a> (StkFloat offset)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table offset value. <a href="#b40ffd675bd7242a210e8630f8919556"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#968a97400ec6bd424634ff377fc6417a">setSlope</a> (StkFloat slope)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table slope value. <a href="#968a97400ec6bd424634ff377fc6417a"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c1607ed5712e2ab010d8c5e55e431f2"></a><!-- doxytag: member="stk::ReedTable::tick" ref="3c1607ed5712e2ab010d8c5e55e431f2" args="(StkFloat input)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#3c1607ed5712e2ab010d8c5e55e431f2">tick</a> (StkFloat input)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take one sample input and map to one sample of output. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#3455fa2dedb2c86fc825ec48296822be">tick</a> (<a class="el" href="classstk_1_1StkFrames.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="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. <a href="#3455fa2dedb2c86fc825ec48296822be"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#e682fdc0a6ec68a9f858f5cd6889113d">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object. <a href="#e682fdc0a6ec68a9f858f5cd6889113d"></a><br></td></tr>
|
||||
<p><a href="classstk_1_1ReedTable-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="a138db7619ec28a4feeaf2a00988e4f0d"></a><!-- doxytag: member="stk::ReedTable::ReedTable" ref="a138db7619ec28a4feeaf2a00988e4f0d" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a138db7619ec28a4feeaf2a00988e4f0d">ReedTable</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#ab40ffd675bd7242a210e8630f8919556">setOffset</a> (StkFloat offset)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table offset value. <a href="#ab40ffd675bd7242a210e8630f8919556"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a968a97400ec6bd424634ff377fc6417a">setSlope</a> (StkFloat slope)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table slope value. <a href="#a968a97400ec6bd424634ff377fc6417a"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c1607ed5712e2ab010d8c5e55e431f2"></a><!-- doxytag: member="stk::ReedTable::tick" ref="a3c1607ed5712e2ab010d8c5e55e431f2" args="(StkFloat input)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a3c1607ed5712e2ab010d8c5e55e431f2">tick</a> (StkFloat input)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take one sample input and map to one sample of output. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#a3455fa2dedb2c86fc825ec48296822be">tick</a> (<a class="el" href="classstk_1_1StkFrames.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="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. <a href="#a3455fa2dedb2c86fc825ec48296822be"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1ReedTable.html#ae682fdc0a6ec68a9f858f5cd6889113d">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object. <a href="#ae682fdc0a6ec68a9f858f5cd6889113d"></a><br/></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK reed table class.
|
||||
<p>
|
||||
This class implements a simple one breakpoint, non-linear reed function, as described by Smith (1986). This function is based on a memoryless non-linear spring model of the reed (the reed mass is ignored) which saturates when the reed collides with the mouthpiece facing.<p>
|
||||
See McIntyre, Schumacher, & Woodhouse (1983), Smith (1986), Hirschman, Cook, Scavone, and others for more information.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="b40ffd675bd7242a210e8630f8919556"></a><!-- doxytag: member="stk::ReedTable::setOffset" ref="b40ffd675bd7242a210e8630f8919556" args="(StkFloat offset)" -->
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>STK reed table class. </p>
|
||||
<p>This class implements a simple one breakpoint, non-linear reed function, as described by Smith (1986). This function is based on a memoryless non-linear spring model of the reed (the reed mass is ignored) which saturates when the reed collides with the mouthpiece facing.</p>
|
||||
<p>See McIntyre, Schumacher, & Woodhouse (1983), Smith (1986), Hirschman, Cook, Scavone, and others for more information.</p>
|
||||
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="ab40ffd675bd7242a210e8630f8919556"></a><!-- doxytag: member="stk::ReedTable::setOffset" ref="ab40ffd675bd7242a210e8630f8919556" args="(StkFloat offset)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::ReedTable::setOffset </td>
|
||||
<td class="memname">void stk::ReedTable::setOffset </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>offset</em> </td>
|
||||
<td class="paramname"> <em>offset</em></td>
|
||||
<td> ) </td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
@@ -75,21 +69,20 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Set the table offset value.
|
||||
<p>
|
||||
The table offset roughly corresponds to the size of the initial reed tip opening (a greater offset represents a smaller opening).
|
||||
<p>Set the table offset value. </p>
|
||||
<p>The table offset roughly corresponds to the size of the initial reed tip opening (a greater offset represents a smaller opening). </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="968a97400ec6bd424634ff377fc6417a"></a><!-- doxytag: member="stk::ReedTable::setSlope" ref="968a97400ec6bd424634ff377fc6417a" args="(StkFloat slope)" -->
|
||||
</div>
|
||||
<a class="anchor" id="a968a97400ec6bd424634ff377fc6417a"></a><!-- doxytag: member="stk::ReedTable::setSlope" ref="a968a97400ec6bd424634ff377fc6417a" args="(StkFloat slope)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::ReedTable::setSlope </td>
|
||||
<td class="memname">void stk::ReedTable::setSlope </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>slope</em> </td>
|
||||
<td class="paramname"> <em>slope</em></td>
|
||||
<td> ) </td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
@@ -97,18 +90,17 @@ The table offset roughly corresponds to the size of the initial reed tip opening
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Set the table slope value.
|
||||
<p>
|
||||
The table slope roughly corresponds to the reed stiffness (a greater slope represents a harder reed).
|
||||
<p>Set the table slope value. </p>
|
||||
<p>The table slope roughly corresponds to the reed stiffness (a greater slope represents a harder reed). </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="3455fa2dedb2c86fc825ec48296822be"></a><!-- doxytag: member="stk::ReedTable::tick" ref="3455fa2dedb2c86fc825ec48296822be" args="(StkFrames &frames, unsigned int channel=0)" -->
|
||||
</div>
|
||||
<a class="anchor" id="a3455fa2dedb2c86fc825ec48296822be"></a><!-- doxytag: member="stk::ReedTable::tick" ref="a3455fa2dedb2c86fc825ec48296822be" args="(StkFrames &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> & stk::ReedTable::tick </td>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::ReedTable::tick </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
||||
<td class="paramname"> <em>frames</em>, </td>
|
||||
@@ -128,18 +120,17 @@ The table slope roughly corresponds to the reed stiffness (a greater slope repre
|
||||
</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 table 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>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 table 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>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="e682fdc0a6ec68a9f858f5cd6889113d"></a><!-- doxytag: member="stk::ReedTable::tick" ref="e682fdc0a6ec68a9f858f5cd6889113d" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
|
||||
</div>
|
||||
<a class="anchor" id="ae682fdc0a6ec68a9f858f5cd6889113d"></a><!-- doxytag: member="stk::ReedTable::tick" ref="ae682fdc0a6ec68a9f858f5cd6889113d" args="(StkFrames &iFrames, StkFrames &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> & stk::ReedTable::tick </td>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::ReedTable::tick </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
||||
<td class="paramname"> <em>iFrames</em>, </td>
|
||||
@@ -171,20 +162,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 table 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 table 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="ReedTable_8h-source.html">ReedTable.h</a></ul>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="ReedTable_8h_source.html">ReedTable.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>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user