Mercurial > hg > ltpda

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