Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_pz_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_pz_content.html,v 1.6 2009/03/17 16:52:04 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_pz.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_pz.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_main.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: 'f' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>f</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Frequency of pole/zero</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>pz</p>
86 </td>
87 </tr>
88 <!-- Property: 'q' -->
89 <tr valign="top">
90 <td>
91 <p><tt>q</tt></p>
92 </td>
93 <td>
94 <p>Quality factor of pole/zero</p>
95 </td>
96 <td>
97 <p>pz</p>
98 </td>
99 </tr>
100 <!-- Property: 'ri' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>ri</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Complex representation of pole/zero</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>pz</p>
110 </td>
111 </tr>
112 <!-- Property: 'version' -->
113 <tr valign="top">
114 <td>
115 <p><tt>version</tt></p>
116 </td>
117 <td>
118 <p>CVS version string of the constructor</p>
119 </td>
120 <td>
121 <p>pz</p>
122 </td>
123 </tr>
124 </tbody>
125 </table>
126 </p>
127
128 <!-- ===== Top of page ===== -->
129 <a href="#top_of_page">
130 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
131 Back to Top
132 </a>
133
134 <h2 class="title"><a name="top_methods"/>Methods</h2>
135 <!-- ===== link box: Begin ===== -->
136 <p>
137 <table border="1" width="80%">
138 <tr>
139 <td>
140 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
141 <colgroup>
142 <col width="37%"/>
143 <col width="63%"/>
144 </colgroup>
145 <tbody>
146 <tr valign="top">
147 <td>
148 <a href="class_desc_pz.html#constructor">Constructor</a>
149 </td>
150 <td>Constructor of this class</td>
151 </tr>
152 <tr valign="top">
153 <td>
154 <a href="class_desc_pz.html#helper">Helper</a>
155 </td>
156 <td>Helper methods only for internal usage</td>
157 </tr>
158 <tr valign="top">
159 <td>
160 <a href="class_desc_pz.html#internal">Internal</a>
161 </td>
162 <td>Internal methods only for internal usage</td>
163 </tr>
164 <tr valign="top">
165 <td>
166 <a href="class_desc_pz.html#output">Output</a>
167 </td>
168 <td>Output methods</td>
169 </tr>
170 <tr valign="top">
171 <td>
172 <a href="class_desc_pz.html#relational_operator">Relational Operator</a>
173 </td>
174 <td>Relational operator methods</td>
175 </tr>
176 <tr valign="top">
177 <td>
178 <a href="class_desc_pz.html#signal_processing">Signal Processing</a>
179 </td>
180 <td>Signal processing methods</td>
181 </tr>
182 </tbody>
183 </table>
184 </td>
185 </tr>
186 </table>
187 </p>
188 <!-- ===== link box: End ====== -->
189
190 <!-- ===== Top of page ===== -->
191 <a href="#top_of_page">
192 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
193 Back to Top
194 </a>
195
196 <!-- ===== Methods Category: Constructor ===== -->
197 <h3 class="title"><a name="constructor"/>Constructor</h3>
198 <p>
199 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
200 <colgroup>
201 <col width="15%"/>
202 <col width="73%"/>
203 <col width="12%"/>
204 </colgroup>
205 <thead>
206 <tr valign="top">
207 <th class="categorylist">Methods</th>
208 <th class="categorylist">Description</th>
209 <th class="categorylist">Defined in class</th>
210 </tr>
211 </thead>
212 <tbody>
213 <!-- pz/pz -->
214 <tr valign="top">
215 <td bgcolor="#f3f4f5">
216 <p><a href="matlab:doc('pz')">pz</a></p>
217 </td>
218 <td bgcolor="#f3f4f5">
219 <p>PZ is the ltpda class that provides a common definition of poles and zeros.</p>
220 </td>
221 <td bgcolor="#f3f4f5">
222 <p>pz</p>
223 </td>
224 </tr>
225 </tbody>
226 </table>
227 <!-- ===== Back to Top of Methods ===== -->
228 <a href="#top_methods">
229 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
230 Back to Top of Section
231 </a>
232
233 </p>
234
235 <!-- ===== Methods Category: Helper ===== -->
236 <h3 class="title"><a name="helper"/>Helper</h3>
237 <p>
238 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
239 <colgroup>
240 <col width="15%"/>
241 <col width="73%"/>
242 <col width="12%"/>
243 </colgroup>
244 <thead>
245 <tr valign="top">
246 <th class="categorylist">Methods</th>
247 <th class="categorylist">Description</th>
248 <th class="categorylist">Defined in class</th>
249 </tr>
250 </thead>
251 <tbody>
252 <!-- ltpda_obj/get -->
253 <tr valign="top">
254 <td bgcolor="#f3f4f5">
255 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
256 </td>
257 <td bgcolor="#f3f4f5">
258 <p>GET get a property of a object.</p>
259 </td>
260 <td bgcolor="#f3f4f5">
261 <p>ltpda_obj</p>
262 </td>
263 </tr>
264 <!-- ltpda_obj/isprop -->
265 <tr valign="top">
266 <td>
267 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
268 </td>
269 <td>
270 <p>ISPROP tests if the given field is one of the object properties.</p>
271 </td>
272 <td>
273 <p>ltpda_obj</p>
274 </td>
275 </tr>
276 </tbody>
277 </table>
278 <!-- ===== Back to Top of Methods ===== -->
279 <a href="#top_methods">
280 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
281 Back to Top of Section
282 </a>
283
284 </p>
285
286 <!-- ===== Methods Category: Internal ===== -->
287 <h3 class="title"><a name="internal"/>Internal</h3>
288 <p>
289 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
290 <colgroup>
291 <col width="15%"/>
292 <col width="73%"/>
293 <col width="12%"/>
294 </colgroup>
295 <thead>
296 <tr valign="top">
297 <th class="categorylist">Methods</th>
298 <th class="categorylist">Description</th>
299 <th class="categorylist">Defined in class</th>
300 </tr>
301 </thead>
302 <tbody>
303 <!-- pz/cp2iir -->
304 <tr valign="top">
305 <td bgcolor="#f3f4f5">
306 <p><a href="matlab:doc('pz/cp2iir')">cp2iir</a></p>
307 </td>
308 <td bgcolor="#f3f4f5">
309 <p>CP2IIR Return a,b IIR filter coefficients for a complex pole designed using the bilinear transform.</p>
310 </td>
311 <td bgcolor="#f3f4f5">
312 <p>pz</p>
313 </td>
314 </tr>
315 <!-- pz/cz2iir -->
316 <tr valign="top">
317 <td>
318 <p><a href="matlab:doc('pz/cz2iir')">cz2iir</a></p>
319 </td>
320 <td>
321 <p>CZ2IIR return a,b IIR filter coefficients for a complex zero designed using the bilinear transform.</p>
322 </td>
323 <td>
324 <p>pz</p>
325 </td>
326 </tr>
327 <!-- pz/rp2iir -->
328 <tr valign="top">
329 <td bgcolor="#f3f4f5">
330 <p><a href="matlab:doc('pz/rp2iir')">rp2iir</a></p>
331 </td>
332 <td bgcolor="#f3f4f5">
333 <p>RP2IIR Return a,b coefficients for a real pole designed using the bilinear transform.</p>
334 </td>
335 <td bgcolor="#f3f4f5">
336 <p>pz</p>
337 </td>
338 </tr>
339 <!-- pz/rz2iir -->
340 <tr valign="top">
341 <td>
342 <p><a href="matlab:doc('pz/rz2iir')">rz2iir</a></p>
343 </td>
344 <td>
345 <p>RZ2IIR Return a,b IIR filter coefficients for a real zero designed using the bilinear transform.</p>
346 </td>
347 <td>
348 <p>pz</p>
349 </td>
350 </tr>
351 </tbody>
352 </table>
353 <!-- ===== Back to Top of Methods ===== -->
354 <a href="#top_methods">
355 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
356 Back to Top of Section
357 </a>
358
359 </p>
360
361 <!-- ===== Methods Category: Output ===== -->
362 <h3 class="title"><a name="output"/>Output</h3>
363 <p>
364 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
365 <colgroup>
366 <col width="15%"/>
367 <col width="73%"/>
368 <col width="12%"/>
369 </colgroup>
370 <thead>
371 <tr valign="top">
372 <th class="categorylist">Methods</th>
373 <th class="categorylist">Description</th>
374 <th class="categorylist">Defined in class</th>
375 </tr>
376 </thead>
377 <tbody>
378 <!-- pz/char -->
379 <tr valign="top">
380 <td bgcolor="#f3f4f5">
381 <p><a href="matlab:doc('pz/char')">char</a></p>
382 </td>
383 <td bgcolor="#f3f4f5">
384 <p>CHAR convert a pz object into a string.</p>
385 </td>
386 <td bgcolor="#f3f4f5">
387 <p>pz</p>
388 </td>
389 </tr>
390 <!-- pz/display -->
391 <tr valign="top">
392 <td>
393 <p><a href="matlab:doc('pz/display')">display</a></p>
394 </td>
395 <td>
396 <p>DISPLAY display a pz object.</p>
397 </td>
398 <td>
399 <p>pz</p>
400 </td>
401 </tr>
402 <!-- pz/string -->
403 <tr valign="top">
404 <td bgcolor="#f3f4f5">
405 <p><a href="matlab:doc('pz/string')">string</a></p>
406 </td>
407 <td bgcolor="#f3f4f5">
408 <p>STRING writes a command string that can be used to recreate the input pz object.</p>
409 </td>
410 <td bgcolor="#f3f4f5">
411 <p>pz</p>
412 </td>
413 </tr>
414 </tbody>
415 </table>
416 <!-- ===== Back to Top of Methods ===== -->
417 <a href="#top_methods">
418 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
419 Back to Top of Section
420 </a>
421
422 </p>
423
424 <!-- ===== Methods Category: Relational_Operator ===== -->
425 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
426 <p>
427 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
428 <colgroup>
429 <col width="15%"/>
430 <col width="73%"/>
431 <col width="12%"/>
432 </colgroup>
433 <thead>
434 <tr valign="top">
435 <th class="categorylist">Methods</th>
436 <th class="categorylist">Description</th>
437 <th class="categorylist">Defined in class</th>
438 </tr>
439 </thead>
440 <tbody>
441 <!-- ltpda_obj/eq -->
442 <tr valign="top">
443 <td bgcolor="#f3f4f5">
444 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
445 </td>
446 <td bgcolor="#f3f4f5">
447 <p>EQ overloads the == operator for ltpda objects.</p>
448 </td>
449 <td bgcolor="#f3f4f5">
450 <p>ltpda_obj</p>
451 </td>
452 </tr>
453 <!-- ltpda_obj/ne -->
454 <tr valign="top">
455 <td>
456 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
457 </td>
458 <td>
459 <p>NE overloads the ~= operator for ltpda objects.</p>
460 </td>
461 <td>
462 <p>ltpda_obj</p>
463 </td>
464 </tr>
465 </tbody>
466 </table>
467 <!-- ===== Back to Top of Methods ===== -->
468 <a href="#top_methods">
469 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
470 Back to Top of Section
471 </a>
472
473 </p>
474
475 <!-- ===== Methods Category: Signal_Processing ===== -->
476 <h3 class="title"><a name="signal_processing"/>Signal Processing</h3>
477 <p>
478 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
479 <colgroup>
480 <col width="15%"/>
481 <col width="73%"/>
482 <col width="12%"/>
483 </colgroup>
484 <thead>
485 <tr valign="top">
486 <th class="categorylist">Methods</th>
487 <th class="categorylist">Description</th>
488 <th class="categorylist">Defined in class</th>
489 </tr>
490 </thead>
491 <tbody>
492 <!-- pz/resp -->
493 <tr valign="top">
494 <td bgcolor="#f3f4f5">
495 <p><a href="matlab:doc('pz/resp')">resp</a></p>
496 </td>
497 <td bgcolor="#f3f4f5">
498 <p>RESP returns the complex response of the pz object.</p>
499 </td>
500 <td bgcolor="#f3f4f5">
501 <p>pz</p>
502 </td>
503 </tr>
504 </tbody>
505 </table>
506 <!-- ===== Back to Top of Methods ===== -->
507 <a href="#top_methods">
508 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
509 Back to Top of Section
510 </a>
511
512 </p>
513
514 <!-- ================================================== -->
515 <!-- END CONTENT FILE -->
516 <!-- ================================================== -->