File: _plotlib.xml

package info (click to toggle)
scilab-plotlib 0.41-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 3,196 kB
  • sloc: xml: 3,308; makefile: 15
file content (94 lines) | stat: -rw-r--r-- 6,666 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 * Ajouter ici d'ventuels commentaires sur le fichier XML
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="xxxxx_plotlib" xml:lang="en">
  <info>
    <pubdate>$LastChangedDate: 26-05-2009 $</pubdate>
  </info>
  <refnamediv>
    <refname>Plotlib 0.4</refname>
    <refpurpose>Overview of plotlib features</refpurpose>
	<para>This library aims to emulate Matlab graphics features, i.e. macros and property/value pairs. Some 
	already existing Scilab macros already correctly emulate the Matlab ones and were not considered in the Plotlib.</para>
  </refnamediv>
   <refsection>
    <title>Recall of the Matlab-like native Scilab macros</title>
    <para><link linkend="axis">title</link> - add a title to a given or current Axes</para>
    <para><link linkend="axis">xlabel</link> - add a label on the X axis to a given or current Axes</para>
    <para><link linkend="axis">ylabel</link> - add a label on the Y axis to a given or current Axes</para>
    <para><link linkend="axis">zlabel</link> - add a label on the Z axis to a given or current Axes</para>
  </refsection>
  <refsection>
    <title>Plotlib general functions</title>
    <para><link linkend="plotlibmode">plotlibmode</link> - plotlib compatibility mode</para>
    <para><link linkend="axis">axis</link> - set/get the axis limits and type</para>
    <para><link linkend="figure">figure</link> - creates/activates a figure</para>
    <para><link linkend="grid">grid</link> - add/toggle a grid on a graph</para>
    <para><link linkend="hold">hold</link> - holds/releases current plot</para>
    <para><link linkend="legend">legend</link> - adds a legend</para>
    <para><link linkend="shg">shg</link> - brings a window on the foreground</para>
    <para><link linkend="subplot">subplot</link> - Create axes in tiled positions.</para>
    <para><link linkend="subplot">drawnow</link> - Flushed postponed graphics commands.</para>
  </refsection>
  <refsection>
    <title>Plotlib 2D functions</title>
    <para><link linkend="pcolor">pcolor</link> - 2D pseudo color patches</para>
    <para><link linkend="plot">plot</link> - generic plot function.</para>
    <para><link linkend="plotyy">plotyy</link> - generic plot function.</para>
    <para><link linkend="fill">fill</link> - fill 2D polygons</para>
    <para><link linkend="loglog">loglog</link> - plot with logarihtmic x andy scale</para>
    <para><link linkend="quiver">quiver</link> - vector field plot</para>
    <para><link linkend="semilogx">semilogx</link> - plot with logarihtmic x scale</para>
    <para><link linkend="semilogy">semilogy</link> - plot with logarihtmic y scale</para>
    <para><link linkend="tripcolor">tripcolor</link> - 2D pseudo color patches based on a triangulation</para>
	<para><link linkend="triplot">triplot</link> - plot 2D mesh based on a triabgulation</para>
  </refsection>
  <refsection>
    <title>Plotlib 3D functions</title>
    <para><link linkend="fill3">fill3</link> - fill 3D polygons</para>
    <para><link linkend="plot3">plot3</link> - Plot lines and points in 3-D space.</para>
    <para><link linkend="mesh">mesh</link> - 3D mesh surface.</para>
    <para><link linkend="surf">surf</link> - 3D colored surface.</para>
    <para><link linkend="surfl">surfl</link> - 3D surface with lighting</para>
    <para><link linkend="quiver3">quiver3</link> - 3d vector field defined on a surface</para>
    <para><link linkend="trimesh">trimesh</link> - 3D surface mesh based on a triangulation</para>
    <para><link linkend="trisurf">trisurf</link> - 3D colored surface based on a triangulation</para>
    <para><link linkend="trisurfl">trisurfl</link> - 3D surface based on a triangulation, with lighting</para>
    <para><link linkend="view">view</link> - sets the view point</para>
  </refsection>
  <refsection>
    <title>Plotlib Color management</title>
	<para>The plotlib differentiates the colormap used for axes, polyline and other linear entities and the colormap for pesudo-color
2D and surface plots. The actual color of such entities is determined by their CData and CDataMapping properties and by the CLim and CLimMode
properties of the parent Axes. When CLimMode is equal to 'auto' the the CLim property changes dynamically as entites are added or removed from the Axes.</para>
    <para><link linkend="caxis">caxis</link> - set/get color axis</para>
    <para><link linkend="colormap">colormap</link> - Set/get the colormap of currently active figure</para>
    <para><link linkend="colorbar">colorbar</link> - Adds a colorbar</para>
    <para><link linkend="shading">shading</link> - Change the shading model</para>
    <para><link linkend="whitebg">whitebg</link> - Set the default color scheme</para>
  </refsection>
  <refsection>
    <title>Plotlib new graphic objects properties</title>
    <para>The new properties of graphical entities are fields of the user_data field and a Plotlib graphic handle is just a Scilab native graphic handle encapsulated in a mlist of type "pltlibH". By using the overloading features of Scilab, these two kinds of handles can be read or changed transparently by using the set and get macros. The native Scilab graphic properties of the encapsulated handle are also transparently read or changed by these two macros.</para> 
    <para>The default display function %pltlibH_p for plotlib handles just gives the type of the handle. To display and/or get a single property, you can use the get function or the . field operator. Idem for the set operation :</para>
          <programlisting role="example">h=surfl()
z=get(h,'ZData');
z=h.ZData;
set(h,'CData',z);
h.CData=rand(z);</programlisting>
<para>You can get more than one property value at a time, by using a vector of strings, or get all properties by omitting the property. In both cases, get returns a struct with corresponding fieldnames.</para>
<programlisting role="example">h=pcolor()
get(h,['FaceColor','EdgeColor'])
get(h)</programlisting>
    <para><link linkend="leaf_properties">Leaf properties</link> - Leaf properties</para>
    <para><link linkend="axes_properties">Axes properties</link> - Axes properties</para>
    <para><link linkend="figure_properties">Figure properties</link> - Figure properties</para>
 </refsection>
 <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>Stphane Mottelet</member>
    </simplelist>
  </refsection>
</refentry>