summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/buttord.html
blob: 5a031551084a78edffcb9f5b503fa9f364957799 (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
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>buttord</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="butter.html">&lt;&lt; butter</a></span>

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

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="cceps.html">cceps &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_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a> &gt; buttord</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">buttord</h1>
    <p class="refpurpose">/This function computes the minimum filter order of a Butterworth filter with the desired response characteristics.</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre><span class="default">n</span><span class="default"> = </span><span class="functionid">buttord</span><span class="default">(</span><span class="default">Wp</span><span class="default">, </span><span class="default">Ws</span><span class="default">, </span><span class="default">Rp</span><span class="default">, </span><span class="default">Rs</span><span class="default">)</span>
<span class="default">[</span><span class="default">n</span><span class="default">, </span><span class="default">Wc</span><span class="default">] = </span><span class="functionid">buttord</span><span class="default">(</span><span class="default">Wp</span><span class="default">, </span><span class="default">Ws</span><span class="default">, </span><span class="default">Rp</span><span class="default">, </span><span class="default">Rs</span><span class="default">)</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">Wp:</span>
      <dd><p class="para">scalar or vector of length 2</p></dd></dt>
   <dt><span class="term">Ws:</span>
      <dd><p class="para">scalar or vector of length 2, elements must be in the range [0,1]</p></dd></dt>
   <dt><span class="term">Rp:</span>
      <dd><p class="para">real or complex value</p></dd></dt>
   <dt><span class="term">Rs:</span>
      <dd><p class="para">real or complex value</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">This is an Octave function.
This function computes the minimum filter order of a Butterworth filter with the desired response characteristics.
The filter frequency band edges are specified by the passband frequency wp and stopband frequency ws.
Frequencies are normalized to the Nyquist frequency in the range [0,1].
Rp is measured in decibels and is the allowable passband ripple, and Rs is also in decibels and is the minimum attenuation in the stop band.
If ws&gt;wp, the filter is a low pass filter. If wp&gt;ws, the filter is a high pass filter.
If wp and ws are vectors of length 2, then the passband interval is defined by wp the stopband interval is defined by ws.
If wp is contained within the lower and upper limits of ws, the filter is a band-pass filter. If ws is contained within the lower and upper limits of wp the filter is a band-stop or band-reject filter.</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="scilabid">Wp</span> <span class="scilaboperator">=</span> <span class="scilabnumber">40</span><span class="scilaboperator">/</span><span class="scilabnumber">500</span>
<span class="scilabid">Ws</span> <span class="scilaboperator">=</span> <span class="scilabnumber">150</span><span class="scilaboperator">/</span><span class="scilabnumber">500</span>
<span class="scilabopenclose">[</span><span class="scilabid">n</span><span class="scilabdefault">,</span> <span class="scilabid">Wn</span><span class="scilabopenclose">]</span> <span class="scilaboperator">=</span> <span class="scilabid">buttord</span><span class="scilabopenclose">(</span><span class="scilabid">Wp</span><span class="scilabdefault">,</span> <span class="scilabid">Ws</span><span class="scilabdefault">,</span> <span class="scilabnumber">3</span><span class="scilabdefault">,</span> <span class="scilabnumber">60</span><span class="scilabopenclose">)</span>
<span class="scilabid">n</span> <span class="scilaboperator">=</span>  <span class="scilabnumber">5</span>
<span class="scilabid">Wn</span> <span class="scilaboperator">=</span>  <span class="scilabnumber">0.080038</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="butter.html">&lt;&lt; butter</a></span>

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

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

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