summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/zp2sos.html
blob: 4adde73bc32619f8ba2ffb5647ab1a54e95f6e99 (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
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>zp2sos</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="zerocrossing.html">&lt;&lt; zerocrossing</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="zp2ss.html">zp2ss &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; zp2sos</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">zp2sos</h1>
    <p class="refpurpose">This function converts filter poles and zeros to second-order sections.</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre><span class="default">[</span><span class="default">sos</span><span class="default">] = </span><span class="functionid">zp2sos</span><span class="default">(</span><span class="default">z</span><span class="default">)</span>
<span class="default">[</span><span class="default">sos</span><span class="default">] = </span><span class="functionid">zp2sos</span><span class="default">(</span><span class="default">z</span><span class="default">, </span><span class="default">p</span><span class="default">)</span>
<span class="default">[</span><span class="default">sos</span><span class="default">] = </span><span class="functionid">zp2sos</span><span class="default">(</span><span class="default">z</span><span class="default">, </span><span class="default">p</span><span class="default">, </span><span class="default">k</span><span class="default">)</span>
<span class="default">[</span><span class="default">sos</span><span class="default">, </span><span class="default">g</span><span class="default">] = </span><span class="functionid">zp2sos</span><span class="default">(...)</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">z:</span>
      <dd><p class="para">column vector</p></dd></dt>
   <dt><span class="term">p:</span>
      <dd><p class="para">column vector</p></dd></dt>
   <dt><span class="term">k:</span>
      <dd><p class="para">real or complex value, default value is 1</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">This is an Octave function.
This function converts filter poles and zeros to second-order sections.
The first and second parameters are column vectors containing zeros and poles. The third parameter is the overall filter gain, the default value of which is 1.
The output is the sos matrix and the overall gain.
If there is only one output argument, the overall filter gain is applied to the first second-order section in the sos matrix.</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">zp2sos</span><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span> <span class="scilabnumber">2</span><span class="scilabdefault">,</span> <span class="scilabnumber">3</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span> <span class="scilabnumber">2</span><span class="scilabdefault">,</span> <span class="scilabnumber">6</span><span class="scilabopenclose">)</span>
<span class="scilabid">ans</span> <span class="scilaboperator">=</span>
<span class="scilabnumber">6</span>  <span class="scilaboperator">-</span><span class="scilabnumber">18</span>   <span class="scilabnumber">12</span>    <span class="scilabnumber">1</span>   <span class="scilaboperator">-</span><span class="scilabnumber">2</span>    <span class="scilabnumber">0</span>
<span class="scilabnumber">1</span>   <span class="scilaboperator">-</span><span class="scilabnumber">3</span>    <span class="scilabnumber">0</span>    <span class="scilabnumber">1</span>    <span class="scilabnumber">0</span>    <span class="scilabnumber">0</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="zerocrossing.html">&lt;&lt; zerocrossing</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="zp2ss.html">zp2ss &gt;&gt;</a></span>

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