1PLSHADES(3plplot) PLplot API PLSHADES(3plplot)
2
6 plshades - Shade regions on the basis of value
7
9 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel,
10 fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
11
13 Shade regions on the basis of value. This is the high-level routine
14 for making continuous color shaded plots with cmap1 while
15 plshade(3plplot) (or plshade1(3plplot)) are used for individual shaded
16 regions using either cmap0 or cmap1. examples/c/x16c.c shows a number
17 of examples for using this function. See the following discussion of
18 the arguments and the PLplot documentation for more information.
19 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
21 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
22 pltr_data) Perl/PDL: plshades(a, xmin, xmax, ymin, ymax, clevel,
23 fill_width, cont_color, cont_width, fill, rectangular, defined, pltr,
24 pltr_data)
25 This function is used in examples 16,21.
28
30 a (PLFLT **, input)
31 Contains ** pointer to array to be plotted. The array must have
32 been declared as PLFLT a[nx][ny].
33 nx (PLINT, input)
35 First dimension of array "a".
36 ny (PLINT, input)
38 Second dimension of array "a".
39 defined (PLINT (*) (PLFLT, PLFLT), input)
41 User function specifying regions excluded from the shading plot.
42 This function accepts x and y coordinates as input arguments and
43 must return 0 if the point is in the excluded region or 1 other‐
44 wise. This argument can be NULL if all the values are valid.
45 xmin (PLFLT, input)
47 Defines the "grid" coordinates. The data a[0][0] has a position
48 of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so
49 on.
50 xmax (PLFLT, input)
52 Defines the "grid" coordinates. The data a[0][0] has a position
53 of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so
54 on.
55 ymin (PLFLT, input)
57 Defines the "grid" coordinates. The data a[0][0] has a position
58 of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so
59 on.
60 ymax (PLFLT, input)
62 Defines the "grid" coordinates. The data a[0][0] has a position
63 of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so
64 on.
65 clevel (PLFLT *, input)
67 Pointer to array containing the data levels corresponding to the
68 edges of each shaded region that will be plotted by this func‐
69 tion. To work properly the levels should be monotonic.
70 nlevel (PLINT, input)
72 Number of shades plus 1 (i.e., the number of shade edge values
73 in clevel).
74 fill_width (PLINT, input)
76 Defines width used by the fill pattern.
77 cont_color (PLINT, input)
79 Defines pen color used for contours defining edges of shaded
80 regions. The pen color is only temporary set for the contour
81 drawing. Set this value to zero or less if no shade edge con‐
82 tours are wanted.
83 cont_width (PLINT, input)
85 Defines pen width used for contours defining edges of shaded
86 regions. This value may not be honored by all drivers. The pen
87 width is only temporary set for the contour drawing. Set this
88 value to zero or less if no shade edge contours are wanted.
89 fill (void (*) (PLINT, PLFLT *, PLFLT *), input)
91 Routine used to fill the region. Use plfill(3plplot). Future
92 version of PLplot may have other fill routines.
93 rectangular (PLBOOL, input)
95 Set rectangular to true if rectangles map to rectangles after
96 coordinate transformation with pltrl. Otherwise, set rectangu‐
97 lar to false. If rectangular is set to true, plshade tries to
98 save time by filling large rectangles. This optimization fails
99 if the coordinate transformation distorts the shape of rectan‐
100 gles. For example a plot in polar coordinates has to have rec‐
101 tangular set to false.
102 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input)
104 Pointer to function that defines transformation between indices
105 in array z and the world coordinates (C only). Transformation
106 functions are provided in the PLplot library: pltr0(3plplot) for
107 identity mapping, and pltr1(3plplot) and pltr2(3plplot) for
108 arbitrary mappings respectively defined by one- and two-dimen‐
109 sional arrays. In addition, user-supplied routines for the
110 transformation can be used as well. Examples of all of these
111 approaches are given in the PLplot documentation. The transfor‐
112 mation function should have the form given by any of
113 pltr0(3plplot), pltr1(3plplot), or pltr2(3plplot).
114 pltr_data (PLPointer, input)
116 Extra parameter to help pass information to pltr0(3plplot),
117 pltr1(3plplot), pltr2(3plplot), or whatever routine that is
118 externally supplied.
119
122 Geoffrey Furnish and Maurice LeBrun wrote and maintain PLplot. This
123 man page was automatically generated from the DocBook source of the
124 PLplot documentation, maintained by Alan W. Irwin and Rafael
125 Laboissiere.
126
128 PLplot documentation at http://plplot.sourceforge.net/resources.
129 July, 2010 PLSHADES(3plplot)