Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/objects_intro_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 <p>
2 The LTPDA toolbox is object oriented and as such, extends the MATLAB object types to many others. All data processing is
3 done using objects and methods of those classes.
4 </p>
5 <p>
6 For full details of objects in MATLAB, refer to <a href="matlab:web(['jar:file:///' matlabroot '/help/techdoc/help.jar!/matlab_oop/ug_intropage.html'])">MATLAB Classes and Object-Oriented Programming</a>.
7 </p>
8 <a name="classes" id= "classes"><h3 class="title">LTPDA Classes</h3></a>
9
10 <p>
11 Various classes make up the object-oriented infrastructure of LTPDA. The figure below shows all the classes in LTPDA.
12 All classes are derived from the base class, <tt>ltpda_obj</tt>. The classes then fall into two main types deriving
13 from the classes <tt>ltpda_nuo</tt> and <tt>ltpda_uo</tt>.
14 </p>
15 <br>
16 <img src="images/objects_class_diagram.png" alt="LTPDA classes">
17 <br>
18 <p>
19 The left branch, <tt>ltpda_nuo</tt>, are termed 'non-user objects'. These
20 objects are not typically accessed or created by users. The right branch, <tt>ltpda_uo</tt>, are termed 'user objects'.
21 These objects have a 'name' and a 'history' property which means that their processing history is tracked through all
22 LTPDA algorithms. In addition, these 'user objects' can be saved to disk or to an LTPDA repository.
23 </p>
24 <p>
25 The objects drawn in green are expected to be created by users in scripts or on the LTPDA GUI.
26 </p>
27
28
29 <p>Details of each class are given in:</p>
30
31 <table border="1" cellpadding="2" width="30%" bgcolor="#DDDDDD">
32 <tr valign="top">
33 <td><a href="class_desc_ao.html">analysis object class</a></td>
34 </tr>
35 <tr valign="top">
36 <td><a href="class_desc_ssm.html">statespace model class</a></td>
37 </tr>
38 <tr valign="top">
39 <td><a href="class_desc_rational.html">rational class</a></td>
40 </tr>
41 <tr valign="top">
42 <td><a href="class_desc_parfrac.html">partial fraction class</a></td>
43 </tr>
44 <tr valign="top">
45 <td><a href="class_desc_pzmodel.html">pole/zero model class</a></td>
46 </tr>
47 <tr valign="top">
48 <td><a href="class_desc_miir.html">iir filter class</a></td>
49 </tr>
50 <tr valign="top">
51 <td><a href="class_desc_mfir.html">fir filter class</a></td>
52 </tr>
53 <tr valign="top">
54 <td><a href="class_desc_timespan.html">timespan class</a></td>
55 </tr>
56 <tr valign="top">
57 <td><a href="class_desc_plist.html">parameter list class</a></td>
58 </tr>
59 <tr valign="top">
60 <td><a href="class_desc_specwin.html">spectral window class</a></td>
61 </tr>
62 <tr valign="top">
63 <td><a href="class_desc_time.html">time class</a></td>
64 </tr>
65 <tr valign="top">
66 <td><a href="class_desc_pz.html">pole/zero class</a></td>
67 </tr>
68 <tr valign="top">
69 <td><a href="class_desc_minfo.html">method info class</a></td>
70 </tr>
71 <tr valign="top">
72 <td><a href="class_desc_history.html">history class</a></td>
73 </tr>
74 <tr valign="top">
75 <td><a href="class_desc_provenance.html">provenance class</a></td>
76 </tr>
77 <tr valign="top">
78 <td><a href="class_desc_param.html">parameter class</a></td>
79 </tr>
80 <tr valign="top">
81 <td><a href="class_desc_unit.html">unit class</a></td>
82 </tr>
83 <tr valign="top">
84 <td><a href="class_desc_cdata.html">constant data class</a></td>
85 </tr>
86 <tr valign="top">
87 <td><a href="class_desc_xydata.html">xy data class</a></td>
88 </tr>
89 <tr valign="top">
90 <td><a href="class_desc_tsdata.html">time-series data class</a></td>
91 </tr>
92 <tr valign="top">
93 <td><a href="class_desc_fsdata.html">frequency-series data class</a></td>
94 </tr>
95 <tr valign="top">
96 <td><a href="class_desc_xyzdata.html">xyz data class</a></td>
97 </tr>
98 </table>