← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/graphics/Matplot.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/graphics/Matplot.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>Matplot</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="Matplot"> 2D plot of a matrix using colors</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>Matplot(a,[strf,rect,nax])  </CALLING_SEQUENCE_ITEM>
 
11
    <CALLING_SEQUENCE_ITEM>Matplot(a,&lt;opt_args&gt;)  </CALLING_SEQUENCE_ITEM>
 
12
  </CALLING_SEQUENCE>
 
13
  <PARAM>
 
14
    <PARAM_INDENT>
 
15
      <PARAM_ITEM>
 
16
        <PARAM_NAME>a</PARAM_NAME>
 
17
        <PARAM_DESCRIPTION>
 
18
          <SP>: real matrix of size (n1,n2).</SP>
 
19
        </PARAM_DESCRIPTION>
 
20
      </PARAM_ITEM>
 
21
      <PARAM_ITEM>
 
22
        <PARAM_NAME>&lt;opt_args&gt;  </PARAM_NAME>
 
23
        <PARAM_DESCRIPTION>
 
24
          <SP>: This represents a sequence of statements <VERB>key1=value1, key2=value2</VERB>,... where <VERB>key1</VERB>, <VERB>key2,...</VERB> can be one of the following:</SP>
 
25
          <PARAM_INDENT>
 
26
            <PARAM_ITEM>
 
27
              <PARAM_NAME>rect</PARAM_NAME>
 
28
              <PARAM_DESCRIPTION>
 
29
                <SP>: sets the bounds of the plot. If this key is given and neither <VERB>frameflag</VERB> nor <VERB>strf</VERB> is  given then the <VERB>y</VERB> character of <VERB>strf</VERB> is supposed to be <VERB>7</VERB>.  See below for value.</SP>
 
30
              </PARAM_DESCRIPTION>
 
31
            </PARAM_ITEM>
 
32
            <PARAM_ITEM>
 
33
              <PARAM_NAME>nax</PARAM_NAME>
 
34
              <PARAM_DESCRIPTION>
 
35
                <SP>: sets the grids definition. If this key is given and neither <VERB>axesflag</VERB> nor <VERB>strf</VERB> is given then the <VERB>z</VERB> character of <VERB>strf</VERB> is supposed to be <VERB>1</VERB>.  See below for value.</SP>
 
36
              </PARAM_DESCRIPTION>
 
37
            </PARAM_ITEM>
 
38
            <PARAM_ITEM>
 
39
              <PARAM_NAME>frameflag</PARAM_NAME>
 
40
              <PARAM_DESCRIPTION>
 
41
                <SP>: specifies how the frame of the plot is computed. The value is an integer ranging from 0 to 8. It corresponds to the <VERB>y</VERB> character of <VERB>strf</VERB>. See below.</SP>
 
42
              </PARAM_DESCRIPTION>
 
43
            </PARAM_ITEM>
 
44
            <PARAM_ITEM>
 
45
              <PARAM_NAME>axesflag</PARAM_NAME>
 
46
              <PARAM_DESCRIPTION>
 
47
                <SP>: specifies what kind of axes are drawn around the plot. The value is an integer ranging from 0 to 5. It corresponds to the <VERB>z</VERB> character of <VERB>strf</VERB>. See below.</SP>
 
48
              </PARAM_DESCRIPTION>
 
49
            </PARAM_ITEM>
 
50
          </PARAM_INDENT>
 
51
        </PARAM_DESCRIPTION>
 
52
      </PARAM_ITEM>
 
53
      <PARAM_ITEM>
 
54
        <PARAM_NAME>strf</PARAM_NAME>
 
55
        <PARAM_DESCRIPTION>
 
56
          <SP>:  is a string of length 3 <VERB>&quot;xyz&quot;</VERB>.</SP>
 
57
          <PARAM_INDENT>
 
58
            <PARAM_ITEM>
 
59
              <PARAM_NAME>default</PARAM_NAME>
 
60
              <PARAM_DESCRIPTION>
 
61
                <SP>The default is <VERB>&quot;081&quot;</VERB>.</SP>
 
62
              </PARAM_DESCRIPTION>
 
63
            </PARAM_ITEM>
 
64
            <PARAM_ITEM>
 
65
              <PARAM_NAME>x</PARAM_NAME>
 
66
              <PARAM_DESCRIPTION>
 
67
                <SP>: controls the display of captions.</SP>
 
68
                <PARAM_INDENT>
 
69
                  <PARAM_ITEM>
 
70
                    <PARAM_NAME>x=0</PARAM_NAME>
 
71
                    <PARAM_DESCRIPTION>
 
72
                      <SP>: no caption.</SP>
 
73
                    </PARAM_DESCRIPTION>
 
74
                  </PARAM_ITEM>
 
75
                  <PARAM_ITEM>
 
76
                    <PARAM_NAME>x=1</PARAM_NAME>
 
77
                    <PARAM_DESCRIPTION>
 
78
                      <SP>: captions are displayed. They are given by the optional argument <VERB>leg</VERB>.</SP>
 
79
                    </PARAM_DESCRIPTION>
 
80
                  </PARAM_ITEM>
 
81
                </PARAM_INDENT>
 
82
              </PARAM_DESCRIPTION>
 
83
            </PARAM_ITEM>
 
84
            <PARAM_ITEM>
 
85
              <PARAM_NAME>y</PARAM_NAME>
 
86
              <PARAM_DESCRIPTION>
 
87
                <SP>: controls the computation of the actual coordinate ranges from the minimal requested values. Actual ranges can be larger than minimal requirements.</SP>
 
88
                <PARAM_INDENT>
 
89
                  <PARAM_ITEM>
 
90
                    <PARAM_NAME>y=0</PARAM_NAME>
 
91
                    <PARAM_DESCRIPTION>
 
92
                      <SP>: no computation, the plot use the previus (or default) scale</SP>
 
93
                    </PARAM_DESCRIPTION>
 
94
                  </PARAM_ITEM>
 
95
                  <PARAM_ITEM>
 
96
                    <PARAM_NAME>y=1</PARAM_NAME>
 
97
                    <PARAM_DESCRIPTION>
 
98
                      <SP>: from the rect arg</SP>
 
99
                    </PARAM_DESCRIPTION>
 
100
                  </PARAM_ITEM>
 
101
                  <PARAM_ITEM>
 
102
                    <PARAM_NAME>y=2</PARAM_NAME>
 
103
                    <PARAM_DESCRIPTION>
 
104
                      <SP>: from the min/max of the x, y datas</SP>
 
105
                    </PARAM_DESCRIPTION>
 
106
                  </PARAM_ITEM>
 
107
                  <PARAM_ITEM>
 
108
                    <PARAM_NAME>y=3</PARAM_NAME>
 
109
                    <PARAM_DESCRIPTION>
 
110
                      <SP>: built for an isometric scale from the rect arg</SP>
 
111
                    </PARAM_DESCRIPTION>
 
112
                  </PARAM_ITEM>
 
113
                  <PARAM_ITEM>
 
114
                    <PARAM_NAME>y=4</PARAM_NAME>
 
115
                    <PARAM_DESCRIPTION>
 
116
                      <SP>: built for an isometric plot from the min/max of the x, y datas</SP>
 
117
                    </PARAM_DESCRIPTION>
 
118
                  </PARAM_ITEM>
 
119
                  <PARAM_ITEM>
 
120
                    <PARAM_NAME>y=5</PARAM_NAME>
 
121
                    <PARAM_DESCRIPTION>
 
122
                      <SP>: enlarged for pretty axes from the rect arg</SP>
 
123
                    </PARAM_DESCRIPTION>
 
124
                  </PARAM_ITEM>
 
125
                  <PARAM_ITEM>
 
126
                    <PARAM_NAME>y=6</PARAM_NAME>
 
127
                    <PARAM_DESCRIPTION>
 
128
                      <SP>: enlarged for pretty axes from  the min/max of the x, y datas</SP>
 
129
                    </PARAM_DESCRIPTION>
 
130
                  </PARAM_ITEM>
 
131
                  <PARAM_ITEM>
 
132
                    <PARAM_NAME>y=7</PARAM_NAME>
 
133
                    <PARAM_DESCRIPTION>
 
134
                      <SP>: like y=1 but the previus plot(s) are redrawn to use the new scale</SP>
 
135
                    </PARAM_DESCRIPTION>
 
136
                  </PARAM_ITEM>
 
137
                  <PARAM_ITEM>
 
138
                    <PARAM_NAME>y=8</PARAM_NAME>
 
139
                    <PARAM_DESCRIPTION>
 
140
                      <SP>: like y=2 but the previus plot(s) are redrawn to use the new scale</SP>
 
141
                    </PARAM_DESCRIPTION>
 
142
                  </PARAM_ITEM>
 
143
                </PARAM_INDENT>
 
144
              </PARAM_DESCRIPTION>
 
145
            </PARAM_ITEM>
 
146
            <PARAM_ITEM>
 
147
              <PARAM_NAME>z</PARAM_NAME>
 
148
              <PARAM_DESCRIPTION>
 
149
                <SP>: controls the display of information on the frame around the plot. If axes are requested, the number of tics can be specified by the <VERB>nax</VERB> optional argument.</SP>
 
150
                <PARAM_INDENT>
 
151
                  <PARAM_ITEM>
 
152
                    <PARAM_NAME>z=0</PARAM_NAME>
 
153
                    <PARAM_DESCRIPTION>
 
154
                      <SP>:  nothing is drawn around the plot.</SP>
 
155
                    </PARAM_DESCRIPTION>
 
156
                  </PARAM_ITEM>
 
157
                  <PARAM_ITEM>
 
158
                    <PARAM_NAME>z=1</PARAM_NAME>
 
159
                    <PARAM_DESCRIPTION>
 
160
                      <SP>:  axes are drawn, the y=axis is displayed on the left.</SP>
 
161
                    </PARAM_DESCRIPTION>
 
162
                  </PARAM_ITEM>
 
163
                  <PARAM_ITEM>
 
164
                    <PARAM_NAME>z=2</PARAM_NAME>
 
165
                    <PARAM_DESCRIPTION>
 
166
                      <SP>:  the plot is surrounded by a box without tics.</SP>
 
167
                    </PARAM_DESCRIPTION>
 
168
                  </PARAM_ITEM>
 
169
                  <PARAM_ITEM>
 
170
                    <PARAM_NAME>z=3</PARAM_NAME>
 
171
                    <PARAM_DESCRIPTION>
 
172
                      <SP>:  axes are drawn, the y=axis is displayed on the right.</SP>
 
173
                    </PARAM_DESCRIPTION>
 
174
                  </PARAM_ITEM>
 
175
                  <PARAM_ITEM>
 
176
                    <PARAM_NAME>z=4</PARAM_NAME>
 
177
                    <PARAM_DESCRIPTION>
 
178
                      <SP>:  axes are drawn centred in the middle of the frame box.</SP>
 
179
                    </PARAM_DESCRIPTION>
 
180
                  </PARAM_ITEM>
 
181
                  <PARAM_ITEM>
 
182
                    <PARAM_NAME>z=5</PARAM_NAME>
 
183
                    <PARAM_DESCRIPTION>
 
184
                      <SP>:  axes are drawn so as to cross at point <VERB>(0,0)</VERB>.  If point <VERB>(0,0)</VERB> does not lie inside the frame, axes will not appear on the graph.</SP>
 
185
                    </PARAM_DESCRIPTION>
 
186
                  </PARAM_ITEM>
 
187
                </PARAM_INDENT>
 
188
              </PARAM_DESCRIPTION>
 
189
            </PARAM_ITEM>
 
190
          </PARAM_INDENT>
 
191
        </PARAM_DESCRIPTION>
 
192
      </PARAM_ITEM>
 
193
      <PARAM_ITEM>
 
194
        <PARAM_NAME>rect</PARAM_NAME>
 
195
        <PARAM_DESCRIPTION>
 
196
          <SP>:  This argument is used when the second character y of argument <VERB>strf</VERB> is 1, 3 or 5. It is a row vector of size 4 and gives the dimension of the frame:  <VERB>rect=[xmin,ymin,xmax,ymax]</VERB>.</SP>
 
197
        </PARAM_DESCRIPTION>
 
198
      </PARAM_ITEM>
 
199
      <PARAM_ITEM>
 
200
        <PARAM_NAME>nax</PARAM_NAME>
 
201
        <PARAM_DESCRIPTION>
 
202
          <SP>:  This argument is used when the third character z of argument <VERB>strf</VERB> is 1. It is a row vector with four entries <VERB>[nx,Nx,ny,Ny]</VERB> where <VERB>nx</VERB> (<VERB>ny</VERB>) is the number of subgraduations on the x (y) axis and <VERB>Nx</VERB> (<VERB>Ny</VERB>) is the number of graduations on the x (y) axis.</SP>
 
203
        </PARAM_DESCRIPTION>
 
204
      </PARAM_ITEM>
 
205
    </PARAM_INDENT>
 
206
  </PARAM>
 
207
  <DESCRIPTION>
 
208
    <P>
 
209
    The entries of matrix <VERB>int(a)</VERB> are used as colormap entries in 
 
210
    the current colormap. The color associated to <VERB>a(i,j)</VERB> is used 
 
211
    do draw a small square of length 1 with center at location 
 
212
    <VERB>(x=j,y=(n1-i+1))</VERB>.</P>
 
213
    <P>
 
214
    Enter the command <VERB>Matplot()</VERB> to see a demo.</P>
 
215
  </DESCRIPTION>
 
216
  <EXAMPLE>
 
217
<![CDATA[
 
218
Matplot([1 2 3;4 5 6])
 
219
// draw the current colormap 
 
220
Matplot((1:xget("lastpattern")))
 
221
 ]]>
 
222
  </EXAMPLE>
 
223
  <SEE_ALSO>
 
224
    <SEE_ALSO_ITEM>
 
225
      <LINK>colormap</LINK>
 
226
    </SEE_ALSO_ITEM>
 
227
    <SEE_ALSO_ITEM>
 
228
      <LINK>plot2d</LINK>
 
229
    </SEE_ALSO_ITEM>
 
230
    <SEE_ALSO_ITEM>
 
231
      <LINK>Matplot1</LINK>
 
232
    </SEE_ALSO_ITEM>
 
233
  </SEE_ALSO>
 
234
  <AUTHOR>J.Ph.C.  </AUTHOR>
 
235
</MAN>