Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/lwb_blockProps.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 diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/lwb_blockProps.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,261 @@ +<!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>Setting block properties and parameters (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= + "lwb_addBlocks.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="Adding blocks to the canvas"></a> <a href= + "lwb_connectBlocks.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Connecting blocks"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Setting block properties and parameters</h1> + <hr> + + <p> + <p> + + The different block types have different properties that the user can set. + + <h2>LTPDA Algorithm Blocks</h2> + + LTPDA Algorithm blocks (MBlocks) have both <i>properties</i> and <i>parameters</i>. + <br> + Properties of an MBlock are + <br> + <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%"> + <colgroup> + <col width="20%"/> + <col width="80%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Property</th> + <th class="categorylist">Description</th> + </tr> + </thead> + <tbody> + <!-- Name --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p>Name</p> + </td> + <td bgcolor="#f3f4f5"> + <p>The name of the block as it appears on the canvas Block names are unique on a canvas. This is also the + string that will be converted to a valid MATLAB variable name when the pipeline is executed.</p> + </td> + </tr> + <!-- Modifier --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p>Modifier</p> + </td> + <td bgcolor="#f3f4f5"> + <p> + Set this block to be a modifier or not. For more details on modifier blocks in LTPDA see + <a href="objects_working.html#calling">Calling object methods</a>. The accepted values + are "true" or "false". + </p> + </td> + </tr> + </tbody> + </table> + <br> + <p> + To set the properties of a block, select one or more MBlocks, then double + click in the value column entry for the property you want to change. Enter the + new value and press return/enter. + </p> + + <h3> Setting the parameter list </h3> + + <p> + LTPDA Algorithm Blocks also have parameters which translate as a parameter list upon execution. To set + the parameters of a block, click on a block (or multiple MBlocks which represent the same LTPDA algorithm). You + will then see the 'current parameters' that the block holds. To edit the 'key' or 'value' of a parameter, double + click the table entry you want to edit, enter the new value, and hit <tt>enter</tt> or click OK. + </p> + <p> + To add or remove parameters from this list use the 'plus' and 'minus' buttons. + </p> + <p> + You can also select a set of predefined parameter sets from the drop-down menu above the parameter table. + Having selected a parameter set, you need to click the 'set' button to push these parameters to the block. You can then + go ahead and add or remove parameters from the 'current parameters' on the block. + </p> + <p> + Editing of most parameter keys and values is done in a simple editor dialog box. However, there are some + key/value pairs which are edited using special dialog boxes: + </p> + + <h4>Built-in models of AO and SSM classes</h4> + <p> + Both the AO and the SSM classes can be built from pre-defined, built-in + models. These are typically created with a plist containing the key <tt>BUILT-IN</tt>. + If you try to edit the value for this key for one of these constructors, you will be + presented with a dialog box that allows you to choose from the built-in models. For all + other classes, editing the value for the key <tt>BUILT-IN</tt> is done via a standard + input dialog. + </p> + <br> + <br> + <img src="images/model_dialog.png" alt="Model dialog" border="3"> + <br> + <br> + + <h4>Pole/zero model editor</h4> + <p> + If any block has a parameter with the key <tt>PZMODEL</tt> then the + corresponding value will be edited via the Pole/zero model editor. Here + you can type directly in the constructor edit box, or you can add/remove + poles and zeros from the lists. To edit the frequency or Q of a pole or + zero, double-click on the table entry. To enter a real pole or zero (no Q), + set the Q to 'NaN'. + </p> + <br> + <br> + <img src="images/pzmodel_editor.png" alt="Model dialog" border="3"> + <br> + <br> + + <h4>Spectral window selector</h4> + <p> + Many algorithms in LTPDA accept a parameter with the key <tt>WIN</tt> for + a spectral window parameter. Editing the value for such a parameter presents + the user with a dialog where the spectral window can be selected from the list + of supported windows. You can also type the constructor directly in the edit + box. + </p> + <br> + <br> + <img src="images/specwin_editor.png" alt="Model dialog" border="3"> + <br> + <br> + + <h4>Repository hostname selector</h4> + <p> + Editing parameters with the key <tt>hostname</tt> will give the user + a dialog containing the pop-up menu of possible hostnames. This list of + hostnames is taken from the LTPDA Preferences. If the preferences are changed, + the workbench needs to be closed and reopened for the changes to propogate. + </p> + + <h4>Filenames</h4> + <p> + If the parameter list contains a parameter with the key <tt>FILENAME</tt>, this + will be edited using standard file dialog boxes. If the block algorithm is <tt>save</tt> + a save dialog is presented. In all other cases, a load dialog is presented. + </p> + + + <h2>MATLAB Expression Blocks</h2> + + MATLAB Expression blocks have two properties: + <br> + <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%"> + <colgroup> + <col width="20%"/> + <col width="80%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Property</th> + <th class="categorylist">Description</th> + </tr> + </thead> + <tbody> + <!-- Name --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p>Name</p> + </td> + <td bgcolor="#f3f4f5"> + <p>The name of the block as it appears on the canvas Block names are unique on a canvas. This is also the + string that will be converted to a valid MATLAB variable name when the pipeline is executed.</p> + </td> + </tr> + <!-- Modifier --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p>Expression</p> + </td> + <td bgcolor="#f3f4f5"> + <p> + This is the (valid) MATLAB expression which, when evaluated, will be set to the variable name. + </p> + </td> + </tr> + </tbody> + </table> + <br> + To set the properties of a block, select one or more MATBlocks then double + click in the value column entry for the property you want to change. Enter the + new value and press return/enter. + + Alternatively, you can double-click on a MATBlock to get a dialog box where you can enter the expression. + + + <h2>MATLAB Constant Blocks</h2> + + Setting of properties on a MATLAB Constant block is just the same as MATBlocks; these blocks only differ + in the way they are handled at the time of execution. + + + <h2>Annotation Blocks</h2> + + To set the text of an Annotation block, double click on the text area to start editing. Click off the block + to end editing. + + +</p> + + </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="lwb_addBlocks.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "Adding blocks to the canvas"></a> </td> + + <td align="left">Adding blocks to the canvas</td> + + <td> </td> + + <td align="right">Connecting blocks</td> + + <td align="right" width="20"><a href= + "lwb_connectBlocks.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Connecting blocks"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>