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

« back to all changes in this revision

Viewing changes to man/graphics/champ1.cat

  • 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
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
champ1            Scilab Group            Scilab Function            champ1
2
 
NAME
3
 
   champ1 - 2D vector field plot with colored arrows
4
 
  
5
 
CALLING SEQUENCE
6
 
 champ1(x,y,fx,fy,[arfact,rect,strf])
7
 
PARAMETERS
8
 
 x,y      : two vectors which define the grid.
9
 
          
10
 
 fx       : a matrix which describes the x component of the vector field.
11
 
          fx(i,j) is the x component of the vector field at point
12
 
          (x(i),y(j)).
13
 
          
14
 
 fy       : a matrix which describes the y component of the vector field.
15
 
          fy(i,j) is the y component of the vector field at point
16
 
          (x(i),y(j)).
17
 
          
18
 
 arfact   : an optional argument of type real which gives a scale factor
19
 
          for the display of the arrow heads on the plot (default value is
20
 
          1.0).
21
 
          
22
 
 rect     : a vector rect=[xmin,ymin,xmax,ymax] which gives the boundaries
23
 
          of the  graphics frame to use.
24
 
          
25
 
 strf     : a string of length 3 "xyz" which has the same meaning as the
26
 
          strf parameter of plot2d. The first character x has no effect
27
 
          with champ1.
28
 
          
29
 
DESCRIPTION
30
 
   champ1 draws a 2D vector field with colored arrows. The color of the 
31
 
  arrows depends on the intensity of the field.  If you want arrows
32
 
  proportional to the intensity of the field, use champ.  Enter the command
33
 
  champ1() to see a demo.
34
 
  
35
 
EXAMPLE
36
 
 xset("use color",1)
37
 
 champ1(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
38
 
SEE ALSO
39
 
   champ, fchamp, plot2d
40
 
  
41
 
AUTHOR
42
 
   J.Ph.C.
43