11 from sys
import version_info
12 if version_info >= (2,6,0):
14 from os.path
import dirname
18 fp, pathname, description = imp.find_module(
'_plplotc', [dirname(__file__)])
24 _mod = imp.load_module(
'_plplotc', fp, pathname, description)
29 del swig_import_helper
34 _swig_property = property
38 if (name ==
"thisown"):
return self.this.own(value)
40 if type(value).__name__ ==
'SwigPyObject':
41 self.__dict__[name] = value
43 method = class_type.__swig_setmethods__.get(name,
None)
44 if method:
return method(self,value)
46 self.__dict__[name] = value
48 raise AttributeError(
"You cannot add attributes to %s" % self)
54 if (name ==
"thisown"):
return self.this.own()
55 method = class_type.__swig_getmethods__.get(name,
None)
56 if method:
return method(self)
57 raise AttributeError(name)
60 try: strthis =
"proxy of " + self.this.__repr__()
62 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
67 except AttributeError:
74 return _plplotc.pltr0(*args)
75 pltr0 = _plplotc.pltr0
78 return _plplotc.pltr1(*args)
79 pltr1 = _plplotc.pltr1
82 return _plplotc.pltr2(*args)
83 pltr2 = _plplotc.pltr2
84 PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
85 PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
86 PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
87 PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
88 PLESC_RESIZE = _plplotc.PLESC_RESIZE
89 PLESC_REDRAW = _plplotc.PLESC_REDRAW
90 PLESC_TEXT = _plplotc.PLESC_TEXT
91 PLESC_GRAPH = _plplotc.PLESC_GRAPH
92 PLESC_FILL = _plplotc.PLESC_FILL
93 PLESC_DI = _plplotc.PLESC_DI
94 PLESC_FLUSH = _plplotc.PLESC_FLUSH
95 PLESC_EH = _plplotc.PLESC_EH
96 PLESC_GETC = _plplotc.PLESC_GETC
97 PLESC_SWIN = _plplotc.PLESC_SWIN
98 PLESC_PLFLTBUFFERING = _plplotc.PLESC_PLFLTBUFFERING
99 PLESC_XORMOD = _plplotc.PLESC_XORMOD
100 PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
101 PLESC_CLEAR = _plplotc.PLESC_CLEAR
102 PLESC_DASH = _plplotc.PLESC_DASH
103 PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
104 PLESC_IMAGE = _plplotc.PLESC_IMAGE
105 PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
106 DRAW_LINEX = _plplotc.DRAW_LINEX
107 DRAW_LINEY = _plplotc.DRAW_LINEY
108 DRAW_LINEXY = _plplotc.DRAW_LINEXY
109 MAG_COLOR = _plplotc.MAG_COLOR
110 BASE_CONT = _plplotc.BASE_CONT
111 TOP_CONT = _plplotc.TOP_CONT
112 SURF_CONT = _plplotc.SURF_CONT
113 DRAW_SIDES = _plplotc.DRAW_SIDES
114 FACETED = _plplotc.FACETED
116 PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
117 PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
118 PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
119 PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
120 PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
121 PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
122 PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
123 PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
124 PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
125 PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
126 PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
127 PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
128 PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
129 PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
130 PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
131 PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
132 PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
133 PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
134 PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
135 PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
136 PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
137 PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
138 PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
139 PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
140 PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
141 PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
142 PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
143 PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
144 PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
145 PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
146 PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
147 PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
148 PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
149 PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
150 PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
151 PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
152 PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
153 PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
154 PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
155 PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
156 PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
157 PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
158 PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
159 PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
160 PL_X_AXIS = _plplotc.PL_X_AXIS
161 PL_Y_AXIS = _plplotc.PL_Y_AXIS
162 PL_Z_AXIS = _plplotc.PL_Z_AXIS
163 PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
164 PL_OPT_ARG = _plplotc.PL_OPT_ARG
165 PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
166 PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
167 PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
168 PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
169 PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
170 PL_OPT_INT = _plplotc.PL_OPT_INT
171 PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
172 PL_OPT_STRING = _plplotc.PL_OPT_STRING
173 PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
174 PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
175 PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
176 PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
177 PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
178 PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
179 PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
180 PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
181 PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
182 PL_FCI_MARK = _plplotc.PL_FCI_MARK
183 PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
184 PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
185 PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
186 PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
187 PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
188 PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
189 PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
190 PL_FCI_SANS = _plplotc.PL_FCI_SANS
191 PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
192 PL_FCI_MONO = _plplotc.PL_FCI_MONO
193 PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
194 PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
195 PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
196 PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
197 PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
198 PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
199 PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
200 PL_MAXKEY = _plplotc.PL_MAXKEY
202 __swig_setmethods__ = {}
203 __setattr__ =
lambda self, name, value:
_swig_setattr(self, PLGraphicsIn, name, value)
204 __swig_getmethods__ = {}
206 __repr__ = _swig_repr
207 __swig_setmethods__[
"type"] = _plplotc.PLGraphicsIn_type_set
208 __swig_getmethods__[
"type"] = _plplotc.PLGraphicsIn_type_get
209 if _newclass:type =
_swig_property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
210 __swig_setmethods__[
"state"] = _plplotc.PLGraphicsIn_state_set
211 __swig_getmethods__[
"state"] = _plplotc.PLGraphicsIn_state_get
212 if _newclass:state =
_swig_property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
213 __swig_setmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_set
214 __swig_getmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_get
215 if _newclass:keysym =
_swig_property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
216 __swig_setmethods__[
"button"] = _plplotc.PLGraphicsIn_button_set
217 __swig_getmethods__[
"button"] = _plplotc.PLGraphicsIn_button_get
218 if _newclass:button =
_swig_property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
219 __swig_setmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_set
220 __swig_getmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_get
221 if _newclass:subwindow =
_swig_property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
222 __swig_setmethods__[
"string"] = _plplotc.PLGraphicsIn_string_set
223 __swig_getmethods__[
"string"] = _plplotc.PLGraphicsIn_string_get
224 if _newclass:string =
_swig_property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
225 __swig_setmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_set
226 __swig_getmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_get
227 if _newclass:pX =
_swig_property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
228 __swig_setmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_set
229 __swig_getmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_get
230 if _newclass:pY =
_swig_property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
231 __swig_setmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_set
232 __swig_getmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_get
233 if _newclass:dX =
_swig_property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
234 __swig_setmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_set
235 __swig_getmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_get
236 if _newclass:dY =
_swig_property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
237 __swig_setmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_set
238 __swig_getmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_get
239 if _newclass:wX =
_swig_property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
240 __swig_setmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_set
241 __swig_getmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_get
242 if _newclass:wY =
_swig_property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
244 this = _plplotc.new_PLGraphicsIn()
245 try: self.this.append(this)
247 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
248 __del__ =
lambda self :
None;
249 PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister
252 PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
253 PL_NOTSET = _plplotc.PL_NOTSET
254 PLESPLFLTBUFFERING_ENABLE = _plplotc.PLESPLFLTBUFFERING_ENABLE
255 PLESPLFLTBUFFERING_DISABLE = _plplotc.PLESPLFLTBUFFERING_DISABLE
256 PLESPLFLTBUFFERING_QUERY = _plplotc.PLESPLFLTBUFFERING_QUERY
257 GRID_CSA = _plplotc.GRID_CSA
258 GRID_DTLI = _plplotc.GRID_DTLI
259 GRID_NNI = _plplotc.GRID_NNI
260 GRID_NNIDW = _plplotc.GRID_NNIDW
261 GRID_NNLI = _plplotc.GRID_NNLI
262 GRID_NNAIDW = _plplotc.GRID_NNAIDW
265 return _plplotc.plsxwin(*args)
266 plsxwin = _plplotc.plsxwin
270 Set format of numerical label for contours
274 Set format of numerical label for contours.
276 Redacted form: pl_setcontlabelformat(lexp, sigdig)
278 This function is used example 9.
284 pl_setcontlabelformat(lexp, sigdig)
288 lexp (PLINT, input) : If the contour numerical label is greater
289 than 10^(lexp) or less than 10^(-lexp), then the exponential
290 format is used. Default value of lexp is 4.
292 sigdig (PLINT, input) : Number of significant digits. Default
296 return _plplotc.pl_setcontlabelformat(*args)
300 Set parameters of contour labelling other than format of numerical label
304 Set parameters of contour labelling other than those handled by
305 pl_setcontlabelformat.
307 Redacted form: pl_setcontlabelparam(offset, size, spacing, active)
309 This function is used in example 9.
315 pl_setcontlabelparam(offset, size, spacing, active)
319 offset (PLFLT, input) : Offset of label from contour line (if set
320 to 0.0, labels are printed on the lines). Default value is 0.006.
322 size (PLFLT, input) : Font height for contour labels (normalized).
323 Default value is 0.3.
325 spacing (PLFLT, input) : Spacing parameter for contour labels.
326 Default value is 0.1.
328 active (PLINT, input) : Activate labels. Set to 1 if you want
329 contour labels on. Default is off (0).
332 return _plplotc.pl_setcontlabelparam(*args)
336 Advance the (sub-)page
340 Advances to the next subpage if sub=0, performing a page advance if
341 there are no remaining subpages on the current page. If subpages
342 aren't being used, pladv(0) will always advance the page. If sub>0,
343 PLplot switches to the specified subpage. Note that this allows you
344 to overwrite a plot on the specified subpage; if this is not what you
345 intended, use pleop followed by plbop to first advance the page. This
346 routine is called automatically (with sub=0) by plenv, but if plenv is
347 not used, pladv must be called after initializing PLplot but before
348 defining the viewport.
350 Redacted form: pladv(sub)
352 This function is used in examples 1,2,4,6-12,14-18,20,21,23-27,29,31.
362 sub (PLINT, input) : Specifies the subpage number (starting from 1
363 in the top left corner and increasing along the rows) to which to
364 advance. Set to zero to advance to the next subpage.
367 return _plplotc.pladv(*args)
371 Draw a circular or elliptical arc
375 Draw a possibly filled arc centered at x, y with semimajor axis a and
376 semiminor axis b, starting at angle1 and ending at angle2.
378 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate,
382 This function is used in examples 3 and 27.
388 plarc(x, y, a, b, angle1, angle2, rotate, fill)
392 x (PLFLT, input) : X coordinate of arc center.
394 y (PLFLT, input) : Y coordinate of arc center.
396 a (PLFLT, input) : Length of the semimajor axis of the arc.
398 b (PLFLT, input) : Length of the semiminor axis of the arc.
400 angle1 (PLFLT, input) : Starting angle of the arc relative to the
403 angle2 (PLFLT, input) : Ending angle of the arc relative to the
406 rotate (PLFLT, input) : Angle of the semimajor axis relative to the
409 fill (PLBOOL, input) : Draw a filled arc.
412 return _plplotc.plarc(*args)
416 Draw a box with axes, etc. with arbitrary origin
420 Draws a box around the currently defined viewport with arbitrary
421 world-coordinate origin specified by x0 and y0 and labels it with
422 world coordinate values appropriate to the window. Thus plaxes should
423 only be called after defining both viewport and window. The character
424 strings xopt and yopt specify how the box should be drawn as described
425 below. If ticks and/or subticks are to be drawn for a particular
426 axis, the tick intervals and number of subintervals may be specified
427 explicitly, or they may be defaulted by setting the appropriate
430 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt,
432 Perl/PDL: plaxes(x0, y0, xtick, nxsub, ytick, nysub, xopt,
436 This function is not used in any examples.
442 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
446 x0 (PLFLT, input) : World X coordinate of origin.
448 y0 (PLFLT, input) : World Y coordinate of origin.
450 xopt (const char *, input) : Pointer to character string specifying
451 options for horizontal axis. The string can include any
452 combination of the following letters (upper or lower case) in any
453 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
454 is vertical line (x=0).
455 b: Draws bottom (X) or left (Y) edge of frame.
456 c: Draws top (X) or right (Y) edge of frame.
457 d: Plot labels as date / time. Values are assumed to be
458 seconds since the epoch (as used by gmtime).
459 f: Always use fixed point numeric labels.
460 g: Draws a grid at the major tick interval.
461 h: Draws a grid at the minor tick interval.
462 i: Inverts tick marks, so they are drawn outwards, rather than
464 l: Labels axis logarithmically. This only affects the labels,
465 not the data, and so it is necessary to compute the logarithms
466 of data points before passing them to any of the drawing
468 m: Writes numeric labels at major tick intervals in the
469 unconventional location (above box for X, right of box for Y).
470 n: Writes numeric labels at major tick intervals in the
471 conventional location (below box for X, left of box for Y).
472 o: Use custom labeling function to generate axis label text.
473 The custom labeling function can be defined with the
474 plslabelfuncplslabelfunc; command.
475 s: Enables subticks between major ticks, only valid if t is
477 t: Draws major ticks.
480 xtick (PLFLT, input) : World coordinate interval between major
481 ticks on the x axis. If it is set to zero, PLplot automatically
482 generates a suitable tick interval.
484 nxsub (PLINT, input) : Number of subintervals between major x axis
485 ticks for minor ticks. If it is set to zero, PLplot automatically
486 generates a suitable minor tick interval.
488 yopt (const char *, input) : Pointer to character string specifying
489 options for vertical axis. The string can include any combination
490 of the letters defined above for xopt, and in addition may
491 contain: v: Write numeric labels for vertical axis parallel to the
492 base of the graph, rather than parallel to the axis.
495 ytick (PLFLT, input) : World coordinate interval between major
496 ticks on the y axis. If it is set to zero, PLplot automatically
497 generates a suitable tick interval.
499 nysub (PLINT, input) : Number of subintervals between major y axis
500 ticks for minor ticks. If it is set to zero, PLplot automatically
501 generates a suitable minor tick interval.
504 return _plplotc.plaxes(*args)
508 Plot a histogram from binned data
512 Plots a histogram consisting of nbin bins. The value associated with
513 the i'th bin is placed in x[i], and the number of points in the bin is
514 placed in y[i]. For proper operation, the values in x[i] must form a
515 strictly increasing sequence. By default, x[i] is the left-hand edge
516 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
517 placed midway between the values in the x array. Also see plhist for
518 drawing histograms from unbinned data.
520 Redacted form: General: plbin(x, y, opt)
521 Perl/PDL: plbin(nbin, x, y, opt)
522 Python: plbin(nbin, x, y, opt)
525 This function is not used in any examples.
531 plbin(nbin, x, y, opt)
535 nbin (PLINT, input) : Number of bins (i.e., number of values in x
538 x (PLFLT *, input) : Pointer to array containing values associated
539 with bins. These must form a strictly increasing sequence.
541 y (PLFLT *, input) : Pointer to array containing number of points
542 in bin. This is a PLFLT (instead of PLINT) array so as to allow
543 histograms of probabilities, etc.
545 opt (PLINT, input) : Is a combination of several flags:
546 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
547 outer bins are expanded to fill up the entire x-axis and bins of
548 zero height are simply drawn.
549 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
550 between the x values. If the values in x are equally spaced,
551 the values are the center values of the bins.
552 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal
553 size as the ones inside.
554 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn
555 (there is a gap for such bins).
558 return _plplotc.plbin(*args)
561 return _plplotc.plbtime(*args)
562 plbtime = _plplotc.plbtime
570 Begins a new page. For a file driver, the output file is opened if
571 necessary. Advancing the page via pleop and plbop is useful when a
572 page break is desired at a particular point when plotting to subpages.
573 Another use for pleop and plbop is when plotting pages to different
574 files, since you can manually set the file name by calling plsfnam
575 after the call to pleop. (In fact some drivers may only support a
576 single page per file, making this a necessity.) One way to handle
577 this case automatically is to page advance via pladv, but enable
578 familying (see plsfam) with a small limit on the file size so that a
579 new family member file will be created on each page break.
581 Redacted form: plbop()
583 This function is used in examples 2,20.
592 return _plplotc.plbop()
596 Draw a box with axes, etc
600 Draws a box around the currently defined viewport, and labels it with
601 world coordinate values appropriate to the window. Thus plbox should
602 only be called after defining both viewport and window. The character
603 strings xopt and yopt specify how the box should be drawn as described
604 below. If ticks and/or subticks are to be drawn for a particular
605 axis, the tick intervals and number of subintervals may be specified
606 explicitly, or they may be defaulted by setting the appropriate
609 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
610 Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt)
613 This function is used in examples 1,2,4,6,6-12,14-18,21,23-26,29.
619 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
623 xopt (const char *, input) : Pointer to character string specifying
624 options for horizontal axis. The string can include any
625 combination of the following letters (upper or lower case) in any
626 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
627 is vertical line (x=0).
628 b: Draws bottom (X) or left (Y) edge of frame.
629 c: Draws top (X) or right (Y) edge of frame.
630 d: Plot labels as date / time. Values are assumed to be
631 seconds since the epoch (as used by gmtime).
632 f: Always use fixed point numeric labels.
633 g: Draws a grid at the major tick interval.
634 h: Draws a grid at the minor tick interval.
635 i: Inverts tick marks, so they are drawn outwards, rather than
637 l: Labels axis logarithmically. This only affects the labels,
638 not the data, and so it is necessary to compute the logarithms
639 of data points before passing them to any of the drawing
641 m: Writes numeric labels at major tick intervals in the
642 unconventional location (above box for X, right of box for Y).
643 n: Writes numeric labels at major tick intervals in the
644 conventional location (below box for X, left of box for Y).
645 o: Use custom labeling function to generate axis label text.
646 The custom labeling function can be defined with the
647 plslabelfuncplslabelfunc; command.
648 s: Enables subticks between major ticks, only valid if t is
650 t: Draws major ticks.
651 u: Exactly like "b" except don't draw edge line.
652 w: Exactly like "c" except don't draw edge line.
655 xtick (PLFLT, input) : World coordinate interval between major
656 ticks on the x axis. If it is set to zero, PLplot automatically
657 generates a suitable tick interval.
659 nxsub (PLINT, input) : Number of subintervals between major x axis
660 ticks for minor ticks. If it is set to zero, PLplot automatically
661 generates a suitable minor tick interval.
663 yopt (const char *, input) : Pointer to character string specifying
664 options for vertical axis. The string can include any combination
665 of the letters defined above for xopt, and in addition may
666 contain: v: Write numeric labels for vertical axis parallel to the
667 base of the graph, rather than parallel to the axis.
670 ytick (PLFLT, input) : World coordinate interval between major
671 ticks on the y axis. If it is set to zero, PLplot automatically
672 generates a suitable tick interval.
674 nysub (PLINT, input) : Number of subintervals between major y axis
675 ticks for minor ticks. If it is set to zero, PLplot automatically
676 generates a suitable minor tick interval.
679 return _plplotc.plbox(*args)
683 Draw a box with axes, etc, in 3-d
687 Draws axes, numeric and text labels for a three-dimensional surface
688 plot. For a more complete description of three-dimensional plotting
689 see the PLplot documentation.
691 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,
692 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
693 Perl/PDL: plbox3(xtick, nxsub, ytick, nysub, ztick, nzsub,
694 xopt, xlabel, yopt, ylabel, zopt, zlabel)
697 This function is used in examples 8,11,18,21.
703 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
707 xopt (const char *, input) : Pointer to character string specifying
708 options for the x axis. The string can include any combination of
709 the following letters (upper or lower case) in any order: b: Draws
710 axis at base, at height z=
711 zmin where zmin is defined by call to plw3d. This character must be
712 specified in order to use any of the other options.
713 f: Always use fixed point numeric labels.
714 i: Inverts tick marks, so they are drawn downwards, rather
716 l: Labels axis logarithmically. This only affects the labels,
717 not the data, and so it is necessary to compute the logarithms
718 of data points before passing them to any of the drawing
720 n: Writes numeric labels at major tick intervals.
721 o: Use custom labeling function to generate axis label text.
722 The custom labeling function can be defined with the
723 plslabelfuncplslabelfunc; command.
724 s: Enables subticks between major ticks, only valid if t is
726 t: Draws major ticks.
727 u: If this is specified, the text label for the axis is
728 written under the axis.
731 xlabel (const char *, input) : Pointer to character string
732 specifying text label for the x axis. It is only drawn if u is in
735 xtick (PLFLT, input) : World coordinate interval between major
736 ticks on the x axis. If it is set to zero, PLplot automatically
737 generates a suitable tick interval.
739 nxsub (PLINT, input) : Number of subintervals between major x axis
740 ticks for minor ticks. If it is set to zero, PLplot automatically
741 generates a suitable minor tick interval.
743 yopt (const char *, input) : Pointer to character string specifying
744 options for the y axis. The string is interpreted in the same way
747 ylabel (const char *, input) : Pointer to character string
748 specifying text label for the y axis. It is only drawn if u is in
751 ytick (PLFLT, input) : World coordinate interval between major
752 ticks on the y axis. If it is set to zero, PLplot automatically
753 generates a suitable tick interval.
755 nysub (PLINT, input) : Number of subintervals between major y axis
756 ticks for minor ticks. If it is set to zero, PLplot automatically
757 generates a suitable minor tick interval.
759 zopt (const char *, input) : Pointer to character string specifying
760 options for the z axis. The string can include any combination of
761 the following letters (upper or lower case) in any order: b: Draws
762 z axis to the left of the surface plot.
763 c: Draws z axis to the right of the surface plot.
764 d: Draws grid lines parallel to the x-y plane behind the
765 figure. These lines are not drawn until after plot3d or
766 plmesh are called because of the need for hidden line removal.
767 f: Always use fixed point numeric labels.
768 i: Inverts tick marks, so they are drawn away from the center.
769 l: Labels axis logarithmically. This only affects the labels,
770 not the data, and so it is necessary to compute the logarithms
771 of data points before passing them to any of the drawing
773 m: Writes numeric labels at major tick intervals on the
774 right-hand vertical axis.
775 n: Writes numeric labels at major tick intervals on the
776 left-hand vertical axis.
777 o: Use custom labeling function to generate axis label text.
778 The custom labeling function can be defined with the
779 plslabelfuncplslabelfunc; command.
780 s: Enables subticks between major ticks, only valid if t is
782 t: Draws major ticks.
783 u: If this is specified, the text label is written beside the
785 v: If this is specified, the text label is written beside the
789 zlabel (const char *, input) : Pointer to character string
790 specifying text label for the z axis. It is only drawn if u or v
791 are in the zopt string.
793 ztick (PLFLT, input) : World coordinate interval between major
794 ticks on the z axis. If it is set to zero, PLplot automatically
795 generates a suitable tick interval.
797 nzsub (PLINT, input) : Number of subintervals between major z axis
798 ticks for minor ticks. If it is set to zero, PLplot automatically
799 generates a suitable minor tick interval.
802 return _plplotc.plbox3(*args)
806 Calculate world coordinates and corresponding window index from relative device coordinates
810 Calculate world coordinates, wx and wy, and corresponding window index
811 from relative device coordinates, rx and ry.
813 Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
814 Perl/PDL: Not available?
817 This function is used in example 31.
823 plcalc_world(rx, ry, wx, wy, window)
827 rx (PLFLT, input) : Input relative device coordinate (ranging from
828 0. to 1.) for the x coordinate.
830 ry (PLFLT, input) : Input relative device coordinate (ranging from
831 0. to 1.) for the y coordinate.
833 wx (PLFLT *, output) : Pointer to the returned world coordinate for
834 x corresponding to the relative device coordinates rx and ry.
836 wy (PLFLT *, output) : Pointer to the returned world coordinate for
837 y corresponding to the relative device coordinates rx and ry.
839 window (PLINT *, output) : Pointer to the returned last defined
840 window index that corresponds to the input relative device
841 coordinates (and the returned world coordinates). To give some
842 background on the window index, for each page the initial window
843 index is set to zero, and each time plwind is called within the
844 page, world and device coordinates are stored for the window and
845 the window index is incremented. Thus, for a simple page layout
846 with non-overlapping viewports and one window per viewport, window
847 corresponds to the viewport index (in the order which the
848 viewport/windows were created) of the only viewport/window
849 corresponding to rx and ry. However, for more complicated layouts
850 with potentially overlapping viewports and possibly more than one
851 window (set of world coordinates) per viewport, window and the
852 corresponding output world coordinates corresponds to the last
853 window created that fulfils the criterion that the relative device
854 coordinates are inside it. Finally, in all cases where the input
855 relative device coordinates are not inside any viewport/window,
856 then window is set to -1.
859 return _plplotc.plcalc_world(*args)
863 Clear current (sub)page
867 Clears the current page, effectively erasing everything that have been
868 drawn. This command only works with interactive drivers; if the
869 driver does not support this, the page is filled with the background
870 color in use. If the current page is divided into subpages, only the
871 current subpage is erased. The nth subpage can be selected with
874 Redacted form: General: plclear()
875 Perl/PDL: Not available?
878 This function is not used in any examples.
887 return _plplotc.plclear()
895 Sets the color for color map0 (see the PLplot documentation).
897 Redacted form: plcol0(color)
899 This function is used in examples 1-9,11-16,18-27,29.
909 color (PLINT, input) : Integer representing the color. The
910 defaults at present are (these may change):
911 0 black (default background)
912 1 red (default foreground)
928 Use plscmap0 to change the entire map0 color palette and plscol0 to
929 change an individual color in the map0 color palette.
932 return _plplotc.plcol0(*args)
940 Sets the color for color map1 (see the PLplot documentation).
942 Redacted form: plcol1(col1)
944 This function is used in examples 12 and 21.
954 col1 (PLFLT, input) : This value must be in the range from 0. to 1.
955 and is mapped to color using the continuous map1 color palette
956 which by default ranges from blue to the background color to red.
957 The map1 palette can also be straightforwardly changed by the user
958 with plscmap1 or plscmap1l.
961 return _plplotc.plcol1(*args)
964 return _plplotc.plconfigtime(*args)
965 plconfigtime = _plplotc.plconfigtime
973 Draws a contour plot of the data in z[
975 ny], using the nlevel contour levels specified by clevel. Only the
976 region of the array from kx to lx and from ky to ly is plotted out. A
977 transformation routine pointed to by pltr with a pointer pltr_data for
978 additional data required by the transformation routine is used to map
979 indices within the array to the world coordinates. See the following
980 discussion of the arguments and the PLplot documentation for more
983 Redacted form: [PLEASE UPDATE! ONLY PERL INFO IS LIKELY CORRECT!] F95:
984 plcont(z, kx, lx, ky, ly, clevel, tr?) or plcont(z, kx, lx, ky, ly,
985 clevel, xgrid, ygrid)
986 Java: pls.cont(z, kx, lx, ky, ly, clevel, xgrid, ygrid)
987 Perl/PDL: plcont(z, kx, lx, ky, ly, clevel, pltr, pltr_data)
988 Python: plcont2(z, kx, lx, ky, ly, clevel)
991 This function is used in examples 9,14,16,22.
997 plcont(z, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
1001 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
1002 containing data to be contoured.
1004 nx, ny (PLINT, input) : Physical dimensions of array z.
1006 kx, lx (PLINT, input) : Range of x indices to consider.
1008 ky, ly (PLINT, input) : Range of y indices to consider.
1010 clevel (PLFLT *, input) : Pointer to array specifying levels at
1011 which to draw contours.
1013 nlevel (PLINT, input) : Number of contour levels to draw.
1015 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
1016 Pointer to function that defines transformation between indices
1017 in array z and the world coordinates (C only). Transformation
1018 functions are provided in the PLplot library: pltr0 for identity
1019 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
1020 defined by one- and two-dimensional arrays. In addition,
1021 user-supplied routines for the transformation can be used as well.
1022 Examples of all of these approaches are given in the PLplot
1023 documentation. The transformation function should have the form
1024 given by any of pltr0, pltr1, or pltr2. Note that unlike plshades
1025 and similar PLplot functions which have a pltr argument, plcont
1026 requires that a transformation function be provided in the C
1027 interface. Leaving pltr NULL will result in an error.
1029 pltr_data (PLPointer, input) : Extra parameter to help pass
1030 information to pltr0, pltr1, pltr2, or whatever routine that is
1031 externally supplied.
1034 return _plplotc.plcont(*args)
1037 return _plplotc.plctime(*args)
1038 plctime = _plplotc.plctime
1042 Copy state parameters from the reference stream to the current stream
1046 Copies state parameters from the reference stream to the current
1047 stream. Tell driver interface to map device coordinates unless flags
1050 This function is used for making save files of selected plots (e.g.
1051 from the TK driver). After initializing, you can get a copy of the
1052 current plot to the specified device by switching to this stream and
1053 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as
1054 appropriate. The plot buffer must have previously been enabled (done
1055 automatically by some display drivers, such as X).
1057 Redacted form: plcpstrm(iplsr, flags)
1059 This function is used in example 1,20.
1065 plcpstrm(iplsr, flags)
1069 iplsr (PLINT, input) : Number of reference stream.
1071 flags (PLBOOL, input) : If flags is set to true the device
1072 coordinates are not copied from the reference to current stream.
1075 return _plplotc.plcpstrm(*args)
1079 End plotting session
1083 Ends a plotting session, tidies up all the output files, switches
1084 interactive devices back into text mode and frees up any memory that
1085 was allocated. Must be called before end of program.
1087 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a
1088 wait state after a call to plend or other functions which trigger the
1089 end of a plot page. To avoid this, use the plspause function.
1091 Redacted form: plend()
1093 This function is used in all of the examples.
1102 return _plplotc.plend()
1106 End plotting session for current stream
1110 Ends a plotting session for the current output stream only. See
1111 plsstrm for more info.
1113 Redacted form: plend1()
1115 This function is used in examples 1,20.
1124 return _plplotc.plend1()
1128 Set up standard window and draw box
1132 Sets up plotter environment for simple graphs by calling pladv and
1133 setting up viewport and window to sensible default values. plenv
1134 leaves enough room around most graphs for axis labels and a title.
1135 When these defaults are not suitable, use the individual routines
1136 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
1137 defining the window, and plbox for drawing the box.
1139 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis)
1141 This function is used in example 1,3,9,13,14,19-22,29.
1147 plenv(xmin, xmax, ymin, ymax, just, axis)
1151 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1154 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1157 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1160 ymax (PLFLT, input) : Value of y at top edge of window (in world
1163 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1164 scales will not be set, the user must set up the scale before
1165 calling plenv using plsvpa, plvasp or other.
1166 0: the x and y axes are scaled independently to use as much of
1167 the screen as possible.
1168 1: the scales of the x and y axes are made equal.
1169 2: the axis of the x and y axes are made equal, and the plot
1173 axis (PLINT, input) : Controls drawing of the box around the plot:
1174 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1176 0: draw box, ticks, and numeric tick labels.
1177 1: also draw coordinate axes at x=0 and y=0.
1178 2: also draw a grid at major tick positions in both
1180 3: also draw a grid at minor tick positions in both
1182 10: same as 0 except logarithmic x tick marks. (The x data
1183 have to be converted to logarithms separately.)
1184 11: same as 1 except logarithmic x tick marks. (The x data
1185 have to be converted to logarithms separately.)
1186 12: same as 2 except logarithmic x tick marks. (The x data
1187 have to be converted to logarithms separately.)
1188 13: same as 3 except logarithmic x tick marks. (The x data
1189 have to be converted to logarithms separately.)
1190 20: same as 0 except logarithmic y tick marks. (The y data
1191 have to be converted to logarithms separately.)
1192 21: same as 1 except logarithmic y tick marks. (The y data
1193 have to be converted to logarithms separately.)
1194 22: same as 2 except logarithmic y tick marks. (The y data
1195 have to be converted to logarithms separately.)
1196 23: same as 3 except logarithmic y tick marks. (The y data
1197 have to be converted to logarithms separately.)
1198 30: same as 0 except logarithmic x and y tick marks. (The x
1199 and y data have to be converted to logarithms separately.)
1200 31: same as 1 except logarithmic x and y tick marks. (The x
1201 and y data have to be converted to logarithms separately.)
1202 32: same as 2 except logarithmic x and y tick marks. (The x
1203 and y data have to be converted to logarithms separately.)
1204 33: same as 3 except logarithmic x and y tick marks. (The x
1205 and y data have to be converted to logarithms separately.)
1206 40: same as 0 except date / time x labels.
1207 41: same as 1 except date / time x labels.
1208 42: same as 2 except date / time x labels.
1209 43: same as 3 except date / time x labels.
1210 50: same as 0 except date / time y labels.
1211 51: same as 1 except date / time y labels.
1212 52: same as 2 except date / time y labels.
1213 53: same as 3 except date / time y labels.
1214 60: same as 0 except date / time x and y labels.
1215 61: same as 1 except date / time x and y labels.
1216 62: same as 2 except date / time x and y labels.
1217 63: same as 3 except date / time x and y labels.
1218 70: same as 0 except custom x and y labels.
1219 71: same as 1 except custom x and y labels.
1220 72: same as 2 except custom x and y labels.
1221 73: same as 3 except custom x and y labels.
1224 return _plplotc.plenv(*args)
1228 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it.
1232 Sets up plotter environment for simple graphs by calling pladv and
1233 setting up viewport and window to sensible default values. plenv0
1234 leaves enough room around most graphs for axis labels and a title.
1235 When these defaults are not suitable, use the individual routines
1236 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
1237 defining the window, and plbox for drawing the box.
1239 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis)
1241 This function is used in example 21.
1247 plenv0(xmin, xmax, ymin, ymax, just, axis)
1251 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1254 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1257 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1260 ymax (PLFLT, input) : Value of y at top edge of window (in world
1263 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1264 scales will not be set, the user must set up the scale before
1265 calling plenv0 using plsvpa, plvasp or other.
1266 0: the x and y axes are scaled independently to use as much of
1267 the screen as possible.
1268 1: the scales of the x and y axes are made equal.
1269 2: the axis of the x and y axes are made equal, and the plot
1273 axis (PLINT, input) : Controls drawing of the box around the plot:
1274 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1276 0: draw box, ticks, and numeric tick labels.
1277 1: also draw coordinate axes at x=0 and y=0.
1278 2: also draw a grid at major tick positions in both
1280 3: also draw a grid at minor tick positions in both
1282 10: same as 0 except logarithmic x tick marks. (The x data
1283 have to be converted to logarithms separately.)
1284 11: same as 1 except logarithmic x tick marks. (The x data
1285 have to be converted to logarithms separately.)
1286 12: same as 2 except logarithmic x tick marks. (The x data
1287 have to be converted to logarithms separately.)
1288 13: same as 3 except logarithmic x tick marks. (The x data
1289 have to be converted to logarithms separately.)
1290 20: same as 0 except logarithmic y tick marks. (The y data
1291 have to be converted to logarithms separately.)
1292 21: same as 1 except logarithmic y tick marks. (The y data
1293 have to be converted to logarithms separately.)
1294 22: same as 2 except logarithmic y tick marks. (The y data
1295 have to be converted to logarithms separately.)
1296 23: same as 3 except logarithmic y tick marks. (The y data
1297 have to be converted to logarithms separately.)
1298 30: same as 0 except logarithmic x and y tick marks. (The x
1299 and y data have to be converted to logarithms separately.)
1300 31: same as 1 except logarithmic x and y tick marks. (The x
1301 and y data have to be converted to logarithms separately.)
1302 32: same as 2 except logarithmic x and y tick marks. (The x
1303 and y data have to be converted to logarithms separately.)
1304 33: same as 3 except logarithmic x and y tick marks. (The x
1305 and y data have to be converted to logarithms separately.)
1306 40: same as 0 except date / time x labels.
1307 41: same as 1 except date / time x labels.
1308 42: same as 2 except date / time x labels.
1309 43: same as 3 except date / time x labels.
1310 50: same as 0 except date / time y labels.
1311 51: same as 1 except date / time y labels.
1312 52: same as 2 except date / time y labels.
1313 53: same as 3 except date / time y labels.
1314 60: same as 0 except date / time x and y labels.
1315 61: same as 1 except date / time x and y labels.
1316 62: same as 2 except date / time x and y labels.
1317 63: same as 3 except date / time x and y labels.
1318 70: same as 0 except custom x and y labels.
1319 71: same as 1 except custom x and y labels.
1320 72: same as 2 except custom x and y labels.
1321 73: same as 3 except custom x and y labels.
1324 return _plplotc.plenv0(*args)
1332 Clears the graphics screen of an interactive device, or ejects a page
1333 on a plotter. See plbop for more information.
1335 Redacted form: pleop()
1337 This function is used in example 2,14.
1346 return _plplotc.pleop()
1354 Draws a set of n horizontal error bars, the i'th error bar extending
1355 from xmin[i] to xmax[i] at y coordinate y[i]. The terminals of the
1356 error bar are of length equal to the minor tick length (settable using
1359 Redacted form: General: plerrx(xmin, ymax, y)
1360 Perl/PDL: plerrx(n, xmin, xmax, y)
1363 This function is used in example 29.
1369 plerrx(n, xmin, xmax, y)
1373 n (PLINT, input) : Number of error bars to draw.
1375 xmin (PLFLT *, input) : Pointer to array with x coordinates of
1376 left-hand endpoint of error bars.
1378 xmax (PLFLT *, input) : Pointer to array with x coordinates of
1379 right-hand endpoint of error bars.
1381 y (PLFLT *, input) : Pointer to array with y coordinates of error
1385 return _plplotc.plerrx(*args)
1393 Draws a set of n vertical error bars, the i'th error bar extending
1394 from ymin[i] to ymax[i] at x coordinate x[i]. The terminals of the
1395 error bar are of length equal to the minor tick length (settable using
1398 Redacted form: General: plerry(x, ymin, ymax)
1399 Perl/PDL: plerry(n, x, ymin, ymax)
1402 This function is used in example 29.
1408 plerry(n, x, ymin, ymax)
1412 n (PLINT, input) : Number of error bars to draw.
1414 x (PLFLT *, input) : Pointer to array with x coordinates of error
1417 ymin (PLFLT *, input) : Pointer to array with y coordinates of
1418 lower endpoint of error bars.
1420 ymax (PLFLT *, input) : Pointer to array with y coordinate of upper
1421 endpoint of error bar.
1424 return _plplotc.plerry(*args)
1428 Advance to the next family file on the next new page
1432 Advance to the next family file on the next new page.
1434 Redacted form: plfamadv()
1436 This function is not used in any examples.
1445 return _plplotc.plfamadv()
1453 Fills the polygon defined by the n points (
1455 y[i]) using the pattern defined by plpsty or plpat. The default fill
1456 style is a solid fill. The routine will automatically close the
1457 polygon between the last and first vertices. If multiple closed
1458 polygons are passed in x and y then plfill will fill in between them.
1460 Redacted form: plfill(x,y)
1462 This function is used in examples 12,13,15,16,21,24,25.
1472 n (PLINT, input) : Number of vertices in polygon.
1474 x (PLFLT *, input) : Pointer to array with x coordinates of
1477 y (PLFLT *, input) : Pointer to array with y coordinates of
1481 return _plplotc.plfill(*args)
1485 Draw filled polygon in 3D
1489 Fills the 3D polygon defined by the n points in the x, y, and z arrays
1490 using the pattern defined by plpsty or plpat. The routine will
1491 automatically close the polygon between the last and first vertices.
1492 If multiple closed polygons are passed in x, y, and z then plfill3
1493 will fill in between them.
1495 Redacted form: General: plfill3(x, y, z)
1496 Perl/PDL: plfill3(n, x, y, z)
1499 This function is used in example 15.
1509 n (PLINT, input) : Number of vertices in polygon.
1511 x (PLFLT *, input) : Pointer to array with x coordinates of
1514 y (PLFLT *, input) : Pointer to array with y coordinates of
1517 z (PLFLT *, input) : Pointer to array with z coordinates of
1521 return _plplotc.plfill3(*args)
1525 Draw linear gradient inside polygon
1529 Draw a linear gradient using colour map 1 inside the polygon defined
1532 y[i]). Interpretation of the polygon is the same as for plfill. The
1533 polygon coordinates and the gradient angle are all expressed in world
1534 coordinates. The angle from the x axis for both the rotated
1535 coordinate system and the gradient vector is specified by angle. The
1536 magnitude of the gradient vector is the difference between the maximum
1537 and minimum values of x for the vertices in the rotated coordinate
1538 system. The origin of the gradient vector can be interpreted as being
1539 anywhere on the line corresponding to the minimum x value for the
1540 vertices in the rotated coordinate system. The distance along the
1541 gradient vector is linearly transformed to the independent variable of
1542 colour map 1 which ranges from 0. at the tail of the gradient vector
1543 to 1. at the head of the gradient vector. What is drawn is the RGBA
1544 colour corresponding to the independent variable of colour map 1. For
1545 more information about colour map 1 (see the PLplot documentation).
1547 Redacted form: plgradient(x,y,angle)
1549 This function is used in examples 25,30.
1555 plgradient(n, x, y, angle)
1559 n (PLINT, input) : Number of vertices in polygon.
1561 x (PLFLT *, input) : Pointer to array with x coordinates of
1564 y (PLFLT *, input) : Pointer to array with y coordinates of
1567 angle (PLFLT, input) : Angle (degrees) of gradient vector from x
1571 return _plplotc.plgradient(*args)
1575 Flushes the output stream
1579 Flushes the output stream. Use sparingly, if at all.
1581 Redacted form: plflush()
1583 This function is used in examples 1,14.
1592 return _plplotc.plflush()
1600 Sets the default character font for subsequent character drawing. Also
1601 affects symbols produced by plpoin. This routine has no effect unless
1602 the extended character set is loaded (see plfontld).
1604 Redacted form: plfont(font)
1606 This function is used in examples 1,2,4,7,13,24,26.
1616 font (PLINT, input) : Specifies the font: 1: Normal font (simplest
1623 return _plplotc.plfont(*args)
1631 Sets the character set to use for subsequent character drawing. May
1632 be called before initializing PLplot.
1634 Redacted form: plfontld(set)
1636 This function is used in examples 1,7.
1646 set (PLINT, input) : Specifies the character set to load: 0:
1647 Standard character set
1648 1: Extended character set
1651 return _plplotc.plfontld(*args)
1655 Get character default height and current (scaled) height
1659 Get character default height and current (scaled) height.
1661 Redacted form: plgchr(p_def, p_ht)
1663 This function is used in example 23.
1673 p_def (PLFLT *, output) : Pointer to default character height (mm).
1675 p_ht (PLFLT *, output) : Pointer to current (scaled) character
1679 return _plplotc.plgchr()
1683 Returns 8-bit RGB values for given color from color map0
1687 Returns 8-bit RGB values (0-255) for given color from color map0 (see
1688 the PLplot documentation). Values are negative if an invalid color id
1691 Redacted form: plgcol0(icol0, r, g, b)
1693 This function is used in example 2.
1699 plgcol0(icol0, r, g, b)
1703 icol0 (PLINT, input) : Index of desired cmap0 color.
1705 r (PLINT *, output) : Pointer to 8-bit red value.
1707 g (PLINT *, output) : Pointer to 8-bit green value.
1709 b (PLINT *, output) : Pointer to 8-bit blue value.
1712 return _plplotc.plgcol0(*args)
1716 Returns 8-bit RGB values and double alpha value for given color from color map0.
1720 Returns 8-bit RGB values (0-255) and double alpha value (0.0 - 1.0)
1721 for given color from color map0 (see the PLplot documentation).
1722 Values are negative if an invalid color id is given.
1724 This function is used in example 30.
1730 plgcol0a(icol0, r, g, b, a)
1734 icol0 (PLINT, input) : Index of desired cmap0 color.
1736 r (PLINT *, output) : Pointer to 8-bit red value.
1738 g (PLINT *, output) : Pointer to 8-bit green value.
1740 b (PLINT *, output) : Pointer to 8-bit blue value.
1742 a (PLFLT *, output) : Pointer to PLFLT alpha value.
1745 return _plplotc.plgcol0a(*args)
1749 Returns the background color (cmap0[0]) by 8-bit RGB value
1753 Returns the background color (cmap0[0]) by 8-bit RGB value.
1755 Redacted form: plgcolbg(r, g, b)
1757 This function is used in example 31.
1767 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1768 representing the degree of red in the color.
1770 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1771 representing the degree of green in the color.
1773 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1774 representing the degree of blue in the color.
1777 return _plplotc.plgcolbg()
1781 Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha value.
1785 Returns the background color (cmap0[0]) by 8-bit RGB value and double
1788 This function is used in example 31.
1794 lgcolbga(r, g, b, a)
1798 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1799 representing the degree of red in the color.
1801 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1802 representing the degree of green in the color.
1804 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1805 representing the degree of blue in the color.
1807 a (PLFLT *, output) : Pointer to PLFLT alpha value.
1810 return _plplotc.plgcolbga()
1814 Get the current device-compression setting
1818 Get the current device-compression setting. This parameter is only
1819 used for drivers that provide compression.
1821 Redacted form: plgcompression(compression)
1823 This function is used in example 31.
1829 plgcompression(compression)
1833 compression (PLINT *, output) : Pointer to a variable to be filled
1834 with the current device-compression setting.
1837 return _plplotc.plgcompression()
1841 Get the current device (keyword) name
1845 Get the current device (keyword) name. Note: you must have allocated
1846 space for this (80 characters is safe).
1848 Redacted form: plgdev(p_dev)
1850 This function is used in example 14.
1860 p_dev (char *, output) : Pointer to device (keyword) name string.
1863 return _plplotc.plgdev()
1867 Get parameters that define current device-space window
1871 Get relative margin width, aspect ratio, and relative justification
1872 that define current device-space window. If plsdidev has not been
1873 called the default values pointed to by p_mar, p_aspect, p_jx, and
1876 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy)
1878 This function is used in example 31.
1884 plgdidev(p_mar, p_aspect, p_jx, p_jy)
1888 p_mar (PLFLT *, output) : Pointer to relative margin width.
1890 p_aspect (PLFLT *, output) : Pointer to aspect ratio.
1892 p_jx (PLFLT *, output) : Pointer to relative justification in x.
1894 p_jy (PLFLT *, output) : Pointer to relative justification in y.
1897 return _plplotc.plgdidev()
1901 Get plot orientation
1905 Get plot orientation parameter which is multiplied by 90 degrees to
1906 obtain the angle of rotation. Note, arbitrary rotation parameters
1907 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
1908 values for the rotation parameter are 0., 1., 2., and 3. corresponding
1909 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
1910 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has
1911 not been called the default value pointed to by p_rot will be 0.
1913 Redacted form: plgdiori(p_rot)
1915 This function is not used in any examples.
1925 p_rot (PLFLT *, output) : Pointer to orientation parameter.
1928 return _plplotc.plgdiori()
1932 Get parameters that define current plot-space window
1936 Get relative minima and maxima that define current plot-space window.
1937 If plsdiplt has not been called the default values pointed to by
1938 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1.
1940 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
1942 This function is used in example 31.
1948 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
1952 p_xmin (PLFLT *, output) : Pointer to relative minimum in x.
1954 p_ymin (PLFLT *, output) : Pointer to relative minimum in y.
1956 p_xmax (PLFLT *, output) : Pointer to relative maximum in x.
1958 p_ymax (PLFLT *, output) : Pointer to relative maximum in y.
1961 return _plplotc.plgdiplt()
1965 Get family file parameters
1969 Gets information about current family file, if familying is enabled.
1970 See the PLplot documentation for more information.
1972 Redacted form: plgfam(fam, num, bmax)
1974 This function is used in examples 14,31.
1980 plgfam(fam, num, bmax)
1984 fam (PLINT *, output) : Pointer to variable with the Boolean family
1985 flag value. If nonzero, familying is enabled.
1987 num (PLINT *, output) : Pointer to variable with the current family
1990 bmax (PLINT *, output) : Pointer to variable with the maximum file
1991 size (in bytes) for a family file.
1994 return _plplotc.plgfam()
1998 Get FCI (font characterization integer)
2002 Gets information about the current font using the FCI approach. See
2003 the PLplot documentation for more information.
2005 Redacted form: plgfci(fci)
2007 This function is used in example 23.
2017 fci (PLUNICODE *, output) : Pointer to PLUNICODE (unsigned 32-bit
2018 integer) variable which is updated with current FCI value.
2021 return _plplotc.plgfci()
2025 Get output file name
2029 Gets the current output file name, if applicable.
2031 Redacted form: plgfnam(fnam)
2033 This function is used in example 31.
2043 fnam (char *, output) : Pointer to file name string (a preallocated
2044 string of 80 characters or more).
2047 return _plplotc.plgfnam()
2051 Get family, style and weight of the current font
2055 Gets information about current font. See the PLplot documentation for
2056 more information on font selection.
2058 Redacted form: plgfont(p_family, p_style, p_weight)
2060 This function is used in example 23.
2066 plgfont(p_family, p_style, p_weight)
2070 p_family (PLINT *, output) : Pointer to variable with the current
2071 font family. The available values are given by the PL_FCI_*
2072 constants in plplot.h. Current options are PL_FCI_SANS,
2073 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If
2074 p_family is NULL then the font family is not returned.
2076 p_style (PLINT *, output) : Pointer to variable with the current
2077 font style. The available values are given by the PL_FCI_*
2078 constants in plplot.h. Current options are PL_FCI_UPRIGHT,
2079 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the
2080 font style is not returned.
2082 p_weight (PLINT *, output) : Pointer to variable with the current
2083 font weight. The available values are given by the PL_FCI_*
2084 constants in plplot.h. Current options are PL_FCI_MEDIUM and
2085 PL_FCI_BOLD. If p_weight is NULL then the font weight is not
2089 return _plplotc.plgfont()
2093 Get the (current) run level
2097 Get the (current) run level. Valid settings are: 0, uninitialized
2100 3, world coordinates defined
2103 Redacted form: plglevel(p_level)
2105 This function is used in example 31.
2115 p_level (PLINT *, output) : Pointer to the run level.
2118 return _plplotc.plglevel()
2126 Gets the current page configuration. The length and offset values are
2127 expressed in units that are specific to the current driver. For
2128 instance: screen drivers will usually interpret them as number of
2129 pixels, whereas printer drivers will usually use mm.
2131 Redacted form: plgpage(xp, yp, xleng, yleng, xoff, yoff)
2133 This function is used in examples 14 and 31.
2139 plgpage(xp, yp, xleng, yleng, xoff, yoff)
2143 xp (PLFLT *, output) : Pointer to number of pixels/inch (DPI), x.
2145 yp (PLFLT *, output) : Pointer to number of pixels/inch (DPI) in y.
2147 xleng (PLINT *, output) : Pointer to x page length value.
2149 yleng (PLINT *, output) : Pointer to y page length value.
2151 xoff (PLINT *, output) : Pointer to x page offset.
2153 yoff (PLINT *, output) : Pointer to y page offset.
2156 return _plplotc.plgpage()
2160 Switch to graphics screen
2164 Sets an interactive device to graphics mode, used in conjunction with
2165 pltext to allow graphics and text to be interspersed. On a device
2166 which supports separate text and graphics windows, this command causes
2167 control to be switched to the graphics window. If already in graphics
2168 mode, this command is ignored. It is also ignored on devices which
2169 only support a single window or use a different method for shifting
2170 focus. See also pltext.
2172 Redacted form: plgra()
2174 This function is used in example 1.
2183 return _plplotc.plgra()
2187 Grid data from irregularly sampled data
2191 Real world data is frequently irregularly sampled, but all PLplot 3D
2192 plots require data placed in a uniform grid. This function takes
2193 irregularly sampled data from three input arrays x[npts], y[npts], and
2194 z[npts], reads the desired grid location from input arrays xg[nptsx]
2195 and yg[nptsy], and returns the gridded data into output array
2196 zg[nptsx][nptsy]. The algorithm used to grid the data is specified
2197 with the argument type which can have one parameter specified in
2200 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data)
2201 Perl/PDL: Not available?
2202 Python: zg=plgriddata(x, y, z, xg, yg, type, data)
2205 This function is used in example 21.
2211 plggriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
2215 x (PLFLT *, input) : The input x array.
2217 y (PLFLT *, input) : The input y array.
2219 z (PLFLT *, input) : The input z array. Each triple x[i], y[i],
2220 z[i] represents one data sample coordinate.
2222 npts (PLINT, input) : The number of data samples in the x, y and z
2225 xg (PLFLT *, input) : The input array that specifies the grid
2226 spacing in the x direction. Usually xg has nptsx equally spaced
2227 values from the minimum to the maximum values of the x input
2230 nptsx (PLINT, input) : The number of points in the xg array.
2232 yg (PLFLT *, input) : The input array that specifies the grid
2233 spacing in the y direction. Similar to the xg parameter.
2235 nptsy (PLINT, input) : The number of points in the yg array.
2237 zg (PLFLT **, output) : The output array, where data lies in the
2238 regular grid specified by xg and yg. the zg array must exist or be
2239 allocated by the user prior to the call, and must have dimension
2242 type (PLINT, input) : The type of gridding algorithm to use, which
2243 can be: GRID_CSA: Bivariate Cubic Spline approximation
2244 GRID_DTLI: Delaunay Triangulation Linear Interpolation
2245 GRID_NNI: Natural Neighbors Interpolation
2246 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
2247 GRID_NNLI: Nearest Neighbors Linear Interpolation
2248 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
2250 For details of the algorithms read the source file plgridd.c.
2252 data (PLFLT, input) : Some gridding algorithms require extra data,
2253 which can be specified through this argument. Currently, for
2254 algorithm: GRID_NNIDW, data specifies the number of neighbors to
2255 use, the lower the value, the noisier (more local) the
2257 GRID_NNLI, data specifies what a thin triangle is, in the
2258 range [1. .. 2.]. High values enable the usage of very thin
2259 triangles for interpolation, possibly resulting in error in
2261 GRID_NNI, only weights greater than data will be accepted. If
2262 0, all weights will be accepted.
2265 return _plplotc.plgriddata(*args)
2269 Get current subpage parameters
2273 Gets the size of the current subpage in millimeters measured from the
2274 bottom left hand corner of the output device page or screen. Can be
2275 used in conjunction with plsvpa for setting the size of a viewport in
2276 absolute coordinates (millimeters).
2278 Redacted form: plgspa(xmin, xmax, ymin, ymax)
2280 This function is used in example 23.
2286 plgspa(xmin, xmax, ymin, ymax)
2290 xmin (PLFLT *, output) : Pointer to variable with position of left
2291 hand edge of subpage in millimeters.
2293 xmax (PLFLT *, output) : Pointer to variable with position of right
2294 hand edge of subpage in millimeters.
2296 ymin (PLFLT *, output) : Pointer to variable with position of
2297 bottom edge of subpage in millimeters.
2299 ymax (PLFLT *, output) : Pointer to variable with position of top
2300 edge of subpage in millimeters.
2303 return _plplotc.plgspa()
2307 Get current stream number
2311 Gets the number of the current output stream. See also plsstrm.
2313 Redacted form: plgstrm(strm)
2315 This function is used in example 1,20.
2325 strm (PLINT *, output) : Pointer to current stream value.
2328 return _plplotc.plgstrm()
2332 Get the current library version number
2336 Get the current library version number. Note: you must have allocated
2337 space for this (80 characters is safe).
2339 Redacted form: plgver(p_ver)
2341 This function is used in example 1.
2351 p_ver (char *, output) : Pointer to the current library version
2355 return _plplotc.plgver()
2359 Get viewport limits in normalized device coordinates
2363 Get viewport limits in normalized device coordinates.
2365 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2366 Perl/PDL: Not available?
2369 This function is used in example 31.
2375 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2379 p_xmin (PLFLT *, output) : Lower viewport limit of the normalized
2380 device coordinate in x.
2382 p_xmax (PLFLT *, output) : Upper viewport limit of the normalized
2383 device coordinate in x.
2385 p_ymin (PLFLT *, output) : Lower viewport limit of the normalized
2386 device coordinate in y.
2388 p_ymax (PLFLT *, output) : Upper viewport limit of the normalized
2389 device coordinate in y.
2392 return _plplotc.plgvpd()
2396 Get viewport limits in world coordinates
2400 Get viewport limits in world coordinates.
2402 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2403 Perl/PDL: Not available?
2406 This function is used in example 31.
2412 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2416 p_xmin (PLFLT *, output) : Lower viewport limit of the world
2419 p_xmax (PLFLT *, output) : Upper viewport limit of the world
2422 p_ymin (PLFLT *, output) : Lower viewport limit of the world
2425 p_ymax (PLFLT *, output) : Upper viewport limit of the world
2429 return _plplotc.plgvpw()
2433 Get x axis parameters
2437 Returns current values of the digmax and digits flags for the x axis.
2438 digits is updated after the plot is drawn, so this routine should only
2439 be called after the call to plbox (or plbox3) is complete. See the
2440 PLplot documentation for more information.
2442 Redacted form: plgxax(digmax, digits)
2444 This function is used in example 31.
2450 plgxax(digmax, digits)
2454 digmax (PLINT *, output) : Pointer to variable with the maximum
2455 number of digits for the x axis. If nonzero, the printed label
2456 has been switched to a floating point representation when the
2457 number of digits exceeds digmax.
2459 digits (PLINT *, output) : Pointer to variable with the actual
2460 number of digits for the numeric labels (x axis) from the last
2464 return _plplotc.plgxax()
2468 Get y axis parameters
2472 Identical to plgxax, except that arguments are flags for y axis. See
2473 the description of plgxax for more detail.
2475 Redacted form: plgyax(digmax, digits)
2477 This function is used in example 31.
2483 plgyax(digmax, digits)
2487 digmax (PLINT *, output) : Pointer to variable with the maximum
2488 number of digits for the y axis. If nonzero, the printed label
2489 has been switched to a floating point representation when the
2490 number of digits exceeds digmax.
2492 digits (PLINT *, output) : Pointer to variable with the actual
2493 number of digits for the numeric labels (y axis) from the last
2497 return _plplotc.plgyax()
2501 Get z axis parameters
2505 Identical to plgxax, except that arguments are flags for z axis. See
2506 the description of plgxax for more detail.
2508 Redacted form: plgzax(digmax, digits)
2510 This function is used in example 31.
2516 plgzax(digmax, digits)
2520 digmax (PLINT *, output) : Pointer to variable with the maximum
2521 number of digits for the z axis. If nonzero, the printed label
2522 has been switched to a floating point representation when the
2523 number of digits exceeds digmax.
2525 digits (PLINT *, output) : Pointer to variable with the actual
2526 number of digits for the numeric labels (z axis) from the last
2530 return _plplotc.plgzax()
2534 Plot a histogram from unbinned data
2538 Plots a histogram from n data points stored in the array data. This
2539 routine bins the data into nbin bins equally spaced between datmin and
2540 datmax, and calls plbin to draw the resulting histogram. Parameter
2541 opt allows, among other things, the histogram either to be plotted in
2542 an existing window or causes plhist to call plenv with suitable limits
2543 before plotting the histogram.
2545 Redacted form: plhist(data, datmin, datmax, nbin, opt)
2547 This function is used in example 5.
2553 plhist(n, data, datmin, datmax, nbin, opt)
2557 n (PLINT, input) : Number of data points.
2559 data (PLFLT *, input) : Pointer to array with values of the n data
2562 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
2564 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
2566 nbin (PLINT, input) : Number of (equal-sized) bins into which to
2567 divide the interval xmin to xmax.
2569 opt (PLINT, input) : Is a combination of several flags:
2570 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
2571 the histogram data, the outer bins are expanded to fill up the
2572 entire x-axis, data outside the given extremes are assigned to the
2573 outer bins and bins of zero height are simply drawn.
2574 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled
2575 to fit the histogram data, without this flag, plenv is called
2576 to set the world coordinates.
2577 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
2578 extremes are not taken into account. This option should
2579 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to
2580 properly present the data.
2581 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal
2582 size as the ones inside.
2583 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn
2584 (there is a gap for such bins).
2587 return _plplotc.plhist(*args)
2591 Convert HLS color to RGB
2595 Convert HLS color coordinates to RGB.
2597 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
2598 Perl/PDL: Not available? Implemented as plhls?
2601 This function is used in example 2.
2607 plhlsrgb(h, l, s, p_r, p_g, p_b)
2611 h (PLFLT, input) : Hue, in degrees on the colour cone (0.0-360.0)
2613 l (PLFLT, input) : Lightness, expressed as a fraction of the axis
2614 of the colour cone (0.0-1.0)
2616 s (PLFLT, input) : Saturation, expressed as a fraction of the
2617 radius of the colour cone (0.0-1.0)
2619 p_r (PLFLT *, output) : Pointer to red intensity (0.0-1.0) of the
2622 p_g (PLFLT *, output) : Pointer to green intensity (0.0-1.0) of the
2625 p_b (PLFLT *, output) : Pointer to blue intensity (0.0-1.0) of the
2629 return _plplotc.plhlsrgb(*args)
2637 Initializing the plotting package. The program prompts for the device
2638 keyword or number of the desired output device. Hitting a RETURN in
2639 response to the prompt is the same as selecting the first device.
2640 plinit will issue no prompt if either the device was specified
2641 previously (via command line flag, the plsetopt function, or the
2642 plsdev function), or if only one device is enabled when PLplot is
2643 installed. If subpages have been specified, the output device is
2644 divided into nx by ny subpages, each of which may be used
2645 independently. If plinit is called again during a program, the
2646 previously opened file will be closed. The subroutine pladv is used
2647 to advance from one subpage to the next.
2649 Redacted form: plinit()
2651 This function is used in all of the examples.
2660 return _plplotc.plinit()
2664 Draw a line between two points
2674 Redacted form: pljoin(x1,y1,x2,y2)
2676 This function is used in examples 3,14.
2682 pljoin(x1, y1, x2, y2)
2686 x1 (PLFLT, input) : x coordinate of first point.
2688 y1 (PLFLT, input) : y coordinate of first point.
2690 x2 (PLFLT, input) : x coordinate of second point.
2692 y2 (PLFLT, input) : y coordinate of second point.
2695 return _plplotc.pljoin(*args)
2699 Simple routine to write labels
2703 Routine for writing simple labels. Use plmtex for more complex labels.
2705 Redacted form: pllab(xlabel, ylabel, tlabel)
2707 This function is used in examples 1,5,9,12,14-16,20-22,29.
2713 pllab(xlabel, ylabel, tlabel)
2717 xlabel (const char *, input) : Label for horizontal axis.
2719 ylabel (const char *, input) : Label for vertical axis.
2721 tlabel (const char *, input) : Title of graph.
2724 return _plplotc.pllab(*args)
2728 Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols
2732 Routine for creating a discrete plot legend with a plotted filled box,
2733 line, and/or line of symbols for each annotated legend entry. The
2734 arguments of pllegend provide control over the location and size of
2735 the legend as well as the location and characteristics of the elements
2736 (most of which are optional) within that legend. The resulting legend
2737 is clipped at the boundaries of the current subpage. (N.B. the adopted
2738 coordinate system used for some of the parameters is defined in the
2739 documentation of the position parameter.)
2741 Redacted form: pllegend(p_legend_width, p_legend_height, opt,
2742 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow,
2743 ncolumn, opt_array, text_offset, text_scale, text_spacing,
2744 test_justification, text_colors, text, box_colors, box_patterns,
2745 box_scales, box_line_widths, line_colors, line_styles, line_widths,
2746 symbol_colors, symbol_scales, symbol_numbers, symbols)
2748 This function is used in examples 4 and 26.
2754 pllegend(p_legend_width, p_legend_height, opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, nlegend, opt_array, text_offset, text_scale, text_spacing, test_justification, text_colors, text, box_colors, box_patterns, box_scales, box_line_widths, line_colors, line_styles, line_widths, symbol_colors, symbol_scales, symbol_numbers, symbols)
2758 p_legend_width (PLFLT *, output) : Pointer to a location which
2759 contains (after the call) the legend width in adopted coordinates.
2760 This quantity is calculated from plot_width, text_offset, ncolumn
2761 (possibly modified inside the routine depending on nlegend and
2762 nrow), and the length (calculated internally) of the longest text
2765 p_legend_height (PLFLT *, output) : Pointer to a location which
2766 contains (after the call) the legend height in adopted
2767 coordinates. This quantity is calculated from text_scale,
2768 text_spacing, and nrow (possibly modified inside the routine
2769 depending on nlegend and nrow).
2771 opt (PLINT, input) : opt contains bits controlling the overall
2772 legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area
2773 on the left of the legend and the plotted area on the right.
2774 Otherwise, put the text area on the right of the legend and the
2775 plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set,
2776 plot a (semi-transparent) background for the legend. If the
2777 PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the
2778 legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the
2779 possibly internally transformed) nrow > 1 and ncolumn > 1, then
2780 plot the resulting array of legend entries in row-major order.
2781 Otherwise, plot the legend entries in column-major order.
2783 position (PLINT, input) : position contains bits controlling the
2784 overall position of the legend and the definition of the adopted
2785 coordinates used for positions. The combination of the
2786 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP,
2787 PL_POSITION_BOTTOM, PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE
2788 bits specifies one of the 16 possible standard positions (the 4
2789 corners and 4 side centers for both the inside and outside cases)
2790 of the legend relative to the adopted coordinate system. The
2791 adopted coordinates are normalized viewport coordinates if the
2792 PL_POSITION_VIEWPORT bit is set or normalized subpage coordinates
2793 if the PL_POSITION_SUBPAGE bit is set. Default position bits: If
2794 none of PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, or
2795 PL_POSITION_BOTTOM are set, then use the combination of
2796 PL_POSITION_RIGHT and PL_POSITION_TOP. If neither of
2797 PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set, use
2798 PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or
2799 PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT.
2801 x (PLFLT, input) : X offset of the legend position in adopted
2802 coordinates from the specified standard position of the legend.
2803 For positive x, the direction of motion away from the standard
2804 position is inward/outward from the standard corner positions or
2805 standard left or right positions if the
2806 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
2807 For the standard top or bottom positions, the direction of motion
2808 is toward positive X.
2810 y (PLFLT, input) : Y offset of the legend position in adopted
2811 coordinates from the specified standard position of the legend.
2812 For positive y, the direction of motion away from the standard
2813 position is inward/outward from the standard corner positions or
2814 standard top or bottom positions if the
2815 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
2816 For the standard left or right positions, the direction of motion
2817 is toward positive Y.
2819 plot_width (PLFLT, input) : Horizontal width in adopted coordinates
2820 of the plot area (where the colored boxes, lines, and/or lines of
2821 symbols are drawn) of the legend.
2823 bg_color (PLINT, input) : The cmap0 index of the background color
2824 for the legend (PL_LEGEND_BACKGROUND).
2826 bb_color (PLINT, input) : The cmap0 index of the color of the
2827 bounding-box line for the legend (PL_LEGEND_BOUNDING_BOX).
2829 bb_style (PLINT, input) : The cmap0 index of the background color
2830 for the legend (PL_LEGEND_BACKGROUND).
2832 nrow (PLINT, input) : The cmap0 index of the background color for
2833 the legend (PL_LEGEND_BACKGROUND).
2835 ncolumn (PLINT, input) : The cmap0 index of the background color
2836 for the legend (PL_LEGEND_BACKGROUND).
2838 nlegend (PLINT, input) : Number of legend entries. N.B. The total
2839 vertical height of the legend in adopted coordinates is calculated
2840 internally from nlegend, text_scale (see below), and text_spacing
2843 opt_array (const PLINT *, input) : Array of nlegend values of
2844 options to control each individual plotted area corresponding to a
2845 legend entry. If the
2846 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted
2848 PL_LEGEND_COLOR_BOX,
2849 PL_LEGEND_LINE, and/or
2850 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
2851 entry is plotted with a colored box; a line; and/or a line of
2854 text_offset (PLFLT, input) : Offset of the text area from the plot
2855 area in units of character width. N.B. The total horizontal
2856 width of the legend in adopted coordinates is calculated
2858 plot_width (see above),
2859 text_offset, and length (calculated internally) of the longest text
2862 text_scale (PLFLT, input) : Character height scale for text
2863 annotations. N.B. The total vertical height of the legend in
2864 adopted coordinates is calculated internally from
2865 nlegend (see above),
2867 text_spacing (see below).
2869 text_spacing (PLFLT, input) : Vertical spacing in units of the
2870 character height from one legend entry to the next. N.B. The
2871 total vertical height of the legend in adopted coordinates is
2872 calculated internally from
2873 nlegend (see above),
2874 text_scale (see above), and
2877 text_justification (PLFLT, input) : Justification parameter used
2878 for text justification. The most common values of
2879 text_justification are 0., 0.5, or 1. corresponding to a text that
2880 is left justified, centred, or right justified within the text
2881 area, but other values are allowed as well.
2883 text_colors (const PLINT *, input) : Array of nlegend text colors
2886 text (const char **, input) : Array of nlegend text string
2889 box_colors (const PLINT *, input) : Array of nlegend colors (cmap0
2890 indices) for the discrete colored boxes (
2891 PL_LEGEND_COLOR_BOX).
2893 box_patterns (const PLINT *, input) : Array of nlegend patterns
2894 (plpsty indices) for the discrete colored boxes (
2895 PL_LEGEND_COLOR_BOX).
2897 box_scales (const PLFLT *, input) : Array of nlegend scales (units
2898 of fraction of character height) for the height of the discrete
2900 PL_LEGEND_COLOR_BOX).
2902 box_line_widths (const PLFLT *, input) : Array of nlegend line
2903 widths for the patterns specified by box_patterns (
2904 PL_LEGEND_COLOR_BOX).
2906 line_colors (const PLINT *, input) : Array of nlegend line colors
2910 line_styles (const PLINT *, input) : Array of nlegend line styles
2914 line_widths (const PLFLT *, input) : Array of nlegend line widths (
2917 symbol_colors (const PLINT *, input) : Array of nlegend symbol
2918 colors (cmap0 indices) (
2921 symbol_scales (const PLFLT *, input) : Array of nlegend scale
2922 values for the symbol height (
2925 symbol_numbers (const PLINT *, input) : Array of nlegend numbers of
2926 symbols to be drawn across the width of the plotted area (
2929 symbols (const char **, input) : Array of nlegend symbols (plpoin
2934 return _plplotc.pllegend(*args)
2937 return _plplotc.plcolorbar(*args)
2938 plcolorbar = _plplotc.plcolorbar
2942 Sets the 3D position of the light source
2946 Sets the 3D position of the light source for use with plsurf3d.
2948 Redacted form: pllightsource(x, y, z)
2950 This function is used in example 8.
2956 pllightsource(x, y, z)
2960 x (PLFLT, input) : X-coordinate of the light source.
2962 y (PLFLT, input) : Y-coordinate of the light source.
2964 z (PLFLT, input) : Z-coordinate of the light source.
2967 return _plplotc.pllightsource(*args)
2975 Draws line defined by n points in x and y.
2977 Redacted form: plline(x, y)
2979 This function is used in examples 1,3,4,9,12-14,16,18,20,22,25-27,29.
2989 n (PLINT, input) : Number of points defining line.
2991 x (PLFLT *, input) : Pointer to array with x coordinates of points.
2993 y (PLFLT *, input) : Pointer to array with y coordinates of points.
2996 return _plplotc.plline(*args)
3000 Draw a line in 3 space
3004 Draws line in 3 space defined by n points in x, y, and z. You must
3005 first set up the viewport, the 2d viewing window (in world
3006 coordinates), and the 3d normalized coordinate box. See x18c.c for
3009 Redacted form: plline3(x, y, z)
3011 This function is used in example 18.
3021 n (PLINT, input) : Number of points defining line.
3023 x (PLFLT *, input) : Pointer to array with x coordinates of points.
3025 y (PLFLT *, input) : Pointer to array with y coordinates of points.
3027 z (PLFLT *, input) : Pointer to array with z coordinates of points.
3030 return _plplotc.plline3(*args)
3038 This sets the line style according to one of eight predefined patterns
3041 Redacted form: pllsty(n)
3043 This function is used in examples 9,12,22,25.
3053 n (PLINT, input) : Integer value between 1 and 8. Line style 1 is a
3054 continuous line, line style 2 is a line with short dashes and
3055 gaps, line style 3 is a line with long dashes and gaps, line style
3056 4 has long dashes and short gaps and so on.
3059 return _plplotc.pllsty(*args)
3067 Plots a surface mesh within the environment set up by plw3d. The
3068 surface is defined by the two-dimensional array z[
3070 ny], the point z[i][j] being the value of the function at (
3072 y[j]). Note that the points in arrays x and y do not need to be
3073 equally spaced, but must be stored in ascending order. The parameter
3074 opt controls the way in which the surface is displayed. For further
3075 details see the PLplot documentation.
3077 Redacted form: plmesh(x, y, z, opt)
3079 This function is used in example 11.
3085 plmesh(x, y, z, nx, ny, opt)
3089 x (PLFLT *, input) : Pointer to set of x coordinate values at which
3090 the function is evaluated.
3092 y (PLFLT *, input) : Pointer to set of y coordinate values at which
3093 the function is evaluated.
3095 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
3096 with set of function values.
3098 nx (PLINT, input) : Number of x values at which function is
3101 ny (PLINT, input) : Number of y values at which function is
3104 opt (PLINT, input) : Determines the way in which the surface is
3105 represented: opt=DRAW_LINEX: Lines are drawn showing z as a
3106 function of x for each value of y[j].
3107 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
3108 for each value of x[i].
3109 opt=DRAW_LINEXY: Network of lines is drawn connecting points
3110 at which function is defined.
3113 return _plplotc.plmesh(*args)
3117 Magnitude colored plot surface mesh with contour.
3121 Identical to plmesh but with extra functionalities: the surface mesh
3122 can be colored accordingly to the current z value being plotted, a
3123 contour plot can be drawn at the base XY plane, and a curtain can be
3124 drawn between the plotted function border and the base XY plane.
3126 Redacted form: plmeshc(x, y, z, opt, clevel)
3128 This function is used in example 11.
3134 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
3138 x (PLFLT *, input) : Pointer to set of x coordinate values at which
3139 the function is evaluated.
3141 y (PLFLT *, input) : Pointer to set of y coordinate values at which
3142 the function is evaluated.
3144 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
3145 with set of function values.
3147 nx (PLINT, input) : Number of x values at which function is
3150 ny (PLINT, input) : Number of y values at which function is
3153 opt (PLINT, input) : Determines the way in which the surface is
3154 represented. To specify more than one option just add the options,
3155 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX: Lines are drawn
3156 showing z as a function of x for each value of y[j].
3157 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
3158 for each value of x[i].
3159 opt=DRAW_LINEXY: Network of lines is drawn connecting points
3160 at which function is defined.
3161 opt=MAG_COLOR: Each line in the mesh is colored according to
3162 the z value being plotted. The color is used from the current
3164 opt=BASE_CONT: A contour plot is drawn at the base XY plane
3168 opt=DRAW_SIDES: draws a curtain between the base XY plane and
3169 the borders of the plotted function.
3172 clevel (PLFLT *, input) : Pointer to the array that defines the
3173 contour level spacing.
3175 nlevel (PLINT, input) : Number of elements in the clevel array.
3178 return _plplotc.plmeshc(*args)
3182 Creates a new stream and makes it the default
3186 Creates a new stream and makes it the default. Differs from using
3187 plsstrm, in that a free stream number is found, and returned.
3188 Unfortunately, I have to start at stream 1 and work upward, since
3189 stream 0 is preallocated. One of the big flaws in the PLplot API is
3190 that no initial, library-opening call is required. So stream 0 must
3191 be preallocated, and there is no simple way of determining whether it
3192 is already in use or not.
3194 Redacted form: plmkstrm(p_strm)
3196 This function is used in examples 1,20.
3206 p_strm (PLINT *, output) : Pointer to stream number of the created
3210 return _plplotc.plmkstrm()
3214 Write text relative to viewport boundaries
3218 Writes text at a specified position relative to the viewport
3219 boundaries. Text may be written inside or outside the viewport, but
3220 is clipped at the subpage boundaries. The reference point of a string
3221 lies along a line passing through the string at half the height of a
3222 capital letter. The position of the reference point along this line
3223 is determined by just, and the position of the reference point
3224 relative to the viewport is set by disp and pos.
3226 Redacted form: General: plmtex(side, disp, pos, just, text)
3227 Perl/PDL: plmtex(disp, pos, just, side, text)
3230 This function is used in examples 3,4,6-8,11,12,14,18,23,26.
3236 plmtex(side, disp, pos, just, text)
3240 side (const char *, input) : Specifies the side of the viewport
3241 along which the text is to be written. The string must be one of:
3242 b: Bottom of viewport, text written parallel to edge.
3243 bv: Bottom of viewport, text written at right angles to edge.
3244 l: Left of viewport, text written parallel to edge.
3245 lv: Left of viewport, text written at right angles to edge.
3246 r: Right of viewport, text written parallel to edge.
3247 rv: Right of viewport, text written at right angles to edge.
3248 t: Top of viewport, text written parallel to edge.
3249 tv: Top of viewport, text written at right angles to edge.
3252 disp (PLFLT, input) : Position of the reference point of string,
3253 measured outwards from the specified viewport edge in units of the
3254 current character height. Use negative disp to write within the
3257 pos (PLFLT, input) : Position of the reference point of string
3258 along the specified edge, expressed as a fraction of the length of
3261 just (PLFLT, input) : Specifies the position of the string relative
3262 to its reference point. If just=0., the reference point is at the
3263 left and if just=1., it is at the right of the string. Other
3264 values of just give intermediate justifications.
3266 text (const char *, input) : The string to be written out.
3269 return _plplotc.plmtex(*args)
3273 Write text relative to viewport boundaries in 3D plots.
3277 Writes text at a specified position relative to the viewport
3278 boundaries. Text may be written inside or outside the viewport, but
3279 is clipped at the subpage boundaries. The reference point of a string
3280 lies along a line passing through the string at half the height of a
3281 capital letter. The position of the reference point along this line
3282 is determined by just, and the position of the reference point
3283 relative to the viewport is set by disp and pos.
3285 Redacted form: plmtex3(side, disp, pos, just, text)
3287 This function is used in example 28.
3293 plmtex3(side, disp, pos, just, text)
3297 side (const char *, input) : Specifies the side of the viewport
3298 along which the text is to be written. The string should contain
3299 one or more of the following characters: [xyz][ps][v]. Only one
3300 label is drawn at a time, i.e. xyp will only label the X axis, not
3301 both the X and Y axes. x: Label the X axis.
3302 y: Label the Y axis.
3303 z: Label the Z axis.
3304 p: Label the primary axis. For Z this is the leftmost Z axis.
3305 For X it is the axis that starts at y-min. For Y it is the
3306 axis that starts at x-min.
3307 s: Label the secondary axis.
3308 v: Draw the text perpendicular to the axis.
3311 disp (PLFLT, input) : Position of the reference point of string,
3312 measured outwards from the specified viewport edge in units of the
3313 current character height. Use negative disp to write within the
3316 pos (PLFLT, input) : Position of the reference point of string
3317 along the specified edge, expressed as a fraction of the length of
3320 just (PLFLT, input) : Specifies the position of the string relative
3321 to its reference point. If just=0., the reference point is at the
3322 left and if just=1., it is at the right of the string. Other
3323 values of just give intermediate justifications.
3325 text (const char *, input) : The string to be written out.
3328 return _plplotc.plmtex3(*args)
3332 Plot 3-d surface plot
3336 Plots a three dimensional surface plot within the environment set up
3337 by plw3d. The surface is defined by the two-dimensional array z[
3339 ny], the point z[i][j] being the value of the function at (
3341 y[j]). Note that the points in arrays x and y do not need to be
3342 equally spaced, but must be stored in ascending order. The parameter
3343 opt controls the way in which the surface is displayed. For further
3344 details see the PLplot documentation. The only difference between
3345 plmesh and plot3d is that plmesh draws the bottom side of the surface,
3346 while plot3d only draws the surface as viewed from the top.
3348 Redacted form: plot3d(x, y, z, opt, side)
3350 This function is used in examples 11,21.
3356 plot3d(x, y, z, nx, ny, opt, side)
3360 x (PLFLT *, input) : Pointer to set of x coordinate values at which
3361 the function is evaluated.
3363 y (PLFLT *, input) : Pointer to set of y coordinate values at which
3364 the function is evaluated.
3366 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
3367 with set of function values.
3369 nx (PLINT, input) : Number of x values at which function is
3372 ny (PLINT, input) : Number of y values at which function is
3375 opt (PLINT, input) : Determines the way in which the surface is
3376 represented: opt=DRAW_LINEX: Lines are drawn showing z as a
3377 function of x for each value of y[j].
3378 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
3379 for each value of x[i].
3380 opt=DRAW_LINEXY: Network of lines is drawn connecting points
3381 at which function is defined.
3384 side (PLBOOL, input) : Flag to indicate whether or not ``sides''
3385 should be draw on the figure. If side is true sides are drawn,
3386 otherwise no sides are drawn.
3389 return _plplotc.plot3d(*args)
3393 Magnitude colored plot surface with contour.
3397 Identical to plot3d but with extra functionalities: the surface mesh
3398 can be colored accordingly to the current z value being plotted, a
3399 contour plot can be drawn at the base XY plane, and a curtain can be
3400 drawn between the plotted function border and the base XY plane. The
3401 arguments are identical to plmeshc. The only difference between
3402 plmeshc and plot3dc is that plmeshc draws the bottom side of the
3403 surface, while plot3dc only draws the surface as viewed from the top.
3405 Redacted form: General: plot3dc(x, y, z, opt, clevel)
3406 Perl/PDL: Not available?
3409 This function is used in example 21.
3415 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
3418 return _plplotc.plot3dc(*args)
3421 return _plplotc.plot3dcl(*args)
3422 plot3dcl = _plplotc.plot3dcl
3426 Plot shaded 3-d surface plot
3430 Plots a three dimensional shaded surface plot within the environment
3431 set up by plw3d. The surface is defined by the two-dimensional array
3434 ny], the point z[i][j] being the value of the function at (
3436 y[j]). Note that the points in arrays x and y do not need to be
3437 equally spaced, but must be stored in ascending order. For further
3438 details see the PLplot documentation.
3440 Redacted form: plsurf3d(x, y, z, opt, clevel)
3442 This function is not used in any examples.
3448 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
3452 x (PLFLT *, input) : Pointer to set of x coordinate values at which
3453 the function is evaluated.
3455 y (PLFLT *, input) : Pointer to set of y coordinate values at which
3456 the function is evaluated.
3458 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
3459 with set of function values.
3461 nx (PLINT, input) : Number of x values at which function is
3464 ny (PLINT, input) : Number of y values at which function is
3467 opt (PLINT, input) : Determines the way in which the surface is
3468 represented. To specify more than one option just add the options,
3469 e.g. FACETED + SURF_CONT opt=FACETED: Network of lines is drawn
3470 connecting points at which function is defined.
3471 opt=BASE_CONT: A contour plot is drawn at the base XY plane
3475 opt=SURF_CONT: A contour plot is drawn at the surface plane
3479 opt=DRAW_SIDES: draws a curtain between the base XY plane and
3480 the borders of the plotted function.
3481 opt=MAG_COLOR: the surface is colored according to the value
3482 of Z; if MAG_COLOR is not used, then the default the surface
3483 is colored according to the intensity of the reflected light
3484 in the surface from a light source whose position is set using
3488 clevel (PLFLT *, input) : Pointer to the array that defines the
3489 contour level spacing.
3491 nlevel (PLINT, input) : Number of elements in the clevel array.
3494 return _plplotc.plsurf3d(*args)
3497 return _plplotc.plsurf3dl(*args)
3498 plsurf3dl = _plplotc.plsurf3dl
3502 Parse command-line arguments
3506 Parse command-line arguments.
3508 plparseopts removes all recognized flags (decreasing argc
3509 accordingly), so that invalid input may be readily detected. It can
3510 also be used to process user command line flags. The user can merge
3511 an option table of type PLOptionTable into the internal option table
3512 info structure using plMergeOpts. Or, the user can specify that ONLY
3513 the external table(s) be parsed by calling plClearOpts before
3516 The default action taken by plparseopts is as follows:
3517 Returns with an error if an unrecognized option or badly formed
3518 option-value pair are encountered.
3519 Returns immediately (return code 0) when the first non-option command
3520 line argument is found.
3521 Returns with the return code of the option handler, if one was called.
3523 Deletes command line arguments from argv list as they are found, and
3524 decrements argc accordingly.
3525 Does not show "invisible" options in usage or help messages.
3526 Assumes the program name is contained in argv[0].
3528 These behaviors may be controlled through the
3531 Redacted form: General: plparseopts(argv, mode)
3532 Perl/PDL: Not available?
3535 This function is used in all of the examples.
3541 int plparseopts(p_argc, argv, mode)
3545 p_argc (int *, input) : pointer to number of arguments.
3547 argv (char **, input) : Pointer to character array containing
3548 *p_argc command-line arguments.
3550 mode (PLINT, input) : Parsing mode with the following
3551 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
3552 and all error messages enabled, including program exit when an
3553 error occurs. Anything on the command line that isn't recognized
3554 as a valid option or option argument is flagged as an error.
3555 PL_PARSE_QUIET (2) -- Turns off all output except in the case
3557 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
3559 PL_PARSE_SHOWALL (8) -- Show invisible options
3560 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a
3561 pointer to the program name.
3562 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required.
3563 PL_PARSE_SKIP (128) -- Set to quietly skip over any
3564 unrecognized arguments.
3567 return _plplotc.plparseopts(*args)
3571 Set area fill pattern
3575 Sets the area fill pattern. The pattern consists of 1 or 2 sets of
3576 parallel lines with specified inclinations and spacings. The
3577 arguments to this routine are the number of sets to use (1 or 2)
3578 followed by two pointers to integer arrays (of 1 or 2 elements)
3579 specifying the inclinations in tenths of a degree and the spacing in
3580 micrometers. (also see plpsty)
3582 Redacted form: General: plpat(inc, del)
3583 Perl/PDL: plpat(nlin, inc, del)
3586 This function is used in example 15.
3592 plpat(nlin, inc, del)
3596 nlin (PLINT, input) : Number of sets of lines making up the
3597 pattern, either 1 or 2.
3599 inc (PLINT *, input) : Pointer to array with nlin elements.
3600 Specifies the line inclination in tenths of a degree. (Should be
3601 between -900 and 900).
3603 del (PLINT *, input) : Pointer to array with nlin elements.
3604 Specifies the spacing in micrometers between the lines making up
3608 return _plplotc.plpat(*args)
3612 Plot a glyph at the specified points
3616 Plot a glyph at the specified points. (This function is largely
3617 superseded by plstring which gives access to many[!] more glyphs.)
3618 code=-1 means try to just draw a point. Right now it's just a move
3619 and a draw at the same place. Not ideal, since a sufficiently
3620 intelligent output device may optimize it away, or there may be faster
3621 ways of doing it. This is OK for now, though, and offers a 4X speedup
3622 over drawing a Hershey font "point" (which is actually diamond shaped
3623 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
3624 useful (but small subset) of Hershey symbols is plotted. If 32 <=
3625 code <= 127 the corresponding printable ASCII character is plotted.
3627 Redacted form: plpoin(x, y, code)
3629 This function is used in examples 1,6,14,29.
3635 plpoin(n, x, y, code)
3639 n (PLINT, input) : Number of points in the x and y arrays.
3641 x (PLFLT *, input) : Pointer to an array with X coordinates of
3644 y (PLFLT *, input) : Pointer to an array with Y coordinates of
3647 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
3648 with -1 <= code <= 127) corresponding to a glyph to be plotted at
3649 each of the n points.
3652 return _plplotc.plpoin(*args)
3656 Plot a glyph at the specified 3D points
3660 Plot a glyph at the specified 3D points. (This function is largely
3661 superseded by plstring3 which gives access to many[!] more glyphs.)
3662 Set up the call to this function similar to what is done for plline3.
3663 code=-1 means try to just draw a point. Right now it's just a move
3664 and a draw at the same place. Not ideal, since a sufficiently
3665 intelligent output device may optimize it away, or there may be faster
3666 ways of doing it. This is OK for now, though, and offers a 4X speedup
3667 over drawing a Hershey font "point" (which is actually diamond shaped
3668 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
3669 useful (but small subset) of Hershey symbols is plotted. If 32 <=
3670 code <= 127 the corresponding printable ASCII character is plotted.
3672 Redacted form: plpoin3(x, y, z, code)
3674 This function is not used in any example.
3680 plpoin3(n, x, y, z, code)
3684 n (PLINT, input) : Number of points in the x and y arrays.
3686 x (PLFLT *, input) : Pointer to an array with X coordinates of
3689 y (PLFLT *, input) : Pointer to an array with Y coordinates of
3692 z (PLFLT *, input) : Pointer to an array with Z coordinates of
3695 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
3696 with -1 <= code <= 127) corresponding to a glyph to be plotted at
3697 each of the n points.
3700 return _plplotc.plpoin3(*args)
3704 Draw a polygon in 3 space
3708 Draws a polygon in 3 space defined by n points in x, y, and z. Setup
3709 like plline3, but differs from that function in that plpoly3 attempts
3710 to determine if the polygon is viewable depending on the order of the
3711 points within the arrays and the value of ifcc. If the back of
3712 polygon is facing the viewer, then it isn't drawn. If this isn't what
3713 you want, then use plline3 instead.
3715 The points are assumed to be in a plane, and the directionality of the
3716 plane is determined from the first three points. Additional points do
3717 not have to lie on the plane defined by the first three, but if they
3718 do not, then the determination of visibility obviously can't be 100%
3719 accurate... So if you're 3 space polygons are too far from planar,
3720 consider breaking them into smaller polygons. 3 points define a plane
3723 Bugs: If one of the first two segments is of zero length, or if they
3724 are co-linear, the calculation of visibility has a 50/50 chance of
3725 being correct. Avoid such situations :-). See x18c.c for an example
3726 of this problem. (Search for 20.1).
3728 Redacted form: plpoly3(x, y, z, code)
3730 This function is used in example 18.
3736 plpoly3(n, x, y, z, draw, ifcc)
3740 n (PLINT, input) : Number of points defining line.
3742 x (PLFLT *, input) : Pointer to array with x coordinates of points.
3744 y (PLFLT *, input) : Pointer to array with y coordinates of points.
3746 z (PLFLT *, input) : Pointer to array with z coordinates of points.
3748 draw (PLBOOL *, input) : Pointer to array which controls drawing
3749 the segments of the polygon. If draw[i] is true, then the polygon
3750 segment from index [i] to [i+1] is drawn, otherwise, not.
3752 ifcc (PLBOOL, input) : If ifcc is true the directionality of the
3753 polygon is determined by assuming the points are laid out in a
3754 counter-clockwise order. Otherwise, the directionality of the
3755 polygon is determined by assuming the points are laid out in a
3759 return _plplotc.plpoly3(*args)
3763 Set precision in numeric labels
3767 Sets the number of places after the decimal point in numeric labels.
3769 Redacted form: plprec(set, prec)
3771 This function is used in example 29.
3781 set (PLINT, input) : If set is equal to 0 then PLplot automatically
3782 determines the number of places to use after the decimal point in
3783 numeric labels (like those used to label axes). If set is 1 then
3784 prec sets the number of places.
3786 prec (PLINT, input) : The number of characters to draw after the
3787 decimal point in numeric labels.
3790 return _plplotc.plprec(*args)
3794 Select area fill pattern
3798 Select one of eight predefined area fill patterns to use (also see
3799 plpat). Setting the fill style to 0 gives a solid fill.
3801 Redacted form: plpsty(n)
3803 This function is used in examples 12,13,15,16,25.
3813 n (PLINT, input) : The desired pattern. Pattern 1 consists of
3814 horizontal lines, pattern 2 consists of vertical lines, pattern 3
3815 consists of lines at 45 degrees angle (upward), and so on.
3818 return _plplotc.plpsty(*args)
3822 Write text inside the viewport
3826 Writes text at a specified position and inclination within the
3827 viewport. Text is clipped at the viewport boundaries. The reference
3828 point of a string lies along a line passing through the string at half
3829 the height of a capital letter. The position of the reference point
3830 along this line is determined by just, the reference point is placed
3831 at world coordinates (
3833 y) within the viewport. The inclination of the string is specified in
3834 terms of differences of world coordinates making it easy to write text
3835 parallel to a line in a graph.
3837 Redacted form: plptex(x, y, dx, dy, just, text)
3839 This function is used in example 2-4,10,12-14,20,23,24,26.
3845 plptex(x, y, dx, dy, just, text)
3849 x (PLFLT, input) : x coordinate of reference point of string.
3851 y (PLFLT, input) : y coordinate of reference point of string.
3853 dx (PLFLT, input) : Together with dy, this specifies the
3854 inclination of the string. The baseline of the string is parallel
3863 dy (PLFLT, input) : Together with dx, this specifies the
3864 inclination of the string.
3866 just (PLFLT, input) : Specifies the position of the string relative
3867 to its reference point. If just=0., the reference point is at the
3868 left and if just=1., it is at the right of the string. Other
3869 values of just give intermediate justifications.
3871 text (const char *, input) : The string to be written out.
3874 return _plplotc.plptex(*args)
3878 Write text inside the viewport of a 3D plot.
3882 Writes text at a specified position and inclination and with a
3883 specified shear within the viewport. Text is clipped at the viewport
3884 boundaries. The reference point of a string lies along a line passing
3885 through the string at half the height of a capital letter. The
3886 position of the reference point along this line is determined by just,
3887 and the reference point is placed at world coordinates (
3890 z) within the viewport. The inclination and shear of the string is
3891 specified in terms of differences of world coordinates making it easy
3892 to write text parallel to a line in a graph.
3894 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
3896 This function is used in example 28.
3902 plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
3906 x (PLFLT, input) : x coordinate of reference point of string.
3908 y (PLFLT, input) : y coordinate of reference point of string.
3910 z (PLFLT, input) : z coordinate of reference point of string.
3912 dx (PLFLT, input) : Together with dy and
3913 dz, this specifies the inclination of the string. The baseline of
3914 the string is parallel to a line joining (
3925 dy (PLFLT, input) : Together with dx and
3926 dz, this specifies the inclination of the string.
3928 dz (PLFLT, input) : Together with dx and
3929 dy, this specifies the inclination of the string.
3931 sx (PLFLT, input) : Together with sy and
3932 sz, this specifies the shear of the string. The string is sheared so
3933 that the characters are vertically parallel to a line joining (
3944 sz = 0.) then the text is not sheared.
3946 sy (PLFLT, input) : Together with sx and
3947 sz, this specifies shear of the string.
3949 sz (PLFLT, input) : Together with sx and
3950 sy, this specifies shear of the string.
3952 just (PLFLT, input) : Specifies the position of the string relative
3953 to its reference point. If just=0., the reference point is at the
3954 left and if just=1., it is at the right of the string. Other
3955 values of just give intermediate justifications.
3957 text (const char *, input) : The string to be written out.
3960 return _plplotc.plptex3(*args)
3964 Random number generator returning a real random number in the range [0,1].
3968 Random number generator returning a real random number in the range
3969 [0,1]. The generator is based on the Mersenne Twister. Most languages
3970 / compilers provide their own random number generator, and so this is
3971 provided purely for convenience and to give a consistent random number
3972 generator across all languages supported by PLplot. This is
3973 particularly useful for comparing results from the test suite of
3976 Redacted form: plrandd()
3978 This function is used in examples 17,21.
3987 return _plplotc.plrandd()
3991 Replays contents of plot buffer to current device/file
3995 Replays contents of plot buffer to current device/file.
3997 Redacted form: plreplot()
3999 This function is used in example 1,20.
4008 return _plplotc.plreplot()
4012 Convert RGB color to HLS
4016 Convert RGB color coordinates to HLS
4018 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
4019 Perl/PDL: Not available? Implemented as plrgb/plrgb1?
4022 This function is used in example 2.
4028 plrgbhls(r, g, b, p_h, p_l, p_s)
4032 r (PLFLT, input) : Red intensity (0.0-1.0) of the colour
4034 g (PLFLT, input) : Green intensity (0.0-1.0) of the colour
4036 b (PLFLT, input) : Blue intensity (0.0-1.0) of the colour
4038 p_h (PLFLT *, output) : Pointer to hue, in degrees on the colour
4041 p_l (PLFLT *, output) : Pointer to lightness, expressed as a
4042 fraction of the axis of the colour cone (0.0-1.0)
4044 p_s (PLFLT *, output) : Pointer to saturation, expressed as a
4045 fraction of the radius of the colour cone (0.0-1.0)
4048 return _plplotc.plrgbhls(*args)
4056 This sets up the size of all subsequent characters drawn. The actual
4057 height of a character is the product of the default character size and
4060 Redacted form: plschr(def, scale)
4062 This function is used in example 2,13,23,24.
4072 def (PLFLT, input) : The default height of a character in
4073 millimeters, should be set to zero if the default height is to
4076 scale (PLFLT, input) : Scale factor to be applied to default to get
4077 actual character height.
4080 return _plplotc.plschr(*args)
4084 Set color map0 colors by 8-bit RGB values
4088 Set color map0 colors using 8-bit RGB values (see the PLplot
4089 documentation). This sets the entire color map -- only as many colors
4090 as specified will be allocated.
4092 Redacted form: plscmap0(r, g, b, ncol0)
4094 This function is used in examples 2,24.
4100 plscmap0(r, g, b, ncol0)
4104 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4105 integers (0-255) representing the degree of red in the color.
4107 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4108 integers (0-255) representing the degree of green in the color.
4110 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4111 integers (0-255) representing the degree of blue in the color.
4113 ncol0 (PLINT, input) : Number of items in the r, g, and b arrays.
4116 return _plplotc.plscmap0(*args)
4120 Set color map0 colors by 8-bit RGB values and double alpha value.
4124 Set color map0 colors using 8-bit RGB values (see the PLplot
4125 documentation) and floating point alpha value. This sets the entire
4126 color map -- only as many colors as specified will be allocated.
4128 This function is used in examples 30.
4134 plscmap0a(r, g, b, a, ncol0)
4138 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4139 integers (0-255) representing the degree of red in the color.
4141 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4142 integers (0-255) representing the degree of green in the color.
4144 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4145 integers (0-255) representing the degree of blue in the color.
4147 a (PLFLT *, input) : Pointer to array with set of PLFLT values (0.0
4148 - 1.0) representing the transparency of the color.
4150 ncol0 (PLINT, input) : Number of items in the r, g, b, and a
4154 return _plplotc.plscmap0a(*args)
4158 Set number of colors in color map0
4162 Set number of colors in color map0 (see the PLplot documentation).
4163 Allocate (or reallocate) color map0, and fill with default values for
4164 those colors not previously allocated. The first 16 default colors are
4165 given in the plcol0 documentation. For larger indices the default
4168 The drivers are not guaranteed to support more than 16 colors.
4170 Redacted form: plscmap0n(ncol0)
4172 This function is used in examples 15,16,24.
4182 ncol0 (PLINT, input) : Number of colors that will be allocated in
4183 the map0 palette. If this number is zero or less, then the value
4184 from the previous call to plscmap0n is used and if there is no
4185 previous call, then a default value is used.
4188 return _plplotc.plscmap0n(*args)
4192 Set color map1 colors using 8-bit RGB values
4196 Set color map1 colors using 8-bit RGB values (see the PLplot
4197 documentation). This also sets the number of colors.
4199 Redacted form: plscmap1(r, g, b, ncol1)
4201 This function is used in example 31.
4207 plscmap1(r, g, b, ncol1)
4211 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4212 integers (0-255) representing the degree of red in the color.
4214 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4215 integers (0-255) representing the degree of green in the color.
4217 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4218 integers (0-255) representing the degree of blue in the color.
4220 ncol1 (PLINT, input) : Number of items in the r, g, and b arrays.
4223 return _plplotc.plscmap1(*args)
4227 Set color map1 colors using 8-bit RGB values and double alpha values.
4231 Set color map1 colors using 8-bit RGB values (see the PLplot
4232 documentation) and double alpha values. This also sets the number of
4235 This function is used in example 31.
4241 plscmap1a(r, g, b, a, ncol1)
4245 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4246 integers (0-255) representing the degree of red in the color.
4248 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4249 integers (0-255) representing the degree of green in the color.
4251 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
4252 integers (0-255) representing the degree of blue in the color.
4254 a (PLFLT *, input) : Pointer to array with set of double values
4255 (0.0-1.0) representing the alpha value of the color.
4257 ncol1 (PLINT, input) : Number of items in the r, g, b, and a
4261 return _plplotc.plscmap1a(*args)
4265 Set color map1 colors using a piece-wise linear relationship
4269 Set color map1 colors using a piece-wise linear relationship between
4270 position in the color map (from 0 to 1) and position in HLS or RGB
4271 color space (see the PLplot documentation). May be called at any
4274 The idea here is to specify a number of control points that define the
4275 mapping between palette 1 input positions (intensities) and HLS (or
4276 RGB). Between these points, linear interpolation is used which gives
4277 a smooth variation of color with input position. Any number of
4278 control points may be specified, located at arbitrary positions,
4279 although typically 2 - 4 are enough. Another way of stating this is
4280 that we are traversing a given number of lines through HLS (or RGB)
4281 space as we move through color map1 entries. The control points at
4282 the minimum and maximum position (0 and 1) must always be specified.
4283 By adding more control points you can get more variation. One good
4284 technique for plotting functions that vary about some expected average
4285 is to use an additional 2 control points in the center (position ~=
4286 0.5) that are the same lightness as the background (typically white
4287 for paper output, black for crt), and same hue as the boundary control
4288 points. This allows the highs and lows to be very easily
4291 Each control point must specify the position in color map1 as well as
4292 three coordinates in HLS or RGB space. The first point must
4293 correspond to position = 0, and the last to position = 1.
4295 The default behaviour is for the hue to be linearly interpolated
4296 between the control points. Since the hue lies in the range [0, 360]
4297 this corresponds to interpolation around the "front" of the color
4298 wheel (red<->green<->blue<->red). If alt_hue_path[i] is true, then an
4299 alternative interpolation is used between control points i and i+1. If
4300 hue[i+1]-hue[i] > 0 then interpolation is between hue[i] and
4301 hue[i+1] - 360, otherwise between hue[i] and hue[i+1] + 360. You can
4302 consider this as interpolation around the "back" or "reverse" of the
4303 color wheel. Specifying alt_hue_path=NULL is equivalent to setting
4304 alt_hue_path[] = false for every control point.
4306 Examples of interpolation Huealt_hue_pathcolor scheme[120
4307 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120
4308 240]truegreen-yellow-red-magenta-blue[240
4309 120]trueblue-magenta-red-yellow-green
4311 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
4312 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
4313 1]magnitudeHLSsaturation[0, 1]magnitude
4315 Redacted form: plscmap1l(itype, pos, coord1, coord2, coord3,
4318 This function is used in examples 8,11,12,15,20,21.
4324 plscmap1l(itype, npts, pos, coord1, coord2, coord3, alt_hue_path)
4328 itype (PLBOOL, input) : true: RGB, false: HLS.
4330 npts (PLINT, input) : number of control points
4332 pos (PLFLT *, input) : position for each control point (between 0.0
4333 and 1.0, in ascending order)
4335 coord1 (PLFLT *, input) : first coordinate (H or R) for each
4338 coord2 (PLFLT *, input) : second coordinate (L or G) for each
4341 coord3 (PLFLT *, input) : third coordinate (S or B) for each
4344 alt_hue_path (PLBOOL: *, input) : alternative interpolation method
4345 flag for each control point. (alt_hue_path[i] refers to the
4346 interpolation interval between the i and i + 1 control points).
4349 return _plplotc.plscmap1l(*args)
4353 Set color map1 colors using a piece-wise linear relationship
4357 This is a version of plscmap1l that supports alpha transparency. It
4358 sets color map1 colors using a piece-wise linear relationship between
4359 position in the color map (from 0 to 1) and position in HLS or RGB
4360 color space (see the PLplot documentation) with alpha value (0.0 -
4361 1.0). It may be called at any time.
4363 This function is used in example 30.
4369 plscmap1la(itype, npts, pos, coord1, coord2, coord3, coord4, alt_hue_path)
4373 itype (PLBOOL, input) : true: RGB, false: HLS.
4375 npts (PLINT, input) : number of control points
4377 pos (PLFLT *, input) : position for each control point (between 0.0
4378 and 1.0, in ascending order)
4380 coord1 (PLFLT *, input) : first coordinate (H or R) for each
4383 coord2 (PLFLT *, input) : second coordinate (L or G) for each
4386 coord3 (PLFLT *, input) : third coordinate (S or B) for each
4389 coord4 (PLFLT *, input) : fourth coordinate, the alpha value for
4392 alt_hue_path (PLBOOL: *, input) : alternative interpolation method
4393 flag for each control point. (alt_hue_path[i] refers to the
4394 interpolation interval between the i and i + 1 control points).
4397 return _plplotc.plscmap1la(*args)
4401 Set number of colors in color map1
4405 Set number of colors in color map1, (re-)allocate color map1, and set
4406 default values if this is the first allocation (see the PLplot
4409 Redacted form: plscmap1n(ncol1)
4411 This function is used in examples 8,11,20,21.
4421 ncol1 (PLINT, input) : Number of colors that will be allocated in
4422 the map1 palette. If this number is zero or less, then the value
4423 from the previous call to plscmap1n is used and if there is no
4424 previous call, then a default value is used.
4427 return _plplotc.plscmap1n(*args)
4430 return _plplotc.plscmap1_range(*args)
4431 plscmap1_range = _plplotc.plscmap1_range
4434 return _plplotc.plgcmap1_range()
4435 plgcmap1_range = _plplotc.plgcmap1_range
4439 Set a given color from color map0 by 8 bit RGB value
4443 Set a given color by 8-bit RGB value for color map0 (see the PLplot
4444 documentation). Overwrites the previous color value for the given
4445 index and, thus, does not result in any additional allocation of space
4448 Redacted form: plscol0(icol0, r, g, b)
4450 This function is not used in any examples.
4456 lscol0(icol0, r, g, b)
4460 icol0 (PLINT, input) : Color index. Must be less than the maximum
4461 number of colors (which is set by default, by plscmap0n, or even
4464 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4465 degree of red in the color.
4467 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4468 degree of green in the color.
4470 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4471 degree of blue in the color.
4474 return _plplotc.plscol0(*args)
4478 Set a given color from color map0 by 8 bit RGB value and double alpha value.
4482 Set a given color by 8-bit RGB value and double alpha value for color
4483 map0 (see the PLplot documentation). Overwrites the previous color
4484 value for the given index and, thus, does not result in any
4485 additional allocation of space for colors.
4487 This function is used in example 30.
4493 lscol0a(icol0, r, g, b, a)
4497 icol0 (PLINT, input) : Color index. Must be less than the maximum
4498 number of colors (which is set by default, by plscmap0n, or even
4501 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4502 degree of red in the color.
4504 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4505 degree of green in the color.
4507 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4508 degree of blue in the color.
4510 a (PLFLT, input) : double value (0.0-1.0) representing the alpha
4514 return _plplotc.plscol0a(*args)
4518 Set the background color by 8-bit RGB value
4522 Set the background color (color 0 in color map 0) by 8-bit RGB value
4523 (see the PLplot documentation).
4525 Redacted form: plscolbg(r, g, b)
4527 This function is used in examples 15,31.
4537 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4538 degree of red in the color.
4540 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4541 degree of green in the color.
4543 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4544 degree of blue in the color.
4547 return _plplotc.plscolbg(*args)
4551 Set the background color by 8-bit RGB value and double alpha value.
4555 Set the background color (color 0 in color map 0) by 8-bit RGB value
4556 (see the PLplot documentation) and double alpha value.
4558 This function is used in example 31.
4564 plscolbga(r, g, b, a)
4568 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4569 degree of red in the color.
4571 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4572 degree of green in the color.
4574 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
4575 degree of blue in the color.
4577 a (PLFLT, input) : double value (0.0-1.0) representing the alpha
4581 return _plplotc.plscolbga(*args)
4585 Used to globally turn color output on/off
4589 Used to globally turn color output on/off for those drivers/devices
4592 Redacted form: plscolor(color)
4594 This function is used in example 31.
4604 color (PLINT, input) : Color flag (Boolean). If zero, color is
4605 turned off. If non-zero, color is turned on.
4608 return _plplotc.plscolor(*args)
4612 Set device-compression level
4616 Set device-compression level. Only used for drivers that provide
4617 compression. This function, if used, should be invoked before a call
4620 Redacted form: plscompression(compression)
4622 This function is used in example 31.
4628 plscompression(compression)
4632 compression (PLINT, input) : The desired compression level. This is
4633 a device-dependent value. Currently only the jpeg and png devices
4634 use these values. For jpeg value is the jpeg quality which should
4635 normally be in the range 0-95. Higher values denote higher quality
4636 and hence larger image sizes. For png values are in the range -1
4637 to 99. Values of 0-9 are taken as the compression level for zlib.
4638 A value of -1 denotes the default zlib compression level. Values
4639 in the range 10-99 are divided by 10 and then used as the zlib
4640 compression level. Higher compression levels correspond to greater
4641 compression and small file sizes at the expense of more
4645 return _plplotc.plscompression(*args)
4649 Set the device (keyword) name
4653 Set the device (keyword) name.
4655 Redacted form: plsdev(devname)
4657 This function is used in examples 1,14,20.
4667 devname (const char *, input) : Pointer to device (keyword) name
4671 return _plplotc.plsdev(*args)
4675 Set parameters that define current device-space window
4679 Set relative margin width, aspect ratio, and relative justification
4680 that define current device-space window. If you want to just use the
4681 previous value for any of these, just pass in the magic value
4682 PL_NOTSET. It is unlikely that one should ever need to change the
4683 aspect ratio but it's in there for completeness. If plsdidev is not
4684 called the default values of mar, jx, and jy are all 0. aspect is set
4685 to a device-specific value.
4687 Redacted form: plsdidev(mar, aspect, jx, jy)
4689 This function is used in example 31.
4695 plsdidev(mar, aspect, jx, jy)
4699 mar (PLFLT, input) : Relative margin width.
4701 aspect (PLFLT, input) : Aspect ratio.
4703 jx (PLFLT, input) : Relative justification in x. Value must lie in
4704 the range -0.5 to 0.5.
4706 jy (PLFLT, input) : Relative justification in y. Value must lie in
4707 the range -0.5 to 0.5.
4710 return _plplotc.plsdidev(*args)
4714 Set up transformation from metafile coordinates
4718 Set up transformation from metafile coordinates. The size of the plot
4719 is scaled so as to preserve aspect ratio. This isn't intended to be a
4720 general-purpose facility just yet (not sure why the user would need
4723 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
4726 This function is not used in any examples.
4732 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
4736 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
4738 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
4740 dimymin (PLINT, input) : NEEDS DOCUMENTATION
4742 dimymax (PLINT, input) : NEEDS DOCUMENTATION
4744 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
4746 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
4749 return _plplotc.plsdimap(*args)
4753 Set plot orientation
4757 Set plot orientation parameter which is multiplied by 90 degrees to
4758 obtain the angle of rotation. Note, arbitrary rotation parameters
4759 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
4760 values for the rotation parameter are 0., 1., 2., and 3. corresponding
4761 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
4762 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is
4763 not called the default value of rot is 0.
4765 N.B. aspect ratio is unaffected by calls to plsdiori. So you will
4766 probably want to change the aspect ratio to a value suitable for the
4767 plot orientation using a call to plsdidev or the command-line options
4768 -a or -freeaspect. For more documentation of those options see the
4769 PLplot documentation. Such command-line options can be set internally
4770 using plsetopt or set directly using the command line and parsed using
4771 a call to plparseopts.
4773 Redacted form: plsdiori(rot)
4775 This function is not used in any examples.
4785 rot (PLFLT, input) : Plot orientation parameter.
4788 return _plplotc.plsdiori(*args)
4792 Set parameters that define current plot-space window
4796 Set relative minima and maxima that define the current plot-space
4797 window. If plsdiplt is not called the default values of xmin, ymin,
4798 xmax, and ymax are 0., 0., 1., and 1.
4800 Redacted form: plsdiplt(xmin, ymin, xmax, ymax)
4802 This function is used in example 31.
4808 plsdiplt(xmin, ymin, xmax, ymax)
4812 xmin (PLFLT, input) : Relative minimum in x.
4814 ymin (PLFLT, input) : Relative minimum in y.
4816 xmax (PLFLT, input) : Relative maximum in x.
4818 ymax (PLFLT, input) : Relative maximum in y.
4821 return _plplotc.plsdiplt(*args)
4825 Set parameters incrementally (zoom mode) that define current plot-space window
4829 Set relative minima and maxima incrementally (zoom mode) that define
4830 the current plot-space window. This function has the same effect as
4831 plsdiplt if that function has not been previously called. Otherwise,
4832 this function implements zoom mode using the transformation min_used =
4833 old_min + old_length*min and max_used = old_min + old_length*max for
4834 each axis. For example, if min = 0.05 and max = 0.95 for each axis,
4835 repeated calls to plsdiplz will zoom in by 10 per cent for each call.
4837 Redacted form: plsdiplz(xmin, ymin, xmax, ymax)
4839 This function is used in example 31.
4845 plsdiplz(xmin, ymin, xmax, ymax)
4849 xmin (PLFLT, input) : Relative (incremental) minimum in x.
4851 ymin (PLFLT, input) : Relative (incremental) minimum in y.
4853 xmax (PLFLT, input) : Relative (incremental) maximum in x.
4855 ymax (PLFLT, input) : Relative (incremental) maximum in y.
4858 return _plplotc.plsdiplz(*args)
4862 Set seed for internal random number generator.
4866 Set the seed for the internal random number generator. See plrandd for
4869 Redacted form: plseed(seed)
4871 This function is used in example 21.
4881 seed (unsigned int, input) : Seed for random number generator.
4884 return _plplotc.plseed(*args)
4888 Set the escape character for text strings
4892 Set the escape character for text strings. From C (in contrast to
4893 Fortran 77, see plsescfortran77) you pass esc as a character. Only
4894 selected characters are allowed to prevent the user from shooting
4895 himself in the foot (For example, a \ isn't allowed since it conflicts
4896 with C's use of backslash as a character escape). Here are the
4897 allowed escape characters and their corresponding decimal ASCII
4909 Redacted form: General: plsesc(esc)
4910 Perl/PDL: Not available?
4913 This function is used in example 29.
4923 esc (char, input) : Escape character.
4926 return _plplotc.plsesc(*args)
4930 Set any command-line option
4934 Set any command-line option internally from a program before it
4935 invokes plinit. opt is the name of the command-line option and optarg
4936 is the corresponding command-line option argument.
4938 This function returns 0 on success.
4940 Redacted form: plsetopt(opt, optarg)
4942 This function is used in example 14.
4948 int plsetopt(opt, optarg)
4952 opt (const char *, input) : Pointer to string containing the
4953 command-line option.
4955 optarg (const char *, input) : Pointer to string containing the
4956 argument of the command-line option.
4959 return _plplotc.plsetopt(*args)
4963 Set family file parameters
4967 Sets variables dealing with output file familying. Does nothing if
4968 familying not supported by the driver. This routine, if used, must be
4969 called before initializing PLplot. See the PLplot documentation for
4972 Redacted form: plsfam(fam, num, bmax)
4974 This function is used in examples 14,31.
4980 plsfam(fam, num, bmax)
4984 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
4987 num (PLINT, input) : Current family file number.
4989 bmax (PLINT, input) : Maximum file size (in bytes) for a family
4993 return _plplotc.plsfam(*args)
4997 Set FCI (font characterization integer)
5001 Sets font characteristics to be used at the start of the next string
5002 using the FCI approach. See the PLplot documentation for more
5005 Redacted form: General: plsfci(fci)
5006 Perl/PDL: Not available?
5009 This function is used in example 23.
5019 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
5023 return _plplotc.plsfci(*args)
5027 Set output file name
5031 Sets the current output file name, if applicable. If the file name
5032 has not been specified and is required by the driver, the user will be
5033 prompted for it. If using the X-windows output driver, this sets the
5034 display name. This routine, if used, must be called before
5035 initializing PLplot.
5037 Redacted form: plsfnam(fnam)
5039 This function is used in examples 1,20.
5049 fnam (const char *, input) : Pointer to file name string.
5052 return _plplotc.plsfnam(*args)
5056 Set family, style and weight of the current font
5060 Sets the current font. See the PLplot documentation for more
5061 information on font selection.
5063 Redacted form: plsfont(family, style, weight)
5065 This function is used in example 23.
5071 plsfont(family, style, weight)
5075 family (PLINT, input) : Font family to select for the current font.
5076 The available values are given by the PL_FCI_* constants in
5077 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
5078 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value
5079 signifies that the font family should not be altered.
5081 style (PLINT, input) : Font style to select for the current font.
5082 The available values are given by the PL_FCI_* constants in
5083 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and
5084 PL_FCI_OBLIQUE. A negative value signifies that the font style
5085 should not be altered.
5087 weight (PLINT, input) : Font weight to select for the current font.
5088 The available values are given by the PL_FCI_* constants in
5089 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A
5090 negative value signifies that the font weight should not be
5094 return _plplotc.plsfont(*args)
5098 Shade regions on the basis of value
5102 Shade regions on the basis of value. This is the high-level routine
5103 for making continuous color shaded plots with cmap1 while plshade (or
5104 plshade1) are used for individual shaded regions using either cmap0 or
5105 cmap1. examples/c/x16c.c shows a number of examples for using this
5106 function. See the following discussion of the arguments and the PLplot
5107 documentation for more information.
5109 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
5110 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
5112 Perl/PDL: plshades(a, xmin, xmax, ymin, ymax, clevel,
5113 fill_width, cont_color, cont_width, fill, rectangular, defined, pltr,
5117 This function is used in examples 16,21.
5123 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
5127 a (PLFLT **, input) : Contains ** pointer to array to be plotted.
5128 The array must have been declared as PLFLT a[nx][ny].
5130 nx (PLINT, input) : First dimension of array "a".
5132 ny (PLINT, input) : Second dimension of array "a".
5134 defined (PLINT (*) (PLFLT, PLFLT), input) : User function
5135 specifying regions excluded from the shading plot. This function
5136 accepts x and y coordinates as input arguments and must return 0
5137 if the point is in the excluded region or 1 otherwise. This
5138 argument can be NULL if all the values are valid.
5140 xmin (PLFLT, input) : Defines the "grid" coordinates. The data
5141 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5142 at (xmax,ymin) and so on.
5144 xmax (PLFLT, input) : Defines the "grid" coordinates. The data
5145 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5146 at (xmax,ymin) and so on.
5148 ymin (PLFLT, input) : Defines the "grid" coordinates. The data
5149 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5150 at (xmax,ymin) and so on.
5152 ymax (PLFLT, input) : Defines the "grid" coordinates. The data
5153 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5154 at (xmax,ymin) and so on.
5156 clevel (PLFLT *, input) : Pointer to array containing the data
5157 levels corresponding to the edges of each shaded region that will
5158 be plotted by this function. To work properly the levels should
5161 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
5162 of shade edge values in clevel).
5164 fill_width (PLFLT, input) : Defines line width used by the fill
5167 cont_color (PLINT, input) : Defines pen color used for contours
5168 defining edges of shaded regions. The pen color is only temporary
5169 set for the contour drawing. Set this value to zero or less if no
5170 shade edge contours are wanted.
5172 cont_width (PLFLT, input) : Defines line width used for contours
5173 defining edges of shaded regions. This value may not be honored
5174 by all drivers. The pen width is only temporary set for the
5175 contour drawing. Set this value to zero or less if no shade edge
5176 contours are wanted.
5178 fill (void (*) (PLINT, PLFLT *, PLFLT *), input) : Routine used to
5179 fill the region. Use plfill. Future version of PLplot may have
5180 other fill routines.
5182 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
5183 map to rectangles after coordinate transformation with pltrl.
5184 Otherwise, set rectangular to false. If rectangular is set to
5185 true, plshade tries to save time by filling large rectangles.
5186 This optimization fails if the coordinate transformation distorts
5187 the shape of rectangles. For example a plot in polar coordinates
5188 has to have rectangular set to false.
5190 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
5191 Pointer to function that defines transformation between indices
5192 in array z and the world coordinates (C only). Transformation
5193 functions are provided in the PLplot library: pltr0 for identity
5194 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
5195 defined by one- and two-dimensional arrays. In addition,
5196 user-supplied routines for the transformation can be used as well.
5197 Examples of all of these approaches are given in the PLplot
5198 documentation. The transformation function should have the form
5199 given by any of pltr0, pltr1, or pltr2.
5201 pltr_data (PLPointer, input) : Extra parameter to help pass
5202 information to pltr0, pltr1, pltr2, or whatever routine that is
5203 externally supplied.
5206 return _plplotc.plshades(*args)
5210 Shade individual region on the basis of value
5214 Shade individual region on the basis of value. Use plshades if you
5215 want to shade a number of regions using continuous colors. plshade is
5216 identical to plshade1 except for the type of the first parameter. See
5217 plshade1 for further discussion.
5219 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax,
5220 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
5221 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
5222 Perl/PDL: Not available?
5225 This function is used in example 15.
5231 lshade(a, nx, ny, defined, xmin, xmax, ymin, ymax, shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color, min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
5235 a (PLFLT **, input) :
5241 defined (PLINT (*) (PLFLT, PLFLT), input) :
5243 xmin (PLFLT, input) :
5245 xmax (PLFLT, input) :
5247 ymin (PLFLT, input) :
5249 ymax (PLFLT, input) :
5251 shade_min (PLFLT, input) :
5253 shade_max (PLFLT, input) :
5255 sh_cmap (PLINT, input) :
5257 sh_color (PLFLT, input) :
5259 sh_width (PLFLT, input) :
5261 min_color (PLINT, input) :
5263 min_width (PLFLT, input) :
5265 max_color (PLINT, input) :
5267 max_width (PLFLT, input) :
5269 fill (void (*) (PLINT, PLFLT *, PLFLT *), input) :
5271 rectangular (PLBOOL, input) :
5273 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
5275 pltr_data (PLPointer, input) :
5278 return _plplotc.plshade(*args)
5282 Assign a function to use for generating custom axis labels
5286 This function allows a user to provide their own function to provide
5287 axis label text. The user function is given the numeric value for a
5288 point on an axis and returns a string label to correspond with that
5289 value. Custom axis labels can be enabled by passing appropriate
5290 arguments to plenv, plbox, plbox3 and similar functions.
5292 This function is used in example 19.
5298 plslabelfunc(label_func, label_data)
5302 label_func (void (*) (PLINT, PLFLT, char *, PLINT, void *), input) :
5303 This is the custom label function. In order to reset to the
5304 default labeling, set this to NULL. The labeling function
5305 parameters are, in order: axis: This indicates which axis a
5306 label is being requested for. The value will be one of PL_X_AXIS,
5307 PL_Y_AXIS or PL_Z_AXIS.
5309 value: This is the value along the axis which is being labeled.
5311 label_text: The string representation of the label value.
5313 length: The maximum length in characters allowed for label_text.
5316 label_data (void *, input) : This parameter may be used to pass
5317 data to the label_func function.
5320 return _plplotc.plslabelfunc(*args)
5324 Set length of major ticks
5328 This sets up the length of the major ticks. The actual length is the
5329 product of the default length and a scaling factor as for character
5332 Redacted form: plsmaj(def, scale)
5334 This function is used in example 29.
5344 def (PLFLT, input) : The default length of a major tick in
5345 millimeters, should be set to zero if the default length is to
5348 scale (PLFLT, input) : Scale factor to be applied to default to get
5352 return _plplotc.plsmaj(*args)
5356 Set the memory area to be plotted (RGB)
5360 Set the memory area to be plotted (with the mem or memcairo driver) as
5361 the dev member of the stream structure. Also set the number of pixels
5362 in the memory passed in
5363 plotmem, which is a block of memory
5365 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
5367 This memory will have to be freed by the user!
5369 Redacted form: plsmem(maxx, maxy, plotmem)
5371 This function is not used in any examples.
5377 plsmem(maxx, maxy, plotmem)
5381 maxx (PLINT, input) : Size of memory area in the X coordinate.
5383 maxy (PLINT, input) : Size of memory area in the Y coordinate.
5385 plotmem (void *, input) : Pointer to the beginning of the
5386 user-supplied memory area.
5389 return _plplotc.plsmem(*args)
5393 Set the memory area to be plotted (RGBA)
5397 Set the memory area to be plotted (with the memcairo driver) as the
5398 dev member of the stream structure. Also set the number of pixels in
5399 the memory passed in
5400 plotmem, which is a block of memory
5402 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
5404 This memory will have to be freed by the user!
5406 Redacted form: plsmema(maxx, maxy, plotmem)
5408 This function is not used in any examples.
5414 plsmema(maxx, maxy, plotmem)
5418 maxx (PLINT, input) : Size of memory area in the X coordinate.
5420 maxy (PLINT, input) : Size of memory area in the Y coordinate.
5422 plotmem (void *, input) : Pointer to the beginning of the
5423 user-supplied memory area.
5426 return _plplotc.plsmema(*args)
5430 Set length of minor ticks
5434 This sets up the length of the minor ticks and the length of the
5435 terminals on error bars. The actual length is the product of the
5436 default length and a scaling factor as for character height.
5438 Redacted form: plsmin(def, scale)
5440 This function is used in example 29.
5450 def (PLFLT, input) : The default length of a minor tick in
5451 millimeters, should be set to zero if the default length is to
5454 scale (PLFLT, input) : Scale factor to be applied to default to get
5458 return _plplotc.plsmin(*args)
5466 Set integer plot orientation parameter. This function is identical to
5467 plsdiori except for the type of the argument, and should be used in
5468 the same way. See the PLplot documentation for details.
5470 Redacted form: plsori(ori)
5472 This function is used in example 3.
5482 ori (PLINT, input) : Orientation value (0 for landscape, 1 for
5483 portrait, etc.) The value is multiplied by 90 degrees to get the
5487 return _plplotc.plsori(*args)
5495 Sets the page configuration (optional). If an individual parameter is
5496 zero then that parameter value is not updated. Not all parameters are
5497 recognized by all drivers and the interpretation is device-dependent.
5498 The X-window driver uses the length and offset parameters to determine
5499 the window size and location. The length and offset values are
5500 expressed in units that are specific to the current driver. For
5501 instance: screen drivers will usually interpret them as number of
5502 pixels, whereas printer drivers will usually use mm. This routine, if
5503 used, must be called before initializing PLplot.
5505 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff)
5507 This function is used in examples 14 and 31.
5513 plspage(xp, yp, xleng, yleng, xoff, yoff)
5517 xp (PLFLT, input) : Number of pixels/inch (DPI), x.
5519 yp (PLFLT, input) : Number of pixels/inch (DPI), y.
5521 xleng (PLINT , input) : Page length, x.
5523 yleng (PLINT, input) : Page length, y.
5525 xoff (PLINT, input) : Page offset, x.
5527 yoff (PLINT, input) : Page offset, y.
5530 return _plplotc.plspage(*args)
5534 Set the colors for color table 0 from a cmap0 file
5538 Set the colors for color table 0 from a cmap0 file
5540 Redacted form: plspal0(filename)
5542 This function is in example 16.
5552 filename (const char *, input) : The name of the cmap0 file, or a
5553 empty to string to specify the default cmap0 file.
5556 return _plplotc.plspal0(*args)
5560 Set the colors for color table 1 from a cmap1 file
5564 Set the colors for color table 1 from a cmap1 file
5566 Redacted form: plspal1(filename)
5568 This function is in example 16.
5578 filename (const char *, input) : The name of the cmap1 file, or a
5579 empty to string to specify the default cmap1 file.
5582 return _plplotc.plspal1(*args)
5586 Set the pause (on end-of-page) status
5590 Set the pause (on end-of-page) status.
5592 Redacted form: plspause(pause)
5594 This function is in examples 14,20.
5604 pause (PLBOOL, input) : If pause is true there will be a pause on
5605 end-of-page for those drivers which support this. Otherwise there
5609 return _plplotc.plspause(*args)
5613 Set current output stream
5617 Sets the number of the current output stream. The stream number
5618 defaults to 0 unless changed by this routine. The first use of this
5619 routine must be followed by a call initializing PLplot (e.g. plstar).
5621 Redacted form: plsstrm(strm)
5623 This function is examples 1,14,20.
5633 strm (PLINT, input) : The current stream number.
5636 return _plplotc.plsstrm(*args)
5640 Set the number of subpages in x and y
5644 Set the number of subpages in x and y.
5646 Redacted form: plssub(nx, ny)
5648 This function is examples 1,2,14,21,25,27.
5658 nx (PLINT, input) : Number of windows in x direction (i.e., number
5661 ny (PLINT, input) : Number of windows in y direction (i.e., number
5665 return _plplotc.plssub(*args)
5673 This sets up the size of all subsequent symbols drawn by plpoin and
5674 plsym. The actual height of a symbol is the product of the default
5675 symbol size and a scaling factor as for the character height.
5677 Redacted form: plssym(def, scale)
5679 This function is used in example 29.
5689 def (PLFLT, input) : The default height of a symbol in millimeters,
5690 should be set to zero if the default height is to remain
5693 scale (PLFLT, input) : Scale factor to be applied to default to get
5694 actual symbol height.
5697 return _plplotc.plssym(*args)
5705 Initializing the plotting package. The program prompts for the device
5706 keyword or number of the desired output device. Hitting a RETURN in
5707 response to the prompt is the same as selecting the first device. If
5708 only one device is enabled when PLplot is installed, plstar will issue
5709 no prompt. The output device is divided into nx by ny subpages, each
5710 of which may be used independently. The subroutine pladv is used to
5711 advance from one subpage to the next.
5713 Redacted form: plstar(nx, ny)
5715 This function is used in example 1.
5725 nx (PLINT, input) : Number of subpages to divide output page in the
5726 horizontal direction.
5728 ny (PLINT, input) : Number of subpages to divide output page in the
5732 return _plplotc.plstar(*args)
5740 Alternative to plstar for initializing the plotting package. The
5741 device name keyword for the desired output device must be supplied as
5742 an argument. The device keywords are the same as those printed out by
5743 plstar. If the requested device is not available, or if the input
5744 string is empty or begins with ``?'', the prompted startup of plstar
5745 is used. This routine also divides the output device into nx by ny
5746 subpages, each of which may be used independently. The subroutine
5747 pladv is used to advance from one subpage to the next.
5749 Redacted form: General: plstart(device, nx, ny)
5750 Perl/PDL: plstart(nx, ny, device)
5753 This function is not used in any examples.
5759 plstart(device, nx, ny)
5763 device (const char *, input) : Device name (keyword) of the
5764 required output device. If NULL or if the first character is a
5765 ``?'', the normal (prompted) startup is used.
5767 nx (PLINT, input) : Number of subpages to divide output page in the
5768 horizontal direction.
5770 ny (PLINT, input) : Number of subpages to divide output page in the
5774 return _plplotc.plstart(*args)
5778 Set a global coordinate transform function
5782 This function can be used to define a coordinate transformation which
5783 affects all elements drawn within the current plot window. The
5784 transformation function is similar to that provided for the plmap and
5785 plmeridians functions. The data parameter may be used to pass extra
5786 data to transform_fun.
5788 Redacted form: General: plstransform(transform_fun, data)
5791 This function is used in example 19.
5797 plstransform(transform_fun, data)
5801 transform_fun (void (*) (PLFLT, PLFLT, PLFLT*, PLFLT*, PLPointer) ,
5802 input) : Pointer to a function that defines a transformation
5803 from the input (x, y) coordinate to a new plot world coordiante.
5805 data (PLPointer, input) : Optional extra data for
5809 return _plplotc.plstransform(*args)
5813 Plot a glyph at the specified points
5817 Plot a glyph at the specified points. (Supersedes plpoin and plsym
5818 because many[!] more glyphs are accessible with plstring.) The glyph
5819 is specified with a PLplot user string. Note that the user string is
5820 not actually limited to one glyph so it is possible (but not normally
5821 useful) to plot more than one glyph at the specified points with this
5822 function. As with plmtex and plptex, the user string can contain FCI
5823 escapes to determine the font, UTF-8 code to determine the glyph or
5824 else PLplot escapes for Hershey or unicode text to determine the
5827 Redacted form: plstring(x, y, string)
5829 This function is used in examples 4, 21 and 26.
5835 plstring(n, x, y, string)
5839 n (PLINT, input) : Number of points in the x and y arrays.
5841 x (PLFLT *, input) : Pointer to an array with X coordinates of
5844 y (PLFLT *, input) : Pointer to an array with Y coordinates of
5847 string (const char *, input) : PLplot user string corresponding to
5848 the glyph to be plotted at each of the n points.
5851 return _plplotc.plstring(*args)
5855 Plot a glyph at the specified 3D points
5859 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because
5860 many[!] more glyphs are accessible with plstring3.) Set up the call to
5861 this function similar to what is done for plline3. The glyph is
5862 specified with a PLplot user string. Note that the user string is not
5863 actually limited to one glyph so it is possible (but not normally
5864 useful) to plot more than one glyph at the specified points with this
5865 function. As with plmtex and plptex, the user string can contain FCI
5866 escapes to determine the font, UTF-8 code to determine the glyph or
5867 else PLplot escapes for Hershey or unicode text to determine the
5870 Redacted form: plstring3(x, y, z, string)
5872 This function is used in example 18.
5878 plstring3(n, x, y, z, string)
5882 n (PLINT, input) : Number of points in the x, y, and z arrays.
5884 x (PLFLT *, input) : Pointer to an array with X coordinates of
5887 y (PLFLT *, input) : Pointer to an array with Y coordinates of
5890 z (PLFLT *, input) : Pointer to an array with Z coordinates of
5893 string (const char *, input) : PLplot user string corresponding to
5894 the glyph to be plotted at each of the n points.
5897 return _plplotc.plstring3(*args)
5901 Add a point to a stripchart
5905 Add a point to a given pen of a given stripchart. There is no need for
5906 all pens to have the same number of points or to be equally sampled in
5907 the x coordinate. Allocates memory and rescales as necessary.
5909 Redacted form: plstripa(id, p, x, y)
5911 This function is used in example 17.
5917 plstripa(id, p, x, y)
5921 id (PLINT, input) : Identification number (set up in plstripc) of
5924 p (PLINT, input) : Pen number (ranges from 0 to 3).
5926 x (PLFLT, input) : X coordinate of point to plot.
5928 y (PLFLT, input) : Y coordinate of point to plot.
5931 return _plplotc.plstripa(*args)
5935 Create a 4-pen stripchart
5939 Create a 4-pen stripchart, to be used afterwards by plstripa
5941 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
5942 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
5943 styline, legline, labx, laby, labz)
5944 Perl/PDL: plstripc(xmin, xmax, xjump, ymin, ymax, xlpos,
5945 ylpos, y_ascl, acc, colbox, collab, colline, styline, id, xspec,
5946 ypsec, legline, labx, laby, labtop)
5949 This function is used in example 17.
5955 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
5959 id (PLINT *, output) : Identification number of stripchart to use
5960 on plstripa and plstripd.
5962 xspec (char *, input) : X-axis specification as in plbox.
5964 yspec (char *, input) : Y-axis specification as in plbox.
5966 xmin (PLFLT, input) : Initial coordinates of plot box; they will
5967 change as data are added.
5969 xmax (PLFLT, input) : Initial coordinates of plot box; they will
5970 change as data are added.
5972 xjump (PLFLT, input) : When x attains xmax, the length of the plot
5973 is multiplied by the factor (1 +
5976 ymin (PLFLT, input) : Initial coordinates of plot box; they will
5977 change as data are added.
5979 ymax (PLFLT, input) : Initial coordinates of plot box; they will
5980 change as data are added.
5982 xlpos (PLFLT, input) : X legend box position (range from 0 to 1).
5984 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1).
5986 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is
5987 true, otherwise not.
5989 acc (PLBOOL, input) : Accumulate strip plot if acc is true,
5990 otherwise slide display.
5992 colbox (PLINT, input) : Plot box color index (cmap0).
5994 collab (PLINT, input) : Legend color index (cmap0).
5996 colline (PLINT *, input) : Pointer to array with color indices
5997 (cmap0) for the 4 pens.
5999 styline (PLINT *, input) : Pointer to array with line styles for
6002 legline (char **, input) : Pointer to character array containing
6003 legends for the 4 pens.
6005 labx (char *, input) : X-axis label.
6007 laby (char *, input) : Y-axis label.
6009 labtop (char *, input) : Plot title.
6012 return _plplotc.plstripc(*args)
6016 Deletes and releases memory used by a stripchart
6020 Deletes and releases memory used by a stripchart.
6022 Redacted form: plstripd(id)
6024 This function is used in example 17.
6034 id (PLINT, input) : Identification number of stripchart to delete.
6037 return _plplotc.plstripd(*args)
6045 This sets up the line style for all lines subsequently drawn. A line
6046 consists of segments in which the pen is alternately down and up. The
6047 lengths of these segments are passed in the arrays mark and space
6048 respectively. The number of mark-space pairs is specified by nels.
6049 In order to return the line style to the default continuous line,
6050 plstyl should be called with nels=0.(see also pllsty)
6052 Redacted form: plstyl(mark, space)
6054 This function is used in examples 1,9,14.
6060 plstyl(nels, mark, space)
6064 nels (PLINT, input) : The number of mark and space elements in a
6065 line. Thus a simple broken line can be obtained by setting
6066 nels=1. A continuous line is specified by setting nels=0.
6068 mark (PLINT *, input) : Pointer to array with the lengths of the
6069 segments during which the pen is down, measured in micrometers.
6071 space (PLINT *, input) : Pointer to array with the lengths of the
6072 segments during which the pen is up, measured in micrometers.
6075 return _plplotc.plstyl(*args)
6079 Set arrow style for vector plots
6083 Set the style for the arrow used by plvect to plot vectors.
6085 Redacted form: plsvect(arrowx, arrowy, fill)
6087 This function is used in example 22.
6093 plsvect(arrowx, arrowy, npts, fill)
6097 arrowx, arrowy (PLFLT *,input) : Pointers to a pair of arrays
6098 containing the x and y points which make up the arrow. The arrow
6099 is plotted by joining these points to form a polygon. The scaling
6100 assumes that the x and y points in the arrow lie in the range -0.5
6103 npts (PLINT,input) : Number of points in the arrays arrowx and
6106 fill (PLBOOL,input) : If fill is true then the arrow is closed, if
6107 fill is false then the arrow is open.
6110 return _plplotc.plsvect(*args)
6114 Specify viewport in absolute coordinates
6118 Alternate routine to plvpor for setting up the viewport. This routine
6119 should be used only if the viewport is required to have a definite
6120 size in millimeters. The routine plgspa is useful for finding out the
6121 size of the current subpage.
6123 Redacted form: plsvpa(xmin, xmax, ymin, ymax)
6125 This function is used in example 10.
6131 plsvpa(xmin, xmax, ymin, ymax)
6135 xmin (PLFLT, input) : The distance of the left-hand edge of the
6136 viewport from the left-hand edge of the subpage in millimeters.
6138 xmax (PLFLT, input) : The distance of the right-hand edge of the
6139 viewport from the left-hand edge of the subpage in millimeters.
6141 ymin (PLFLT, input) : The distance of the bottom edge of the
6142 viewport from the bottom edge of the subpage in millimeters.
6144 ymax (PLFLT, input) : The distance of the top edge of the viewport
6145 from the bottom edge of the subpage in millimeters.
6148 return _plplotc.plsvpa(*args)
6152 Set x axis parameters
6156 Sets values of the digmax and digits flags for the x axis. See the
6157 PLplot documentation for more information.
6159 Redacted form: plsxax(digmax, digits)
6161 This function is used in example 31.
6167 plsxax(digmax, digits)
6171 digmax (PLINT, input) : Variable to set the maximum number of
6172 digits for the x axis. If nonzero, the printed label will be
6173 switched to a floating point representation when the number of
6174 digits exceeds digmax.
6176 digits (PLINT, input) : Field digits value. Currently, changing
6177 its value here has no effect since it is set only by plbox or
6178 plbox3. However, the user may obtain its value after a call to
6179 either of these functions by calling plgxax.
6182 return _plplotc.plsxax(*args)
6186 Set y axis parameters
6190 Identical to plsxax, except that arguments are flags for y axis. See
6191 the description of plsxax for more detail.
6193 Redacted form: plsyax(digmax, digits)
6195 This function is used in examples 1,14,31.
6201 plsyax(digmax, digits)
6205 digmax (PLINT, input) : Variable to set the maximum number of
6206 digits for the y axis. If nonzero, the printed label will be
6207 switched to a floating point representation when the number of
6208 digits exceeds digmax.
6210 digits (PLINT, input) : Field digits value. Currently, changing
6211 its value here has no effect since it is set only by plbox or
6212 plbox3. However, the user may obtain its value after a call to
6213 either of these functions by calling plgyax.
6216 return _plplotc.plsyax(*args)
6220 Plot a glyph at the specified points
6224 Plot a glyph at the specified points. (This function is largely
6225 superseded by plstring which gives access to many[!] more glyphs.)
6227 Redacted form: plsym(x, y, code)
6229 This function is used in example 7.
6235 plsym(n, x, y, code)
6239 n (PLINT, input) : Number of points in the x and y arrays.
6241 x (PLFLT *, input) : Pointer to an array with X coordinates of
6244 y (PLFLT *, input) : Pointer to an array with Y coordinates of
6247 code (PLINT, input) : Hershey symbol code corresponding to a glyph
6248 to be plotted at each of the n points.
6251 return _plplotc.plsym(*args)
6255 Set z axis parameters
6259 Identical to plsxax, except that arguments are flags for z axis. See
6260 the description of plsxax for more detail.
6262 Redacted form: plszax(digmax, digits)
6264 This function is used in example 31.
6270 plszax(digmax, digits)
6274 digmax (PLINT, input) : Variable to set the maximum number of
6275 digits for the z axis. If nonzero, the printed label will be
6276 switched to a floating point representation when the number of
6277 digits exceeds digmax.
6279 digits (PLINT, input) : Field digits value. Currently, changing
6280 its value here has no effect since it is set only by plbox or
6281 plbox3. However, the user may obtain its value after a call to
6282 either of these functions by calling plgzax.
6285 return _plplotc.plszax(*args)
6289 Switch to text screen
6293 Sets an interactive device to text mode, used in conjunction with
6294 plgra to allow graphics and text to be interspersed. On a device
6295 which supports separate text and graphics windows, this command causes
6296 control to be switched to the text window. This can be useful for
6297 printing diagnostic messages or getting user input, which would
6298 otherwise interfere with the plots. The program must switch back to
6299 the graphics window before issuing plot commands, as the text (or
6300 console) device will probably become quite confused otherwise. If
6301 already in text mode, this command is ignored. It is also ignored on
6302 devices which only support a single window or use a different method
6303 for shifting focus (see also plgra).
6305 Redacted form: pltext()
6307 This function is used in example 1.
6316 return _plplotc.pltext()
6320 Set format for date / time labels
6324 Sets the format for date / time labels. To enable date / time format
6325 labels see the options to plbox and plenv.
6327 Redacted form: pltimefmt(fmt)
6329 This function is used in example 29.
6339 fmt (const char *, fmt) : This string is passed directly to the
6340 system strftime. See the system documentation for a full list of
6341 conversion specifications for your system. All conversion
6342 specifications take the form of a '%' character followed by
6343 further conversion specification character. All other text is
6344 printed as-is. Common options include: %c: The preferred date and
6345 time representation for the current locale.
6346 %d: The day of the month as a decimal number.
6347 %H: The hour as a decimal number using a 24-hour clock.
6348 %j: The day of the year as a decimal number.
6349 %m: The month as a decimal number.
6350 %M: The minute as a decimal number.
6351 %S: The second as a decimal number.
6352 %y: The year as a decimal number without a century.
6353 %Y: The year as a decimal number including a century.
6356 return _plplotc.pltimefmt(*args)
6360 Specify viewport using aspect ratio only
6364 Sets the viewport so that the ratio of the length of the y axis to
6365 that of the x axis is equal to aspect.
6367 Redacted form: plvasp(aspect)
6369 This function is used in example 13.
6379 aspect (PLFLT, input) : Ratio of length of y axis to length of x
6383 return _plplotc.plvasp(*args)
6391 Draws a vector plot of the vector (
6397 ny]). The scaling factor for the vectors is given by scale. A
6398 transformation routine pointed to by pltr with a pointer pltr_data for
6399 additional data required by the transformation routine is used to map
6400 indices within the array to the world coordinates. The style of the
6401 vector arrow may be set using plsvect.
6403 Redacted form: plvect(u, v, scale, pltr, pltr_data)
6405 This function is used in example 22.
6411 plvect(u, v, nx, ny, scale, pltr, pltr_data)
6415 u, v (PLFLT **, input) : Pointers to a pair of vectored
6416 two-dimensional arrays containing the x and y components of the
6417 vector data to be plotted.
6419 nx, ny (PLINT, input) : Physical dimensions of the arrays u and v.
6421 scale (PLFLT, input) : Parameter to control the scaling factor of
6422 the vectors for plotting. If scale = 0 then the scaling factor is
6423 automatically calculated for the data. If scale < 0 then the
6424 scaling factor is automatically calculated for the data and then
6426 scale. If scale > 0 then the scaling factor is set to scale.
6428 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
6429 Pointer to function that defines transformation between indices
6430 in array z and the world coordinates (C only). Transformation
6431 functions are provided in the PLplot library: pltr0 for identity
6432 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
6433 defined by one- and two-dimensional arrays. In addition,
6434 user-supplied routines for the transformation can be used as well.
6435 Examples of all of these approaches are given in the PLplot
6436 documentation. The transformation function should have the form
6437 given by any of pltr0, pltr1, or pltr2.
6439 pltr_data (PLPointer, input) : Extra parameter to help pass
6440 information to pltr0, pltr1, pltr2, or whatever routine that is
6441 externally supplied.
6444 return _plplotc.plvect(*args)
6448 Specify viewport using coordinates and aspect ratio
6452 Device-independent routine for setting up the viewport. The viewport
6453 is chosen to be the largest with the given aspect ratio that fits
6454 within the specified region (in terms of normalized subpage
6455 coordinates). This routine is functionally equivalent to plvpor when
6456 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this
6457 routine reserves no extra space at the edges for labels.
6459 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect)
6461 This function is used in example 9.
6467 plvpas(xmin, xmax, ymin, ymax, aspect)
6471 xmin (PLFLT, input) : The normalized subpage coordinate of the
6472 left-hand edge of the viewport.
6474 xmax (PLFLT, input) : The normalized subpage coordinate of the
6475 right-hand edge of the viewport.
6477 ymin (PLFLT, input) : The normalized subpage coordinate of the
6478 bottom edge of the viewport.
6480 ymax (PLFLT, input) : The normalized subpage coordinate of the top
6481 edge of the viewport.
6483 aspect (PLFLT, input) : Ratio of length of y axis to length of x
6487 return _plplotc.plvpas(*args)
6491 Specify viewport using coordinates
6495 Device-independent routine for setting up the viewport. This defines
6496 the viewport in terms of normalized subpage coordinates which run from
6497 0.0 to 1.0 (left to right and bottom to top) along each edge of the
6498 current subpage. Use the alternate routine plsvpa in order to create
6499 a viewport of a definite size.
6501 Redacted form: plvpor(xmin, xmax, ymin, ymax)
6503 This function is used in examples
6504 2,6-8,10,11,15,16,18,21,23,24,26,27,31.
6510 plvpor(xmin, xmax, ymin, ymax)
6514 xmin (PLFLT, input) : The normalized subpage coordinate of the
6515 left-hand edge of the viewport.
6517 xmax (PLFLT, input) : The normalized subpage coordinate of the
6518 right-hand edge of the viewport.
6520 ymin (PLFLT, input) : The normalized subpage coordinate of the
6521 bottom edge of the viewport.
6523 ymax (PLFLT, input) : The normalized subpage coordinate of the top
6524 edge of the viewport.
6527 return _plplotc.plvpor(*args)
6531 Select standard viewport
6535 Sets up a standard viewport, leaving a left-hand margin of seven
6536 character heights, and four character heights around the other three
6539 Redacted form: plvsta()
6541 This function is used in examples 1,12,14,17,25,29.
6550 return _plplotc.plvsta()
6554 Set up window for 3-d plotting
6558 Sets up a window for a three-dimensional surface plot within the
6559 currently defined two-dimensional window. The enclosing box for the
6560 surface plot defined by xmin, xmax, ymin, ymax, zmin and zmax in
6561 user-coordinate space is mapped into a box of world coordinate size
6562 basex by basey by height so that xmin maps to -
6563 basex/2, xmax maps to basex/2, ymin maps to -
6564 basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height.
6565 The resulting world-coordinate box is then viewed by an observer at
6566 altitude alt and azimuth az. This routine must be called before
6567 plbox3 or plot3d. For a more complete description of
6568 three-dimensional plotting see the PLplot documentation.
6570 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
6571 zmin, zmax, alt, az)
6573 This function is examples 8,11,18,21.
6579 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
6583 basex (PLFLT, input) : The x coordinate size of the
6584 world-coordinate box.
6586 basey (PLFLT, input) : The y coordinate size of the
6587 world-coordinate box.
6589 height (PLFLT, input) : The z coordinate size of the
6590 world-coordinate box.
6592 xmin (PLFLT, input) : The minimum user x coordinate value.
6594 xmax (PLFLT, input) : The maximum user x coordinate value.
6596 ymin (PLFLT, input) : The minimum user y coordinate value.
6598 ymax (PLFLT, input) : The maximum user y coordinate value.
6600 zmin (PLFLT, input) : The minimum user z coordinate value.
6602 zmax (PLFLT, input) : The maximum user z coordinate value.
6604 alt (PLFLT, input) : The viewing altitude in degrees above the XY
6607 az (PLFLT, input) : The viewing azimuth in degrees. When az=0, the
6608 observer is looking face onto the ZX plane, and as az is
6609 increased, the observer moves clockwise around the box when viewed
6610 from above the XY plane.
6613 return _plplotc.plw3d(*args)
6623 Redacted form: plwidth(width)
6625 This function is used in examples 1,2.
6635 width (PLINT, input) : The desired pen width. If width is negative
6636 or the same as the previous value no action is taken. width = 0
6637 should be interpreted as as the minimum valid pen width for the
6638 device. The interpretation of positive width values is also
6642 return _plplotc.plwidth(*args)
6646 Specify world coordinates of viewport boundaries
6650 Sets up the world coordinates of the edges of the viewport.
6652 Redacted form: plwind(xmin, xmax, ymin, ymax)
6654 This function is used in examples 1,2,4,6-12,14-16,18,21,23-27,29,31.
6660 plwind(xmin, xmax, ymin, ymax)
6664 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
6667 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
6670 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
6673 ymax (PLFLT, input) : The world y coordinate of the top edge of the
6677 return _plplotc.plwind(*args)
6681 Enter or leave xor mode
6685 Enter (when mode is true) or leave (when mode is false) xor mode for
6686 those drivers (e.g., the xwin driver) that support it. Enables
6687 erasing plots by drawing twice the same line, symbol, etc. If driver
6688 is not capable of xor operation it returns a status of false.
6690 Redacted form: plxormod(mode, status)
6692 This function is used in examples 1,20.
6698 plxormod(mode, status)
6702 mode (PLBOOL, input) : mode is true means enter xor mode and mode
6703 is false means leave xor mode.
6705 status (PLBOOL *, output) : Pointer to status. Returned modestatus
6706 of true (false) means driver is capable (incapable) of xor mode.
6709 return _plplotc.plxormod(*args)
6713 Plot continental outline in world coordinates.
6717 Plots continental outlines in world coordinates. examples/c/x19c
6718 demonstrates how to use this function to create different
6721 Redacted form: General: plmap(mapform, type, minlong, maxlong,
6723 F95, Java, Perl/PDL, Python: Not implemented?
6726 This function is used in example 19.
6732 plmap(mapform, type, minlong, maxlong, minlat, maxlat)
6736 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
6737 supplied function to transform the coordinate longitudes and
6738 latitudes to a plot coordinate system. By using this transform,
6739 we can change from a longitude, latitude coordinate to a polar
6740 stereographic project, for example. Initially, x[0]..[n-1] are
6741 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
6742 After the call to mapform(), x[] and y[] should be replaced by
6743 the corresponding plot coordinates. If no transform is desired,
6744 mapform can be replaced by NULL.
6746 type (char *, input) : type is a character string. The value of
6747 this parameter determines the type of background. The possible
6748 values are: "globe" -- continental outlines
6749 "usa" -- USA and state boundaries
6750 "cglobe" -- continental outlines and countries
6751 "usaglobe" -- USA, state boundaries and continental outlines
6754 minlong (PLFLT, input) : The value of the longitude on the left
6755 side of the plot. The value of minlong must be less than the
6756 value of maxlong, and the quantity maxlong-minlong must be less
6757 than or equal to 360.
6759 maxlong (PLFLT, input) : The value of the longitude on the right
6762 minlat (PLFLT, input) : The minimum latitude to be plotted on the
6763 background. One can always use -90.0 as the boundary outside the
6764 plot window will be automatically eliminated. However, the
6765 program will be faster if one can reduce the size of the
6768 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
6769 background. One can always use 90.0 as the boundary outside the
6770 plot window will be automatically eliminated.
6773 return _plplotc.plmap(*args)
6777 Plot latitude and longitude lines.
6781 Displays latitude and longitude on the current plot. The lines are
6782 plotted in the current color and line style.
6784 Redacted form: General: plmeridians(mapform, dlong, dlat, minlong,
6785 maxlong, minlat, maxlat)
6786 F95, Java, Perl/PDL, Python: Not implemented?
6789 This function is used in example 19.
6795 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
6799 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
6800 supplied function to transform the coordinate longitudes and
6801 latitudes to a plot coordinate system. By using this transform,
6802 we can change from a longitude, latitude coordinate to a polar
6803 stereographic project, for example. Initially, x[0]..[n-1] are
6804 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
6805 After the call to mapform(), x[] and y[] should be replaced by
6806 the corresponding plot coordinates. If no transform is desired,
6807 mapform can be replaced by NULL.
6809 dlong (PLFLT, input) : The interval in degrees at which the
6810 longitude lines are to be plotted.
6812 dlat (PLFLT, input) : The interval in degrees at which the latitude
6813 lines are to be plotted.
6815 minlong (PLFLT, input) : The value of the longitude on the left
6816 side of the plot. The value of minlong must be less than the
6817 value of maxlong, and the quantity maxlong-minlong must be less
6818 than or equal to 360.
6820 maxlong (PLFLT, input) : The value of the longitude on the right
6823 minlat (PLFLT, input) : The minimum latitude to be plotted on the
6824 background. One can always use -90.0 as the boundary outside the
6825 plot window will be automatically eliminated. However, the
6826 program will be faster if one can reduce the size of the
6829 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
6830 background. One can always use 90.0 as the boundary outside the
6831 plot window will be automatically eliminated.
6834 return _plplotc.plmeridians(*args)
6838 Plot a 2D matrix using color map1 with automatic colour adjustment
6842 Plot a 2D matrix using color palette 1. The color scale is
6843 automatically adjusted to use the maximum and minimum values in idata
6844 as valuemin and valuemax in a call to plimagefr.
6846 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin,
6847 zmax, Dxmin, Dxmax, Dymin, Dymax)
6850 This function is used in example 20.
6856 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
6860 idata (PLFLT**, input) : A 2D array of values (intensities) to
6861 plot. Should have dimensions idata[nx][ny].
6863 nx, ny (PLINT, input) : Dimensions of idata
6865 xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to strecth
6866 the image data to. idata[0][0] corresponds to (xmin, ymin) and
6867 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
6869 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
6870 (inclusive) will be plotted.
6872 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
6873 points whose plot coordinates fall inside the window of (Dxmin,
6874 Dymin) to (Dxmax, Dymax).
6877 return _plplotc.plimage(*args)
6881 Plot a 2D matrix using color map1
6885 Plot a 2D matrix using color map1.
6887 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax,
6888 zmin, zmax, valuemin, valuemax, pltr, pltr_data)
6891 This function is used in example 20.
6897 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
6901 idata (PLFLT**, input) : A 2D array of values (intensities) to
6902 plot. Should have dimensions idata[nx][ny].
6904 nx, ny (PLINT, input) : Dimensions of idata
6906 xmin, xmax, ymin, ymax (PLFLT, input) : Stretch image data to these
6907 Plot coordinates. idata[0][0] corresponds to (xmin, ymin) and
6908 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
6910 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
6911 (inclusive) will be plotted.
6913 valuemin, valuemax (PLFLT, input) : The minimum and maximum data
6914 values to use for value to color mappings. A datum equal to or
6915 less than valuemin will be plotted with color 0.0, while a datum
6916 equal to or greater than valuemax will be plotted with color 1.0.
6917 Data between valuemin and valuemax map linearly to colors between
6920 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
6921 Pointer to function that defines a transformation between the
6922 data in the array idata and world coordinates. An input
6923 coordinate of (0, 0) corresponds to the "top-left" corner of idata
6924 while (nx, ny) corresponds to the "bottom-right" corner of idata.
6925 Some transformation functions are provided in the PLplot library:
6926 pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary
6927 mappings respectively defined by one- and two-dimensional arrays.
6928 In addition, user-supplied routines for the transformation can be
6929 used as well. Examples of all of these approaches are given in
6930 the PLplot documentation. The transformation function should have
6931 the form given by any of pltr0, pltr1, or pltr2.
6933 pltr_data (PLPointer, input) : Extra parameter to help pass
6934 information to pltr0, pltr1, pltr2, or whatever routine is
6935 externally supplied.
6938 return _plplotc.plimagefr(*args)
6941 return _plplotc.plClearOpts()
6942 plClearOpts = _plplotc.plClearOpts
6945 return _plplotc.plResetOpts()
6946 plResetOpts = _plplotc.plResetOpts
6949 return _plplotc.plSetUsage(*args)
6950 plSetUsage = _plplotc.plSetUsage
6953 return _plplotc.plOptUsage()
6954 plOptUsage = _plplotc.plOptUsage
6957 return _plplotc.plMinMax2dGrid(*args)
6958 plMinMax2dGrid = _plplotc.plMinMax2dGrid
6961 return _plplotc.plGetCursor(*args)
6962 plGetCursor = _plplotc.plGetCursor
def _swig_setattr_nondynamic
def pl_setcontlabelformat
PLGraphicsIn_swigregister