5a9b983e603bba72aa74016da1c72e69132eac7d
[scilab.git] / scilab / modules / graphics / help / en_US / Graphics.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) INRIA
5  * 
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="en" scilab:needs-examples="no" xml:id="Graphics">
17     <refnamediv>
18         <refname>Graphics: Getting started</refname>
19         <refpurpose>graphics library overview</refpurpose>
20     </refnamediv>
21     <refsection>
22         <title>2d plotting</title>
23         <variablelist>
24             <varlistentry>
25                 <term>
26                     <link linkend="plot2d">plot2d</link>
27                 </term>
28                 <listitem>
29                     <para>Plot a curve</para>
30                     <para>
31                         <emphasis role="bold">Example:</emphasis>
32                     </para>
33                     <para>
34                         <scilab:image>plot2d();</scilab:image>
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>
40                     <link linkend="plot2d2">plot2d2</link>
41                 </term>
42                 <listitem>
43                     <para>Plot a curve as step function</para>
44                     <para>
45                         <emphasis role="bold">Example:</emphasis>
46                     </para>
47                     <para>
48                         <scilab:image>plot2d2();</scilab:image>
49                     </para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>
54                     <link linkend="plot2d3">plot2d3</link>
55                 </term>
56                 <listitem>
57                     <para>Plot a curve with vertical bars</para>
58                     <para>
59                         <emphasis role="bold">Example:</emphasis>
60                     </para>
61                     <para>
62                         <scilab:image>plot2d3();</scilab:image>
63                     </para>
64                 </listitem>
65             </varlistentry>
66             <varlistentry>
67                 <term>
68                     <link linkend="plot2d4">plot2d4</link>
69                 </term>
70                 <listitem>
71                     <para>Plot a curve with arrows</para>
72                     <para>
73                         <emphasis role="bold">Example:</emphasis>
74                     </para>
75                     <para>
76                         <scilab:image>plot2d4();</scilab:image>
77                     </para>
78                 </listitem>
79             </varlistentry>
80             <varlistentry>
81                 <term>
82                     <link linkend="fplot2d">fplot2d</link>
83                 </term>
84                 <listitem>
85                     <para>Plot a curve defined by a function</para>
86                     <para>
87                         <emphasis role="bold">Example:</emphasis>
88                     </para>
89                     <para>
90                         <scilab:image>fplot2d();</scilab:image>
91                     </para>
92                 </listitem>
93             </varlistentry>
94             <varlistentry>
95                 <term>
96                     <link linkend="champ">champ</link>
97                 </term>
98                 <listitem>
99                     <para>2D vector field</para>
100                     <para>
101                         <emphasis role="bold">Example:</emphasis>
102                     </para>
103                     <para>
104                         <scilab:image>champ();</scilab:image>
105                     </para>
106                 </listitem>
107             </varlistentry>
108             <varlistentry>
109                 <term>
110                     <link linkend="champ1">champ1</link>
111                 </term>
112                 <listitem>
113                     <para>2D vector field with colored arrows</para>
114                     <para>
115                         <emphasis role="bold">Example:</emphasis>
116                     </para>
117                     <para>
118                         <scilab:image>champ1();</scilab:image>
119                     </para>
120                 </listitem>
121             </varlistentry>
122             <varlistentry>
123                 <term>
124                     <link linkend="fchamp">fchamp</link>
125                 </term>
126                 <listitem>
127                     <para>Direction field of a 2D first order ODE</para>
128                     <para>
129                         <emphasis role="bold">Example:</emphasis>
130                     </para>
131                     <para>
132                         <scilab:image>fchamp();</scilab:image>
133                     </para>
134                 </listitem>
135             </varlistentry>
136             <varlistentry>
137                 <term>
138                     <link linkend="contour2d">contour2d</link>
139                 </term>
140                 <listitem>
141                     <para>Level curves of a surface on a 2D plot</para>
142                 </listitem>
143             </varlistentry>
144             <varlistentry>
145                 <term>
146                     <link linkend="fcontour2d">fcontour2d</link>
147                 </term>
148                 <listitem>
149                     <para>Level curves of a surface defined by a function on a 2D plot</para>
150                     <para>
151                         <emphasis role="bold">Example:</emphasis>
152                     </para>
153                     <para>
154                         <scilab:image>fcontour2d();</scilab:image>
155                     </para>
156                 </listitem>
157             </varlistentry>
158             <varlistentry>
159                 <term>
160                     <link linkend="grayplot">grayplot</link>
161                 </term>
162                 <listitem>
163                     <para>2D plot of a surface using colors</para>
164                     <para>
165                         <emphasis role="bold">Example:</emphasis>
166                     </para>
167                     <para>
168                         <scilab:image>grayplot();</scilab:image>
169                     </para>
170                 </listitem>
171             </varlistentry>
172             <varlistentry>
173                 <term>
174                     <link linkend="fgrayplot">fgrayplot</link>
175                 </term>
176                 <listitem>
177                     <para>2D plot of a surface defined by a function using colors</para>
178                     <para>
179                         <emphasis role="bold">Example:</emphasis>
180                     </para>
181                     <para>
182                         <scilab:image>fgrayplot();</scilab:image>
183                     </para>
184                 </listitem>
185             </varlistentry>
186             <varlistentry>
187                 <term>
188                     <link linkend="Sgrayplot">Sgrayplot</link>
189                 </term>
190                 <listitem>
191                     <para>Smooth 2D plot of a surface using colors</para>
192                     <para>
193                         <emphasis role="bold">Example:</emphasis>
194                     </para>
195                     <para>
196                         <scilab:image>Sgrayplot();</scilab:image>
197                     </para>
198                 </listitem>
199             </varlistentry>
200             <varlistentry>
201                 <term>
202                     <link linkend="Sfgrayplot">Sfgrayplot</link>
203                 </term>
204                 <listitem>
205                     <para>Smooth 2D plot of a surface defined by a function using colors</para>
206                     <para>
207                         <emphasis role="bold">Example:</emphasis>
208                     </para>
209                     <para>
210                         <scilab:image>Sfgrayplot();</scilab:image>
211                     </para>
212                 </listitem>
213             </varlistentry>
214             <varlistentry>
215                 <term>
216                     <link linkend="xgrid">xgrid</link>
217                 </term>
218                 <listitem>
219                     <para>Add a grid on a 2D plot</para>
220                     <para>
221                         <emphasis role="bold">Example:</emphasis>
222                     </para>
223                     <para>
224                         <scilab:image>x=[0:0.1:2*%pi]'; plot2d(sin(x));xgrid(5)</scilab:image>
225                     </para>
226                 </listitem>
227             </varlistentry>
228             <varlistentry>
229                 <term>
230                     <link linkend="errbar">errbar</link>
231                 </term>
232                 <listitem>
233                     <para>Add vertical error bars on a 2D plot</para>
234                     <para>
235                         <emphasis role="bold">Example:</emphasis>
236                     </para>
237                     <para>
238                         <scilab:image>errbar();</scilab:image>
239                     </para>
240                 </listitem>
241             </varlistentry>
242             <varlistentry>
243                 <term>
244                     <link linkend="histplot">histplot</link>
245                 </term>
246                 <listitem>
247                     <para>Plot a histogram</para>
248                     <para>
249                         <emphasis role="bold">Example:</emphasis>
250                     </para>
251                     <para>
252                         <scilab:image>histplot();</scilab:image>
253                     </para>
254                 </listitem>
255             </varlistentry>
256             <varlistentry>
257                 <term>
258                     <link linkend="Matplot">Matplot</link>
259                 </term>
260                 <listitem>
261                     <para>2D plot of a matrix using colors</para>
262                     <para>
263                         <emphasis role="bold">Example:</emphasis>
264                     </para>
265                     <para>
266                         <scilab:image>Matplot();</scilab:image>
267                     </para>
268                 </listitem>
269             </varlistentry>
270         </variablelist>
271     </refsection>
272     <refsection>
273         <title>3d plotting</title>
274         <variablelist>
275             <varlistentry>
276                 <term>
277                     <link linkend="plot3d">plot3d</link>
278                 </term>
279                 <listitem>
280                     <para>Plot a surface</para>
281                     <para>
282                         <emphasis role="bold">Example:</emphasis>
283                     </para>
284                     <para>
285                         <scilab:image>plot3d();</scilab:image>
286                     </para>
287                 </listitem>
288             </varlistentry>
289             <varlistentry>
290                 <term>
291                     <link linkend="plot3d1">plot3d1</link>
292                 </term>
293                 <listitem>
294                     <para>Plot a surface with gray or color level</para>
295                     <para>
296                         <emphasis role="bold">Example:</emphasis>
297                     </para>
298                     <para>
299                         <scilab:image>plot3d1();</scilab:image>
300                     </para>
301                 </listitem>
302             </varlistentry>
303             <varlistentry>
304                 <term>
305                     <link linkend="fplot3d">fplot3d</link>
306                 </term>
307                 <listitem>
308                     <para>Plot a surface defined by a function</para>
309                     <para>
310                         <emphasis role="bold">Example:</emphasis>
311                     </para>
312                     <para>
313                         <scilab:image>fplot3d();</scilab:image>
314                     </para>
315                 </listitem>
316             </varlistentry>
317             <varlistentry>
318                 <term>
319                     <link linkend="fplot3d1">fplot3d1</link>
320                 </term>
321                 <listitem>
322                     <para>Plot a surface defined by a function with gray or color level</para>
323                     <para>
324                         <emphasis role="bold">Example:</emphasis>
325                     </para>
326                     <para>
327                         <scilab:image>fplot3d1();</scilab:image>
328                     </para>
329                 </listitem>
330             </varlistentry>
331             <varlistentry>
332                 <term>
333                     <link linkend="param3d">param3d</link>
334                 </term>
335                 <listitem>
336                     <para>Plot one curve</para>
337                     <para>
338                         <emphasis role="bold">Example:</emphasis>
339                     </para>
340                     <para>
341                         <scilab:image>param3d();</scilab:image>
342                     </para>
343                 </listitem>
344             </varlistentry>
345             <varlistentry>
346                 <term>
347                     <link linkend="param3d1">param3d1</link>
348                 </term>
349                 <listitem>
350                     <para>Plots curves</para>
351                     <para>
352                         <emphasis role="bold">Example:</emphasis>
353                     </para>
354                     <para>
355                         <scilab:image>param3d1();</scilab:image>
356                     </para>
357                 </listitem>
358             </varlistentry>
359             <varlistentry>
360                 <term>
361                     <link linkend="contour">contour</link>
362                 </term>
363                 <listitem>
364                     <para>Level curves on a 3D surface</para>
365                     <para>
366                         <emphasis role="bold">Example:</emphasis>
367                     </para>
368                     <para>
369                         <scilab:image>contour();</scilab:image>
370                     </para>
371                 </listitem>
372             </varlistentry>
373             <varlistentry>
374                 <term>
375                     <link linkend="fcontour">fcontour</link>
376                 </term>
377                 <listitem>
378                     <para>Level curves on a 3D surface defined by a function</para>
379                     <para>
380                         <emphasis role="bold">Example:</emphasis>
381                     </para>
382                     <para>
383                         <scilab:image>fcontour();</scilab:image>
384                     </para>
385                 </listitem>
386             </varlistentry>
387             <varlistentry>
388                 <term>
389                     <link linkend="hist3d">hist3d</link>
390                 </term>
391                 <listitem>
392                     <para>3D representation of a histogram</para>
393                     <para>
394                         <emphasis role="bold">Example:</emphasis>
395                     </para>
396                     <para>
397                         <scilab:image>hist3d();</scilab:image>
398                     </para>
399                 </listitem>
400             </varlistentry>
401             <varlistentry>
402                 <term>
403                     <link linkend="genfac3d">genfac3d</link>
404                 </term>
405                 <listitem>
406                     <para>Compute facets of a 3D surface</para>
407                     <para>
408                         <emphasis role="bold">Example:</emphasis>
409                     </para>
410                     <para>
411                         <scilab:image>genfac3d();</scilab:image>
412                     </para>
413                 </listitem>
414             </varlistentry>
415             <varlistentry>
416                 <term>
417                     <link linkend="eval3dp">eval3dp</link>
418                 </term>
419                 <listitem>
420                     <para>Compute facets of a 3D surface</para>
421                     <para>
422                         <emphasis role="bold">Example:</emphasis>
423                     </para>
424                     <para>
425                         <scilab:image>p1=linspace(0,2*%pi,10);
426                             p2=linspace(0,2*%pi,10);
427                             deff("[x,y,z]=scp(p1,p2)",["x=p1.*sin(p1).*cos(p2)";..
428                             "y=p1.*cos(p1).*cos(p2)";..
429                             "z=p1.*sin(p2)"])
430                             [Xf,Yf,Zf]=eval3dp(scp,p1,p2);
431                             plot3d(Xf,Yf,Zf)
432                         </scilab:image>
433                     </para>
434                 </listitem>
435             </varlistentry>
436             <varlistentry>
437                 <term>
438                     <link linkend="geom3d">geom3d</link>
439                 </term>
440                 <listitem>
441                     <para>Projection from 3D on 2D after a 3D plot</para>
442                     <para>
443                         <emphasis role="bold">Example:</emphasis>
444                     </para>
445                     <para>
446                         <scilab:image>deff("[z]=surface(x,y)","z=sin(x)*cos(y)")
447                             t=%pi*(-10:10)/10;
448                             // 3D plot of the surface
449                             fplot3d(t,t,surface,35,45,"X@Y@Z")
450                             // now (t,t,sin(t).*cos(t)) is a curve on the surface
451                             // which can be drawn using geom3d and xpoly
452                             [x,y]=geom3d(%pi/2,0,surface(%pi/2,0))
453                         </scilab:image>
454                     </para>
455                 </listitem>
456             </varlistentry>
457         </variablelist>
458     </refsection>
459     <refsection>
460         <title>Line and polygon plotting</title>
461         <variablelist>
462             <varlistentry>
463                 <term>
464                     <link linkend="xpoly">xpoly</link>
465                 </term>
466                 <listitem>
467                     <para>Draw a polyline or a polygon</para>
468                 </listitem>
469             </varlistentry>
470             <varlistentry>
471                 <term>
472                     <link linkend="xpolys">xpolys</link>
473                 </term>
474                 <listitem>
475                     <para>Draw a set of polylines or polygons</para>
476                 </listitem>
477             </varlistentry>
478             <varlistentry>
479                 <term>
480                     <link linkend="xrpoly">xrpoly</link>
481                 </term>
482                 <listitem>
483                     <para>Draw a regular polygon</para>
484                 </listitem>
485             </varlistentry>
486             <varlistentry>
487                 <term>
488                     <link linkend="xsegs">xsegs</link>
489                 </term>
490                 <listitem>
491                     <para>Draw unconnected segments</para>
492                 </listitem>
493             </varlistentry>
494             <varlistentry>
495                 <term>
496                     <link linkend="xfpoly">xfpoly</link>
497                 </term>
498                 <listitem>
499                     <para>Fill a polygon</para>
500                 </listitem>
501             </varlistentry>
502             <varlistentry>
503                 <term>
504                     <link linkend="xfpolys">xfpolys</link>
505                 </term>
506                 <listitem>
507                     <para>Fill a set of polygons</para>
508                 </listitem>
509             </varlistentry>
510         </variablelist>
511     </refsection>
512     <refsection>
513         <title>Rectangle plotting</title>
514         <variablelist>
515             <varlistentry>
516                 <term>
517                     <link linkend="xrect">xrect</link>
518                 </term>
519                 <listitem>
520                     <para>Draw a rectangle</para>
521                 </listitem>
522             </varlistentry>
523             <varlistentry>
524                 <term>
525                     <link linkend="xfrect">xfrect</link>
526                 </term>
527                 <listitem>
528                     <para>Fill a rectangle</para>
529                 </listitem>
530             </varlistentry>
531             <varlistentry>
532                 <term>
533                     <link linkend="xrects">xrects</link>
534                 </term>
535                 <listitem>
536                     <para>Draw or fill a set of rectangles</para>
537                 </listitem>
538             </varlistentry>
539         </variablelist>
540     </refsection>
541     <refsection>
542         <title>Arc plotting</title>
543         <variablelist>
544             <varlistentry>
545                 <term>
546                     <link linkend="xarc">xarc</link>
547                 </term>
548                 <listitem>
549                     <para>Draw a part of an ellipse</para>
550                 </listitem>
551             </varlistentry>
552             <varlistentry>
553                 <term>
554                     <link linkend="xarcs">xarcs</link>
555                 </term>
556                 <listitem>
557                     <para>Draw parts of a set of ellipses</para>
558                 </listitem>
559             </varlistentry>
560             <varlistentry>
561                 <term>
562                     <link linkend="xfarc">xfarc</link>
563                 </term>
564                 <listitem>
565                     <para>Fill a part of an ellipse</para>
566                 </listitem>
567             </varlistentry>
568             <varlistentry>
569                 <term>
570                     <link linkend="xfarcs">xfarcs</link>
571                 </term>
572                 <listitem>
573                     <para>Fill parts of a set of ellipses</para>
574                 </listitem>
575             </varlistentry>
576         </variablelist>
577     </refsection>
578     <refsection>
579         <title>Arrow plotting</title>
580         <variablelist>
581             <varlistentry>
582                 <term>
583                     <link linkend="xarrows">xarrows</link>
584                 </term>
585                 <listitem>
586                     <para>Draw a set of arrows</para>
587                 </listitem>
588             </varlistentry>
589         </variablelist>
590     </refsection>
591     <refsection>
592         <title>Strings</title>
593         <variablelist>
594             <varlistentry>
595                 <term>
596                     <link linkend="xstring">xstring</link>
597                 </term>
598                 <listitem>
599                     <para>Draw strings</para>
600                 </listitem>
601             </varlistentry>
602             <varlistentry>
603                 <term>
604                     <link linkend="xstringl">xstringl</link>
605                 </term>
606                 <listitem>
607                     <para>Compute a box which surrounds strings</para>
608                 </listitem>
609             </varlistentry>
610             <varlistentry>
611                 <term>
612                     <link linkend="xstringb">xstringb</link>
613                 </term>
614                 <listitem>
615                     <para>Draw strings into a box</para>
616                     <para>
617                         <emphasis role="bold">Example:</emphasis>
618                     </para>
619                     <para>
620                         <scilab:image>xstringb();</scilab:image>
621                     </para>
622                 </listitem>
623             </varlistentry>
624             <varlistentry>
625                 <term>
626                     <link linkend="xtitle">xtitle</link>
627                 </term>
628                 <listitem>
629                     <para>Add titles on a graphics window</para>
630                     <para>
631                         <emphasis role="bold">Example:</emphasis>
632                     </para>
633                     <para>
634                         <scilab:image>xtitle();</scilab:image>
635                     </para>
636                 </listitem>
637             </varlistentry>
638             <varlistentry>
639                 <term>
640                     <link linkend="titlepage">titlepage</link>
641                 </term>
642                 <listitem>
643                     <para>Add a title in the middle of a graphics window</para>
644                 </listitem>
645             </varlistentry>
646             <varlistentry>
647                 <term>
648                     <link linkend="xinfo">xinfo</link>
649                 </term>
650                 <listitem>
651                     <para>Draw an info string in the message subwindow</para>
652                 </listitem>
653             </varlistentry>
654         </variablelist>
655     </refsection>
656     <refsection>
657         <title>Frames and axes</title>
658         <variablelist>
659             <varlistentry>
660                 <term>
661                     <link linkend="drawaxis">drawaxis</link>
662                 </term>
663                 <listitem>
664                     <para>Draw an axis</para>
665                 </listitem>
666             </varlistentry>
667             <varlistentry>
668                 <term>
669                     <link linkend="graduate">graduate</link>
670                 </term>
671                 <listitem>
672                     <para>Pretty axis graduations</para>
673                 </listitem>
674             </varlistentry>
675             <varlistentry>
676                 <term>
677                     <link linkend="plotframe">plotframe</link>
678                 </term>
679                 <listitem>
680                     <para>
681                         Plot a frame with scaling and grids
682                         <warning>
683                             This function is obsolete.
684                         </warning>
685                     </para>
686                 </listitem>
687             </varlistentry>
688         </variablelist>
689     </refsection>
690     <refsection>
691         <title>Coordinates transformations</title>
692         <variablelist>
693             <varlistentry>
694                 <term>
695                     <link linkend="isoview">isoview</link>
696                 </term>
697                 <listitem>
698                     <para>
699                         Set scales for isometric plot (do not change the size
700                         of the window)
701                         <warning>
702                             This function is obsolete.
703                         </warning>
704                     </para>
705                 </listitem>
706             </varlistentry>
707             <varlistentry>
708                 <term>
709                     <link linkend="square">square</link>
710                 </term>
711                 <listitem>
712                     <para>Set scales for isometric plot (change the size of the window)</para>
713                 </listitem>
714             </varlistentry>
715             <varlistentry>
716                 <term>
717                     <link linkend="scaling">scaling</link>
718                 </term>
719                 <listitem>
720                     <para>Affine transformation of a set of points</para>
721                 </listitem>
722             </varlistentry>
723             <varlistentry>
724                 <term>
725                     <link linkend="rotate">rotate</link>
726                 </term>
727                 <listitem>
728                     <para>Rotation of a set of points</para>
729                 </listitem>
730             </varlistentry>
731             <varlistentry>
732                 <term>
733                     <link linkend="xsetech">xsetech</link>
734                 </term>
735                 <listitem>
736                     <para>Set the sub-window of a graphics window for plotting</para>
737                 </listitem>
738             </varlistentry>
739             <varlistentry>
740                 <term>
741                     <link linkend="subplot">subplot</link>
742                 </term>
743                 <listitem>
744                     <para>Divide a graphics window into a matrix of sub-windows</para>
745                 </listitem>
746             </varlistentry>
747             <varlistentry>
748                 <term>
749                     <link linkend="xgetech">xgetech</link>
750                 </term>
751                 <listitem>
752                     <para>Get the current graphics scale</para>
753                 </listitem>
754             </varlistentry>
755             <varlistentry>
756                 <term>
757                     <link linkend="xchange">xchange</link>
758                 </term>
759                 <listitem>
760                     <para>Transform real to pixel coordinates</para>
761                 </listitem>
762             </varlistentry>
763         </variablelist>
764     </refsection>
765     <refsection>
766         <title>Colors</title>
767         <variablelist>
768             <varlistentry>
769                 <term>
770                     <link linkend="colormap">colormap</link>
771                 </term>
772                 <listitem>
773                     <para>Using colormaps</para>
774                 </listitem>
775             </varlistentry>
776             <varlistentry>
777                 <term>
778                     <link linkend="getcolor">getcolor</link>
779                 </term>
780                 <listitem>
781                     <para>Dialog to select colors in the current colormap</para>
782                 </listitem>
783             </varlistentry>
784             <varlistentry>
785                 <term>
786                     <link linkend="addcolor">addcolor</link>
787                 </term>
788                 <listitem>
789                     <para>Add new colors to the current colormap</para>
790                 </listitem>
791             </varlistentry>
792             <varlistentry>
793                 <term>
794                     <link linkend="graycolormap">graycolormap</link>
795                 </term>
796                 <listitem>
797                     <para>Linear gray colormap</para>
798                 </listitem>
799             </varlistentry>
800             <varlistentry>
801                 <term>
802                     <link linkend="hotcolormap">hotcolormap</link>
803                 </term>
804                 <listitem>
805                     <para>Red to yellow colormap</para>
806                 </listitem>
807             </varlistentry>
808         </variablelist>
809     </refsection>
810     <refsection>
811         <title>Graphics context</title>
812         <variablelist>
813             <varlistentry>
814                 <term>
815                     <link linkend="xset">xset</link>
816                 </term>
817                 <listitem>
818                     <para>
819                         Set values of the graphics context
820                         <warning>
821                             This function is obsolete.
822                         </warning>
823                     </para>
824                 </listitem>
825             </varlistentry>
826             <varlistentry>
827                 <term>
828                     <link linkend="xget">xget</link>
829                 </term>
830                 <listitem>
831                     <para>
832                         Get current values of the graphics context
833                         <warning>
834                             This function is obsolete.
835                         </warning>
836                     </para>
837                 </listitem>
838             </varlistentry>
839             <varlistentry>
840                 <term>
841                     <link linkend="xlfont">xlfont</link>
842                 </term>
843                 <listitem>
844                     <para>Load a font in the graphics context or query loaded font</para>
845                 </listitem>
846             </varlistentry>
847         </variablelist>
848     </refsection>
849     <refsection>
850         <title>Save and load</title>
851         <variablelist>
852             <varlistentry>
853                 <term>
854                     <link linkend="xsave">xsave</link>
855                 </term>
856                 <listitem>
857                     <para>Save graphics into a file</para>
858                 </listitem>
859             </varlistentry>
860             <varlistentry>
861                 <term>
862                     <link linkend="xload">xload</link>
863                 </term>
864                 <listitem>
865                     <para>Load a saved graphics</para>
866                 </listitem>
867             </varlistentry>
868             <varlistentry>
869                 <term>
870                     <link linkend="xs2bmp">xs2bmp</link>
871                 </term>
872                 <listitem>
873                     <para>Export graphics using the BMP format</para>
874                 </listitem>
875             </varlistentry>
876             <varlistentry>
877                 <term>
878                     <link linkend="xs2emf">xs2emf</link>
879                 </term>
880                 <listitem>
881                     <para>
882                         Export graphics using the EMF format
883                         <warning>
884                             Only under Windows.
885                         </warning>
886                     </para>
887                 </listitem>
888             </varlistentry>
889             <varlistentry>
890                 <term>
891                     <link linkend="xs2eps">xs2eps</link>
892                 </term>
893                 <listitem>
894                     <para>Export graphics using the EPS format</para>
895                 </listitem>
896             </varlistentry>
897             <varlistentry>
898                 <term>
899                     <link linkend="xs2gif">xs2gif</link>
900                 </term>
901                 <listitem>
902                     <para>Export graphics using the GIF format</para>
903                 </listitem>
904             </varlistentry>
905             <varlistentry>
906                 <term>
907                     <link linkend="xs2jpg">xs2jpg</link>
908                 </term>
909                 <listitem>
910                     <para>Export graphics using the JPG format</para>
911                 </listitem>
912             </varlistentry>
913             <varlistentry>
914                 <term>
915                     <link linkend="xs2pdf">xs2pdf</link>
916                 </term>
917                 <listitem>
918                     <para>Export graphics using the PDF format</para>
919                 </listitem>
920             </varlistentry>
921             <varlistentry>
922                 <term>
923                     <link linkend="xs2png">xs2png</link>
924                 </term>
925                 <listitem>
926                     <para>Export graphics using the PNG format</para>
927                 </listitem>
928             </varlistentry>
929             <varlistentry>
930                 <term>
931                     <link linkend="xs2ppm">xs2ppm</link>
932                 </term>
933                 <listitem>
934                     <para>Export graphics using the PPM format</para>
935                 </listitem>
936             </varlistentry>
937             <varlistentry>
938                 <term>
939                     <link linkend="xs2ps">xs2ps</link>
940                 </term>
941                 <listitem>
942                     <para>Export graphics using the PS format</para>
943                 </listitem>
944             </varlistentry>
945             <varlistentry>
946                 <term>
947                     <link linkend="xs2svg">xs2svg</link>
948                 </term>
949                 <listitem>
950                     <para>Export graphics using the SVG format</para>
951                 </listitem>
952             </varlistentry>
953         </variablelist>
954     </refsection>
955     <refsection>
956         <title>Graphics primitives</title>
957         <variablelist>
958             <varlistentry>
959                 <term>
960                     <link linkend="clf">clf</link>
961                 </term>
962                 <listitem>
963                     <para>
964                         Clear or reset the current graphic figure (window) to default values
965                     </para>
966                 </listitem>
967             </varlistentry>
968             <varlistentry>
969                 <term>
970                     <link linkend="xclear">xclear</link>
971                 </term>
972                 <listitem>
973                     <para>
974                         Clear a graphics window
975                         <warning>
976                             Function <function>xclear</function> is obsolete.
977                         </warning>
978                     </para>
979                 </listitem>
980             </varlistentry>
981             <varlistentry>
982                 <term>
983                     <link linkend="driver">driver</link>
984                 </term>
985                 <listitem>
986                     <para>Select a graphics driver</para>
987                 </listitem>
988             </varlistentry>
989             <varlistentry>
990                 <term>
991                     <link linkend="xinit">xinit</link>
992                 </term>
993                 <listitem>
994                     <para>Initialisation of a graphics driver</para>
995                 </listitem>
996             </varlistentry>
997             <varlistentry>
998                 <term>
999                     <link linkend="xend">xend</link>
1000                 </term>
1001                 <listitem>
1002                     <para>Close a graphics session</para>
1003                 </listitem>
1004             </varlistentry>
1005             <varlistentry>
1006                 <term>
1007                     <link linkend="replot">replot</link>
1008                 </term>
1009                 <listitem>
1010                     <para>Redraw the current graphics window with new boundaries</para>
1011                 </listitem>
1012             </varlistentry>
1013             <varlistentry>
1014                 <term>
1015                     <link linkend="xpause">xpause</link>
1016                 </term>
1017                 <listitem>
1018                     <para>Suspend Scilab</para>
1019                 </listitem>
1020             </varlistentry>
1021             <varlistentry>
1022                 <term>
1023                     <link linkend="show_window">show_window</link>
1024                 </term>
1025                 <listitem>
1026                     <para>Raise the current graphics window</para>
1027                 </listitem>
1028             </varlistentry>
1029             <varlistentry>
1030                 <term>
1031                     <link linkend="xdel">xdel</link>
1032                 </term>
1033                 <listitem>
1034                     <para>Delete a graphics window</para>
1035                 </listitem>
1036             </varlistentry>
1037             <varlistentry>
1038                 <term>
1039                     <link linkend="winsid">winsid</link>
1040                 </term>
1041                 <listitem>
1042                     <para>Return the list of graphics windows</para>
1043                 </listitem>
1044             </varlistentry>
1045             <varlistentry>
1046                 <term>
1047                     <link linkend="xname">xname</link>
1048                 </term>
1049                 <listitem>
1050                     <para>Change the name of the current graphics window</para>
1051                 </listitem>
1052             </varlistentry>
1053         </variablelist>
1054     </refsection>
1055     <refsection>
1056         <title>Mouse position</title>
1057         <variablelist>
1058             <varlistentry>
1059                 <term>
1060                     <link linkend="xclick">xclick</link>
1061                 </term>
1062                 <listitem>
1063                     <para>
1064                         Wait for a mouse click or an event in a graphic window
1065                     </para>
1066                 </listitem>
1067             </varlistentry>
1068             <varlistentry>
1069                 <term>
1070                     <link linkend="locate">locate</link>
1071                 </term>
1072                 <listitem>
1073                     <para>Mouse selection of a set of points</para>
1074                 </listitem>
1075             </varlistentry>
1076             <varlistentry>
1077                 <term>
1078                     <link linkend="xgetmouse">xgetmouse</link>
1079                 </term>
1080                 <listitem>
1081                     <para>Get the mouse events and current position</para>
1082                 </listitem>
1083             </varlistentry>
1084         </variablelist>
1085     </refsection>
1086     <refsection>
1087         <title>Interactive editor</title>
1088         <variablelist>
1089             <varlistentry>
1090                 <term>
1091                     <link linkend="edit_curv">edit_curv</link>
1092                 </term>
1093                 <listitem>
1094                     <para>Interactive graphics curve editor</para>
1095                 </listitem>
1096             </varlistentry>
1097         </variablelist>
1098     </refsection>
1099     <refsection>
1100         <title>Graphics functions for automatic control</title>
1101         <variablelist>
1102             <varlistentry>
1103                 <term>
1104                     <link linkend="bode">bode</link>
1105                 </term>
1106                 <listitem>
1107                     <para>Bode plot</para>
1108                     <para>
1109                         <emphasis role="bold">Example:</emphasis>
1110                     </para>
1111                     <para>
1112                         <scilab:image>s=poly(0,'s')
1113                             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
1114                             clf();bode(h,0.01,100);
1115                         </scilab:image>
1116                     </para>
1117                 </listitem>
1118             </varlistentry>
1119             <varlistentry>
1120                 <term>
1121                     <link linkend="gainplot">gainplot</link>
1122                 </term>
1123                 <listitem>
1124                     <para>Magnitude plot</para>
1125                     <para>
1126                         <emphasis role="bold">Example:</emphasis>
1127                     </para>
1128                     <para>
1129                         <scilab:image>s=poly(0,'s')
1130                             h1=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
1131                             h2=syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
1132                             clf();gainplot([h1;h2],0.01,100,['h1';'h2'])
1133                             title('Gainplot');
1134                         </scilab:image>
1135                     </para>
1136                 </listitem>
1137             </varlistentry>
1138             <varlistentry>
1139                 <term>
1140                     <link linkend="nyquist">nyquist</link>
1141                 </term>
1142                 <listitem>
1143                     <para>Nyquist plot</para>
1144                     <para>
1145                         <emphasis role="bold">Example:</emphasis>
1146                     </para>
1147                     <para>
1148                         <scilab:image>s=poly(0,'s')
1149                             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01));
1150                             h1=h*syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
1151                             nyquist(h1)
1152                             ax=gca();
1153                             h_h=ax.children($).children(2);
1154                             tip=datatipCreate(h_h,[1.331,0.684]);
1155                             datatipSetOrientation(tip,"upper left");
1156                         </scilab:image>
1157                     </para>
1158                 </listitem>
1159             </varlistentry>
1160             <varlistentry>
1161                 <term>
1162                     <link linkend="m_circle">m_circle</link>
1163                 </term>
1164                 <listitem>
1165                     <para>
1166                         Plot the complex plane iso-gain contours of y/(1+y)
1167                         <warning>
1168                             This function is obsolete.
1169                         </warning>
1170                     </para>
1171                     <para>
1172                         <emphasis role="bold">Example:</emphasis>
1173                     </para>
1174                     <para>
1175                         <scilab:image>m_circle();</scilab:image>
1176                     </para>
1177                 </listitem>
1178             </varlistentry>
1179             <varlistentry>
1180                 <term>
1181                     <link linkend="hallchart">hallchart</link>
1182                 </term>
1183                 <listitem>
1184                     <para>
1185                         Hall chart
1186                     </para>
1187                     <para>
1188                         <emphasis role="bold">Example:</emphasis>
1189                     </para>
1190                     <para>
1191                         <scilab:image localized="true">hallchart();</scilab:image>
1192                     </para>
1193                 </listitem>
1194             </varlistentry>
1195             <varlistentry>
1196                 <term>
1197                     <link linkend="nicholschart">nicholschart</link>
1198                 </term>
1199                 <listitem>
1200                     <para>Nichols chart</para>
1201                     <para>
1202                         <emphasis role="bold">Example:</emphasis>
1203                     </para>
1204                     <para>
1205                         <scilab:image localized="true">nicholschart();</scilab:image>
1206                     </para>
1207                 </listitem>
1208             </varlistentry>
1209             <varlistentry>
1210                 <term>
1211                     <link linkend="black">black</link>
1212                 </term>
1213                 <listitem>
1214                     <para>Black's diagram</para>
1215                     <para>
1216                         <emphasis role="bold">Example:</emphasis>
1217                     </para>
1218                     <para>
1219                         <scilab:image localized="true">s=poly(0,'s');
1220                             sl=syslin('c',5*(1+s)/(.1*s^4+s^3+15*s^2+3*s+1))
1221                             clf();black(sl,0.01,10);
1222                         </scilab:image>
1223                     </para>
1224                 </listitem>
1225             </varlistentry>
1226             <varlistentry>
1227                 <term>
1228                     <link linkend="evans">evans</link>
1229                 </term>
1230                 <listitem>
1231                     <para>Evans root locus</para>
1232                     <para>
1233                         <emphasis role="bold">Example:</emphasis>
1234                     </para>
1235                     <para>
1236                         <scilab:image localized="true">evans();</scilab:image>
1237                     </para>
1238                 </listitem>
1239             </varlistentry>
1240             <varlistentry>
1241                 <term>
1242                     <link linkend="sgrid">sgrid</link>
1243                 </term>
1244                 <listitem>
1245                     <para>s-plane grid lines</para>
1246                     <para>
1247                         <emphasis role="bold">Example:</emphasis>
1248                     </para>
1249                     <para>
1250                         <scilab:image localized="true">sgrid(0:0.2:1,[0.2 0.6 1 1.7 2])</scilab:image>
1251                     </para>
1252                 </listitem>
1253             </varlistentry>
1254             <varlistentry>
1255                 <term>
1256                     <link linkend="plzr">plzr</link>
1257                 </term>
1258                 <listitem>
1259                     <para>pole-zero plot</para>
1260                     <para>
1261                         <emphasis role="bold">Example:</emphasis>
1262                     </para>
1263                     <para>
1264                         <scilab:image localized="true">s=poly(0,'s');
1265                             n=[1+s   2+3*s+4*s^2        5; 0        1-s             s];
1266                             d=[1+3*s   5-s^3           s+1;1+s     1+s+s^2      3*s-1];
1267                             h=syslin('c',n./d);
1268                             plzr(h);
1269                         </scilab:image>
1270                     </para>
1271                 </listitem>
1272             </varlistentry>
1273             <varlistentry>
1274                 <term>
1275                     <link linkend="zgrid">zgrid</link>
1276                 </term>
1277                 <listitem>
1278                     <para>zgrid plot</para>
1279                     <para>
1280                         <emphasis role="bold">Example:</emphasis>
1281                     </para>
1282                     <para>
1283                         <scilab:image localized="true">zgrid();</scilab:image>
1284                     </para>
1285                 </listitem>
1286             </varlistentry>
1287         </variablelist>
1288     </refsection>
1289 </refentry>