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