1PLVECT(3plplot)                   PLplot API                   PLVECT(3plplot)
2
3
4

NAME

6       plvect - Vector plot
7

SYNOPSIS

9       plvect(u, v, nx, ny, scale, pltr, pltr_data)
10

DESCRIPTION

12       Draws  a  vector  plot of the vector (u[nx][ny],v[nx][ny]). The scaling
13       factor for the vectors is given  by  scale.  A  transformation  routine
14       pointed  to  by  pltr  with  a  pointer  pltr_data  for additional data
15       required by the transformation routine is used to  map  indices  within
16       the  array  to the world coordinates. The style of the vector arrow may
17       be set using plsvect(3plplot).
18
19       Redacted form: plvect(u, v, scale, pltr, pltr_data)
20
21       This function is used in example 22.
22

ARGUMENTS

24       u, v (PLFLT **, input)
25              Pointers to a pair of vectored two-dimensional arrays containing
26              the x and y components of the vector data to be plotted.
27
28       nx, ny (PLINT, input)
29              Physical dimensions of the arrays u and v.
30
31       scale (PLFLT, input)
32              Parameter to control the scaling factor of the vectors for plot‐
33              ting. If scale = 0 then the scaling factor is automatically cal‐
34              culated  for  the  data. If scale < 0 then the scaling factor is
35              automatically calculated for the data  and  then  multiplied  by
36              -scale. If scale > 0 then the scaling factor is set to scale.
37
38       pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input)
39              Pointer  to function that defines transformation between indices
40              in array z and the world coordinates (C  only).   Transformation
41              functions are provided in the PLplot library: pltr0(3plplot) for
42              identity mapping,  and  pltr1(3plplot)  and  pltr2(3plplot)  for
43              arbitrary  mappings  respectively defined by one- and two-dimen‐
44              sional arrays.  In  addition,  user-supplied  routines  for  the
45              transformation  can  be  used as well.  Examples of all of these
46              approaches are given in the PLplot documentation. The  transfor‐
47              mation   function   should   have  the  form  given  by  any  of
48              pltr0(3plplot), pltr1(3plplot), or pltr2(3plplot).
49
50       pltr_data (PLPointer, input)
51              Extra parameter to  help  pass  information  to  pltr0(3plplot),
52              pltr1(3plplot),  pltr2(3plplot),  or  whatever  routine  that is
53              externally supplied.
54
55

AUTHORS

57       Geoffrey Furnish and Maurice LeBrun wrote and  maintain  PLplot.   This
58       man  page  was  automatically  generated from the DocBook source of the
59       PLplot  documentation,  maintained  by  Alan  W.   Irwin   and   Rafael
60       Laboissiere.
61

SEE ALSO

63       PLplot documentation at http://plplot.sourceforge.net/resources.
64
65
66
67                                  March, 2007                  PLVECT(3plplot)
Impressum