06512707b006c30b75493fb76ee8425ab9f4bb6d
[scilab.git] / scilab / modules / graphics / help / ja_JP / 2d_plot / Matplot.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4
5  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
6
7  * Copyright (C) ENPC - Jean-Philippe Chancelier
8
9  *
10
11
12  * Copyright (C) 2012 - 2016 - Scilab Enterprises
13  *
14  * This file is hereby licensed under the terms of the GNU GPL v2.0,
15  * pursuant to article 5.3.4 of the CeCILL v.2.1.
16  * This file was originally licensed under the terms of the CeCILL v2.1,
17  * and continues to be available under such terms.
18  * For more information, see the COPYING file which you should have received
19  * along with this program.
20
21  *
22
23  -->
24
25 <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="Matplot">
26
27     <refnamediv>
28
29         <refname>Matplot</refname>
30
31         <refpurpose>行列のカラー二次元プロット</refpurpose>
32
33     </refnamediv>
34
35     <refsynopsisdiv>
36
37         <title>呼び出し手順</title>
38
39         <synopsis>
40
41             Matplot(a,[strf,rect,nax])
42
43             Matplot(a,&lt;opt_args&gt;)
44
45         </synopsis>
46
47     </refsynopsisdiv>
48
49     <refsection>
50
51         <title>引数</title>
52
53         <variablelist>
54
55             <varlistentry>
56
57                 <term>a</term>
58
59                 <listitem>
60
61                     <para>
62
63                         大きさ (<literal>n1</literal>, <literal>n2</literal>)
64
65                         の実数行列.
66
67                     </para>
68
69                 </listitem>
70
71             </varlistentry>
72
73             <varlistentry>
74
75                 <term>&lt;opt_args&gt;</term>
76
77                 <listitem>
78
79                     <para>
80
81                         一連の命令<literal>key1=value1,
82
83                             key2=value2
84
85                         </literal>
86
87                         ,... を表し,<literal>key1</literal>,
88
89                         <literal>key2,...</literal> には以下のどれかを指定できます:
90
91                     </para>
92
93                     <variablelist>
94
95                         <varlistentry>
96
97                             <term>rect</term>
98
99                             <listitem>
100
101                                 <para>
102
103                                     プロットの境界を設定します.
104
105                                     このキーが指定され,<literal>frameflag</literal> および <literal>strf</literal>
106
107                                     のどちらも指定されない場合,<literal>strf</literal> の文字<literal>y</literal>
108
109                                     は<literal>7</literal>に設定されます.
110
111                                     値については以下を参照ください.
112
113                                 </para>
114
115                             </listitem>
116
117                         </varlistentry>
118
119                         <varlistentry>
120
121                             <term>nax</term>
122
123                             <listitem>
124
125                                 <para>グリッドの定義を設定します.このキーが指定され,
126
127                                     <literal>axesflag</literal>および<literal>strf</literal>のどちらも指定されない場合,
128
129                                     <literal>strf</literal>の文字 <literal>z</literal>が
130
131                                     <literal>1</literal>に設定されます.値については以下を参照ください.
132
133                                 </para>
134
135                             </listitem>
136
137                         </varlistentry>
138
139                         <varlistentry>
140
141                             <term>frameflag</term>
142
143                             <listitem>
144
145                                 <para>プロットのフレームの計算方法を指定します.
146
147                                     この値は 0 から 8の整数です.<literal>strf</literal>の文字
148
149                                     <literal>y</literal>に対応します.以下を参照ください.
150
151                                 </para>
152
153                             </listitem>
154
155                         </varlistentry>
156
157                         <varlistentry>
158
159                             <term>axesflag</term>
160
161                             <listitem>
162
163                                 <para>プロットの周囲に描画される軸の種類を指定します.
164
165                                     この値は 0 から 5の整数です.<literal>strf</literal>の文字
166
167                                     <literal>z</literal>に対応します.以下を参照ください.
168
169                                 </para>
170
171                             </listitem>
172
173                         </varlistentry>
174
175                     </variablelist>
176
177                 </listitem>
178
179             </varlistentry>
180
181             <varlistentry>
182
183                 <term>strf</term>
184
185                 <listitem>
186
187                     <para>
188
189                         長さ3の文字列 <literal>"xyz"</literal>です.
190
191                     </para>
192
193                     <variablelist>
194
195                         <varlistentry>
196
197                             <term>default</term>
198
199                             <listitem>
200
201                                 <para>
202
203                                     デフォルトは <literal>"081"</literal>です.
204
205                                 </para>
206
207                             </listitem>
208
209                         </varlistentry>
210
211                         <varlistentry>
212
213                             <term>x</term>
214
215                             <listitem>
216
217                                 <para>キャプションの表示を制御します.</para>
218
219                                 <variablelist>
220
221                                     <varlistentry>
222
223                                         <term>x=0</term>
224
225                                         <listitem>
226
227                                             <para>キャプションなし.</para>
228
229                                         </listitem>
230
231                                     </varlistentry>
232
233                                     <varlistentry>
234
235                                         <term>x=1</term>
236
237                                         <listitem>
238
239                                             <para>キャプションが表示されます.
240
241                                                 これらはオプションの引数<literal>leg</literal>で指定されます.
242
243                                             </para>
244
245                                         </listitem>
246
247                                     </varlistentry>
248
249                                 </variablelist>
250
251                             </listitem>
252
253                         </varlistentry>
254
255                         <varlistentry>
256
257                             <term>y</term>
258
259                             <listitem>
260
261                                 <para>
262
263                                     指定された値に関する最小限の範囲をカバーする実際の座標を
264
265                                     計算する手法を制御します.
266
267                                     実際の範囲は必要最小限の値よりも大きくすることができます.
268
269                                 </para>
270
271                                 <variablelist>
272
273                                     <varlistentry>
274
275                                         <term>y=0</term>
276
277                                         <listitem>
278
279                                             <para>計算せずにプロットは前(またはデフォルト)のスケールを使用します</para>
280
281                                         </listitem>
282
283                                     </varlistentry>
284
285                                     <varlistentry>
286
287                                         <term>y=1</term>
288
289                                         <listitem>
290
291                                             <para>rect引数による</para>
292
293                                         </listitem>
294
295                                     </varlistentry>
296
297                                     <varlistentry>
298
299                                         <term>y=2</term>
300
301                                         <listitem>
302
303                                             <para>x, yデータの最小値/最大値による</para>
304
305                                         </listitem>
306
307                                     </varlistentry>
308
309                                     <varlistentry>
310
311                                         <term>y=3</term>
312
313                                         <listitem>
314
315                                             <para>rect引数に基づき等軸スケールで設定</para>
316
317                                         </listitem>
318
319                                     </varlistentry>
320
321                                     <varlistentry>
322
323                                         <term>y=4</term>
324
325                                         <listitem>
326
327                                             <para>x, yデータの最小値/最大値に基づき等軸スケールで設定</para>
328
329                                         </listitem>
330
331                                     </varlistentry>
332
333                                     <varlistentry>
334
335                                         <term>y=5</term>
336
337                                         <listitem>
338
339                                             <para>rect引数の設定値から見栄えが良くなるよう軸を拡大</para>
340
341                                         </listitem>
342
343                                     </varlistentry>
344
345                                     <varlistentry>
346
347                                         <term>y=6</term>
348
349                                         <listitem>
350
351                                             <para>x, yデータの最小値/最大値に基づく設定から見栄えが良くなるよう
352
353                                                 軸を拡大
354
355                                             </para>
356
357                                         </listitem>
358
359                                     </varlistentry>
360
361                                     <varlistentry>
362
363                                         <term>y=7</term>
364
365                                         <listitem>
366
367                                             <para>y=1 と似ていますが, 前のプロットは新しいスケールを使用して
368
369                                                 再描画させます
370
371                                             </para>
372
373                                         </listitem>
374
375                                     </varlistentry>
376
377                                     <varlistentry>
378
379                                         <term>y=8</term>
380
381                                         <listitem>
382
383                                             <para>y=2と似ていますが,前のプロットが新しいスケールを
384
385                                                 用いて再描画されます.
386
387                                             </para>
388
389                                         </listitem>
390
391                                     </varlistentry>
392
393                                 </variablelist>
394
395                             </listitem>
396
397                         </varlistentry>
398
399                         <varlistentry>
400
401                             <term>z</term>
402
403                             <listitem>
404
405                                 <para>プロットの周囲のフレームへの情報の表示を制御します.
406
407                                     軸が指定された場合,目盛の数をオプションの引数
408
409                                     <literal>nax</literal>により指定できます.
410
411                                 </para>
412
413                                 <variablelist>
414
415                                     <varlistentry>
416
417                                         <term>z=0</term>
418
419                                         <listitem>
420
421                                             <para>プロットの周囲に何も描画されません.</para>
422
423                                         </listitem>
424
425                                     </varlistentry>
426
427                                     <varlistentry>
428
429                                         <term>z=1</term>
430
431                                         <listitem>
432
433                                             <para>軸が描画され, y軸が左に表示されます.</para>
434
435                                         </listitem>
436
437                                     </varlistentry>
438
439                                     <varlistentry>
440
441                                         <term>z=2</term>
442
443                                         <listitem>
444
445                                             <para>プロットが目盛のない箱で囲われます.</para>
446
447                                         </listitem>
448
449                                     </varlistentry>
450
451                                     <varlistentry>
452
453                                         <term>z=3</term>
454
455                                         <listitem>
456
457                                             <para>軸が描画され,y軸が右側に表示されます.</para>
458
459                                         </listitem>
460
461                                     </varlistentry>
462
463                                     <varlistentry>
464
465                                         <term>z=4</term>
466
467                                         <listitem>
468
469                                             <para>
470
471                                                 フレームボックスの中央に軸が描画され,ボックスは無効になります.
472
473                                             </para>
474
475                                         </listitem>
476
477                                     </varlistentry>
478
479                                     <varlistentry>
480
481                                         <term>z=5</term>
482
483                                         <listitem>
484
485                                             <para>
486
487                                                 フレームボックスの中央に軸が描画され,ボックスは有効となります.
488
489                                             </para>
490
491                                         </listitem>
492
493                                     </varlistentry>
494
495                                 </variablelist>
496
497                             </listitem>
498
499                         </varlistentry>
500
501                     </variablelist>
502
503                 </listitem>
504
505             </varlistentry>
506
507             <varlistentry>
508
509                 <term>rect</term>
510
511                 <listitem>
512
513                     <para>
514
515                         この引数は引数<literal>strf</literal>の2文字目のyが1, 3または5の時に
516
517                         使用されます.
518
519                         この値は大きさ4の行ベクトルで,フレームの次元を指定します:
520
521                         <literal>rect=[xmin,ymin,xmax,ymax]</literal>.
522
523                     </para>
524
525                 </listitem>
526
527             </varlistentry>
528
529             <varlistentry>
530
531                 <term>nax</term>
532
533                 <listitem>
534
535                     <para>
536
537                         この引数は引数<literal>strf</literal>の3文字目のzが1の場合に
538
539                         使用されます.
540
541                         この値は4つのエントリ<literal>[nx,Nx,ny,Ny]</literal>を有する
542
543                         行ベクトルです.
544
545                         ただし,<literal>nx</literal> (<literal>ny</literal>)
546
547                         は x (y) 軸のサブグラデーションの数,
548
549                         <literal>Nx</literal> (<literal>Ny</literal>) はx (y) 軸のグラデーションの数です.
550
551                     </para>
552
553                 </listitem>
554
555             </varlistentry>
556
557         </variablelist>
558
559     </refsection>
560
561     <refsection>
562
563         <title>説明</title>
564
565         <para>
566
567             行列のエントリ<literal>int(a)</literal>がカレントのカラーマップにおける
568
569             カラーマップのエントリとして使用されます.
570
571             <literal>a(i,j)</literal>が指す色が位置<literal>(x=j,y=(n1-i+1))</literal>
572
573             を中心とする大きさ1の小さな正方領域を描画する際に使用されます.
574
575             行列のエントリがカラーマップの外側の場合,
576
577             対応する矩形は表示されません.
578
579         </para>
580
581         <para>
582
583             <warning>
584
585                 Matplotデータを更新する際には, 対応するハンドルの
586
587                 <literal>data</literal> フィールドを使用します.
588
589             </warning>
590
591             <literal>data</literal> は行列(またはハイパー行列)で,
592
593             RGB, RGBA, ... データを有します
594
595             (<link linkend="Matplot_properties">Matplot_properties</link>参照).
596
597         </para>
598
599         <para>
600
601             コマンド <literal>Matplot()</literal> を入力するとデモが表示されます.
602
603         </para>
604
605     </refsection>
606
607     <refsection>
608
609         <title>例</title>
610
611         <programlisting role="example"><![CDATA[
612 Matplot([1 2 3 ; 4 5 6])
613  ]]></programlisting>
614
615         <scilab:image>
616
617             Matplot([1 2 3;4 5 6])
618
619         </scilab:image>
620
621         <programlisting role="example"><![CDATA[
622 clf()
623 // カレントのカラーマップを描画
624 nbcol = size(gcf().color_map, 1);
625 Matplot(1:nbcol)
626  ]]></programlisting>
627         <scilab:image>
628             nbcol = size(gcf().color_map, 1);
629             Matplot(1:nbcol)
630         </scilab:image>
631     </refsection>
632     <refsection role="see also">
633
634         <title>参照</title>
635
636         <simplelist type="inline">
637
638             <member>
639
640                 <link linkend="colormap">colormap</link>
641
642             </member>
643
644             <member>
645
646                 <link linkend="plot2d">plot2d</link>
647
648             </member>
649
650             <member>
651
652                 <link linkend="Matplot1">Matplot1</link>
653
654             </member>
655
656             <member>
657
658                 <link linkend="Matplot_properties">Matplot_properties</link>
659
660             </member>
661
662         </simplelist>
663
664     </refsection>
665
666     <refsection>
667
668         <title>履歴</title>
669
670         <revhistory>
671
672             <revision>
673
674                 <revnumber>5.5.0</revnumber>
675
676                 <revremark>
677
678                     <literal>data</literal> は行列(またはハイパー行列)となり,
679
680                     RGB, RGBA, ... データを有するようになりました
681
682                     (<link linkend="Matplot_properties">Matplot_properties</link>参照).
683
684                 </revremark>
685
686             </revision>
687
688         </revhistory>
689
690     </refsection>
691
692 </refentry>
693
694
695