Mercurial > hg > ltpda
view m-toolbox/html_help/help/ug/releasenotesV2_1.html @ 0:f0afece42f48
Import.
| author | Daniele Nicolodi <nicolodi@science.unitn.it> |
|---|---|
| date | Wed, 23 Nov 2011 19:22:13 +0100 |
| parents | |
| children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> <html lang="en"> <head> <meta name="generator" content= "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> <meta http-equiv="Content-Type" content= "text/html; charset=us-ascii"> <title>Version 2.1 LTPDA Toolbox Software (LTPDA Toolbox)</title> <link rel="stylesheet" href="docstyle.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> <meta name="description" content= "Presents an overview of the features, system requirements, and starting the toolbox."> </head> <body> <a name="top_of_page" id="top_of_page"></a> <p style="font-size:1px;"> </p> <table class="nav" summary="Navigation aid" border="0" width= "100%" cellpadding="0" cellspacing="0"> <tr> <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> <td valign="baseline" align="right"><a href= "releasenotesV2_2.html"><img src="b_prev.gif" border="0" align= "bottom" alt="Version 2.2 LTPDA Toolbox Software"></a> <a href= "releasenotesV2_0_1.html"><img src="b_next.gif" border="0" align= "bottom" alt="Version 2.0.1 LTPDA Toolbox Software"></a></td> </tr> </table> <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Version 2.1 LTPDA Toolbox Software</h1> <hr> <p> <!-- BEGIN: Content file --> <a name="top_of_page"></a> <p>This table summarizes what's new in Version 2.1:</p> <table cellspacing="0" class="body" cellpadding="4" border="2" width="100%"> <colgroup> <col width="25%"> <col width="25%"> <col width="25%"> <col width="25%"> </colgroup> <thead> <tr valign="top"> <th bgcolor="#B2B2B2" valign="top"><p>New Features and Changes</p></th> <th bgcolor="#B2B2B2" valign="top"><p>Version Compatibility Considerations</p></th> <th bgcolor="#B2B2B2" valign="top"><p>Fixed Bugs and Known Problems</p></th> <th bgcolor="#B2B2B2" valign="top"><p>Related Documentation at Web Site</p></th> </tr> </thead> <tbody> <tr valign="top"> <td bgcolor="#F2F2F2"><p>Yes<br>Details below</p></td> <td bgcolor="#F2F2F2"><p>Yes — Details labeled as <b>Deprecated methods</b> in descriptions of changes, below. See also <a href="#deprecated">Summary</a>.</p></td> <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> <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> </tr> </tbody> </table> <p></p> <ul> <li><p><a href="#introduction">Introduction</a></p></li> <li><p><a href="#newFeatures">New toolbox features</a></p></li> <li><p><a href="#newWbFeatures">New Workbench features</a></p></li> <li><p><a href="#newAOMethods">New AO methods</a></p></li> <li><p><a href="#mc">Main Changes</a></p></li> <li><p><a href="#deprecated">Deprecated methods</a></p></li> </ul> <!-- HEADLINE: Introduction --> <h3 class="title" id="introduction">Introduction</h3> <p>This version of LTPDA is 2.1. This document lists the changes since V2.0.1.</p> <!-- HEADLINE: New toolbox features --> <h3 class="title" id="newFeatures">New toolbox features</h3> <p>Version 2.1 of LTPDA has various new features.</p> <ul> <li><p>Analysis Objects have two new properties, <b>dx</b> and <b>dy</b>, for storing errors/uncertainties on the <b>x</b> and <b>y</b> data vectors. Currently, the spectral estimation tools (<b>psd, cohere</b>, etc) are calculating sample variances and assigning the values to <b>dy</b>. In this release, errors are not properly propagated through all additional functions; this is sometimes left to the user to handle. In a future release, the aim is to properly handle error propagation in all functions, where possible. Often this will mean deleting these vectors, or calculating new errors based on the input AOs.</p></li> <li> <p>All user objects now have the following new fields:</p> <ul> <li><p>description: a string that can be assigned to describe the object</p></li> <li><p>procinfo: a <b>plist</b> containing additional information produced during processing by an algorithm. The contents of the <b>plist</b> depend on the algorithm being applied.</p></li> </ul> </li> <li><p>Documentation (<b>>>help</b> method) has been significantly simplified. Now the details of the parameters for configuring a method are dynamically created and presented to the user in the MATLAB help browser after clicking on the ‘Parameter Sets’ link in the help text.</p></li> <li> <p>New user classes:</p> <ul> <li><p><b>smodel</b>: defines parametric models of an X variable which can be combined and evaluated to AOs.</p></li> <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> <li><p><b>filterbank</b>: represents a bank of digital filters. It can be either a ‘parallel’ or ‘serial’ filter bank.</p></li> </ul> </li> <li><p>All user classes now support built-in models.</p></li> <li><p>LTPDA now provides direct access to NDS (version 1) servers using the AO constructor ‘From NDS Server’. This requires the (3rd party) NDS client mex files to be available on the MATLAB path.</p></li> <li><p>The repository interactions are now done through purpose written java code so that no database toolbox is required. Also, the repository GUI (repogui) has been removed and the various features are replaced by individual GUI components which can be launched either via the workbench or via the new workspace browser (<b>workspaceBrowser</b>).</p></li> <li><p>A new GUI, the Workspace Browser (workspaceBrowser) allows fast access to various toolbox features as well as showing the current LTPDA user objects in the workspace.</p></li> </ul> <!-- HEADLINE: New Workbench features --> <h3 class="title" id="newWbFeatures">New Workbench features</h3> <p>Apart from various cosmetic improvements, the workbench has the following new features:</p> <ul> <li><p>The workbench now has a ‘recent files’ list under the File menu</p></li> <li><p>The workbench now has the concept of an ‘Execution plan’. Any or all of the pipelines in the workbench can be entered in the execution plan. The full plan can then be executed in the order given. To edit the plan: File->Plan->Edit. To run the plan: File->Plan->Run.</p></li> <li> <p>New block types:</p> <ul> <li><p>‘From Pipeline’ block allows the user to link together pipelines in the current workbench. Double clicking the ‘From Pipeline’ block allows the user to select the source to be from the output of any block on any other pipeline in the workbench. This goes along with the new ‘ Plan’ concept.</p> </li> <li><p>Mux/Demux blocks allow objects to be put in to, or removed from, arrays.</p></li> <li><p>‘To Workspace’ block pushes the objects to the MATLAB workspace.</p></li> </ul> </li> <li><p>A graphical representation of the current pipeline can be exported as a JPEG image.</p></li> <li><p>The workbench has a new panel called the ‘Shelf’. Users can store subsystems on the shelf and pull them off anytime in the future to include them in a different pipeline. The Shelf supports nested categories, exporting and importing of categories, and adding of subsystems from the canvas or from the shelf context menus.</p></li> <li><p>The pipelines of the current workbench are now shown in a tree-like structure, where the subsystems of each pipeline can also be seen.</p></li> <li><p>The block-property table has been re-coded to more nicely present the options to the user.</p></li> <li> <p>The parameter list table now supports:</p> <ul> <li><p>activating and deactivating individual parameters</p></li> <li><p>double-click in-place editing of the key and value</p></li> <li><p>selection of parameters with options via drop-down menus</p></li> <li><p>selection of boolean parameters via check-boxes</p></li> <li><p>editing of parameter values in special editors via the edit button (‘...’)</p></li> <li><p>changing the type of a parameter (double/char/boolean) via the context menu</p></li> </ul> </li> <li> <p>The workbench has the following new block button commands:</p> <ul> <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> <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> <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> </ul> </li> <li> <p>New menu entries for</p> <ul> <li><p>show quickblock (ctrl-b)</p></li> <li><p>edit canvas info (ctrl-i)</p></li> <li><p>search workbench (ctrl-f)</p></li> </ul> </li> <li><p>The element searching now has new features, like the ability to choose whether to search for block names, algorithms, or both. Info about the block <b>plist</b> is now shown as a tooltip on the results table, and double clicking a result highlights that block in the workbench.</p></li> <li><p>The workbench now supports plain text documents.</p></li> <li><p>The workbench output files have seen some optimisation and are much smaller than in earlier versions.</p></li> <li><p>A new special editor for keys: 'xunit', 'xunits', 'yunit', 'yunits', 'unit'.</p></li> <li><p>A new special editor for assembling a list of colors that can, for example, be passed to <b>iplot</b>. So far this will activate for any parameter with key 'colors' or 'linecolors'.</p></li> <li><p>A new special editor for a cell-array of line-styles, like that used in configuring iplot.</p></li> <li><p>A new special editor for building a list of markers. Activated for key 'markers'.</p></li> <li><p>A new special editor for the key 'plotinfo'. Allows to edit the line style, line width, color and marker for AOs.</p></li> <li><p>The workbench can now be attached to any or all output objects from all blocks on a pipeline. The workbench can then be loaded from the object, whether it’s on disk or in the MATLAB workspace. To attach the workbench to an object, select the block and set the property ‘Attach Workbench’ in the property table. To import a pipeline from an existing object, ‘File->Import Pipelines->From LTPDA Object...’.</p></li> <li><p>Blocks can be ‘Commented Out’ (deactivated) on the pipeline. These ‘commented out’ blocks will not be considered during pipeline execution.</p></li> <li> <p>The workbench now supports some direct interaction with an LTPDA Repository, avoiding the need to go through the repository GUI. For example, it is possible to:</p> <ul> <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> <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> <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> </ul> </li> <li><p>The workbench now has an autosave feature. This can be activated in the preferences (‘File->Preferences...’) and the interval can be set.</p></li> </ul> <!-- HEADLINE: New AO methods --> <h3 class="title" id="newAOMethods">New AO methods</h3> <ul> <li><p><b>ao/table</b>: display the data in the AO in a graphical table.</p></li> <li><p><b>ao/normdist</b>: computes a normal distributed pdf based on the mean and variance of the data in the AO.</p></li> <li><p><b>ao/corr</b>: computes the sample correlation matrix using Pearson's product-moment method.</p></li> <li><p><b>ao/linSubtract</b>: subtract linear contributions to a data set.</p></li> <li><p><b>ao/filtSubtract</b>: subtracts a frequency dependent noise contribution from an input ao.</p></li> <li><p><b>ao/hypot</b>: robust computation of square-root of the sum of the squares.</p></li> <li><p><b>ao/xfit</b>: fits a function of x to a data set using simplex non-linear fitting routine.</p></li> <li><p><b>ao/tdfit</b>: fits a model to a set of input and output data. The parametric model (<b>smodel</b>) should represent the system(s) which gives the outputs for the given inputs.</p></li> </ul> <!-- HEADLINE: Main Changes --> <h3 class="title" id="mc">Main Changes</h3> <ul> <li><p>All user-created objects now have a Universal Unique Identifier (UUID) which is reset whenever the object is modified (a history step is added).</p></li> <li><p>Cross-spectral estimators (<b>ltfe, cohere</b>, etc) now only accept two inputs and return a single output.</p></li> <li><p><b>ao/lscov</b> now returns a vector of AOs, each containing a single parameter, with units and errors.</p></li> <li><p>The statespace modelling class has been heavily rewritten and as such behaves differently than in previous versions. Review the LTPDA documentation for the new behaviour of this class.</p></li> <li><p>On Windows, Microsoft’s Visual C++ compiler version 2008 is used to compile the mex files. That means that the appropriate runtime environment must be installed. The installation files for 32-bit (<b>vcredist_x86.exe</b>) and 64-bit (<b>vcredist_x64.exe</b>) are included in the ltpda/src directory.</p></li> <li> <p>updated versions of <b>fft</b> and <b>ifft</b>.</p> <ul> <li> <p><b>fft</b></p> <p>– added 'plain' option which output the standard matlab <b>fft</b> results. Available parameters are now 'type' = 'plain', 'one' (onesided), 'two' (twosided)</p> <p>– frequency bins now are correctly calculated</p> </li> <li> <p><b>ifft</b></p> <p>– 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> </li> </ul> </li> <li><p><b>ao/iplot</b> now supports the <b>plotinfo</b> field of an AO. This means that each AO can be given specific plotting attributes. The <b>plotinfo</b> field can be set using <b>ao/setPlotinfo</b>. It is a parameter list of properties and values; see help of <b>ao/iplot</b> for supported properties. The values in <b>plotinfo</b> override all other inputs to <b>iplot</b> for that particular AO.</p></li> <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> </ul> <!-- HEADLINE: Deprecated methods --> <h3 class="title" id="deprecated">Deprecated methods</h3> <p>The following ao methods are deprecated</p> <ul> <li><p><b>ao/curvefit</b>: has been replaced by <b>ao/xfit</b> and as such will no longer be maintained.</p></li> <li><p><b>ao/pwelch</b>: is still deprecated. Use <b>ao/psd</b> instead.</p></li> </ul> <!-- END: Content file --> </p> <br> <br> <table class="nav" summary="Navigation aid" border="0" width= "100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td align="left" width="20"><a href="releasenotesV2_2.html"><img src= "b_prev.gif" border="0" align="bottom" alt= "Version 2.2 LTPDA Toolbox Software"></a> </td> <td align="left">Version 2.2 LTPDA Toolbox Software</td> <td> </td> <td align="right">Version 2.0.1 LTPDA Toolbox Software</td> <td align="right" width="20"><a href= "releasenotesV2_0_1.html"><img src="b_next.gif" border="0" align= "bottom" alt="Version 2.0.1 LTPDA Toolbox Software"></a></td> </tr> </table><br> <p class="copy">©LTP Team</p> </body> </html>