Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_xyzdata_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_xyzdata_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_xyzdata.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_xyzdata.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>xyzdata</p>
86 </td>
87 </tr>
88 <!-- Property: 'zunits' -->
89 <tr valign="top">
90 <td>
91 <p><tt>zunits</tt></p>
92 </td>
93 <td>
94 <p>Units of the z-axis</p>
95 </td>
96 <td>
97 <p>data3D</p>
98 </td>
99 </tr>
100 <!-- Property: 'z' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>z</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Data values of the z-axis</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>data3D</p>
110 </td>
111 </tr>
112 <!-- Property: 'xunits' -->
113 <tr valign="top">
114 <td>
115 <p><tt>xunits</tt></p>
116 </td>
117 <td>
118 <p>Units of the x-axis</p>
119 </td>
120 <td>
121 <p>data2D</p>
122 </td>
123 </tr>
124 <!-- Property: 'yunits' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>yunits</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>Units of the y-axis</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>data2D</p>
134 </td>
135 </tr>
136 <!-- Property: 'x' -->
137 <tr valign="top">
138 <td>
139 <p><tt>x</tt></p>
140 </td>
141 <td>
142 <p>Data values of the x-axis</p>
143 </td>
144 <td>
145 <p>data2D</p>
146 </td>
147 </tr>
148 <!-- Property: 'y' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>y</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>Data values of the y-axis</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>data2D</p>
158 </td>
159 </tr>
160 <!-- Property: 'dx' -->
161 <tr valign="top">
162 <td>
163 <p><tt>dx</tt></p>
164 </td>
165 <td>
166 <p>Error on x values</p>
167 </td>
168 <td>
169 <p>data2D</p>
170 </td>
171 </tr>
172 <!-- Property: 'dy' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>dy</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>Error on y values</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>data2D</p>
182 </td>
183 </tr>
184 </tbody>
185 </table>
186 </p>
187
188 <!-- ===== Top of page ===== -->
189 <a href="#top_of_page">
190 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
191 Back to Top
192 </a>
193
194 <h2 class="title"><a name="top_methods"/>Methods</h2>
195 <!-- ===== link box: Begin ===== -->
196 <p>
197 <table border="1" width="80%">
198 <tr>
199 <td>
200 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
201 <colgroup>
202 <col width="37%"/>
203 <col width="63%"/>
204 </colgroup>
205 <tbody>
206 <tr valign="top">
207 <td>
208 <a href="class_desc_xyzdata.html#constructor">Constructor</a>
209 </td>
210 <td>Constructor of this class</td>
211 </tr>
212 <tr valign="top">
213 <td>
214 <a href="class_desc_xyzdata.html#helper">Helper</a>
215 </td>
216 <td>Helper methods only for internal usage</td>
217 </tr>
218 <tr valign="top">
219 <td>
220 <a href="class_desc_xyzdata.html#internal">Internal</a>
221 </td>
222 <td>Internal methods only for internal usage</td>
223 </tr>
224 <tr valign="top">
225 <td>
226 <a href="class_desc_xyzdata.html#output">Output</a>
227 </td>
228 <td>Output methods</td>
229 </tr>
230 <tr valign="top">
231 <td>
232 <a href="class_desc_xyzdata.html#relational_operator">Relational Operator</a>
233 </td>
234 <td>Relational operator methods</td>
235 </tr>
236 </tbody>
237 </table>
238 </td>
239 </tr>
240 </table>
241 </p>
242 <!-- ===== link box: End ====== -->
243
244 <!-- ===== Top of page ===== -->
245 <a href="#top_of_page">
246 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
247 Back to Top
248 </a>
249
250 <!-- ===== Methods Category: Constructor ===== -->
251 <h3 class="title"><a name="constructor"/>Constructor</h3>
252 <p>
253 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
254 <colgroup>
255 <col width="15%"/>
256 <col width="73%"/>
257 <col width="12%"/>
258 </colgroup>
259 <thead>
260 <tr valign="top">
261 <th class="categorylist">Methods</th>
262 <th class="categorylist">Description</th>
263 <th class="categorylist">Defined in class</th>
264 </tr>
265 </thead>
266 <tbody>
267 <!-- xyzdata/xyzdata -->
268 <tr valign="top">
269 <td bgcolor="#f3f4f5">
270 <p><a href="matlab:doc('xyzdata')">xyzdata</a></p>
271 </td>
272 <td bgcolor="#f3f4f5">
273 <p>XZYDATA X-Y-Z data object class constructor.</p>
274 </td>
275 <td bgcolor="#f3f4f5">
276 <p>xyzdata</p>
277 </td>
278 </tr>
279 </tbody>
280 </table>
281 <!-- ===== Back to Top of Methods ===== -->
282 <a href="#top_methods">
283 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
284 Back to Top of Section
285 </a>
286
287 </p>
288
289 <!-- ===== Methods Category: Helper ===== -->
290 <h3 class="title"><a name="helper"/>Helper</h3>
291 <p>
292 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
293 <colgroup>
294 <col width="15%"/>
295 <col width="73%"/>
296 <col width="12%"/>
297 </colgroup>
298 <thead>
299 <tr valign="top">
300 <th class="categorylist">Methods</th>
301 <th class="categorylist">Description</th>
302 <th class="categorylist">Defined in class</th>
303 </tr>
304 </thead>
305 <tbody>
306 <!-- ltpda_obj/get -->
307 <tr valign="top">
308 <td bgcolor="#f3f4f5">
309 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
310 </td>
311 <td bgcolor="#f3f4f5">
312 <p>GET get a property of a object.</p>
313 </td>
314 <td bgcolor="#f3f4f5">
315 <p>ltpda_obj</p>
316 </td>
317 </tr>
318 <!-- ltpda_obj/isprop -->
319 <tr valign="top">
320 <td>
321 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
322 </td>
323 <td>
324 <p>ISPROP tests if the given field is one of the object properties.</p>
325 </td>
326 <td>
327 <p>ltpda_obj</p>
328 </td>
329 </tr>
330 </tbody>
331 </table>
332 <!-- ===== Back to Top of Methods ===== -->
333 <a href="#top_methods">
334 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
335 Back to Top of Section
336 </a>
337
338 </p>
339
340 <!-- ===== Methods Category: Internal ===== -->
341 <h3 class="title"><a name="internal"/>Internal</h3>
342 <p>
343 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
344 <colgroup>
345 <col width="15%"/>
346 <col width="73%"/>
347 <col width="12%"/>
348 </colgroup>
349 <thead>
350 <tr valign="top">
351 <th class="categorylist">Methods</th>
352 <th class="categorylist">Description</th>
353 <th class="categorylist">Defined in class</th>
354 </tr>
355 </thead>
356 <tbody>
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 <!-- data3D/getZ -->
490 <tr valign="top">
491 <td>
492 <p><a href="matlab:doc('data3D/getZ')">getZ</a></p>
493 </td>
494 <td>
495 <p>GETZ Get the property 'z'.</p>
496 </td>
497 <td>
498 <p>data3D</p>
499 </td>
500 </tr>
501 <!-- data3D/setZ -->
502 <tr valign="top">
503 <td bgcolor="#f3f4f5">
504 <p><a href="matlab:doc('data3D/setZ')">setZ</a></p>
505 </td>
506 <td bgcolor="#f3f4f5">
507 <p>SETZ Set the property 'z'.</p>
508 </td>
509 <td bgcolor="#f3f4f5">
510 <p>data3D</p>
511 </td>
512 </tr>
513 <!-- data3D/setZunits -->
514 <tr valign="top">
515 <td>
516 <p><a href="matlab:doc('data3D/setZunits')">setZunits</a></p>
517 </td>
518 <td>
519 <p>SETZUNITS Set the property 'zunits'.</p>
520 </td>
521 <td>
522 <p>data3D</p>
523 </td>
524 </tr>
525 </tbody>
526 </table>
527 <!-- ===== Back to Top of Methods ===== -->
528 <a href="#top_methods">
529 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
530 Back to Top of Section
531 </a>
532
533 </p>
534
535 <!-- ===== Methods Category: Output ===== -->
536 <h3 class="title"><a name="output"/>Output</h3>
537 <p>
538 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
539 <colgroup>
540 <col width="15%"/>
541 <col width="73%"/>
542 <col width="12%"/>
543 </colgroup>
544 <thead>
545 <tr valign="top">
546 <th class="categorylist">Methods</th>
547 <th class="categorylist">Description</th>
548 <th class="categorylist">Defined in class</th>
549 </tr>
550 </thead>
551 <tbody>
552 <!-- xyzdata/char -->
553 <tr valign="top">
554 <td bgcolor="#f3f4f5">
555 <p><a href="matlab:doc('xyzdata/char')">char</a></p>
556 </td>
557 <td bgcolor="#f3f4f5">
558 <p>CHAR convert a ltpda_data-object into a string.</p>
559 </td>
560 <td bgcolor="#f3f4f5">
561 <p>xyzdata</p>
562 </td>
563 </tr>
564 <!-- xyzdata/display -->
565 <tr valign="top">
566 <td>
567 <p><a href="matlab:doc('xyzdata/display')">display</a></p>
568 </td>
569 <td>
570 <p>DISPLAY overloads display functionality for xyzdata objects.</p>
571 </td>
572 <td>
573 <p>xyzdata</p>
574 </td>
575 </tr>
576 </tbody>
577 </table>
578 <!-- ===== Back to Top of Methods ===== -->
579 <a href="#top_methods">
580 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
581 Back to Top of Section
582 </a>
583
584 </p>
585
586 <!-- ===== Methods Category: Relational_Operator ===== -->
587 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
588 <p>
589 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
590 <colgroup>
591 <col width="15%"/>
592 <col width="73%"/>
593 <col width="12%"/>
594 </colgroup>
595 <thead>
596 <tr valign="top">
597 <th class="categorylist">Methods</th>
598 <th class="categorylist">Description</th>
599 <th class="categorylist">Defined in class</th>
600 </tr>
601 </thead>
602 <tbody>
603 <!-- ltpda_obj/eq -->
604 <tr valign="top">
605 <td bgcolor="#f3f4f5">
606 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
607 </td>
608 <td bgcolor="#f3f4f5">
609 <p>EQ overloads the == operator for ltpda objects.</p>
610 </td>
611 <td bgcolor="#f3f4f5">
612 <p>ltpda_obj</p>
613 </td>
614 </tr>
615 <!-- ltpda_obj/ne -->
616 <tr valign="top">
617 <td>
618 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
619 </td>
620 <td>
621 <p>NE overloads the ~= operator for ltpda objects.</p>
622 </td>
623 <td>
624 <p>ltpda_obj</p>
625 </td>
626 </tr>
627 </tbody>
628 </table>
629 <!-- ===== Back to Top of Methods ===== -->
630 <a href="#top_methods">
631 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
632 Back to Top of Section
633 </a>
634
635 </p>
636
637 <!-- ================================================== -->
638 <!-- END CONTENT FILE -->
639 <!-- ================================================== -->