-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathclasshoa_1_1_optim.html
360 lines (342 loc) · 26.1 KB
/
classhoa_1_1_optim.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
<!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: Optim< 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_optim.html">Optim</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhoa_1_1_optim-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Optim< D, T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The class optimizes the ambisonic sound field for several restitution systems.
<a href="classhoa_1_1_optim.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for Optim< D, T >:</div>
<div class="dyncontent">
<div class="center">
<img src="classhoa_1_1_optim.png" usemap="#Optim_3C_20D_2C_20T_20_3E_map" alt=""/>
<map id="Optim_3C_20D_2C_20T_20_3E_map" name="Optim< D, T >_map">
<area href="classhoa_1_1_processor_harmonics.html" title="The harmonic processor. " alt="ProcessorHarmonics< D, T >" shape="rect" coords="0,56,179,80"/>
<area href="classhoa_1_1_processor.html" title="The processor. " alt="Processor< D, T >" shape="rect" coords="0,0,179,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
</table><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:a27afeabc43224bab22753c96dda537ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_optim.html#a27afeabc43224bab22753c96dda537ad">Optim</a> (size_t order) hoa_noexcept</td></tr>
<tr class="memdesc:a27afeabc43224bab22753c96dda537ad"><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <a href="#a27afeabc43224bab22753c96dda537ad">More...</a><br /></td></tr>
<tr class="separator:a27afeabc43224bab22753c96dda537ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ae3b1c74aa325687a178a36d9987abf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ae3b1c74aa325687a178a36d9987abf"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_optim.html#a2ae3b1c74aa325687a178a36d9987abf">~Optim</a> () hoa_noexcept</td></tr>
<tr class="memdesc:a2ae3b1c74aa325687a178a36d9987abf"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br /></td></tr>
<tr class="separator:a2ae3b1c74aa325687a178a36d9987abf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac316a9ca3b13e435870a030c3d27cff7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac316a9ca3b13e435870a030c3d27cff7"></a>
<a class="el" href="classhoa_1_1_optim.html#a46c8a310cf4c094f8c80e1cb8dc1f911">Mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_optim.html#ac316a9ca3b13e435870a030c3d27cff7">getMode</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:ac316a9ca3b13e435870a030c3d27cff7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current optimization mode. <br /></td></tr>
<tr class="separator:ac316a9ca3b13e435870a030c3d27cff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a243815c506ba18789f14d0f2a4fd963a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_optim.html#a243815c506ba18789f14d0f2a4fd963a">setMode</a> (<a class="el" href="classhoa_1_1_optim.html#a46c8a310cf4c094f8c80e1cb8dc1f911">Mode</a> mode) hoa_noexcept</td></tr>
<tr class="memdesc:a243815c506ba18789f14d0f2a4fd963a"><td class="mdescLeft"> </td><td class="mdescRight">Set the optimization mode. <a href="#a243815c506ba18789f14d0f2a4fd963a">More...</a><br /></td></tr>
<tr class="separator:a243815c506ba18789f14d0f2a4fd963a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1ff15d18384ffa349a745a2b49e0819"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_optim.html#af1ff15d18384ffa349a745a2b49e0819">process</a> (T const *inputs, T *outputs) hoa_noexcept hoa_final</td></tr>
<tr class="memdesc:af1ff15d18384ffa349a745a2b49e0819"><td class="mdescLeft"> </td><td class="mdescRight">The method performs the optimization on the harmonics signal. <a href="#af1ff15d18384ffa349a745a2b49e0819">More...</a><br /></td></tr>
<tr class="separator:af1ff15d18384ffa349a745a2b49e0819"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classhoa_1_1_processor_harmonics"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classhoa_1_1_processor_harmonics')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classhoa_1_1_processor_harmonics.html">ProcessorHarmonics< D, T ></a></td></tr>
<tr class="memitem:a6c046a8eea082c04363643b4d5a861c5 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a6c046a8eea082c04363643b4d5a861c5">ProcessorHarmonics</a> (const size_t order) hoa_noexcept</td></tr>
<tr class="memdesc:a6c046a8eea082c04363643b4d5a861c5 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">The harmonics constructor. <a href="#a6c046a8eea082c04363643b4d5a861c5">More...</a><br /></td></tr>
<tr class="separator:a6c046a8eea082c04363643b4d5a861c5 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae356bc4bd84a253c316bce3b84d11a1e inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae356bc4bd84a253c316bce3b84d11a1e"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#ae356bc4bd84a253c316bce3b84d11a1e">~ProcessorHarmonics</a> () hoa_noexcept</td></tr>
<tr class="memdesc:ae356bc4bd84a253c316bce3b84d11a1e inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">The harmonics destructor. <br /></td></tr>
<tr class="separator:ae356bc4bd84a253c316bce3b84d11a1e inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a022c96904c6016c6a984b70107a3f574 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a022c96904c6016c6a984b70107a3f574"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a022c96904c6016c6a984b70107a3f574">getDecompositionOrder</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:a022c96904c6016c6a984b70107a3f574 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the order of decomposition. <br /></td></tr>
<tr class="separator:a022c96904c6016c6a984b70107a3f574 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2bfb1d90e280e369b1d4f0a445e491f inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2bfb1d90e280e369b1d4f0a445e491f"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#ae2bfb1d90e280e369b1d4f0a445e491f">getNumberOfHarmonics</a> () const hoa_noexcept</td></tr>
<tr class="memdesc:ae2bfb1d90e280e369b1d4f0a445e491f inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of harmonics. <br /></td></tr>
<tr class="separator:ae2bfb1d90e280e369b1d4f0a445e491f inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a4ac723612a8fd301322c7f649db738 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a1a4ac723612a8fd301322c7f649db738">getHarmonicDegree</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:a1a4ac723612a8fd301322c7f649db738 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the degree of an harmonic. <a href="#a1a4ac723612a8fd301322c7f649db738">More...</a><br /></td></tr>
<tr class="separator:a1a4ac723612a8fd301322c7f649db738 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04933264f971ac86125ead92b4cf1177 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a04933264f971ac86125ead92b4cf1177">getHarmonicOrder</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:a04933264f971ac86125ead92b4cf1177 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the azimuthal order of an harmonic. <a href="#a04933264f971ac86125ead92b4cf1177">More...</a><br /></td></tr>
<tr class="separator:a04933264f971ac86125ead92b4cf1177 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c5d31e082cfa79c253bb6c3c969fa0b inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a2c5d31e082cfa79c253bb6c3c969fa0b">getHarmonicIndex</a> (const size_t degree, const long order) const hoa_noexcept</td></tr>
<tr class="memdesc:a2c5d31e082cfa79c253bb6c3c969fa0b inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of an harmonic given the degree and the azimuthal order. <a href="#a2c5d31e082cfa79c253bb6c3c969fa0b">More...</a><br /></td></tr>
<tr class="separator:a2c5d31e082cfa79c253bb6c3c969fa0b inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a847895cc614362e651d755ce1150e51d inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a847895cc614362e651d755ce1150e51d">getHarmonicName</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:a847895cc614362e651d755ce1150e51d inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of an harmonic. <a href="#a847895cc614362e651d755ce1150e51d">More...</a><br /></td></tr>
<tr class="separator:a847895cc614362e651d755ce1150e51d inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23f022db7c23e001a36d172279b63376 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a23f022db7c23e001a36d172279b63376">getHarmonicNormalization</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:a23f022db7c23e001a36d172279b63376 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the normalization of an harmonic. <a href="#a23f022db7c23e001a36d172279b63376">More...</a><br /></td></tr>
<tr class="separator:a23f022db7c23e001a36d172279b63376 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1819efdb4d5088d8c94d1366bcc0d9c3 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor_harmonics.html#a1819efdb4d5088d8c94d1366bcc0d9c3">getHarmonicSemiNormalization</a> (const size_t index) const hoa_noexcept</td></tr>
<tr class="memdesc:a1819efdb4d5088d8c94d1366bcc0d9c3 inherit pub_methods_classhoa_1_1_processor_harmonics"><td class="mdescLeft"> </td><td class="mdescRight">Returns the semi-normalization of an harmonic. <a href="#a1819efdb4d5088d8c94d1366bcc0d9c3">More...</a><br /></td></tr>
<tr class="separator:a1819efdb4d5088d8c94d1366bcc0d9c3 inherit pub_methods_classhoa_1_1_processor_harmonics"><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>
<tr class="memitem:a1465e992478a626e2f1310b533902edd inherit pub_methods_classhoa_1_1_processor"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhoa_1_1_processor.html#a1465e992478a626e2f1310b533902edd">process</a> (const T *inputs, T *outputs) hoa_noexcept</td></tr>
<tr class="memdesc:a1465e992478a626e2f1310b533902edd inherit pub_methods_classhoa_1_1_processor"><td class="mdescLeft"> </td><td class="mdescRight">The pure virtual method performs that performs the digital signal processing. <a href="#a1465e992478a626e2f1310b533902edd">More...</a><br /></td></tr>
<tr class="separator:a1465e992478a626e2f1310b533902edd 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::Optim< D, T ></h3>
<p>The class optimizes the ambisonic sound field for several restitution systems. </p>
<p>The class should be used to optimize the ambisonic sound field. There are 3 optimizations, basic (no optimization), max-re (energy vector optimization) and in-phase (energy and velocity vector optimization).<br />
The basic optimization has no effect, it should be used (or not) with a perfect ambisonic channels arrangement where all the channels are to equal distance on a circle or a sphere, and for a listener placed at the perfect center of the circle of the sphere. The basic optimization generates a set of weights defined by:<br />
</p><p class="formulaDsp">
\[W^{basic}_{l,m} = 1\]
</p>
<p><br />
The max-re should be used should be used for an auditory confined to the center of the circle or the sphere. The max-re optimization generates a set of weights defined by:<br />
</p><p class="formulaDsp">
\[W^{max-re}_{l,m} = \cos{(l \times \frac{\pi}{2N + 2})}\]
</p>
<p><br />
The in-phase optimization should be used when the auditory covers the entire channels area and/or when the channels arrangement is not a perfect circle or a perfect sphere (when the channels are not to equal distance for example).The in-phase optimization generates a set of weights defined by:<br />
</p><p class="formulaDsp">
\[W^{in-phase}_{l,m} = \frac{N!^2}{(N + l)!(N -l)!}\]
</p>
<p><br />
with \(N\) the order of decomposition, \(l\) the degree and \(m\) the azimuthal order. Note that the optimizations decrease the precision of the sound field restitution thus it can be compared to particular cases of the fractional orders. </p>
<p>Definition at line <a class="el" href="_hoa___optim_8hpp_source.html#l00040">40</a> of file <a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a46c8a310cf4c094f8c80e1cb8dc1f911"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classhoa_1_1_optim.html#a46c8a310cf4c094f8c80e1cb8dc1f911">Mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The different optimization mode. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhoa_1_1_optim.html#ac316a9ca3b13e435870a030c3d27cff7" title="Returns the current optimization mode. ">getMode()</a>, <a class="el" href="classhoa_1_1_optim.html#a243815c506ba18789f14d0f2a4fd963a" title="Set the optimization mode. ">setMode()</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a46c8a310cf4c094f8c80e1cb8dc1f911ae7daa0df03dc17e169eb5190f575f3ef"></a>Basic </td><td class="fielddoc">
<p>The basic optimization. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a46c8a310cf4c094f8c80e1cb8dc1f911aca0a9165ee620ede32ee6cc9a3566ba8"></a>MaxRe </td><td class="fielddoc">
<p>The max-re optimization. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a46c8a310cf4c094f8c80e1cb8dc1f911a263f6660ba749f0dda731712db4b9c88"></a>InPhase </td><td class="fielddoc">
<p>The in-phase optimization. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="_hoa___optim_8hpp_source.html#l00046">46</a> of file <a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a27afeabc43224bab22753c96dda537ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhoa_1_1_optim.html">Optim</a> </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>The order of decomposition. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_hoa___optim_8hpp_source.html#l00055">55</a> of file <a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a243815c506ba18789f14d0f2a4fd963a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void setMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhoa_1_1_optim.html#a46c8a310cf4c094f8c80e1cb8dc1f911">Mode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the optimization mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>The mode of optimization. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_hoa___optim_8hpp_source.html#l00067">67</a> of file <a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af1ff15d18384ffa349a745a2b49e0819"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void process </td>
<td>(</td>
<td class="paramtype">T const * </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The method performs the optimization on the harmonics signal. </p>
<p>The method can be used for in-place or not-in-place processing and sample by sample. The inputs array and outputs array contains the spherical harmonics samples thus the minimum size of the array must be the number of harmonics. </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>Definition at line <a class="el" href="_hoa___optim_8hpp_source.html#l00104">104</a> of file <a class="el" href="_hoa___optim_8hpp_source.html">Hoa_Optim.hpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 2 2017 09:36:31 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>