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