← 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/zgrid.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/zgrid.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: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="zgrid">
14
 
  <refnamediv>
15
 
    <refname>zgrid</refname>
16
 
    <refpurpose> zgrid plot</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>
21
 
      zgrid()
22
 
      zgrid(zeta,wn [,colors])
23
 
      zgrid(['new',] zeta,wn [,colors])
24
 
      zgrid(zeta,wn [,'new'] [,colors])
25
 
    </synopsis>
26
 
  </refsynopsisdiv>
27
 
  <refsection>
28
 
    <title>Arguments</title>
29
 
    <variablelist>
30
 
      <varlistentry>
31
 
        <term>zeta</term>
32
 
        <listitem>
33
 
          <para>
34
 
            array of damping factors. Only values in <literal>[0
35
 
              1]
36
 
            </literal>
37
 
            are taken into account. The default value is
38
 
            <literal>0:0.1:1</literal>.
39
 
          </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
      <varlistentry>
43
 
        <term>wn</term>
44
 
        <listitem>
45
 
          <para>array of normalized natural frequencies (factors of
46
 
            π/dt).  Only values in <literal>[0 1]</literal> are taken
47
 
            into account. The default value is
48
 
            <literal>0:0.1:1</literal>.
49
 
          </para>
50
 
        </listitem>
51
 
      </varlistentry>
52
 
      <varlistentry>
53
 
        <term>colors</term>
54
 
        <listitem>
55
 
          <para>a scalar or an 2 element array  with integer values (color index).</para>
56
 
        </listitem>
57
 
      </varlistentry>
58
 
    </variablelist>
59
 
  </refsection>
60
 
  <refsection>
61
 
    <title>Description</title>
62
 
    <para>
63
 
      plots z-plane grid lines: lines of constant damping factor
64
 
      (selection given by <literal>zeta</literal>) and natural frequency
65
 
      (selection given by <literal>wn</literal>) are drawn in within the
66
 
      unit Z-plane circle.
67
 
    </para>
68
 
    <para>
69
 
      Iso-frequency curves are shown in on the interval
70
 
      [0,%pi/dt].
71
 
    </para>
72
 
    <para>
73
 
      The <literal>colors</literal> argument may be used to assign a
74
 
      color for constant damping ratio curves
75
 
      (<literal>colors(2)</literal>) and for frequency curves
76
 
      (<literal>colors(1)</literal>).
77
 
    </para>
78
 
    <para>
79
 
      The <literal>zgrid</literal> function is often used to draw a grid
80
 
      for evens root locus of continuous time linear systems. In such a
81
 
      case the <literal>zgrid</literal> function should be called after
82
 
      the call to <link linkend="evans">evans</link>. For continuous time linear
83
 
      systems one should use <link linkend="sgrid">sgrid</link> function instead.
84
 
    </para>
85
 
    <para>
86
 
      The optional argument <literal>'new'</literal> can be used to
87
 
      erase the graphic window before plotting the grid.
88
 
    </para>
89
 
  </refsection>
90
 
  <refsection>
91
 
    <title>Examples</title>
92
 
    <programlisting role="example"><![CDATA[
93
 
    //zgrid
94
 
    clf();zgrid(0:0.2:1,[0.2 0.6 0.8 1])
95
 
    ]]></programlisting>
96
 
    <para>
97
 
      <inlinemediaobject>
98
 
        <imageobject>
99
 
          <imagedata fileref="../images/zgrid.svg"/>
100
 
        </imageobject>
101
 
      </inlinemediaobject>
102
 
    </para>
103
 
    <programlisting role="example"><![CDATA[
104
 
    //zgrid with discrete time system  root locus
105
 
    z=poly(0,'z')
106
 
    H=syslin(0.01,(0.54-1.8*z+2.9*z^2-2.6*z^3+z^4)/(0.8+0.78*z-0.1*z^2+0.9*z^3+z^4))
107
 
    clf();evans(H,1000);zgrid(0:0.1:0.5)
108
 
 
109
 
    ]]></programlisting>
110
 
    <para>
111
 
      <inlinemediaobject>
112
 
        <imageobject>
113
 
          <imagedata fileref="../images/evans3.svg"/>
114
 
        </imageobject>
115
 
      </inlinemediaobject>
116
 
    </para>
117
 
  </refsection>
118
 
  <refsection role="see also">
119
 
    <title>See Also</title>
120
 
    <simplelist type="inline">
121
 
      <member>
122
 
        <link linkend="evans">evans</link>
123
 
      </member>
124
 
      <member>
125
 
        <link linkend="sgrid">sgrid</link>
126
 
      </member>
127
 
      <member>
128
 
        <link linkend="freson">freson</link>
129
 
      </member>
130
 
      <member>
131
 
        <link linkend="datatips">datatips</link>
132
 
      </member>
133
 
    </simplelist>
134
 
  </refsection>
135
 
</refentry>