* Bug 15392 fixed: comet() comet3d() with named|#RRGGBB|[r g b] colors
[scilab.git] / scilab / modules / graphics / help / ja_JP / 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="ja" xml:id="comet">
20     <refnamediv>
21         <refname>comet</refname>
22         <refpurpose>2次元 comet アニメーションプロット</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> が指定されたと仮定されます.
43                     ただし,<literal>np</literal> は曲線の点の数(下記参照)です.
44                     行列として、各列は別々の彗星の軌跡の水平座標を定義します。
45                     <para/>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>y</term>
50                 <listitem>
51                     長さの実数ベクトルまたは行列. 行列として、各列は別々の彗星の軌跡の縦座標を定義します。
52                     <literal>nc=size(y,"c")</literal>  は、同時に描画される彗星の数です。
53                     <para/>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>Lf</term>
58                 <listitem>
59                     範囲 <literal>[0 1[</literal> の実数スカラー. デフォルト値は 0.1です.
60                     これは、彗星の痕跡のLeading fractionを定義します。最近の点は太い線でプロットされています
61                     (<literal>k=Lf*np</literal>)。
62                     <para/>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>fun</term>
67                 <listitem>
68                     呼び出し手順  <literal>y=fun(x)</literal> のScilab関数.
69                     <varname>fun</varname> は多項式または有理数とすることもできます.
70                     <para/>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>c</term>
75                 <listitem>
76                     <literal>nc</literal> colors of the <literal>nc</literal> comets traces.
77                     They may be specified as a vector of <literal>nc</literal> color indices or
78                     <link linkend="color_list">color names</link> or "#RRGGBB" hexadecimal
79                     color codes. Or by a matrix (ncx3) of <literal>[r,g,b]</literal> vectors of
80                     Red-Green-Blue intensities in the [0,1] interval.
81                     <para/>
82                 </listitem>
83             </varlistentry>
84         </variablelist>
85     </refsection>
86     <refsection>
87         <title>説明</title>
88         <para>
89             <literal>(x,y)</literal> が同じ要素数のベクトルの場合,
90             この関数は,
91             <literal>m</literal>を<literal>1</literal> から
92             <literal>np=length(x)</literal>まで変えて
93             曲線<literal>(x(1:m), y(1:m))</literal>の漸進を示す
94             2次元アニメーションプロットを描画します.
95         </para>
96         <para>
97             このプロットは以下の3つの部分から構成されます:
98             <table>
99                 <tr><td><emphasis role="bold">ヘッド</emphasis></td>
100                     <td>カレントの位置<literal>(x(i),y(i))</literal>を示すマーカ.</td>
101                 </tr>
102                 <tr><td><emphasis role="bold">ボディ</emphasis></td>
103                     <td>
104                         軌跡の最も最近の点である<literal>k=round(Lf*np)</literal>
105                         で構成され、トレースのより厚い部分として表示されます。
106                     </td>
107                 </tr>
108                 <tr><td><emphasis role="bold">テール</emphasis></td>
109                     <td>
110                         曲線の<literal>(x(1:i-k),y(1:i-k))</literal>の部分を表示.
111                     </td>
112                 </tr>
113             </table>
114         </para>
115         <para>
116             <literal>comet(x,fun,...)</literal> は, <literal>comet(x,feval(x,fun),...)</literal>
117             と等価です.
118         </para>
119         <para>
120             <varname>x</varname> および <varname>y</varname> は
121             同じ大きさの行列の場合, 各組  <literal>(x(:,l),y(:,l))</literal> 毎に.
122             アニメーション表示された曲線が描画されます.
123             この場合, <literal>np</literal>は
124             <varname>x</varname>および  <varname>y</varname>の 行の数です.
125         </para>
126         <para>
127             <literal>comet(...,"colors",c)</literal> は各曲線の色を設定する際に使用できます.
128         </para>
129     </refsection>
130     <refsection>
131         <title>例</title>
132         <programlisting role="example"><![CDATA[
133 // One comet in spiral:
134 t = linspace(0, 10*%pi, 500);
135 clf, isoview
136 comet(t.*sin(t), t.*cos(t), "colors", "orange")
137     ]]></programlisting>
138         <inlinemediaobject>
139             <imageobject>
140                 <imagedata fileref="../../images/comet_1.png"/>
141             </imageobject>
142         </inlinemediaobject>
143         <para/>
144         <programlisting role="example"><![CDATA[
145 // Two simultaneous comets with default colors:
146 t = linspace(0,10*%pi,500)';
147 clf
148 comet(t.*sin(t), [t.*sin(2*t) t.*sin(3*t)])
149     ]]></programlisting>
150         <para/>
151         <programlisting role="example"><![CDATA[
152 // Chosen colors:
153 clf
154 comet(t.*sin(t), [t.*cos(t) t.*sin(2*t)], "colors", ["orange" "mag"])
155     ]]></programlisting>
156         <inlinemediaobject>
157             <imageobject>
158                 <imagedata fileref="../../images/comet_2.png"/>
159             </imageobject>
160         </inlinemediaobject>
161         <para/>
162         <programlisting role="example"><![CDATA[
163 function y = traj(x)
164   y = 1.5*sin(x^2)
165 endfunction
166 clf
167 comet(linspace(0,5,500),traj)
168     ]]></programlisting>
169         <para/>
170         <programlisting role="example"><![CDATA[
171 clf
172 comet(linspace(-2,4,500), (%s-3)/(%s^3+2*%s^2+1))
173     ]]></programlisting>
174     </refsection>
175     <refsection>
176         <title>参照</title>
177         <simplelist type="inline">
178             <member>
179                 <link linkend="comet3d">comet3d</link>
180             </member>
181             <member>
182                 <link linkend="paramfplot2d">paramfplot2d</link>
183             </member>
184             <member>
185                 <link linkend="realtime">realtime</link>
186             </member>
187             <member>
188                 <link linkend="color_list">colors names</link>
189             </member>
190         </simplelist>
191     </refsection>
192     <refsection>
193         <title>履歴</title>
194         <revhistory>
195             <revision>
196                 <revnumber>5.3.2</revnumber>
197                 <revremark>
198                     関数 comet() が導入されました.
199                 </revremark>
200             </revision>
201             <revision>
202                 <revnumber>6.1.0</revnumber>
203                 <revremark>
204                   色は、名前、"#RRGGBB"の16進コード、または赤緑青の強度で指定することもできるようになりました。
205                 </revremark>
206             </revision>
207         </revhistory>
208     </refsection>
209 </refentry>