summaryrefslogtreecommitdiff
path: root/help/en_US/butter.xml
blob: bacacaf30d38fedae7f047e3b494bded4d3ea444 (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="butter" 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>butter</refname>
    <refpurpose>This function generates a Butterworth filter.</refpurpose>
  </refnamediv>


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

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>n:</term>
      <listitem><para> positive integer value</para></listitem></varlistentry>
   <varlistentry><term>w:</term>
      <listitem><para> positive real value, w in the range [0,1]</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function generates a Butterworth filter. Default is a discrete space (Z) filter.
The third parameter takes in low or high, default value is low. The cutoff is pi*Wc radians.
[b,a] = butter(n, [Wl, Wh]) indicates a band pass filter with edges pi*Wl and pi*Wh radians.
[b,a] = butter(n, [Wl, Wh], ’stop’) indicates a band reject filter with edges pi*Wl and pi*Wh radians.
[z,p,g] = butter(...) returns filter as zero-pole-gain rather than coefficients of the numerator and denominator polynomials.
[...] = butter(...,’s’) returns a Laplace space filter, w can be larger than 1.
[a,b,c,d] = butter(...) returns state-space matrices.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
[a,b]=butter(3, 0.7)
a =
0.37445   1.12336   1.12336   0.37445
b =
1.00000   1.16192   0.69594   0.13776
   ]]></programlisting>
</refsection>
</refentry>