← 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/find_freq.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/find_freq.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="find_freq">
3
 
  <refnamediv>
4
 
    <refname>find_freq</refname>
5
 
    <refpurpose> parameter compatibility for elliptic filter design</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[m]=find_freq(epsilon,A,n)</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Arguments</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>epsilon</term>
16
 
        <listitem>
17
 
          <para>passband ripple</para>
18
 
        </listitem>
19
 
      </varlistentry>
20
 
      <varlistentry>
21
 
        <term>A</term>
22
 
        <listitem>
23
 
          <para>stopband attenuation</para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
      <varlistentry>
27
 
        <term>n</term>
28
 
        <listitem>
29
 
          <para>filter order</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
      <varlistentry>
33
 
        <term>m</term>
34
 
        <listitem>
35
 
          <para>frequency needed for construction of elliptic filter</para>
36
 
        </listitem>
37
 
      </varlistentry>
38
 
    </variablelist>
39
 
  </refsection>
40
 
  <refsection>
41
 
    <title>Description</title>
42
 
    <para>
43
 
      Search for m such that <literal>n=K(1-m1)K(m)/(K(m1)K(1-m))</literal>
44
 
      with
45
 
    </para>
46
 
    <para>
47
 
      <literal>m1=(epsilon*epsilon)/(A*A-1)</literal>;
48
 
    </para>
49
 
    <para>
50
 
      If <literal>m = omegar^2/omegac^2</literal>, the parameters
51
 
      <literal>epsilon,A,omegac,omegar</literal> and <literal>n</literal> are then
52
 
      compatible for defining a prototype elliptic filter.
53
 
      Here, <literal>K=%k(m)</literal> is the complete elliptic integral with parameter <literal>m</literal>.
54
 
    </para>
55
 
  </refsection>
56
 
  <refsection role="see also">
57
 
    <title>See Also</title>
58
 
    <simplelist type="inline">
59
 
      <member>
60
 
        <link linkend="percentk">%k</link>
61
 
      </member>
62
 
    </simplelist>
63
 
  </refsection>
64
 
</refentry>