Revision of English help pages for different functions (nothing serious).
[scilab.git] / scilab / modules / elementary_functions / help / en_US / signalprocessing / trfmod.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="trfmod">
14     <refnamediv>
15         <refname>trfmod</refname>
16         <refpurpose>poles and zeros display</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[hm]=trfmod(h [,job])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Description</title>
24         <para>
25             To visualize the pole-zero structure of a SISO transfer 
26             function <literal>h</literal> .
27         </para>
28         <variablelist>
29             <varlistentry>
30                 <term>job='p'</term>
31                 <listitem>
32                     <para>visualization of polynomials (default)</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>job='f'</term>
37                 <listitem>
38                     <para>visualization of natural frequencies and damping</para>
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42         <para>
43             Interactive simplification of <literal>h</literal>. <literal>trfmod</literal> opens
44             a dialog window.
45         </para>
46     </refsection>
47     <refsection>
48         <title>Examples</title>
49         <programlisting role="example"><![CDATA[
50 // with a transfer function 
51 s=poly(0,'s');
52 gs=syslin('c',1/(s+1));
53 trfmod(gs)
54
55 // with a state-space matrix
56 A=diag([1,2,3]);
57 B=[1;1;1];
58 C=[2,2,2];
59 sys=syslin('c',A,B,C);
60 trfmod(sys)
61  ]]></programlisting>
62     </refsection>
63     
64     <refsection role="see also">
65         <title>See Also</title>
66         <simplelist type="inline">
67             <member>
68                 <link linkend="poly">poly</link>
69             </member>
70             <member>
71                 <link linkend="simp">simp</link>
72             </member>
73         </simplelist>
74     </refsection>
75 </refentry>