Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_fsdata_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_fsdata_content.html,v 1.12 2009/03/17 17:14:03 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_fsdata.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_fsdata.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_main.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: 't0' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>t0</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Time-stamp of the first data sample</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>fsdata</p>
86 </td>
87 </tr>
88 <!-- Property: 'navs' -->
89 <tr valign="top">
90 <td>
91 <p><tt>navs</tt></p>
92 </td>
93 <td>
94 <p>Number of averages</p>
95 </td>
96 <td>
97 <p>fsdata</p>
98 </td>
99 </tr>
100 <!-- Property: 'fs' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>fs</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Sample rate of data</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>fsdata</p>
110 </td>
111 </tr>
112 <!-- Property: 'enbw' -->
113 <tr valign="top">
114 <td>
115 <p><tt>enbw</tt></p>
116 </td>
117 <td>
118 <p>Equivalent noise bandwidth</p>
119 </td>
120 <td>
121 <p>fsdata</p>
122 </td>
123 </tr>
124 <!-- Property: 'version' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>version</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>CVS version string of the constructor</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>fsdata</p>
134 </td>
135 </tr>
136 <!-- Property: 'xunits' -->
137 <tr valign="top">
138 <td>
139 <p><tt>xunits</tt></p>
140 </td>
141 <td>
142 <p>Units of the x-axis</p>
143 </td>
144 <td>
145 <p>data2D</p>
146 </td>
147 </tr>
148 <!-- Property: 'yunits' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>yunits</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>Units of the y-axis</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>data2D</p>
158 </td>
159 </tr>
160 <!-- Property: 'x' -->
161 <tr valign="top">
162 <td>
163 <p><tt>x</tt></p>
164 </td>
165 <td>
166 <p>Data values of the x-axis</p>
167 </td>
168 <td>
169 <p>data2D</p>
170 </td>
171 </tr>
172 <!-- Property: 'y' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>y</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>Data values of the y-axis</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>data2D</p>
182 </td>
183 </tr>
184 <!-- Property: 'dx' -->
185 <tr valign="top">
186 <td>
187 <p><tt>dx</tt></p>
188 </td>
189 <td>
190 <p>Error on x values</p>
191 </td>
192 <td>
193 <p>data2D</p>
194 </td>
195 </tr>
196 <!-- Property: 'dy' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><tt>dy</tt></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>Error on y values</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>data2D</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_fsdata.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_fsdata.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_fsdata.html#internal">Internal</a>
245 </td>
246 <td>Internal methods only for internal usage</td>
247 </tr>
248 <tr valign="top">
249 <td>
250 <a href="class_desc_fsdata.html#output">Output</a>
251 </td>
252 <td>Output methods</td>
253 </tr>
254 <tr valign="top">
255 <td>
256 <a href="class_desc_fsdata.html#relational_operator">Relational Operator</a>
257 </td>
258 <td>Relational operator methods</td>
259 </tr>
260 </tbody>
261 </table>
262 </td>
263 </tr>
264 </table>
265 </p>
266 <!-- ===== link box: End ====== -->
267
268 <!-- ===== Top of page ===== -->
269 <a href="#top_of_page">
270 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
271 Back to Top
272 </a>
273
274 <!-- ===== Methods Category: Constructor ===== -->
275 <h3 class="title"><a name="constructor"/>Constructor</h3>
276 <p>
277 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
278 <colgroup>
279 <col width="15%"/>
280 <col width="73%"/>
281 <col width="12%"/>
282 </colgroup>
283 <thead>
284 <tr valign="top">
285 <th class="categorylist">Methods</th>
286 <th class="categorylist">Description</th>
287 <th class="categorylist">Defined in class</th>
288 </tr>
289 </thead>
290 <tbody>
291 <!-- fsdata/fsdata -->
292 <tr valign="top">
293 <td bgcolor="#f3f4f5">
294 <p><a href="matlab:doc('fsdata')">fsdata</a></p>
295 </td>
296 <td bgcolor="#f3f4f5">
297 <p>FSDATA frequency-series object class constructor.</p>
298 </td>
299 <td bgcolor="#f3f4f5">
300 <p>fsdata</p>
301 </td>
302 </tr>
303 </tbody>
304 </table>
305 <!-- ===== Back to Top of Methods ===== -->
306 <a href="#top_methods">
307 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
308 Back to Top of Section
309 </a>
310
311 </p>
312
313 <!-- ===== Methods Category: Helper ===== -->
314 <h3 class="title"><a name="helper"/>Helper</h3>
315 <p>
316 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
317 <colgroup>
318 <col width="15%"/>
319 <col width="73%"/>
320 <col width="12%"/>
321 </colgroup>
322 <thead>
323 <tr valign="top">
324 <th class="categorylist">Methods</th>
325 <th class="categorylist">Description</th>
326 <th class="categorylist">Defined in class</th>
327 </tr>
328 </thead>
329 <tbody>
330 <!-- ltpda_obj/get -->
331 <tr valign="top">
332 <td bgcolor="#f3f4f5">
333 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
334 </td>
335 <td bgcolor="#f3f4f5">
336 <p>GET get a property of a object.</p>
337 </td>
338 <td bgcolor="#f3f4f5">
339 <p>ltpda_obj</p>
340 </td>
341 </tr>
342 <!-- ltpda_obj/isprop -->
343 <tr valign="top">
344 <td>
345 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
346 </td>
347 <td>
348 <p>ISPROP tests if the given field is one of the object properties.</p>
349 </td>
350 <td>
351 <p>ltpda_obj</p>
352 </td>
353 </tr>
354 </tbody>
355 </table>
356 <!-- ===== Back to Top of Methods ===== -->
357 <a href="#top_methods">
358 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
359 Back to Top of Section
360 </a>
361
362 </p>
363
364 <!-- ===== Methods Category: Internal ===== -->
365 <h3 class="title"><a name="internal"/>Internal</h3>
366 <p>
367 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
368 <colgroup>
369 <col width="15%"/>
370 <col width="73%"/>
371 <col width="12%"/>
372 </colgroup>
373 <thead>
374 <tr valign="top">
375 <th class="categorylist">Methods</th>
376 <th class="categorylist">Description</th>
377 <th class="categorylist">Defined in class</th>
378 </tr>
379 </thead>
380 <tbody>
381 <!-- data2D/applymethod -->
382 <tr valign="top">
383 <td bgcolor="#f3f4f5">
384 <p><a href="matlab:doc('data2D/applymethod')">applymethod</a></p>
385 </td>
386 <td bgcolor="#f3f4f5">
387 <p>APPLYMETHOD applys the given method to the input 2D data.</p>
388 </td>
389 <td bgcolor="#f3f4f5">
390 <p>data2D</p>
391 </td>
392 </tr>
393 <!-- data2D/applyoperator -->
394 <tr valign="top">
395 <td>
396 <p><a href="matlab:doc('data2D/applyoperator')">applyoperator</a></p>
397 </td>
398 <td>
399 <p>APPLYOPERATOR applys the given operator to the two input data objects.</p>
400 </td>
401 <td>
402 <p>data2D</p>
403 </td>
404 </tr>
405 <!-- data2D/getDx -->
406 <tr valign="top">
407 <td bgcolor="#f3f4f5">
408 <p><a href="matlab:doc('data2D/getDx')">getDx</a></p>
409 </td>
410 <td bgcolor="#f3f4f5">
411 <p>GETDX Get the property 'dx'.</p>
412 </td>
413 <td bgcolor="#f3f4f5">
414 <p>data2D</p>
415 </td>
416 </tr>
417 <!-- data2D/getDy -->
418 <tr valign="top">
419 <td>
420 <p><a href="matlab:doc('data2D/getDy')">getDy</a></p>
421 </td>
422 <td>
423 <p>GETDY Get the property 'dy'.</p>
424 </td>
425 <td>
426 <p>data2D</p>
427 </td>
428 </tr>
429 <!-- data2D/getX -->
430 <tr valign="top">
431 <td bgcolor="#f3f4f5">
432 <p><a href="matlab:doc('data2D/getX')">getX</a></p>
433 </td>
434 <td bgcolor="#f3f4f5">
435 <p>GETX Get the property 'x'.</p>
436 </td>
437 <td bgcolor="#f3f4f5">
438 <p>data2D</p>
439 </td>
440 </tr>
441 <!-- data2D/getY -->
442 <tr valign="top">
443 <td>
444 <p><a href="matlab:doc('data2D/getY')">getY</a></p>
445 </td>
446 <td>
447 <p>GETY Get the property 'y'.</p>
448 </td>
449 <td>
450 <p>data2D</p>
451 </td>
452 </tr>
453 <!-- data2D/setDx -->
454 <tr valign="top">
455 <td bgcolor="#f3f4f5">
456 <p><a href="matlab:doc('data2D/setDx')">setDx</a></p>
457 </td>
458 <td bgcolor="#f3f4f5">
459 <p>SETDX Set the property 'dx'.</p>
460 </td>
461 <td bgcolor="#f3f4f5">
462 <p>data2D</p>
463 </td>
464 </tr>
465 <!-- data2D/setDy -->
466 <tr valign="top">
467 <td>
468 <p><a href="matlab:doc('data2D/setDy')">setDy</a></p>
469 </td>
470 <td>
471 <p>SETDY Set the property 'dy'.</p>
472 </td>
473 <td>
474 <p>data2D</p>
475 </td>
476 </tr>
477 <!-- data2D/setX -->
478 <tr valign="top">
479 <td bgcolor="#f3f4f5">
480 <p><a href="matlab:doc('data2D/setX')">setX</a></p>
481 </td>
482 <td bgcolor="#f3f4f5">
483 <p>SETX Set the property 'x'.</p>
484 </td>
485 <td bgcolor="#f3f4f5">
486 <p>data2D</p>
487 </td>
488 </tr>
489 <!-- data2D/setXY -->
490 <tr valign="top">
491 <td>
492 <p><a href="matlab:doc('data2D/setXY')">setXY</a></p>
493 </td>
494 <td>
495 <p>SETXY Set the property 'xy'.</p>
496 </td>
497 <td>
498 <p>data2D</p>
499 </td>
500 </tr>
501 <!-- data2D/setXunits -->
502 <tr valign="top">
503 <td bgcolor="#f3f4f5">
504 <p><a href="matlab:doc('data2D/setXunits')">setXunits</a></p>
505 </td>
506 <td bgcolor="#f3f4f5">
507 <p>SETXUNITS Set the property 'xunits'.</p>
508 </td>
509 <td bgcolor="#f3f4f5">
510 <p>data2D</p>
511 </td>
512 </tr>
513 <!-- data2D/setY -->
514 <tr valign="top">
515 <td>
516 <p><a href="matlab:doc('data2D/setY')">setY</a></p>
517 </td>
518 <td>
519 <p>SETY Set the property 'y'.</p>
520 </td>
521 <td>
522 <p>data2D</p>
523 </td>
524 </tr>
525 <!-- data2D/setYunits -->
526 <tr valign="top">
527 <td bgcolor="#f3f4f5">
528 <p><a href="matlab:doc('data2D/setYunits')">setYunits</a></p>
529 </td>
530 <td bgcolor="#f3f4f5">
531 <p>SETYUNITS Set the property 'yunits'.</p>
532 </td>
533 <td bgcolor="#f3f4f5">
534 <p>data2D</p>
535 </td>
536 </tr>
537 <!-- fsdata/setEnbw -->
538 <tr valign="top">
539 <td>
540 <p><a href="matlab:doc('fsdata/setEnbw')">setEnbw</a></p>
541 </td>
542 <td>
543 <p>SETENBW Set the property 'enbw'.</p>
544 </td>
545 <td>
546 <p>fsdata</p>
547 </td>
548 </tr>
549 <!-- fsdata/setFs -->
550 <tr valign="top">
551 <td bgcolor="#f3f4f5">
552 <p><a href="matlab:doc('fsdata/setFs')">setFs</a></p>
553 </td>
554 <td bgcolor="#f3f4f5">
555 <p>SETFS Set the property 'fs'.</p>
556 </td>
557 <td bgcolor="#f3f4f5">
558 <p>fsdata</p>
559 </td>
560 </tr>
561 <!-- fsdata/setNavs -->
562 <tr valign="top">
563 <td>
564 <p><a href="matlab:doc('fsdata/setNavs')">setNavs</a></p>
565 </td>
566 <td>
567 <p>SETNAVS Set the property 'navs'.</p>
568 </td>
569 <td>
570 <p>fsdata</p>
571 </td>
572 </tr>
573 <!-- fsdata/setT0 -->
574 <tr valign="top">
575 <td bgcolor="#f3f4f5">
576 <p><a href="matlab:doc('fsdata/setT0')">setT0</a></p>
577 </td>
578 <td bgcolor="#f3f4f5">
579 <p>SETT0 Set the property 't0'.</p>
580 </td>
581 <td bgcolor="#f3f4f5">
582 <p>fsdata</p>
583 </td>
584 </tr>
585 </tbody>
586 </table>
587 <!-- ===== Back to Top of Methods ===== -->
588 <a href="#top_methods">
589 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
590 Back to Top of Section
591 </a>
592
593 </p>
594
595 <!-- ===== Methods Category: Output ===== -->
596 <h3 class="title"><a name="output"/>Output</h3>
597 <p>
598 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
599 <colgroup>
600 <col width="15%"/>
601 <col width="73%"/>
602 <col width="12%"/>
603 </colgroup>
604 <thead>
605 <tr valign="top">
606 <th class="categorylist">Methods</th>
607 <th class="categorylist">Description</th>
608 <th class="categorylist">Defined in class</th>
609 </tr>
610 </thead>
611 <tbody>
612 <!-- data2D/char -->
613 <tr valign="top">
614 <td bgcolor="#f3f4f5">
615 <p><a href="matlab:doc('data2D/char')">char</a></p>
616 </td>
617 <td bgcolor="#f3f4f5">
618 <p>CHAR convert a ltpda_data-object into a string.</p>
619 </td>
620 <td bgcolor="#f3f4f5">
621 <p>data2D</p>
622 </td>
623 </tr>
624 <!-- fsdata/display -->
625 <tr valign="top">
626 <td>
627 <p><a href="matlab:doc('fsdata/display')">display</a></p>
628 </td>
629 <td>
630 <p>DISPLAY implement terminal display for fsdata object.</p>
631 </td>
632 <td>
633 <p>fsdata</p>
634 </td>
635 </tr>
636 </tbody>
637 </table>
638 <!-- ===== Back to Top of Methods ===== -->
639 <a href="#top_methods">
640 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
641 Back to Top of Section
642 </a>
643
644 </p>
645
646 <!-- ===== Methods Category: Relational_Operator ===== -->
647 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
648 <p>
649 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
650 <colgroup>
651 <col width="15%"/>
652 <col width="73%"/>
653 <col width="12%"/>
654 </colgroup>
655 <thead>
656 <tr valign="top">
657 <th class="categorylist">Methods</th>
658 <th class="categorylist">Description</th>
659 <th class="categorylist">Defined in class</th>
660 </tr>
661 </thead>
662 <tbody>
663 <!-- ltpda_obj/eq -->
664 <tr valign="top">
665 <td bgcolor="#f3f4f5">
666 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
667 </td>
668 <td bgcolor="#f3f4f5">
669 <p>EQ overloads the == operator for ltpda objects.</p>
670 </td>
671 <td bgcolor="#f3f4f5">
672 <p>ltpda_obj</p>
673 </td>
674 </tr>
675 <!-- ltpda_obj/ne -->
676 <tr valign="top">
677 <td>
678 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
679 </td>
680 <td>
681 <p>NE overloads the ~= operator for ltpda objects.</p>
682 </td>
683 <td>
684 <p>ltpda_obj</p>
685 </td>
686 </tr>
687 </tbody>
688 </table>
689 <!-- ===== Back to Top of Methods ===== -->
690 <a href="#top_methods">
691 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
692 Back to Top of Section
693 </a>
694
695 </p>
696
697 <!-- ================================================== -->
698 <!-- END CONTENT FILE -->
699 <!-- ================================================== -->