← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/signal_processing/help/en_US/cheb1mag.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/signal_processing/help/en_US/cheb1mag.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="cheb1mag">
3
 
  <refnamediv>
4
 
    <refname>cheb1mag</refname>
5
 
    <refpurpose>  response of Chebyshev type 1 filter</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[h2]=cheb1mag(n,omegac,epsilon,sample)</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>omegac</term>
22
 
        <listitem>
23
 
          <para>real : cut-off frequency</para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
      <varlistentry>
27
 
        <term>epsilon</term>
28
 
        <listitem>
29
 
          <para>real : ripple in pass band</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
      <varlistentry>
33
 
        <term>sample</term>
34
 
        <listitem>
35
 
          <para>
36
 
            vector of frequencies where <literal>cheb1mag</literal> is evaluated
37
 
          </para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
      <varlistentry>
41
 
        <term>h2</term>
42
 
        <listitem>
43
 
          <para>Chebyshev I filter values at sample points</para>
44
 
        </listitem>
45
 
      </varlistentry>
46
 
    </variablelist>
47
 
  </refsection>
48
 
  <refsection>
49
 
    <title>Description</title>
50
 
    <para>
51
 
      Square magnitude response of a type 1 Chebyshev filter.
52
 
    </para>
53
 
    <para>
54
 
      <literal>omegac</literal>=passband edge.
55
 
    </para>
56
 
    <para>
57
 
      <literal>epsilon</literal>such that <literal>1/(1+epsilon^2)</literal>=passband ripple.
58
 
    </para>
59
 
    <para>
60
 
      <literal>sample</literal>vector of frequencies where the square magnitude
61
 
      is desired.
62
 
    </para>
63
 
  </refsection>
64
 
  <refsection>
65
 
    <title>Examples</title>
66
 
    <programlisting role="example"><![CDATA[ 
67
 
//Chebyshev; ripple in the passband
68
 
n=13;epsilon=0.2;omegac=3;sample=0:0.05:10;
69
 
h=cheb1mag(n,omegac,epsilon,sample);
70
 
plot2d(sample,h)
71
 
xtitle('','frequencies','magnitude')
72
 
 ]]></programlisting>
73
 
  </refsection>
74
 
  <refsection role="see also">
75
 
    <title>See Also</title>
76
 
    <simplelist type="inline">
77
 
      <member>
78
 
        <link linkend="buttmag">buttmag</link>
79
 
      </member>
80
 
    </simplelist>
81
 
  </refsection>
82
 
</refentry>