Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/objects_intro.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 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
3
4 <html lang="en">
5 <head>
6 <meta name="generator" content=
7 "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org">
8 <meta http-equiv="Content-Type" content=
9 "text/html; charset=us-ascii">
10
11 <title>Introducing LTPDA Objects (LTPDA Toolbox)</title>
12 <link rel="stylesheet" href="docstyle.css" type="text/css">
13 <meta name="generator" content="DocBook XSL Stylesheets V1.52.2">
14 <meta name="description" content=
15 "Presents an overview of the features, system requirements, and starting the toolbox.">
16 </head>
17
18 <body>
19 <a name="top_of_page" id="top_of_page"></a>
20
21 <p style="font-size:1px;">&nbsp;</p>
22
23 <table class="nav" summary="Navigation aid" border="0" width=
24 "100%" cellpadding="0" cellspacing="0">
25 <tr>
26 <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td>
27
28 <td valign="baseline" align="right"><a href=
29 "userguide.html"><img src="b_prev.gif" border="0" align=
30 "bottom" alt="User Guide"></a>&nbsp;&nbsp;&nbsp;<a href=
31 "object_types.html"><img src="b_next.gif" border="0" align=
32 "bottom" alt="Types of User Objects"></a></td>
33 </tr>
34 </table>
35
36 <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Introducing LTPDA Objects</h1>
37 <hr>
38
39 <p>
40 <p>
41 The LTPDA toolbox is object oriented and as such, extends the MATLAB object types to many others. All data processing is
42 done using objects and methods of those classes.
43 </p>
44 <p>
45 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>.
46 </p>
47 <a name="classes" id= "classes"><h3 class="title">LTPDA Classes</h3></a>
48
49 <p>
50 Various classes make up the object-oriented infrastructure of LTPDA. The figure below shows all the classes in LTPDA.
51 All classes are derived from the base class, <tt>ltpda_obj</tt>. The classes then fall into two main types deriving
52 from the classes <tt>ltpda_nuo</tt> and <tt>ltpda_uo</tt>.
53 </p>
54 <br>
55 <img src="images/objects_class_diagram.png" alt="LTPDA classes">
56 <br>
57 <p>
58 The left branch, <tt>ltpda_nuo</tt>, are termed 'non-user objects'. These
59 objects are not typically accessed or created by users. The right branch, <tt>ltpda_uo</tt>, are termed 'user objects'.
60 These objects have a 'name' and a 'history' property which means that their processing history is tracked through all
61 LTPDA algorithms. In addition, these 'user objects' can be saved to disk or to an LTPDA repository.
62 </p>
63 <p>
64 The objects drawn in green are expected to be created by users in scripts or on the LTPDA GUI.
65 </p>
66
67
68 <p>Details of each class are given in:</p>
69
70 <table border="1" cellpadding="2" width="30%" bgcolor="#DDDDDD">
71 <tr valign="top">
72 <td><a href="class_desc_ao.html">analysis object class</a></td>
73 </tr>
74 <tr valign="top">
75 <td><a href="class_desc_ssm.html">statespace model class</a></td>
76 </tr>
77 <tr valign="top">
78 <td><a href="class_desc_rational.html">rational class</a></td>
79 </tr>
80 <tr valign="top">
81 <td><a href="class_desc_parfrac.html">partial fraction class</a></td>
82 </tr>
83 <tr valign="top">
84 <td><a href="class_desc_pzmodel.html">pole/zero model class</a></td>
85 </tr>
86 <tr valign="top">
87 <td><a href="class_desc_miir.html">iir filter class</a></td>
88 </tr>
89 <tr valign="top">
90 <td><a href="class_desc_mfir.html">fir filter class</a></td>
91 </tr>
92 <tr valign="top">
93 <td><a href="class_desc_timespan.html">timespan class</a></td>
94 </tr>
95 <tr valign="top">
96 <td><a href="class_desc_plist.html">parameter list class</a></td>
97 </tr>
98 <tr valign="top">
99 <td><a href="class_desc_specwin.html">spectral window class</a></td>
100 </tr>
101 <tr valign="top">
102 <td><a href="class_desc_time.html">time class</a></td>
103 </tr>
104 <tr valign="top">
105 <td><a href="class_desc_pz.html">pole/zero class</a></td>
106 </tr>
107 <tr valign="top">
108 <td><a href="class_desc_minfo.html">method info class</a></td>
109 </tr>
110 <tr valign="top">
111 <td><a href="class_desc_history.html">history class</a></td>
112 </tr>
113 <tr valign="top">
114 <td><a href="class_desc_provenance.html">provenance class</a></td>
115 </tr>
116 <tr valign="top">
117 <td><a href="class_desc_param.html">parameter class</a></td>
118 </tr>
119 <tr valign="top">
120 <td><a href="class_desc_unit.html">unit class</a></td>
121 </tr>
122 <tr valign="top">
123 <td><a href="class_desc_cdata.html">constant data class</a></td>
124 </tr>
125 <tr valign="top">
126 <td><a href="class_desc_xydata.html">xy data class</a></td>
127 </tr>
128 <tr valign="top">
129 <td><a href="class_desc_tsdata.html">time-series data class</a></td>
130 </tr>
131 <tr valign="top">
132 <td><a href="class_desc_fsdata.html">frequency-series data class</a></td>
133 </tr>
134 <tr valign="top">
135 <td><a href="class_desc_xyzdata.html">xyz data class</a></td>
136 </tr>
137 </table>
138
139 </p>
140
141 <br>
142 <br>
143 <table class="nav" summary="Navigation aid" border="0" width=
144 "100%" cellpadding="0" cellspacing="0">
145 <tr valign="top">
146 <td align="left" width="20"><a href="userguide.html"><img src=
147 "b_prev.gif" border="0" align="bottom" alt=
148 "User Guide"></a>&nbsp;</td>
149
150 <td align="left">User Guide</td>
151
152 <td>&nbsp;</td>
153
154 <td align="right">Types of User Objects</td>
155
156 <td align="right" width="20"><a href=
157 "object_types.html"><img src="b_next.gif" border="0" align=
158 "bottom" alt="Types of User Objects"></a></td>
159 </tr>
160 </table><br>
161
162 <p class="copy">&copy;LTP Team</p>
163 </body>
164 </html>