[doc] champ() page fixed + improved after f94449
[scilab.git] / scilab / modules / graphics / help / ru_RU / 2d_plot / champ.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) ENPC - Jean-Philippe Chancelier
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2020 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
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="champ">
20     <refnamediv>
21         <refname>champ</refname>
22         <refpurpose>строит стрелками поле двумерных векторов</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Синтаксис</title>
26         <synopsis>
27             champ()  // example
28             champ(x, y, fx, fy)
29             champ(x, y, fx, fy, arfact)
30             champ(x, y, fx, fy, arfact, rect)
31             champ(x, y, fx, fy, arfact, rect, strf)
32             champ(x, y, fx, fy, &lt;opt_args&gt;)
33         </synopsis>
34     </refsynopsisdiv>
35     <refsection>
36         <title>Аргументы</title>
37         <variablelist>
38             <varlistentry>
39                 <term>x, y</term>
40                 <listitem>
41                     <para>
42                         векторы десятичных чисел, которые определяют сетку узлов = координат начальных
43                         точек стрелок.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>fx</term>
49                 <listitem>
50                     <para>
51                         матрица, которая описывает x-составляющую векторного
52                         поля. <literal>fx(i,j)</literal> - это x-составляющая
53                         векторного поля в точке <literal>(x(i),y(j))</literal>.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>fy</term>
59                 <listitem>
60                     <para>
61                         матрица, которая описывает y-составляющую векторного
62                         поля. <literal>fy(i,j)</literal> - это y-составляющая
63                         векторного поля в точке <literal>(x(i),y(j))</literal>.
64                     </para>
65                 </listitem>
66             </varlistentry>
67             <varlistentry>
68                 <term>&lt;opt_args&gt;</term>
69                 <listitem>
70                     <para>
71                         Этот аргумент представляет последовательность инструкций
72                         <literal>key1=value1, key2=value2</literal>,..., где
73                         <literal>key1</literal>, <literal>key2</literal>,...
74                         могут быть одним из следующих:
75                         <varname>arfact</varname>, <varname>rect</varname>,
76                         <varname>strf</varname> (см. ниже).
77                     </para>
78                 </listitem>
79             </varlistentry>
80             <varlistentry>
81                 <term>arfact</term>
82                 <listitem>
83                     <para>
84                         необязательный аргумент типа <literal>real</literal>,
85                         который даёт масштабирующий коэффициент для отображения
86                         остриё стрелки на графике (значение по умолчанию равно
87                         <literal>1.0</literal>).
88                     </para>
89                 </listitem>
90             </varlistentry>
91             <varlistentry>
92                 <term>rect</term>
93                 <listitem>
94                     <para>
95                         вектор <literal>rect=[xmin, ymin, xmax, ymax]</literal>,
96                         который указывает используемые пределы кадра графика.
97                     </para>
98                 </listitem>
99             </varlistentry>
100             <varlistentry>
101                 <term>strf</term>
102                 <listitem>
103                     <para>
104                         строковое значение длиной 3 "xyz", которое имеет то же
105                         самое значение, что и параметр <varname>strf</varname>
106                         функции <function>plot2d</function>. Первый символ
107                         <literal>x</literal> не имеет значения для <function>champ</function>.
108                     </para>
109                 </listitem>
110             </varlistentry>
111         </variablelist>
112     </refsection>
113     <refsection>
114         <title>Описание</title>
115         <para>
116             <literal>champ(…)</literal> строит поле двумерных веторов с помощью стрелок.
117         </para>
118         <para>
119             По умолчанию все стрелки одного цвета, а их длина пропорционально локальной интенсивности
120             поля (норма векторов). Кроме того, все длины нормированы в соответствии с самой длинной стрелкой.
121         </para>
122         <para>
123             Когда установлено <literal>gce().colored = "on"</literal>,
124             каждая стрелка становится настолько длинной, насколько это возможно в её ячейке, и её
125             цвет соответствует локальной интенсивности поля.
126         </para>
127         <para>
128             После вызова <literal>champ(…)</literal>, <literal>gce()</literal>
129             возвращает дескриптор поля стрелок типа <literal>Champ</literal>,
130             чьи <link linkend="champ_properties">свойства</link> могут быть далее обработаны.
131         </para>
132         <para>
133             Введите команду <literal>champ()</literal>, чтобу увидеть пример.
134         </para>
135     </refsection>
136     <refsection>
137         <title>Примеры</title>
138         <programlisting role="example"><![CDATA[
139 x = -4:6;
140 X = ndgrid(x);
141 [fx, fy] =  (rand(X)-0.5, rand(X)-0.5);
142
143 clf
144 gcf().color_map = jetcolormap(50);
145
146 // Интенсивность поля = длине стрелок
147 subplot(2,2,1)
148 champ(x, x, fx, fy)
149
150 // С более крупной стрелкой
151 subplot(2,2,2)
152 champ(x, x, fx, fy, arfact=1.7)
153 title("arfact=1.7", "fontsize",3)
154
155 // Интенсивность поля = цвету стрелок
156 xsetech([0 0.5 0.55 0.5])
157 champ(x, x, fx, fy, arfact=1.7)
158 gce().colored = "on";
159 title("arfact=1.7, .colored=""on""", "fontsize",3)
160 L = sqrt(fx.^2 + fy.^2);
161 colorbar(min(L), max(L));
162
163 // Интенсивность поля = цвету, + расширенные пределы
164 subplot(2,2,4)
165 champ(x, x, fx, fy, rect=[-5,-6,9,7],strf="011")
166 gce().colored = "on";
167 title("rect=[-5,-6,9,6], strf=""011"", .colored=""on""", "fontsize",3)
168
169 gcf().axes_size = [740 680];
170     ]]></programlisting>
171         <scilab:image>
172             x = -4:6;
173             X = ndgrid(x);
174             [fx, fy] =  (rand(X)-0.5, rand(X)-0.5);
175
176             clf
177             gcf().color_map = jetcolormap(50);
178
179             // Field's intensity = arrows length
180             subplot(2,2,1)
181             champ(x, x, fx, fy)
182
183             // With bigger arrow heads
184             subplot(2,2,2)
185             champ(x, x, fx, fy, arfact=1.7)
186             title("arfact=1.7", "fontsize",3)
187
188             // Field's intensity = arrows color
189             xsetech([0 0.5 0.55 0.5])
190             champ(x, x, fx, fy, arfact=1.7)
191             gce().colored = "on";
192             title("arfact=1.7, .colored=""on""", "fontsize",3)
193             L = sqrt(fx.^2 + fy.^2);
194             colorbar(min(L), max(L));
195
196             // Field's intensity = color, + imposed boundaries
197             subplot(2,2,4)
198             champ(x, x, fx, fy, rect=[-5,-6,9,7],strf="011")
199             gce().colored = "on";
200             title("rect=[-5,-6,9,6], strf=""011"", .colored=""on""", "fontsize",3)
201
202             gcf().axes_size = [740 680];
203         </scilab:image>
204         <programlisting role="example"><![CDATA[
205 x = -1.2:0.11:0.7;
206 y = -1:0.11:0.5;
207 [X, Y] = ndgrid(x, y);
208 [fx, fy] = (2*X, 2*Y);
209
210 clf
211 xsetech([0 0 0.45 1])
212 champ(x, y, fx, fy)
213 title(".colored = ""off"" (по умолчанию)", "fontsize",3)
214 xsetech([0.45 0 0.55 1])
215 champ(x, y, fx, fy)
216 title(".colored = ""on""", "fontsize",3)
217 gce().colored = "on";
218
219 gcf().color_map = jetcolormap(100);
220 L = sqrt(fx.^2 + fy.^2);
221 colorbar(min(L), max(L));
222 ]]></programlisting>
223         <scilab:image>
224             x = -1.2:0.11:0.7;
225             y = -1:0.11:0.5;
226             [X, Y] = ndgrid(x, y);
227             [fx, fy] = (2*X, 2*Y);
228
229             clf
230             xsetech([0 0 0.45 1])
231             champ(x, y, fx, fy)
232             title(".colored = ""off"" (default)", "fontsize",3)
233             xsetech([0.45 0 0.55 1])
234             champ(x, y, fx, fy)
235             title(".colored = ""on""", "fontsize",3)
236             gce().colored = "on";
237
238             gcf().color_map = jetcolormap(100);
239             L = sqrt(fx.^2 + fy.^2);
240             colorbar(min(L), max(L));
241
242             gcf().axes_size = [720 340];
243         </scilab:image>
244     </refsection>
245     <refsection role="see also">
246         <title>Смотрите также</title>
247         <simplelist type="inline">
248             <member>
249                 <link linkend="champ_properties">champ_properties</link>
250             </member>
251             <member>
252                 <link linkend="fchamp">fchamp</link>
253             </member>
254             <member>
255                 <link linkend="xarrows">xarrows</link>
256             </member>
257             <member>
258                 <link linkend="polyline_properties">Arrowed polyline</link>
259             </member>
260         </simplelist>
261     </refsection>
262 </refentry>