summaryrefslogtreecommitdiff
path: root/help/en_US/ellip.xml
blob: 847f91e6c5fedcb90af5d709feaaaffbe6e19d98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from ellip.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="ellip" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>ellip</refname>
    <refpurpose>This function generates an elliptic or Cauer filter with rp dB of passband ripple and rs dB of stopband attenuation.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [a, b] = ellip (n, rp, rs, wp)
   [a, b] = ellip (n, rp, rs, wp, "high")
   [a, b] = ellip (n, rp, rs, [wl, wh])
   [a, b] = ellip (n, rp, rs, [wl, wh], "stop")
   [a, b, c] = ellip (…)
   [a, b, c, d] = ellip (…)
   […] = ellip (…, "s")
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>n:</term>
      <listitem><para> positive integer value</para></listitem></varlistentry>
   <varlistentry><term>rp:</term>
      <listitem><para> non negative scalar value</para></listitem></varlistentry>
   <varlistentry><term>rs:</term>
      <listitem><para> non negative scalar value</para></listitem></varlistentry>
   <varlistentry><term>w:</term>
      <listitem><para> scalar or vector, all elements should be in the range [0,1]</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function generates an elliptic or Cauer filter with rp dB of passband ripple and rs dB of stopband attenuation.
[b, a] = ellip(n, Rp, Rs, Wp) indicates low pass filter with order n, Rp decibels of ripple in the passband and a stopband Rs decibels down and cutoff of pi*Wp radians. If the fifth argument is high, then the filter is a high pass filter.
[b, a] = ellip(n, Rp, Rs, [Wl, Wh]) indictaes band pass filter with band pass edges pi*Wl and pi*Wh. If the fifth argument is stop, the filter is a band reject filter.
[z, p, g] = ellip(...) returns filter as zero-pole-gain.
[...] = ellip(...,’s’) returns a Laplace space filter, w can be larger than 1.
[a, b, c, d] = ellip(...) returns state-space matrices.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
[a,b]=ellip(2, 0.5, 0.7, [0.3,0.4])
a =
0.88532  -1.58410   2.40380  -1.58410   0.88532
b =
1.00000  -1.78065   2.68703  -1.75725   0.97454
   ]]></programlisting>
</refsection>
</refentry>