← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/graphics/champ.man

  • 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/graphics/champ.man
1
 
.TH champ 2 "April 1993" "Scilab Group" "Scilab Function" 
2
 
.so ../sci.an
3
 
.SH NAME
4
 
champ - 2D vector field plot
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
champ(x,y,fx,fy,[arfact,rect,strf])
8
 
champ(x,y,fx,fy,<opt_args>)
9
 
.fi
10
 
.SH PARAMETERS
11
 
.TP 8
12
 
x,y
13
 
: two vectors which define the grid.
14
 
.TP
15
 
fx
16
 
: a matrix which describes the x component of the vector field. \fVfx(i,j)\fR
17
 
is the x component of the vector field at point \fV(x(i),y(j))\fR.
18
 
.TP 
19
 
fy
20
 
: a matrix which describes the y component of the vector field. \fVfy(i,j)\fR
21
 
is the y component of the vector field at point \fV(x(i),y(j))\fR.
22
 
.TP
23
 
<opt_args>
24
 
: This represents a sequence of statements \fVkey1=value1,
25
 
key2=value2\fR,... where \fVkey1\fR, \fVkey2,...\fR can be one of the
26
 
following: arfact, rect, strf (see below).
27
 
.TP
28
 
arfact
29
 
: an optional argument of type real which gives a scale factor for the display of the arrow heads on the plot (default value is 1.0).
30
 
.TP
31
 
rect
32
 
: a vector \fVrect=[xmin,ymin,xmax,ymax]\fR which gives the boundaries of the 
33
 
graphics frame to use.
34
 
.TP
35
 
strf 
36
 
: a string of length 3 "xyz" which has the same meaning as the \fVstrf\fR
37
 
parameter of \fVplot2d\fR. The first character x has no effect with \fVchamp\fR.
38
 
.SH DESCRIPTION 
39
 
\fVchamp\fR draws a 2D vector field. The length 
40
 
of the arrows is proportional to the intensity of the field.
41
 
 
42
 
If you want colored arrows with the color of the arrows depending on the 
43
 
intensity of the field, use \fVchamp1\fR.
44
 
 
45
 
Enter the command \fVchamp()\fR to see a demo.
46
 
.SH EXAMPLE
47
 
.nf 
48
 
// using rect as plot boundaries 
49
 
champ(-5:5,-5:5,rand(11,11),rand(11,11),1,[-10,-10,10,10],"011")
50
 
// using (x,y) to get boundaries 
51
 
xbasc()
52
 
champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
53
 
.fi
54
 
.SH SEE ALSO
55
 
champ1, fchamp, plot2d
56
 
.SH AUTHOR
57
 
J.Ph.C.