Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_pzmodel.html @ 0:f0afece42f48

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