Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_pzmodel_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 <!-- $Id: class_desc_pzmodel_content.html,v 1.15 2011/05/12 19:47:56 ingo Exp $ -->
2
3 <!-- ================================================== -->
4 <!-- BEGIN CONTENT FILE -->
5 <!-- ================================================== -->
6 <!-- ===== link box: Begin ===== -->
7 <p>
8 <table border="1" width="80%">
9 <tr>
10 <td>
11 <table border="0" cellpadding="5" class="categorylist" width="100%">
12 <colgroup>
13 <col width="37%"/>
14 <col width="63%"/>
15 </colgroup>
16 <tbody>
17 <tr valign="top">
18 <td>
19 <a href="class_desc_pzmodel.html#top_properties">Properties</a>
20 </td>
21 <td>Properties of the class</td>
22 </tr>
23 <tr valign="top">
24 <td>
25 <a href="class_desc_pzmodel.html#top_methods">Methods</a>
26 </td>
27 <td>All Methods of the class ordered by category.</td>
28 </tr>
29 <tr valign="top">
30 <td>
31 <a href="constructor_examples_pzmodel.html">Examples</a>
32 </td>
33 <td>Some constructor examples</td>
34 </tr>
35 </tbody>
36 </table>
37 </td>
38 </tr>
39 </table>
40 </p>
41 <!-- ===== link box: End ====== -->
42
43 <!-- ===== Back to Class descriptions ===== -->
44 <a href="class_desc_main.html">
45 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
46 Back to Class descriptions
47 </a>
48
49 <h2 class="title"><a name="top_properties"/>Properties</h2>
50 <p>
51 The LTPDA toolbox restrict access of the properties.<br></br>
52 The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
53 <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
54 The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
55 <pre class="programlisting">
56 For example:
57 obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
58 obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre>
59 </p>
60 <!-- ===== Properties ===== -->
61 <p>
62 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
63 <colgroup>
64 <col width="15%"/>
65 <col width="73%"/>
66 <col width="12%"/>
67 </colgroup>
68 <thead>
69 <tr valign="top">
70 <th class="categorylist">Properties</th>
71 <th class="categorylist">Description</th>
72 <th class="categorylist">Defined in class</th>
73 </tr>
74 </thead>
75 <tbody>
76 <!-- Property: 'poles' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><a href="matlab:doc('pzmodel.poles')">poles</a></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>pole-array of the model</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>pzmodel</p>
86 </td>
87 </tr>
88 <!-- Property: 'zeros' -->
89 <tr valign="top">
90 <td>
91 <p><a href="matlab:doc('pzmodel.zeros')">zeros</a></p>
92 </td>
93 <td>
94 <p>zero-array of the model</p>
95 </td>
96 <td>
97 <p>pzmodel</p>
98 </td>
99 </tr>
100 <!-- Property: 'gain' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><a href="matlab:doc('pzmodel.gain')">gain</a></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>gain of the model</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>pzmodel</p>
110 </td>
111 </tr>
112 <!-- Property: 'delay' -->
113 <tr valign="top">
114 <td>
115 <p><a href="matlab:doc('pzmodel.delay')">delay</a></p>
116 </td>
117 <td>
118 <p>delay of the pole/zero model</p>
119 </td>
120 <td>
121 <p>pzmodel</p>
122 </td>
123 </tr>
124 <!-- Property: 'iunits' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><a href="matlab:doc('pzmodel.iunits')">iunits</a></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>input units of the object</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>ltpda_tf</p>
134 </td>
135 </tr>
136 <!-- Property: 'ounits' -->
137 <tr valign="top">
138 <td>
139 <p><a href="matlab:doc('pzmodel.ounits')">ounits</a></p>
140 </td>
141 <td>
142 <p>output units of the object</p>
143 </td>
144 <td>
145 <p>ltpda_tf</p>
146 </td>
147 </tr>
148 <!-- Property: 'hist' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><a href="matlab:doc('pzmodel.hist')">hist</a></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>history of the object (history object)</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>ltpda_uoh</p>
158 </td>
159 </tr>
160 <!-- Property: 'procinfo' -->
161 <tr valign="top">
162 <td>
163 <p><a href="matlab:doc('pzmodel.procinfo')">procinfo</a></p>
164 </td>
165 <td>
166 <p>plist with additional information for an object.</p>
167 </td>
168 <td>
169 <p>ltpda_uoh</p>
170 </td>
171 </tr>
172 <!-- Property: 'plotinfo' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><a href="matlab:doc('pzmodel.plotinfo')">plotinfo</a></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>plist with the plot information</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>ltpda_uoh</p>
182 </td>
183 </tr>
184 <!-- Property: 'name' -->
185 <tr valign="top">
186 <td>
187 <p><a href="matlab:doc('pzmodel.name')">name</a></p>
188 </td>
189 <td>
190 <p>name of the object</p>
191 </td>
192 <td>
193 <p>ltpda_uo</p>
194 </td>
195 </tr>
196 <!-- Property: 'description' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><a href="matlab:doc('pzmodel.description')">description</a></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>description of the object</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>ltpda_uo</p>
206 </td>
207 </tr>
208 <!-- Property: 'mdlfile' -->
209 <tr valign="top">
210 <td>
211 <p><a href="matlab:doc('pzmodel.mdlfile')">mdlfile</a></p>
212 </td>
213 <td>
214 <p>model xml file of the LTPDAworkbench</p>
215 </td>
216 <td>
217 <p>ltpda_uo</p>
218 </td>
219 </tr>
220 <!-- Property: 'UUID' -->
221 <tr valign="top">
222 <td bgcolor="#f3f4f5">
223 <p><a href="matlab:doc('pzmodel.UUID')">UUID</a></p>
224 </td>
225 <td bgcolor="#f3f4f5">
226 <p>Universally Unique Identifier of 128-bit</p>
227 </td>
228 <td bgcolor="#f3f4f5">
229 <p>ltpda_uo</p>
230 </td>
231 </tr>
232 </tbody>
233 </table>
234 </p>
235
236 <!-- ===== Top of page ===== -->
237 <a href="#top_of_page">
238 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
239 Back to Top
240 </a>
241
242 <h2 class="title"><a name="top_methods"/>Methods</h2>
243 <!-- ===== link box: Begin ===== -->
244 <p>
245 <table border="1" width="80%">
246 <tr>
247 <td>
248 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
249 <colgroup>
250 <col width="37%"/>
251 <col width="63%"/>
252 </colgroup>
253 <tbody>
254 <tr valign="top">
255 <td>
256 <a href="class_desc_pzmodel.html#arithmetic_operator">Arithmetic Operator</a>
257 </td>
258 <td>Arithmetic Operator</td>
259 </tr>
260 <tr valign="top">
261 <td>
262 <a href="class_desc_pzmodel.html#constructor">Constructor</a>
263 </td>
264 <td>Constructor of this class</td>
265 </tr>
266 <tr valign="top">
267 <td>
268 <a href="class_desc_pzmodel.html#helper">Helper</a>
269 </td>
270 <td>Helper methods only for internal usage</td>
271 </tr>
272 <tr valign="top">
273 <td>
274 <a href="class_desc_pzmodel.html#internal">Internal</a>
275 </td>
276 <td>Internal methods only for internal usage</td>
277 </tr>
278 <tr valign="top">
279 <td>
280 <a href="class_desc_pzmodel.html#operator">Operator</a>
281 </td>
282 <td>Operator methods</td>
283 </tr>
284 <tr valign="top">
285 <td>
286 <a href="class_desc_pzmodel.html#output">Output</a>
287 </td>
288 <td>Output methods</td>
289 </tr>
290 <tr valign="top">
291 <td>
292 <a href="class_desc_pzmodel.html#relational_operator">Relational Operator</a>
293 </td>
294 <td>Relational operator methods</td>
295 </tr>
296 <tr valign="top">
297 <td>
298 <a href="class_desc_pzmodel.html#signal_processing">Signal Processing</a>
299 </td>
300 <td>Signal processing methods</td>
301 </tr>
302 </tbody>
303 </table>
304 </td>
305 </tr>
306 </table>
307 </p>
308 <!-- ===== link box: End ====== -->
309
310 <!-- ===== Top of page ===== -->
311 <a href="#top_of_page">
312 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
313 Back to Top
314 </a>
315
316 <!-- ===== Methods Category: Arithmetic_Operator ===== -->
317 <h3 class="title"><a name="arithmetic_operator"/>Arithmetic Operator</h3>
318 <p>
319 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
320 <colgroup>
321 <col width="15%"/>
322 <col width="73%"/>
323 <col width="12%"/>
324 </colgroup>
325 <thead>
326 <tr valign="top">
327 <th class="categorylist">Methods</th>
328 <th class="categorylist">Description</th>
329 <th class="categorylist">Defined in class</th>
330 </tr>
331 </thead>
332 <tbody>
333 <!-- pzmodel/mrdivide -->
334 <tr valign="top">
335 <td bgcolor="#f3f4f5">
336 <p><a href="matlab:doc('pzmodel/mrdivide')">mrdivide</a></p>
337 </td>
338 <td bgcolor="#f3f4f5">
339 <p>MRDIVIDE overloads the division operator for pzmodels.</p>
340 </td>
341 <td bgcolor="#f3f4f5">
342 <p>pzmodel</p>
343 </td>
344 </tr>
345 <!-- pzmodel/mtimes -->
346 <tr valign="top">
347 <td>
348 <p><a href="matlab:doc('pzmodel/mtimes')">mtimes</a></p>
349 </td>
350 <td>
351 <p>MTIMES overloads the multiplication operator for pzmodels.</p>
352 </td>
353 <td>
354 <p>pzmodel</p>
355 </td>
356 </tr>
357 <!-- pzmodel/rdivide -->
358 <tr valign="top">
359 <td bgcolor="#f3f4f5">
360 <p><a href="matlab:doc('pzmodel/rdivide')">rdivide</a></p>
361 </td>
362 <td bgcolor="#f3f4f5">
363 <p>RDIVIDE overloads the division operator for pzmodels.</p>
364 </td>
365 <td bgcolor="#f3f4f5">
366 <p>pzmodel</p>
367 </td>
368 </tr>
369 <!-- pzmodel/times -->
370 <tr valign="top">
371 <td>
372 <p><a href="matlab:doc('pzmodel/times')">times</a></p>
373 </td>
374 <td>
375 <p>TIMES overloads the multiplication operator for pzmodels.</p>
376 </td>
377 <td>
378 <p>pzmodel</p>
379 </td>
380 </tr>
381 </tbody>
382 </table>
383 <!-- ===== Back to Top of Methods ===== -->
384 <a href="#top_methods">
385 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
386 Back to Top of Section
387 </a>
388
389 </p>
390
391 <!-- ===== Methods Category: Constructor ===== -->
392 <h3 class="title"><a name="constructor"/>Constructor</h3>
393 <p>
394 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
395 <colgroup>
396 <col width="15%"/>
397 <col width="73%"/>
398 <col width="12%"/>
399 </colgroup>
400 <thead>
401 <tr valign="top">
402 <th class="categorylist">Methods</th>
403 <th class="categorylist">Description</th>
404 <th class="categorylist">Defined in class</th>
405 </tr>
406 </thead>
407 <tbody>
408 <!-- ltpda_uoh/rebuild -->
409 <tr valign="top">
410 <td bgcolor="#f3f4f5">
411 <p><a href="matlab:doc('pzmodel/rebuild')">rebuild</a></p>
412 </td>
413 <td bgcolor="#f3f4f5">
414 <p>REBUILD rebuilds the input objects using the history.</p>
415 </td>
416 <td bgcolor="#f3f4f5">
417 <p>ltpda_uoh</p>
418 </td>
419 </tr>
420 <!-- pzmodel/pzmodel -->
421 <tr valign="top">
422 <td>
423 <p><a href="matlab:doc('pzmodel')">pzmodel</a></p>
424 </td>
425 <td>
426 <p>PZMODEL constructor for pzmodel class.</p>
427 </td>
428 <td>
429 <p>pzmodel</p>
430 </td>
431 </tr>
432 </tbody>
433 </table>
434 <!-- ===== Back to Top of Methods ===== -->
435 <a href="#top_methods">
436 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
437 Back to Top of Section
438 </a>
439
440 </p>
441
442 <!-- ===== Methods Category: Helper ===== -->
443 <h3 class="title"><a name="helper"/>Helper</h3>
444 <p>
445 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
446 <colgroup>
447 <col width="15%"/>
448 <col width="73%"/>
449 <col width="12%"/>
450 </colgroup>
451 <thead>
452 <tr valign="top">
453 <th class="categorylist">Methods</th>
454 <th class="categorylist">Description</th>
455 <th class="categorylist">Defined in class</th>
456 </tr>
457 </thead>
458 <tbody>
459 <!-- ltpda_obj/get -->
460 <tr valign="top">
461 <td bgcolor="#f3f4f5">
462 <p><a href="matlab:doc('pzmodel/get')">get</a></p>
463 </td>
464 <td bgcolor="#f3f4f5">
465 <p>GET get a property of a object.</p>
466 </td>
467 <td bgcolor="#f3f4f5">
468 <p>ltpda_obj</p>
469 </td>
470 </tr>
471 <!-- ltpda_tf/setIunits -->
472 <tr valign="top">
473 <td>
474 <p><a href="matlab:doc('pzmodel/setIunits')">setIunits</a></p>
475 </td>
476 <td>
477 <p>SETIUNITS sets the 'iunits' property a transfer function object.</p>
478 </td>
479 <td>
480 <p>ltpda_tf</p>
481 </td>
482 </tr>
483 <!-- ltpda_tf/setOunits -->
484 <tr valign="top">
485 <td bgcolor="#f3f4f5">
486 <p><a href="matlab:doc('pzmodel/setOunits')">setOunits</a></p>
487 </td>
488 <td bgcolor="#f3f4f5">
489 <p>SETOUNITS sets the 'ounits' property a transfer function object.</p>
490 </td>
491 <td bgcolor="#f3f4f5">
492 <p>ltpda_tf</p>
493 </td>
494 </tr>
495 <!-- ltpda_tf/simplifyUnits -->
496 <tr valign="top">
497 <td>
498 <p><a href="matlab:doc('pzmodel/simplifyUnits')">simplifyUnits</a></p>
499 </td>
500 <td>
501 <p>SIMPLIFYUNITS simplify the input units and/or output units of the object.</p>
502 </td>
503 <td>
504 <p>ltpda_tf</p>
505 </td>
506 </tr>
507 <!-- ltpda_uoh/created -->
508 <tr valign="top">
509 <td bgcolor="#f3f4f5">
510 <p><a href="matlab:doc('pzmodel/created')">created</a></p>
511 </td>
512 <td bgcolor="#f3f4f5">
513 <p>CREATED Returns a time object of the last modification.</p>
514 </td>
515 <td bgcolor="#f3f4f5">
516 <p>ltpda_uoh</p>
517 </td>
518 </tr>
519 <!-- ltpda_uoh/creator -->
520 <tr valign="top">
521 <td>
522 <p><a href="matlab:doc('pzmodel/creator')">creator</a></p>
523 </td>
524 <td>
525 <p>CREATOR Extract the creator(s) from the history.</p>
526 </td>
527 <td>
528 <p>ltpda_uoh</p>
529 </td>
530 </tr>
531 <!-- ltpda_uoh/csvexport -->
532 <tr valign="top">
533 <td bgcolor="#f3f4f5">
534 <p><a href="matlab:doc('pzmodel/csvexport')">csvexport</a></p>
535 </td>
536 <td bgcolor="#f3f4f5">
537 <p>CSVEXPORT Exports the data of an object to a csv file.</p>
538 </td>
539 <td bgcolor="#f3f4f5">
540 <p>ltpda_uoh</p>
541 </td>
542 </tr>
543 <!-- ltpda_uoh/index -->
544 <tr valign="top">
545 <td>
546 <p><a href="matlab:doc('pzmodel/index')">index</a></p>
547 </td>
548 <td>
549 <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p>
550 </td>
551 <td>
552 <p>ltpda_uoh</p>
553 </td>
554 </tr>
555 <!-- ltpda_uoh/requirements -->
556 <tr valign="top">
557 <td bgcolor="#f3f4f5">
558 <p><a href="matlab:doc('pzmodel/requirements')">requirements</a></p>
559 </td>
560 <td bgcolor="#f3f4f5">
561 <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p>
562 </td>
563 <td bgcolor="#f3f4f5">
564 <p>ltpda_uoh</p>
565 </td>
566 </tr>
567 <!-- ltpda_uoh/setDescription -->
568 <tr valign="top">
569 <td>
570 <p><a href="matlab:doc('pzmodel/setDescription')">setDescription</a></p>
571 </td>
572 <td>
573 <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p>
574 </td>
575 <td>
576 <p>ltpda_uoh</p>
577 </td>
578 </tr>
579 <!-- ltpda_uoh/setMdlfile -->
580 <tr valign="top">
581 <td bgcolor="#f3f4f5">
582 <p><a href="matlab:doc('pzmodel/setMdlfile')">setMdlfile</a></p>
583 </td>
584 <td bgcolor="#f3f4f5">
585 <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p>
586 </td>
587 <td bgcolor="#f3f4f5">
588 <p>ltpda_uoh</p>
589 </td>
590 </tr>
591 <!-- ltpda_uoh/setName -->
592 <tr valign="top">
593 <td>
594 <p><a href="matlab:doc('pzmodel/setName')">setName</a></p>
595 </td>
596 <td>
597 <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p>
598 </td>
599 <td>
600 <p>ltpda_uoh</p>
601 </td>
602 </tr>
603 <!-- ltpda_uoh/setPlotinfo -->
604 <tr valign="top">
605 <td bgcolor="#f3f4f5">
606 <p><a href="matlab:doc('pzmodel/setPlotinfo')">setPlotinfo</a></p>
607 </td>
608 <td bgcolor="#f3f4f5">
609 <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p>
610 </td>
611 <td bgcolor="#f3f4f5">
612 <p>ltpda_uoh</p>
613 </td>
614 </tr>
615 <!-- ltpda_uoh/setProcinfo -->
616 <tr valign="top">
617 <td>
618 <p><a href="matlab:doc('pzmodel/setProcinfo')">setProcinfo</a></p>
619 </td>
620 <td>
621 <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p>
622 </td>
623 <td>
624 <p>ltpda_uoh</p>
625 </td>
626 </tr>
627 <!-- pzmodel/setDelay -->
628 <tr valign="top">
629 <td bgcolor="#f3f4f5">
630 <p><a href="matlab:doc('pzmodel/setDelay')">setDelay</a></p>
631 </td>
632 <td bgcolor="#f3f4f5">
633 <p>SETDELAY sets the 'delay' property of the pzmodel object.</p>
634 </td>
635 <td bgcolor="#f3f4f5">
636 <p>pzmodel</p>
637 </td>
638 </tr>
639 <!-- pzmodel/setGain -->
640 <tr valign="top">
641 <td>
642 <p><a href="matlab:doc('pzmodel/setGain')">setGain</a></p>
643 </td>
644 <td>
645 <p>SETGAIN sets the 'gain' property of the pzmodel object.</p>
646 </td>
647 <td>
648 <p>pzmodel</p>
649 </td>
650 </tr>
651 <!-- pzmodel/setPoles -->
652 <tr valign="top">
653 <td bgcolor="#f3f4f5">
654 <p><a href="matlab:doc('pzmodel/setPoles')">setPoles</a></p>
655 </td>
656 <td bgcolor="#f3f4f5">
657 <p>SETPOLES Set the property 'poles' of a pole/zero model.</p>
658 </td>
659 <td bgcolor="#f3f4f5">
660 <p>pzmodel</p>
661 </td>
662 </tr>
663 <!-- pzmodel/setZeros -->
664 <tr valign="top">
665 <td>
666 <p><a href="matlab:doc('pzmodel/setZeros')">setZeros</a></p>
667 </td>
668 <td>
669 <p>SETZEROS Set the property 'zeros' of a pole/zero model.</p>
670 </td>
671 <td>
672 <p>pzmodel</p>
673 </td>
674 </tr>
675 </tbody>
676 </table>
677 <!-- ===== Back to Top of Methods ===== -->
678 <a href="#top_methods">
679 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
680 Back to Top of Section
681 </a>
682
683 </p>
684
685 <!-- ===== Methods Category: Internal ===== -->
686 <h3 class="title"><a name="internal"/>Internal</h3>
687 <p>
688 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
689 <colgroup>
690 <col width="15%"/>
691 <col width="73%"/>
692 <col width="12%"/>
693 </colgroup>
694 <thead>
695 <tr valign="top">
696 <th class="categorylist">Methods</th>
697 <th class="categorylist">Description</th>
698 <th class="categorylist">Defined in class</th>
699 </tr>
700 </thead>
701 <tbody>
702 <!-- ltpda_obj/isprop -->
703 <tr valign="top">
704 <td bgcolor="#f3f4f5">
705 <p><a href="matlab:doc('pzmodel/isprop')">isprop</a></p>
706 </td>
707 <td bgcolor="#f3f4f5">
708 <p>ISPROP tests if the given field is one of the object properties.</p>
709 </td>
710 <td bgcolor="#f3f4f5">
711 <p>ltpda_obj</p>
712 </td>
713 </tr>
714 <!-- ltpda_uo/bsubmit -->
715 <tr valign="top">
716 <td>
717 <p><a href="matlab:doc('pzmodel/bsubmit')">bsubmit</a></p>
718 </td>
719 <td>
720 <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p>
721 </td>
722 <td>
723 <p>ltpda_uo</p>
724 </td>
725 </tr>
726 <!-- ltpda_uo/submit -->
727 <tr valign="top">
728 <td bgcolor="#f3f4f5">
729 <p><a href="matlab:doc('pzmodel/submit')">submit</a></p>
730 </td>
731 <td bgcolor="#f3f4f5">
732 <p>SUBMIT Submits the given objects to an LTPDA repository</p>
733 </td>
734 <td bgcolor="#f3f4f5">
735 <p>ltpda_uo</p>
736 </td>
737 </tr>
738 <!-- ltpda_uo/update -->
739 <tr valign="top">
740 <td>
741 <p><a href="matlab:doc('pzmodel/update')">update</a></p>
742 </td>
743 <td>
744 <p>UPDATE Updates the given object in an LTPDA repository</p>
745 </td>
746 <td>
747 <p>ltpda_uo</p>
748 </td>
749 </tr>
750 <!-- ltpda_uoh/string -->
751 <tr valign="top">
752 <td bgcolor="#f3f4f5">
753 <p><a href="matlab:doc('pzmodel/string')">string</a></p>
754 </td>
755 <td bgcolor="#f3f4f5">
756 <p>STRING writes a command string that can be used to recreate the input object(s).</p>
757 </td>
758 <td bgcolor="#f3f4f5">
759 <p>ltpda_uoh</p>
760 </td>
761 </tr>
762 <!-- ltpda_uoh/type -->
763 <tr valign="top">
764 <td>
765 <p><a href="matlab:doc('pzmodel/type')">type</a></p>
766 </td>
767 <td>
768 <p>TYPE converts the input objects to MATLAB functions.</p>
769 </td>
770 <td>
771 <p>ltpda_uoh</p>
772 </td>
773 </tr>
774 <!-- pzmodel/generateConstructorPlist -->
775 <tr valign="top">
776 <td bgcolor="#f3f4f5">
777 <p><a href="matlab:doc('pzmodel/generateConstructorPlist')">generateConstructorPlist</a></p>
778 </td>
779 <td bgcolor="#f3f4f5">
780 <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p>
781 </td>
782 <td bgcolor="#f3f4f5">
783 <p>pzmodel</p>
784 </td>
785 </tr>
786 <!-- pzmodel/getlowerFreq -->
787 <tr valign="top">
788 <td>
789 <p><a href="matlab:doc('pzmodel/getlowerFreq')">getlowerFreq</a></p>
790 </td>
791 <td>
792 <p>GETLOWERFREQ gets the frequency of the lowest pole or zero in the model.</p>
793 </td>
794 <td>
795 <p>pzmodel</p>
796 </td>
797 </tr>
798 <!-- pzmodel/getupperFreq -->
799 <tr valign="top">
800 <td bgcolor="#f3f4f5">
801 <p><a href="matlab:doc('pzmodel/getupperFreq')">getupperFreq</a></p>
802 </td>
803 <td bgcolor="#f3f4f5">
804 <p>GETUPPERFREQ gets the frequency of the highest pole or zero in the model.</p>
805 </td>
806 <td bgcolor="#f3f4f5">
807 <p>pzmodel</p>
808 </td>
809 </tr>
810 </tbody>
811 </table>
812 <!-- ===== Back to Top of Methods ===== -->
813 <a href="#top_methods">
814 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
815 Back to Top of Section
816 </a>
817
818 </p>
819
820 <!-- ===== Methods Category: Operator ===== -->
821 <h3 class="title"><a name="operator"/>Operator</h3>
822 <p>
823 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
824 <colgroup>
825 <col width="15%"/>
826 <col width="73%"/>
827 <col width="12%"/>
828 </colgroup>
829 <thead>
830 <tr valign="top">
831 <th class="categorylist">Methods</th>
832 <th class="categorylist">Description</th>
833 <th class="categorylist">Defined in class</th>
834 </tr>
835 </thead>
836 <tbody>
837 <!-- pzmodel/tomfir -->
838 <tr valign="top">
839 <td bgcolor="#f3f4f5">
840 <p><a href="matlab:doc('pzmodel/tomfir')">tomfir</a></p>
841 </td>
842 <td bgcolor="#f3f4f5">
843 <p>TOMFIR approximates a pole/zero model with an FIR filter.</p>
844 </td>
845 <td bgcolor="#f3f4f5">
846 <p>pzmodel</p>
847 </td>
848 </tr>
849 <!-- pzmodel/tomiir -->
850 <tr valign="top">
851 <td>
852 <p><a href="matlab:doc('pzmodel/tomiir')">tomiir</a></p>
853 </td>
854 <td>
855 <p>TOMIIR converts a pzmodel to an IIR filter using a bilinear transform.</p>
856 </td>
857 <td>
858 <p>pzmodel</p>
859 </td>
860 </tr>
861 </tbody>
862 </table>
863 <!-- ===== Back to Top of Methods ===== -->
864 <a href="#top_methods">
865 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
866 Back to Top of Section
867 </a>
868
869 </p>
870
871 <!-- ===== Methods Category: Output ===== -->
872 <h3 class="title"><a name="output"/>Output</h3>
873 <p>
874 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
875 <colgroup>
876 <col width="15%"/>
877 <col width="73%"/>
878 <col width="12%"/>
879 </colgroup>
880 <thead>
881 <tr valign="top">
882 <th class="categorylist">Methods</th>
883 <th class="categorylist">Description</th>
884 <th class="categorylist">Defined in class</th>
885 </tr>
886 </thead>
887 <tbody>
888 <!-- ltpda_uo/save -->
889 <tr valign="top">
890 <td bgcolor="#f3f4f5">
891 <p><a href="matlab:doc('pzmodel/save')">save</a></p>
892 </td>
893 <td bgcolor="#f3f4f5">
894 <p>SAVE overloads save operator for ltpda objects.</p>
895 </td>
896 <td bgcolor="#f3f4f5">
897 <p>ltpda_uo</p>
898 </td>
899 </tr>
900 <!-- ltpda_uoh/report -->
901 <tr valign="top">
902 <td>
903 <p><a href="matlab:doc('pzmodel/report')">report</a></p>
904 </td>
905 <td>
906 <p>REPORT generates an HTML report about the input objects.</p>
907 </td>
908 <td>
909 <p>ltpda_uoh</p>
910 </td>
911 </tr>
912 <!-- ltpda_uoh/viewHistory -->
913 <tr valign="top">
914 <td bgcolor="#f3f4f5">
915 <p><a href="matlab:doc('pzmodel/viewHistory')">viewHistory</a></p>
916 </td>
917 <td bgcolor="#f3f4f5">
918 <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p>
919 </td>
920 <td bgcolor="#f3f4f5">
921 <p>ltpda_uoh</p>
922 </td>
923 </tr>
924 <!-- pzmodel/char -->
925 <tr valign="top">
926 <td>
927 <p><a href="matlab:doc('pzmodel/char')">char</a></p>
928 </td>
929 <td>
930 <p>CHAR convert a pzmodel object into a string.</p>
931 </td>
932 <td>
933 <p>pzmodel</p>
934 </td>
935 </tr>
936 <!-- pzmodel/display -->
937 <tr valign="top">
938 <td bgcolor="#f3f4f5">
939 <p><a href="matlab:doc('pzmodel/display')">display</a></p>
940 </td>
941 <td bgcolor="#f3f4f5">
942 <p>DISPLAY overloads display functionality for pzmodel objects.</p>
943 </td>
944 <td bgcolor="#f3f4f5">
945 <p>pzmodel</p>
946 </td>
947 </tr>
948 </tbody>
949 </table>
950 <!-- ===== Back to Top of Methods ===== -->
951 <a href="#top_methods">
952 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
953 Back to Top of Section
954 </a>
955
956 </p>
957
958 <!-- ===== Methods Category: Relational_Operator ===== -->
959 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
960 <p>
961 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
962 <colgroup>
963 <col width="15%"/>
964 <col width="73%"/>
965 <col width="12%"/>
966 </colgroup>
967 <thead>
968 <tr valign="top">
969 <th class="categorylist">Methods</th>
970 <th class="categorylist">Description</th>
971 <th class="categorylist">Defined in class</th>
972 </tr>
973 </thead>
974 <tbody>
975 <!-- ltpda_obj/eq -->
976 <tr valign="top">
977 <td bgcolor="#f3f4f5">
978 <p><a href="matlab:doc('pzmodel/eq')">eq</a></p>
979 </td>
980 <td bgcolor="#f3f4f5">
981 <p>EQ overloads the == operator for ltpda objects.</p>
982 </td>
983 <td bgcolor="#f3f4f5">
984 <p>ltpda_obj</p>
985 </td>
986 </tr>
987 <!-- ltpda_obj/ne -->
988 <tr valign="top">
989 <td>
990 <p><a href="matlab:doc('pzmodel/ne')">ne</a></p>
991 </td>
992 <td>
993 <p>NE overloads the ~= operator for ltpda objects.</p>
994 </td>
995 <td>
996 <p>ltpda_obj</p>
997 </td>
998 </tr>
999 </tbody>
1000 </table>
1001 <!-- ===== Back to Top of Methods ===== -->
1002 <a href="#top_methods">
1003 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1004 Back to Top of Section
1005 </a>
1006
1007 </p>
1008
1009 <!-- ===== Methods Category: Signal_Processing ===== -->
1010 <h3 class="title"><a name="signal_processing"/>Signal Processing</h3>
1011 <p>
1012 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
1013 <colgroup>
1014 <col width="15%"/>
1015 <col width="73%"/>
1016 <col width="12%"/>
1017 </colgroup>
1018 <thead>
1019 <tr valign="top">
1020 <th class="categorylist">Methods</th>
1021 <th class="categorylist">Description</th>
1022 <th class="categorylist">Defined in class</th>
1023 </tr>
1024 </thead>
1025 <tbody>
1026 <!-- ltpda_tf/resp -->
1027 <tr valign="top">
1028 <td bgcolor="#f3f4f5">
1029 <p><a href="matlab:doc('pzmodel/resp')">resp</a></p>
1030 </td>
1031 <td bgcolor="#f3f4f5">
1032 <p>RESP returns the complex response of a transfer function as an Analysis Object.</p>
1033 </td>
1034 <td bgcolor="#f3f4f5">
1035 <p>ltpda_tf</p>
1036 </td>
1037 </tr>
1038 <!-- pzmodel/fngen -->
1039 <tr valign="top">
1040 <td>
1041 <p><a href="matlab:doc('pzmodel/fngen')">fngen</a></p>
1042 </td>
1043 <td>
1044 <p>FNGEN creates an arbitrarily long time-series based on the input pzmodel.</p>
1045 </td>
1046 <td>
1047 <p>pzmodel</p>
1048 </td>
1049 </tr>
1050 <!-- pzmodel/simplify -->
1051 <tr valign="top">
1052 <td bgcolor="#f3f4f5">
1053 <p><a href="matlab:doc('pzmodel/simplify')">simplify</a></p>
1054 </td>
1055 <td bgcolor="#f3f4f5">
1056 <p>SIMPLIFY simplifies pzmodels by cancelling like poles with like zeros.</p>
1057 </td>
1058 <td bgcolor="#f3f4f5">
1059 <p>pzmodel</p>
1060 </td>
1061 </tr>
1062 </tbody>
1063 </table>
1064 <!-- ===== Back to Top of Methods ===== -->
1065 <a href="#top_methods">
1066 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
1067 Back to Top of Section
1068 </a>
1069
1070 </p>
1071
1072 <!-- ================================================== -->
1073 <!-- END CONTENT FILE -->
1074 <!-- ================================================== -->