* Bug #11670 to 11676 fixed - Add examples in the signal processing help pages.
[scilab.git] / scilab / modules / signal_processing / help / en_US / zpch2.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" version="5.0-subset Scilab" xml:lang="en" xml:id="zpch2">
3     <refnamediv>
4         <refname>zpch2</refname>
5         <refpurpose> Chebyshev analog filter</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[zeros,poles,gain]=zpch2(n,A,omegar)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>n</term>
16                 <listitem>
17                     <para>integer : filter order</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>A</term>
22                 <listitem>
23                     <para>
24                         real : attenuation in stop band (<literal>A&gt;1</literal>)
25                     </para>
26                 </listitem>
27             </varlistentry>
28             <varlistentry>
29                 <term>omegar</term>
30                 <listitem>
31                     <para>real : cut-off frequency in Hertz</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>zeros</term>
36                 <listitem>
37                     <para>resulting filter zeros</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>poles</term>
42                 <listitem>
43                     <para>resulting filter poles</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>gain</term>
48                 <listitem>
49                     <para>Resulting filter gain</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Description</title>
56         <para>
57             Poles and zeros of a type 2 Chebyshev analog filter
58             gain is the gain of the filter
59         </para>
60         <programlisting role="no-scilab-exec"><![CDATA[ 
61 H(s)=gain*poly(zeros,'s')/poly(poles,'s')
62  ]]></programlisting>
63     </refsection>
64     <refsection>
65         <title>Examples</title>
66         <programlisting role="example"><![CDATA[ 
67 n=10;
68 A=1/0.2;
69 omegar=6;
70 [z,p,gain]=zpch2(n,A,omegar)
71  ]]></programlisting>
72     </refsection>
73     
74 </refentry>