summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/butter.html
blob: 6a1a3e294c75f8b9cd48f1de99dc037a5c220853 (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>butter</title>
    <style type="text/css" media="all">
      @import url("scilab_code.css");
      @import url("xml_code.css");
      @import url("c_code.css");
      @import url("style.css");
    </style>
  </head>
  <body>
    <div class="manualnavbar">
    <table width="100%"><tr>
      <td width="30%">
    	<span class="previous"><a href="buttap.html">&lt;&lt; buttap</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="buttord.html">buttord &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a> &gt; butter</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">butter</h1>
    <p class="refpurpose">This function generates a Butterworth filter.</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre><span class="default">[</span><span class="default">a</span><span class="default">, </span><span class="default">b</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (</span><span class="default">n</span><span class="default">, </span><span class="default">w</span><span class="default">)</span>
<span class="default">[</span><span class="default">a</span><span class="default">, </span><span class="default">b</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (</span><span class="default">n</span><span class="default">, </span><span class="default">w</span><span class="default">, </span>&#0034;<span class="default">high</span>&#0034;<span class="default">)</span>
<span class="default">[</span><span class="default">a</span><span class="default">, </span><span class="default">b</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (</span><span class="default">n</span><span class="default">, [</span><span class="default">wl</span><span class="default">, </span><span class="default">wh</span><span class="default">])</span>
<span class="default">[</span><span class="default">b</span><span class="default">, </span><span class="default">a</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (</span><span class="default">n</span><span class="default">, [</span><span class="default">wl</span><span class="default">, </span><span class="default">wh</span><span class="default">], </span>&#0034;<span class="default">stop</span>&#0034;<span class="default">)</span>
<span class="default">[</span><span class="default">a</span><span class="default">, </span><span class="default">b</span><span class="default">, </span><span class="default">c</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (…)</span>
<span class="default">[</span><span class="default">a</span><span class="default">, </span><span class="default">b</span><span class="default">, </span><span class="default">c</span><span class="default">, </span><span class="default">d</span><span class="default">] = </span><span class="functionid">butter</span><span class="default"> (…)</span>
<span class="default">[…] = </span><span class="functionid">butter</span><span class="default"> (…, </span>&#0034;<span class="default">s</span>&#0034;<span class="default">)</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">n:</span>
      <dd><p class="para">positive integer value</p></dd></dt>
   <dt><span class="term">w:</span>
      <dd><p class="para">positive real value, w in the range [0,1]</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="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.</p></div>

<div class="refsection"><h3 class="title">Examples</h3>
   <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabopenclose">[</span><span class="scilabid">a</span><span class="scilabdefault">,</span><span class="scilabid">b</span><span class="scilabopenclose">]</span><span class="scilaboperator">=</span><span class="scilabid">butter</span><span class="scilabopenclose">(</span><span class="scilabnumber">3</span><span class="scilabdefault">,</span> <span class="scilabnumber">0.7</span><span class="scilabopenclose">)</span>
<span class="scilabid">a</span> <span class="scilaboperator">=</span>
<span class="scilabnumber">0.37445</span>   <span class="scilabnumber">1.12336</span>   <span class="scilabnumber">1.12336</span>   <span class="scilabnumber">0.37445</span>
<span class="scilabid">b</span> <span class="scilaboperator">=</span>
<span class="scilabnumber">1.00000</span>   <span class="scilabnumber">1.16192</span>   <span class="scilabnumber">0.69594</span>   <span class="scilabnumber">0.13776</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
    <br />

    <div class="manualnavbar">
    <table width="100%">
    <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
      <td width="30%">
    	<span class="previous"><a href="buttap.html">&lt;&lt; buttap</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="buttord.html">buttord &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>