1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
<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.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Mesh2D.html">Mesh2D</a>
</div>
<div class="contents">
<h1>stk::Mesh2D Class Reference</h1><!-- doxytag: class="stk::Mesh2D" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>Two-dimensional rectilinear waveguide mesh class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Mesh2D_8h_source.html">Mesh2D.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Mesh2D:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Mesh2D.png" usemap="#stk::Mesh2D_map" alt=""/>
<map id="stk::Mesh2D_map" name="stk::Mesh2D_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,80,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,80,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Mesh2D-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="aef48c3c65901f62a8dbdbe606763203e"></a><!-- doxytag: member="stk::Mesh2D::Mesh2D" ref="aef48c3c65901f62a8dbdbe606763203e" args="(unsigned short nX, unsigned short nY)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#aef48c3c65901f62a8dbdbe606763203e">Mesh2D</a> (unsigned short nX, unsigned short nY)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the x and y dimensions in samples. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4abd6b5190587d69c7c2b13870fb646"></a><!-- doxytag: member="stk::Mesh2D::~Mesh2D" ref="ac4abd6b5190587d69c7c2b13870fb646" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#ac4abd6b5190587d69c7c2b13870fb646">~Mesh2D</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49f56b4865dc041ae874fbc1b80e967b"></a><!-- doxytag: member="stk::Mesh2D::clear" ref="a49f56b4865dc041ae874fbc1b80e967b" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a49f56b4865dc041ae874fbc1b80e967b">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6834a52f03b072e18387b799f804527b"></a><!-- doxytag: member="stk::Mesh2D::setNX" ref="a6834a52f03b072e18387b799f804527b" args="(unsigned short lenX)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a6834a52f03b072e18387b799f804527b">setNX</a> (unsigned short lenX)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the x dimension size in samples. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2be2badaccfeb57e52e548f1b7515fbe"></a><!-- doxytag: member="stk::Mesh2D::setNY" ref="a2be2badaccfeb57e52e548f1b7515fbe" args="(unsigned short lenY)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a2be2badaccfeb57e52e548f1b7515fbe">setNY</a> (unsigned short lenY)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the y dimension size in samples. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cdfa80ecccf3f12dc184003458ba3a3"></a><!-- doxytag: member="stk::Mesh2D::setInputPosition" ref="a9cdfa80ecccf3f12dc184003458ba3a3" args="(StkFloat xFactor, StkFloat yFactor)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a9cdfa80ecccf3f12dc184003458ba3a3">setInputPosition</a> (StkFloat xFactor, StkFloat yFactor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the x, y input position on a 0.0 - 1.0 scale. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7b3d950e40308e7060e5ff9a62a8b8d"></a><!-- doxytag: member="stk::Mesh2D::setDecay" ref="ab7b3d950e40308e7060e5ff9a62a8b8d" args="(StkFloat decayFactor)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#ab7b3d950e40308e7060e5ff9a62a8b8d">setDecay</a> (StkFloat decayFactor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the loss filters gains (0.0 - 1.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7915dae1032ace5960c85790a7b93e0f"></a><!-- doxytag: member="stk::Mesh2D::noteOn" ref="a7915dae1032ace5960c85790a7b93e0f" args="(StkFloat frequency, StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a7915dae1032ace5960c85790a7b93e0f">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Impulse the mesh with the given amplitude (frequency ignored). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0580962b3cc0dbac092581d0fc15127b"></a><!-- doxytag: member="stk::Mesh2D::noteOff" ref="a0580962b3cc0dbac092581d0fc15127b" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a0580962b3cc0dbac092581d0fc15127b">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay) ... currently ignored. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52d9552b67edea0fc6ff3e949d6331a0"></a><!-- doxytag: member="stk::Mesh2D::energy" ref="a52d9552b67edea0fc6ff3e949d6331a0" args="(void)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a52d9552b67edea0fc6ff3e949d6331a0">energy</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate and return the signal energy stored in the mesh. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a688bed8725ef2d8bf4c6465251bd8b86"></a><!-- doxytag: member="stk::Mesh2D::inputTick" ref="a688bed8725ef2d8bf4c6465251bd8b86" args="(StkFloat input)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#a688bed8725ef2d8bf4c6465251bd8b86">inputTick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input a sample to the mesh and compute one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc618a91b288305785644d852cfdaf83"></a><!-- doxytag: member="stk::Mesh2D::controlChange" ref="acc618a91b288305785644d852cfdaf83" args="(int number, StkFloat value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#acc618a91b288305785644d852cfdaf83">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8a7e86e4774d8738098c79ab0d5e00a"></a><!-- doxytag: member="stk::Mesh2D::tick" ref="ae8a7e86e4774d8738098c79ab0d5e00a" args="(unsigned int channel=0)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#ae8a7e86e4774d8738098c79ab0d5e00a">tick</a> (unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <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_1Mesh2D.html#a0bfe62f0ab05859963571f4a9a569bd8">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">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a0bfe62f0ab05859963571f4a9a569bd8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Two-dimensional rectilinear waveguide mesh class. </p>
<p>This class implements a rectilinear, two-dimensional digital waveguide mesh structure. For details, see Van Duyne and Smith, "Physical Modeling with the 2-D Digital
Waveguide Mesh", Proceedings of the 1993 International Computer Music Conference.</p>
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
<p>Control Change Numbers:</p>
<ul>
<li>X Dimension = 2</li>
<li>Y Dimension = 4</li>
<li>Mesh Decay = 11</li>
<li>X-Y Input Position = 1</li>
</ul>
<p>by Julius Smith, 2000 - 2002. Revised by Gary Scavone for STK, 2002. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0bfe62f0ab05859963571f4a9a569bd8"></a><!-- doxytag: member="stk::Mesh2D::tick" ref="a0bfe62f0ab05859963571f4a9a569bd8" 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::Mesh2D::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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>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_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00116"></a>00116 {
<a name="l00117"></a>00117 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
<a name="l00118"></a>00118 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
<a name="l00120"></a>00120 oStream_ << <span class="stringliteral">"Mesh2D::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00121"></a>00121 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123 <span class="preprocessor">#endif</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>
<a name="l00125"></a>00125 StkFloat *samples = &frames[channel];
<a name="l00126"></a>00126 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
<a name="l00127"></a>00127 <span class="keywordflow">if</span> ( nChannels == 1 ) {
<a name="l00128"></a>00128 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop )
<a name="l00129"></a>00129 *samples++ = <a class="code" href="classstk_1_1Mesh2D.html#ae8a7e86e4774d8738098c79ab0d5e00a" title="Compute and return one output sample.">tick</a>();
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131 <span class="keywordflow">else</span> {
<a name="l00132"></a>00132 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop ) {
<a name="l00133"></a>00133 *samples++ = <a class="code" href="classstk_1_1Mesh2D.html#ae8a7e86e4774d8738098c79ab0d5e00a" title="Compute and return one output sample.">tick</a>();
<a name="l00134"></a>00134 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
<a name="l00135"></a>00135 *samples++ = lastFrame_[j];
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordflow">return</span> frames;
<a name="l00140"></a>00140 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Mesh2D_8h_source.html">Mesh2D.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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
