* Bug #11670 to 11676 fixed - Add examples in the signal processing help pages.
[scilab.git] / scilab / modules / signal_processing / help / en_US / zpch1.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="zpch1">
3     <refnamediv>
4         <refname>zpch1</refname>
5         <refpurpose> Chebyshev analog filter</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[poles,gain]=zpch1(n,epsilon,omegac)</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>epsilon</term>
22                 <listitem>
23                     <para>
24                         real : ripple in the pass band (<literal>0&lt;epsilon&lt;1</literal>)
25                     </para>
26                 </listitem>
27             </varlistentry>
28             <varlistentry>
29                 <term>omegac</term>
30                 <listitem>
31                     <para>real : cut-off frequency in Hertz</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>poles</term>
36                 <listitem>
37                     <para>resulting filter poles</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>gain</term>
42                 <listitem>
43                     <para>resulting filter gain</para>
44                 </listitem>
45             </varlistentry>
46         </variablelist>
47     </refsection>
48     <refsection>
49         <title>Description</title>
50         <para>
51             Poles of a Type 1 Chebyshev analog filter. The transfer function is given by :
52         </para>
53         <programlisting role="no-scilab-exec"><![CDATA[ 
54 H(s)=gain/poly(poles,'s')
55  ]]></programlisting>
56     </refsection>
57     <refsection>
58         <title>Examples</title>
59         <programlisting role="example"><![CDATA[ 
60 n = 13;
61 epsilon = 0.2;
62 omegac = 3;
63 [p,gain] = zpch1(n,epsilon,omegac)
64  ]]></programlisting>
65     </refsection>
66     
67 </refentry>