Mercurial > hg > ltpda

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