File: surf.xml

package info (click to toggle)
scilab-plotlib 0.42-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch, wheezy
  • size: 5,716 kB
  • sloc: xml: 3,506; makefile: 15
file content (136 lines) | stat: -rw-r--r-- 4,363 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?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="surf" xml:lang="en">
  <info>
    <pubdate>$LastChangedDate: 26-05-2009 $</pubdate>
  </info>
  <refnamediv>
    <refname>surf</refname>
    <refpurpose>Display 3-D color surface</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>hdl = surf(X,Y,Z,C)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameter</title>
    <variablelist>
      <varlistentry>
        <term>X</term>
        <listitem>
          <para>1 by m matrix or n by m matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Y</term>
        <listitem>
          <para>1 by n matrix or n by m matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Z</term>
        <listitem>
          <para>n by m matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>C</term>
        <listitem>
          <para>n by m matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>hdl</term>
        <listitem>
          <para>Handle of the created Fac3d entity</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>surf(x,y,Z,C) plots the colored parametric or non parametric surface
    defined by four arguments. The view point is specified by the 'view'
    proporty (see below).</para>
    <para>surf(X,Y,Z) uses C = Z, so color is proportional to surface
    height.</para>
    <para>The entries of C are scaled to correspond to the
    current colormap entries.The color of edges is given by the default
    foreground and can be changed by the properties 'edgecolor' . The color of
    faces is flat by default or interpolated. Use the 'facecolor' property (see
    examples below). The actual mapping of C values to colors depends on the
    colormap and the color axis (see colormap, caxis).</para>
    <para>When x,y and Z are matrices of the same size, surf(x,y,Z) plots the
    parametric surface defined by vertices (x(i,j), y(i,j), Z(i,j)).</para>
    <para>When x,y are vector arguments you must have length(x) = n and
    length(y) = m where [m,n] = size(Z).In this case, the vertices of the
    surface lines are the triples (x(j), y(i), Z(i,j)). Note that x
    corresponds to the columns of Z and y corresponds to the rows, example
    :</para>
    <programlisting>x=linspace(-1,1,20); y=linspace(-2,2,40);
Z=cos(y'*x);
surf(x,y,Z);</programlisting>
    <para>Note that surf(Z) uses x = 1:m and y = 1:n</para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example">
[u,v]=meshgrid(linspace(0,%pi,50),linspace(%pi/4,%pi,25));
x=sin(v).*cos(u);
y=sin(v).*sin(u);
z=cos(v);
drawlater
surf(x,y,z,x,'facecolor','interp','edgecolor','none');
hold on
surf(x,-y,z,rand(z));
hold off
axis equal;
colormap cool
drawnow
</programlisting>
  </refsection>
  <refsection>
    <title>Screenshot</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="surf.png"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="plot">plot</link>
      </member>
      <member>
        <link linkend="plot3">plot3</link>
      </member>
      <member>
        <link linkend="surf">surf</link>
      </member>
      <member>
        <link linkend="colormap">colormap</link>
      </member>
      <member>
        <link linkend="shading">shading</link>
      </member>
      <member>
        <link linkend="caxis">caxis</link>
      </member>
      <member>
        <link linkend="colorbar">colorbar</link>
      </member>
    </simplelist>
  </refsection>
  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>Stphane Mottelet</member>
    </simplelist>
  </refsection>
</refentry>