diff m-toolbox/html_help/help/ug/constructor_examples_pole_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_pole_content.html	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,100 @@
+<!-- $Id: constructor_examples_pole_content.html,v 1.2 2008/03/30 20:40:04 ingo Exp $ -->
+
+<!-- -------------------------------------------------- -->
+<!-- --------------- BEGIN CONTENT FILE --------------- -->
+<!-- -------------------------------------------------- -->
+
+<!-- --------------- Link box: begin --------------- -->
+<table border="0" summary="Simple list" class="simplelist_nottable_last">
+  <tr>
+    <td>
+      <a href="constructor_examples_pole.html#empty">Construct empty POLE object</a>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <a href="constructor_examples_pole.html#xml_file">Construct a POLE object by loading the object from a file</a>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <a href="constructor_examples_pole.html#real">Construct a POLE object with a real pole</a>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <a href="constructor_examples_pole.html#complex">Construct a POLE object with a complex pole</a>
+    </td>
+  </tr>
+</table>
+
+<p>Poles are specified by in the LTPDA Toolbox by a frequency, f, and (optionally) a quality factor, Q.</p>
+<!-- --------------- Link box: end --------------- -->
+
+<!-- --------------- NEXT EXAMPLE --------------- -->
+
+<hr>
+<h2 class="title"><a name="empty"></a>Construct empty POLE object</h2>
+<p>The following example creates an empty pole object</p>
+<div class="fragment"><pre class="programlisting">
+p = pole()
+---- pole 1 ----
+None: NaN Hz
+----------------
+</pre></div>
+
+<!-- --------------- NEXT EXAMPLE --------------- -->
+
+<hr>
+<h2 class="title"><a name="xml_file"></a>Construct a POLE object by loading the object from a file</h2>
+<p>The following example creates a new pole object by loading the pole object from disk.</p>
+<div class="fragment"><pre class="programlisting">
+p = pole(<span class="string">'pole.mat'</span>)
+p = pole(<span class="string">'pole.xml'</span>)
+</pre></div>
+
+<!-- --------------- NEXT EXAMPLE --------------- -->
+
+<hr>
+<h2 class="title"><a name="real"></a>Construct a POLE object with a real pole</h2>
+<p>The following code fragment creates a real pole at 1Hz:</p>
+<div class="fragment"><pre class="programlisting">
+p = pole(1)
+---- pole 1 ----
+real pole: 1 Hz
+----------------
+</pre></div>
+<p>It is also possible to use a parameter list (PLIST) object</p>
+<div class="fragment"><pre class="programlisting">
+pl = plist(<span class="string">'f'</span>, 1);
+
+p = pole(pl)
+---- pole 1 ----
+real pole: 1 Hz
+----------------
+</pre></div>
+
+<!-- --------------- NEXT EXAMPLE --------------- -->
+
+<hr>
+<h2 class="title"><a name="complex"></a>Construct a POLE object with a complex pole</h2>
+<p>To create a complex pole, you can specify a quality factor. For example</p>
+<div class="fragment"><pre class="programlisting">
+p = pole(10,4)
+---- pole 1 ----
+complex pole: 10 Hz, Q=4 [-0.0019894+0.015791i]
+----------------
+</pre></div>
+<p>It is also possible to use a parameter list (PLIST) object</p>
+<div class="fragment"><pre class="programlisting">
+pl = plist(<span class="string">'f'</span>, 10, <span class="string">'q'</span>, 4);
+
+pole(pl)
+---- pole 1 ----
+complex pole: 10 Hz, Q=4 [-0.0019894+0.015791i]
+----------------
+</pre></div>
+
+<!-- ------------------------------------------------ -->
+<!-- --------------- END CONTENT FILE --------------- -->
+<!-- ------------------------------------------------ -->