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

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

<refentry version="5.0-subset Scilab" xml:id="tf2sos" 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>tf2sos</refname>
    <refpurpose>This function converts direct-form filter coefficients to series second-order sections.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [sos] = tf2sos (b, a)
   [sos, g] = tf2sos (b, a)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>b:</term>
      <listitem><para> matrix of real numbers</para></listitem></varlistentry>
   <varlistentry><term>a:</term>
      <listitem><para> matrix of real numbers</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function converts direct-form filter coefficients to series second-order sections.
The input parameters b and a are vectors specifying the digital filter H(z) = B(z)/A(z).
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.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
tf2sos([1,2,3,4,5,6],2)
ans =
0.50000   0.80579   1.07239   1.00000   0.00000   0.00000
1.00000  -1.10337   1.87524   1.00000   0.00000   0.00000
1.00000   1.49180  -0.00000   1.00000   0.00000   0.00000
   ]]></programlisting>
</refsection>
</refentry>