e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-12 12:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e11bff2fe8738d3927cc85e97ce48f2d85b2de2c
stk/doc/html/classReedTabl.html
Gary Scavone e11bff2fe8 Release 4.1.3 tarball
2013-09-29 23:38:16 +02:00

165 lines
7.7 KiB
HTML
Raw Blame History

<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"> &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.3.4 -->
<h1>ReedTabl Class Reference</h1>STK reed table class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ReedTabl_8h-source.html">ReedTabl.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ReedTabl:
<p><center><img src="classReedTabl.png" usemap="#ReedTabl_map" border="0" alt=""></center>
<map name="ReedTabl_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,65,24">
</map>
<a href="classReedTabl-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="a0" doxytag="ReedTabl::ReedTabl" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a0">ReedTabl</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="ReedTabl::~ReedTabl" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a1">~ReedTabl</a> ()</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>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a2">setOffset</a> (MY_FLOAT aValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the table offset value. </em> <a href="#a2"></a><em><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="classReedTabl.html#a3">setSlope</a> (MY_FLOAT aValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the table slope value. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="ReedTabl::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a4">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a5">tick</a> (MY_FLOAT input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the function value for <em>input</em>. </em> <a href="#a5"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="ReedTabl::tick" ></a>
MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReedTabl.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take <em>vectorSize</em> inputs and return the corresponding function values in <em>vector</em>. <br><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, &amp; Woodhouse (1983), Smith (1986), Hirschman, Cook, Scavone, and others for more information.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="ReedTabl_8h-source.html#l00025">25</a> of file <a class="el" href="ReedTabl_8h-source.html">ReedTabl.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="ReedTabl::setOffset" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ReedTabl::setOffset </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>aValue</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<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). </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="ReedTabl::setSlope" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ReedTabl::setSlope </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>aValue</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the table slope value.
<p>
The table slope roughly corresponds to the reed stiffness (a greater slope represents a harder reed). </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="ReedTabl::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> MY_FLOAT ReedTabl::tick </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>input</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the function value for <em>input</em>.
<p>
The function input represents the differential pressure across the reeds. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ReedTabl_8h-source.html">ReedTabl.h</a></ul>
<HR>
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink