scilab/modules/graphics/help/ja_JP/3d_plot/comet3d.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Add some comments about XML file
   4 -->
   5 <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="ja" xml:id="comet3d">
   6     <refnamediv>
   7         <refname>comet3d</refname>
   8         <refpurpose>3次元 comet アニメーションプロット. </refpurpose>
   9     </refnamediv>
  10     <refsynopsisdiv>
  11         <title>呼び出し手順</title>
  12         <synopsis>
  13             comet3d(z)
  14             comet3d(x, y, z)
  15             comet3d(x, y, fun)
  16             comet3d(x, y, z, p)
  17             comet3d(x, y, fun, p)
  18             comet3d(...,"colors", c)
  19         </synopsis>
  20     </refsynopsisdiv>
  21     <refsection>
  22         <title>パラメータ</title>
  23         <variablelist>
  24             <varlistentry>
  25                 <term>x</term>
  26                 <listitem>
  27                     <para>
  28                         実数ベクトルまたは行列. 省略された場合,
  29                         ベクトル  <literal>1:nz</literal> が使用されます.
  30                         ただし,  <literal>nz</literal> は<literal>z</literal>パラメータ
  31                         で指定される曲線の点の数です.
  32                     </para>
  33                 </listitem>
  34             </varlistentry>
  35             <varlistentry>
  36                 <term>y</term>
  37                 <listitem>
  38                     <para>
  39                         実数ベクトルまたは行列. 省略された場合,
  40                         ベクトル  <literal>1:nz</literal> が使用されます.
  41                         ただし,  <literal>nz</literal> は<literal>z</literal>パラメータ
  42                         で指定される曲線の点の数です.
  43                     </para>
  44                 </listitem>
  45             </varlistentry>
  46             <varlistentry>
  47                 <term>z</term>
  48                 <listitem>
  49                     <para>
  50                         長さ <literal>nz</literal> の実数ベクトル, または,
  51                         <literal>nz</literal> 行の行列.
  52                     </para>
  53                 </listitem>
  54             </varlistentry>
  55             <varlistentry>
  56                 <term>p</term>
  57                 <listitem>
  58                     <para>
  59                         範囲 <literal>[0 1[</literal> の実数スカラー.
  60                         デフォルト値は 0.1.
  61                     </para>
  62                 </listitem>
  63             </varlistentry>
  64             <varlistentry>
  65                 <term>fun</term>
  66                 <listitem>
  67                     <para>
  68                         呼び出し手順 <literal>z=fun(x,y)</literal> のScilab関数.
  69                     </para>
  70                 </listitem>
  71             </varlistentry>
  72             <varlistentry>
  73                 <term>c</term>
  74                 <listitem>
  75                     <para>
  76                         <literal>ny</literal> 色の添字のベクトル.
  77                     </para>
  78                 </listitem>
  79             </varlistentry>
  80         </variablelist>
  81     </refsection>
  82     <refsection>
  83         <title>説明</title>
  84         <para>
  85             <literal>(x,y,z)</literal>が要素数が同じ3つのベクトルの場合,
  86             この関数は3次元cometアニメーションプロットを描画します.
  87             このプロットは以下の3つの部分から構成されます:
  88             <variablelist>
  89                 <varlistentry>
  90                     <term>ヘッド</term>
  91                     カレントの位置<literal>(x(i),y(i),z(i))</literal>を示すマーカ.
  92                     <listitem><para>
  93                         </para>
  94                     </listitem>
  95                 </varlistentry>
  96                 <varlistentry>
  97                     <term>ボディー</term> ヘッドに続く尾の曲線を示す:
  98                     曲線の一部
  99                     <literal>(x(i-k:i),y(i-k:i),z(i-k:i))</literal>)
 100                     <listitem><para>
 101                         </para>
 102                     </listitem>
 103                 </varlistentry>
 104                 <varlistentry>
 105                     <term>テール</term>
 106                     曲線の一部<literal>(x(1:i-k),y(1:i-k),z(1:i-k))</literal> を示す.
 107                     <listitem><para>
 108                         </para>
 109                     </listitem>
 110                 </varlistentry>
 111             </variablelist>
 112             <para>
 113                 <literal>z</literal> が行列,
 114                 <literal>(x,y)</literal> がベクトルの場合,
 115                 アニメーション表示される曲線は各<literal>(x,y,z(:,l))</literal>
 116                 の組について描画されます.
 117                 この場合,
 118                 <literal>nz</literal> は <literal>z</literal>の行の数となります.
 119             </para>
 120             <para>
 121                 <literal>x,y,z</literal> が同じ次元の行列の場合,
 122                 アニメーション表示される曲線は,
 123                 各組<literal>(x(:,l),y(:,l),z(:,l))</literal>について
 124                 描画されます.
 125             </para>
 126             <para>
 127                 <literal>comet3d(x,y,fun,...)</literal> は,
 128                 <literal>z</literal> ベクトルを
 129                 <literal>z(i)=fun(x(i),y(i))</literal>により
 130                 計算します.
 131             </para>
 132             <para>
 133                 <literal>comet3d(...,p)</literal> は,
 134                 ボディの相対長を設定するために使用することができます.
 135                 <literal>k</literal> は,
 136                 <literal>k = round(p*nz)</literal>により定義されます.
 137             </para>
 138         </para>
 139     </refsection>
 140     <refsection>
 141         <title>例</title>
 142         <programlisting role="example"><![CDATA[
 143 t = linspace(-%pi,%pi,500);
 144 clf
 145 comet3d(sin(5*t), sin(t), t^2)
 146     ]]></programlisting>
 147         <programlisting role="example"><![CDATA[
 148 t = linspace(-%pi,%pi,500)';
 149 clf
 150 comet3d(sin(5*t), sin(t), [t^2,ones(t)])
 151     ]]></programlisting>
 152         <programlisting role="example"><![CDATA[
 153 t = linspace(-%pi,%pi,500)';
 154 function z=traj(x,y),z=1.5*sin(x^2)*cos(y),endfunction
 155 clf
 156 comet3d(cos(t), sin(t), traj)
 157     ]]></programlisting>
 158     </refsection>
 159     <refsection role="see also">
 160         <title>参照</title>
 161         <simplelist type="inline">
 162             <member>
 163                 <link linkend="comet">comet</link>
 164             </member>
 165         </simplelist>
 166     </refsection>
 167     <refsection>
 168         <title>履歴</title>
 169         <revhistory>
 170             <revision>
 171                 <revnumber>5.3.2</revnumber>
 172                 <revremark>関数 comet3d が導入されました.</revremark>
 173             </revision>
 174         </revhistory>
 175     </refsection>
 176 </refentry>