* Bug 15392 fixed: comet() comet3d() with named|#RRGGBB|[r g b] colors
[scilab.git] / scilab / modules / graphics / help / ru_RU / 2d_plot / comet.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) Serge Steer
5  * Copyright (C) 2018 - Samuel GOUGEON
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *-->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="ru" xml:id="comet">
20     <refnamediv>
21         <refname>comet</refname>
22         <refpurpose>двумерный график с анимированной кометой</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Синтаксис</title>
26         <synopsis>
27            comet(y)
28            comet(x, y)
29            comet(x, y, Lf)
30            comet(x, fun)
31            comet(x, fun, Lf)
32            comet(...,"colors",c)
33         </synopsis>
34     </refsynopsisdiv>
35     <refsection>
36         <title>Аргументы</title>
37         <variablelist>
38             <varlistentry>
39                 <term>x</term>
40                 <listitem>
41                     вещественный вектор или матрица. Если не указать, то предполагается,
42                     что это вектор <literal>1:np</literal>, где <literal>np</literal> -
43                     это количество точек кривой (см. ниже). В качестве матрицы каждый столбец
44                     определяет абсциссы следа отдельной кометы.
45                     <para/>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>y</term>
50                 <listitem>
51                     вещественный вектор или матрица. В качестве матрицы каждый столбец
52                     определяет ординаты следа отдельной кометы.
53                     <para/>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>Lf</term>
58                 <listitem>
59                     вещественный скаляр на интервале <literal>[0 1[</literal>. Значение по
60                     умолчанию <literal>0.1</literal>. Он определяет ведущую часть следа кометы.
61                     Самые последние точки <literal>k=Lf*np</literal> отображаются в более
62                     толстой строке.
63                     <para/>
64                 </listitem>
65             </varlistentry>
66             <varlistentry>
67                 <term>fun</term>
68                 <listitem>
69                     Scilab-функция с последовательностью вызова <literal>y=fun(x)</literal>.
70                     <varname>fun</varname> также может быть полиномом или рациональной дробью.
71                     <para/>
72                 </listitem>
73             </varlistentry>
74             <varlistentry>
75                 <term>c</term>
76                 <listitem>
77                     <literal>nc</literal> цвета <literal>nc</literal> хвостов комет.
78                     Они могут определяться в виде вектора <literal>nc</literal> индексов цветов или
79                     <link linkend="color_list">названий цветов</link> либо шестнадцатеричных кодов
80                     цветов "#RRGGBB". Либо матрицей (ncx3) из векторов <literal>[r,g,b]</literal>
81                     интенсивности Красного-Зелёного-Синего в интервале [0,1].
82                     <para/>
83                 </listitem>
84             </varlistentry>
85         </variablelist>
86     </refsection>
87     <refsection>
88         <title>Описание</title>
89         <para>
90             Если <literal>(x,y)</literal> являются двумя векторами с одинаковым количеством
91             элементов, то эта функция нарисует двумерный график с анимированной кометой,
92             показывающей движение кривой <literal>(x(1:k),y(1:k))</literal> для
93             <literal>k</literal>, меняющейся от <literal>1</literal> до
94             <literal>np=length(x)</literal>.
95         </para>
96         <para>
97             График строится из трёх частей:
98             <table>
99                 <tr><td><emphasis role="bold">голова</emphasis></td>
100                     <td>
101                         метка, которая показывает текущее положение <literal>(x(i),y(i))</literal>.
102                     </td>
103                 </tr>
104                 <tr><td><emphasis role="bold">тело</emphasis></td>
105                     <td>
106                         состоящее из <literal>k=round(Lf*np)</literal> самых последних точек
107                         траектории, отображаемое как более толстая часть трассы.
108                     </td>
109                 </tr>
110                 <tr><td><emphasis role="bold">хвост</emphasis></td>
111                     <td>
112                         показывает часть кривой <literal>(x(1:i-k),y(1:i-k))</literal>.
113                     </td>
114                 </tr>
115             </table>
116             <para>
117                 Инструкция <literal>comet(x, fun,...)</literal> эквивалентна инструкции
118                 <literal>comet(x, feval(x,fun),...)</literal>.
119             </para>
120             <para>
121                 Если <varname>x</varname> и <varname>y</varname> - матрицы
122                 одинаковых размеров, то анимированные кривые строятся для каждой пары
123                 <literal>(x(:,l),y(:,l))</literal>. В этом случае <literal>np</literal>
124                 - это количество строк матриц <varname>x</varname> и <varname>y</varname>.
125             </para>
126             <para>
127                 <literal>comet(...,"colors",c)</literal> может быть использована для
128                 установки цвета для каждой из траекторий.
129             </para>
130         </para>
131     </refsection>
132     <refsection>
133         <title>Примеры</title>
134         <programlisting role="example"><![CDATA[
135 // Одна комета по спирали:
136 t = linspace(0, 10*%pi, 500);
137 clf, isoview
138 comet(t.*sin(t), t.*cos(t), "colors", "orange")
139     ]]></programlisting>
140         <inlinemediaobject>
141             <imageobject>
142                 <imagedata fileref="../../images/comet_1.png"/>
143             </imageobject>
144         </inlinemediaobject>
145         <para/>
146         <programlisting role="example"><![CDATA[
147 // Две одновременные кометы с цветами по умолчанию :
148 t = linspace(0,10*%pi,500)';
149 clf
150 comet(t.*sin(t), [t.*sin(2*t) t.*sin(3*t)])
151     ]]></programlisting>
152         <para/>
153         <programlisting role="example"><![CDATA[
154 // Выбранные цвета :
155 t = linspace(0, 10*%pi, 500)';
156 clf
157 comet(t.*sin(t), [t.*cos(t) t.*sin(2*t)], "colors", ["orange" "mag"])
158     ]]></programlisting>
159         <inlinemediaobject>
160             <imageobject>
161                 <imagedata fileref="../../images/comet_2.png"/>
162             </imageobject>
163         </inlinemediaobject>
164         <para/>
165         <programlisting role="example"><![CDATA[
166 function y = traj(x)
167   y = 1.5*sin(x^2)
168 endfunction
169 clf
170 comet(linspace(0,5,500),traj)
171     ]]></programlisting>
172         <para/>
173         <programlisting role="example"><![CDATA[
174 clf
175 comet(linspace(-2,4,500), (%s-3)/(%s^3+2*%s^2+1))
176     ]]></programlisting>
177     </refsection>
178     <refsection role="see also">
179         <title>Смотрите также</title>
180         <simplelist type="inline">
181             <member>
182                 <link linkend="comet3d">comet3d</link>
183             </member>
184             <member>
185                 <link linkend="paramfplot2d">paramfplot2d</link>
186             </member>
187             <member>
188                 <link linkend="realtime">realtime</link>
189             </member>
190             <member>
191                 <link linkend="color_list">названия цветов</link>
192             </member>
193         </simplelist>
194     </refsection>
195     <refsection>
196         <title>История</title>
197         <revhistory>
198             <revision>
199                 <revnumber>5.3.2</revnumber>
200                 <revremark>
201                     Введена функция comet().
202                 </revremark>
203             </revision>
204             <revision>
205                 <revnumber>6.1.0</revnumber>
206                 <revremark>
207                   Цвета теперь могут быть указаны также их именами или шестнадцатеричными кодами
208                   «#RRGGBB» или их интенсивностью [r g b] Красный-Зелёный-Синий.
209                 </revremark>
210             </revision>
211         </revhistory>
212     </refsection>
213 </refentry>