Mercurial > hg > ltpda
comparison m-toolbox/test/MPipeline/ssmtest.lwb @ 0:f0afece42f48
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 <?xml version="1.0" encoding="utf-8"?> | |
2 <LTPDAworkbench filepath="/Users/hewitson/working/ltp/ltpda/software/m-toolbox/test/MPipeline/ssmtest.lwb" name="ssmtest.lwb*"> | |
3 <document name="SSM pipeline"> | |
4 <block bounds="0 0 110 100" inputs="1" name="DFACS" outputs="1"> | |
5 <LTPDAalgorithm mcategory="Constructor" mclass="ssm" mname="ssm" mpackage="" mversion="" portdims="1 10 1 10"> | |
6 <HelpText> SSM statespace model class constructor. | |
7 | |
8 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
9 | |
10 DESCRIPTION: SSM statespace model class constructor. | |
11 | |
12 ** This class is written using the new OO structures of MATLAB R2008a and | |
13 will not work with earlier MATLAB versions. | |
14 | |
15 Public properties (read-only): | |
16 | |
17 Public properties (read/write): | |
18 name - name of analysis object | |
19 | |
20 Possible constructors: | |
21 | |
22 s = ssm() - creates an empty statespace model | |
23 s = ssm('a1.xml') - creates a new statespace model by loading the | |
24 object from disk. | |
25 s = ssm('a1.mat') - creates a new statespace model by loading the | |
26 object from disk. | |
27 a = ssm(plist) - creates a statespace model from the description | |
28 given in the parameter list | |
29 a = ssm(struct) - creates a statespace model from the | |
30 structure returned by struct(ssm). | |
31 | |
32 Parameter sets for plist constructor (in order of priority): | |
33 | |
34 From XML File | |
35 ------------- | |
36 Construct a statespace model by loading it from an XML file. | |
37 | |
38 'filename' - construct a statespace model from a filename. | |
39 Example: plist('filename', 'ss1.xml') | |
40 [default: empty string] | |
41 | |
42 From MAT File | |
43 ------------- | |
44 Construct a statespace model by loading it from a MAT file. | |
45 | |
46 'filename' - construct a statespace model from a filename. | |
47 Example: plist('filename', 'ss1.mat') | |
48 [default: empty string] | |
49 | |
50 From Built-in System | |
51 ---------------- | |
52 Construct a statespace model by specifying one of the built-in system | |
53 names. Built-in models are stored in directories specified by | |
54 SSM_MODELS in ltpda_startup. You can list multiple directories. A | |
55 built-in model m-file must follow the naming convention ssm_model_*.m. | |
56 | |
57 'Buit-in' - A system name. | |
58 Example: plist('filename', 'model_LPF_Dynamics_noparams') | |
59 Example: plist('Built-in', ' ') | |
60 will show the names of all the existing systems | |
61 | |
62 'dim' - Optional parameter to reduce the model to 1, 3, or 6 | |
63 dimension. [Default: empty [] - return full model] | |
64 | |
65 From Repository | |
66 --------------- | |
67 Construct a statespace model by retrieving it from an LTPDA repository. | |
68 | |
69 'Hostname' - the repository hostname. Only those objects which | |
70 are statespace models are returned. | |
71 [default: 'localhost']; | |
72 | |
73 Additional parameters: | |
74 | |
75 'Database' - The database name [default: 'ltpda'] | |
76 'ID' - A vector of object IDs. [default: []] | |
77 'CID' - Retrieve all SSM objects from a particular | |
78 collection. | |
79 | |
80 From a Miir | |
81 --------------- | |
82 Construct a statespace model out of a MIIR object. | |
83 | |
84 example : sys = ssm(themiir); | |
85 | |
86 From PZ model | |
87 --------------- | |
88 Construct a statespace model by retrieving it from an LTPDA repository. | |
89 | |
90 example : sys=ssm(thepzmodel); | |
91 | |
92 | |
93 From Description | |
94 ---------------- | |
95 Construct a statespace model from a full description of the system. | |
96 | |
97 'isADescription' >> special filed to tell the constructor which set to use | |
98 | |
99 compulsory fields: | |
100 'name','ssnames', 'outputnames', 'inputnames', 'timestep', 'amats', ... | |
101 'bmats', 'cmats', 'dmats', 'paramnames', 'paramvalues' | |
102 | |
103 optionnals fields : | |
104 'mmats' 'amats_handles' 'bmats_handles' 'cmats_handles' 'dmats_handles'... | |
105 'inputvarnames' 'ssvarnames' 'outputvarnames' 'paramsigmas' | |
106 | |
107 example : | |
108 name = 'sys'; | |
109 ssnames = {'ss1' 'ss2' 'ss3'}; | |
110 ssvarnames = {{'ssvar1'} {'ssvar2'} {'ssvar31' 'ssvar32'}}; | |
111 inputnames = {'input1' 'input2' 'input3'}; | |
112 inputvarnames = {{'inputvar1'} {'inputvar2'} {'inputvar31' 'inputvar32'}}; | |
113 outputnames = {'output1' 'output2' 'output3'}; | |
114 outputvarnames = {{'outputvar1'} {'outputvar2'} {'outputvar31' 'outputvar32'}}; | |
115 timestep = 0; | |
116 paramnames = {}; | |
117 paramvalues = []; | |
118 amats = cell(3,3); | |
119 bmats = cell(3,3); | |
120 cmats = cell(3,3); | |
121 dmats = cell(3,3); | |
122 amats{1,1} = -1; | |
123 amats{2,2} = -2; | |
124 amats{3,3} = -3*eye(2); | |
125 amats{3,1} = [-1;-3]; | |
126 bmats{1,1} = 1; | |
127 bmats{2,2} = 2; | |
128 bmats{3,3} = 3*eye(2); | |
129 cmats{1,1} = 1; | |
130 cmats{2,2} = 1; | |
131 cmats{3,3} = eye(2); | |
132 dmats{1,3} = [6 6]; | |
133 dmats{2,1} = 6; | |
134 dmats{3,2} = [6;6]; | |
135 sys = ssm(plist('isADescription', '' ,'name', name , ... | |
136 'timestep', timestep , 'paramnames', paramnames ,'paramvalues', paramvalues ,... | |
137 'inputnames', inputnames , 'outputnames',outputnames ,'ssnames', ssnames,... | |
138 'inputvarnames', inputvarnames , 'outputvarnames',outputvarnames ,'ssvarnames', ssvarnames,... | |
139 'amats', amats ,'bmats', bmats ,'cmats', cmats ,'dmats', dmats )); | |
140 | |
141 | |
142 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
143 </HelpText> | |
144 <sets> | |
145 <set name="Default"/> | |
146 <set name="From XML File"/> | |
147 <set name="From MAT File"/> | |
148 <set name="From Built-in Model"/> | |
149 <set name="From Description"/> | |
150 <set name="From Plist"/> | |
151 <set name="From Repository"/> | |
152 <set name="From Pzmodel"/> | |
153 <set name="From Miir"/> | |
154 </sets> | |
155 <plists> | |
156 <plist name="none"/> | |
157 <plist name="none"> | |
158 <param> | |
159 <key>FILENAME</key> | |
160 <val/> | |
161 <type>char</type> | |
162 </param> | |
163 </plist> | |
164 <plist name="none"> | |
165 <param> | |
166 <key>FILENAME</key> | |
167 <val/> | |
168 <type>char</type> | |
169 </param> | |
170 </plist> | |
171 <plist name="none"> | |
172 <param> | |
173 <key>BUILT-IN</key> | |
174 <val/> | |
175 <type>char</type> | |
176 </param> | |
177 <param> | |
178 <key>DIM</key> | |
179 <val>3</val> | |
180 <type>double</type> | |
181 </param> | |
182 <param> | |
183 <key>WITHPARAMS</key> | |
184 <val>true</val> | |
185 <type>logical</type> | |
186 </param> | |
187 </plist> | |
188 <plist name="none"/> | |
189 <plist name="none"> | |
190 <param> | |
191 <key>PLIST</key> | |
192 <val>(empty-plist)</val> | |
193 <type>plist</type> | |
194 </param> | |
195 </plist> | |
196 <plist name="none"> | |
197 <param> | |
198 <key>HOSTNAME</key> | |
199 <val>localhost</val> | |
200 <type>char</type> | |
201 </param> | |
202 <param> | |
203 <key>DATABASE</key> | |
204 <val>ltpda</val> | |
205 <type>char</type> | |
206 </param> | |
207 <param> | |
208 <key>ID</key> | |
209 <val>[]</val> | |
210 <type>double</type> | |
211 </param> | |
212 </plist> | |
213 <plist name="none"> | |
214 <param> | |
215 <key>PZMODEL</key> | |
216 <val>pzmodel(none)</val> | |
217 <type>pzmodel</type> | |
218 </param> | |
219 </plist> | |
220 <plist name="none"> | |
221 <param> | |
222 <key>MIIR</key> | |
223 <val>none(fs=, ntaps=0.00, a=[], b=[])</val> | |
224 <type>miir</type> | |
225 </param> | |
226 </plist> | |
227 </plists> | |
228 </LTPDAalgorithm> | |
229 <plist name="none"> | |
230 <param> | |
231 <key>BUILT-IN</key> | |
232 <val>DFACS_5_Science_Mode_1_All_Optical_Readouts</val> | |
233 <type>char</type> | |
234 </param> | |
235 <param> | |
236 <key>DIM</key> | |
237 <val>1</val> | |
238 <type>double</type> | |
239 </param> | |
240 <param> | |
241 <key>WITHPARAMS</key> | |
242 <val>true</val> | |
243 <type>logical</type> | |
244 </param> | |
245 </plist> | |
246 <port number="0" type="output"> | |
247 <node> | |
248 <pipe dstblock="set DFACS name" dstport="0" srcblock="DFACS"/> | |
249 </node> | |
250 </port> | |
251 </block> | |
252 <block bounds="150 0 110 100" inputs="1" name="set DFACS name" outputs="1"> | |
253 <LTPDAalgorithm mcategory="Helper" mclass="ltpda_uoh" mname="setName" mpackage="" mversion="" portdims="1 10 1 10"> | |
254 <HelpText> SETNAME Set the property 'name'. | |
255 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
256 | |
257 DESCRIPTION: Set the property 'name'. | |
258 | |
259 CALL: obj = obj.setName('new name'); | |
260 obj = obj.setName(plist('name', 'new name')); | |
261 obj = setName(obj, 'new name'); | |
262 obj = setName(); | |
263 | |
264 EXAMPLE: obj.setName -> Sets the name to the variable name. | |
265 In this case to 'obj' | |
266 | |
267 INPUTS: obj - can be a vector, matrix, list, or a mix of them. | |
268 pl - to set the name with a plist specify only one plist with | |
269 only one key-word 'name'. | |
270 | |
271 M-FILE INFO: Get information about this methods by calling | |
272 >> ao.getInfo('setName') | |
273 | |
274 Get information about a specified set-plist by calling: | |
275 >> ao.getInfo('setName', 'set') | |
276 | |
277 VERSION: $Id: ssmtest.lwb,v 1.1 2009/01/13 12:39:16 hewitson Exp $ | |
278 | |
279 HISTORY: 27-05-2008 Diepholz | |
280 Creation | |
281 | |
282 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
283 </HelpText> | |
284 <sets> | |
285 <set name="Default"/> | |
286 </sets> | |
287 <plists> | |
288 <plist name="none"> | |
289 <param> | |
290 <key>NAME</key> | |
291 <val/> | |
292 <type>char</type> | |
293 </param> | |
294 </plist> | |
295 </plists> | |
296 </LTPDAalgorithm> | |
297 <plist name="none"> | |
298 <param> | |
299 <key>NAME</key> | |
300 <val/> | |
301 <type>char</type> | |
302 </param> | |
303 </plist> | |
304 <port number="0" type="output"> | |
305 <node> | |
306 <pipe dstblock="simulate DFACS" dstport="0" srcblock="set DFACS name"/> | |
307 </node> | |
308 </port> | |
309 </block> | |
310 <block bounds="250 100 110 100" inputs="2" name="simulate DFACS" outputs="1"> | |
311 <LTPDAalgorithm mcategory="Statespace" mclass="ssm" mname="simulate" mpackage="" mversion="" portdims="1 10 1 10"> | |
312 <HelpText> simulate simulates a discrete ssm with given inputs | |
313 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
314 | |
315 DESCRIPTION: %simulate simulates a discrete ssm with given inputs | |
316 | |
317 CALL: [ao_out pl_out] = simulate(sys, plist_inputs) | |
318 | |
319 INPUTS: | |
320 - sys, (array of) ssm object | |
321 - plist_inputs contains 10 fields : | |
322 - 2 noise fields | |
323 - 'noise variable names' with a cell vector of strings of | |
324 the desired input variable names | |
325 - 'covariance' which gives the covariance of this noise between | |
326 the different corresponding inputs given for the *TIME | |
327 CONTINUOUS* noise model | |
328 - 2 fields for input aos : | |
329 - 'aos variable names' with a cell vector of strings of | |
330 the desired input variable names | |
331 - 'aos' which gives the aos for the different | |
332 corresponding inputs | |
333 - 2 fields to plug in constants : | |
334 - 'constant variable names' with a cell vector of strings of | |
335 the desired input variable names | |
336 - 'constants' which gives the DC value for the different | |
337 corresponding inputs | |
338 - 2 arrays telling which blocks should be stored and returned | |
339 - 'return states' : for blocks of the state space (ex [8]) | |
340 - 'return outputs' : for blocks of the output (ex [1 5]) | |
341 - 1 field 'Nsamples' telling max number of samples to use | |
342 (it is smaller if aos are shorter than Nsamples) | |
343 - 1 field 'ssini' is a cell array of vectors that give the | |
344 initial position for simulation. 0 is the default. | |
345 - 1 field 'tini' for the initial time, a time object or a number | |
346 (in millisec). | |
347 - 1 field 'displayTime' (0/1) to switch off/on the display. | |
348 0 (Off) is the default value | |
349 | |
350 OUTPUTS: | |
351 _ pl_out contains 'lastX', the last state position | |
352 | |
353 *** the plist CANNOT be arrays anymore. *** | |
354 Because of the very large number of output it is not desirable to have | |
355 more than 1 simulation per function run. | |
356 | |
357 | |
358 M-FILE INFO: Get information about this methods by calling | |
359 >> ssm.getInfo('simulate') | |
360 | |
361 Get information about a specified set-plist by calling: | |
362 >> ssm.getInfo('simulate', 'Default') | |
363 | |
364 ***** THERE ARE NO DEFAULT PARAMETERS ***** | |
365 | |
366 VERSION: $Id: ssmtest.lwb,v 1.1 2009/01/13 12:39:16 hewitson Exp $ | |
367 | |
368 HISTORY: | |
369 04-08-2008 A Grynagier : new multiple state spaces, independant variables | |
370 in aos... | |
371 12-06-2008 M Weyrich : change for multiple outputs, bug fixes | |
372 17-04-2008 A Grynagier | |
373 19-02-2008 A Grynagier | |
374 17-02-2008 A Grynagier | |
375 Creation 30-01-2008 M Weyrich | |
376 | |
377 TO DO: Check input aos for the timestep, tsdata, and ssm.timestep | |
378 options to be defined (NL case) | |
379 add check if one input mach no ssm input variable | |
380 allow use of other LTPDA functions to generate white noise | |
381 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
382 </HelpText> | |
383 <sets> | |
384 <set name="Default"/> | |
385 </sets> | |
386 <plists> | |
387 <plist name="none"> | |
388 <param> | |
389 <key>NOISE VARIABLE NAMES</key> | |
390 <val>cell(0,0)</val> | |
391 <type>cell</type> | |
392 </param> | |
393 <param> | |
394 <key>COVARIANCE</key> | |
395 <val>[]</val> | |
396 <type>double</type> | |
397 </param> | |
398 <param> | |
399 <key>AOS VARIABLE NAMES</key> | |
400 <val>cell(0,0)</val> | |
401 <type>cell</type> | |
402 </param> | |
403 <param> | |
404 <key>AOS</key> | |
405 <val>[]</val> | |
406 <type>double</type> | |
407 </param> | |
408 <param> | |
409 <key>CONSTANT VARIABLE NAMES</key> | |
410 <val>cell(0,0)</val> | |
411 <type>cell</type> | |
412 </param> | |
413 <param> | |
414 <key>CONSTANT</key> | |
415 <val>[]</val> | |
416 <type>double</type> | |
417 </param> | |
418 <param> | |
419 <key>RETURN STATES</key> | |
420 <val>NONE</val> | |
421 <type>char</type> | |
422 </param> | |
423 <param> | |
424 <key>RETURN OUTPUTS</key> | |
425 <val>ALL</val> | |
426 <type>char</type> | |
427 </param> | |
428 <param> | |
429 <key>NSAMPLES</key> | |
430 <val>Inf</val> | |
431 <type>double</type> | |
432 </param> | |
433 <param> | |
434 <key>SSINI</key> | |
435 <val>cell(0,0)</val> | |
436 <type>cell</type> | |
437 </param> | |
438 <param> | |
439 <key>TINI</key> | |
440 <val>0</val> | |
441 <type>double</type> | |
442 </param> | |
443 <param> | |
444 <key>DISPLAYTIME</key> | |
445 <val>0</val> | |
446 <type>double</type> | |
447 </param> | |
448 </plist> | |
449 </plists> | |
450 </LTPDAalgorithm> | |
451 <plist name="none"> | |
452 <param> | |
453 <key>AOS VARIABLE NAMES</key> | |
454 <val>{'rx1_H1_Ifo_delayed'}</val> | |
455 <type>cell</type> | |
456 </param> | |
457 <param> | |
458 <key>AOS</key> | |
459 <val>PORT_1</val> | |
460 <type>char</type> | |
461 </param> | |
462 <param> | |
463 <key>RETURN OUTPUTS</key> | |
464 <val>{'fx_mps_c'}</val> | |
465 <type>cell</type> | |
466 </param> | |
467 </plist> | |
468 <port number="0" type="output"> | |
469 <node> | |
470 <pipe dstblock="tf" dstport="0" srcblock="simulate DFACS"/> | |
471 </node> | |
472 </port> | |
473 </block> | |
474 <block bounds="0 200 110 100" inputs="1" name="noise AO" outputs="1"> | |
475 <LTPDAalgorithm mcategory="Constructor" mclass="ao" mname="ao" mpackage="" mversion="" portdims="1 10 1 10"> | |
476 <HelpText> AO analysis object class constructor. | |
477 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
478 | |
479 DESCRIPTION: AO analysis object class constructor. | |
480 Create an analysis object. | |
481 | |
482 Possible constructors: | |
483 | |
484 a = ao() - creates an empty analysis object | |
485 a = ao('a1.xml') - creates a new analysis object by loading the | |
486 analysis object from disk. | |
487 a = ao('a1.mat') - creates a new analysis object by loading the | |
488 analysis object from disk. | |
489 a = ao('a1.mat') - creates a new analysis object by loading the | |
490 2-column data set stored in the .MAT file. | |
491 a = ao('file.txt') - creates a new analysis object by loading the | |
492 a = ao('file.dat') data in 'file.txt'. The ascii file is assumed | |
493 to be an equally sampled two-column file of | |
494 time and amplitude. By default, the amplitude | |
495 units are taken to be Volts ('V') and the | |
496 time samples are assumed to be in seconds. | |
497 a = ao('file',pl) - creates a new analysis object by loading the | |
498 data in 'file'. The parameter list decide how the | |
499 analysis object is created. The valid key values | |
500 of the parameter list are: | |
501 'type' 'tsdata','fsdata','xydata' | |
502 [default: 'tsdata'] | |
503 'use_fs' if this value is set, the | |
504 x-axes is computed by the fs value. | |
505 [default: empty array] | |
506 'columns' [1 2 1 4] | |
507 Each pair represented the x- and y-axes. | |
508 (Each column pair creates an analysis object) | |
509 Is the value 'use_fs' is used then | |
510 represent each column the y-axes. | |
511 (Each column creates an analysis object) | |
512 [default: [1 2] ] | |
513 'comment_char' The comment character in the file | |
514 [default: ''] | |
515 'description' To set the description in the analysis object | |
516 '...' every property where exist a public | |
517 set-function in the AO class e.g. | |
518 setName, setT0, setYunits, ... | |
519 If the constructor creates multiple ao's it is | |
520 possible to give each data class its own e.g. | |
521 'name'. In this case the parameter list with the | |
522 key 'name' must have cell of the different values | |
523 as the name of the different data objects. e.g. | |
524 pl = plist('columns', [1 2 1 3], ... | |
525 'name', {'name1' 'name2'}, ... | |
526 'xunits', unit('s'), ... | |
527 'yunits', {unit('V') unit('Hz'})); | |
528 This parameter list creates two ao's with tsdata. | |
529 | |
530 'Robust' - set this to 'yes' to use (slow) | |
531 robust data reading. Useful for | |
532 complicated file formats. | |
533 [default: 'yes'] | |
534 | |
535 NOTE: Data files with comments at the end of the lines can only be | |
536 read if there are no lines with only comments. In this case, do not | |
537 specify a comment character. If you really want to load a file like | |
538 this, specify the 'Robust' option; this will be very slow for large | |
539 files. | |
540 | |
541 a = ao(data) - creates an analysis object with a data | |
542 object. Data object can be one of tsdata, | |
543 fsdata, cdata, xydata, xyzdata. | |
544 a = ao(data, hist) - creates an analysis object with a data | |
545 object and a history object | |
546 a = ao(specwin) - creates an analysis object from a specwin | |
547 object | |
548 a = ao(plist) - creates an analysis object from the description | |
549 given in the parameter list | |
550 | |
551 Parameter sets for plist constructor (in order of priority): | |
552 | |
553 From XML File | |
554 ------------- | |
555 | |
556 Construct an AO by loading it from an XML file. | |
557 | |
558 'filename' - construct an AO from a filename. | |
559 Example: plist('filename', 'a1.xml') | |
560 [default: empty string] | |
561 | |
562 From MAT File | |
563 ------------- | |
564 | |
565 Construct an AO by loading it from a MAT file. | |
566 | |
567 'filename' - construct an AO from a filename. | |
568 Example: plist('filename', 'a1.mat') | |
569 [default: empty string] | |
570 | |
571 From ASCII File | |
572 --------------- | |
573 | |
574 Construct an AO by loading it from an ASCII text file. | |
575 | |
576 'filename' - construct an AO from a filename. | |
577 Example: plist('filename', 'a1.txt') | |
578 [default: empty string] | |
579 | |
580 For additional parameters, see constructor ao(file, pl) above. | |
581 | |
582 From Function | |
583 ------------- | |
584 | |
585 Construct an AO from the description of any valid MATLAB function. | |
586 | |
587 'fcn' - any valid MATLAB function. | |
588 Example: plist('fcn', 'randn(100,1)') | |
589 | |
590 You can pass additional parameters to the fcn as extra | |
591 parameters in the parameter list: | |
592 plist('fcn', 'a*b', 'a', 2, 'b', 1:20); | |
593 | |
594 ** Note: case is ignored in the function specification | |
595 such the following: | |
596 plist('fcn', 'a*A/b', 'a', 2, 'B', 1:20); | |
597 results in: | |
598 2*2*[1:20] | |
599 | |
600 [default: 'randn(100,1)'] | |
601 | |
602 From Values | |
603 ----------- | |
604 | |
605 Construct an AO from a set of values. | |
606 | |
607 'vals' - a set of values. | |
608 Example: plist('vals', [1 2 3]) | |
609 optional parameter: repeat 'N' times | |
610 Example: plist('vals', [1 2 3], 'N', 10) | |
611 | |
612 [default: vals: [1], N: [1] ] | |
613 OR | |
614 | |
615 To produce a tsdata AO | |
616 | |
617 'xvals' - a set of x values. | |
618 'yvals' - a set of y values. | |
619 | |
620 | |
621 | |
622 From Time-series Function | |
623 ------------------------- | |
624 | |
625 Construct an AO from a function of time, t. | |
626 | |
627 'tsfcn' - a function of time. | |
628 | |
629 You can also specify optional parameters | |
630 'fs' - sampling frequency [default: 10 Hz] | |
631 'nsecs' - length in seconds [default: 10 s] | |
632 | |
633 You can also specify the initial time (t0) associated with | |
634 the time-series by passing a parameter 't0' with a value | |
635 that is a time object [default: time(0)] | |
636 Example: | |
637 plist('fs', 10, 'nsecs', 10, ... | |
638 'tsfcn', 'sin(2*pi*1.4*t) + 0.1*randn(size(t))', ... | |
639 't0', time('1980-12-01 12:43:12')); | |
640 | |
641 From Frequency-series Function | |
642 ------------------------------ | |
643 | |
644 Construct an AO from a function of frequency, f. | |
645 | |
646 'fsfcn' - a function of frequency, f. [default: 'f'] | |
647 | |
648 You can also specify optional parameters: | |
649 'f1' - the initial frequency [default: 1e-9] | |
650 'f2' - the final frequency [default: 5] | |
651 'nf' - the number of frequency samples [default: 1000] | |
652 'scale' - 'log' or 'lin' frequency spacing [default: 'log'] | |
653 or provide a frequency vector: | |
654 'f' - a vector of frequencies on which to evaluate the | |
655 function [default: [] ] | |
656 | |
657 From Window | |
658 ----------- | |
659 | |
660 Construct an AO from a spectral window object. | |
661 | |
662 'win' - A specwin object. | |
663 | |
664 This creates a cdata type AO containing the window values. | |
665 Example: plist('win', specwin('Hannning', 100)) | |
666 | |
667 [default: specwin('Hanning', 100)] | |
668 | |
669 From Waveform | |
670 ------------- | |
671 | |
672 Construct an AO from a waveform description. | |
673 | |
674 'waveform' - a waveform description (see options below). | |
675 | |
676 You can also specify additional parameters: | |
677 'fs' - sampling frequency [default: 10 Hz] | |
678 'nsecs' - length in seconds [default: 10 s] | |
679 't0' - time-stamp of the first data sample [default time(0)] | |
680 | |
681 and, for the following waveform types: | |
682 'sine wave' - 'A', 'f', 'phi', 'nsecs', 'toff' | |
683 (can be vectors for sum of sine waves) | |
684 'A' - Amplitude of the wave | |
685 'f' - Frequency of the wave | |
686 'phi' - Phase of the eave | |
687 'nsecs' - Number of seconds (in seconds) | |
688 'toff' - Offset of the wave (in seconds) | |
689 'noise' - 'type' (can be 'Normal' or 'Uniform') | |
690 'sigma' specify the standard deviation | |
691 'chirp' - 'f0', 'f1', 't1' (help chirp) | |
692 'Gaussian pulse' - 'f0', 'bw' (help gauspuls) | |
693 'Square wave' - 'f', 'duty' (help square) | |
694 'Sawtooth' - 'f', 'width' (help sawtooth) | |
695 | |
696 You can also specify the initial time (t0) associated with | |
697 the time-series by passing a parameter 't0' with a value | |
698 that is a time object. | |
699 | |
700 [defaults: waveform: 'sine wave', A: 1, f: 1.23, phi: 0, | |
701 fs: 10, nsecs: 10, t0: time(0) ] | |
702 | |
703 | |
704 From Repository | |
705 --------------- | |
706 | |
707 Construct an AO by retrieving it from an LTPDA repository. | |
708 | |
709 'Hostname' - the repository hostname. Only those objects which | |
710 are AOs are returned. | |
711 [default: 'localhost']; | |
712 | |
713 Additional parameters: | |
714 | |
715 'Database' - The database name [default: 'ltpda'] | |
716 'ID' - A vector of object IDs. [default: []] | |
717 'CID' - Retrieve all AO objects from a particular | |
718 collection. | |
719 'Binary' - Set to 'yes' to retrieve from stored binary | |
720 representation (not always available). | |
721 | |
722 From Polynomial | |
723 --------------- | |
724 | |
725 Construct an AO from a set of polynomial coefficients. | |
726 | |
727 'polyval' - a set of polynomial coefficients. | |
728 [default: [-0.0001 0.02 -1 -1] ] | |
729 | |
730 Additional parameters: | |
731 'Nsecs' and 'fs' - number of seconds, and sample rate | |
732 [defaults: nsecs: 10, fs: 10] | |
733 or 't' - vector of time vertices | |
734 [default: [] ] | |
735 | |
736 Example: a = ao(plist('polyval', [1 2 3], 'Nsecs', 10, 'fs', 10)); | |
737 | |
738 | |
739 From Pzmodel | |
740 ------------ | |
741 | |
742 Generates an ao with a timeseries with a prescribed spectrum. | |
743 p = [pz(f1,q1) pz(f2,q2)] | |
744 z = [pz(f3,q3)] | |
745 pzm = pzmodel(gain, p, z) | |
746 The constructor also needs: fs - sampling frequency | |
747 nsecs - number of seconds to be generated | |
748 a = ao(plist('pzmodel', pzm, 'Nsecs', nsecs, 'Fs', fs)) | |
749 | |
750 From Model | |
751 ---------- | |
752 | |
753 A collection of built-in models which construct data series and return | |
754 them in AOs. | |
755 | |
756 'Model' - give the model name. To get a list of models: | |
757 ao(plist('Model', '')) | |
758 | |
759 Each model has additional parameters that need to be passed. To see the | |
760 parameters: | |
761 >> help ao.<model_name> | |
762 | |
763 for example, | |
764 | |
765 >> help ao.mdc1_fd_dynamics | |
766 | |
767 From Plist | |
768 ---------- | |
769 | |
770 'Plist' - construct from a plist. The value passed should be a plist | |
771 object. | |
772 [default: empty plist] | |
773 | |
774 | |
775 | |
776 Examples: | |
777 | |
778 1) Normally distributed random noise time-series | |
779 | |
780 p = plist('waveform', 'noise', 'fs', 10, 'nsecs', 1000); | |
781 rd10 = ao(p); | |
782 | |
783 | |
784 Indexing: | |
785 b = a(1) % where a is an array of analysis objects | |
786 d = a.data; % get the data object | |
787 h = a.hist; % get the history object | |
788 d = a.data.x(1:20); % get a matrix of data values x; | |
789 | |
790 2) Timeseries with a prescribed spectrum | |
791 | |
792 p = plist('pzmodel',pzm, 'fs',10, 'nsecs', 120, 'ndigits',50) | |
793 a = ao(p) | |
794 | |
795 fs - sampling frequency | |
796 nsecs - number of seconds in time series | |
797 ndigits - number of digits for symbolic math toolbox (default: 32) | |
798 | |
799 | |
800 From pzmodel | |
801 ------------ | |
802 | |
803 Generates an ao with a timeseries with a prescribed spectrum. | |
804 p = [pz(f1,q1) pz(f2,q2)] | |
805 z = [pz(f3,q3)] | |
806 pzm = pzmodel(gain, p, z) | |
807 The constructor also needs: fs - sampling frequency | |
808 nsecs - number of seconds to be generated | |
809 a = ao(pzm, nsecs, fs) | |
810 | |
811 The following call returns an minfo object that contains information | |
812 about the AO constructor: | |
813 | |
814 >> info = ao.getInfo | |
815 | |
816 You can get information about class methods by calling: | |
817 | |
818 >> info = ao.getInfo(method) | |
819 | |
820 e.g. info = ao.getInfo('pwelch') | |
821 | |
822 You can also restrict the sets of parameters contained in the minfo | |
823 object by calling: | |
824 | |
825 >> info = ao.getInfo(method, set) | |
826 | |
827 e.g., info = ao.getInfo('ao', 'From Vals') | |
828 | |
829 See also tsdata, fsdata, xydata, cdata, xyzdata | |
830 | |
831 M Hewitson 30-01-07 | |
832 | |
833 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
834 </HelpText> | |
835 <sets> | |
836 <set name="Default"/> | |
837 <set name="From XML File"/> | |
838 <set name="From MAT File"/> | |
839 <set name="From ASCII File"/> | |
840 <set name="From Function"/> | |
841 <set name="From Values"/> | |
842 <set name="From Time-series Function"/> | |
843 <set name="From Frequency-series Function"/> | |
844 <set name="From Window"/> | |
845 <set name="From Waveform"/> | |
846 <set name="From Polynomial"/> | |
847 <set name="From Repository"/> | |
848 <set name="From Plist"/> | |
849 <set name="From Pzmodel"/> | |
850 <set name="From Model"/> | |
851 </sets> | |
852 <plists> | |
853 <plist name="none"/> | |
854 <plist name="none"> | |
855 <param> | |
856 <key>FILENAME</key> | |
857 <val/> | |
858 <type>char</type> | |
859 </param> | |
860 </plist> | |
861 <plist name="none"> | |
862 <param> | |
863 <key>FILENAME</key> | |
864 <val/> | |
865 <type>char</type> | |
866 </param> | |
867 </plist> | |
868 <plist name="none"> | |
869 <param> | |
870 <key>FILENAME</key> | |
871 <val/> | |
872 <type>char</type> | |
873 </param> | |
874 <param> | |
875 <key>TYPE</key> | |
876 <val>tsdata</val> | |
877 <type>char</type> | |
878 </param> | |
879 <param> | |
880 <key>COLUMNS</key> | |
881 <val>[1 2]</val> | |
882 <type>double</type> | |
883 </param> | |
884 <param> | |
885 <key>XUNITS</key> | |
886 <val>[ unit(' s ') ]</val> | |
887 <type>unit</type> | |
888 </param> | |
889 <param> | |
890 <key>YUNITS</key> | |
891 <val>[ unit(' V ') ]</val> | |
892 <type>unit</type> | |
893 </param> | |
894 <param> | |
895 <key>T0</key> | |
896 <val>time([plist('TIMEFORMAT', 'yyyy-mm-dd HH:MM:SS.FFF', 'TIMEZONE', 'UTC', 'UTC_EPOCH_MILLI', 0)]) </val> | |
897 <type>time</type> | |
898 </param> | |
899 <param> | |
900 <key>COMMENT_CHAR</key> | |
901 <val/> | |
902 <type>char</type> | |
903 </param> | |
904 <param> | |
905 <key>USE_FS</key> | |
906 <val/> | |
907 <type>char</type> | |
908 </param> | |
909 <param> | |
910 <key>ROBUST</key> | |
911 <val>yes</val> | |
912 <type>char</type> | |
913 </param> | |
914 </plist> | |
915 <plist name="none"> | |
916 <param> | |
917 <key>FCN</key> | |
918 <val>randn(100,1)</val> | |
919 <type>char</type> | |
920 </param> | |
921 <param> | |
922 <key>YUNITS</key> | |
923 <val>[ unit(' V ') ]</val> | |
924 <type>unit</type> | |
925 </param> | |
926 </plist> | |
927 <plist name="none"> | |
928 <param> | |
929 <key>VALS</key> | |
930 <val>[]</val> | |
931 <type>double</type> | |
932 </param> | |
933 <param> | |
934 <key>N</key> | |
935 <val>1</val> | |
936 <type>double</type> | |
937 </param> | |
938 <param> | |
939 <key>DTYPE</key> | |
940 <val/> | |
941 <type>char</type> | |
942 </param> | |
943 <param> | |
944 <key>FS</key> | |
945 <val>[]</val> | |
946 <type>double</type> | |
947 </param> | |
948 <param> | |
949 <key>XVALS</key> | |
950 <val>[]</val> | |
951 <type>double</type> | |
952 </param> | |
953 <param> | |
954 <key>YVALS</key> | |
955 <val>[]</val> | |
956 <type>double</type> | |
957 </param> | |
958 <param> | |
959 <key>YUNITS</key> | |
960 <val/> | |
961 <type>char</type> | |
962 </param> | |
963 </plist> | |
964 <plist name="none"> | |
965 <param> | |
966 <key>TSFCN</key> | |
967 <val>t</val> | |
968 <type>char</type> | |
969 </param> | |
970 <param> | |
971 <key>FS</key> | |
972 <val>10</val> | |
973 <type>double</type> | |
974 </param> | |
975 <param> | |
976 <key>NSECS</key> | |
977 <val>1</val> | |
978 <type>double</type> | |
979 </param> | |
980 <param> | |
981 <key>T0</key> | |
982 <val>time([plist('TIMEFORMAT', 'yyyy-mm-dd HH:MM:SS.FFF', 'TIMEZONE', 'UTC', 'UTC_EPOCH_MILLI', 0)]) </val> | |
983 <type>time</type> | |
984 </param> | |
985 <param> | |
986 <key>XUNITS</key> | |
987 <val>[ unit(' s ') ]</val> | |
988 <type>unit</type> | |
989 </param> | |
990 <param> | |
991 <key>YUNITS</key> | |
992 <val>[ unit(' V ') ]</val> | |
993 <type>unit</type> | |
994 </param> | |
995 </plist> | |
996 <plist name="none"> | |
997 <param> | |
998 <key>FSFCN</key> | |
999 <val>f</val> | |
1000 <type>char</type> | |
1001 </param> | |
1002 <param> | |
1003 <key>F1</key> | |
1004 <val>1e-09</val> | |
1005 <type>double</type> | |
1006 </param> | |
1007 <param> | |
1008 <key>F2</key> | |
1009 <val>5</val> | |
1010 <type>double</type> | |
1011 </param> | |
1012 <param> | |
1013 <key>NF</key> | |
1014 <val>1000</val> | |
1015 <type>double</type> | |
1016 </param> | |
1017 <param> | |
1018 <key>SCALE</key> | |
1019 <val>log</val> | |
1020 <type>char</type> | |
1021 </param> | |
1022 <param> | |
1023 <key>F</key> | |
1024 <val>[]</val> | |
1025 <type>double</type> | |
1026 </param> | |
1027 <param> | |
1028 <key>XUNITS</key> | |
1029 <val>[ unit(' Hz ') ]</val> | |
1030 <type>unit</type> | |
1031 </param> | |
1032 <param> | |
1033 <key>YUNITS</key> | |
1034 <val>[ unit(' V ') ]</val> | |
1035 <type>unit</type> | |
1036 </param> | |
1037 </plist> | |
1038 <plist name="none"> | |
1039 <param> | |
1040 <key>WIN</key> | |
1041 <val> specwin('Hanning', 100)</val> | |
1042 <type>specwin</type> | |
1043 </param> | |
1044 <param> | |
1045 <key>YUNITS</key> | |
1046 <val>[ unit(' I ') ]</val> | |
1047 <type>unit</type> | |
1048 </param> | |
1049 </plist> | |
1050 <plist name="none"> | |
1051 <param> | |
1052 <key>WAVEFORM</key> | |
1053 <val>sine wave</val> | |
1054 <type>char</type> | |
1055 </param> | |
1056 <param> | |
1057 <key>A</key> | |
1058 <val>1</val> | |
1059 <type>double</type> | |
1060 </param> | |
1061 <param> | |
1062 <key>F</key> | |
1063 <val>1.23</val> | |
1064 <type>double</type> | |
1065 </param> | |
1066 <param> | |
1067 <key>PHI</key> | |
1068 <val>0</val> | |
1069 <type>double</type> | |
1070 </param> | |
1071 <param> | |
1072 <key>FS</key> | |
1073 <val>10</val> | |
1074 <type>double</type> | |
1075 </param> | |
1076 <param> | |
1077 <key>NSECS</key> | |
1078 <val>10</val> | |
1079 <type>double</type> | |
1080 </param> | |
1081 <param> | |
1082 <key>T0</key> | |
1083 <val>time([plist('TIMEFORMAT', 'yyyy-mm-dd HH:MM:SS.FFF', 'TIMEZONE', 'UTC', 'UTC_EPOCH_MILLI', 0)]) </val> | |
1084 <type>time</type> | |
1085 </param> | |
1086 <param> | |
1087 <key>TOFF</key> | |
1088 <val>0</val> | |
1089 <type>double</type> | |
1090 </param> | |
1091 <param> | |
1092 <key>XUNITS</key> | |
1093 <val>[ unit(' s ') ]</val> | |
1094 <type>unit</type> | |
1095 </param> | |
1096 <param> | |
1097 <key>YUNITS</key> | |
1098 <val>[ unit(' V ') ]</val> | |
1099 <type>unit</type> | |
1100 </param> | |
1101 </plist> | |
1102 <plist name="none"> | |
1103 <param> | |
1104 <key>POLYVAL</key> | |
1105 <val>[-0.0001 0.02 -1 -1]</val> | |
1106 <type>double</type> | |
1107 </param> | |
1108 <param> | |
1109 <key>NSECS</key> | |
1110 <val>10</val> | |
1111 <type>double</type> | |
1112 </param> | |
1113 <param> | |
1114 <key>FS</key> | |
1115 <val>10</val> | |
1116 <type>double</type> | |
1117 </param> | |
1118 <param> | |
1119 <key>T</key> | |
1120 <val>[]</val> | |
1121 <type>double</type> | |
1122 </param> | |
1123 <param> | |
1124 <key>XUNITS</key> | |
1125 <val>[ unit(' s ') ]</val> | |
1126 <type>unit</type> | |
1127 </param> | |
1128 <param> | |
1129 <key>YUNITS</key> | |
1130 <val>[ unit(' V ') ]</val> | |
1131 <type>unit</type> | |
1132 </param> | |
1133 </plist> | |
1134 <plist name="none"> | |
1135 <param> | |
1136 <key>HOSTNAME</key> | |
1137 <val>localhost</val> | |
1138 <type>char</type> | |
1139 </param> | |
1140 <param> | |
1141 <key>DATABASE</key> | |
1142 <val>ltpda</val> | |
1143 <type>char</type> | |
1144 </param> | |
1145 <param> | |
1146 <key>ID</key> | |
1147 <val>[]</val> | |
1148 <type>double</type> | |
1149 </param> | |
1150 <param> | |
1151 <key>BINARY</key> | |
1152 <val>no</val> | |
1153 <type>char</type> | |
1154 </param> | |
1155 </plist> | |
1156 <plist name="none"> | |
1157 <param> | |
1158 <key>PLIST</key> | |
1159 <val>(empty-plist)</val> | |
1160 <type>plist</type> | |
1161 </param> | |
1162 </plist> | |
1163 <plist name="none"> | |
1164 <param> | |
1165 <key>PZMODEL</key> | |
1166 <val>pzmodel(none)</val> | |
1167 <type>pzmodel</type> | |
1168 </param> | |
1169 <param> | |
1170 <key>NSECS</key> | |
1171 <val>0</val> | |
1172 <type>double</type> | |
1173 </param> | |
1174 <param> | |
1175 <key>FS</key> | |
1176 <val>0</val> | |
1177 <type>double</type> | |
1178 </param> | |
1179 <param> | |
1180 <key>XUNITS</key> | |
1181 <val>[ unit(' s ') ]</val> | |
1182 <type>unit</type> | |
1183 </param> | |
1184 <param> | |
1185 <key>YUNITS</key> | |
1186 <val>[ unit(' V ') ]</val> | |
1187 <type>unit</type> | |
1188 </param> | |
1189 </plist> | |
1190 <plist name="none"> | |
1191 <param> | |
1192 <key>MODEL</key> | |
1193 <val/> | |
1194 <type>char</type> | |
1195 </param> | |
1196 </plist> | |
1197 </plists> | |
1198 </LTPDAalgorithm> | |
1199 <plist name="none"> | |
1200 <param> | |
1201 <key>TSFCN</key> | |
1202 <val>1e-3*randn(size(t))</val> | |
1203 <type>char</type> | |
1204 </param> | |
1205 <param> | |
1206 <key>FS</key> | |
1207 <val>10</val> | |
1208 <type>double</type> | |
1209 </param> | |
1210 <param> | |
1211 <key>NSECS</key> | |
1212 <val>1000</val> | |
1213 <type>double</type> | |
1214 </param> | |
1215 </plist> | |
1216 <port number="0" type="output"> | |
1217 <node> | |
1218 <pipe dstblock="simulate DFACS" dstport="1" srcblock="noise AO"/> | |
1219 <pipe dstblock="tf" dstport="1" srcblock="noise AO"/> | |
1220 </node> | |
1221 </port> | |
1222 </block> | |
1223 <block bounds="400 100 110 100" inputs="2" name="tf" outputs="1"> | |
1224 <LTPDAalgorithm mcategory="Signal Processing" mclass="ao" mname="ltfe" mpackage="" mversion="" portdims="1 10 1 10"> | |
1225 <HelpText> LTFE implement transfer-function estimation computed on a log frequency axis. | |
1226 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1227 | |
1228 DESCRIPTION: LTFE implement transfer-function estimation computed on a | |
1229 log frequency axis. | |
1230 | |
1231 CALL: tfs = ltfe(as) | |
1232 tfs = ltfe(as, pl) | |
1233 | |
1234 INPUTS: as - array of analysis objects | |
1235 pl - parameter list (see below) | |
1236 | |
1237 OUTPUTS: bs - array of analysis objects, one for each input | |
1238 | |
1239 PARAMETER LIST: | |
1240 | |
1241 Kdes - desired number of averages [default: 100] | |
1242 Lmin - minimum segment length [default: 0] | |
1243 Jdes - number of spectral frequencies to compute [default: fs/4] | |
1244 Win - a specwin window object | |
1245 Only the design parameters of the window object are used; the | |
1246 window is recomputed for each DFT length inside the ltpda_dft | |
1247 algorithm. [default: Kaiser with -200dB PSLL] | |
1248 Olap - desired overlap [default: taken from window] | |
1249 Order - order of detrending. | |
1250 -1 - no detrending | |
1251 0 - subtract mean | |
1252 1 - subtract linear fit | |
1253 N - subtract fit of polynomial, order N | |
1254 | |
1255 M-FILE INFO: Get information about this methods by calling | |
1256 >> ao.getInfo('ltfe') | |
1257 | |
1258 Get information about a specified set-plist by calling: | |
1259 >> ao.getInfo('ltfe', 'None') | |
1260 | |
1261 VERSION: $Id: ssmtest.lwb,v 1.1 2009/01/13 12:39:16 hewitson Exp $ | |
1262 | |
1263 HISTORY: 02-02-2007 M Hewitson | |
1264 Created | |
1265 | |
1266 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1267 </HelpText> | |
1268 <sets> | |
1269 <set name="Default"/> | |
1270 </sets> | |
1271 <plists> | |
1272 <plist name="none"> | |
1273 <param> | |
1274 <key>KDES</key> | |
1275 <val>100</val> | |
1276 <type>double</type> | |
1277 </param> | |
1278 <param> | |
1279 <key>JDES</key> | |
1280 <val>1000</val> | |
1281 <type>double</type> | |
1282 </param> | |
1283 <param> | |
1284 <key>LMIN</key> | |
1285 <val>0</val> | |
1286 <type>double</type> | |
1287 </param> | |
1288 <param> | |
1289 <key>WIN</key> | |
1290 <val> specwin('BH92', 10)</val> | |
1291 <type>specwin</type> | |
1292 </param> | |
1293 <param> | |
1294 <key>OLAP</key> | |
1295 <val>-1</val> | |
1296 <type>double</type> | |
1297 </param> | |
1298 <param> | |
1299 <key>ORDER</key> | |
1300 <val>0</val> | |
1301 <type>double</type> | |
1302 </param> | |
1303 </plist> | |
1304 </plists> | |
1305 </LTPDAalgorithm> | |
1306 <plist name="none"> | |
1307 <param> | |
1308 <key>KDES</key> | |
1309 <val>100</val> | |
1310 <type>double</type> | |
1311 </param> | |
1312 <param> | |
1313 <key>JDES</key> | |
1314 <val>1000</val> | |
1315 <type>double</type> | |
1316 </param> | |
1317 <param> | |
1318 <key>LMIN</key> | |
1319 <val>0</val> | |
1320 <type>double</type> | |
1321 </param> | |
1322 <param> | |
1323 <key>WIN</key> | |
1324 <val> specwin('BH92', 10)</val> | |
1325 <type>specwin</type> | |
1326 </param> | |
1327 <param> | |
1328 <key>OLAP</key> | |
1329 <val>-1</val> | |
1330 <type>double</type> | |
1331 </param> | |
1332 <param> | |
1333 <key>ORDER</key> | |
1334 <val>0</val> | |
1335 <type>double</type> | |
1336 </param> | |
1337 </plist> | |
1338 <port number="0" type="output"> | |
1339 <node> | |
1340 <pipe dstblock="view" dstport="0" srcblock="tf"/> | |
1341 </node> | |
1342 </port> | |
1343 </block> | |
1344 <block bounds="500 100 110 100" inputs="1" name="view" outputs="1"> | |
1345 <LTPDAalgorithm mcategory="Output" mclass="ao" mname="iplot" mpackage="" mversion="" portdims="1 10 1 10"> | |
1346 <HelpText> IPLOT provides an intelligent plotting tool for LTPDA. | |
1347 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1348 | |
1349 DESCRIPTION: IPLOT provides an intelligent plotting tool for LTPDA. | |
1350 | |
1351 CALL: hfig = iplot (a,pl) | |
1352 [hfig, hax] = iplot (a,pl) | |
1353 [hfig, hax, hli] = iplot (a,pl) | |
1354 | |
1355 INPUTS: pl - a parameter list | |
1356 a - input analysis object | |
1357 | |
1358 OUTPUTS: hfig - handles to figures | |
1359 hax - handles to axes | |
1360 hli - handles to lines | |
1361 | |
1362 | |
1363 Plot parameters: | |
1364 | |
1365 'Arrangement' - select the plot layout: | |
1366 'single' - plots all AOs on individual figures | |
1367 'stacked' - plots all AOs on the same axes [default] | |
1368 'subplots' - plots all AOs on subplots | |
1369 | |
1370 'Function' - specify the plot function: | |
1371 'plot', 'stairs', 'stem' | |
1372 [default: 'plot'] | |
1373 *** doesn't work for xyzdata AOs | |
1374 | |
1375 Line parameters: | |
1376 | |
1377 The following properties take cell array values. If the length of | |
1378 the cell array is shorter than the number of lines to plot, the | |
1379 remaining lines will be plotted with the default options. If the | |
1380 cell array is of length 2 and the first cell contains the string | |
1381 'all', then the second cell is used to set the propery of all | |
1382 lines. | |
1383 | |
1384 'LineColors' - a cell array of color definitions for each line. | |
1385 | |
1386 'LineStyles' - a cell array of line styles. | |
1387 | |
1388 'Markers' - a cell array of markers. | |
1389 | |
1390 'LineWidths' - a cell array of line widths. If the length of the | |
1391 cell array is shorter than the number of lines to | |
1392 plot, the remaining lines will be plotted with | |
1393 the default line width. | |
1394 | |
1395 Axes parameters: | |
1396 | |
1397 'Legends' - specify a cell array of strings to be used for | |
1398 the plot legends. If a cell contains an empty | |
1399 string, the default legend string is built. | |
1400 If a single string 'off' is given instead of a | |
1401 cell array, then the legends are all switched | |
1402 off. | |
1403 | |
1404 'XLabels' - Specify the labels to be used on the x-axes. The | |
1405 units are added from the data object 'xunits' | |
1406 property. | |
1407 | |
1408 'YLabels' - Specify the labels to be used on the y-axes. The | |
1409 units are added from the data object 'yunits' | |
1410 property. If the object contains complex data, | |
1411 you should specify two y-labels for that object. | |
1412 | |
1413 The following axis properties also work with the 'all' keyword as | |
1414 described above in the line properties section. | |
1415 | |
1416 'XScales' - Specify the scales to be used on the x-axes. | |
1417 | |
1418 'YScales' - Specify the scales to the used on the y-axes. If | |
1419 an object contains complex data, you should | |
1420 specify two y-labels for that object. | |
1421 | |
1422 'XRanges' - Specify the ranges to be displayed on the x-axes. | |
1423 | |
1424 'YRanges' - Specify the ranges to the displayed on the | |
1425 y-axes. | |
1426 | |
1427 Error parameters: If you give more than one input AO then you must | |
1428 specify the following parameter values in a cell-array, | |
1429 one cell for each input AO. Leave the cell empty to | |
1430 plot no errors. Each error can be a value or a vector | |
1431 the same length as the data vector. If you give and | |
1432 upper limit but not lower limit, then the errors are | |
1433 assumed to be symmetric (and vice versa) | |
1434 | |
1435 'XerrL' - lower bound error values for the X data points. | |
1436 'XerrU' - upper bound error values for the X data points. | |
1437 'YerrL' - lower bound error values for the Y data points. | |
1438 'YerrU' - upper bound error values for the Y data points. | |
1439 | |
1440 Math operations: You can specify rudimentary math operations to be | |
1441 performed on the X and Y data prior to plotting. The | |
1442 'all' keyword is also supported by these parameters. | |
1443 | |
1444 'Xmaths' - specify math operations to perform on the | |
1445 data vector 'x'. For example, | |
1446 plist('Xmaths', 'abs(x)'). | |
1447 | |
1448 'Ymaths' - specify math operations to perform on the | |
1449 data vector 'y'. For example, | |
1450 plist('Ymaths', 'sqrt(y)'). | |
1451 | |
1452 Time-series parameters: in addition to the general options, time-series | |
1453 objects have the following additional parameters. | |
1454 | |
1455 'Xunits' - specify the units on the x-axis as | |
1456 'us' - microseconds | |
1457 'ms' - milliseconds | |
1458 's' - seconds [default] | |
1459 'm' - minutes | |
1460 'h' - hours | |
1461 'D' - days | |
1462 'M' - months | |
1463 'HH:MM:SS' - using a date/time format | |
1464 recognized by datetic (help datetic) | |
1465 | |
1466 | |
1467 Frequency-series parameters: | |
1468 | |
1469 'complexPlotType' - specify how to plot complex data. | |
1470 Choose from: | |
1471 - 'realimag' | |
1472 - 'absdeg' | |
1473 - 'absrad' | |
1474 | |
1475 EXAMPLES: | |
1476 | |
1477 1) Plot two time-series AOs with different colors, line styles, and widths | |
1478 | |
1479 pl = plist('Linecolors', {'g', 'k'}, 'LineStyles', {'', '--'}, 'LineWidths', {1, 4}); | |
1480 iplot(tsao1, tsao2, pl); | |
1481 | |
1482 2) Plot two time-series AOs in subplots. Also override the second legend | |
1483 text and the first line style. | |
1484 | |
1485 pl = plist('Arrangement', 'subplots', 'LineStyles', {'--'}, 'Legends', {'', 'My Sine Wave'}); | |
1486 iplot(tsao1, tsao2, pl); | |
1487 | |
1488 3) Plot two time-series AOs taking the square of the y-values of the | |
1489 first AO and the log of the x-values of the second AO. | |
1490 | |
1491 pl = plist('Arrangement', 'subplots', 'YMaths', 'y.^2', 'XMaths', {'', 'log(x)'}); | |
1492 iplot(tsao1, tsao2, pl); | |
1493 | |
1494 4) Plot two frequency-series AOs on subplots with the same Y-scales and | |
1495 Y-ranges | |
1496 | |
1497 pl1 = plist('Yscales', {'All', 'lin'}); | |
1498 pl2 = plist('arrangement', 'subplots', 'YRanges', {'All', [1e-6 100]}); | |
1499 iplot(fsd1, fsd2, pl1, pl2) | |
1500 | |
1501 | |
1502 M-FILE INFO: Get information about this methods by calling | |
1503 >> ao.getInfo('iplot') | |
1504 | |
1505 Get information about a specified set-plist by calling: | |
1506 >> ao.getInfo('iplot', 'None') | |
1507 | |
1508 VERSION: $Id: ssmtest.lwb,v 1.1 2009/01/13 12:39:16 hewitson Exp $ | |
1509 | |
1510 HISTORY: 22-12-07 M Hewitson | |
1511 Creation | |
1512 | |
1513 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1514 </HelpText> | |
1515 <sets> | |
1516 <set name="Time-series plot"/> | |
1517 <set name="Frequency-series plot"/> | |
1518 <set name="Y data plot"/> | |
1519 <set name="X-Y data plot"/> | |
1520 <set name="3D plot"/> | |
1521 </sets> | |
1522 <plists> | |
1523 <plist name="none"> | |
1524 <param> | |
1525 <key>COLORS</key> | |
1526 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1527 <type>cell</type> | |
1528 </param> | |
1529 <param> | |
1530 <key>ARRANGEMENT</key> | |
1531 <val>stacked</val> | |
1532 <type>char</type> | |
1533 </param> | |
1534 <param> | |
1535 <key>FUNCTION</key> | |
1536 <val>plot</val> | |
1537 <type>char</type> | |
1538 </param> | |
1539 <param> | |
1540 <key>LEGENDLOCATION</key> | |
1541 <val>NorthEast</val> | |
1542 <type>char</type> | |
1543 </param> | |
1544 <param> | |
1545 <key>XERRL</key> | |
1546 <val>[]</val> | |
1547 <type>double</type> | |
1548 </param> | |
1549 <param> | |
1550 <key>XERRU</key> | |
1551 <val>[]</val> | |
1552 <type>double</type> | |
1553 </param> | |
1554 <param> | |
1555 <key>YERRU</key> | |
1556 <val>[]</val> | |
1557 <type>double</type> | |
1558 </param> | |
1559 <param> | |
1560 <key>YERRL</key> | |
1561 <val>[]</val> | |
1562 <type>double</type> | |
1563 </param> | |
1564 <param> | |
1565 <key>XLABEL</key> | |
1566 <val>Time</val> | |
1567 <type>char</type> | |
1568 </param> | |
1569 <param> | |
1570 <key>YLABEL</key> | |
1571 <val>Amplitude</val> | |
1572 <type>char</type> | |
1573 </param> | |
1574 </plist> | |
1575 <plist name="none"> | |
1576 <param> | |
1577 <key>COLORS</key> | |
1578 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1579 <type>cell</type> | |
1580 </param> | |
1581 <param> | |
1582 <key>ARRANGEMENT</key> | |
1583 <val>stacked</val> | |
1584 <type>char</type> | |
1585 </param> | |
1586 <param> | |
1587 <key>FUNCTION</key> | |
1588 <val>plot</val> | |
1589 <type>char</type> | |
1590 </param> | |
1591 <param> | |
1592 <key>LEGENDLOCATION</key> | |
1593 <val>NorthEast</val> | |
1594 <type>char</type> | |
1595 </param> | |
1596 <param> | |
1597 <key>XERRL</key> | |
1598 <val>[]</val> | |
1599 <type>double</type> | |
1600 </param> | |
1601 <param> | |
1602 <key>XERRU</key> | |
1603 <val>[]</val> | |
1604 <type>double</type> | |
1605 </param> | |
1606 <param> | |
1607 <key>YERRU</key> | |
1608 <val>[]</val> | |
1609 <type>double</type> | |
1610 </param> | |
1611 <param> | |
1612 <key>YERRL</key> | |
1613 <val>[]</val> | |
1614 <type>double</type> | |
1615 </param> | |
1616 <param> | |
1617 <key>COMPLEXPLOTTYPE</key> | |
1618 <val>absdeg</val> | |
1619 <type>char</type> | |
1620 </param> | |
1621 <param> | |
1622 <key>XLABEL</key> | |
1623 <val>Frequency</val> | |
1624 <type>char</type> | |
1625 </param> | |
1626 </plist> | |
1627 <plist name="none"> | |
1628 <param> | |
1629 <key>COLORS</key> | |
1630 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1631 <type>cell</type> | |
1632 </param> | |
1633 <param> | |
1634 <key>ARRANGEMENT</key> | |
1635 <val>stacked</val> | |
1636 <type>char</type> | |
1637 </param> | |
1638 <param> | |
1639 <key>FUNCTION</key> | |
1640 <val>plot</val> | |
1641 <type>char</type> | |
1642 </param> | |
1643 <param> | |
1644 <key>LEGENDLOCATION</key> | |
1645 <val>NorthEast</val> | |
1646 <type>char</type> | |
1647 </param> | |
1648 <param> | |
1649 <key>XERRL</key> | |
1650 <val>[]</val> | |
1651 <type>double</type> | |
1652 </param> | |
1653 <param> | |
1654 <key>XERRU</key> | |
1655 <val>[]</val> | |
1656 <type>double</type> | |
1657 </param> | |
1658 <param> | |
1659 <key>YERRU</key> | |
1660 <val>[]</val> | |
1661 <type>double</type> | |
1662 </param> | |
1663 <param> | |
1664 <key>YERRL</key> | |
1665 <val>[]</val> | |
1666 <type>double</type> | |
1667 </param> | |
1668 <param> | |
1669 <key>XLABEL</key> | |
1670 <val>Sample</val> | |
1671 <type>char</type> | |
1672 </param> | |
1673 <param> | |
1674 <key>YLABEL</key> | |
1675 <val>Value</val> | |
1676 <type>char</type> | |
1677 </param> | |
1678 </plist> | |
1679 <plist name="none"> | |
1680 <param> | |
1681 <key>COLORS</key> | |
1682 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1683 <type>cell</type> | |
1684 </param> | |
1685 <param> | |
1686 <key>ARRANGEMENT</key> | |
1687 <val>stacked</val> | |
1688 <type>char</type> | |
1689 </param> | |
1690 <param> | |
1691 <key>FUNCTION</key> | |
1692 <val>plot</val> | |
1693 <type>char</type> | |
1694 </param> | |
1695 <param> | |
1696 <key>LEGENDLOCATION</key> | |
1697 <val>NorthEast</val> | |
1698 <type>char</type> | |
1699 </param> | |
1700 <param> | |
1701 <key>XERRL</key> | |
1702 <val>[]</val> | |
1703 <type>double</type> | |
1704 </param> | |
1705 <param> | |
1706 <key>XERRU</key> | |
1707 <val>[]</val> | |
1708 <type>double</type> | |
1709 </param> | |
1710 <param> | |
1711 <key>YERRU</key> | |
1712 <val>[]</val> | |
1713 <type>double</type> | |
1714 </param> | |
1715 <param> | |
1716 <key>YERRL</key> | |
1717 <val>[]</val> | |
1718 <type>double</type> | |
1719 </param> | |
1720 <param> | |
1721 <key>XLABEL</key> | |
1722 <val>X-data</val> | |
1723 <type>char</type> | |
1724 </param> | |
1725 <param> | |
1726 <key>YLABEL</key> | |
1727 <val>Y-data</val> | |
1728 <type>char</type> | |
1729 </param> | |
1730 <param> | |
1731 <key>YMATHS</key> | |
1732 <val/> | |
1733 <type>char</type> | |
1734 </param> | |
1735 <param> | |
1736 <key>XMATHS</key> | |
1737 <val/> | |
1738 <type>char</type> | |
1739 </param> | |
1740 </plist> | |
1741 <plist name="none"> | |
1742 <param> | |
1743 <key>COLORS</key> | |
1744 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1745 <type>cell</type> | |
1746 </param> | |
1747 <param> | |
1748 <key>ARRANGEMENT</key> | |
1749 <val>single</val> | |
1750 <type>char</type> | |
1751 </param> | |
1752 <param> | |
1753 <key>XLABEL</key> | |
1754 <val>Time</val> | |
1755 <type>char</type> | |
1756 </param> | |
1757 <param> | |
1758 <key>YLABEL</key> | |
1759 <val>Frequency</val> | |
1760 <type>char</type> | |
1761 </param> | |
1762 <param> | |
1763 <key>ZLABEL</key> | |
1764 <val>Amplitude</val> | |
1765 <type>char</type> | |
1766 </param> | |
1767 <param> | |
1768 <key>YMATHS</key> | |
1769 <val/> | |
1770 <type>char</type> | |
1771 </param> | |
1772 <param> | |
1773 <key>ZMATHS</key> | |
1774 <val/> | |
1775 <type>char</type> | |
1776 </param> | |
1777 <param> | |
1778 <key>XMATHS</key> | |
1779 <val/> | |
1780 <type>char</type> | |
1781 </param> | |
1782 </plist> | |
1783 </plists> | |
1784 </LTPDAalgorithm> | |
1785 <plist name="none"> | |
1786 <param> | |
1787 <key>COLORS</key> | |
1788 <val>{[0.80000000000000004 0.20000000000000001 0.20000000000000001],[0.20000000000000001 0.20000000000000001 0.80000000000000004],[0.20000000000000001 0.90000000000000002 0.20000000000000001],[0.37 0.90000000000000002 0.82999999999999996],[0.88800000000000001 0.16300000000000001 0.90000000000000002],[0 0 0],[0 0.81176470588235294 1],[1 0.50196078431372548 0],[0.5607843137254902 0 0],[1 0.81176470588235294 0],[0.90000000000000002 0.26600000000000001 0.59299999999999997]}</val> | |
1789 <type>cell</type> | |
1790 </param> | |
1791 <param> | |
1792 <key>ARRANGEMENT</key> | |
1793 <val>stacked</val> | |
1794 <type>char</type> | |
1795 </param> | |
1796 <param> | |
1797 <key>FUNCTION</key> | |
1798 <val>plot</val> | |
1799 <type>char</type> | |
1800 </param> | |
1801 <param> | |
1802 <key>LEGENDLOCATION</key> | |
1803 <val>NorthEast</val> | |
1804 <type>char</type> | |
1805 </param> | |
1806 <param> | |
1807 <key>XERRL</key> | |
1808 <val>[]</val> | |
1809 <type>double</type> | |
1810 </param> | |
1811 <param> | |
1812 <key>XERRU</key> | |
1813 <val>[]</val> | |
1814 <type>double</type> | |
1815 </param> | |
1816 <param> | |
1817 <key>YERRU</key> | |
1818 <val>[]</val> | |
1819 <type>double</type> | |
1820 </param> | |
1821 <param> | |
1822 <key>YERRL</key> | |
1823 <val>[]</val> | |
1824 <type>double</type> | |
1825 </param> | |
1826 <param> | |
1827 <key>XLABEL</key> | |
1828 <val>Time</val> | |
1829 <type>char</type> | |
1830 </param> | |
1831 <param> | |
1832 <key>YLABEL</key> | |
1833 <val>Amplitude</val> | |
1834 <type>char</type> | |
1835 </param> | |
1836 </plist> | |
1837 <port number="0" type="output"/> | |
1838 </block> | |
1839 </document> | |
1840 </LTPDAworkbench> |