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