Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_specwin_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 <!-- $Id: class_desc_specwin_content.html,v 1.11 2009/03/17 16:52:04 ingo Exp $ -->
2
3 <!-- ================================================== -->
4 <!-- BEGIN CONTENT FILE -->
5 <!-- ================================================== -->
6 <!-- ===== link box: Begin ===== -->
7 <p>
8 <table border="1" width="80%">
9 <tr>
10 <td>
11 <table border="0" cellpadding="5" class="categorylist" width="100%">
12 <colgroup>
13 <col width="37%"/>
14 <col width="63%"/>
15 </colgroup>
16 <tbody>
17 <tr valign="top">
18 <td>
19 <a href="class_desc_specwin.html#top_properties">Properties</a>
20 </td>
21 <td>Properties of the class</td>
22 </tr>
23 <tr valign="top">
24 <td>
25 <a href="class_desc_specwin.html#top_methods">Methods</a>
26 </td>
27 <td>All Methods of the class ordered by category.</td>
28 </tr>
29 <tr valign="top">
30 <td>
31 <a href="constructor_examples_specwin.html">Examples</a>
32 </td>
33 <td>Some constructor examples</td>
34 </tr>
35 </tbody>
36 </table>
37 </td>
38 </tr>
39 </table>
40 </p>
41 <!-- ===== link box: End ====== -->
42
43 <!-- ===== Back to Class descriptions ===== -->
44 <a href="class_desc_main.html">
45 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
46 Back to Class descriptions
47 </a>
48
49 <h2 class="title"><a name="top_properties"/>Properties</h2>
50 <p>
51 The LTPDA toolbox restrict access of the properties.<br></br>
52 The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
53 <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
54 The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
55 <pre class="programlisting">
56 For example:
57 obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
58 obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre>
59 </p>
60 <!-- ===== Properties ===== -->
61 <p>
62 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
63 <colgroup>
64 <col width="15%"/>
65 <col width="73%"/>
66 <col width="12%"/>
67 </colgroup>
68 <thead>
69 <tr valign="top">
70 <th class="categorylist">Properties</th>
71 <th class="categorylist">Description</th>
72 <th class="categorylist">Defined in class</th>
73 </tr>
74 </thead>
75 <tbody>
76 <!-- Property: 'type' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>type</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Name of the spectral window object</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>specwin</p>
86 </td>
87 </tr>
88 <!-- Property: 'alpha' -->
89 <tr valign="top">
90 <td>
91 <p><tt>alpha</tt></p>
92 </td>
93 <td>
94 <p>Alpha parameter for various window functions</p>
95 </td>
96 <td>
97 <p>specwin</p>
98 </td>
99 </tr>
100 <!-- Property: 'psll' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>psll</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Peak sidelobe level</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>specwin</p>
110 </td>
111 </tr>
112 <!-- Property: 'rov' -->
113 <tr valign="top">
114 <td>
115 <p><tt>rov</tt></p>
116 </td>
117 <td>
118 <p>Recommended overlap</p>
119 </td>
120 <td>
121 <p>specwin</p>
122 </td>
123 </tr>
124 <!-- Property: 'nenbw' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>nenbw</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>Normalised equivalent noise bandwidth</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>specwin</p>
134 </td>
135 </tr>
136 <!-- Property: 'w3db' -->
137 <tr valign="top">
138 <td>
139 <p><tt>w3db</tt></p>
140 </td>
141 <td>
142 <p>dB bandwidth in bins</p>
143 </td>
144 <td>
145 <p>specwin</p>
146 </td>
147 </tr>
148 <!-- Property: 'flatness' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>flatness</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>Window flatness</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>specwin</p>
158 </td>
159 </tr>
160 <!-- Property: 'ws' -->
161 <tr valign="top">
162 <td>
163 <p><tt>ws</tt></p>
164 </td>
165 <td>
166 <p>Sum of window values</p>
167 </td>
168 <td>
169 <p>specwin</p>
170 </td>
171 </tr>
172 <!-- Property: 'ws2' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>ws2</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>Sum of squares of window values</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>specwin</p>
182 </td>
183 </tr>
184 <!-- Property: 'win' -->
185 <tr valign="top">
186 <td>
187 <p><tt>win</tt></p>
188 </td>
189 <td>
190 <p>Window samples (column vector)</p>
191 </td>
192 <td>
193 <p>specwin</p>
194 </td>
195 </tr>
196 <!-- Property: 'version' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><tt>version</tt></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>CVS version string of the constructor</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>specwin</p>
206 </td>
207 </tr>
208 </tbody>
209 </table>
210 </p>
211
212 <!-- ===== Top of page ===== -->
213 <a href="#top_of_page">
214 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
215 Back to Top
216 </a>
217
218 <h2 class="title"><a name="top_methods"/>Methods</h2>
219 <!-- ===== link box: Begin ===== -->
220 <p>
221 <table border="1" width="80%">
222 <tr>
223 <td>
224 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
225 <colgroup>
226 <col width="37%"/>
227 <col width="63%"/>
228 </colgroup>
229 <tbody>
230 <tr valign="top">
231 <td>
232 <a href="class_desc_specwin.html#constructor">Constructor</a>
233 </td>
234 <td>Constructor of this class</td>
235 </tr>
236 <tr valign="top">
237 <td>
238 <a href="class_desc_specwin.html#helper">Helper</a>
239 </td>
240 <td>Helper methods only for internal usage</td>
241 </tr>
242 <tr valign="top">
243 <td>
244 <a href="class_desc_specwin.html#output">Output</a>
245 </td>
246 <td>Output methods</td>
247 </tr>
248 <tr valign="top">
249 <td>
250 <a href="class_desc_specwin.html#relational_operator">Relational Operator</a>
251 </td>
252 <td>Relational operator methods</td>
253 </tr>
254 </tbody>
255 </table>
256 </td>
257 </tr>
258 </table>
259 </p>
260 <!-- ===== link box: End ====== -->
261
262 <!-- ===== Top of page ===== -->
263 <a href="#top_of_page">
264 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
265 Back to Top
266 </a>
267
268 <!-- ===== Methods Category: Constructor ===== -->
269 <h3 class="title"><a name="constructor"/>Constructor</h3>
270 <p>
271 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
272 <colgroup>
273 <col width="15%"/>
274 <col width="73%"/>
275 <col width="12%"/>
276 </colgroup>
277 <thead>
278 <tr valign="top">
279 <th class="categorylist">Methods</th>
280 <th class="categorylist">Description</th>
281 <th class="categorylist">Defined in class</th>
282 </tr>
283 </thead>
284 <tbody>
285 <!-- specwin/specwin -->
286 <tr valign="top">
287 <td bgcolor="#f3f4f5">
288 <p><a href="matlab:doc('specwin')">specwin</a></p>
289 </td>
290 <td bgcolor="#f3f4f5">
291 <p>% SPECWIN spectral window object class constructor.</p>
292 </td>
293 <td bgcolor="#f3f4f5">
294 <p>specwin</p>
295 </td>
296 </tr>
297 </tbody>
298 </table>
299 <!-- ===== Back to Top of Methods ===== -->
300 <a href="#top_methods">
301 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
302 Back to Top of Section
303 </a>
304
305 </p>
306
307 <!-- ===== Methods Category: Helper ===== -->
308 <h3 class="title"><a name="helper"/>Helper</h3>
309 <p>
310 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
311 <colgroup>
312 <col width="15%"/>
313 <col width="73%"/>
314 <col width="12%"/>
315 </colgroup>
316 <thead>
317 <tr valign="top">
318 <th class="categorylist">Methods</th>
319 <th class="categorylist">Description</th>
320 <th class="categorylist">Defined in class</th>
321 </tr>
322 </thead>
323 <tbody>
324 <!-- ltpda_obj/get -->
325 <tr valign="top">
326 <td bgcolor="#f3f4f5">
327 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
328 </td>
329 <td bgcolor="#f3f4f5">
330 <p>GET get a property of a object.</p>
331 </td>
332 <td bgcolor="#f3f4f5">
333 <p>ltpda_obj</p>
334 </td>
335 </tr>
336 <!-- ltpda_obj/isprop -->
337 <tr valign="top">
338 <td>
339 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
340 </td>
341 <td>
342 <p>ISPROP tests if the given field is one of the object properties.</p>
343 </td>
344 <td>
345 <p>ltpda_obj</p>
346 </td>
347 </tr>
348 </tbody>
349 </table>
350 <!-- ===== Back to Top of Methods ===== -->
351 <a href="#top_methods">
352 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
353 Back to Top of Section
354 </a>
355
356 </p>
357
358 <!-- ===== Methods Category: Output ===== -->
359 <h3 class="title"><a name="output"/>Output</h3>
360 <p>
361 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
362 <colgroup>
363 <col width="15%"/>
364 <col width="73%"/>
365 <col width="12%"/>
366 </colgroup>
367 <thead>
368 <tr valign="top">
369 <th class="categorylist">Methods</th>
370 <th class="categorylist">Description</th>
371 <th class="categorylist">Defined in class</th>
372 </tr>
373 </thead>
374 <tbody>
375 <!-- specwin/char -->
376 <tr valign="top">
377 <td bgcolor="#f3f4f5">
378 <p><a href="matlab:doc('specwin/char')">char</a></p>
379 </td>
380 <td bgcolor="#f3f4f5">
381 <p>CHAR convert a specwin object into a string.</p>
382 </td>
383 <td bgcolor="#f3f4f5">
384 <p>specwin</p>
385 </td>
386 </tr>
387 <!-- specwin/display -->
388 <tr valign="top">
389 <td>
390 <p><a href="matlab:doc('specwin/display')">display</a></p>
391 </td>
392 <td>
393 <p>DISPLAY overloads display functionality for specwin objects.</p>
394 </td>
395 <td>
396 <p>specwin</p>
397 </td>
398 </tr>
399 <!-- specwin/plot -->
400 <tr valign="top">
401 <td bgcolor="#f3f4f5">
402 <p><a href="matlab:doc('specwin/plot')">plot</a></p>
403 </td>
404 <td bgcolor="#f3f4f5">
405 <p>PLOT plots a specwin object.</p>
406 </td>
407 <td bgcolor="#f3f4f5">
408 <p>specwin</p>
409 </td>
410 </tr>
411 <!-- specwin/string -->
412 <tr valign="top">
413 <td>
414 <p><a href="matlab:doc('specwin/string')">string</a></p>
415 </td>
416 <td>
417 <p>STRING writes a command string that can be used to recreate the input window object.</p>
418 </td>
419 <td>
420 <p>specwin</p>
421 </td>
422 </tr>
423 </tbody>
424 </table>
425 <!-- ===== Back to Top of Methods ===== -->
426 <a href="#top_methods">
427 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
428 Back to Top of Section
429 </a>
430
431 </p>
432
433 <!-- ===== Methods Category: Relational_Operator ===== -->
434 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
435 <p>
436 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
437 <colgroup>
438 <col width="15%"/>
439 <col width="73%"/>
440 <col width="12%"/>
441 </colgroup>
442 <thead>
443 <tr valign="top">
444 <th class="categorylist">Methods</th>
445 <th class="categorylist">Description</th>
446 <th class="categorylist">Defined in class</th>
447 </tr>
448 </thead>
449 <tbody>
450 <!-- ltpda_obj/eq -->
451 <tr valign="top">
452 <td bgcolor="#f3f4f5">
453 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
454 </td>
455 <td bgcolor="#f3f4f5">
456 <p>EQ overloads the == operator for ltpda objects.</p>
457 </td>
458 <td bgcolor="#f3f4f5">
459 <p>ltpda_obj</p>
460 </td>
461 </tr>
462 <!-- ltpda_obj/ne -->
463 <tr valign="top">
464 <td>
465 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
466 </td>
467 <td>
468 <p>NE overloads the ~= operator for ltpda objects.</p>
469 </td>
470 <td>
471 <p>ltpda_obj</p>
472 </td>
473 </tr>
474 </tbody>
475 </table>
476 <!-- ===== Back to Top of Methods ===== -->
477 <a href="#top_methods">
478 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
479 Back to Top of Section
480 </a>
481
482 </p>
483
484 <!-- ================================================== -->
485 <!-- END CONTENT FILE -->
486 <!-- ================================================== -->