Remove windows carriage return
[scilab.git] / scilab / modules / graphics / help / ja_JP / 3d_plot / plot3d1.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  * 
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" version="5.0-subset Scilab" xml:lang="ja" xml:id="plot3d1">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>plot3d1</refname>
19     <refpurpose>曲面の3次元白黒またはカラープロット</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>呼び出し手順</title>
23     <synopsis>plot3d1(x,y,z,[theta,alpha,leg,flag,ebox])
24 plot3d1(xf,yf,zf,[theta,alpha,leg,flag,ebox])
25
26 plot3d1(x,y,z,&lt;opts_args&gt;)
27 plot3d1(xf,yf,zf,&lt;opts_args&gt;)</synopsis>
28   </refsynopsisdiv>
29   <refsection>
30     <title>パラメータ</title>
31     <variablelist>
32       <varlistentry>
33         <term>x,y</term>
34         <listitem>
35           <para>大きさ n1 および n2 の行ベクトル(x軸およびy軸座標
36           ). これらの座標は単調である必要があります.</para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>z</term>
41         <listitem>
42           <para>大きさ (n1,n2)の行列. <literal>z(i,j)</literal> は点(x(i),y(j))における
43                 曲面の値です.</para>
44         </listitem>
45       </varlistentry>
46       <varlistentry>
47         <term>xf,yf,zf</term>
48         <listitem>
49           <para>大きさ (nf,n)の行列. 曲面を描画する際に使用される小平面を定義します.
50         <literal>n</literal>個の小平面があります. 各小平面
51           <literal>i</literal> は<literal>nf</literal>個の点を有するポリゴンで定義されます.
52         i番目の小平面の点のx軸,y軸,z軸座標はそれぞれ<literal>xf(:,i)</literal>, 
53         <literal>yf(:,i)</literal> および  <literal>zf(:,i)</literal>により指定されます.
54         </para>
55         </listitem>
56       </varlistentry>
57       <varlistentry>
58         <term>&lt;opt_args&gt;</term>
59         <listitem>
60           <para>一連の命令<literal>key1=value1,
61           key2=value2</literal>,...を表し, <literal>key1</literal>,
62           <literal>key2,...</literal> は以下のどれかとすることができます: theta,
63           alpha ,leg,flag,ebox (以下の定義を参照).</para>
64         </listitem>
65       </varlistentry>
66       <varlistentry>
67         <term>theta, alpha</term>
68         <listitem>
69           <para>観測点の球座標を指定する実数値(単位:度).</para>
70         </listitem>
71       </varlistentry>
72       <varlistentry>
73         <term>leg</term>
74         <listitem>
75           <para>各軸のラベルを定義する文字列. @ をフィールドセパレータとし,
76                 "X@Y@Z"のようになります.</para>
77         </listitem>
78       </varlistentry>
79       <varlistentry>
80         <term>flag</term>
81         <listitem>
82           <para>大きさ3の実数ベクトル.
83           <literal>flag=[mode,type,box]</literal>.</para>
84           <variablelist>
85             <varlistentry>
86               <term>mode</term>
87               <listitem>
88                 <para>整数 (曲面の色).</para>
89                 <variablelist>
90                   <varlistentry>
91                     <term>mode&gt;0</term>
92                     <listitem>
93                       <para>曲面は色<literal>"mode"</literal>で塗られます ;
94                         小平面の境界はカレントの線種と色で描画されます.</para>
95                     </listitem>
96                   </varlistentry>
97                   <varlistentry>
98                     <term>mode=0:</term>
99                     <listitem>
100                       <para>曲面のメッシュが描画されます.</para>
101                     </listitem>
102                   </varlistentry>
103                   <varlistentry>
104                     <term>mode&lt;0:</term>
105                     <listitem>
106                       <para>曲面は色<literal>"-mode"</literal>で塗られます ;
107                         小平面の境界は描画されません.</para>
108                       <para>曲面の色の取り扱いは,
109                         surfaceエンティティプロパティによる
110                         <literal>color_mode</literal>および
111                         <literal>color_flag</literal>オプションを用いて
112                         行われることに注意してください (<link
113                       linkend="surface_properties">surface_properties</link>参照).</para>
114                     </listitem>
115                   </varlistentry>
116                 </variablelist>
117               </listitem>
118             </varlistentry>
119             <varlistentry>
120               <term>type</term>
121               <listitem>
122                 <para>整数 (スケール).</para>
123                 <variablelist>
124                   <varlistentry>
125                     <term>type=0:</term>
126                     <listitem>
127                       <para>プロットは
128                         (前の<literal>param3d</literal>,
129                       <literal>plot3d</literal>, <literal>contour</literal> または
130                       <literal>plot3d1</literal>のコールで設定された)
131                         カレントの3次元スケールで行われます.</para>
132                     </listitem>
133                   </varlistentry>
134                   <varlistentry>
135                     <term>type=1:</term>
136                     <listitem>
137                       <para>
138                         3次元ボックスのスケールがアスペクト比の最大値に基づき
139                         自動的に調整され,
140                         境界はオプションの引数<literal>ebox</literal>の値で
141                         指定されます.</para>
142                     </listitem>
143                   </varlistentry>
144                   <varlistentry>
145                     <term>type=2:</term>
146                     <listitem>
147                      <para>
148                         3次元ボックスのスケールがアスペクト比の最大値に基づき
149                         自動的に調整され,境界は指令したデータにより計算されます.</para>
150                     </listitem>
151                   </varlistentry>
152                   <varlistentry>
153                     <term>type=3:</term>
154                     <listitem>
155                      <para>
156                         オプション<literal>ebox</literal>で指定したボックス境界を有する
157                         3次元等軸プロットで,<literal>type=1</literal>に似ています.</para>
158                     </listitem>
159                   </varlistentry>
160                   <varlistentry>
161                     <term>type=4:</term>
162                     <listitem>
163                       <para>データで定義された境界に基づく3次元等軸プロットで,
164                         <literal>type=2</literal>に似ています.</para>
165                     </listitem>
166                   </varlistentry>
167                   <varlistentry>
168                     <term>type=5:</term>
169                     <listitem>
170                      <para>
171                         オプション<literal>ebox</literal>で指定されたボックス境界で
172                         定義された境界に基づく3次元拡張等軸プロットで,
173                         <literal>type=1</literal>に似ています.</para>
174                     </listitem>
175                   </varlistentry>
176                   <varlistentry>
177                     <term>type=6:</term>
178                     <listitem>
179                      <para>
180                         データで定義された境界に基づく3次元拡張等軸プロットで,
181                         <literal>type=2</literal>に似ています.
182                         軸の境界は axes エンティティプロパティによりカスタマイズできる
183                         ことに注意してください(<link
184                       linkend="axes_properties">axes_properties</link>参照).</para>
185                     </listitem>
186                   </varlistentry>
187                 </variablelist>
188               </listitem>
189             </varlistentry>
190             <varlistentry>
191               <term>box</term>
192               <listitem>
193                 <para>整数 (プロットの周囲のフレーム).</para>
194                 <variablelist>
195                   <varlistentry>
196                     <term>box=0:</term>
197                     <listitem>
198                       <para>プロットの周囲に何も描画されません.</para>
199                     </listitem>
200                   </varlistentry>
201                   <varlistentry>
202                     <term>box=1:</term>
203                     <listitem>
204                       <para>実装されていません (box=0と同様).</para>
205                     </listitem>
206                   </varlistentry>
207                   <varlistentry>
208                     <term>box=2:</term>
209                     <listitem>
210                       <para>曲面の背後の軸のみが描画されます.</para>
211                     </listitem>
212                   </varlistentry>
213                   <varlistentry>
214                     <term>box=3:</term>
215                     <listitem>
216                       <para>曲面を囲うボックスが描画され,キャプションが追加されます.</para>
217                     </listitem>
218                   </varlistentry>
219                   <varlistentry>
220                     <term>box=4:</term>
221                     <listitem>
222                       <para>
223                         曲面を囲うボックスが描画され,キャプションと軸が追加されます.
224                         </para>
225                       <para>
226                         軸のアスペクトもaxesエンティティのプロパティによりカスタマイズ
227                         できることに注意してください (<link
228                       linkend="axes_properties">axes_properties</link>参照).
229                       </para>
230                     </listitem>
231                   </varlistentry>
232                 </variablelist>
233               </listitem>
234             </varlistentry>
235           </variablelist>
236         </listitem>
237       </varlistentry>
238       <varlistentry>
239         <term>ebox</term>
240         <listitem>
241         <para>
242         プロットの境界をベクトル
243           <literal>[xmin,xmax,ymin,ymax,zmin,zmax]</literal>で指定します. 
244         この引数は,<literal>flag</literal>の<literal>type</literal>が<literal>1</literal>,
245           <literal>3</literal> または <literal>5</literal>に設定された場合,
246         使用されます (対応する動作については上記参照). 
247         <literal>flag</literal> が指定されない場合
248           <literal>ebox</literal> は無視されます. </para>
249           <para>
250         指定された場合, <literal>ebox</literal>引数は,
251         <literal>data_bounds</literal>に基づいて動作し,
252         axesエンティティのプロパティによりリセットすることも可能であることに
253         注意してください. ebox のデフォルト値は[0,1,0,1,0,1]です.(<link
254           linkend="axes_properties">axes_properties</link>参照)
255         </para>
256         </listitem>
257       </varlistentry>
258     </variablelist>
259   </refsection>
260   <refsection>
261     <title>説明</title>
262     <para>
263         <literal>plot3d1</literal> は曲面のzのレベルに基づく色の曲面を
264         プロットします.
265         この特別なプロット関数は,<literal>plot3d</literal>の後で
266         <literal>color_flag=1</literal>を設定することにより有効にすることができます.
267         (
268     <link linkend="surface_properties">surface_properties</link>参照)</para>
269     <para>コマンド <literal>plot3d1()</literal> によりデモを参照できます.</para>
270   </refsection>
271   <refsection>
272     <title>例</title>
273     <programlisting role="example"><![CDATA[ 
274 // z=f(x,y) によりプロットする
275 t=[0:0.3:2*%pi]'; z=sin(t)*cos(t'); 
276 plot3d1(t,t,z) 
277 // genfac3d により計算された小平面を用いて同様にプロット
278 [xx,yy,zz]=genfac3d(t,t,z); 
279 clf(); 
280 plot3d1(xx,yy,zz) 
281 // 複数のプロット 
282 clf(); 
283 plot3d1([xx xx],[yy yy],[zz 4+zz]) 
284 // 視点とキャプションを指定してプロット
285 clf() ;
286 plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[2,2,3]) 
287 // グリッドを指定せずにプロット 
288 clf() 
289 plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[-2,2,3]) 
290 // eval3dp により計算される小平面により球をプロット
291 deff("[x,y,z]=sph(alp,tet)",["x=r*cos(alp).*cos(tet)+orig(1)*ones(tet)";.. 
292 "y=r*cos(alp).*sin(tet)+orig(2)*ones(tet)";.. 
293 "z=r*sin(alp)+orig(3)*ones(tet)"]); 
294 r=1; orig=[0 0 0]; 
295 [xx,yy,zz]=eval3dp(sph,linspace(-%pi/2,%pi/2,40),linspace(0,%pi*2,20)); 
296 clf() 
297
298 plot3d(xx,yy,zz)
299 e=gce();
300 e.color_flag=1;
301 scf(2);
302 plot3d1(xx,yy,zz) // 2つのグラフィックは同じ
303  ]]></programlisting>
304   </refsection>
305   <refsection role="see also">
306     <title>参照</title>
307     <simplelist type="inline">
308       <member>
309         <link linkend="plot3d">plot3d</link>
310       </member>
311       <member>
312         <link linkend="gca">gca</link>
313       </member>
314       <member>
315         <link linkend="gce">gce</link>
316       </member>
317       <member>
318         <link linkend="scf">scf</link>
319       </member>
320       <member>
321         <link linkend="clf">clf</link>
322       </member>
323     </simplelist>
324   </refsection>
325   <refsection>
326     <title>作者</title>
327     <para>J.Ph.C.</para>
328   </refsection>
329 </refentry>