-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathclasshoa_1_1_vector.html
425 lines (406 loc) · 31.7 KB
/
classhoa_1_1_vector.html
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>HOA Library: Vector< D, T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">HOA Library
 <span id="projectnumber">beta 3.0</span>
</div>
<div id="projectbrief">High Order Ambisonics Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehoa.html">hoa</a></li><li class="navelem"><a class="el" href="classhoa_1_1_vector.html">Vector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhoa_1_1_vector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Vector< D, T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The vector class computes the energy and the velocity vectors for a set of loudspeakers.
<a href="classhoa_1_1_vector.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_hoa___vector_8hpp_source.html">Hoa_Vector.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for Vector< D, T >:</div>
<div class="dyncontent">
<div class="center">
<img src="classhoa_1_1_vector.png" usemap="#Vector_3C_20D_2C_20T_20_3E_map" alt=""/>
<map id="Vector_3C_20D_2C_20T_20_3E_map" name="Vector< D, T >_map">
<area href="classhoa_1_1_processor_planewaves.html" title="The planewaves processor. " alt="ProcessorPlanewaves< D, T >" shape="rect" coords="0,56,187,80"/>
<area href="classhoa_1_1_processor.html" title="The processor. " alt="Processor< D, T >" shape="rect" coords="0,0,187,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acbccada9e51e2b3d742b95425078f1a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#acbccada9e51e2b3d742b95425078f1a0">Vector</a> (const size_t numberOfChannels) hoa_noexcept</td></tr>
<tr class="memdesc:acbccada9e51e2b3d742b95425078f1a0"><td class="mdescLeft"> </td><td class="mdescRight">The vector constructor. <a href="#acbccada9e51e2b3d742b95425078f1a0">More...</a><br /></td></tr>
<tr class="separator:acbccada9e51e2b3d742b95425078f1a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb0b300da42770f4758dae9006301bb8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#abb0b300da42770f4758dae9006301bb8">~Vector</a> () hoa_noexcept=0</td></tr>
<tr class="memdesc:abb0b300da42770f4758dae9006301bb8"><td class="mdescLeft"> </td><td class="mdescRight">The vector destructor. <a href="#abb0b300da42770f4758dae9006301bb8">More...</a><br /></td></tr>
<tr class="separator:abb0b300da42770f4758dae9006301bb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8547b81d8c88d92b46d3842bfa595765"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#a8547b81d8c88d92b46d3842bfa595765">computeRendering</a> () hoa_noexcept=0</td></tr>
<tr class="memdesc:a8547b81d8c88d92b46d3842bfa595765"><td class="mdescLeft"> </td><td class="mdescRight">This method pre-computes the necessary values to process. <a href="#a8547b81d8c88d92b46d3842bfa595765">More...</a><br /></td></tr>
<tr class="separator:a8547b81d8c88d92b46d3842bfa595765"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55c59b7d96e8b1eeea47020d8ffb2b17"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#a55c59b7d96e8b1eeea47020d8ffb2b17">process</a> (const T *inputs, T *outputs) hoa_noexcept=0</td></tr>
<tr class="memdesc:a55c59b7d96e8b1eeea47020d8ffb2b17"><td class="mdescLeft"> </td><td class="mdescRight">This method computes the energy and velocity vectors. <a href="#a55c59b7d96e8b1eeea47020d8ffb2b17">More...</a><br /></td></tr>
<tr class="separator:a55c59b7d96e8b1eeea47020d8ffb2b17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e5f1e52a3f96a82a96a1d981a536242"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#a4e5f1e52a3f96a82a96a1d981a536242">processVelocity</a> (const T *inputs, T *outputs) hoa_noexcept=0</td></tr>
<tr class="memdesc:a4e5f1e52a3f96a82a96a1d981a536242"><td class="mdescLeft"> </td><td class="mdescRight">This method computes the velocity vector. <a href="#a4e5f1e52a3f96a82a96a1d981a536242">More...</a><br /></td></tr>
<tr class="separator:a4e5f1e52a3f96a82a96a1d981a536242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd542594e74633b762e5e451a0a61303"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_vector.html#abd542594e74633b762e5e451a0a61303">processEnergy</a> (const T *inputs, T *outputs) hoa_noexcept=0</td></tr>
<tr class="memdesc:abd542594e74633b762e5e451a0a61303"><td class="mdescLeft"> </td><td class="mdescRight">This method computes the energy vector. <a href="#abd542594e74633b762e5e451a0a61303">More...</a><br /></td></tr>
<tr class="separator:abd542594e74633b762e5e451a0a61303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classhoa_1_1_processor_planewaves"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhoa_1_1_processor_planewaves')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classhoa_1_1_processor_planewaves.html">ProcessorPlanewaves< D, T ></a></td></tr>
<tr class="memitem:af4f5732e7fda623824272aadb13408c0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#af4f5732e7fda623824272aadb13408c0">ProcessorPlanewaves</a> (const size_t nplws) hoa_noexcept</td></tr>
<tr class="memdesc:af4f5732e7fda623824272aadb13408c0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">The planewaves constructor. <a href="#af4f5732e7fda623824272aadb13408c0">More...</a><br /></td></tr>
<tr class="separator:af4f5732e7fda623824272aadb13408c0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf40c616a46103a46c2071cbc05fe036 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf40c616a46103a46c2071cbc05fe036"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#abf40c616a46103a46c2071cbc05fe036">~ProcessorPlanewaves</a> () hoa_noexcept</td></tr>
<tr class="memdesc:abf40c616a46103a46c2071cbc05fe036 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">The planewaves destructor. <br /></td></tr>
<tr class="separator:abf40c616a46103a46c2071cbc05fe036 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e0f7696f05532b2e85c31c1b99f211e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e0f7696f05532b2e85c31c1b99f211e"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a5e0f7696f05532b2e85c31c1b99f211e">getNumberOfPlanewaves</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:a5e0f7696f05532b2e85c31c1b99f211e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of planewaves. <br /></td></tr>
<tr class="separator:a5e0f7696f05532b2e85c31c1b99f211e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8db000417d9499a04bc40527a30814f inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#ae8db000417d9499a04bc40527a30814f">setPlanewavesRotation</a> (const T x_axe, const T y_axe, const T z_axe) hoa_noexcept</td></tr>
<tr class="memdesc:ae8db000417d9499a04bc40527a30814f inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Sets the global rotation of the planewaves. <a href="#ae8db000417d9499a04bc40527a30814f">More...</a><br /></td></tr>
<tr class="separator:ae8db000417d9499a04bc40527a30814f inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ba88199c857a5984bc6ef1f92adf7d3 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ba88199c857a5984bc6ef1f92adf7d3"></a>
T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a0ba88199c857a5984bc6ef1f92adf7d3">getPlanewavesRotationX</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:a0ba88199c857a5984bc6ef1f92adf7d3 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the angle of rotation around the x axis in radian of the planewaves. <br /></td></tr>
<tr class="separator:a0ba88199c857a5984bc6ef1f92adf7d3 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a769cb23b8365a271d3c7318f3f4906d0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a769cb23b8365a271d3c7318f3f4906d0"></a>
T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a769cb23b8365a271d3c7318f3f4906d0">getPlanewavesRotationY</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:a769cb23b8365a271d3c7318f3f4906d0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the angle of rotation around the y axis in radian of the planewaves. <br /></td></tr>
<tr class="separator:a769cb23b8365a271d3c7318f3f4906d0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a019860c91177a11279e8fa704871694a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a019860c91177a11279e8fa704871694a"></a>
T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a019860c91177a11279e8fa704871694a">getPlanewavesRotationZ</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:a019860c91177a11279e8fa704871694a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the angle of rotation around the z axis in radian of the planewaves. <br /></td></tr>
<tr class="separator:a019860c91177a11279e8fa704871694a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b996c8b26235ce93d863221dfb5e9e6 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b996c8b26235ce93d863221dfb5e9e6"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a5b996c8b26235ce93d863221dfb5e9e6">getPlanewaveIndex</a> (const size_t index) hoa_noexcept</td></tr>
<tr class="memdesc:a5b996c8b26235ce93d863221dfb5e9e6 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of a planewave. <br /></td></tr>
<tr class="separator:a5b996c8b26235ce93d863221dfb5e9e6 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac65cb57ebbe82f7f9e6df505a50933b4 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#ac65cb57ebbe82f7f9e6df505a50933b4">setPlanewaveAzimuth</a> (const size_t index, const T azimuth) hoa_noexcept</td></tr>
<tr class="memdesc:ac65cb57ebbe82f7f9e6df505a50933b4 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Sets the azimuth of a planewave in radian. <a href="#ac65cb57ebbe82f7f9e6df505a50933b4">More...</a><br /></td></tr>
<tr class="separator:ac65cb57ebbe82f7f9e6df505a50933b4 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb1b69deec2243a34bbdeea0b8fef53a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#acb1b69deec2243a34bbdeea0b8fef53a">setPlanewaveElevation</a> (const size_t index, const T elevation) hoa_noexcept</td></tr>
<tr class="memdesc:acb1b69deec2243a34bbdeea0b8fef53a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Sets the azimuth of a planewave in radian. <a href="#acb1b69deec2243a34bbdeea0b8fef53a">More...</a><br /></td></tr>
<tr class="separator:acb1b69deec2243a34bbdeea0b8fef53a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a369ac36ddcf7c6bebb63cc0d700e47 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a7a369ac36ddcf7c6bebb63cc0d700e47">getPlanewaveAzimuth</a> (const size_t index, const bool rotation=true) const hoa_noexcept</td></tr>
<tr class="memdesc:a7a369ac36ddcf7c6bebb63cc0d700e47 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the azimuth of a planewave. <a href="#a7a369ac36ddcf7c6bebb63cc0d700e47">More...</a><br /></td></tr>
<tr class="separator:a7a369ac36ddcf7c6bebb63cc0d700e47 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca9d8f72e3b60663ed806434da95f0e0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#aca9d8f72e3b60663ed806434da95f0e0">getPlanewaveElevation</a> (const size_t index, const bool rotation=true) const hoa_noexcept</td></tr>
<tr class="memdesc:aca9d8f72e3b60663ed806434da95f0e0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the elevation of a planewave. <a href="#aca9d8f72e3b60663ed806434da95f0e0">More...</a><br /></td></tr>
<tr class="separator:aca9d8f72e3b60663ed806434da95f0e0 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37fe06830dba815a8bc0559090c0d940 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a37fe06830dba815a8bc0559090c0d940">getPlanewaveAbscissa</a> (const size_t index, const bool rotation=true) const hoa_noexcept</td></tr>
<tr class="memdesc:a37fe06830dba815a8bc0559090c0d940 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the abscissa of a planewave. <a href="#a37fe06830dba815a8bc0559090c0d940">More...</a><br /></td></tr>
<tr class="separator:a37fe06830dba815a8bc0559090c0d940 inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a444b4b6e06daee03befc949109a18d2a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#a444b4b6e06daee03befc949109a18d2a">getPlanewaveOrdinate</a> (const size_t index, const bool rotation=true) const hoa_noexcept</td></tr>
<tr class="memdesc:a444b4b6e06daee03befc949109a18d2a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ordinate of a planewave. <a href="#a444b4b6e06daee03befc949109a18d2a">More...</a><br /></td></tr>
<tr class="separator:a444b4b6e06daee03befc949109a18d2a inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4d489b1b979e17b9a1426f330365a4e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#ab4d489b1b979e17b9a1426f330365a4e">getPlanewaveHeight</a> (const size_t index, const bool rotation=true) const hoa_noexcept</td></tr>
<tr class="memdesc:ab4d489b1b979e17b9a1426f330365a4e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Returns the height of a planewave. <a href="#ab4d489b1b979e17b9a1426f330365a4e">More...</a><br /></td></tr>
<tr class="separator:ab4d489b1b979e17b9a1426f330365a4e inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1c50479a48808b8e9f6fcc5ae75cdad inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_planewaves.html#af1c50479a48808b8e9f6fcc5ae75cdad">getPlanewaveName</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:af1c50479a48808b8e9f6fcc5ae75cdad inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="mdescLeft"> </td><td class="mdescRight">Retruns the name for a planewave. <a href="#af1c50479a48808b8e9f6fcc5ae75cdad">More...</a><br /></td></tr>
<tr class="separator:af1c50479a48808b8e9f6fcc5ae75cdad inherit pub_methods_classhoa_1_1_processor_planewaves"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classhoa_1_1_processor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhoa_1_1_processor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classhoa_1_1_processor.html">Processor< D, T ></a></td></tr>
<tr class="memitem:aea09971a681f2912e0716bace5754cdf inherit pub_methods_classhoa_1_1_processor"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea09971a681f2912e0716bace5754cdf"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor.html#aea09971a681f2912e0716bace5754cdf">~Processor</a> () hoa_noexcept</td></tr>
<tr class="memdesc:aea09971a681f2912e0716bace5754cdf inherit pub_methods_classhoa_1_1_processor"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br /></td></tr>
<tr class="separator:aea09971a681f2912e0716bace5754cdf inherit pub_methods_classhoa_1_1_processor"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<Dimension D, typename T><br />
class hoa::Vector< D, T ></h3>
<p>The vector class computes the energy and the velocity vectors for a set of loudspeakers. </p>
<p>The vector class compute the energy and the velocity vectors of a sound field for a set of channels. It is an useful tool to characterize the quality of the sound field restitution. For further information : Michael A. Gerzon, General metatheorie of auditory localization. Audio Engineering Society Preprint, 3306, 1992. This class retrieve the cartesian coordinates of the vectors. </p>
<p>Definition at line <a class="el" href="_hoa___vector_8hpp_source.html#l00022">22</a> of file <a class="el" href="_hoa___vector_8hpp_source.html">Hoa_Vector.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="acbccada9e51e2b3d742b95425078f1a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhoa_1_1_vector.html">Vector</a> </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>numberOfChannels</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The vector constructor. </p>
<p>The vector constructor allocates and initialize the member values to computes vectors. The number of channels must be at least 1. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numberOfChannels</td><td>The number of channels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abb0b300da42770f4758dae9006301bb8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classhoa_1_1_vector.html">Vector</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The vector destructor. </p>
<p>The vector destructor free the memory. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8547b81d8c88d92b46d3842bfa595765"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void computeRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method pre-computes the necessary values to process. </p>
<p>You should use this method before calling the process methods and after changing the azimuth, the elevation or the offset of the channels. </p>
</div>
</div>
<a class="anchor" id="a55c59b7d96e8b1eeea47020d8ffb2b17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void process </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>inputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>outputs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method computes the energy and velocity vectors. </p>
<p>You should use this method for in-place or not-in-place processing and sample by sample. The inputs array contains the channels samples and the minimum size must be the number of channels. The outputs array contains the vectors cartesian coordinates and the minimum size must be 4 for 2d and 6 for 3d. The coordinates arrangement in the outputs array is velocity abscissa, velocity ordinate, (velocity height), energy abscissa and energy ordinate (and energy height).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputs</td><td>The inputs array. </td></tr>
<tr><td class="paramname">outputs</td><td>The outputs array. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classhoa_1_1_processor.html#a1465e992478a626e2f1310b533902edd">Processor< D, T ></a>.</p>
</div>
</div>
<a class="anchor" id="a4e5f1e52a3f96a82a96a1d981a536242"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void processVelocity </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>inputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>outputs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method computes the velocity vector. </p>
<p>You should use this method for in-place or not-in-place processing and sample by sample. The inputs array and contains the channels samples and the minimum size must be the number of channels. The outputs array contains the vectors cartesian coordinates and the minimum size must be 2 for 2d and 3 for 3d. The coordinates arrangement in the outputs array is velocity abscissa and velocity ordinate (and velocity height). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputs</td><td>The inputs array. </td></tr>
<tr><td class="paramname">outputs</td><td>The outputs array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abd542594e74633b762e5e451a0a61303"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void processEnergy </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>inputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>outputs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method computes the energy vector. </p>
<p>You should use this method for in-place or not-in-place processing and sample by sample. The inputs array and contains the channels samples and the minimum size must be the number of harmonics. The outputs array contains the vectors cartesian coordinates and the minimum size must be 2 for 2d and 3 for 3d. The coordinates arrangement in the outputs array is energy abscissa and energy ordinate (and energy height). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputs</td><td>The inputs array. </td></tr>
<tr><td class="paramname">outputs</td><td>The outputs array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 2 2017 09:36:32 for HOA Library by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>