Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/constructor_examples_pzmodel_content.html @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/constructor_examples_pzmodel_content.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,174 @@ +<!-- $Id: constructor_examples_pzmodel_content.html,v 1.3 2009/09/08 14:54:13 nicola Exp $ --> + +<!-- -------------------------------------------------- --> +<!-- --------------- BEGIN CONTENT FILE --------------- --> +<!-- -------------------------------------------------- --> + +<table border="0" summary="Simple list" class="simplelist_nottable_last"> + <tr> + <td> + <a href="pzmodel_model.html">General information about PZMODEL objects</a> + </td> + </tr> + <tr> + <td> + <a href="constructor_examples_pzmodel.html#empty">Construct empty PZMODEL object</a> + </td> + </tr> + <tr> + <td> + <a href="constructor_examples_pzmodel.html#xml_file">Construct a PZMODEL object by loading the object from a file</a> + </td> + </tr> + <tr> + <td> + <a href="constructor_examples_pzmodel.html#gain_poles_zeros">Construct a PZMODEL object from gain, poles and zeros</a> + </td> + </tr> + <tr> + <td> + <a href="constructor_examples_pzmodel.html#exist_model">Construct a PZMODEL object from an existing model</a> + </td> + </tr> + <tr> + <td> + <a href="constructor_examples_pzmodel.html#plist">Construct a PZMODEL object from a parameter list (PLIST) object</a> + </td> + </tr> +</table> + +<!-- --------------- NEXT EXAMPLE --------------- --> + +<hr> +<h2 class="title"><a href="pzmodel_model.html">General information about pole/zero models</a></h2> +<h2 class="title"> + <!-- --------------- NEXT EXAMPLE --------------- --> + <a href="gui_pzmodel.html">For help in designing a PZMODEL object, see also the PZMODEL Helper GUI documentation</a></h2> +<hr> +<h2 class="title"><a name="empty"></a>Construct empty PZMODEL object</h2> +<p>The following example creates an empty pzmodel object</p> +<div class="fragment"><pre class="programlisting"> +pzm = pzmodel() +---- pzmodel 1 ---- +model: None +gain : 0 +pole 001: pole(NaN) +zero 001: zero(NaN) +------------------- +</pre></div> + +<!-- --------------- NEXT EXAMPLE --------------- --> + +<hr> +<h2 class="title"><a name="xml_file"></a>Construct a PZMODEL object by loading the object from a file</h2> +<p>The following example creates a new pzmodel object by loading the pzmodel object from disk.</p> +<div class="fragment"><pre class="programlisting"> +p = pzmodel(<span class="string">'pzmodel.mat'</span>) +p = pzmodel(<span class="string">'pzmodel.xml'</span>) +</pre></div> + +<!-- --------------- NEXT EXAMPLE --------------- --> + +<hr> +<h2 class="title"><a name="gain_poles_zeros"></a>Construct a PZMODEL object from gain, poles and zeros</h2> +<p>The following code fragment creates a pole/zero model consisting of 2 poles and 2 zeros with a gain factor of 10:</p> +<div class="fragment"><pre class="programlisting"> +gain = 10; +poles = [pole(1,2) pole(40)]; +zeros = [zero(10,3) zero(100)]; + +pzm = pzmodel(gain, poles, zeros) +---- pzmodel 1 ---- +model: None +gain : 10 +pole 001: pole(1,2) +pole 002: pole(40) +zero 001: zero(10,3) +zero 002: zero(100) +------------------- +</pre></div> +<p>It is possible to give the model direct a name.</p> +<div class="fragment"><pre class="programlisting"> +gain = 10; +poles = [pole(1,2) pole(40)]; +zeros = [zero(10,3) zero(100)]; + +pzm = pzmodel(gain, poles, zeros, <span class="string">'my model name'</span>) +---- pzmodel 1 ---- +model: <span class="string">my model name</span> +gain : 10 +pole 001: pole(1,2) +pole 002: pole(40) +zero 001: zero(10,3) +zero 002: zero(100) +------------------- +</pre></div> + +<!-- --------------- NEXT EXAMPLE --------------- --> + +<hr> +<h2 class="title"><a name="exist_model"></a>Construct a PZMODEL object from an existing model</h2> +<p>The pzmodel constructor also accepts as an input existing models in a LISO file format</p> +<div class="fragment"><pre class="programlisting"> +pzm = pzmodel(<span class="string">'foo.fil'</span>) +</pre></div> + +<!-- --------------- NEXT EXAMPLE --------------- --> + +<hr> +<h2 class="title"><a name="plist"></a>Construct a PZMODEL object from a parameter list (PLIST) object</h2> +<p>Construct a PZMODEL from its definion. + <table border="0" summary="Simple list" class="simplelist_nottable_last" width="50%"> + <tr valign="top"> + <td width="25%"> + <p>'gain'</p> + </td> + <td width="75%"> + <p>Model gain [default: 1]</p> + </td> + </tr> + <tr valign="top"> + <td width="25%"> + <p>'poles'</p> + </td> + <td width="75%"> + <p>Vector of pole objects [default: empty pole]</p> + </td> + </tr> + <tr valign="top"> + <td width="25%"> + <p>'zeros'</p> + </td> + <td width="75%"> + <p>Vector of zero objects [default: empty zero]</p> + </td> + </tr> + <tr valign="top"> + <td width="25%"> + <p>'name'</p> + </td> + <td width="75%"> + <p>Name of model [default: 'None']</p> + </td> + </tr> + </table> +</p> +<div class="fragment"><pre class="programlisting"> +poles = [pole(0.1) pole(1,100)]; +zeros = [zero(10,3) zero(100)]; +pl = plist('name', 'my filter', 'poles', poles, 'zeros', zeros, 'gain', 10); + +pzm = pzmodel(pl) +---- pzmodel 1 ---- +model: my filter +gain : 10 +pole 001: pole(0.1) +pole 002: pole(1,100) +zero 001: zero(10,3) +zero 002: zero(100) +------------------- +</pre></div> + +<!-- ------------------------------------------------ --> +<!-- --------------- END CONTENT FILE --------------- --> +<!-- ------------------------------------------------ -->