[doc] misc. fix & improvements
[scilab.git] / scilab / modules / signal_processing / help / en_US / bilt.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="bilt">
3     <refnamediv>
4         <refname>bilt</refname>
5         <refpurpose>bilinear or biquadratic transform SISO system given by a zero/poles representation</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>[npl,nzr,ngn] = bilt(pl,zr,gn,num,den)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>pl</term>
16                 <listitem>
17                     <para>a vector, the poles of the given system.</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>zr</term>
22                 <listitem>
23                     <para>a vector, the zeros of the given system.</para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>num</term>
28                 <listitem>
29                     <para>a polynomial with degree equal to the degree of
30                         <literal>den</literal>, the numerator of the
31                         transform.
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>den</term>
37                 <listitem>
38                     <para>a polynomial with degree 1 or 2, the denominator of the transform.</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>npl</term>
43                 <listitem>
44                     <para>a vector, the poles of the transformed system.</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>nzr</term>
49                 <listitem>
50                     <para>a vector, the zeros of the transformed system.</para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>ngn</term>
55                 <listitem>
56                     <para>a scalar, the gain of the transformed system.</para>
57                 </listitem>
58             </varlistentry>
59         </variablelist>
60     </refsection>
61     <refsection>
62         <title>Description</title>
63         <para>function for calculating the gain poles and zeros which
64             result from a bilinear transform or from a biquadratic transform.
65             Used by the functions <link linkend="iir">iir</link> and <link linkend="trans">trans</link>.
66         </para>
67     </refsection>
68     <refsection>
69         <title>Examples</title>
70         <programlisting role="example"><![CDATA[
71 Hlp=iir(3,'lp','ellip',[0.1 0],[.08 .03]);
72 pl=roots(Hlp.den);
73 zr=roots(Hlp.num);
74 gn=coeff(Hlp.num,degree(Hlp.num))/coeff(Hlp.den,degree(Hlp.den));
75 z=poly(0,'z');
76 a=0.3;
77 num=z-a;
78 den=1-a*z;
79 [npl,nzr,ngn] = bilt(pl,zr,gn,num,den)
80
81 Hlpt=ngn*poly(nzr,'z','r')/poly(npl,'z','r')
82
83 //comparison with horner
84 horner(Hlp,num/den)
85  ]]></programlisting>
86     </refsection>
87     <refsection role="see also">
88         <title>See also</title>
89         <simplelist type="inline">
90             <member>
91                 <link linkend="iir">iir</link>
92             </member>
93             <member>
94                 <link linkend="trans">trans</link>
95             </member>
96             <member>
97                 <link linkend="horner">horner</link>
98             </member>
99         </simplelist>
100     </refsection>
101 </refentry>