← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/cacsd/help/en_US/plot_display/bode.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/cacsd/help/en_US/plot_display/bode.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!--
 
3
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 
4
 * Copyright (C) INRIA
 
5
 * 
 
6
 * This file must be used under the terms of the CeCILL.
 
7
 * This source file is licensed as described in the file COPYING, which
 
8
 * you should have received as part of this distribution.  The terms
 
9
 * are also available at    
 
10
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
11
 *
 
12
 -->
 
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" version="5.0-subset Scilab" xml:id="bode" xml:lang="en">
 
14
    <refnamediv>
 
15
        <refname>bode</refname>
 
16
        <refpurpose>Bode plot</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>bode(sl,[fmin,fmax] [,step] [,comments] )
 
21
            bode(sl,frq [,comments] )
 
22
            bode(frq,db,phi [,comments])
 
23
            bode(frq, repf [,comments])
 
24
        </synopsis>
 
25
    </refsynopsisdiv>
 
26
    <refsection>
 
27
        <title>Arguments</title>
 
28
        <variablelist>
 
29
            <varlistentry>
 
30
                <term>sl</term>
 
31
                <listitem>
 
32
                    <para>
 
33
                        <literal>syslin</literal> list (SISO or SIMO linear system)
 
34
                        in continuous or discrete time.
 
35
                    </para>
 
36
                </listitem>
 
37
            </varlistentry>
 
38
            <varlistentry>
 
39
                <term>fmin,fmax</term>
 
40
                <listitem>
 
41
                    <para>real (frequency bounds (in Hz))</para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
            <varlistentry>
 
45
                <term>step</term>
 
46
                <listitem>
 
47
                    <para>real (logarithmic step.)</para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
            <varlistentry>
 
51
                <term>comments</term>
 
52
                <listitem>
 
53
                    <para>vector of character strings (captions).</para>
 
54
                </listitem>
 
55
            </varlistentry>
 
56
            <varlistentry>
 
57
                <term>frq</term>
 
58
                <listitem>
 
59
                    <para>row vector or matrix (frequencies (in Hz) ) (one row for each
 
60
                        SISO subsystem).
 
61
                    </para>
 
62
                </listitem>
 
63
            </varlistentry>
 
64
            <varlistentry>
 
65
                <term>db</term>
 
66
                <listitem>
 
67
                    <para>row vector or matrix ( magnitudes (in Db)). (one row for each
 
68
                        SISO subsystem).
 
69
                    </para>
 
70
                </listitem>
 
71
            </varlistentry>
 
72
            <varlistentry>
 
73
                <term>phi</term>
 
74
                <listitem>
 
75
                    <para>row vector or matrix ( phases (in degree)) (one row for each
 
76
                        SISO subsystem).
 
77
                    </para>
 
78
                </listitem>
 
79
            </varlistentry>
 
80
            <varlistentry>
 
81
                <term>repf</term>
 
82
                <listitem>
 
83
                    <para>row vector or matrix of complex numbers (complex frequency
 
84
                        response).
 
85
                    </para>
 
86
                </listitem>
 
87
            </varlistentry>
 
88
        </variablelist>
 
89
    </refsection>
 
90
    <refsection>
 
91
        <title>Description</title>
 
92
        <para>Bode plot, i.e magnitude and phase of the frequency response of
 
93
            <literal>sl</literal>.
 
94
        </para>
 
95
        <para>
 
96
            <literal>sl</literal> can be a continuous-time or discrete-time SIMO
 
97
            system (see <literal>syslin</literal>). In case of multi-output the
 
98
            outputs are plotted with different symbols.
 
99
        </para>
 
100
        <para>
 
101
            The frequencies are given by the bounds <literal>fmin,fmax</literal>
 
102
            (in Hz) or by a row-vector (or a matrix for multi-output)
 
103
            <literal>frq</literal>.
 
104
        </para>
 
105
        <para>
 
106
            <literal>step</literal> is the ( logarithmic ) discretization step.
 
107
            (see <literal>calfrq</literal> for the choice of default value).
 
108
        </para>
 
109
        <para>
 
110
            <literal>comments</literal> is a vector of character strings
 
111
            (captions).
 
112
        </para>
 
113
        <para>
 
114
            <literal>db,phi</literal> are the matrices of modulus (in Db) and
 
115
            phases (in degrees). (One row for each response).
 
116
        </para>
 
117
        <para>
 
118
            <literal>repf</literal> matrix of complex numbers. One row for each
 
119
            response.
 
120
        </para>
 
121
        <para>
 
122
            Default values for <literal>fmin</literal> and
 
123
            <literal>fmax</literal> are <literal>1.d-3</literal>,
 
124
            <literal>1.d+3</literal> if <literal>sl</literal> is continuous-time or
 
125
            <literal>1.d-3</literal>, <literal>0.5</literal>/sl.dt (nyquist frequency)
 
126
            if <literal>sl</literal> is discrete-time. Automatic discretization of
 
127
            frequencies is made by <literal>calfrq</literal>.
 
128
        </para>
 
129
        <para>
 
130
            The 
 
131
            <member>
 
132
                <link linkend="datatips">datatips</link>
 
133
            </member>
 
134
            tool may be used
 
135
            to display data along the phase and modulus curves.
 
136
        </para>
 
137
    </refsection>
 
138
    <refsection>
 
139
        <title>Examples</title>
 
140
        <programlisting role="example"><![CDATA[ 
 
141
s=poly(0,'s')
 
142
h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
 
143
clf();bode(h,0.01,100);
 
144
 ]]></programlisting>
 
145
        <para>
 
146
          <scilab:image>
 
147
s=poly(0,'s')
 
148
h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
 
149
clf();bode(h,0.01,100);
 
150
          </scilab:image>
 
151
        </para>
 
152
        <programlisting role="example"><![CDATA[ 
 
153
s=poly(0,'s')
 
154
h1=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
 
155
num=22801+4406.18*s+382.37*s^2+21.02*s^3+s^4;
 
156
den=22952.25+4117.77*s+490.63*s^2+33.06*s^3+s^4
 
157
h2=syslin('c',num/den);
 
158
 
 
159
clf();bode([h1;h2],0.01,100,['h1';'h2'])
 
160
 ]]></programlisting>
 
161
        <para>
 
162
          <scilab:image>
 
163
s=poly(0,'s')
 
164
h1=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
 
165
num=22801+4406.18*s+382.37*s^2+21.02*s^3+s^4;
 
166
den=22952.25+4117.77*s+490.63*s^2+33.06*s^3+s^4
 
167
h2=syslin('c',num/den);
 
168
 
 
169
clf();bode([h1;h2],0.01,100,['h1';'h2'])
 
170
          </scilab:image>
 
171
        </para>
 
172
    </refsection>
 
173
    <refsection role="see also">
 
174
        <title>See Also</title>
 
175
        <simplelist type="inline">
 
176
            <member>
 
177
                <link linkend="black">black</link>
 
178
            </member>
 
179
            <member>
 
180
                <link linkend="nyquist">nyquist</link>
 
181
            </member>
 
182
            <member>
 
183
                <link linkend="gainplot">gainplot</link>
 
184
            </member>
 
185
            <member>
 
186
                <link linkend="repfreq">repfreq</link>
 
187
            </member>
 
188
            <member>
 
189
                <link linkend="g_margin">g_margin</link>
 
190
            </member>
 
191
            <member>
 
192
                <link linkend="p_margin">p_margin</link>
 
193
            </member>
 
194
            <member>
 
195
                <link linkend="calfrq">calfrq</link>
 
196
            </member>
 
197
            <member>
 
198
                <link linkend="phasemag">phasemag</link>
 
199
            </member>
 
200
            <member>
 
201
                <link linkend="datatips">datatips</link>
 
202
            </member>
 
203
        </simplelist>
 
204
    </refsection>
 
205
</refentry>