view m-toolbox/html_help/help/ug/class_desc_pz_content.html @ 51:9d5c88356247
database-connection-manager
Make unit tests database connection parameters configurable
| author |
Daniele Nicolodi <nicolodi@science.unitn.it> |
| date |
Wed, 07 Dec 2011 17:24:37 +0100 (2011-12-07) |
| parents |
f0afece42f48 |
| children |
|
line source
<!-- $Id: class_desc_pz_content.html,v 1.6 2009/03/17 16:52:04 ingo Exp $ -->
<!-- ================================================== -->
<!-- BEGIN CONTENT FILE -->
<!-- ================================================== -->
<!-- ===== link box: Begin ===== -->
<p>
<table border="1" width="80%">
<tr>
<td>
<table border="0" cellpadding="5" class="categorylist" width="100%">
<colgroup>
<col width="37%"/>
<col width="63%"/>
</colgroup>
<tbody>
<tr valign="top">
<td>
<a href="class_desc_pz.html#top_properties">Properties</a>
</td>
<td>Properties of the class</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#top_methods">Methods</a>
</td>
<td>All Methods of the class ordered by category.</td>
</tr>
<tr valign="top">
<td>
<a href="constructor_examples_main.html">Examples</a>
</td>
<td>Some constructor examples</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</p>
<!-- ===== link box: End ====== -->
<!-- ===== Back to Class descriptions ===== -->
<a href="class_desc_main.html">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
Back to Class descriptions
</a>
<h2 class="title"><a name="top_properties"/>Properties</h2>
<p>
The LTPDA toolbox restrict access of the properties.<br></br>
The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
<pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
<pre class="programlisting">
For example:
obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre>
</p>
<!-- ===== Properties ===== -->
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Properties</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- Property: 'f' -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><tt>f</tt></p>
</td>
<td bgcolor="#f3f4f5">
<p>Frequency of pole/zero</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
<!-- Property: 'q' -->
<tr valign="top">
<td>
<p><tt>q</tt></p>
</td>
<td>
<p>Quality factor of pole/zero</p>
</td>
<td>
<p>pz</p>
</td>
</tr>
<!-- Property: 'ri' -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><tt>ri</tt></p>
</td>
<td bgcolor="#f3f4f5">
<p>Complex representation of pole/zero</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
<!-- Property: 'version' -->
<tr valign="top">
<td>
<p><tt>version</tt></p>
</td>
<td>
<p>CVS version string of the constructor</p>
</td>
<td>
<p>pz</p>
</td>
</tr>
</tbody>
</table>
</p>
<!-- ===== Top of page ===== -->
<a href="#top_of_page">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
Back to Top
</a>
<h2 class="title"><a name="top_methods"/>Methods</h2>
<!-- ===== link box: Begin ===== -->
<p>
<table border="1" width="80%">
<tr>
<td>
<table border="0" cellpadding="5" class="subcategorylist" width="100%">
<colgroup>
<col width="37%"/>
<col width="63%"/>
</colgroup>
<tbody>
<tr valign="top">
<td>
<a href="class_desc_pz.html#constructor">Constructor</a>
</td>
<td>Constructor of this class</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#helper">Helper</a>
</td>
<td>Helper methods only for internal usage</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#internal">Internal</a>
</td>
<td>Internal methods only for internal usage</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#output">Output</a>
</td>
<td>Output methods</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#relational_operator">Relational Operator</a>
</td>
<td>Relational operator methods</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_pz.html#signal_processing">Signal Processing</a>
</td>
<td>Signal processing methods</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</p>
<!-- ===== link box: End ====== -->
<!-- ===== Top of page ===== -->
<a href="#top_of_page">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
Back to Top
</a>
<!-- ===== Methods Category: Constructor ===== -->
<h3 class="title"><a name="constructor"/>Constructor</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- pz/pz -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz')">pz</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>PZ is the ltpda class that provides a common definition of poles and zeros.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ===== Methods Category: Helper ===== -->
<h3 class="title"><a name="helper"/>Helper</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- ltpda_obj/get -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>GET get a property of a object.</p>
</td>
<td bgcolor="#f3f4f5">
<p>ltpda_obj</p>
</td>
</tr>
<!-- ltpda_obj/isprop -->
<tr valign="top">
<td>
<p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
</td>
<td>
<p>ISPROP tests if the given field is one of the object properties.</p>
</td>
<td>
<p>ltpda_obj</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ===== Methods Category: Internal ===== -->
<h3 class="title"><a name="internal"/>Internal</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- pz/cp2iir -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz/cp2iir')">cp2iir</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>CP2IIR Return a,b IIR filter coefficients for a complex pole designed using the bilinear transform.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
<!-- pz/cz2iir -->
<tr valign="top">
<td>
<p><a href="matlab:doc('pz/cz2iir')">cz2iir</a></p>
</td>
<td>
<p>CZ2IIR return a,b IIR filter coefficients for a complex zero designed using the bilinear transform.</p>
</td>
<td>
<p>pz</p>
</td>
</tr>
<!-- pz/rp2iir -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz/rp2iir')">rp2iir</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>RP2IIR Return a,b coefficients for a real pole designed using the bilinear transform.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
<!-- pz/rz2iir -->
<tr valign="top">
<td>
<p><a href="matlab:doc('pz/rz2iir')">rz2iir</a></p>
</td>
<td>
<p>RZ2IIR Return a,b IIR filter coefficients for a real zero designed using the bilinear transform.</p>
</td>
<td>
<p>pz</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ===== Methods Category: Output ===== -->
<h3 class="title"><a name="output"/>Output</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- pz/char -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz/char')">char</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>CHAR convert a pz object into a string.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
<!-- pz/display -->
<tr valign="top">
<td>
<p><a href="matlab:doc('pz/display')">display</a></p>
</td>
<td>
<p>DISPLAY display a pz object.</p>
</td>
<td>
<p>pz</p>
</td>
</tr>
<!-- pz/string -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz/string')">string</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>STRING writes a command string that can be used to recreate the input pz object.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ===== Methods Category: Relational_Operator ===== -->
<h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- ltpda_obj/eq -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>EQ overloads the == operator for ltpda objects.</p>
</td>
<td bgcolor="#f3f4f5">
<p>ltpda_obj</p>
</td>
</tr>
<!-- ltpda_obj/ne -->
<tr valign="top">
<td>
<p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
</td>
<td>
<p>NE overloads the ~= operator for ltpda objects.</p>
</td>
<td>
<p>ltpda_obj</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ===== Methods Category: Signal_Processing ===== -->
<h3 class="title"><a name="signal_processing"/>Signal Processing</h3>
<p>
<table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
<colgroup>
<col width="15%"/>
<col width="73%"/>
<col width="12%"/>
</colgroup>
<thead>
<tr valign="top">
<th class="categorylist">Methods</th>
<th class="categorylist">Description</th>
<th class="categorylist">Defined in class</th>
</tr>
</thead>
<tbody>
<!-- pz/resp -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('pz/resp')">resp</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>RESP returns the complex response of the pz object.</p>
</td>
<td bgcolor="#f3f4f5">
<p>pz</p>
</td>
</tr>
</tbody>
</table>
<!-- ===== Back to Top of Methods ===== -->
<a href="#top_methods">
<img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
Back to Top of Section
</a>
</p>
<!-- ================================================== -->
<!-- END CONTENT FILE -->
<!-- ================================================== -->
