scilab/modules/cacsd/help/en_US/plot_display/m_circle.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 - Serge Steer
   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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="m_circle">
  14     <refnamediv>
  15         <refname>m_circle</refname>
  16         <refpurpose> plots the complex plane iso-gain contours of y/(1+y) (obsolete) </refpurpose>
  17     </refnamediv>
  18     <refsynopsisdiv>
  19         <title>Calling Sequence</title>
  20         <synopsis>m_circle()
  21             m_circle(gain)
  22         </synopsis>
  23     </refsynopsisdiv>
  24     <refsection>
  25         <title>Arguments</title>
  26         <variablelist>
  27             <varlistentry>
  28                 <term>gain</term>
  29                 <listitem>
  30                     <para>vector of gains (in DB). The default value is</para>
  31                     <variablelist>
  32                         <varlistentry>
  33                             <term>gain</term>
  34                             <listitem>
  35                                 <para>=[-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]</para>
  36                             </listitem>
  37                         </varlistentry>
  38                     </variablelist>
  39                 </listitem>
  40             </varlistentry>
  41         </variablelist>
  42     </refsection>
  43     <refsection>
  44         <title>Description</title>
  45         <para>
  46             <literal>m_circle</literal> draws the iso-gain contours
  47             given by then <literal>gain</literal> argument in the complex
  48             plane (Re,Im).
  49         </para>
  50         <para>
  51             The default value for <literal>gain</literal> is:
  52         </para>
  53         <para>
  54             <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>
  55         </para>
  56         <para>
  57             <literal>m_circle</literal> is used with <literal>nyquist</literal>.
  58         </para>
  59         <para>
  60             This function is superseded by the <link linkend="hallchart">hallchart</link> function.
  61         </para>
  62     </refsection>
  63     <refsection>
  64         <title>Examples</title>
  65         <programlisting role="example"><![CDATA[
  66
  67 s=poly(0,'s')
  68 h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
  69 nyquist(h,0.01,100,'(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01)')
  70 m_circle();
  71 ]]></programlisting>
  72         <scilab:image>
  73             s=poly(0,'s')
  74             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
  75             nyquist(h,0.01,100,'(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01)')
  76             m_circle();
  77         </scilab:image>
  78
  79         <programlisting role="example"><![CDATA[
  80 clf();
  81 s=poly(0,'s')
  82 h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
  83 h1=h*syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
  84 nyquist([h1;h],0.01,100,['h1';'h'])
  85 m_circle([-8 -6 -4]);
  86 ]]></programlisting>
  87         <scilab:image>
  88             clf();
  89             s=poly(0,'s')
  90             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
  91             h1=h*syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
  92             nyquist([h1;h],0.01,100,['h1';'h'])
  93             m_circle([-8 -6 -4]);
  94         </scilab:image>
  95     </refsection>
  96     <refsection role="see also">
  97         <title>See Also</title>
  98         <simplelist type="inline">
  99             <member>
 100                 <link linkend="nyquist">nyquist</link>
 101             </member>
 102             <member>
 103                 <link linkend="chart">chart</link>
 104             </member>
 105             <member>
 106                 <link linkend="black">black</link>
 107             </member>
 108         </simplelist>
 109     </refsection>
 110 </refentry>