summaryrefslogtreecommitdiff
path: root/help/en_US/sos2tf.xml
blob: 4d4e48e5bc6c5e892cf769fbde32d02f33b34cc2 (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 sos2tf.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="sos2tf" 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>sos2tf</refname>
    <refpurpose>This function converts series second-order sections to direct H(z) = B(z)/A(z) form.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [B] = sos2tf(sos)
   [B] = sos2tf(sos, g)
   [B,A] = sos2tf(...)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>sos:</term>
      <listitem><para> matrix of real or complex numbers</para></listitem></varlistentry>
   <varlistentry><term>g:</term>
      <listitem><para> real or complex value, default value is 1</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function converts series second-order sections to direct H(z) = B(z)/A(z) form.
The input is the sos matrix and the second parameter is the overall gain, default value of which is 1.
The output is a vector.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
[a,b]=sos2tf([1,2,3,4,5,6])
a =
1   2   3
b =
4   5   6
   ]]></programlisting>
</refsection>
</refentry>