Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/lwb_blockProps.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>Setting block properties and parameters (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 "lwb_addBlocks.html"><img src="b_prev.gif" border="0" align=
30 "bottom" alt="Adding blocks to the canvas"></a>&nbsp;&nbsp;&nbsp;<a href=
31 "lwb_connectBlocks.html"><img src="b_next.gif" border="0" align=
32 "bottom" alt="Connecting blocks"></a></td>
33 </tr>
34 </table>
35
36 <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Setting block properties and parameters</h1>
37 <hr>
38
39 <p>
40 <p>
41
42 The different block types have different properties that the user can set.
43
44 <h2>LTPDA Algorithm Blocks</h2>
45
46 LTPDA Algorithm blocks (MBlocks) have both <i>properties</i> and <i>parameters</i>.
47 <br>
48 Properties of an MBlock are
49 <br>
50 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
51 <colgroup>
52 <col width="20%"/>
53 <col width="80%"/>
54 </colgroup>
55 <thead>
56 <tr valign="top">
57 <th class="categorylist">Property</th>
58 <th class="categorylist">Description</th>
59 </tr>
60 </thead>
61 <tbody>
62 <!-- Name -->
63 <tr valign="top">
64 <td bgcolor="#f3f4f5">
65 <p>Name</p>
66 </td>
67 <td bgcolor="#f3f4f5">
68 <p>The name of the block as it appears on the canvas Block names are unique on a canvas. This is also the
69 string that will be converted to a valid MATLAB variable name when the pipeline is executed.</p>
70 </td>
71 </tr>
72 <!-- Modifier -->
73 <tr valign="top">
74 <td bgcolor="#f3f4f5">
75 <p>Modifier</p>
76 </td>
77 <td bgcolor="#f3f4f5">
78 <p>
79 Set this block to be a modifier or not. For more details on modifier blocks in LTPDA see
80 <a href="objects_working.html#calling">Calling object methods</a>. The accepted values
81 are "true" or "false".
82 </p>
83 </td>
84 </tr>
85 </tbody>
86 </table>
87 <br>
88 <p>
89 To set the properties of a block, select one or more MBlocks, then double
90 click in the value column entry for the property you want to change. Enter the
91 new value and press return/enter.
92 </p>
93
94 <h3> Setting the parameter list </h3>
95
96 <p>
97 LTPDA Algorithm Blocks also have parameters which translate as a parameter list upon execution. To set
98 the parameters of a block, click on a block (or multiple MBlocks which represent the same LTPDA algorithm). You
99 will then see the 'current parameters' that the block holds. To edit the 'key' or 'value' of a parameter, double
100 click the table entry you want to edit, enter the new value, and hit <tt>enter</tt> or click OK.
101 </p>
102 <p>
103 To add or remove parameters from this list use the 'plus' and 'minus' buttons.
104 </p>
105 <p>
106 You can also select a set of predefined parameter sets from the drop-down menu above the parameter table.
107 Having selected a parameter set, you need to click the 'set' button to push these parameters to the block. You can then
108 go ahead and add or remove parameters from the 'current parameters' on the block.
109 </p>
110 <p>
111 Editing of most parameter keys and values is done in a simple editor dialog box. However, there are some
112 key/value pairs which are edited using special dialog boxes:
113 </p>
114
115 <h4>Built-in models of AO and SSM classes</h4>
116 <p>
117 Both the AO and the SSM classes can be built from pre-defined, built-in
118 models. These are typically created with a plist containing the key <tt>BUILT-IN</tt>.
119 If you try to edit the value for this key for one of these constructors, you will be
120 presented with a dialog box that allows you to choose from the built-in models. For all
121 other classes, editing the value for the key <tt>BUILT-IN</tt> is done via a standard
122 input dialog.
123 </p>
124 <br>
125 <br>
126 <img src="images/model_dialog.png" alt="Model dialog" border="3">
127 <br>
128 <br>
129
130 <h4>Pole/zero model editor</h4>
131 <p>
132 If any block has a parameter with the key <tt>PZMODEL</tt> then the
133 corresponding value will be edited via the Pole/zero model editor. Here
134 you can type directly in the constructor edit box, or you can add/remove
135 poles and zeros from the lists. To edit the frequency or Q of a pole or
136 zero, double-click on the table entry. To enter a real pole or zero (no Q),
137 set the Q to 'NaN'.
138 </p>
139 <br>
140 <br>
141 <img src="images/pzmodel_editor.png" alt="Model dialog" border="3">
142 <br>
143 <br>
144
145 <h4>Spectral window selector</h4>
146 <p>
147 Many algorithms in LTPDA accept a parameter with the key <tt>WIN</tt> for
148 a spectral window parameter. Editing the value for such a parameter presents
149 the user with a dialog where the spectral window can be selected from the list
150 of supported windows. You can also type the constructor directly in the edit
151 box.
152 </p>
153 <br>
154 <br>
155 <img src="images/specwin_editor.png" alt="Model dialog" border="3">
156 <br>
157 <br>
158
159 <h4>Repository hostname selector</h4>
160 <p>
161 Editing parameters with the key <tt>hostname</tt> will give the user
162 a dialog containing the pop-up menu of possible hostnames. This list of
163 hostnames is taken from the LTPDA Preferences. If the preferences are changed,
164 the workbench needs to be closed and reopened for the changes to propogate.
165 </p>
166
167 <h4>Filenames</h4>
168 <p>
169 If the parameter list contains a parameter with the key <tt>FILENAME</tt>, this
170 will be edited using standard file dialog boxes. If the block algorithm is <tt>save</tt>
171 a save dialog is presented. In all other cases, a load dialog is presented.
172 </p>
173
174
175 <h2>MATLAB Expression Blocks</h2>
176
177 MATLAB Expression blocks have two properties:
178 <br>
179 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
180 <colgroup>
181 <col width="20%"/>
182 <col width="80%"/>
183 </colgroup>
184 <thead>
185 <tr valign="top">
186 <th class="categorylist">Property</th>
187 <th class="categorylist">Description</th>
188 </tr>
189 </thead>
190 <tbody>
191 <!-- Name -->
192 <tr valign="top">
193 <td bgcolor="#f3f4f5">
194 <p>Name</p>
195 </td>
196 <td bgcolor="#f3f4f5">
197 <p>The name of the block as it appears on the canvas Block names are unique on a canvas. This is also the
198 string that will be converted to a valid MATLAB variable name when the pipeline is executed.</p>
199 </td>
200 </tr>
201 <!-- Modifier -->
202 <tr valign="top">
203 <td bgcolor="#f3f4f5">
204 <p>Expression</p>
205 </td>
206 <td bgcolor="#f3f4f5">
207 <p>
208 This is the (valid) MATLAB expression which, when evaluated, will be set to the variable name.
209 </p>
210 </td>
211 </tr>
212 </tbody>
213 </table>
214 <br>
215 To set the properties of a block, select one or more MATBlocks then double
216 click in the value column entry for the property you want to change. Enter the
217 new value and press return/enter.
218
219 Alternatively, you can double-click on a MATBlock to get a dialog box where you can enter the expression.
220
221
222 <h2>MATLAB Constant Blocks</h2>
223
224 Setting of properties on a MATLAB Constant block is just the same as MATBlocks; these blocks only differ
225 in the way they are handled at the time of execution.
226
227
228 <h2>Annotation Blocks</h2>
229
230 To set the text of an Annotation block, double click on the text area to start editing. Click off the block
231 to end editing.
232
233
234 </p>
235
236 </p>
237
238 <br>
239 <br>
240 <table class="nav" summary="Navigation aid" border="0" width=
241 "100%" cellpadding="0" cellspacing="0">
242 <tr valign="top">
243 <td align="left" width="20"><a href="lwb_addBlocks.html"><img src=
244 "b_prev.gif" border="0" align="bottom" alt=
245 "Adding blocks to the canvas"></a>&nbsp;</td>
246
247 <td align="left">Adding blocks to the canvas</td>
248
249 <td>&nbsp;</td>
250
251 <td align="right">Connecting blocks</td>
252
253 <td align="right" width="20"><a href=
254 "lwb_connectBlocks.html"><img src="b_next.gif" border="0" align=
255 "bottom" alt="Connecting blocks"></a></td>
256 </tr>
257 </table><br>
258
259 <p class="copy">&copy;LTP Team</p>
260 </body>
261 </html>