Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/releasenotesV2_1_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
2 <!-- BEGIN: Content file -->
3
4 <a name="top_of_page"></a>
5 <p>This table summarizes what's new in Version 2.1:</p>
6 <table cellspacing="0" class="body" cellpadding="4" border="2" width="100%">
7 <colgroup>
8 <col width="25%">
9 <col width="25%">
10 <col width="25%">
11 <col width="25%">
12 </colgroup>
13 <thead>
14 <tr valign="top">
15 <th bgcolor="#B2B2B2" valign="top"><p>New Features and Changes</p></th>
16 <th bgcolor="#B2B2B2" valign="top"><p>Version Compatibility Considerations</p></th>
17 <th bgcolor="#B2B2B2" valign="top"><p>Fixed Bugs and Known Problems</p></th>
18 <th bgcolor="#B2B2B2" valign="top"><p>Related Documentation at Web Site</p></th>
19 </tr>
20 </thead>
21 <tbody>
22 <tr valign="top">
23 <td bgcolor="#F2F2F2"><p>Yes<br>Details below</p></td>
24 <td bgcolor="#F2F2F2"><p>Yes &#8212; Details labeled as <b>Deprecated methods</b> in descriptions of changes, below. See also <a href="#deprecated">Summary</a>.</p></td>
25 <td bgcolor="#F2F2F2"><p><a href="https://ed.fbk.eu/ltpda/mantis/login_page.php" target="_top">Bug Reports</a> at Web site</p></td>
26 <td bgcolor="#F2F2F2"><p>Printable Release Notes: <a href="http://www.lisa.aei-hannover.de/ltpda/downloads/version_2_1/files/Release_Notes_v2.pdf" target="_top">PDF</a></p></td>
27 </tr>
28 </tbody>
29 </table>
30 <p></p>
31 <ul>
32 <li><p><a href="#introduction">Introduction</a></p></li>
33 <li><p><a href="#newFeatures">New toolbox features</a></p></li>
34 <li><p><a href="#newWbFeatures">New Workbench features</a></p></li>
35 <li><p><a href="#newAOMethods">New AO methods</a></p></li>
36 <li><p><a href="#mc">Main Changes</a></p></li>
37 <li><p><a href="#deprecated">Deprecated methods</a></p></li>
38 </ul>
39
40 <!-- HEADLINE: Introduction -->
41
42 <h3 class="title" id="introduction">Introduction</h3>
43 <p>This version of LTPDA is 2.1. This document lists the changes since V2.0.1.</p>
44
45 <!-- HEADLINE: New toolbox features -->
46
47 <h3 class="title" id="newFeatures">New toolbox features</h3>
48 <p>Version 2.1 of LTPDA has various new features.</p>
49 <ul>
50 <li><p>Analysis Objects have two new properties, <b>dx</b> and <b>dy</b>,
51 for storing errors/uncertainties on the <b>x</b> and <b>y</b> data
52 vectors. Currently, the spectral estimation tools
53 (<b>psd, cohere</b>, etc) are calculating sample variances and
54 assigning the values to <b>dy</b>. In this release, errors are not
55 properly propagated through all additional functions; this is
56 sometimes left to the user to handle. In a future release, the aim is
57 to properly handle error propagation in all functions, where possible.
58 Often this will mean deleting these vectors, or calculating new errors
59 based on the input AOs.</p></li>
60 <li>
61 <p>All user objects now have the following new fields:</p>
62 <ul>
63 <li><p>description: a string that can be assigned to describe the object</p></li>
64 <li><p>procinfo: a <b>plist</b> containing additional information
65 produced during processing by an algorithm. The contents of the
66 <b>plist</b> depend on the algorithm being applied.</p></li>
67 </ul>
68 </li>
69 <li><p>Documentation (<b>>>help</b> method) has been significantly
70 simplified. Now the details of the parameters for configuring a method
71 are dynamically created and presented to the user in the MATLAB help
72 browser after clicking on the &lsquo;Parameter Sets&rsquo; link in the
73 help text.</p></li>
74 <li>
75 <p>New user classes:</p>
76 <ul>
77 <li><p><b>smodel</b>: defines parametric models of an X variable which can be combined and evaluated to AOs.</p></li>
78 <li><p><b>matrix</b>: a container class which can be used to group together other user objects and perform some basic matrix operations on the group of objects, not necessarily on the data in the objects.</p></li>
79 <li><p><b>filterbank</b>: represents a bank of digital filters. It can be either a &lsquo;parallel&rsquo; or &lsquo;serial&rsquo; filter bank.</p></li>
80 </ul>
81 </li>
82 <li><p>All user classes now support built-in models.</p></li>
83 <li><p>LTPDA now provides direct access to NDS (version 1) servers using
84 the AO constructor &lsquo;From NDS Server&rsquo;. This requires the (3rd party)
85 NDS client mex files to be available on the MATLAB path.</p></li>
86 <li><p>The repository interactions are now done through purpose written
87 java code so that no database toolbox is required. Also, the
88 repository GUI (repogui) has been removed and the various features
89 are replaced by individual GUI components which can be launched either
90 via the workbench or via the new workspace browser
91 (<b>workspaceBrowser</b>).</p></li>
92 <li><p>A new GUI, the Workspace Browser (workspaceBrowser) allows fast
93 access to various toolbox features as well as showing the current
94 LTPDA user objects in the workspace.</p></li>
95 </ul>
96
97 <!-- HEADLINE: New Workbench features -->
98
99 <h3 class="title" id="newWbFeatures">New Workbench features</h3>
100 <p>Apart from various cosmetic improvements, the workbench has the following new features:</p>
101 <ul>
102 <li><p>The workbench now has a &lsquo;recent files&rsquo; list under the File menu</p></li>
103 <li><p>The workbench now has the concept of an &lsquo;Execution plan&rsquo;. Any or
104 all of the pipelines in the workbench can be entered in the execution
105 plan. The full plan can then be executed in the order given. To edit
106 the plan: File->Plan->Edit. To run the plan: File->Plan->Run.</p></li>
107 <li>
108 <p>New block types:</p>
109 <ul>
110 <li><p>&lsquo;From Pipeline&rsquo; block allows the user to link
111 together pipelines in the current workbench. Double clicking
112 the &lsquo;From Pipeline&rsquo; block allows the user to select
113 the source to be from the output of any block on any other
114 pipeline in the workbench. This goes along with the new &lsquo;
115 Plan&rsquo; concept.</p>
116 </li>
117 <li><p>Mux/Demux blocks allow objects to be put in to, or removed from, arrays.</p></li>
118 <li><p>&lsquo;To Workspace&rsquo; block pushes the objects to the MATLAB workspace.</p></li>
119 </ul>
120 </li>
121 <li><p>A graphical representation of the current pipeline can be exported
122 as a JPEG image.</p></li>
123 <li><p>The workbench has a new panel called the &lsquo;Shelf&rsquo;.
124 Users can store subsystems on the shelf and pull them off anytime in
125 the future to include them in a different pipeline. The Shelf supports
126 nested categories, exporting and importing of categories, and adding
127 of subsystems from the canvas or from the shelf context menus.</p></li>
128 <li><p>The pipelines of the current workbench are now shown in a tree-like
129 structure, where the subsystems of each pipeline can also be seen.</p></li>
130 <li><p>The block-property table has been re-coded to more nicely present
131 the options to the user.</p></li>
132 <li>
133 <p>The parameter list table now supports:</p>
134 <ul>
135 <li><p>activating and deactivating individual parameters</p></li>
136 <li><p>double-click in-place editing of the key and value</p></li>
137 <li><p>selection of parameters with options via drop-down menus</p></li>
138 <li><p>selection of boolean parameters via check-boxes</p></li>
139 <li><p>editing of parameter values in special editors via the edit
140 button (&lsquo;...&rsquo;)</p></li>
141 <li><p>changing the type of a parameter (double/char/boolean) via the context menu</p></li>
142 </ul>
143 </li>
144 <li>
145 <p>The workbench has the following new block button commands:</p>
146 <ul>
147 <li><p><img alt="Controls save" width="18px" height="18px" src="images/release2_1_save.png">saves the outputs of selected objects to disk.</p></li>
148 <li><p><img alt="Controls save" width="18px" height="18px" src="images/release2_1_table.png">displays the data of the selected objects in tables.</p></li>
149 <li><p><img alt="Controls save" width="18px" height="18px" src="images/release2_1_report.png">present a report on the selected objects.</p></li>
150 </ul>
151 </li>
152 <li>
153 <p>New menu entries for</p>
154 <ul>
155 <li><p>show quickblock (ctrl-b)</p></li>
156 <li><p>edit canvas info (ctrl-i)</p></li>
157 <li><p>search workbench (ctrl-f)</p></li>
158 </ul>
159 </li>
160 <li><p>The element searching now has new features, like the ability
161 to choose whether to search for block names, algorithms, or both.
162 Info about the block <b>plist</b> is now shown as a tooltip on the
163 results table, and double clicking a result highlights that block in
164 the workbench.</p></li>
165 <li><p>The workbench now supports plain text documents.</p></li>
166 <li><p>The workbench output files have seen some optimisation and are much
167 smaller than in earlier versions.</p></li>
168 <li><p>A new special editor for keys: 'xunit', 'xunits', 'yunit', 'yunits', 'unit'.</p></li>
169 <li><p>A new special editor for assembling a list of colors that can, for
170 example, be passed to <b>iplot</b>. So far this will activate for any
171 parameter with key 'colors' or 'linecolors'.</p></li>
172 <li><p>A new special editor for a cell-array of line-styles, like that
173 used in configuring iplot.</p></li>
174 <li><p>A new special editor for building a list of markers. Activated for
175 key 'markers'.</p></li>
176 <li><p>A new special editor for the key 'plotinfo'. Allows to edit the
177 line style, line width, color and marker for AOs.</p></li>
178 <li><p>The workbench can now be attached to any or all output objects
179 from all blocks on a pipeline. The workbench can then be loaded from
180 the object, whether it&rsquo;s on disk or in the MATLAB workspace.
181 To attach the workbench to an object, select the block and set the
182 property &lsquo;Attach Workbench&rsquo; in the property table.
183 To import a pipeline from an existing object,
184 &lsquo;File->Import Pipelines->From LTPDA Object...&rsquo;.</p></li>
185 <li><p>Blocks can be &lsquo;Commented Out&rsquo; (deactivated) on
186 the pipeline. These &lsquo;commented out&rsquo; blocks will not be
187 considered during pipeline execution.</p></li>
188 <li>
189 <p>The workbench now supports some direct interaction with an LTPDA
190 Repository, avoiding the need to go through the repository GUI.
191 For example, it is possible to:</p>
192 <ul>
193 <li><p>(dis-)connect to a repository via the (dis-)connect (<img alt="Connect Button" width="18px" height="18px" src="images/release2_1_connect.png"><img alt="Disconnect Button" width="18px" height="18px" src="images/release2_1_disconnect.png">) button(s)</p></li>
194 <li><p>To submit the output of the selected blocks to the repository (pipeline must have been executed first) using the submit (<img alt="Connect Button" width="18px" height="18px" src="images/release2_1_add_to_database.png"><img alt="Disconnect Button" width="18px" height="18px" src="images/release2_1_disconnect.png">) button.</p></li>
195 <li><p>Query a repository using the query button (<img alt="Connect Button" width="18px" height="18px" src="images/release2_1_add_to_database.png"><img alt="Disconnect Button" width="18px" height="18px" src="images/release2_1_search_database.png">). Results of the query can be used to automatically build constructor blocks on the current pipeline.</p></li>
196 </ul>
197 </li>
198 <li><p>The workbench now has an autosave feature. This can be activated in the preferences (&lsquo;File->Preferences...&rsquo;) and the interval can be set.</p></li>
199 </ul>
200
201 <!-- HEADLINE: New AO methods -->
202
203 <h3 class="title" id="newAOMethods">New AO methods</h3>
204 <ul>
205 <li><p><b>ao/table</b>: display the data in the AO in a graphical table.</p></li>
206 <li><p><b>ao/normdist</b>: computes a normal distributed pdf based on the
207 mean and variance of the data in the AO.</p></li>
208 <li><p><b>ao/corr</b>: computes the sample correlation matrix using
209 Pearson's product-moment method.</p></li>
210 <li><p><b>ao/linSubtract</b>: subtract linear contributions to a data set.</p></li>
211 <li><p><b>ao/filtSubtract</b>: subtracts a frequency dependent noise
212 contribution from an input ao.</p></li>
213 <li><p><b>ao/hypot</b>: robust computation of square-root of the sum of the squares.</p></li>
214 <li><p><b>ao/xfit</b>: fits a function of x to a data set using simplex
215 non-linear fitting routine.</p></li>
216 <li><p><b>ao/tdfit</b>: fits a model to a set of input and output data.
217 The parametric model (<b>smodel</b>) should represent the system(s)
218 which gives the outputs for the given inputs.</p></li>
219 </ul>
220
221 <!-- HEADLINE: Main Changes -->
222
223 <h3 class="title" id="mc">Main Changes</h3>
224 <ul>
225 <li><p>All user-created objects now have a Universal Unique Identifier
226 (UUID) which is reset whenever the object is modified (a history step
227 is added).</p></li>
228 <li><p>Cross-spectral estimators (<b>ltfe, cohere</b>, etc) now only
229 accept two inputs and return a single output.</p></li>
230 <li><p><b>ao/lscov</b> now returns a vector of AOs, each containing a
231 single parameter, with units and errors.</p></li>
232 <li><p>The statespace modelling class has been heavily rewritten and as
233 such behaves differently than in previous versions. Review the LTPDA
234 documentation for the new behaviour of this class.</p></li>
235 <li><p>On Windows, Microsoft&rsquo;s Visual C++ compiler version 2008 is used
236 to compile the mex files. That means that the appropriate runtime
237 environment must be installed. The installation files for 32-bit
238 (<b>vcredist_x86.exe</b>) and 64-bit (<b>vcredist_x64.exe</b>) are
239 included in the ltpda/src directory.</p></li>
240 <li>
241 <p>updated versions of <b>fft</b> and <b>ifft</b>.</p>
242 <ul>
243 <li>
244 <p><b>fft</b></p>
245 <p>&ndash; added 'plain' option which output the standard matlab <b>fft</b> results. Available parameters are now 'type' = 'plain', 'one' (onesided), 'two' (twosided)</p>
246 <p>&ndash; frequency bins now are correctly calculated</p>
247 </li>
248 <li>
249 <p><b>ifft</b></p>
250 <p>&ndash; option twosided is no more necessary, the algorithm now is capable to distinguish between 'plain' fft, twosided fft, onesided fft with odd nfft or onesided fft with even nfft</p>
251 </li>
252 </ul>
253 </li>
254 <li><p><b>ao/iplot</b> now supports the <b>plotinfo</b> field of an AO.
255 This means that each AO can be given specific plotting attributes.
256 The <b>plotinfo</b> field can be set using <b>ao/setPlotinfo</b>.
257 It is a parameter list of properties and values; see help of
258 <b>ao/iplot</b> for supported properties. The values in <b>plotinfo</b>
259 override all other inputs to <b>iplot</b> for that particular AO.</p></li>
260 <li><p>The AO methods <b>polyfit, zDomainFit</b> and <b>sDomainFit</b> now return matrix objects. This change is not backwards compatible.</p></li>
261 </ul>
262
263 <!-- HEADLINE: Deprecated methods -->
264
265 <h3 class="title" id="deprecated">Deprecated methods</h3>
266 <p>The following ao methods are deprecated</p>
267 <ul>
268 <li><p><b>ao/curvefit</b>: has been replaced by <b>ao/xfit</b> and as such will no longer be maintained.</p></li>
269 <li><p><b>ao/pwelch</b>: is still deprecated. Use <b>ao/psd</b> instead.</p></li>
270 </ul>
271
272 <!-- END: Content file -->