Mercurial > hg > ltpda

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