← 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/nicholschart.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/nicholschart.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="nicholschart">
14
 
  <refnamediv>
15
 
    <refname>nicholschart</refname>
16
 
    <refpurpose> Nichols chart</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>nicholschart([ modules [,args [,colors]]])</synopsis>
21
 
    <synopsis/>
22
 
  </refsynopsisdiv>
23
 
  <refsection>
24
 
    <title>Arguments</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>modules</term>
28
 
        <listitem>
29
 
          <para>real vector ( modules (in dB))</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
      <varlistentry>
33
 
        <term>args</term>
34
 
        <listitem>
35
 
          <para>real vector (phases (in degree))</para>
36
 
        </listitem>
37
 
      </varlistentry>
38
 
      <varlistentry>
39
 
        <term>colorss</term>
40
 
        <listitem>
41
 
          <para>a scalar or a vector, the color indices for isogain and iso phase curves</para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
    </variablelist>
45
 
  </refsection>
46
 
  <refsection>
47
 
    <title>Description</title>
48
 
    <para> plot the Nichols'chart: iso-module and iso-argument  contours of
49
 
      <literal>y/(1+y)</literal> in <literal>y</literal> phase/gain plane
50
 
    </para>
51
 
    <para>
52
 
      <literal>nicholschart</literal> may be used in cunjunction with
53
 
      <link linkend="black">black</link>. 
54
 
    </para>
55
 
    <para>
56
 
      The default values for <literal>modules</literal> and
57
 
      <literal>args</literal> are respectively :
58
 
    </para>
59
 
    <para>
60
 
      <literal>[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]</literal>
61
 
    </para>
62
 
    <para>
63
 
      <literal>[-(1:10) , -(20:10:160)]</literal>
64
 
    </para>
65
 
  </refsection>
66
 
  <refsection>
67
 
    <title>Examples</title>
68
 
    <programlisting role="example"><![CDATA[
69
 
    //Nichols chart
70
 
    clf()
71
 
    nicholschart(modules=[-6 -3 -1 1 3 6], args=[-1 -20 20 40 80 160 180]);
72
 
    ]]></programlisting>
73
 
    <para>
74
 
      <inlinemediaobject>
75
 
        <imageobject>
76
 
          <imagedata fileref="../images/nicholschart.svg"/>
77
 
        </imageobject>
78
 
      </inlinemediaobject>
79
 
    </para>
80
 
    <programlisting role="example"><![CDATA[
81
 
    //Black diagram with Nichols chart as a grid
82
 
    s=poly(0,'s');
83
 
    Plant=syslin('c',16000/((s+1)*(s+10)*(s+100)));
84
 
    //two degree of freedom PID
85
 
    tau=0.2;xsi=1.2;
86
 
    PID=syslin('c',(1/(2*xsi*tau*s))*(1+2*xsi*tau*s+tau^2*s^2));
87
 
    clf();
88
 
    black([Plant;Plant*PID ],0.01,100,["Plant";"Plant and PID corrector"]);
89
 
    //move the caption in the lower rigth corner
90
 
    ax=gca();Leg=ax.children(1);
91
 
    Leg.legend_location="in_lower_right";
92
 
    nicholschart(colors=color('light gray')*[1 1])
93
 
    ]]></programlisting>
94
 
    <para>
95
 
      <inlinemediaobject>
96
 
        <imageobject>
97
 
          <imagedata fileref="../images/black2.svg"/>
98
 
        </imageobject>
99
 
      </inlinemediaobject>
100
 
    </para>
101
 
  </refsection>
102
 
  <refsection role="see also">
103
 
    <title>See Also</title>
104
 
    <simplelist type="inline">
105
 
      <member>
106
 
        <link linkend="black">black</link>
107
 
      </member>
108
 
      <member>
109
 
        <link linkend="nyquist">nyquist</link>
110
 
      </member>
111
 
      <member>
112
 
        <link linkend="hallchart">hallchart</link>
113
 
      </member>
114
 
    </simplelist>
115
 
  </refsection>
116
 
</refentry>