File: quiver.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 (99 lines) | stat: -rw-r--r-- 3,075 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
<?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="quiver" xml:lang="en">
  <info>
    <pubdate>$LastChangedDate: 26-05-2009 $</pubdate>
  </info>
  <refnamediv>
    <refname>quiver</refname>
    <refpurpose>2D vector field plot</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>hdl = quiver(X,Y,U,V,fact)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameter</title>
    <variablelist>
      <varlistentry>
        <term>X</term>
        <listitem>
          <para>1 by n matrix or n by n matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Y</term>
        <listitem>
          <para>1 by n matrix or n by n matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>U</term>
        <listitem>
          <para>n by n matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>V</term>
        <listitem>
          <para>n by n matrix</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>fact</term>
        <listitem>
          <para>scalar</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>quiver(X,Y,U,V) plots vector field with cartesian coordinaes (U,V)
    defined on a parametric or non parametric mesh defined by (X,Y) (see e.g.
    surf for a discussion about the relative sizes of X and Y). The vectors
    are automatically scaled to fit in the grid defined by X and Y.</para>
    <para>The last argument 'fact' is a scale factor for the vectors, if you
    want to change the length of vectors. If you don't want any scaling at
    all, use fact=0.</para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example">[X,Y]=meshgrid(linspace(-1,1,20),linspace(-1,1,20));
quiver(X,Y,-X,Y,'og');
legend('(-x,y) field');
</programlisting>
  </refsection>
  <refsection>
    <title>Screenshot</title>
    <screenshot>
      <mediaobject>
        <imageobject>
          <imagedata fileref="quiver.png"/>
        </imageobject>
      </mediaobject>
    </screenshot>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="quiver3">quiver3</link>
      </member>
    </simplelist>
  </refsection>
  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>Stphane Mottelet</member>
    </simplelist>
  </refsection>
</refentry>