summaryrefslogtreecommitdiffstats
path: root/scilab/modules/cacsd/help/en_US/gainplot.xml
blob: 29e7346879ceee6aae447f5eeef4e1653bc3ecf7 (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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution.  The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="gainplot">
  <info>
    <pubdate>$LastChangedDate: 2008-03-26 09:50:39 +0100 (Wed, 26 Mar 2008) $</pubdate>
  </info>
  <refnamediv>
    <refname>gainplot</refname>
    <refpurpose>magnitude plot</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>gainplot(sl,fmin,fmax [,step] [,comments] )
    gainplot(frq,db,phi [,comments])
    gainplot(frq, repf [,comments])</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>sl</term>
        <listitem>
          <para>list (<literal>syslin</literal> SIMO linear system).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>fmin,fmax</term>
        <listitem>
          <para>real scalars (frequency interval).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>step</term>
        <listitem>
          <para>real (discretization step (logarithmic scale))</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>comments</term>
        <listitem>
          <para>string</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>frq</term>
        <listitem>
          <para>matrix (row by row frequencies)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>db,phi</term>
        <listitem>
          <para>matrices (magnitudes and phases corresponding to
          <literal>frq</literal>)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>repf</term>
        <listitem>
          <para>complex matrix. One row for each frequency response.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>Same as <link linkend="bode">bode</link> but plots only the magnitude.</para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
    s=poly(0,'s')
    h1=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
    h2=syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
    clf();gainplot([h1;h2],0.01,100,['h1';'h2'])
    title('Gainplot')

    ]]></programlisting>
    <para>
      <inlinemediaobject>
        <imageobject>
          <imagedata fileref="../images/gainplot.svg"/>
        </imageobject>
      </inlinemediaobject>
    </para>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="bode">bode</link>
      </member>
      <member>
        <link linkend="black">black</link>
      </member>
      <member>
        <link linkend="nyquist">nyquist</link>
      </member>
      <member>
        <link linkend="repfreq">repfreq</link>
      </member>
      <member>
        <link linkend="g_margin">g_margin</link>
      </member>
      <member>
        <link linkend="datatips">datatips</link>
      </member>
    </simplelist>
  </refsection>
</refentry>