9 from sys
import version_info
10 if version_info >= (2,6,0):
12 from os.path
import dirname
16 fp, pathname, description = imp.find_module(
'_plplotc', [dirname(__file__)])
22 _mod = imp.load_module(
'_plplotc', fp, pathname, description)
27 del swig_import_helper
32 _swig_property = property
36 if (name ==
"thisown"):
return self.this.own(value)
38 if type(value).__name__ ==
'SwigPyObject':
39 self.__dict__[name] = value
41 method = class_type.__swig_setmethods__.get(name,
None)
42 if method:
return method(self,value)
44 self.__dict__[name] = value
46 raise AttributeError(
"You cannot add attributes to %s" % self)
52 if (name ==
"thisown"):
return self.this.own()
53 method = class_type.__swig_getmethods__.get(name,
None)
54 if method:
return method(self)
55 raise AttributeError(name)
58 try: strthis =
"proxy of " + self.this.__repr__()
60 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
65 except AttributeError:
72 return _plplotc.pltr0(*args)
73 pltr0 = _plplotc.pltr0
76 return _plplotc.pltr1(*args)
77 pltr1 = _plplotc.pltr1
80 return _plplotc.pltr2(*args)
81 pltr2 = _plplotc.pltr2
82 PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
83 PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
84 PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
85 PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
86 PLESC_RESIZE = _plplotc.PLESC_RESIZE
87 PLESC_REDRAW = _plplotc.PLESC_REDRAW
88 PLESC_TEXT = _plplotc.PLESC_TEXT
89 PLESC_GRAPH = _plplotc.PLESC_GRAPH
90 PLESC_FILL = _plplotc.PLESC_FILL
91 PLESC_DI = _plplotc.PLESC_DI
92 PLESC_FLUSH = _plplotc.PLESC_FLUSH
93 PLESC_EH = _plplotc.PLESC_EH
94 PLESC_GETC = _plplotc.PLESC_GETC
95 PLESC_SWIN = _plplotc.PLESC_SWIN
96 PLESC_DOUBLEBUFFERING = _plplotc.PLESC_DOUBLEBUFFERING
97 PLESC_XORMOD = _plplotc.PLESC_XORMOD
98 PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
99 PLESC_CLEAR = _plplotc.PLESC_CLEAR
100 PLESC_DASH = _plplotc.PLESC_DASH
101 PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
102 PLESC_IMAGE = _plplotc.PLESC_IMAGE
103 PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
104 PLESC_PL2DEVCOL = _plplotc.PLESC_PL2DEVCOL
105 PLESC_DEV2PLCOL = _plplotc.PLESC_DEV2PLCOL
106 PLESC_SETBGFG = _plplotc.PLESC_SETBGFG
107 PLESC_DEVINIT = _plplotc.PLESC_DEVINIT
108 PLESC_GETBACKEND = _plplotc.PLESC_GETBACKEND
109 PLESC_BEGIN_TEXT = _plplotc.PLESC_BEGIN_TEXT
110 PLESC_TEXT_CHAR = _plplotc.PLESC_TEXT_CHAR
111 PLESC_CONTROL_CHAR = _plplotc.PLESC_CONTROL_CHAR
112 PLESC_END_TEXT = _plplotc.PLESC_END_TEXT
113 PLESC_START_RASTERIZE = _plplotc.PLESC_START_RASTERIZE
114 PLESC_END_RASTERIZE = _plplotc.PLESC_END_RASTERIZE
115 PLESC_ARC = _plplotc.PLESC_ARC
116 PLESC_GRADIENT = _plplotc.PLESC_GRADIENT
117 PLESC_MODESET = _plplotc.PLESC_MODESET
118 PLESC_MODEGET = _plplotc.PLESC_MODEGET
119 PLESC_FIXASPECT = _plplotc.PLESC_FIXASPECT
120 PLESC_IMPORT_BUFFER = _plplotc.PLESC_IMPORT_BUFFER
121 PLTEXT_FONTCHANGE = _plplotc.PLTEXT_FONTCHANGE
122 PLTEXT_SUPERSCRIPT = _plplotc.PLTEXT_SUPERSCRIPT
123 PLTEXT_SUBSCRIPT = _plplotc.PLTEXT_SUBSCRIPT
124 PLTEXT_BACKCHAR = _plplotc.PLTEXT_BACKCHAR
125 PLTEXT_OVERLINE = _plplotc.PLTEXT_OVERLINE
126 PLTEXT_UNDERLINE = _plplotc.PLTEXT_UNDERLINE
127 ZEROW2B = _plplotc.ZEROW2B
128 ZEROW2D = _plplotc.ZEROW2D
129 ONEW2B = _plplotc.ONEW2B
130 ONEW2D = _plplotc.ONEW2D
131 PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
132 PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
133 PL_X_AXIS = _plplotc.PL_X_AXIS
134 PL_Y_AXIS = _plplotc.PL_Y_AXIS
135 PL_Z_AXIS = _plplotc.PL_Z_AXIS
136 PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
137 PL_OPT_ARG = _plplotc.PL_OPT_ARG
138 PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
139 PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
140 PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
141 PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
142 PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
143 PL_OPT_INT = _plplotc.PL_OPT_INT
144 PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
145 PL_OPT_STRING = _plplotc.PL_OPT_STRING
146 PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
147 PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
148 PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
149 PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
150 PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
151 PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
152 PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
153 PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
154 PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
155 PL_FCI_MARK = _plplotc.PL_FCI_MARK
156 PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
157 PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
158 PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
159 PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
160 PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
161 PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
162 PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
163 PL_FCI_SANS = _plplotc.PL_FCI_SANS
164 PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
165 PL_FCI_MONO = _plplotc.PL_FCI_MONO
166 PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
167 PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
168 PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
169 PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
170 PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
171 PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
172 PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
173 PL_MAXKEY = _plplotc.PL_MAXKEY
174 PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
175 PL_NOTSET = _plplotc.PL_NOTSET
176 PLESC_DOUBLEBUFFERING_ENABLE = _plplotc.PLESC_DOUBLEBUFFERING_ENABLE
177 PLESC_DOUBLEBUFFERING_DISABLE = _plplotc.PLESC_DOUBLEBUFFERING_DISABLE
178 PLESC_DOUBLEBUFFERING_QUERY = _plplotc.PLESC_DOUBLEBUFFERING_QUERY
179 PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
180 PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
181 PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
182 PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
183 GRID_CSA = _plplotc.GRID_CSA
184 GRID_DTLI = _plplotc.GRID_DTLI
185 GRID_NNI = _plplotc.GRID_NNI
186 GRID_NNIDW = _plplotc.GRID_NNIDW
187 GRID_NNLI = _plplotc.GRID_NNLI
188 GRID_NNAIDW = _plplotc.GRID_NNAIDW
189 PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
190 PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
191 PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
192 PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
193 PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
194 PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
195 PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
196 PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
197 PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
198 PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
199 PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
200 PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
201 PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
202 PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
203 PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
204 PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
205 PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
206 PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
207 PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
208 PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
209 PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
210 PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
211 PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
212 PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
213 PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
214 PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
215 PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
216 PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
217 PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
218 PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
219 PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
220 PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
221 PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
222 PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
223 PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
224 PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
225 PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
226 PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
227 PL_DRAWMODE_UNKNOWN = _plplotc.PL_DRAWMODE_UNKNOWN
228 PL_DRAWMODE_DEFAULT = _plplotc.PL_DRAWMODE_DEFAULT
229 PL_DRAWMODE_REPLACE = _plplotc.PL_DRAWMODE_REPLACE
230 PL_DRAWMODE_XOR = _plplotc.PL_DRAWMODE_XOR
231 DRAW_LINEX = _plplotc.DRAW_LINEX
232 DRAW_LINEY = _plplotc.DRAW_LINEY
233 DRAW_LINEXY = _plplotc.DRAW_LINEXY
234 MAG_COLOR = _plplotc.MAG_COLOR
235 BASE_CONT = _plplotc.BASE_CONT
236 TOP_CONT = _plplotc.TOP_CONT
237 SURF_CONT = _plplotc.SURF_CONT
238 DRAW_SIDES = _plplotc.DRAW_SIDES
239 FACETED = _plplotc.FACETED
242 __swig_setmethods__ = {}
243 __setattr__ =
lambda self, name, value:
_swig_setattr(self, PLGraphicsIn, name, value)
244 __swig_getmethods__ = {}
246 __repr__ = _swig_repr
247 __swig_setmethods__[
"type"] = _plplotc.PLGraphicsIn_type_set
248 __swig_getmethods__[
"type"] = _plplotc.PLGraphicsIn_type_get
249 if _newclass:type =
_swig_property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
250 __swig_setmethods__[
"state"] = _plplotc.PLGraphicsIn_state_set
251 __swig_getmethods__[
"state"] = _plplotc.PLGraphicsIn_state_get
252 if _newclass:state =
_swig_property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
253 __swig_setmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_set
254 __swig_getmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_get
255 if _newclass:keysym =
_swig_property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
256 __swig_setmethods__[
"button"] = _plplotc.PLGraphicsIn_button_set
257 __swig_getmethods__[
"button"] = _plplotc.PLGraphicsIn_button_get
258 if _newclass:button =
_swig_property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
259 __swig_setmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_set
260 __swig_getmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_get
261 if _newclass:subwindow =
_swig_property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
262 __swig_setmethods__[
"string"] = _plplotc.PLGraphicsIn_string_set
263 __swig_getmethods__[
"string"] = _plplotc.PLGraphicsIn_string_get
264 if _newclass:string =
_swig_property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
265 __swig_setmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_set
266 __swig_getmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_get
267 if _newclass:pX =
_swig_property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
268 __swig_setmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_set
269 __swig_getmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_get
270 if _newclass:pY =
_swig_property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
271 __swig_setmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_set
272 __swig_getmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_get
273 if _newclass:dX =
_swig_property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
274 __swig_setmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_set
275 __swig_getmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_get
276 if _newclass:dY =
_swig_property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
277 __swig_setmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_set
278 __swig_getmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_get
279 if _newclass:wX =
_swig_property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
280 __swig_setmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_set
281 __swig_getmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_get
282 if _newclass:wY =
_swig_property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
284 this = _plplotc.new_PLGraphicsIn()
285 try: self.this.append(this)
287 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
288 __del__ =
lambda self :
None;
289 PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister
294 return _plplotc.plsxwin(*args)
295 plsxwin = _plplotc.plsxwin
299 Set format of numerical label for contours
303 Set format of numerical label for contours.
305 Redacted form: pl_setcontlabelformat(lexp, sigdig)
307 This function is used example 9.
313 pl_setcontlabelformat(lexp, sigdig)
317 lexp (PLINT, input) : If the contour numerical label is greater
318 than 10^(lexp) or less than 10^(-lexp), then the exponential
319 format is used. Default value of lexp is 4.
321 sigdig (PLINT, input) : Number of significant digits. Default
325 return _plplotc.pl_setcontlabelformat(*args)
329 Set parameters of contour labelling other than format of numerical label
333 Set parameters of contour labelling other than those handled by
334 pl_setcontlabelformat.
336 Redacted form: pl_setcontlabelparam(offset, size, spacing, active)
338 This function is used in example 9.
344 pl_setcontlabelparam(offset, size, spacing, active)
348 offset (PLFLT, input) : Offset of label from contour line (if set
349 to 0.0, labels are printed on the lines). Default value is 0.006.
351 size (PLFLT, input) : Font height for contour labels (normalized).
352 Default value is 0.3.
354 spacing (PLFLT, input) : Spacing parameter for contour labels.
355 Default value is 0.1.
357 active (PLINT, input) : Activate labels. Set to 1 if you want
358 contour labels on. Default is off (0).
361 return _plplotc.pl_setcontlabelparam(*args)
365 Advance the (sub-)page
369 Advances to the next subpage if sub=0, performing a page advance if
370 there are no remaining subpages on the current page. If subpages
371 aren't being used, pladv(0) will always advance the page. If page>0,
372 PLplot switches to the specified subpage. Note that this allows you
373 to overwrite a plot on the specified subpage; if this is not what you
374 intended, use pleop followed by plbop to first advance the page. This
375 routine is called automatically (with page=0) by plenv, but if plenv
376 is not used, pladv must be called after initializing PLplot but before
377 defining the viewport.
379 Redacted form: pladv(page)
381 This function is used in examples 1,2,4,6-12,14-18,20,21,23-27,29,31.
391 page (PLINT, input) : Specifies the subpage number (starting from 1
392 in the top left corner and increasing along the rows) to which to
393 advance. Set to zero to advance to the next subpage (or to the
394 next page if subpages are not being used).
397 return _plplotc.pladv(*args)
401 Draw a circular or elliptical arc
405 Draw a possibly filled arc centered at x, y with semimajor axis a and
406 semiminor axis b, starting at angle1 and ending at angle2.
408 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate,
412 This function is used in examples 3 and 27.
418 plarc(x, y, a, b, angle1, angle2, rotate, fill)
422 x (PLFLT, input) : X coordinate of arc center.
424 y (PLFLT, input) : Y coordinate of arc center.
426 a (PLFLT, input) : Length of the semimajor axis of the arc.
428 b (PLFLT, input) : Length of the semiminor axis of the arc.
430 angle1 (PLFLT, input) : Starting angle of the arc relative to the
433 angle2 (PLFLT, input) : Ending angle of the arc relative to the
436 rotate (PLFLT, input) : Angle of the semimajor axis relative to the
439 fill (PLBOOL, input) : Draw a filled arc.
442 return _plplotc.plarc(*args)
446 Draw a box with axes, etc. with arbitrary origin
450 Draws a box around the currently defined viewport with arbitrary
451 world-coordinate origin specified by x0 and y0 and labels it with
452 world coordinate values appropriate to the window. Thus plaxes should
453 only be called after defining both viewport and window. The character
454 strings xopt and yopt specify how the box should be drawn as described
455 below. If ticks and/or subticks are to be drawn for a particular
456 axis, the tick intervals and number of subintervals may be specified
457 explicitly, or they may be defaulted by setting the appropriate
460 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt,
462 Perl/PDL: plaxes(x0, y0, xtick, nxsub, ytick, nysub, xopt,
466 This function is not used in any examples.
472 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
476 x0 (PLFLT, input) : World X coordinate of origin.
478 y0 (PLFLT, input) : World Y coordinate of origin.
480 xopt (const char *, input) : Pointer to character string specifying
481 options for horizontal axis. The string can include any
482 combination of the following letters (upper or lower case) in any
483 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
484 is vertical line (x=0).
485 b: Draws bottom (X) or left (Y) edge of frame.
486 c: Draws top (X) or right (Y) edge of frame.
487 d: Plot labels as date / time. Values are assumed to be
488 seconds since the epoch (as used by gmtime).
489 f: Always use fixed point numeric labels.
490 g: Draws a grid at the major tick interval.
491 h: Draws a grid at the minor tick interval.
492 i: Inverts tick marks, so they are drawn outwards, rather than
494 l: Labels axis logarithmically. This only affects the labels,
495 not the data, and so it is necessary to compute the logarithms
496 of data points before passing them to any of the drawing
498 m: Writes numeric labels at major tick intervals in the
499 unconventional location (above box for X, right of box for Y).
500 n: Writes numeric labels at major tick intervals in the
501 conventional location (below box for X, left of box for Y).
502 o: Use custom labelling function to generate axis label text.
503 The custom labelling function can be defined with the
504 plslabelfunc command.
505 s: Enables subticks between major ticks, only valid if t is
507 t: Draws major ticks.
508 u: Exactly like "b" except don't draw edge line.
509 w: Exactly like "c" except don't draw edge line.
510 x: Exactly like "t" (including the side effect of the
511 numerical labels for the major ticks) except exclude drawing
512 the major and minor tick marks.
515 xtick (PLFLT, input) : World coordinate interval between major
516 ticks on the x axis. If it is set to zero, PLplot automatically
517 generates a suitable tick interval.
519 nxsub (PLINT, input) : Number of subintervals between major x axis
520 ticks for minor ticks. If it is set to zero, PLplot automatically
521 generates a suitable minor tick interval.
523 yopt (const char *, input) : Pointer to character string specifying
524 options for vertical axis. The string can include any combination
525 of the letters defined above for xopt, and in addition may
526 contain: v: Write numeric labels for vertical axis parallel to the
527 base of the graph, rather than parallel to the axis.
530 ytick (PLFLT, input) : World coordinate interval between major
531 ticks on the y axis. If it is set to zero, PLplot automatically
532 generates a suitable tick interval.
534 nysub (PLINT, input) : Number of subintervals between major y axis
535 ticks for minor ticks. If it is set to zero, PLplot automatically
536 generates a suitable minor tick interval.
539 return _plplotc.plaxes(*args)
543 Plot a histogram from binned data
547 Plots a histogram consisting of nbin bins. The value associated with
548 the i'th bin is placed in x[i], and the number of points in the bin is
549 placed in y[i]. For proper operation, the values in x[i] must form a
550 strictly increasing sequence. By default, x[i] is the left-hand edge
551 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
552 placed midway between the values in the x array. Also see plhist for
553 drawing histograms from unbinned data.
555 Redacted form: General: plbin(x, y, opt)
556 Perl/PDL: plbin(nbin, x, y, opt)
557 Python: plbin(nbin, x, y, opt)
560 This function is not used in any examples.
566 plbin(nbin, x, y, opt)
570 nbin (PLINT, input) : Number of bins (i.e., number of values in x
573 x (const PLFLT *, input) : Pointer to array containing values
574 associated with bins. These must form a strictly increasing
577 y (const PLFLT *, input) : Pointer to array containing number of
578 points in bin. This is a PLFLT (instead of PLINT) array so as to
579 allow histograms of probabilities, etc.
581 opt (PLINT, input) : Is a combination of several flags:
582 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
583 outer bins are expanded to fill up the entire x-axis and bins of
584 zero height are simply drawn.
585 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
586 between the x values. If the values in x are equally spaced,
587 the values are the center values of the bins.
588 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal
589 size as the ones inside.
590 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn
591 (there is a gap for such bins).
594 return _plplotc.plbin(*args)
598 Calculate broken-down time from continuous time for the current stream
602 Calculate broken-down time; year, month, day, hour, min, sec; from
603 continuous time, ctime for the current stream. This function is the
606 The PLplot definition of broken-down time is a calendar time that
607 completely ignores all time zone offsets, i.e., it is the user's
608 responsibility to apply those offsets (if so desired) before using the
609 PLplot time API. By default broken-down time is defined using the
610 proleptic Gregorian calendar without the insertion of leap seconds and
611 continuous time is defined as the number of seconds since the Unix
612 epoch of 1970-01-01T00:00:00Z. However, other definitions of
613 broken-down and continuous time are possible, see plconfigtime.
615 Redacted form: General: plbtime(year, month, day, hour, min, sec,
617 Perl/PDL: Not available?
620 This function is used in example 29.
626 plbtime(year, month, day, hour, min, sec, ctime)
630 year (PLINT *, output) : Output year.
632 month (PLINT *, output) : Output month in range from 0 (January) to
635 day (PLINT *, output) : Output day in range from 1 to 31.
637 hour (PLINT *, output) : Output hour in range from 0 to 23.
639 min (PLINT *, output) : Output minute in range from 0 to 59
641 sec (PLFLT *, output) : Output second in floating range from 0. to
644 ctime (PLFLT, input) : Continous time from which the broken-down
648 return _plplotc.plbtime(*args)
656 Begins a new page. For a file driver, the output file is opened if
657 necessary. Advancing the page via pleop and plbop is useful when a
658 page break is desired at a particular point when plotting to subpages.
659 Another use for pleop and plbop is when plotting pages to different
660 files, since you can manually set the file name by calling plsfnam
661 after the call to pleop. (In fact some drivers may only support a
662 single page per file, making this a necessity.) One way to handle
663 this case automatically is to page advance via pladv, but enable
664 familying (see plsfam) with a small limit on the file size so that a
665 new family member file will be created on each page break.
667 Redacted form: plbop()
669 This function is used in examples 2,20.
678 return _plplotc.plbop()
682 Draw a box with axes, etc
686 Draws a box around the currently defined viewport, and labels it with
687 world coordinate values appropriate to the window. Thus plbox should
688 only be called after defining both viewport and window. The character
689 strings xopt and yopt specify how the box should be drawn as described
690 below. If ticks and/or subticks are to be drawn for a particular
691 axis, the tick intervals and number of subintervals may be specified
692 explicitly, or they may be defaulted by setting the appropriate
695 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
696 Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt)
699 This function is used in examples 1,2,4,6,6-12,14-18,21,23-26,29.
705 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
709 xopt (const char *, input) : Pointer to character string specifying
710 options for horizontal axis. The string can include any
711 combination of the following letters (upper or lower case) in any
712 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
713 is vertical line (x=0).
714 b: Draws bottom (X) or left (Y) edge of frame.
715 c: Draws top (X) or right (Y) edge of frame.
716 d: Plot labels as date / time. Values are assumed to be
717 seconds since the epoch (as used by gmtime).
718 f: Always use fixed point numeric labels.
719 g: Draws a grid at the major tick interval.
720 h: Draws a grid at the minor tick interval.
721 i: Inverts tick marks, so they are drawn outwards, rather than
723 l: Labels axis logarithmically. This only affects the labels,
724 not the data, and so it is necessary to compute the logarithms
725 of data points before passing them to any of the drawing
727 m: Writes numeric labels at major tick intervals in the
728 unconventional location (above box for X, right of box for Y).
729 n: Writes numeric labels at major tick intervals in the
730 conventional location (below box for X, left of box for Y).
731 o: Use custom labelling function to generate axis label text.
732 The custom labelling function can be defined with the
733 plslabelfunc command.
734 s: Enables subticks between major ticks, only valid if t is
736 t: Draws major ticks.
737 u: Exactly like "b" except don't draw edge line.
738 w: Exactly like "c" except don't draw edge line.
739 x: Exactly like "t" (including the side effect of the
740 numerical labels for the major ticks) except exclude drawing
741 the major and minor tick marks.
744 xtick (PLFLT, input) : World coordinate interval between major
745 ticks on the x axis. If it is set to zero, PLplot automatically
746 generates a suitable tick interval.
748 nxsub (PLINT, input) : Number of subintervals between major x axis
749 ticks for minor ticks. If it is set to zero, PLplot automatically
750 generates a suitable minor tick interval.
752 yopt (const char *, input) : Pointer to character string specifying
753 options for vertical axis. The string can include any combination
754 of the letters defined above for xopt, and in addition may
755 contain: v: Write numeric labels for vertical axis parallel to the
756 base of the graph, rather than parallel to the axis.
759 ytick (PLFLT, input) : World coordinate interval between major
760 ticks on the y axis. If it is set to zero, PLplot automatically
761 generates a suitable tick interval.
763 nysub (PLINT, input) : Number of subintervals between major y axis
764 ticks for minor ticks. If it is set to zero, PLplot automatically
765 generates a suitable minor tick interval.
768 return _plplotc.plbox(*args)
772 Draw a box with axes, etc, in 3-d
776 Draws axes, numeric and text labels for a three-dimensional surface
777 plot. For a more complete description of three-dimensional plotting
778 see the PLplot documentation.
780 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,
781 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
782 Perl/PDL: plbox3(xtick, nxsub, ytick, nysub, ztick, nzsub,
783 xopt, xlabel, yopt, ylabel, zopt, zlabel)
786 This function is used in examples 8,11,18,21.
792 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
796 xopt (const char *, input) : Pointer to character string specifying
797 options for the x axis. The string can include any combination of
798 the following letters (upper or lower case) in any order: b: Draws
799 axis at base, at height z=
800 zmin where zmin is defined by call to plw3d. This character must be
801 specified in order to use any of the other options.
802 f: Always use fixed point numeric labels.
803 i: Inverts tick marks, so they are drawn downwards, rather
805 l: Labels axis logarithmically. This only affects the labels,
806 not the data, and so it is necessary to compute the logarithms
807 of data points before passing them to any of the drawing
809 n: Writes numeric labels at major tick intervals.
810 o: Use custom labelling function to generate axis label text.
811 The custom labelling function can be defined with the
812 plslabelfunc command.
813 s: Enables subticks between major ticks, only valid if t is
815 t: Draws major ticks.
816 u: If this is specified, the text label for the axis is
817 written under the axis.
820 xlabel (const char *, input) : Pointer to character string
821 specifying text label for the x axis. It is only drawn if u is in
824 xtick (PLFLT, input) : World coordinate interval between major
825 ticks on the x axis. If it is set to zero, PLplot automatically
826 generates a suitable tick interval.
828 nxsub (PLINT, input) : Number of subintervals between major x axis
829 ticks for minor ticks. If it is set to zero, PLplot automatically
830 generates a suitable minor tick interval.
832 yopt (const char *, input) : Pointer to character string specifying
833 options for the y axis. The string is interpreted in the same way
836 ylabel (const char *, input) : Pointer to character string
837 specifying text label for the y axis. It is only drawn if u is in
840 ytick (PLFLT, input) : World coordinate interval between major
841 ticks on the y axis. If it is set to zero, PLplot automatically
842 generates a suitable tick interval.
844 nysub (PLINT, input) : Number of subintervals between major y axis
845 ticks for minor ticks. If it is set to zero, PLplot automatically
846 generates a suitable minor tick interval.
848 zopt (const char *, input) : Pointer to character string specifying
849 options for the z axis. The string can include any combination of
850 the following letters (upper or lower case) in any order: b: Draws
851 z axis to the left of the surface plot.
852 c: Draws z axis to the right of the surface plot.
853 d: Draws grid lines parallel to the x-y plane behind the
854 figure. These lines are not drawn until after plot3d or
855 plmesh are called because of the need for hidden line removal.
856 f: Always use fixed point numeric labels.
857 i: Inverts tick marks, so they are drawn away from the center.
858 l: Labels axis logarithmically. This only affects the labels,
859 not the data, and so it is necessary to compute the logarithms
860 of data points before passing them to any of the drawing
862 m: Writes numeric labels at major tick intervals on the
863 right-hand vertical axis.
864 n: Writes numeric labels at major tick intervals on the
865 left-hand vertical axis.
866 o: Use custom labelling function to generate axis label text.
867 The custom labelling function can be defined with the
868 plslabelfunc command.
869 s: Enables subticks between major ticks, only valid if t is
871 t: Draws major ticks.
872 u: If this is specified, the text label is written beside the
874 v: If this is specified, the text label is written beside the
878 zlabel (const char *, input) : Pointer to character string
879 specifying text label for the z axis. It is only drawn if u or v
880 are in the zopt string.
882 ztick (PLFLT, input) : World coordinate interval between major
883 ticks on the z axis. If it is set to zero, PLplot automatically
884 generates a suitable tick interval.
886 nzsub (PLINT, input) : Number of subintervals between major z axis
887 ticks for minor ticks. If it is set to zero, PLplot automatically
888 generates a suitable minor tick interval.
891 return _plplotc.plbox3(*args)
895 Calculate world coordinates and corresponding window index from relative device coordinates
899 Calculate world coordinates, wx and wy, and corresponding window index
900 from relative device coordinates, rx and ry.
902 Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
903 Perl/PDL: Not available?
906 This function is used in example 31.
912 plcalc_world(rx, ry, wx, wy, window)
916 rx (PLFLT, input) : Input relative device coordinate (ranging from
917 0. to 1.) for the x coordinate.
919 ry (PLFLT, input) : Input relative device coordinate (ranging from
920 0. to 1.) for the y coordinate.
922 wx (PLFLT *, output) : Pointer to the returned world coordinate for
923 x corresponding to the relative device coordinates rx and ry.
925 wy (PLFLT *, output) : Pointer to the returned world coordinate for
926 y corresponding to the relative device coordinates rx and ry.
928 window (PLINT *, output) : Pointer to the returned last defined
929 window index that corresponds to the input relative device
930 coordinates (and the returned world coordinates). To give some
931 background on the window index, for each page the initial window
932 index is set to zero, and each time plwind is called within the
933 page, world and device coordinates are stored for the window and
934 the window index is incremented. Thus, for a simple page layout
935 with non-overlapping viewports and one window per viewport, window
936 corresponds to the viewport index (in the order which the
937 viewport/windows were created) of the only viewport/window
938 corresponding to rx and ry. However, for more complicated layouts
939 with potentially overlapping viewports and possibly more than one
940 window (set of world coordinates) per viewport, window and the
941 corresponding output world coordinates corresponds to the last
942 window created that fulfills the criterion that the relative
943 device coordinates are inside it. Finally, in all cases where the
944 input relative device coordinates are not inside any
945 viewport/window, then window is set to -1.
948 return _plplotc.plcalc_world(*args)
952 Clear current (sub)page
956 Clears the current page, effectively erasing everything that have been
957 drawn. This command only works with interactive drivers; if the
958 driver does not support this, the page is filled with the background
959 color in use. If the current page is divided into subpages, only the
960 current subpage is erased. The nth subpage can be selected with
963 Redacted form: General: plclear()
964 Perl/PDL: Not available?
967 This function is not used in any examples.
976 return _plplotc.plclear()
984 Sets the color index for cmap0 (see the PLplot documentation).
986 Redacted form: plcol0(icol0)
988 This function is used in examples 1-9,11-16,18-27,29.
998 icol0 (PLINT, input) : Integer representing the color. The
999 defaults at present are (these may change):
1000 0 black (default background)
1001 1 red (default foreground)
1017 Use plscmap0 to change the entire map0 color palette and plscol0 to
1018 change an individual color in the map0 color palette.
1021 return _plplotc.plcol0(*args)
1029 Sets the color for cmap1 (see the PLplot documentation).
1031 Redacted form: plcol1(col1)
1033 This function is used in examples 12 and 21.
1043 col1 (PLFLT, input) : This value must be in the range from 0. to 1.
1044 and is mapped to color using the continuous map1 color palette
1045 which by default ranges from blue to the background color to red.
1046 The map1 palette can also be straightforwardly changed by the user
1047 with plscmap1 or plscmap1l.
1050 return _plplotc.plcol1(*args)
1054 Configure the transformation between continuous and broken-down time for the current stream
1058 Configure the transformation between continuous and broken-down time
1059 for the current stream. This transformation is used by both plbtime
1062 Redacted form: General: plconfigtime(scale, offset1, offset2,
1063 ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1064 Perl/PDL: Not available?
1067 This function is used in example 29.
1073 plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1077 scale (PLFLT, input) : The number of days per continuous time unit.
1078 As a special case, if
1079 scale is 0., then all other arguments are ignored, and the result (the
1080 default used by PLplot) is the equivalent of a call to
1081 plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.).
1082 That is, for this special case broken-down time is calculated with
1083 the proleptic Gregorian calendar with no leap seconds inserted,
1084 and the continuous time is defined as the number of seconds since
1085 the Unix epoch of 1970-01-01T00:00:00Z.
1087 offset1 (PLFLT, input) : If
1088 ifbtime_offset is true, the parameters
1090 offset2 are completely ignored. Otherwise, the sum of these parameters
1091 (with units in days) specify the epoch of the continuous time
1092 relative to the MJD epoch corresponding to the Gregorian calendar
1093 date of 1858-11-17T00:00:00Z or JD = 2400000.5. Two PLFLT numbers
1094 are used to specify the origin to allow users (by specifying
1095 offset1 as an integer that can be exactly represented by a
1096 floating-point variable and specifying
1097 offset2 as a number in the range from 0. to 1) the chance to minimize
1098 the numerical errors of the continuous time representation.
1100 offset2 (PLFLT, input) : See documentation of
1103 ccontrol (PLINT, input) : ccontrol contains bits controlling the
1104 transformation. If the 0x1 bit is set, then the proleptic Julian
1105 calendar is used for broken-down time rather than the proleptic
1106 Gregorian calendar. If the 0x2 bit is set, then leap seconds that
1107 have been historically used to define UTC are inserted into the
1108 broken-down time. Other possibilities for additional control bits
1109 for ccontrol exist such as making the historical time corrections
1110 in the broken-down time corresponding to ET (ephemeris time) or
1111 making the (slightly non-constant) corrections from international
1112 atomic time (TAI) to what astronomers define as terrestrial time
1113 (TT). But those additional possibilities have not been
1114 implemented yet in the qsastime library (one of the PLplot utility
1117 ifbtime_offset (PLBOOL, input) : ifbtime_offset controls how the
1118 epoch of the continuous time scale is specified by the user. If
1119 ifbtime_offset is false, then
1121 offset2 are used to specify the epoch, and the following broken-down
1122 time parameters are completely ignored. If
1123 ifbtime_offset is true, then
1125 offset2 are completely ignored, and the following broken-down time
1126 parameters are used to specify the epoch.
1128 year (PLINT, input) : Year of epoch.
1130 month (PLINT, input) : Month of epoch in range from 0 (January) to
1133 day (PLINT, input) : Day of epoch in range from 1 to 31.
1135 hour (PLINT, input) : Hour of epoch in range from 0 to 23
1137 min (PLINT, input) : Minute of epoch in range from 0 to 59.
1139 sec (PLFLT, input) : Second of epoch in floating range from 0. to
1143 return _plplotc.plconfigtime(*args)
1151 Draws a contour plot of the data in f[
1153 ny], using the nlevel contour levels specified by clevel. Only the
1154 region of the array from kx to lx and from ky to ly is plotted out. A
1155 transformation routine pointed to by pltr with a pointer pltr_data for
1156 additional data required by the transformation routine is used to map
1157 indices within the array to the world coordinates. See the following
1158 discussion of the arguments and the PLplot documentation for more
1161 Redacted form: [PLEASE UPDATE! ONLY PERL INFO IS LIKELY CORRECT!] F95:
1162 plcont(f, kx, lx, ky, ly, clevel, tr?) or plcont(f, kx, lx, ky, ly,
1163 clevel, xgrid, ygrid)
1164 Java: pls.cont(f, kx, lx, ky, ly, clevel, xgrid, ygrid)
1165 Perl/PDL: plcont(f, kx, lx, ky, ly, clevel, pltr, pltr_data)
1166 Python: plcont2(f, kx, lx, ky, ly, clevel)
1169 This function is used in examples 9,14,16,22.
1175 plcont(f, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
1179 f (const PLFLT * const *, input) : Pointer to a vectored
1180 two-dimensional array containing data to be contoured.
1182 nx, ny (PLINT, input) : Physical dimensions of array f.
1184 kx, lx (PLINT, input) : Range of x indices to consider.
1186 ky, ly (PLINT, input) : Range of y indices to consider.
1188 clevel (const PLFLT *, input) : Pointer to array specifying levels
1189 at which to draw contours.
1191 nlevel (PLINT, input) : Number of contour levels to draw.
1193 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
1194 Pointer to function that defines transformation between indices
1195 in array f and the world coordinates (C only). Transformation
1196 functions are provided in the PLplot library: pltr0 for identity
1197 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
1198 defined by one- and two-dimensional arrays. In addition,
1199 user-supplied routines for the transformation can be used as well.
1200 Examples of all of these approaches are given in the PLplot
1201 documentation. The transformation function should have the form
1202 given by any of pltr0, pltr1, or pltr2. Note that unlike plshades
1203 and similar PLplot functions which have a pltr argument, plcont
1204 requires that a transformation function be provided in the C
1205 interface. Leaving pltr NULL will result in an error.
1207 pltr_data (PLPointer, input) : Extra parameter to help pass
1208 information to pltr0, pltr1, pltr2, or whatever routine that is
1209 externally supplied.
1212 return _plplotc.plcont(*args)
1216 Calculate continuous time from broken-down time for the current stream
1220 Calculate continuous time, ctime, from broken-down time for the
1221 current stream. The broken-down
1222 time is specified by the following parameters: year, month, day, hour,
1223 min, and sec. This function is the inverse of plbtime.
1225 The PLplot definition of broken-down time is a calendar time that
1226 completely ignores all time zone offsets, i.e., it is the user's
1227 responsibility to apply those offsets (if so desired) before using the
1228 PLplot time API. By default broken-down time is defined using the
1229 proleptic Gregorian calendar without the insertion of leap seconds and
1230 continuous time is defined as the number of seconds since the Unix
1231 epoch of 1970-01-01T00:00:00Z. However, other definitions of
1232 broken-down and continuous time are possible, see plconfigtime which
1233 specifies that transformation for the current stream.
1235 Redacted form: General: plctime(year, month, day, hour, min, sec,
1237 Perl/PDL: Not available?
1240 This function is used in example 29.
1246 plctime(year, month, day, hour, min, sec, ctime)
1250 year (PLINT, input) : Input year.
1252 month (PLINT, input) : Input month in range from 0 (January) to 11
1255 day (PLINT, input) : Input day in range from 1 to 31.
1257 hour (PLINT, input) : Input hour in range from 0 to 23
1259 min (PLINT, input) : Input minute in range from 0 to 59.
1261 sec (PLFLT, input) : Input second in floating range from 0. to 60.
1263 ctime (PLFLT *, output) : Continous time calculated from the
1264 broken-down time specified by the previous parameters.
1267 return _plplotc.plctime(*args)
1271 Copy state parameters from the reference stream to the current stream
1275 Copies state parameters from the reference stream to the current
1276 stream. Tell driver interface to map device coordinates unless flags
1279 This function is used for making save files of selected plots (e.g.
1280 from the TK driver). After initializing, you can get a copy of the
1281 current plot to the specified device by switching to this stream and
1282 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as
1283 appropriate. The plot buffer must have previously been enabled (done
1284 automatically by some display drivers, such as X).
1286 Redacted form: plcpstrm(iplsr, flags)
1288 This function is used in example 1,20.
1294 plcpstrm(iplsr, flags)
1298 iplsr (PLINT, input) : Number of reference stream.
1300 flags (PLBOOL, input) : If flags is set to true the device
1301 coordinates are not copied from the reference to current stream.
1304 return _plplotc.plcpstrm(*args)
1308 End plotting session
1312 Ends a plotting session, tidies up all the output files, switches
1313 interactive devices back into text mode and frees up any memory that
1314 was allocated. Must be called before end of program.
1316 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a
1317 wait state after a call to plend or other functions which trigger the
1318 end of a plot page. To avoid this, use the plspause function.
1320 Redacted form: plend()
1322 This function is used in all of the examples.
1331 return _plplotc.plend()
1335 End plotting session for current stream
1339 Ends a plotting session for the current output stream only. See
1340 plsstrm for more info.
1342 Redacted form: plend1()
1344 This function is used in examples 1,20.
1353 return _plplotc.plend1()
1357 Set up standard window and draw box
1361 Sets up plotter environment for simple graphs by calling pladv and
1362 setting up viewport and window to sensible default values. plenv
1363 leaves enough room around most graphs for axis labels and a title.
1364 When these defaults are not suitable, use the individual routines
1365 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
1366 defining the window, and plbox for drawing the box.
1368 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis)
1370 This function is used in example 1,3,9,13,14,19-22,29.
1376 plenv(xmin, xmax, ymin, ymax, just, axis)
1380 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1383 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1386 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1389 ymax (PLFLT, input) : Value of y at top edge of window (in world
1392 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1393 scales will not be set, the user must set up the scale before
1394 calling plenv using plsvpa, plvasp or other.
1395 0: the x and y axes are scaled independently to use as much of
1396 the screen as possible.
1397 1: the scales of the x and y axes are made equal.
1398 2: the axis of the x and y axes are made equal, and the plot
1402 axis (PLINT, input) : Controls drawing of the box around the plot:
1403 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1405 0: draw box, ticks, and numeric tick labels.
1406 1: also draw coordinate axes at x=0 and y=0.
1407 2: also draw a grid at major tick positions in both
1409 3: also draw a grid at minor tick positions in both
1411 10: same as 0 except logarithmic x tick marks. (The x data
1412 have to be converted to logarithms separately.)
1413 11: same as 1 except logarithmic x tick marks. (The x data
1414 have to be converted to logarithms separately.)
1415 12: same as 2 except logarithmic x tick marks. (The x data
1416 have to be converted to logarithms separately.)
1417 13: same as 3 except logarithmic x tick marks. (The x data
1418 have to be converted to logarithms separately.)
1419 20: same as 0 except logarithmic y tick marks. (The y data
1420 have to be converted to logarithms separately.)
1421 21: same as 1 except logarithmic y tick marks. (The y data
1422 have to be converted to logarithms separately.)
1423 22: same as 2 except logarithmic y tick marks. (The y data
1424 have to be converted to logarithms separately.)
1425 23: same as 3 except logarithmic y tick marks. (The y data
1426 have to be converted to logarithms separately.)
1427 30: same as 0 except logarithmic x and y tick marks. (The x
1428 and y data have to be converted to logarithms separately.)
1429 31: same as 1 except logarithmic x and y tick marks. (The x
1430 and y data have to be converted to logarithms separately.)
1431 32: same as 2 except logarithmic x and y tick marks. (The x
1432 and y data have to be converted to logarithms separately.)
1433 33: same as 3 except logarithmic x and y tick marks. (The x
1434 and y data have to be converted to logarithms separately.)
1435 40: same as 0 except date / time x labels.
1436 41: same as 1 except date / time x labels.
1437 42: same as 2 except date / time x labels.
1438 43: same as 3 except date / time x labels.
1439 50: same as 0 except date / time y labels.
1440 51: same as 1 except date / time y labels.
1441 52: same as 2 except date / time y labels.
1442 53: same as 3 except date / time y labels.
1443 60: same as 0 except date / time x and y labels.
1444 61: same as 1 except date / time x and y labels.
1445 62: same as 2 except date / time x and y labels.
1446 63: same as 3 except date / time x and y labels.
1447 70: same as 0 except custom x and y labels.
1448 71: same as 1 except custom x and y labels.
1449 72: same as 2 except custom x and y labels.
1450 73: same as 3 except custom x and y labels.
1453 return _plplotc.plenv(*args)
1457 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it
1461 Sets up plotter environment for simple graphs by calling pladv and
1462 setting up viewport and window to sensible default values. plenv0
1463 leaves enough room around most graphs for axis labels and a title.
1464 When these defaults are not suitable, use the individual routines
1465 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
1466 defining the window, and plbox for drawing the box.
1468 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis)
1470 This function is used in example 21.
1476 plenv0(xmin, xmax, ymin, ymax, just, axis)
1480 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1483 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1486 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1489 ymax (PLFLT, input) : Value of y at top edge of window (in world
1492 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1493 scales will not be set, the user must set up the scale before
1494 calling plenv0 using plsvpa, plvasp or other.
1495 0: the x and y axes are scaled independently to use as much of
1496 the screen as possible.
1497 1: the scales of the x and y axes are made equal.
1498 2: the axis of the x and y axes are made equal, and the plot
1502 axis (PLINT, input) : Controls drawing of the box around the plot:
1503 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1505 0: draw box, ticks, and numeric tick labels.
1506 1: also draw coordinate axes at x=0 and y=0.
1507 2: also draw a grid at major tick positions in both
1509 3: also draw a grid at minor tick positions in both
1511 10: same as 0 except logarithmic x tick marks. (The x data
1512 have to be converted to logarithms separately.)
1513 11: same as 1 except logarithmic x tick marks. (The x data
1514 have to be converted to logarithms separately.)
1515 12: same as 2 except logarithmic x tick marks. (The x data
1516 have to be converted to logarithms separately.)
1517 13: same as 3 except logarithmic x tick marks. (The x data
1518 have to be converted to logarithms separately.)
1519 20: same as 0 except logarithmic y tick marks. (The y data
1520 have to be converted to logarithms separately.)
1521 21: same as 1 except logarithmic y tick marks. (The y data
1522 have to be converted to logarithms separately.)
1523 22: same as 2 except logarithmic y tick marks. (The y data
1524 have to be converted to logarithms separately.)
1525 23: same as 3 except logarithmic y tick marks. (The y data
1526 have to be converted to logarithms separately.)
1527 30: same as 0 except logarithmic x and y tick marks. (The x
1528 and y data have to be converted to logarithms separately.)
1529 31: same as 1 except logarithmic x and y tick marks. (The x
1530 and y data have to be converted to logarithms separately.)
1531 32: same as 2 except logarithmic x and y tick marks. (The x
1532 and y data have to be converted to logarithms separately.)
1533 33: same as 3 except logarithmic x and y tick marks. (The x
1534 and y data have to be converted to logarithms separately.)
1535 40: same as 0 except date / time x labels.
1536 41: same as 1 except date / time x labels.
1537 42: same as 2 except date / time x labels.
1538 43: same as 3 except date / time x labels.
1539 50: same as 0 except date / time y labels.
1540 51: same as 1 except date / time y labels.
1541 52: same as 2 except date / time y labels.
1542 53: same as 3 except date / time y labels.
1543 60: same as 0 except date / time x and y labels.
1544 61: same as 1 except date / time x and y labels.
1545 62: same as 2 except date / time x and y labels.
1546 63: same as 3 except date / time x and y labels.
1547 70: same as 0 except custom x and y labels.
1548 71: same as 1 except custom x and y labels.
1549 72: same as 2 except custom x and y labels.
1550 73: same as 3 except custom x and y labels.
1553 return _plplotc.plenv0(*args)
1561 Clears the graphics screen of an interactive device, or ejects a page
1562 on a plotter. See plbop for more information.
1564 Redacted form: pleop()
1566 This function is used in example 2,14.
1575 return _plplotc.pleop()
1583 Draws a set of n horizontal error bars, the i'th error bar extending
1584 from xmin[i] to xmax[i] at y coordinate y[i]. The terminals of the
1585 error bar are of length equal to the minor tick length (settable using
1588 Redacted form: General: plerrx(xmin, ymax, y)
1589 Perl/PDL: plerrx(n, xmin, xmax, y)
1592 This function is used in example 29.
1598 plerrx(n, xmin, xmax, y)
1602 n (PLINT, input) : Number of error bars to draw.
1604 xmin (const PLFLT *, input) : Pointer to array with x coordinates
1605 of left-hand endpoint of error bars.
1607 xmax (const PLFLT *, input) : Pointer to array with x coordinates
1608 of right-hand endpoint of error bars.
1610 y (const PLFLT *, input) : Pointer to array with y coordinates of
1614 return _plplotc.plerrx(*args)
1622 Draws a set of n vertical error bars, the i'th error bar extending
1623 from ymin[i] to ymax[i] at x coordinate x[i]. The terminals of the
1624 error bar are of length equal to the minor tick length (settable using
1627 Redacted form: General: plerry(x, ymin, ymax)
1628 Perl/PDL: plerry(n, x, ymin, ymax)
1631 This function is used in example 29.
1637 plerry(n, x, ymin, ymax)
1641 n (PLINT, input) : Number of error bars to draw.
1643 x (const PLFLT *, input) : Pointer to array with x coordinates of
1646 ymin (const PLFLT *, input) : Pointer to array with y coordinates
1647 of lower endpoint of error bars.
1649 ymax (const PLFLT *, input) : Pointer to array with y coordinate of
1650 upper endpoint of error bar.
1653 return _plplotc.plerry(*args)
1657 Advance to the next family file on the next new page
1661 Advance to the next family file on the next new page.
1663 Redacted form: plfamadv()
1665 This function is not used in any examples.
1674 return _plplotc.plfamadv()
1682 Fills the polygon defined by the n points (
1684 y[i]) using the pattern defined by plpsty or plpat. The default fill
1685 style is a solid fill. The routine will automatically close the
1686 polygon between the last and first vertices. If multiple closed
1687 polygons are passed in x and y then plfill will fill in between them.
1689 Redacted form: plfill(x,y)
1691 This function is used in examples 12,13,15,16,21,24,25.
1701 n (PLINT, input) : Number of vertices in polygon.
1703 x (const PLFLT *, input) : Pointer to array with x coordinates of
1706 y (const PLFLT *, input) : Pointer to array with y coordinates of
1710 return _plplotc.plfill(*args)
1714 Draw filled polygon in 3D
1718 Fills the 3D polygon defined by the n points in the x, y, and z arrays
1719 using the pattern defined by plpsty or plpat. The routine will
1720 automatically close the polygon between the last and first vertices.
1721 If multiple closed polygons are passed in x, y, and z then plfill3
1722 will fill in between them.
1724 Redacted form: General: plfill3(x, y, z)
1725 Perl/PDL: plfill3(n, x, y, z)
1728 This function is used in example 15.
1738 n (PLINT, input) : Number of vertices in polygon.
1740 x (const PLFLT *, input) : Pointer to array with x coordinates of
1743 y (const PLFLT *, input) : Pointer to array with y coordinates of
1746 z (const PLFLT *, input) : Pointer to array with z coordinates of
1750 return _plplotc.plfill3(*args)
1754 Draw linear gradient inside polygon
1758 Draw a linear gradient using colour map 1 inside the polygon defined
1761 y[i]). Interpretation of the polygon is the same as for plfill. The
1762 polygon coordinates and the gradient angle are all expressed in world
1763 coordinates. The angle from the x axis for both the rotated
1764 coordinate system and the gradient vector is specified by angle. The
1765 magnitude of the gradient vector is the difference between the maximum
1766 and minimum values of x for the vertices in the rotated coordinate
1767 system. The origin of the gradient vector can be interpreted as being
1768 anywhere on the line corresponding to the minimum x value for the
1769 vertices in the rotated coordinate system. The distance along the
1770 gradient vector is linearly transformed to the independent variable of
1771 colour map 1 which ranges from 0. at the tail of the gradient vector
1772 to 1. at the head of the gradient vector. What is drawn is the RGBA
1773 colour corresponding to the independent variable of colour map 1. For
1774 more information about colour map 1 (see the PLplot documentation).
1776 Redacted form: plgradient(x,y,angle)
1778 This function is used in examples 25,30.
1784 plgradient(n, x, y, angle)
1788 n (PLINT, input) : Number of vertices in polygon.
1790 x (const PLFLT *, input) : Pointer to array with x coordinates of
1793 y (const PLFLT *, input) : Pointer to array with y coordinates of
1796 angle (PLFLT, input) : Angle (degrees) of gradient vector from x
1800 return _plplotc.plgradient(*args)
1804 Flushes the output stream
1808 Flushes the output stream. Use sparingly, if at all.
1810 Redacted form: plflush()
1812 This function is used in examples 1,14.
1821 return _plplotc.plflush()
1829 Sets the default character font for subsequent character drawing. Also
1830 affects symbols produced by plpoin. This routine has no effect unless
1831 the extended character set is loaded (see plfontld).
1833 Redacted form: plfont(ifont)
1835 This function is used in examples 1,2,4,7,13,24,26.
1845 ifont (PLINT, input) : Specifies the font: 1: Normal font (simplest
1852 return _plplotc.plfont(*args)
1860 Sets the character set to use for subsequent character drawing. May
1861 be called before initializing PLplot.
1863 Redacted form: plfontld(fnt)
1865 This function is used in examples 1,7.
1875 fnt (PLINT, input) : Specifies the character set to load: 0:
1876 Standard character set
1877 1: Extended character set
1880 return _plplotc.plfontld(*args)
1884 Get character default height and current (scaled) height
1888 Get character default height and current (scaled) height.
1890 Redacted form: plgchr(p_def, p_ht)
1892 This function is used in example 23.
1902 p_def (PLFLT *, output) : Pointer to default character height (mm).
1904 p_ht (PLFLT *, output) : Pointer to current (scaled) character
1908 return _plplotc.plgchr()
1912 Returns 8-bit RGB values for given color index from cmap0
1916 Returns 8-bit RGB values (0-255) for given color from cmap0 (see the
1917 PLplot documentation). Values are negative if an invalid color id is
1920 Redacted form: plgcol0(icol0, r, g, b)
1922 This function is used in example 2.
1928 plgcol0(icol0, r, g, b)
1932 icol0 (PLINT, input) : Index of desired cmap0 color.
1934 r (PLINT *, output) : Pointer to 8-bit red value.
1936 g (PLINT *, output) : Pointer to 8-bit green value.
1938 b (PLINT *, output) : Pointer to 8-bit blue value.
1941 return _plplotc.plgcol0(*args)
1945 Returns 8-bit RGB values and double alpha transparency value for given color index from cmap0
1949 Returns 8-bit RGB values (0-255) and double alpha transparency value
1950 (0.0 - 1.0) for given color from cmap0 (see the PLplot
1951 documentation). Values are negative if an invalid color id is given.
1953 This function is used in example 30.
1959 plgcol0a(icol0, r, g, b, alpha)
1963 icol0 (PLINT, input) : Index of desired cmap0 color.
1965 r (PLINT *, output) : Pointer to 8-bit red value.
1967 g (PLINT *, output) : Pointer to 8-bit green value.
1969 b (PLINT *, output) : Pointer to 8-bit blue value.
1971 alpha (PLFLT *, output) : Pointer to PLFLT alpha transparency
1975 return _plplotc.plgcol0a(*args)
1979 Returns the background color (cmap0[0]) by 8-bit RGB value
1983 Returns the background color (cmap0[0]) by 8-bit RGB value.
1985 Redacted form: plgcolbg(r, g, b)
1987 This function is used in example 31.
1997 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
1998 representing the degree of red in the color.
2000 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
2001 representing the degree of green in the color.
2003 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
2004 representing the degree of blue in the color.
2007 return _plplotc.plgcolbg()
2011 Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha transparency value
2015 Returns the background color (cmap0[0]) by 8-bit RGB value and double
2016 alpha transparency value.
2018 This function is used in example 31.
2024 lgcolbga(r, g, b, alpha)
2028 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
2029 representing the degree of red in the color.
2031 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
2032 representing the degree of green in the color.
2034 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
2035 representing the degree of blue in the color.
2037 alpha (PLFLT *, output) : Pointer to PLFLT alpha transparency
2041 return _plplotc.plgcolbga()
2045 Get the current device-compression setting
2049 Get the current device-compression setting. This parameter is only
2050 used for drivers that provide compression.
2052 Redacted form: plgcompression(compression)
2054 This function is used in example 31.
2060 plgcompression(compression)
2064 compression (PLINT *, output) : Pointer to a variable to be filled
2065 with the current device-compression setting.
2068 return _plplotc.plgcompression()
2072 Get the current device (keyword) name
2076 Get the current device (keyword) name. Note: you must have allocated
2077 space for this (80 characters is safe).
2079 Redacted form: plgdev(p_dev)
2081 This function is used in example 14.
2091 p_dev (char *, output) : Pointer to device (keyword) name string.
2094 return _plplotc.plgdev()
2098 Get parameters that define current device-space window
2102 Get relative margin width, aspect ratio, and relative justification
2103 that define current device-space window. If plsdidev has not been
2104 called the default values pointed to by p_mar, p_aspect, p_jx, and
2107 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy)
2109 This function is used in example 31.
2115 plgdidev(p_mar, p_aspect, p_jx, p_jy)
2119 p_mar (PLFLT *, output) : Pointer to relative margin width.
2121 p_aspect (PLFLT *, output) : Pointer to aspect ratio.
2123 p_jx (PLFLT *, output) : Pointer to relative justification in x.
2125 p_jy (PLFLT *, output) : Pointer to relative justification in y.
2128 return _plplotc.plgdidev()
2132 Get plot orientation
2136 Get plot orientation parameter which is multiplied by 90 degrees to
2137 obtain the angle of rotation. Note, arbitrary rotation parameters
2138 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
2139 values for the rotation parameter are 0., 1., 2., and 3. corresponding
2140 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
2141 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has
2142 not been called the default value pointed to by p_rot will be 0.
2144 Redacted form: plgdiori(p_rot)
2146 This function is not used in any examples.
2156 p_rot (PLFLT *, output) : Pointer to orientation parameter.
2159 return _plplotc.plgdiori()
2163 Get parameters that define current plot-space window
2167 Get relative minima and maxima that define current plot-space window.
2168 If plsdiplt has not been called the default values pointed to by
2169 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1.
2171 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2173 This function is used in example 31.
2179 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2183 p_xmin (PLFLT *, output) : Pointer to relative minimum in x.
2185 p_ymin (PLFLT *, output) : Pointer to relative minimum in y.
2187 p_xmax (PLFLT *, output) : Pointer to relative maximum in x.
2189 p_ymax (PLFLT *, output) : Pointer to relative maximum in y.
2192 return _plplotc.plgdiplt()
2196 Get family file parameters
2200 Gets information about current family file, if familying is enabled.
2201 See the PLplot documentation for more information.
2203 Redacted form: plgfam(p_fam, p_num, p_bmax)
2205 This function is used in examples 14,31.
2211 plgfam(p_fam, p_num, p_bmax)
2215 p_fam (PLINT *, output) : Pointer to variable with the Boolean
2216 family flag value. If nonzero, familying is enabled.
2218 p_num (PLINT *, output) : Pointer to variable with the current
2221 p_bmax (PLINT *, output) : Pointer to variable with the maximum
2222 file size (in bytes) for a family file.
2225 return _plplotc.plgfam()
2229 Get FCI (font characterization integer)
2233 Gets information about the current font using the FCI approach. See
2234 the PLplot documentation for more information.
2236 Redacted form: plgfci(p_fci)
2238 This function is used in example 23.
2248 p_fci (PLUNICODE *, output) : Pointer to PLUNICODE (unsigned 32-bit
2249 integer) variable which is updated with current FCI value.
2252 return _plplotc.plgfci()
2256 Get output file name
2260 Gets the current output file name, if applicable.
2262 Redacted form: plgfnam(fnam)
2264 This function is used in example 31.
2274 fnam (char *, output) : Pointer to file name string (a preallocated
2275 string of 80 characters or more).
2278 return _plplotc.plgfnam()
2282 Get family, style and weight of the current font
2286 Gets information about current font. See the PLplot documentation for
2287 more information on font selection.
2289 Redacted form: plgfont(p_family, p_style, p_weight)
2291 This function is used in example 23.
2297 plgfont(p_family, p_style, p_weight)
2301 p_family (PLINT *, output) : Pointer to variable with the current
2302 font family. The available values are given by the PL_FCI_*
2303 constants in plplot.h. Current options are PL_FCI_SANS,
2304 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If
2305 p_family is NULL then the font family is not returned.
2307 p_style (PLINT *, output) : Pointer to variable with the current
2308 font style. The available values are given by the PL_FCI_*
2309 constants in plplot.h. Current options are PL_FCI_UPRIGHT,
2310 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the
2311 font style is not returned.
2313 p_weight (PLINT *, output) : Pointer to variable with the current
2314 font weight. The available values are given by the PL_FCI_*
2315 constants in plplot.h. Current options are PL_FCI_MEDIUM and
2316 PL_FCI_BOLD. If p_weight is NULL then the font weight is not
2320 return _plplotc.plgfont()
2324 Get the (current) run level
2328 Get the (current) run level. Valid settings are: 0, uninitialized
2331 3, world coordinates defined
2334 Redacted form: plglevel(p_level)
2336 This function is used in example 31.
2346 p_level (PLINT *, output) : Pointer to the run level.
2349 return _plplotc.plglevel()
2357 Gets the current page configuration. The length and offset values are
2358 expressed in units that are specific to the current driver. For
2359 instance: screen drivers will usually interpret them as number of
2360 pixels, whereas printer drivers will usually use mm.
2362 Redacted form: plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2364 This function is used in examples 14 and 31.
2370 plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2374 p_xp (PLFLT *, output) : Pointer to number of pixels/inch (DPI), x.
2376 p_yp (PLFLT *, output) : Pointer to number of pixels/inch (DPI) in
2379 p_xleng (PLINT *, output) : Pointer to x page length value.
2381 p_yleng (PLINT *, output) : Pointer to y page length value.
2383 p_xoff (PLINT *, output) : Pointer to x page offset.
2385 p_yoff (PLINT *, output) : Pointer to y page offset.
2388 return _plplotc.plgpage()
2392 Switch to graphics screen
2396 Sets an interactive device to graphics mode, used in conjunction with
2397 pltext to allow graphics and text to be interspersed. On a device
2398 which supports separate text and graphics windows, this command causes
2399 control to be switched to the graphics window. If already in graphics
2400 mode, this command is ignored. It is also ignored on devices which
2401 only support a single window or use a different method for shifting
2402 focus. See also pltext.
2404 Redacted form: plgra()
2406 This function is used in example 1.
2415 return _plplotc.plgra()
2419 Grid data from irregularly sampled data
2423 Real world data is frequently irregularly sampled, but all PLplot 3D
2424 plots require data placed in a uniform grid. This function takes
2425 irregularly sampled data from three input arrays x[npts], y[npts], and
2426 z[npts], reads the desired grid location from input arrays xg[nptsx]
2427 and yg[nptsy], and returns the gridded data into output array
2428 zg[nptsx][nptsy]. The algorithm used to grid the data is specified
2429 with the argument type which can have one parameter specified in
2432 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data)
2433 Perl/PDL: Not available?
2434 Python: zg=plgriddata(x, y, z, xg, yg, type, data)
2437 This function is used in example 21.
2443 plgriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
2447 x (const PLFLT *, input) : The input x array.
2449 y (const PLFLT *, input) : The input y array.
2451 z (const PLFLT *, input) : The input z array. Each triple x[i],
2452 y[i], z[i] represents one data sample coordinate.
2454 npts (PLINT, input) : The number of data samples in the x, y and z
2457 xg (const PLFLT *, input) : The input array that specifies the grid
2458 spacing in the x direction. Usually xg has nptsx equally spaced
2459 values from the minimum to the maximum values of the x input
2462 nptsx (PLINT, input) : The number of points in the xg array.
2464 yg (const PLFLT *, input) : The input array that specifies the grid
2465 spacing in the y direction. Similar to the xg parameter.
2467 nptsy (PLINT, input) : The number of points in the yg array.
2469 zg (PLFLT **, output) : The output array, where data lies in the
2470 regular grid specified by xg and yg. the zg array must exist or be
2471 allocated by the user prior to the call, and must have dimension
2474 type (PLINT, input) : The type of gridding algorithm to use, which
2475 can be: GRID_CSA: Bivariate Cubic Spline approximation
2476 GRID_DTLI: Delaunay Triangulation Linear Interpolation
2477 GRID_NNI: Natural Neighbors Interpolation
2478 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
2479 GRID_NNLI: Nearest Neighbors Linear Interpolation
2480 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
2482 For details of the algorithms read the source file plgridd.c.
2484 data (PLFLT, input) : Some gridding algorithms require extra data,
2485 which can be specified through this argument. Currently, for
2486 algorithm: GRID_NNIDW, data specifies the number of neighbors to
2487 use, the lower the value, the noisier (more local) the
2489 GRID_NNLI, data specifies what a thin triangle is, in the
2490 range [1. .. 2.]. High values enable the usage of very thin
2491 triangles for interpolation, possibly resulting in error in
2493 GRID_NNI, only weights greater than data will be accepted. If
2494 0, all weights will be accepted.
2497 return _plplotc.plgriddata(*args)
2501 Get current subpage parameters
2505 Gets the size of the current subpage in millimeters measured from the
2506 bottom left hand corner of the output device page or screen. Can be
2507 used in conjunction with plsvpa for setting the size of a viewport in
2508 absolute coordinates (millimeters).
2510 Redacted form: plgspa(xmin, xmax, ymin, ymax)
2512 This function is used in example 23.
2518 plgspa(xmin, xmax, ymin, ymax)
2522 xmin (PLFLT *, output) : Pointer to variable with position of left
2523 hand edge of subpage in millimeters.
2525 xmax (PLFLT *, output) : Pointer to variable with position of right
2526 hand edge of subpage in millimeters.
2528 ymin (PLFLT *, output) : Pointer to variable with position of
2529 bottom edge of subpage in millimeters.
2531 ymax (PLFLT *, output) : Pointer to variable with position of top
2532 edge of subpage in millimeters.
2535 return _plplotc.plgspa()
2539 Get current stream number
2543 Gets the number of the current output stream. See also plsstrm.
2545 Redacted form: plgstrm(p_strm)
2547 This function is used in example 1,20.
2557 p_strm (PLINT *, output) : Pointer to current stream value.
2560 return _plplotc.plgstrm()
2564 Get the current library version number
2568 Get the current library version number. Note: you must have allocated
2569 space for this (80 characters is safe).
2571 Redacted form: plgver(p_ver)
2573 This function is used in example 1.
2583 p_ver (char *, output) : Pointer to the current library version
2587 return _plplotc.plgver()
2591 Get viewport limits in normalized device coordinates
2595 Get viewport limits in normalized device coordinates.
2597 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2598 Perl/PDL: Not available?
2601 This function is used in example 31.
2607 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2611 p_xmin (PLFLT *, output) : Lower viewport limit of the normalized
2612 device coordinate in x.
2614 p_xmax (PLFLT *, output) : Upper viewport limit of the normalized
2615 device coordinate in x.
2617 p_ymin (PLFLT *, output) : Lower viewport limit of the normalized
2618 device coordinate in y.
2620 p_ymax (PLFLT *, output) : Upper viewport limit of the normalized
2621 device coordinate in y.
2624 return _plplotc.plgvpd()
2628 Get viewport limits in world coordinates
2632 Get viewport limits in world coordinates.
2634 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2635 Perl/PDL: Not available?
2638 This function is used in example 31.
2644 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2648 p_xmin (PLFLT *, output) : Lower viewport limit of the world
2651 p_xmax (PLFLT *, output) : Upper viewport limit of the world
2654 p_ymin (PLFLT *, output) : Lower viewport limit of the world
2657 p_ymax (PLFLT *, output) : Upper viewport limit of the world
2661 return _plplotc.plgvpw()
2665 Get x axis parameters
2669 Returns current values of the p_digmax and p_digits flags for the x
2670 axis. p_digits is updated after the plot is drawn, so this routine
2671 should only be called after the call to plbox (or plbox3) is complete.
2672 See the PLplot documentation for more information.
2674 Redacted form: plgxax(p_digmax, p_digits)
2676 This function is used in example 31.
2682 plgxax(p_digmax, p_digits)
2686 p_digmax (PLINT *, output) : Pointer to variable with the maximum
2687 number of digits for the x axis. If nonzero, the printed label
2688 has been switched to a floating point representation when the
2689 number of digits exceeds p_digmax.
2691 p_digits (PLINT *, output) : Pointer to variable with the actual
2692 number of digits for the numeric labels (x axis) from the last
2696 return _plplotc.plgxax()
2700 Get y axis parameters
2704 Identical to plgxax, except that arguments are flags for y axis. See
2705 the description of plgxax for more detail.
2707 Redacted form: plgyax(p_digmax, p_digits)
2709 This function is used in example 31.
2715 plgyax(p_digmax, p_digits)
2719 p_digmax (PLINT *, output) : Pointer to variable with the maximum
2720 number of digits for the y axis. If nonzero, the printed label
2721 has been switched to a floating point representation when the
2722 number of digits exceeds p_digmax.
2724 p_digits (PLINT *, output) : Pointer to variable with the actual
2725 number of digits for the numeric labels (y axis) from the last
2729 return _plplotc.plgyax()
2733 Get z axis parameters
2737 Identical to plgxax, except that arguments are flags for z axis. See
2738 the description of plgxax for more detail.
2740 Redacted form: plgzax(p_digmax, p_digits)
2742 This function is used in example 31.
2748 plgzax(p_digmax, p_digits)
2752 p_digmax (PLINT *, output) : Pointer to variable with the maximum
2753 number of digits for the z axis. If nonzero, the printed label
2754 has been switched to a floating point representation when the
2755 number of digits exceeds p_digmax.
2757 p_digits (PLINT *, output) : Pointer to variable with the actual
2758 number of digits for the numeric labels (z axis) from the last
2762 return _plplotc.plgzax()
2766 Plot a histogram from unbinned data
2770 Plots a histogram from n data points stored in the array data. This
2771 routine bins the data into nbin bins equally spaced between datmin and
2772 datmax, and calls plbin to draw the resulting histogram. Parameter
2773 opt allows, among other things, the histogram either to be plotted in
2774 an existing window or causes plhist to call plenv with suitable limits
2775 before plotting the histogram.
2777 Redacted form: plhist(data, datmin, datmax, nbin, opt)
2779 This function is used in example 5.
2785 plhist(n, data, datmin, datmax, nbin, opt)
2789 n (PLINT, input) : Number of data points.
2791 data (const PLFLT *, input) : Pointer to array with values of the n
2794 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
2796 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
2798 nbin (PLINT, input) : Number of (equal-sized) bins into which to
2799 divide the interval xmin to xmax.
2801 opt (PLINT, input) : Is a combination of several flags:
2802 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
2803 the histogram data, the outer bins are expanded to fill up the
2804 entire x-axis, data outside the given extremes are assigned to the
2805 outer bins and bins of zero height are simply drawn.
2806 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled
2807 to fit the histogram data, without this flag, plenv is called
2808 to set the world coordinates.
2809 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
2810 extremes are not taken into account. This option should
2811 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to
2812 properly present the data.
2813 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal
2814 size as the ones inside.
2815 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn
2816 (there is a gap for such bins).
2819 return _plplotc.plhist(*args)
2823 Convert HLS color to RGB
2827 Convert HLS color coordinates to RGB.
2829 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
2830 Perl/PDL: Not available? Implemented as plhls?
2833 This function is used in example 2.
2839 plhlsrgb(h, l, s, p_r, p_g, p_b)
2843 h (PLFLT, input) : Hue, in degrees on the colour cone (0.0-360.0)
2845 l (PLFLT, input) : Lightness, expressed as a fraction of the axis
2846 of the colour cone (0.0-1.0)
2848 s (PLFLT, input) : Saturation, expressed as a fraction of the
2849 radius of the colour cone (0.0-1.0)
2851 p_r (PLFLT *, output) : Pointer to red intensity (0.0-1.0) of the
2854 p_g (PLFLT *, output) : Pointer to green intensity (0.0-1.0) of the
2857 p_b (PLFLT *, output) : Pointer to blue intensity (0.0-1.0) of the
2861 return _plplotc.plhlsrgb(*args)
2869 Initializing the plotting package. The program prompts for the device
2870 keyword or number of the desired output device. Hitting a RETURN in
2871 response to the prompt is the same as selecting the first device.
2872 plinit will issue no prompt if either the device was specified
2873 previously (via command line flag, the plsetopt function, or the
2874 plsdev function), or if only one device is enabled when PLplot is
2875 installed. If subpages have been specified, the output device is
2876 divided into nx by ny subpages, each of which may be used
2877 independently. If plinit is called again during a program, the
2878 previously opened file will be closed. The subroutine pladv is used
2879 to advance from one subpage to the next.
2881 Redacted form: plinit()
2883 This function is used in all of the examples.
2892 return _plplotc.plinit()
2896 Draw a line between two points
2906 Redacted form: pljoin(x1,y1,x2,y2)
2908 This function is used in examples 3,14.
2914 pljoin(x1, y1, x2, y2)
2918 x1 (PLFLT, input) : x coordinate of first point.
2920 y1 (PLFLT, input) : y coordinate of first point.
2922 x2 (PLFLT, input) : x coordinate of second point.
2924 y2 (PLFLT, input) : y coordinate of second point.
2927 return _plplotc.pljoin(*args)
2931 Simple routine to write labels
2935 Routine for writing simple labels. Use plmtex for more complex labels.
2937 Redacted form: pllab(xlabel, ylabel, tlabel)
2939 This function is used in examples 1,5,9,12,14-16,20-22,29.
2945 pllab(xlabel, ylabel, tlabel)
2949 xlabel (const char *, input) : Label for horizontal axis.
2951 ylabel (const char *, input) : Label for vertical axis.
2953 tlabel (const char *, input) : Title of graph.
2956 return _plplotc.pllab(*args)
2960 Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols
2964 Routine for creating a discrete plot legend with a plotted filled box,
2965 line, and/or line of symbols for each annotated legend entry. (See
2966 plcolorbar for similar functionality for creating continuous color
2967 bars.) The arguments of pllegend provide control over the location
2968 and size of the legend as well as the location and characteristics of
2969 the elements (most of which are optional) within that legend. The
2970 resulting legend is clipped at the boundaries of the current subpage.
2971 (N.B. the adopted coordinate system used for some of the parameters is
2972 defined in the documentation of the position parameter.)
2974 Redacted form: pllegend(p_legend_width, p_legend_height, opt,
2975 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow,
2976 ncolumn, opt_array, text_offset, text_scale, text_spacing,
2977 test_justification, text_colors, text, box_colors, box_patterns,
2978 box_scales, box_line_widths, line_colors, line_styles, line_widths,
2979 symbol_colors, symbol_scales, symbol_numbers, symbols)
2981 This function is used in examples 4, 26, and 33.
2987 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)
2991 p_legend_width (PLFLT *, output) : Pointer to a location which
2992 contains (after the call) the legend width in adopted coordinates.
2993 This quantity is calculated from plot_width, text_offset, ncolumn
2994 (possibly modified inside the routine depending on nlegend and
2995 nrow), and the length (calculated internally) of the longest text
2998 p_legend_height (PLFLT *, output) : Pointer to a location which
2999 contains (after the call) the legend height in adopted
3000 coordinates. This quantity is calculated from text_scale,
3001 text_spacing, and nrow (possibly modified inside the routine
3002 depending on nlegend and nrow).
3004 opt (PLINT, input) : opt contains bits controlling the overall
3005 legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area
3006 on the left of the legend and the plotted area on the right.
3007 Otherwise, put the text area on the right of the legend and the
3008 plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set,
3009 plot a (semi-transparent) background for the legend. If the
3010 PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the
3011 legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the
3012 possibly internally transformed) nrow > 1 and ncolumn > 1, then
3013 plot the resulting array of legend entries in row-major order.
3014 Otherwise, plot the legend entries in column-major order.
3016 position (PLINT, input) : position contains bits which control the
3017 overall position of the legend and the definition of the adopted
3018 coordinates used for positions just like what is done for the
3019 position argument for plcolorbar. However, note that the defaults
3020 for the position bits (see below) are different than the
3021 plcolorbar case. The combination of the PL_POSITION_LEFT,
3022 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3023 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3024 the 16 possible standard positions (the 4 corners and centers of
3025 the 4 sides for both the inside and outside cases) of the legend
3026 relative to the adopted coordinate system. The corner positions
3027 are specified by the appropriate combination of two of the
3028 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3029 PL_POSITION_BOTTOM bits while the sides are specified by a single
3030 value of one of those bits. The adopted coordinates are
3031 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3032 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3033 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3034 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3035 then use the combination of PL_POSITION_RIGHT and PL_POSITION_TOP.
3036 If neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set,
3037 use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or
3038 PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT.
3040 x (PLFLT, input) : X offset of the legend position in adopted
3041 coordinates from the specified standard position of the legend.
3042 For positive x, the direction of motion away from the standard
3043 position is inward/outward from the standard corner positions or
3044 standard left or right positions if the
3045 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3046 For the standard top or bottom positions, the direction of motion
3047 is toward positive X.
3049 y (PLFLT, input) : Y offset of the legend position in adopted
3050 coordinates from the specified standard position of the legend.
3051 For positive y, the direction of motion away from the standard
3052 position is inward/outward from the standard corner positions or
3053 standard top or bottom positions if the
3054 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3055 For the standard left or right positions, the direction of motion
3056 is toward positive Y.
3058 plot_width (PLFLT, input) : Horizontal width in adopted coordinates
3059 of the plot area (where the colored boxes, lines, and/or lines of
3060 symbols are drawn) of the legend.
3062 bg_color (PLINT, input) : The cmap0 color of the background for the
3063 legend (PL_LEGEND_BACKGROUND).
3065 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3066 for the legend (PL_LEGEND_BOUNDING_BOX).
3068 bb_style (PLINT, input) : The pllsty style number for the
3069 bounding-box line for the legend (PL_LEGEND_BACKGROUND).
3071 nrow (PLINT, input) : The cmap0 index of the background color for
3072 the legend (PL_LEGEND_BACKGROUND).
3074 ncolumn (PLINT, input) : The cmap0 index of the background color
3075 for the legend (PL_LEGEND_BACKGROUND).
3077 nlegend (PLINT, input) : Number of legend entries. N.B. The total
3078 vertical height of the legend in adopted coordinates is calculated
3079 internally from nlegend, text_scale (see below), and text_spacing
3082 opt_array (const PLINT *, input) : Array of nlegend values of
3083 options to control each individual plotted area corresponding to a
3084 legend entry. If the
3085 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted
3087 PL_LEGEND_COLOR_BOX,
3088 PL_LEGEND_LINE, and/or
3089 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
3090 entry is plotted with a colored box; a line; and/or a line of
3093 text_offset (PLFLT, input) : Offset of the text area from the plot
3094 area in units of character width. N.B. The total horizontal
3095 width of the legend in adopted coordinates is calculated
3097 plot_width (see above),
3098 text_offset, and length (calculated internally) of the longest text
3101 text_scale (PLFLT, input) : Character height scale for text
3102 annotations. N.B. The total vertical height of the legend in
3103 adopted coordinates is calculated internally from
3104 nlegend (see above),
3106 text_spacing (see below).
3108 text_spacing (PLFLT, input) : Vertical spacing in units of the
3109 character height from one legend entry to the next. N.B. The
3110 total vertical height of the legend in adopted coordinates is
3111 calculated internally from
3112 nlegend (see above),
3113 text_scale (see above), and
3116 text_justification (PLFLT, input) : Justification parameter used
3117 for text justification. The most common values of
3118 text_justification are 0., 0.5, or 1. corresponding to a text that
3119 is left justified, centred, or right justified within the text
3120 area, but other values are allowed as well.
3122 text_colors (const PLINT *, input) : Array of nlegend cmap0 text
3125 text (const char * const *, input) : Array of nlegend text string
3128 box_colors (const PLINT *, input) : Array of nlegend cmap0 colors
3129 for the discrete colored boxes (
3130 PL_LEGEND_COLOR_BOX).
3132 box_patterns (const PLINT *, input) : Array of nlegend patterns
3133 (plpsty indices) for the discrete colored boxes (
3134 PL_LEGEND_COLOR_BOX).
3136 box_scales (const PLFLT *, input) : Array of nlegend scales (units
3137 of fraction of character height) for the height of the discrete
3139 PL_LEGEND_COLOR_BOX).
3141 box_line_widths (const PLFLT *, input) : Array of nlegend line
3142 widths for the patterns specified by box_patterns (
3143 PL_LEGEND_COLOR_BOX).
3145 line_colors (const PLINT *, input) : Array of nlegend cmap0 line
3149 line_styles (const PLINT *, input) : Array of nlegend line styles
3153 line_widths (const PLFLT *, input) : Array of nlegend line widths (
3156 symbol_colors (const PLINT *, input) : Array of nlegend cmap0
3160 symbol_scales (const PLFLT *, input) : Array of nlegend scale
3161 values for the symbol height (
3164 symbol_numbers (const PLINT *, input) : Array of nlegend numbers of
3165 symbols to be drawn across the width of the plotted area (
3168 symbols (const char * const *, input) : Array of nlegend symbols
3173 return _plplotc.pllegend(*args)
3177 Plot color bar for image, shade or gradient plots
3181 Routine for creating a continuous color bar for image, shade, or
3182 gradient plots. (See pllegend for similar functionality for creating
3183 legends with discrete elements). The arguments of plcolorbar provide
3184 control over the location and size of the color bar as well as the
3185 location and characteristics of the elements (most of which are
3186 optional) within that color bar. The resulting color bar is clipped
3187 at the boundaries of the current subpage. (N.B. the adopted coordinate
3188 system used for some of the parameters is defined in the documentation
3189 of the position parameter.)
3191 Redacted form: plcolorbar(p_colorbar_width, p_colorbar_height, opt,
3192 position, x, y, x_length, y_length, bg_color, bb_color, bb_style,
3193 low_cap_color, high_cap_color, cont_color, cont_width, label_opts,
3194 labels, axis_opts, ticks, sub_ticks, values)
3196 This function is used in examples 16 and 33.
3202 plcolorbar(p_colorbar_width, p_colorbar_height, opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, n_labels, label_opts, labels, naxes, axis_opts, ticks, sub_ticks, n_values, values)
3206 p_colorbar_width (PLFLT *, output) : Pointer to a location which
3207 contains (after the call) the labelled and decorated color bar
3208 width in adopted coordinates.
3210 p_colorbar_height (PLFLT *, output) : Pointer to a location which
3211 contains (after the call) the labelled and decorated color bar
3212 height in adopted coordinates.
3214 opt (PLINT, input) : opt contains bits controlling the overall
3215 color bar. The orientation (direction of the maximum value) of
3216 the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
3217 PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM. If none of these bits are
3218 specified, the default orientation is toward the top if the
3219 colorbar is placed on the left or right of the viewport or toward
3220 the right if the colorbar is placed on the top or bottom of the
3221 viewport. If the PL_COLORBAR_BACKGROUND bit is set, plot a
3222 (semi-transparent) background for the color bar. If the
3223 PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the
3224 color bar. The type of color bar must be specified with one of
3225 PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If
3226 more than one of those bits is set only the first one in the above
3227 list is honored. The position of the (optional) label/title can be
3228 specified with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT, or
3229 PL_LABEL_BOTTOM. If no label position bit is set then no label
3230 will be drawn. If more than one of this list of bits is specified,
3231 only the first one on the list is honored. End-caps for the color
3232 bar can added with PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.
3233 If a particular color bar cap option is not specified then no cap
3234 will be drawn for that end. As a special case for
3235 PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be
3236 specified. If this option is provided then any tick marks and tick
3237 labels will be placed at the breaks between shaded segments. TODO:
3238 This should be expanded to support custom placement of tick marks
3239 and tick labels at custom value locations for any color bar type.
3241 position (PLINT, input) : position contains bits which control the
3242 overall position of the color bar and the definition of the
3243 adopted coordinates used for positions just like what is done for
3244 the position argument for pllegend. However, note that the
3245 defaults for the position bits (see below) are different than the
3246 pllegend case. The combination of the PL_POSITION_LEFT,
3247 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3248 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3249 the 16 possible standard positions (the 4 corners and centers of
3250 the 4 sides for both the inside and outside cases) of the color
3251 bar relative to the adopted coordinate system. The corner
3252 positions are specified by the appropriate combination of two of
3253 the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3254 PL_POSITION_BOTTOM bits while the sides are specified by a single
3255 value of one of those bits. The adopted coordinates are
3256 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3257 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3258 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3259 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3260 then use PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE or
3261 PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE. If neither of
3262 PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use
3263 PL_POSITION_VIEWPORT.
3265 x (PLFLT, input) : X offset of the color bar position in adopted
3266 coordinates from the specified standard position of the color bar.
3267 For positive x, the direction of motion away from the standard
3268 position is inward/outward from the standard corner positions or
3269 standard left or right positions if the
3270 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3271 For the standard top or bottom positions, the direction of motion
3272 is toward positive X.
3274 y (PLFLT, input) : Y offset of the color bar position in adopted
3275 coordinates from the specified standard position of the color bar.
3276 For positive y, the direction of motion away from the standard
3277 position is inward/outward from the standard corner positions or
3278 standard top or bottom positions if the
3279 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3280 For the standard left or right positions, the direction of motion
3281 is toward positive Y.
3283 x_length (PLFLT, input) : Length of the body of the color bar in
3284 the X direction in adopted coordinates.
3286 y_length (PLFLT, input) : Length of the body of the color bar in
3287 the Y direction in adopted coordinates.
3289 bg_color (PLINT, input) : The cmap0 color of the background for the
3290 color bar (PL_COLORBAR_BACKGROUND).
3292 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3293 for the color bar (PL_COLORBAR_BOUNDING_BOX).
3295 bb_style (PLINT, input) : The pllsty style number for the
3296 bounding-box line for the color bar (PL_COLORBAR_BACKGROUND).
3298 low_cap_color (PLFLT, input) : The cmap1 color of the low-end color
3299 bar cap, if it is drawn (PL_COLORBAR_CAP_LOW).
3301 high_cap_color (PLFLT, input) : The cmap1 color of the high-end
3302 color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH).
3304 cont_color (PLINT, input) : The cmap0 contour color for
3305 PL_COLORBAR_SHADE plots. This is passed directly to plshades, so
3306 it will be interpreted according to the design of plshades.
3308 cont_width (PLFLT, input) : Contour width for PL_COLORBAR_SHADE
3309 plots. This is passed directly to plshades, so it will be
3310 interpreted according to the design of plshades.
3312 n_labels (PLINT, input) : Number of labels to place around the
3315 label_opts (const PLINT *, input) : Options for each of
3318 labels (const char * const *, input) : n_labels text labels for the
3319 color bar. No label is drawn if no label position is specified
3320 with one of the PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP,
3321 PL_COLORBAR_LABEL_LEFT, or PL_COLORBAR_LABEL_BOTTOM bits in the
3322 corresponding label_opts field.
3324 n_axes (PLINT, input) : Number of axis definitions provided. This
3325 value must be greater than 0. It is typically 1 (numerical axis
3326 labels are provided for one of the long edges of the color bar),
3327 but it can be larger if multiple numerical axis labels for the
3328 long edges of the color bar are desired.
3330 axis_opts (const char * const *, input) : An array of n_axes axis
3331 options (interpreted as for plbox) for the color bar's axis
3334 ticks (const PLFLT *, input) : An array of n_axes values of the
3335 spacing of the major tick marks (interpreted as for plbox) for the
3336 color bar's axis definitions.
3338 sub_ticks (const PLINT *, input) : An array of n_axes values of the
3339 number of subticks (interpreted as for plbox) for the color bar's
3342 n_values (const PLINT *, input) : An array containing the number of
3343 elements in each of the n_axes rows of the two-dimensional values
3346 values (const PLFLT * const *, input) : A two-dimensional array
3347 containing the numeric values for the data range represented by
3348 the color bar. For a row index of i_axis (where 0 < i_axis <
3349 n_axes), the number of elements in the row is specified by
3350 n_values[i_axis]. For PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT
3351 the number of elements is 2, and the corresponding row elements of
3352 the values array are the minimum and maximum value represented by
3353 the colorbar. For PL_COLORBAR_SHADE, the number and values of the
3354 elements of a row of the values array is interpreted the same as
3355 the nlevel and clevel arguments of plshades.
3358 return _plplotc.plcolorbar(*args)
3362 Sets the 3D position of the light source
3366 Sets the 3D position of the light source for use with plsurf3d.
3368 Redacted form: pllightsource(x, y, z)
3370 This function is used in example 8.
3376 pllightsource(x, y, z)
3380 x (PLFLT, input) : X-coordinate of the light source.
3382 y (PLFLT, input) : Y-coordinate of the light source.
3384 z (PLFLT, input) : Z-coordinate of the light source.
3387 return _plplotc.pllightsource(*args)
3395 Draws line defined by n points in x and y.
3397 Redacted form: plline(x, y)
3399 This function is used in examples 1,3,4,9,12-14,16,18,20,22,25-27,29.
3409 n (PLINT, input) : Number of points defining line.
3411 x (const PLFLT *, input) : Pointer to array with x coordinates of
3414 y (const PLFLT *, input) : Pointer to array with y coordinates of
3418 return _plplotc.plline(*args)
3422 Draw a line in 3 space
3426 Draws line in 3 space defined by n points in x, y, and z. You must
3427 first set up the viewport, the 2d viewing window (in world
3428 coordinates), and the 3d normalized coordinate box. See x18c.c for
3431 Redacted form: plline3(x, y, z)
3433 This function is used in example 18.
3443 n (PLINT, input) : Number of points defining line.
3445 x (const PLFLT *, input) : Pointer to array with x coordinates of
3448 y (const PLFLT *, input) : Pointer to array with y coordinates of
3451 z (const PLFLT *, input) : Pointer to array with z coordinates of
3455 return _plplotc.plline3(*args)
3463 This sets the line style according to one of eight predefined patterns
3466 Redacted form: pllsty(lin)
3468 This function is used in examples 9,12,22,25.
3478 lin (PLINT, input) : Integer value between 1 and 8. Line style 1 is
3479 a continuous line, line style 2 is a line with short dashes and
3480 gaps, line style 3 is a line with long dashes and gaps, line style
3481 4 has long dashes and short gaps and so on.
3484 return _plplotc.pllsty(*args)
3492 Plots a surface mesh within the environment set up by plw3d. The
3493 surface is defined by the two-dimensional array z[
3495 ny] , the point z[i][j] being the value of the function at (
3497 y[j]) . Note that the points in arrays x and y do not need to be
3498 equally spaced, but must be stored in ascending order. The parameter
3499 opt controls the way in which the surface is displayed. For further
3500 details see the PLplot documentation.
3502 Redacted form: plmesh(x, y, z, opt)
3504 This function is used in example 11.
3510 plmesh(x, y, z, nx, ny, opt)
3514 x (const PLFLT *, input) : Pointer to set of x coordinate values at
3515 which the function is evaluated.
3517 y (const PLFLT *, input) : Pointer to set of y coordinate values at
3518 which the function is evaluated.
3520 z (const PLFLT * const *, input) : Pointer to a vectored
3521 two-dimensional array with set of function values.
3523 nx (PLINT, input) : Number of x values at which function is
3526 ny (PLINT, input) : Number of y values at which function is
3529 opt (PLINT, input) : Determines the way in which the surface is
3530 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3531 function of x for each value of y[j] .
3532 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3533 for each value of x[i] .
3534 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3535 at which function is defined.
3538 return _plplotc.plmesh(*args)
3542 Magnitude colored plot surface mesh with contour
3546 A more powerful form of plmesh: the surface mesh can be colored
3547 accordingly to the current z value being plotted, a contour plot can
3548 be drawn at the base XY plane, and a curtain can be drawn between the
3549 plotted function border and the base XY plane.
3551 Redacted form: plmeshc(x, y, z, opt, clevel)
3553 This function is used in example 11.
3559 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
3563 x (const PLFLT *, input) : Pointer to set of x coordinate values at
3564 which the function is evaluated.
3566 y (const PLFLT *, input) : Pointer to set of y coordinate values at
3567 which the function is evaluated.
3569 z (const PLFLT * const *, input) : Pointer to a vectored
3570 two-dimensional array with set of function values.
3572 nx (PLINT, input) : Number of x values at which function is
3575 ny (PLINT, input) : Number of y values at which function is
3578 opt (PLINT, input) : Determines the way in which the surface is
3579 represented. To specify more than one option just add the options,
3580 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3581 showing z as a function of x for each value of y[j] .
3582 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3583 for each value of x[i] .
3584 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3585 at which function is defined.
3586 opt=MAG_COLOR : Each line in the mesh is colored according to
3587 the z value being plotted. The color is used from the current
3589 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3593 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3594 the borders of the plotted function.
3597 clevel (const PLFLT *, input) : Pointer to the array that defines
3598 the contour level spacing.
3600 nlevel (PLINT, input) : Number of elements in the clevel array.
3603 return _plplotc.plmeshc(*args)
3607 Creates a new stream and makes it the default
3611 Creates a new stream and makes it the default. Differs from using
3612 plsstrm, in that a free stream number is found, and returned.
3613 Unfortunately, I have to start at stream 1 and work upward, since
3614 stream 0 is preallocated. One of the big flaws in the PLplot API is
3615 that no initial, library-opening call is required. So stream 0 must
3616 be preallocated, and there is no simple way of determining whether it
3617 is already in use or not.
3619 Redacted form: plmkstrm(p_strm)
3621 This function is used in examples 1,20.
3631 p_strm (PLINT *, output) : Pointer to stream number of the created
3635 return _plplotc.plmkstrm()
3639 Write text relative to viewport boundaries
3643 Writes text at a specified position relative to the viewport
3644 boundaries. Text may be written inside or outside the viewport, but
3645 is clipped at the subpage boundaries. The reference point of a string
3646 lies along a line passing through the string at half the height of a
3647 capital letter. The position of the reference point along this line
3648 is determined by just, and the position of the reference point
3649 relative to the viewport is set by disp and pos.
3651 Redacted form: General: plmtex(side, disp, pos, just, text)
3652 Perl/PDL: plmtex(disp, pos, just, side, text)
3655 This function is used in examples 3,4,6-8,11,12,14,18,23,26.
3661 plmtex(side, disp, pos, just, text)
3665 side (const char *, input) : Specifies the side of the viewport
3666 along which the text is to be written. The string must be one of:
3667 b: Bottom of viewport, text written parallel to edge.
3668 bv: Bottom of viewport, text written at right angles to edge.
3669 l: Left of viewport, text written parallel to edge.
3670 lv: Left of viewport, text written at right angles to edge.
3671 r: Right of viewport, text written parallel to edge.
3672 rv: Right of viewport, text written at right angles to edge.
3673 t: Top of viewport, text written parallel to edge.
3674 tv: Top of viewport, text written at right angles to edge.
3677 disp (PLFLT, input) : Position of the reference point of string,
3678 measured outwards from the specified viewport edge in units of the
3679 current character height. Use negative disp to write within the
3682 pos (PLFLT, input) : Position of the reference point of string
3683 along the specified edge, expressed as a fraction of the length of
3686 just (PLFLT, input) : Specifies the position of the string relative
3687 to its reference point. If just=0. , the reference point is at
3688 the left and if just=1. , it is at the right of the string. Other
3689 values of just give intermediate justifications.
3691 text (const char *, input) : The string to be written out.
3694 return _plplotc.plmtex(*args)
3698 Write text relative to viewport boundaries in 3D plots
3702 Writes text at a specified position relative to the viewport
3703 boundaries. Text may be written inside or outside the viewport, but
3704 is clipped at the subpage boundaries. The reference point of a string
3705 lies along a line passing through the string at half the height of a
3706 capital letter. The position of the reference point along this line
3707 is determined by just, and the position of the reference point
3708 relative to the viewport is set by disp and pos.
3710 Redacted form: plmtex3(side, disp, pos, just, text)
3712 This function is used in example 28.
3718 plmtex3(side, disp, pos, just, text)
3722 side (const char *, input) : Specifies the side of the viewport
3723 along which the text is to be written. The string should contain
3724 one or more of the following characters: [xyz][ps][v]. Only one
3725 label is drawn at a time, i.e. xyp will only label the X axis, not
3726 both the X and Y axes. x: Label the X axis.
3727 y: Label the Y axis.
3728 z: Label the Z axis.
3729 p: Label the primary axis. For Z this is the leftmost Z axis.
3730 For X it is the axis that starts at y-min. For Y it is the
3731 axis that starts at x-min.
3732 s: Label the secondary axis.
3733 v: Draw the text perpendicular to the axis.
3736 disp (PLFLT, input) : Position of the reference point of string,
3737 measured outwards from the specified viewport edge in units of the
3738 current character height. Use negative disp to write within the
3741 pos (PLFLT, input) : Position of the reference point of string
3742 along the specified edge, expressed as a fraction of the length of
3745 just (PLFLT, input) : Specifies the position of the string relative
3746 to its reference point. If just=0. , the reference point is at
3747 the left and if just=1. , it is at the right of the string. Other
3748 values of just give intermediate justifications.
3750 text (const char *, input) : The string to be written out.
3753 return _plplotc.plmtex3(*args)
3757 Plot 3-d surface plot
3761 Plots a three dimensional surface plot within the environment set up
3762 by plw3d. The surface is defined by the two-dimensional array z[
3764 ny] , the point z[i][j] being the value of the function at (
3766 y[j]) . Note that the points in arrays x and y do not need to be
3767 equally spaced, but must be stored in ascending order. The parameter
3768 opt controls the way in which the surface is displayed. For further
3769 details see the PLplot documentation. The only difference between
3770 plmesh and plot3d is that plmesh draws the bottom side of the surface,
3771 while plot3d only draws the surface as viewed from the top.
3773 Redacted form: plot3d(x, y, z, opt, side)
3775 This function is used in examples 11,21.
3781 plot3d(x, y, z, nx, ny, opt, side)
3785 x (const PLFLT *, input) : Pointer to set of x coordinate values at
3786 which the function is evaluated.
3788 y (const PLFLT *, input) : Pointer to set of y coordinate values at
3789 which the function is evaluated.
3791 z (const PLFLT * const *, input) : Pointer to a vectored
3792 two-dimensional array with set of function values.
3794 nx (PLINT, input) : Number of x values at which function is
3797 ny (PLINT, input) : Number of y values at which function is
3800 opt (PLINT, input) : Determines the way in which the surface is
3801 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3802 function of x for each value of y[j] .
3803 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3804 for each value of x[i] .
3805 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3806 at which function is defined.
3809 side (PLBOOL, input) : Flag to indicate whether or not ``sides''
3810 should be draw on the figure. If side is true sides are drawn,
3811 otherwise no sides are drawn.
3814 return _plplotc.plot3d(*args)
3818 Magnitude colored plot surface with contour
3822 Aside from dropping the
3823 side functionality this is a more powerful form of plot3d: the surface
3824 mesh can be colored accordingly to the current z value being plotted,
3825 a contour plot can be drawn at the base XY plane, and a curtain can be
3826 drawn between the plotted function border and the base XY plane. The
3827 arguments are identical to those of plmeshc. The only difference
3828 between plmeshc and plot3dc is that plmeshc draws the bottom side of
3829 the surface, while plot3dc only draws the surface as viewed from the
3832 Redacted form: General: plot3dc(x, y, z, opt, clevel)
3833 Perl/PDL: Not available?
3836 This function is used in example 21.
3842 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
3846 x (const PLFLT *, input) : Pointer to set of x coordinate values at
3847 which the function is evaluated.
3849 y (const PLFLT *, input) : Pointer to set of y coordinate values at
3850 which the function is evaluated.
3852 z (const PLFLT * const *, input) : Pointer to a vectored
3853 two-dimensional array with set of function values.
3855 nx (PLINT, input) : Number of x values at which function is
3858 ny (PLINT, input) : Number of y values at which function is
3861 opt (PLINT, input) : Determines the way in which the surface is
3862 represented. To specify more than one option just add the options,
3863 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3864 showing z as a function of x for each value of y[j] .
3865 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3866 for each value of x[i] .
3867 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3868 at which function is defined.
3869 opt=MAG_COLOR : Each line in the mesh is colored according to
3870 the z value being plotted. The color is used from the current
3872 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3876 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3877 the borders of the plotted function.
3880 clevel (const PLFLT *, input) : Pointer to the array that defines
3881 the contour level spacing.
3883 nlevel (PLINT, input) : Number of elements in the clevel array.
3886 return _plplotc.plot3dc(*args)
3890 Magnitude colored plot surface with contour for z[x][y] with y index limits
3894 When the implementation is completed this variant of plot3dc (see that
3895 function's documentation for more details) should be suitable for the
3896 case where the area of the x, y coordinate grid where z is defined can
3897 be non-rectangular. The implementation is incomplete so the last 4
3898 parameters of plot3dcl; indexxmin, indexxmax, indexymin, and
3899 indexymax; are currently ignored and the functionality is otherwise
3900 identical to that of plot3dc.
3902 Redacted form: General: plot3dcl(x, y, z, opt, clevel, indexxmin,
3903 indexymin, indexymax)
3904 Perl/PDL: Not available?
3907 This function is not used in any example.
3913 plot3dcl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
3917 x (const PLFLT *, input) : Pointer to set of x coordinate values at
3918 which the function is evaluated.
3920 y (const PLFLT *, input) : Pointer to set of y coordinate values at
3921 which the function is evaluated.
3923 z (const PLFLT * const *, input) : Pointer to a vectored
3924 two-dimensional array with set of function values.
3926 nx (PLINT, input) : Number of x values at which the function is
3929 ny (PLINT, input) : Number of y values at which the function is
3932 opt (PLINT, input) : Determines the way in which the surface is
3933 represented. To specify more than one option just add the options,
3934 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3935 showing z as a function of x for each value of y[j] .
3936 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3937 for each value of x[i] .
3938 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3939 at which function is defined.
3940 opt=MAG_COLOR : Each line in the mesh is colored according to
3941 the z value being plotted. The color is used from the current
3943 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3947 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3948 the borders of the plotted function.
3951 clevel (const PLFLT *, input) : Pointer to the array that defines
3952 the contour level spacing.
3954 nlevel (PLINT, input) : Number of elements in the clevel array.
3956 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
3957 corresponds to the first x index where z is defined.
3959 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
3960 which corresponds (by convention) to one more than the last x
3961 index value where z is defined.
3963 indexymin (const PLINT *, input) : Array of y index values which
3964 all must be ≥ 0. These values are the first y index where z is
3965 defined for a particular x index in the range from indexxmin to
3966 indexxmax - 1. The dimension of indexymin is indexxmax.
3968 indexymax (const PLINT *, input) : Array of y index values which
3969 all must be ≤ ny. These values correspond (by convention) to one
3970 more than the last y index where z is defined for a particular x
3971 index in the range from indexxmin to indexxmax - 1. The dimension
3972 of indexymax is indexxmax.
3975 return _plplotc.plot3dcl(*args)
3979 Plot shaded 3-d surface plot
3983 Plots a three dimensional shaded surface plot within the environment
3984 set up by plw3d. The surface is defined by the two-dimensional array
3987 ny] , the point z[i][j] being the value of the function at (
3989 y[j]) . Note that the points in arrays x and y do not need to be
3990 equally spaced, but must be stored in ascending order. For further
3991 details see the PLplot documentation.
3993 Redacted form: plsurf3d(x, y, z, opt, clevel)
3995 This function is not used in any examples.
4001 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
4005 x (const PLFLT *, input) : Pointer to set of x coordinate values at
4006 which the function is evaluated.
4008 y (const PLFLT *, input) : Pointer to set of y coordinate values at
4009 which the function is evaluated.
4011 z (const PLFLT * const *, input) : Pointer to a vectored
4012 two-dimensional array with set of function values.
4014 nx (PLINT, input) : Number of x values at which function is
4017 ny (PLINT, input) : Number of y values at which function is
4020 opt (PLINT, input) : Determines the way in which the surface is
4021 represented. To specify more than one option just add the options,
4022 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4023 connecting points at which function is defined.
4024 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4028 opt=SURF_CONT : A contour plot is drawn at the surface plane
4032 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4033 the borders of the plotted function.
4034 opt=MAG_COLOR : the surface is colored according to the value
4035 of Z; if MAG_COLOR is not used, then the default the surface
4036 is colored according to the intensity of the reflected light
4037 in the surface from a light source whose position is set using
4041 clevel (const PLFLT *, input) : Pointer to the array that defines
4042 the contour level spacing.
4044 nlevel (PLINT, input) : Number of elements in the clevel array.
4047 return _plplotc.plsurf3d(*args)
4051 Plot shaded 3-d surface plot for z[x][y] with y index limits
4055 This variant of plsurf3d (see that function's documentation for more
4056 details) should be suitable for the case where the area of the x, y
4057 coordinate grid where z is defined can be non-rectangular. The limits
4058 of that grid are provided by the parameters indexxmin, indexxmax,
4059 indexymin, and indexymax.
4061 Redacted form: plsurf3dl(x, y, z, opt, clevel, indexxmin, indexymin,
4064 This function is used in example 8.
4070 plsurf3dl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
4074 x (const PLFLT *, input) : Pointer to set of x coordinate values at
4075 which the function is evaluated.
4077 y (const PLFLT *, input) : Pointer to set of y coordinate values at
4078 which the function is evaluated.
4080 z (const PLFLT * const *, input) : Pointer to a vectored
4081 two-dimensional array with set of function values.
4083 nx (PLINT, input) : Number of x values at which function is
4086 ny (PLINT, input) : Number of y values at which function is
4089 opt (PLINT, input) : Determines the way in which the surface is
4090 represented. To specify more than one option just add the options,
4091 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4092 connecting points at which function is defined.
4093 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4097 opt=SURF_CONT : A contour plot is drawn at the surface plane
4101 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4102 the borders of the plotted function.
4103 opt=MAG_COLOR : the surface is colored according to the value
4104 of Z; if MAG_COLOR is not used, then the default the surface
4105 is colored according to the intensity of the reflected light
4106 in the surface from a light source whose position is set using
4110 clevel (const PLFLT *, input) : Pointer to the array that defines
4111 the contour level spacing.
4113 nlevel (PLINT, input) : Number of elements in the clevel array.
4115 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4116 corresponds to the first x index where z is defined.
4118 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4119 which corresponds (by convention) to one more than the last x
4120 index value where z is defined.
4122 indexymin (const PLINT *, input) : Array of y index values which
4123 all must be ≥ 0. These values are the first y index where z is
4124 defined for a particular x index in the range from indexxmin to
4125 indexxmax - 1. The dimension of indexymin is indexxmax.
4127 indexymax (const PLINT *, input) : Array of y index values which
4128 all must be ≤ ny. These values correspond (by convention) to one
4129 more than the last y index where z is defined for a particular x
4130 index in the range from indexxmin to indexxmax - 1. The dimension
4131 of indexymax is indexxmax.
4134 return _plplotc.plsurf3dl(*args)
4138 Parse command-line arguments
4142 Parse command-line arguments.
4144 plparseopts removes all recognized flags (decreasing argc
4145 accordingly), so that invalid input may be readily detected. It can
4146 also be used to process user command line flags. The user can merge
4147 an option table of type PLOptionTable into the internal option table
4148 info structure using plMergeOpts. Or, the user can specify that ONLY
4149 the external table(s) be parsed by calling plClearOpts before
4152 The default action taken by plparseopts is as follows:
4153 Returns with an error if an unrecognized option or badly formed
4154 option-value pair are encountered.
4155 Returns immediately (return code 0) when the first non-option command
4156 line argument is found.
4157 Returns with the return code of the option handler, if one was called.
4159 Deletes command line arguments from argv list as they are found, and
4160 decrements argc accordingly.
4161 Does not show "invisible" options in usage or help messages.
4162 Assumes the program name is contained in argv[0].
4164 These behaviors may be controlled through the
4167 Redacted form: General: plparseopts(argv, mode)
4168 Perl/PDL: Not available?
4171 This function is used in all of the examples.
4177 int plparseopts(p_argc, argv, mode)
4181 p_argc (int *, input) : pointer to number of arguments.
4183 argv (const char **, input) : Pointer to character array containing
4184 *p_argc command-line arguments.
4186 mode (PLINT, input) : Parsing mode with the following
4187 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
4188 and all error messages enabled, including program exit when an
4189 error occurs. Anything on the command line that isn't recognized
4190 as a valid option or option argument is flagged as an error.
4191 PL_PARSE_QUIET (2) -- Turns off all output except in the case
4193 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
4195 PL_PARSE_SHOWALL (8) -- Show invisible options
4196 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a
4197 pointer to the program name.
4198 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required.
4199 PL_PARSE_SKIP (128) -- Set to quietly skip over any
4200 unrecognized arguments.
4203 return _plplotc.plparseopts(*args)
4207 Set area fill pattern
4211 Sets the area fill pattern. The pattern consists of 1 or 2 sets of
4212 parallel lines with specified inclinations and spacings. The
4213 arguments to this routine are the number of sets to use (1 or 2)
4214 followed by two pointers to integer arrays (of 1 or 2 elements)
4215 specifying the inclinations in tenths of a degree and the spacing in
4216 micrometers. (also see plpsty)
4218 Redacted form: General: plpat(inc, del)
4219 Perl/PDL: plpat(nlin, inc, del)
4222 This function is used in example 15.
4228 plpat(nlin, inc, del)
4232 nlin (PLINT, input) : Number of sets of lines making up the
4233 pattern, either 1 or 2.
4235 inc (const PLINT *, input) : Pointer to array with nlin elements.
4236 Specifies the line inclination in tenths of a degree. (Should be
4237 between -900 and 900).
4239 del (const PLINT *, input) : Pointer to array with nlin elements.
4240 Specifies the spacing in micrometers between the lines making up
4244 return _plplotc.plpat(*args)
4248 Draw a line between two points, accounting for coordinate transforms
4256 y2) . If a global coordinate transform is defined then the line is
4257 broken in to n segments to approximate the path. If no transform is
4258 defined then this simply acts like a call to pljoin.
4260 Redacted form: plpath(n,x1,y1,x2,y2)
4262 This function is used in example 22.
4268 plpath(n, x1, y1, x2, y2)
4272 n (PLINT, input) : number of points to use to approximate the path.
4274 x1 (PLFLT, input) : x coordinate of first point.
4276 y1 (PLFLT, input) : y coordinate of first point.
4278 x2 (PLFLT, input) : x coordinate of second point.
4280 y2 (PLFLT, input) : y coordinate of second point.
4283 return _plplotc.plpath(*args)
4287 Plot a glyph at the specified points
4291 Plot a glyph at the specified points. (This function is largely
4292 superseded by plstring which gives access to many[!] more glyphs.)
4293 code=-1 means try to just draw a point. Right now it's just a move
4294 and a draw at the same place. Not ideal, since a sufficiently
4295 intelligent output device may optimize it away, or there may be faster
4296 ways of doing it. This is OK for now, though, and offers a 4X speedup
4297 over drawing a Hershey font "point" (which is actually diamond shaped
4298 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4299 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4300 code <= 127 the corresponding printable ASCII character is plotted.
4302 Redacted form: plpoin(x, y, code)
4304 This function is used in examples 1,6,14,29.
4310 plpoin(n, x, y, code)
4314 n (PLINT, input) : Number of points in the x and y arrays.
4316 x (const PLFLT *, input) : Pointer to an array with X coordinates
4319 y (const PLFLT *, input) : Pointer to an array with Y coordinates
4322 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4323 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4324 each of the n points.
4327 return _plplotc.plpoin(*args)
4331 Plot a glyph at the specified 3D points
4335 Plot a glyph at the specified 3D points. (This function is largely
4336 superseded by plstring3 which gives access to many[!] more glyphs.)
4337 Set up the call to this function similar to what is done for plline3.
4338 code=-1 means try to just draw a point. Right now it's just a move
4339 and a draw at the same place. Not ideal, since a sufficiently
4340 intelligent output device may optimize it away, or there may be faster
4341 ways of doing it. This is OK for now, though, and offers a 4X speedup
4342 over drawing a Hershey font "point" (which is actually diamond shaped
4343 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4344 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4345 code <= 127 the corresponding printable ASCII character is plotted.
4347 Redacted form: plpoin3(x, y, z, code)
4349 This function is not used in any example.
4355 plpoin3(n, x, y, z, code)
4359 n (PLINT, input) : Number of points in the x and y arrays.
4361 x (const PLFLT *, input) : Pointer to an array with X coordinates
4364 y (const PLFLT *, input) : Pointer to an array with Y coordinates
4367 z (const PLFLT *, input) : Pointer to an array with Z coordinates
4370 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4371 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4372 each of the n points.
4375 return _plplotc.plpoin3(*args)
4379 Draw a polygon in 3 space
4383 Draws a polygon in 3 space defined by n points in x, y, and z. Setup
4384 like plline3, but differs from that function in that plpoly3 attempts
4385 to determine if the polygon is viewable depending on the order of the
4386 points within the arrays and the value of ifcc. If the back of
4387 polygon is facing the viewer, then it isn't drawn. If this isn't what
4388 you want, then use plline3 instead.
4390 The points are assumed to be in a plane, and the directionality of the
4391 plane is determined from the first three points. Additional points do
4392 not have to lie on the plane defined by the first three, but if they
4393 do not, then the determination of visibility obviously can't be 100%
4394 accurate... So if you're 3 space polygons are too far from planar,
4395 consider breaking them into smaller polygons. 3 points define a plane
4398 Bugs: If one of the first two segments is of zero length, or if they
4399 are co-linear, the calculation of visibility has a 50/50 chance of
4400 being correct. Avoid such situations :-). See x18c.c for an example
4401 of this problem. (Search for 20.1).
4403 Redacted form: plpoly3(x, y, z, code)
4405 This function is used in example 18.
4411 plpoly3(n, x, y, z, draw, ifcc)
4415 n (PLINT, input) : Number of points defining line.
4417 x (const PLFLT *, input) : Pointer to array with x coordinates of
4420 y (const PLFLT *, input) : Pointer to array with y coordinates of
4423 z (const PLFLT *, input) : Pointer to array with z coordinates of
4426 draw (const PLBOOL *, input) : Pointer to array which controls
4427 drawing the segments of the polygon. If draw[i] is true, then the
4428 polygon segment from index [i] to [i+1] is drawn, otherwise, not.
4430 ifcc (PLBOOL, input) : If ifcc is true the directionality of the
4431 polygon is determined by assuming the points are laid out in a
4432 counter-clockwise order. Otherwise, the directionality of the
4433 polygon is determined by assuming the points are laid out in a
4437 return _plplotc.plpoly3(*args)
4441 Set precision in numeric labels
4445 Sets the number of places after the decimal point in numeric labels.
4447 Redacted form: plprec(setp, prec)
4449 This function is used in example 29.
4459 setp (PLINT, input) : If setp is equal to 0 then PLplot
4460 automatically determines the number of places to use after the
4461 decimal point in numeric labels (like those used to label axes).
4462 If setp is 1 then prec sets the number of places.
4464 prec (PLINT, input) : The number of characters to draw after the
4465 decimal point in numeric labels.
4468 return _plplotc.plprec(*args)
4472 Select area fill pattern
4476 Select one of eight predefined area fill patterns to use (also see
4477 plpat). Setting the fill style to 0 gives a solid fill.
4479 Redacted form: plpsty(patt)
4481 This function is used in examples 12,13,15,16,25.
4491 patt (PLINT, input) : The desired pattern. Pattern 1 consists of
4492 horizontal lines, pattern 2 consists of vertical lines, pattern 3
4493 consists of lines at 45 degrees angle (upward), and so on.
4496 return _plplotc.plpsty(*args)
4500 Write text inside the viewport
4504 Writes text at a specified position and inclination within the
4505 viewport. Text is clipped at the viewport boundaries. The reference
4506 point of a string lies along a line passing through the string at half
4507 the height of a capital letter. The position of the reference point
4508 along this line is determined by just, the reference point is placed
4509 at world coordinates (
4511 y) within the viewport. The inclination of the string is specified
4512 in terms of differences of world coordinates making it easy to write
4513 text parallel to a line in a graph.
4515 Redacted form: plptex(x, y, dx, dy, just, text)
4517 This function is used in example 2-4,10,12-14,20,23,24,26.
4523 plptex(x, y, dx, dy, just, text)
4527 x (PLFLT, input) : x coordinate of reference point of string.
4529 y (PLFLT, input) : y coordinate of reference point of string.
4531 dx (PLFLT, input) : Together with dy, this specifies the
4532 inclination of the string. The baseline of the string is parallel
4541 dy (PLFLT, input) : Together with dx, this specifies the
4542 inclination of the string.
4544 just (PLFLT, input) : Specifies the position of the string relative
4545 to its reference point. If just=0. , the reference point is at
4546 the left and if just=1. , it is at the right of the string. Other
4547 values of just give intermediate justifications.
4549 text (const char *, input) : The string to be written out.
4552 return _plplotc.plptex(*args)
4556 Write text inside the viewport of a 3D plot
4560 Writes text at a specified position and inclination and with a
4561 specified shear within the viewport. Text is clipped at the viewport
4562 boundaries. The reference point of a string lies along a line passing
4563 through the string at half the height of a capital letter. The
4564 position of the reference point along this line is determined by just,
4565 and the reference point is placed at world coordinates (
4568 wz) within the viewport. The inclination and shear of the string is
4569 specified in terms of differences of world coordinates making it easy
4570 to write text parallel to a line in a graph.
4572 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4574 This function is used in example 28.
4580 plptex3(wx, wy, wz, dx, dy, dz, sx, sy, sz, just, text)
4584 wx (PLFLT, input) : x world coordinate of reference point of
4587 wy (PLFLT, input) : y world coordinate of reference point of
4590 wz (PLFLT, input) : z world coordinate of reference point of
4593 dx (PLFLT, input) : Together with dy and
4594 dz , this specifies the inclination of the string. The baseline of
4595 the string is parallel to a line joining (
4606 dy (PLFLT, input) : Together with dx and
4607 dz, this specifies the inclination of the string.
4609 dz (PLFLT, input) : Together with dx and
4610 dy, this specifies the inclination of the string.
4612 sx (PLFLT, input) : Together with sy and
4613 sz , this specifies the shear of the string. The string is sheared so
4614 that the characters are vertically parallel to a line joining (
4625 sz = 0.) then the text is not sheared.
4627 sy (PLFLT, input) : Together with sx and
4628 sz, this specifies shear of the string.
4630 sz (PLFLT, input) : Together with sx and
4631 sy, this specifies shear of the string.
4633 just (PLFLT, input) : Specifies the position of the string relative
4634 to its reference point. If just=0. , the reference point is at
4635 the left and if just=1. , it is at the right of the string. Other
4636 values of just give intermediate justifications.
4638 text (const char *, input) : The string to be written out.
4641 return _plplotc.plptex3(*args)
4645 Random number generator returning a real random number in the range [0,1]
4649 Random number generator returning a real random number in the range
4650 [0,1]. The generator is based on the Mersenne Twister. Most languages
4651 / compilers provide their own random number generator, and so this is
4652 provided purely for convenience and to give a consistent random number
4653 generator across all languages supported by PLplot. This is
4654 particularly useful for comparing results from the test suite of
4657 Redacted form: plrandd()
4659 This function is used in examples 17,21.
4668 return _plplotc.plrandd()
4672 Replays contents of plot buffer to current device/file
4676 Replays contents of plot buffer to current device/file.
4678 Redacted form: plreplot()
4680 This function is used in example 1,20.
4689 return _plplotc.plreplot()
4693 Convert RGB color to HLS
4697 Convert RGB color coordinates to HLS
4699 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
4700 Perl/PDL: Not available? Implemented as plrgb/plrgb1?
4703 This function is used in example 2.
4709 plrgbhls(r, g, b, p_h, p_l, p_s)
4713 r (PLFLT, input) : Red intensity (0.0-1.0) of the colour
4715 g (PLFLT, input) : Green intensity (0.0-1.0) of the colour
4717 b (PLFLT, input) : Blue intensity (0.0-1.0) of the colour
4719 p_h (PLFLT *, output) : Pointer to hue, in degrees on the colour
4722 p_l (PLFLT *, output) : Pointer to lightness, expressed as a
4723 fraction of the axis of the colour cone (0.0-1.0)
4725 p_s (PLFLT *, output) : Pointer to saturation, expressed as a
4726 fraction of the radius of the colour cone (0.0-1.0)
4729 return _plplotc.plrgbhls(*args)
4737 This sets up the size of all subsequent characters drawn. The actual
4738 height of a character is the product of the default character size and
4741 Redacted form: plschr(def, scale)
4743 This function is used in example 2,13,23,24.
4753 def (PLFLT, input) : The default height of a character in
4754 millimeters, should be set to zero if the default height is to
4757 scale (PLFLT, input) : Scale factor to be applied to default to get
4758 actual character height.
4761 return _plplotc.plschr(*args)
4765 Set cmap0 colors by 8-bit RGB values
4769 Set cmap0 colors using 8-bit RGB values (see the PLplot
4770 documentation). This sets the entire color map -- only as many colors
4771 as specified will be allocated.
4773 Redacted form: plscmap0(r, g, b)
4775 This function is used in examples 2,24.
4781 plscmap0(r, g, b, ncol0)
4785 r (const PLINT *, input) : Pointer to array with set of unsigned
4786 8-bit integers (0-255) representing the degree of red in the
4789 g (const PLINT *, input) : Pointer to array with set of unsigned
4790 8-bit integers (0-255) representing the degree of green in the
4793 b (const PLINT *, input) : Pointer to array with set of unsigned
4794 8-bit integers (0-255) representing the degree of blue in the
4797 ncol0 (PLINT, input) : Number of items in the r, g, and b arrays.
4800 return _plplotc.plscmap0(*args)
4804 Set cmap0 colors by 8-bit RGB values and double alpha transparency value
4808 Set cmap0 colors using 8-bit RGB values (see the PLplot documentation)
4809 and floating point alpha transparency value. This sets the entire
4810 color map -- only as many colors as specified will be allocated.
4812 Redacted form: plscmap0a(r, g, b, alpha)
4814 This function is used in examples 30.
4820 plscmap0a(r, g, b, alpha, ncol0)
4824 r (const PLINT *, input) : Pointer to array with set of unsigned
4825 8-bit integers (0-255) representing the degree of red in the
4828 g (const PLINT *, input) : Pointer to array with set of unsigned
4829 8-bit integers (0-255) representing the degree of green in the
4832 b (const PLINT *, input) : Pointer to array with set of unsigned
4833 8-bit integers (0-255) representing the degree of blue in the
4836 alpha (const PLFLT *, input) : Pointer to array with set of PLFLT
4837 values (0.0 - 1.0) representing the alpha transparency of the
4840 ncol0 (PLINT, input) : Number of items in the r, g, b, and alpha
4844 return _plplotc.plscmap0a(*args)
4848 Set number of colors in cmap0
4852 Set number of colors in color map0 (see the PLplot documentation).
4853 Allocate (or reallocate) color map0, and fill with default values for
4854 those colors not previously allocated. The first 16 default colors are
4855 given in the plcol0 documentation. For larger indices the default
4858 The drivers are not guaranteed to support more than 16 colors.
4860 Redacted form: plscmap0n(ncol0)
4862 This function is used in examples 15,16,24.
4872 ncol0 (PLINT, input) : Number of colors that will be allocated in
4873 the map0 palette. If this number is zero or less, then the value
4874 from the previous call to plscmap0n is used and if there is no
4875 previous call, then a default value is used.
4878 return _plplotc.plscmap0n(*args)
4882 Set cmap1 colors using 8-bit RGB values
4886 Set cmap1 colors using 8-bit RGB values (see the PLplot
4887 documentation). This also sets the number of colors.
4889 Redacted form: plscmap1(r, g, b)
4891 This function is used in example 31.
4897 plscmap1(r, g, b, ncol1)
4901 r (const PLINT *, input) : Pointer to array with set of unsigned
4902 8-bit integers (0-255) representing the degree of red in the
4905 g (const PLINT *, input) : Pointer to array with set of unsigned
4906 8-bit integers (0-255) representing the degree of green in the
4909 b (const PLINT *, input) : Pointer to array with set of unsigned
4910 8-bit integers (0-255) representing the degree of blue in the
4913 ncol1 (PLINT, input) : Number of items in the r, g, and b arrays.
4916 return _plplotc.plscmap1(*args)
4920 Set cmap1 colors using 8-bit RGB values and double alpha transparency values
4924 Set cmap1 colors using 8-bit RGB values (see the PLplot documentation)
4925 and double alpha transparency values. This also sets the number of
4928 Redacted form: plscmap1a(r, g, b, alpha)
4930 This function is used in example 31.
4936 plscmap1a(r, g, b, alpha, ncol1)
4940 r (const PLINT *, input) : Pointer to array with set of unsigned
4941 8-bit integers (0-255) representing the degree of red in the
4944 g (const PLINT *, input) : Pointer to array with set of unsigned
4945 8-bit integers (0-255) representing the degree of green in the
4948 b (const PLINT *, input) : Pointer to array with set of unsigned
4949 8-bit integers (0-255) representing the degree of blue in the
4952 alpha (const PLFLT *, input) : Pointer to array with set of double
4953 values (0.0-1.0) representing the alpha transparency value of the
4956 ncol1 (PLINT, input) : Number of items in the r, g, b, and alpha
4960 return _plplotc.plscmap1a(*args)
4964 Set cmap1 colors using a piece-wise linear relationship
4968 Set cmap1 colors using a piece-wise linear relationship between
4969 intensity index (from 0. to 1.) of cmap1 and position in HLS or RGB
4970 color space (see the PLplot documentation). May be called at any
4973 The idea here is to specify a number of control points that define the
4974 mapping between input cmap1 intensity indices and HLS (or RGB).
4975 Between these points, linear interpolation is used which gives a
4976 smooth variation of color with intensity index. Any number of control
4977 points may be specified, located at arbitrary positions, although
4978 typically 2 - 4 are enough. Another way of stating this is that we are
4979 traversing a given number of lines through HLS (or RGB) space as we
4980 move through cmap1 intensity indices. The control points at the
4981 minimum and maximum position (0 and 1) must always be specified. By
4982 adding more control points you can get more variation. One good
4983 technique for plotting functions that vary about some expected average
4984 is to use an additional 2 control points in the center (position ~=
4985 0.5) that are the same lightness as the background (typically white
4986 for paper output, black for crt), and same hue as the boundary control
4987 points. This allows the highs and lows to be very easily
4990 Each control point must specify the cmap1 intensity index and the
4991 associated three coordinates in HLS or RGB space. The first point
4992 must correspond to position = 0, and the last to position = 1.
4994 The default behaviour is for the hue to be linearly interpolated
4995 between the control points. Since the hue lies in the range [0, 360]
4996 this corresponds to interpolation around the "front" of the color
4997 wheel (red<->green<->blue<->red). If alt_hue_path[i] is true, then an
4998 alternative interpolation is used between control points i and i+1. If
4999 hue[i+1]-hue[i] > 0 then interpolation is between hue[i] and hue[i+1]
5000 - 360, otherwise between hue[i] and hue[i+1] + 360. You can consider
5001 this as interpolation around the "back" or "reverse" of the color
5002 wheel. Specifying alt_hue_path=NULL is equivalent to setting
5003 alt_hue_path[] = false for every control point.
5005 Examples of interpolation Huealt_hue_pathcolor scheme[120
5006 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120
5007 240]truegreen-yellow-red-magenta-blue[240
5008 120]trueblue-magenta-red-yellow-green
5010 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
5011 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
5012 1]magnitudeHLSsaturation[0, 1]magnitude
5014 Redacted form: plscmap1l(itype, intensity, coord1, coord2, coord3,
5017 This function is used in examples 8,11,12,15,20,21.
5023 plscmap1l(itype, npts, intensity, coord1, coord2, coord3, alt_hue_path)
5027 itype (PLBOOL, input) : true: RGB, false: HLS.
5029 npts (PLINT, input) : number of control points
5031 intensity (const PLFLT *, input) : intensity index for each control
5032 point (between 0.0 and 1.0, in ascending order)
5034 coord1 (const PLFLT *, input) : first coordinate (H or R) for each
5037 coord2 (const PLFLT *, input) : second coordinate (L or G) for each
5040 coord3 (const PLFLT *, input) : third coordinate (S or B) for each
5043 alt_hue_path (const PLBOOL *, input) : alternative interpolation
5044 method flag for each control point. (alt_hue_path[i] refers to the
5045 interpolation interval between the i and i + 1 control points).
5048 return _plplotc.plscmap1l(*args)
5052 Set cmap1 colors and alpha transparency using a piece-wise linear relationship
5056 This is a variant of plscmap1l that supports alpha channel
5057 transparency. It sets cmap1 colors using a piece-wise linear
5058 relationship between cmap1 intensity index (from 0. to 1.) and
5059 position in HLS or RGB color space (see the PLplot documentation) with
5060 alpha transparency value (0.0 - 1.0). It may be called at any time.
5062 Redacted form: plscmap1la(itype, intensity, coord1, coord2, coord3,
5063 alpha, alt_hue_path)
5065 This function is used in example 30.
5071 plscmap1la(itype, npts, intensity, coord1, coord2, coord3, alpha, alt_hue_path)
5075 itype (PLBOOL, input) : true: RGB, false: HLS.
5077 npts (PLINT, input) : number of control points
5079 intensity (const PLFLT *, input) : position for each control point
5080 (between 0.0 and 1.0, in ascending order)
5082 coord1 (const PLFLT *, input) : first coordinate (H or R) for each
5085 coord2 (const PLFLT *, input) : second coordinate (L or G) for each
5088 coord3 (const PLFLT *, input) : third coordinate (S or B) for each
5091 alpha (const PLFLT *, input) : the alpha transparency value for
5094 alt_hue_path (const PLBOOL *, input) : alternative interpolation
5095 method flag for each control point. (alt_hue_path[i] refers to the
5096 interpolation interval between the i and i + 1 control points).
5099 return _plplotc.plscmap1la(*args)
5103 Set number of colors in cmap1
5107 Set number of colors in cmap1, (re-)allocate color map1, and set
5108 default values if this is the first allocation (see the PLplot
5111 Redacted form: plscmap1n(ncol1)
5113 This function is used in examples 8,11,20,21.
5123 ncol1 (PLINT, input) : Number of colors that will be allocated in
5124 the map1 palette. If this number is zero or less, then the value
5125 from the previous call to plscmap1n is used and if there is no
5126 previous call, then a default value is used.
5129 return _plplotc.plscmap1n(*args)
5133 Set the cmap1 argument range for continuous color plots
5137 Set the cmap1 argument range for continuous color plots. If
5138 min_color is greater than
5140 max_color is greater than 1.0 or
5141 min_color is less than 0.0 then no change is made. (Use
5142 plgcmap1_range to get the cmap1 argument range.)
5144 Redacted form: plscmap1_range(min_color, max_color)
5146 This function is currently used in example 33.
5152 plscmap1_range(min_color, max_color)
5156 min_color (PLFLT, input) : The minimum cmap1 floating point
5159 max_color (PLFLT, input) : The maximum cmap1 floating point
5163 return _plplotc.plscmap1_range(*args)
5167 Get the cmap1 argument range for continuous color plots
5171 Get the cmap1 argument range for continuous color plots. (Use
5172 plgsmap1_range to set the cmap1 argument range.)
5174 Redacted form: plgcmap1_range(min_color, max_color)
5176 This function is currently not used in any example.
5182 plgcmap1_range(min_color, max_color)
5186 min_color (PLFLT *, output) : Pointer to the current minimum cmap1
5187 floating point argument.
5189 max_color (PLFLT *, output) : Pointer to the current maximum cmap1
5190 floating point argument.
5193 return _plplotc.plgcmap1_range()
5197 Set 8-bit RGB values for given cmap0 color index
5201 Set 8-bit RGB values for given cmap0 (see the PLplot documentation)
5202 index. Overwrites the previous color value for the given index and,
5203 thus, does not result in any additional allocation of space for
5206 Redacted form: plscol0(icol0, r, g, b)
5208 This function is used in any example 31.
5214 lscol0(icol0, r, g, b)
5218 icol0 (PLINT, input) : Color index. Must be less than the maximum
5219 number of colors (which is set by default, by plscmap0n, or even
5222 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5223 degree of red in the color.
5225 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5226 degree of green in the color.
5228 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5229 degree of blue in the color.
5232 return _plplotc.plscol0(*args)
5236 Set 8-bit RGB values and double alpha transparency value for given cmap0 color index
5240 Set 8-bit RGB value and double alpha transparency value for given
5241 cmap0 (see the PLplot documentation) index. Overwrites the previous
5242 color value for the given index and, thus, does not result in any
5243 additional allocation of space for colors.
5245 This function is used in example 30.
5251 lscol0a(icol0, r, g, b, alpha)
5255 icol0 (PLINT, input) : Color index. Must be less than the maximum
5256 number of colors (which is set by default, by plscmap0n, or even
5259 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5260 degree of red in the color.
5262 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5263 degree of green in the color.
5265 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5266 degree of blue in the color.
5268 alpha (PLFLT, input) : double value (0.0-1.0) representing the
5269 alpha transparency value of the color.
5272 return _plplotc.plscol0a(*args)
5276 Set the background color by 8-bit RGB value
5280 Set the background color (color 0 in color map 0) by 8-bit RGB value
5281 (see the PLplot documentation).
5283 Redacted form: plscolbg(r, g, b)
5285 This function is used in examples 15,31.
5295 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5296 degree of red in the color.
5298 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5299 degree of green in the color.
5301 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5302 degree of blue in the color.
5305 return _plplotc.plscolbg(*args)
5309 Set the background color by 8-bit RGB value and double alpha transparency value.
5313 Set the background color (color 0 in color map 0) by 8-bit RGB value
5314 (see the PLplot documentation) and double alpha transparency value.
5316 This function is used in example 31.
5322 plscolbga(r, g, b, alpha)
5326 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5327 degree of red in the color.
5329 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5330 degree of green in the color.
5332 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5333 degree of blue in the color.
5335 alpha (PLFLT, input) : double value (0.0-1.0) representing the
5336 alpha transparency value of the color.
5339 return _plplotc.plscolbga(*args)
5343 Used to globally turn color output on/off
5347 Used to globally turn color output on/off for those drivers/devices
5350 Redacted form: plscolor(color)
5352 This function is used in example 31.
5362 color (PLINT, input) : Color flag (Boolean). If zero, color is
5363 turned off. If non-zero, color is turned on.
5366 return _plplotc.plscolor(*args)
5370 Set device-compression level
5374 Set device-compression level. Only used for drivers that provide
5375 compression. This function, if used, should be invoked before a call
5378 Redacted form: plscompression(compression)
5380 This function is used in example 31.
5386 plscompression(compression)
5390 compression (PLINT, input) : The desired compression level. This is
5391 a device-dependent value. Currently only the jpeg and png devices
5392 use these values. For jpeg value is the jpeg quality which should
5393 normally be in the range 0-95. Higher values denote higher quality
5394 and hence larger image sizes. For png values are in the range -1
5395 to 99. Values of 0-9 are taken as the compression level for zlib.
5396 A value of -1 denotes the default zlib compression level. Values
5397 in the range 10-99 are divided by 10 and then used as the zlib
5398 compression level. Higher compression levels correspond to greater
5399 compression and small file sizes at the expense of more
5403 return _plplotc.plscompression(*args)
5407 Set the device (keyword) name
5411 Set the device (keyword) name.
5413 Redacted form: plsdev(devname)
5415 This function is used in examples 1,14,20.
5425 devname (const char *, input) : Pointer to device (keyword) name
5429 return _plplotc.plsdev(*args)
5433 Set parameters that define current device-space window
5437 Set relative margin width, aspect ratio, and relative justification
5438 that define current device-space window. If you want to just use the
5439 previous value for any of these, just pass in the magic value
5440 PL_NOTSET. It is unlikely that one should ever need to change the
5441 aspect ratio but it's in there for completeness. If plsdidev is not
5442 called the default values of mar, jx, and jy are all 0. aspect is set
5443 to a device-specific value.
5445 Redacted form: plsdidev(mar, aspect, jx, jy)
5447 This function is used in example 31.
5453 plsdidev(mar, aspect, jx, jy)
5457 mar (PLFLT, input) : Relative margin width.
5459 aspect (PLFLT, input) : Aspect ratio.
5461 jx (PLFLT, input) : Relative justification in x. Value must lie in
5462 the range -0.5 to 0.5.
5464 jy (PLFLT, input) : Relative justification in y. Value must lie in
5465 the range -0.5 to 0.5.
5468 return _plplotc.plsdidev(*args)
5472 Set up transformation from metafile coordinates
5476 Set up transformation from metafile coordinates. The size of the plot
5477 is scaled so as to preserve aspect ratio. This isn't intended to be a
5478 general-purpose facility just yet (not sure why the user would need
5481 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
5484 This function is not used in any examples.
5490 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5494 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
5496 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
5498 dimymin (PLINT, input) : NEEDS DOCUMENTATION
5500 dimymax (PLINT, input) : NEEDS DOCUMENTATION
5502 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
5504 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
5507 return _plplotc.plsdimap(*args)
5511 Set plot orientation
5515 Set plot orientation parameter which is multiplied by 90 degrees to
5516 obtain the angle of rotation. Note, arbitrary rotation parameters
5517 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
5518 values for the rotation parameter are 0., 1., 2., and 3. corresponding
5519 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
5520 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is
5521 not called the default value of rot is 0.
5523 N.B. aspect ratio is unaffected by calls to plsdiori. So you will
5524 probably want to change the aspect ratio to a value suitable for the
5525 plot orientation using a call to plsdidev or the command-line options
5526 -a or -freeaspect. For more documentation of those options see the
5527 PLplot documentation. Such command-line options can be set internally
5528 using plsetopt or set directly using the command line and parsed using
5529 a call to plparseopts.
5531 Redacted form: plsdiori(rot)
5533 This function is not used in any examples.
5543 rot (PLFLT, input) : Plot orientation parameter.
5546 return _plplotc.plsdiori(*args)
5550 Set parameters that define current plot-space window
5554 Set relative minima and maxima that define the current plot-space
5555 window. If plsdiplt is not called the default values of xmin, ymin,
5556 xmax, and ymax are 0., 0., 1., and 1.
5558 Redacted form: plsdiplt(xmin, ymin, xmax, ymax)
5560 This function is used in example 31.
5566 plsdiplt(xmin, ymin, xmax, ymax)
5570 xmin (PLFLT, input) : Relative minimum in x.
5572 ymin (PLFLT, input) : Relative minimum in y.
5574 xmax (PLFLT, input) : Relative maximum in x.
5576 ymax (PLFLT, input) : Relative maximum in y.
5579 return _plplotc.plsdiplt(*args)
5583 Set parameters incrementally (zoom mode) that define current plot-space window
5587 Set relative minima and maxima incrementally (zoom mode) that define
5588 the current plot-space window. This function has the same effect as
5589 plsdiplt if that function has not been previously called. Otherwise,
5590 this function implements zoom mode using the transformation min_used =
5591 old_min + old_length*min and max_used = old_min + old_length*max for
5592 each axis. For example, if min = 0.05 and max = 0.95 for each axis,
5593 repeated calls to plsdiplz will zoom in by 10 per cent for each call.
5595 Redacted form: plsdiplz(xmin, ymin, xmax, ymax)
5597 This function is used in example 31.
5603 plsdiplz(xmin, ymin, xmax, ymax)
5607 xmin (PLFLT, input) : Relative (incremental) minimum in x.
5609 ymin (PLFLT, input) : Relative (incremental) minimum in y.
5611 xmax (PLFLT, input) : Relative (incremental) maximum in x.
5613 ymax (PLFLT, input) : Relative (incremental) maximum in y.
5616 return _plplotc.plsdiplz(*args)
5620 Set seed for internal random number generator.
5624 Set the seed for the internal random number generator. See plrandd for
5627 Redacted form: plseed(seed)
5629 This function is used in example 21.
5639 seed (unsigned int, input) : Seed for random number generator.
5642 return _plplotc.plseed(*args)
5646 Set the escape character for text strings
5650 Set the escape character for text strings. From C (in contrast to
5651 Fortran 95, see plsescfortran95) you pass esc as a character. Only
5652 selected characters are allowed to prevent the user from shooting
5653 himself in the foot (For example, a \ isn't allowed since it conflicts
5654 with C's use of backslash as a character escape). Here are the
5655 allowed escape characters and their corresponding decimal ASCII
5667 Redacted form: General: plsesc(esc)
5668 Perl/PDL: Not available?
5671 This function is used in example 29.
5681 esc (char, input) : Escape character.
5684 return _plplotc.plsesc(*args)
5688 Set any command-line option
5692 Set any command-line option internally from a program before it
5693 invokes plinit. opt is the name of the command-line option and optarg
5694 is the corresponding command-line option argument.
5696 This function returns 0 on success.
5698 Redacted form: plsetopt(opt, optarg)
5700 This function is used in example 14.
5706 int plsetopt(opt, optarg)
5710 opt (const char *, input) : Pointer to string containing the
5711 command-line option.
5713 optarg (const char *, input) : Pointer to string containing the
5714 argument of the command-line option.
5717 return _plplotc.plsetopt(*args)
5721 Set family file parameters
5725 Sets variables dealing with output file familying. Does nothing if
5726 familying not supported by the driver. This routine, if used, must be
5727 called before initializing PLplot. See the PLplot documentation for
5730 Redacted form: plsfam(fam, num, bmax)
5732 This function is used in examples 14,31.
5738 plsfam(fam, num, bmax)
5742 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
5745 num (PLINT, input) : Current family file number.
5747 bmax (PLINT, input) : Maximum file size (in bytes) for a family
5751 return _plplotc.plsfam(*args)
5755 Set FCI (font characterization integer)
5759 Sets font characteristics to be used at the start of the next string
5760 using the FCI approach. See the PLplot documentation for more
5763 Redacted form: General: plsfci(fci)
5764 Perl/PDL: Not available?
5767 This function is used in example 23.
5777 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
5781 return _plplotc.plsfci(*args)
5785 Set output file name
5789 Sets the current output file name, if applicable. If the file name
5790 has not been specified and is required by the driver, the user will be
5791 prompted for it. If using the X-windows output driver, this sets the
5792 display name. This routine, if used, must be called before
5793 initializing PLplot.
5795 Redacted form: plsfnam(fnam)
5797 This function is used in examples 1,20.
5807 fnam (const char *, input) : Pointer to file name string.
5810 return _plplotc.plsfnam(*args)
5814 Set family, style and weight of the current font
5818 Sets the current font. See the PLplot documentation for more
5819 information on font selection.
5821 Redacted form: plsfont(family, style, weight)
5823 This function is used in example 23.
5829 plsfont(family, style, weight)
5833 family (PLINT, input) : Font family to select for the current font.
5834 The available values are given by the PL_FCI_* constants in
5835 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
5836 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value
5837 signifies that the font family should not be altered.
5839 style (PLINT, input) : Font style to select for the current font.
5840 The available values are given by the PL_FCI_* constants in
5841 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and
5842 PL_FCI_OBLIQUE. A negative value signifies that the font style
5843 should not be altered.
5845 weight (PLINT, input) : Font weight to select for the current font.
5846 The available values are given by the PL_FCI_* constants in
5847 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A
5848 negative value signifies that the font weight should not be
5852 return _plplotc.plsfont(*args)
5856 Shade regions on the basis of value
5860 Shade regions on the basis of value. This is the high-level routine
5861 for making continuous color shaded plots with cmap1 while plshade (or
5862 plshade1) are used for individual shaded regions using either cmap0 or
5863 cmap1. examples/c/x16c.c shows a number of examples for using this
5864 function. See the following discussion of the arguments and the PLplot
5865 documentation for more information.
5867 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
5868 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
5870 Perl/PDL: plshades(a, xmin, xmax, ymin, ymax, clevel,
5871 fill_width, cont_color, cont_width, fill, rectangular, defined, pltr,
5875 This function is used in examples 16,21.
5881 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
5885 a (const PLFLT * const *, input) : Contains ** pointer to array to
5886 be plotted. The array must have been declared as PLFLT a[nx][ny].
5888 nx (PLINT, input) : First dimension of array "a".
5890 ny (PLINT, input) : Second dimension of array "a".
5892 defined (PLINT (*) (PLFLT, PLFLT), input) : User function
5893 specifying regions excluded from the shading plot. This function
5894 accepts x and y coordinates as input arguments and must return 0
5895 if the point is in the excluded region or 1 otherwise. This
5896 argument can be NULL if all the values are valid.
5898 xmin (PLFLT, input) : Defines the "grid" coordinates. The data
5899 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5900 at (xmax,ymin) and so on.
5902 xmax (PLFLT, input) : Defines the "grid" coordinates. The data
5903 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5904 at (xmax,ymin) and so on.
5906 ymin (PLFLT, input) : Defines the "grid" coordinates. The data
5907 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5908 at (xmax,ymin) and so on.
5910 ymax (PLFLT, input) : Defines the "grid" coordinates. The data
5911 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
5912 at (xmax,ymin) and so on.
5914 clevel (const PLFLT *, input) : Pointer to array containing the
5915 data levels corresponding to the edges of each shaded region that
5916 will be plotted by this function. To work properly the levels
5917 should be monotonic.
5919 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
5920 of shade edge values in clevel).
5922 fill_width (PLFLT, input) : Defines line width used by the fill
5925 cont_color (PLINT, input) : Defines pen color used for contours
5926 defining edges of shaded regions. The pen color is only temporary
5927 set for the contour drawing. Set this value to zero or less if no
5928 shade edge contours are wanted.
5930 cont_width (PLFLT, input) : Defines line width used for contours
5931 defining edges of shaded regions. This value may not be honored
5932 by all drivers. The pen width is only temporary set for the
5933 contour drawing. Set this value to zero or less if no shade edge
5934 contours are wanted.
5936 fill (void (*) (PLINT, const PLFLT *, const PLFLT *), input) :
5937 Routine used to fill the region. Use plfill. Future version of
5938 PLplot may have other fill routines.
5940 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
5941 map to rectangles after coordinate transformation with pltrl.
5942 Otherwise, set rectangular to false. If rectangular is set to
5943 true, plshade tries to save time by filling large rectangles.
5944 This optimization fails if the coordinate transformation distorts
5945 the shape of rectangles. For example a plot in polar coordinates
5946 has to have rectangular set to false.
5948 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
5949 Pointer to function that defines transformation between indices
5950 in array z and the world coordinates (C only). Transformation
5951 functions are provided in the PLplot library: pltr0 for identity
5952 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
5953 defined by one- and two-dimensional arrays. In addition,
5954 user-supplied routines for the transformation can be used as well.
5955 Examples of all of these approaches are given in the PLplot
5956 documentation. The transformation function should have the form
5957 given by any of pltr0, pltr1, or pltr2.
5959 pltr_data (PLPointer, input) : Extra parameter to help pass
5960 information to pltr0, pltr1, pltr2, or whatever routine that is
5961 externally supplied.
5964 return _plplotc.plshades(*args)
5968 Shade individual region on the basis of value
5972 Shade individual region on the basis of value. Use plshades if you
5973 want to shade a number of regions using continuous colors. plshade is
5974 identical to plshade1 except for the type of the first parameter. See
5975 plshade1 for further discussion.
5977 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax,
5978 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
5979 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
5980 Perl/PDL: Not available?
5983 This function is used in example 15.
5989 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)
5993 a (const PLFLT * const *, input) :
5999 defined (PLINT (*) (PLFLT, PLFLT), input) :
6001 xmin (PLFLT, input) :
6003 xmax (PLFLT, input) :
6005 ymin (PLFLT, input) :
6007 ymax (PLFLT, input) :
6009 shade_min (PLFLT, input) :
6011 shade_max (PLFLT, input) :
6013 sh_cmap (PLINT, input) :
6015 sh_color (PLFLT, input) :
6017 sh_width (PLFLT, input) :
6019 min_color (PLINT, input) :
6021 min_width (PLFLT, input) :
6023 max_color (PLINT, input) :
6025 max_width (PLFLT, input) :
6027 fill (void (*) (PLINT, const PLFLT *, const PLFLT *), input) :
6029 rectangular (PLBOOL, input) :
6031 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
6033 pltr_data (PLPointer, input) :
6036 return _plplotc.plshade(*args)
6040 Assign a function to use for generating custom axis labels
6044 This function allows a user to provide their own function to provide
6045 axis label text. The user function is given the numeric value for a
6046 point on an axis and returns a string label to correspond with that
6047 value. Custom axis labels can be enabled by passing appropriate
6048 arguments to plenv, plbox, plbox3 and similar functions.
6050 This function is used in example 19.
6056 plslabelfunc(label_func, label_data)
6060 label_func (void (*) (PLINT, PLFLT, char *, PLINT, PLPointer), input)
6061 : This is the custom label function. In order to reset to the
6062 default labelling, set this to NULL. The labelling function
6063 parameters are, in order: axis: This indicates which axis a
6064 label is being requested for. The value will be one of PL_X_AXIS,
6065 PL_Y_AXIS or PL_Z_AXIS.
6067 value: This is the value along the axis which is being labelled.
6069 label_text: The string representation of the label value.
6071 length: The maximum length in characters allowed for label_text.
6074 label_data (PLPointer, input) : This parameter may be used to pass
6075 data to the label_func function.
6078 return _plplotc.plslabelfunc(*args)
6082 Set length of major ticks
6086 This sets up the length of the major ticks. The actual length is the
6087 product of the default length and a scaling factor as for character
6090 Redacted form: plsmaj(def, scale)
6092 This function is used in example 29.
6102 def (PLFLT, input) : The default length of a major tick in
6103 millimeters, should be set to zero if the default length is to
6106 scale (PLFLT, input) : Scale factor to be applied to default to get
6110 return _plplotc.plsmaj(*args)
6114 Set the memory area to be plotted (RGB)
6118 Set the memory area to be plotted (with the mem or memcairo driver) as
6119 the dev member of the stream structure. Also set the number of pixels
6120 in the memory passed in
6121 plotmem, which is a block of memory
6123 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
6125 This memory will have to be freed by the user!
6127 Redacted form: plsmem(maxx, maxy, plotmem)
6129 This function is not used in any examples.
6135 plsmem(maxx, maxy, plotmem)
6139 maxx (PLINT, input) : Size of memory area in the X coordinate.
6141 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6143 plotmem (void *, input) : Pointer to the beginning of the
6144 user-supplied memory area.
6147 return _plplotc.plsmem(*args)
6151 Set the memory area to be plotted (RGBA)
6155 Set the memory area to be plotted (with the memcairo driver) as the
6156 dev member of the stream structure. Also set the number of pixels in
6157 the memory passed in
6158 plotmem, which is a block of memory
6160 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
6162 This memory will have to be freed by the user!
6164 Redacted form: plsmema(maxx, maxy, plotmem)
6166 This function is not used in any examples.
6172 plsmema(maxx, maxy, plotmem)
6176 maxx (PLINT, input) : Size of memory area in the X coordinate.
6178 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6180 plotmem (void *, input) : Pointer to the beginning of the
6181 user-supplied memory area.
6184 return _plplotc.plsmema(*args)
6188 Set length of minor ticks
6192 This sets up the length of the minor ticks and the length of the
6193 terminals on error bars. The actual length is the product of the
6194 default length and a scaling factor as for character height.
6196 Redacted form: plsmin(def, scale)
6198 This function is used in example 29.
6208 def (PLFLT, input) : The default length of a minor tick in
6209 millimeters, should be set to zero if the default length is to
6212 scale (PLFLT, input) : Scale factor to be applied to default to get
6216 return _plplotc.plsmin(*args)
6224 Set integer plot orientation parameter. This function is identical to
6225 plsdiori except for the type of the argument, and should be used in
6226 the same way. See the PLplot documentation for details.
6228 Redacted form: plsori(ori)
6230 This function is used in example 3.
6240 ori (PLINT, input) : Orientation value (0 for landscape, 1 for
6241 portrait, etc.) The value is multiplied by 90 degrees to get the
6245 return _plplotc.plsori(*args)
6253 Sets the page configuration (optional). If an individual parameter is
6254 zero then that parameter value is not updated. Not all parameters are
6255 recognized by all drivers and the interpretation is device-dependent.
6256 The X-window driver uses the length and offset parameters to determine
6257 the window size and location. The length and offset values are
6258 expressed in units that are specific to the current driver. For
6259 instance: screen drivers will usually interpret them as number of
6260 pixels, whereas printer drivers will usually use mm. This routine, if
6261 used, must be called before initializing PLplot.
6263 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff)
6265 This function is used in examples 14 and 31.
6271 plspage(xp, yp, xleng, yleng, xoff, yoff)
6275 xp (PLFLT, input) : Number of pixels/inch (DPI), x.
6277 yp (PLFLT, input) : Number of pixels/inch (DPI), y.
6279 xleng (PLINT , input) : Page length, x.
6281 yleng (PLINT, input) : Page length, y.
6283 xoff (PLINT, input) : Page offset, x.
6285 yoff (PLINT, input) : Page offset, y.
6288 return _plplotc.plspage(*args)
6292 Set the colors for color table 0 from a cmap0 file
6296 Set the colors for color table 0 from a cmap0 file
6298 Redacted form: plspal0(filename)
6300 This function is in example 16.
6310 filename (const char *, input) : The name of the cmap0 file, or a
6311 empty to string to specify the default cmap0 file.
6314 return _plplotc.plspal0(*args)
6318 Set the palette for cmap1 using the specified cmap1*.pal format file
6322 Set the palette for cmap1 using the specified cmap1*.pal format file.
6324 Redacted form: plspal1(filename, interpolate)
6326 This function is used in example 16.
6332 plspal1(filename, interpolate)
6336 filename (const char *, input) : The name of the cmap1*.pal file,
6337 or an empty string to specify the default cmap1.pal file.
6339 interpolate (PLBOOL, input) : If this parameter is true, the
6340 columns containing the intensity index, r, g, b, alpha and
6341 alt_hue_path in the cmap1*.pal file are used to set the cmap1
6342 palette with a call to plscmap1la. (The cmap1*.pal header contains
6343 a flag which controls whether the r, g, b data sent to plscmap1la
6344 are interpreted as HLS or RGB.) If this parameter is false, the
6345 intensity index and alt_hue_path columns are ignored and the r, g,
6346 b (interpreted as RGB), and alpha columns of the cmap1*.pal file
6347 are used instead to set the cmap1 palette directly with a call to
6351 return _plplotc.plspal1(*args)
6355 Set the pause (on end-of-page) status
6359 Set the pause (on end-of-page) status.
6361 Redacted form: plspause(pause)
6363 This function is in examples 14,20.
6373 pause (PLBOOL, input) : If pause is true there will be a pause on
6374 end-of-page for those drivers which support this. Otherwise there
6378 return _plplotc.plspause(*args)
6382 Set current output stream
6386 Sets the number of the current output stream. The stream number
6387 defaults to 0 unless changed by this routine. The first use of this
6388 routine must be followed by a call initializing PLplot (e.g. plstar).
6390 Redacted form: plsstrm(strm)
6392 This function is examples 1,14,20.
6402 strm (PLINT, input) : The current stream number.
6405 return _plplotc.plsstrm(*args)
6409 Set the number of subpages in x and y
6413 Set the number of subpages in x and y.
6415 Redacted form: plssub(nx, ny)
6417 This function is examples 1,2,14,21,25,27.
6427 nx (PLINT, input) : Number of windows in x direction (i.e., number
6430 ny (PLINT, input) : Number of windows in y direction (i.e., number
6434 return _plplotc.plssub(*args)
6442 This sets up the size of all subsequent symbols drawn by plpoin and
6443 plsym. The actual height of a symbol is the product of the default
6444 symbol size and a scaling factor as for the character height.
6446 Redacted form: plssym(def, scale)
6448 This function is used in example 29.
6458 def (PLFLT, input) : The default height of a symbol in millimeters,
6459 should be set to zero if the default height is to remain
6462 scale (PLFLT, input) : Scale factor to be applied to default to get
6463 actual symbol height.
6466 return _plplotc.plssym(*args)
6474 Initializing the plotting package. The program prompts for the device
6475 keyword or number of the desired output device. Hitting a RETURN in
6476 response to the prompt is the same as selecting the first device. If
6477 only one device is enabled when PLplot is installed, plstar will issue
6478 no prompt. The output device is divided into nx by ny subpages, each
6479 of which may be used independently. The subroutine pladv is used to
6480 advance from one subpage to the next.
6482 Redacted form: plstar(nx, ny)
6484 This function is used in example 1.
6494 nx (PLINT, input) : Number of subpages to divide output page in the
6495 horizontal direction.
6497 ny (PLINT, input) : Number of subpages to divide output page in the
6501 return _plplotc.plstar(*args)
6509 Alternative to plstar for initializing the plotting package. The
6510 device name keyword for the desired output device must be supplied as
6511 an argument. These keywords are the same as those printed out by
6512 plstar. If the requested device is not available, or if the input
6513 string is empty or begins with ``?'', the prompted start up of plstar
6514 is used. This routine also divides the output device page into nx by
6515 ny subpages, each of which may be used independently. The subroutine
6516 pladv is used to advance from one subpage to the next.
6518 Redacted form: General: plstart(devname, nx, ny)
6519 Perl/PDL: plstart(nx, ny, devname)
6522 This function is not used in any examples.
6528 plstart(devname, nx, ny)
6532 devname (const char *, input) : Device name keyword of the required
6533 output device. If NULL or if the first character is a ``?'', the
6534 normal (prompted) start up is used.
6536 nx (PLINT, input) : Number of subpages to divide output page in the
6537 horizontal direction.
6539 ny (PLINT, input) : Number of subpages to divide output page in the
6543 return _plplotc.plstart(*args)
6547 Set a global coordinate transform function
6551 This function can be used to define a coordinate transformation which
6552 affects all elements drawn within the current plot window. The
6553 coordinate_transform function is similar to that provided for the
6554 plmap and plmeridians functions. The coordinate_transform_data
6555 parameter may be used to pass extra data to coordinate_transform.
6557 Redacted form: General: plstransform(coordinate_transform,
6558 coordinate_transform_data)
6561 This function is used in examples 19 and 22.
6567 plstransform(coordinate_transform, coordinate_transform_data)
6571 coordinate_transform (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *,
6572 PLPointer) , input) : Pointer to a function that defines a
6573 transformation from the input (x, y) coordinate to a new plot
6574 world coordinate. A NULL pointer means that no transform is
6577 coordinate_transform_data (PLPointer, input) : Optional extra data
6579 coordinate_transform.
6582 return _plplotc.plstransform(*args)
6586 Plot a glyph at the specified points
6590 Plot a glyph at the specified points. (Supersedes plpoin and plsym
6591 because many[!] more glyphs are accessible with plstring.) The glyph
6592 is specified with a PLplot user string. Note that the user string is
6593 not actually limited to one glyph so it is possible (but not normally
6594 useful) to plot more than one glyph at the specified points with this
6595 function. As with plmtex and plptex, the user string can contain FCI
6596 escapes to determine the font, UTF-8 code to determine the glyph or
6597 else PLplot escapes for Hershey or unicode text to determine the
6600 Redacted form: plstring(x, y, string)
6602 This function is used in examples 4, 21 and 26.
6608 plstring(n, x, y, string)
6612 n (PLINT, input) : Number of points in the x and y arrays.
6614 x (const PLFLT *, input) : Pointer to an array with X coordinates
6617 y (const PLFLT *, input) : Pointer to an array with Y coordinates
6620 string (const char *, input) : PLplot user string corresponding to
6621 the glyph to be plotted at each of the n points.
6624 return _plplotc.plstring(*args)
6628 Plot a glyph at the specified 3D points
6632 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because
6633 many[!] more glyphs are accessible with plstring3.) Set up the call to
6634 this function similar to what is done for plline3. The glyph is
6635 specified with a PLplot user string. Note that the user string is not
6636 actually limited to one glyph so it is possible (but not normally
6637 useful) to plot more than one glyph at the specified points with this
6638 function. As with plmtex and plptex, the user string can contain FCI
6639 escapes to determine the font, UTF-8 code to determine the glyph or
6640 else PLplot escapes for Hershey or unicode text to determine the
6643 Redacted form: plstring3(x, y, z, string)
6645 This function is used in example 18.
6651 plstring3(n, x, y, z, string)
6655 n (PLINT, input) : Number of points in the x, y, and z arrays.
6657 x (const PLFLT *, input) : Pointer to an array with X coordinates
6660 y (const PLFLT *, input) : Pointer to an array with Y coordinates
6663 z (const PLFLT *, input) : Pointer to an array with Z coordinates
6666 string (const char *, input) : PLplot user string corresponding to
6667 the glyph to be plotted at each of the n points.
6670 return _plplotc.plstring3(*args)
6674 Add a point to a strip chart
6678 Add a point to a given pen of a given strip chart. There is no need
6679 for all pens to have the same number of points or to be equally
6680 sampled in the x coordinate. Allocates memory and rescales as
6683 Redacted form: plstripa(id, pen, x, y)
6685 This function is used in example 17.
6691 plstripa(id, pen, x, y)
6695 id (PLINT, input) : Identification number of the strip chart (set
6698 pen (PLINT, input) : Pen number (ranges from 0 to 3).
6700 x (PLFLT, input) : X coordinate of point to plot.
6702 y (PLFLT, input) : Y coordinate of point to plot.
6705 return _plplotc.plstripa(*args)
6709 Create a 4-pen strip chart
6713 Create a 4-pen strip chart, to be used afterwards by plstripa
6715 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
6716 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
6717 styline, legline, labx, laby, labz)
6718 Perl/PDL: plstripc(xmin, xmax, xjump, ymin, ymax, xlpos,
6719 ylpos, y_ascl, acc, colbox, collab, colline, styline, id, xspec,
6720 ypsec, legline, labx, laby, labtop)
6723 This function is used in example 17.
6729 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
6733 id (PLINT *, output) : Identification number of strip chart to use
6734 on plstripa and plstripd.
6736 xspec (const char *, input) : X-axis specification as in plbox.
6738 yspec (const char *, input) : Y-axis specification as in plbox.
6740 xmin (PLFLT, input) : Initial coordinates of plot box; they will
6741 change as data are added.
6743 xmax (PLFLT, input) : Initial coordinates of plot box; they will
6744 change as data are added.
6746 xjump (PLFLT, input) : When x attains xmax, the length of the plot
6747 is multiplied by the factor (1 +
6750 ymin (PLFLT, input) : Initial coordinates of plot box; they will
6751 change as data are added.
6753 ymax (PLFLT, input) : Initial coordinates of plot box; they will
6754 change as data are added.
6756 xlpos (PLFLT, input) : X legend box position (range from 0 to 1).
6758 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1).
6760 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is
6761 true, otherwise not.
6763 acc (PLBOOL, input) : Accumulate strip plot if acc is true,
6764 otherwise slide display.
6766 colbox (PLINT, input) : Plot box color index (cmap0).
6768 collab (PLINT, input) : Legend color index (cmap0).
6770 colline (const PLINT *, input) : Pointer to array with color
6771 indices (cmap0) for the 4 pens.
6773 styline (const PLINT *, input) : Pointer to array with line styles
6776 legline (const char **, input) : Pointer to character array
6777 containing legends for the 4 pens.
6779 labx (const char *, input) : X-axis label.
6781 laby (const char *, input) : Y-axis label.
6783 labtop (const char *, input) : Plot title.
6786 return _plplotc.plstripc(*args)
6790 Deletes and releases memory used by a strip chart
6794 Deletes and releases memory used by a strip chart.
6796 Redacted form: plstripd(id)
6798 This function is used in example 17.
6808 id (PLINT, input) : Identification number of strip chart to delete.
6811 return _plplotc.plstripd(*args)
6819 This sets up the line style for all lines subsequently drawn. A line
6820 consists of segments in which the pen is alternately down and up. The
6821 lengths of these segments are passed in the arrays mark and space
6822 respectively. The number of mark-space pairs is specified by nms. In
6823 order to return the line style to the default continuous line, plstyl
6824 should be called with nms=0 .(see also pllsty)
6826 Redacted form: plstyl(mark, space)
6828 This function is used in examples 1,9,14.
6834 plstyl(nms, mark, space)
6838 nms (PLINT, input) : The number of mark and space elements in a
6839 line. Thus a simple broken line can be obtained by setting nms=1
6840 . A continuous line is specified by setting nms=0 .
6842 mark (const PLINT *, input) : Pointer to array with the lengths of
6843 the segments during which the pen is down, measured in
6846 space (const PLINT *, input) : Pointer to array with the lengths of
6847 the segments during which the pen is up, measured in micrometers.
6850 return _plplotc.plstyl(*args)
6854 Set arrow style for vector plots
6858 Set the style for the arrow used by plvect to plot vectors.
6860 Redacted form: plsvect(arrowx, arrowy, fill)
6862 This function is used in example 22.
6868 plsvect(arrowx, arrowy, npts, fill)
6872 arrowx, arrowy (const PLFLT *,input) : Pointers to a pair of arrays
6873 containing the x and y points which make up the arrow. The arrow
6874 is plotted by joining these points to form a polygon. The scaling
6875 assumes that the x and y points in the arrow lie in the range -0.5
6876 <= x,y <= 0.5. If both arrowx and arrowy are NULL then the arrow
6877 style will be reset to its default.
6879 npts (PLINT,input) : Number of points in the arrays arrowx and
6882 fill (PLBOOL,input) : If fill is true then the arrow is closed, if
6883 fill is false then the arrow is open.
6886 return _plplotc.plsvect(*args)
6890 Specify viewport in absolute coordinates
6894 Alternate routine to plvpor for setting up the viewport. This routine
6895 should be used only if the viewport is required to have a definite
6896 size in millimeters. The routine plgspa is useful for finding out the
6897 size of the current subpage.
6899 Redacted form: plsvpa(xmin, xmax, ymin, ymax)
6901 This function is used in example 10.
6907 plsvpa(xmin, xmax, ymin, ymax)
6911 xmin (PLFLT, input) : The distance of the left-hand edge of the
6912 viewport from the left-hand edge of the subpage in millimeters.
6914 xmax (PLFLT, input) : The distance of the right-hand edge of the
6915 viewport from the left-hand edge of the subpage in millimeters.
6917 ymin (PLFLT, input) : The distance of the bottom edge of the
6918 viewport from the bottom edge of the subpage in millimeters.
6920 ymax (PLFLT, input) : The distance of the top edge of the viewport
6921 from the bottom edge of the subpage in millimeters.
6924 return _plplotc.plsvpa(*args)
6928 Set x axis parameters
6932 Sets values of the digmax and digits flags for the x axis. See the
6933 PLplot documentation for more information.
6935 Redacted form: plsxax(digmax, digits)
6937 This function is used in example 31.
6943 plsxax(digmax, digits)
6947 digmax (PLINT, input) : Variable to set the maximum number of
6948 digits for the x axis. If nonzero, the printed label will be
6949 switched to a floating point representation when the number of
6950 digits exceeds digmax.
6952 digits (PLINT, input) : Field digits value. Currently, changing
6953 its value here has no effect since it is set only by plbox or
6954 plbox3. However, the user may obtain its value after a call to
6955 either of these functions by calling plgxax.
6958 return _plplotc.plsxax(*args)
6962 Set y axis parameters
6966 Identical to plsxax, except that arguments are flags for y axis. See
6967 the description of plsxax for more detail.
6969 Redacted form: plsyax(digmax, digits)
6971 This function is used in examples 1,14,31.
6977 plsyax(digmax, digits)
6981 digmax (PLINT, input) : Variable to set the maximum number of
6982 digits for the y axis. If nonzero, the printed label will be
6983 switched to a floating point representation when the number of
6984 digits exceeds digmax.
6986 digits (PLINT, input) : Field digits value. Currently, changing
6987 its value here has no effect since it is set only by plbox or
6988 plbox3. However, the user may obtain its value after a call to
6989 either of these functions by calling plgyax.
6992 return _plplotc.plsyax(*args)
6996 Plot a glyph at the specified points
7000 Plot a glyph at the specified points. (This function is largely
7001 superseded by plstring which gives access to many[!] more glyphs.)
7003 Redacted form: plsym(x, y, code)
7005 This function is used in example 7.
7011 plsym(n, x, y, code)
7015 n (PLINT, input) : Number of points in the x and y arrays.
7017 x (const PLFLT *, input) : Pointer to an array with X coordinates
7020 y (const PLFLT *, input) : Pointer to an array with Y coordinates
7023 code (PLINT, input) : Hershey symbol code corresponding to a glyph
7024 to be plotted at each of the n points.
7027 return _plplotc.plsym(*args)
7031 Set z axis parameters
7035 Identical to plsxax, except that arguments are flags for z axis. See
7036 the description of plsxax for more detail.
7038 Redacted form: plszax(digmax, digits)
7040 This function is used in example 31.
7046 plszax(digmax, digits)
7050 digmax (PLINT, input) : Variable to set the maximum number of
7051 digits for the z axis. If nonzero, the printed label will be
7052 switched to a floating point representation when the number of
7053 digits exceeds digmax.
7055 digits (PLINT, input) : Field digits value. Currently, changing
7056 its value here has no effect since it is set only by plbox or
7057 plbox3. However, the user may obtain its value after a call to
7058 either of these functions by calling plgzax.
7061 return _plplotc.plszax(*args)
7065 Switch to text screen
7069 Sets an interactive device to text mode, used in conjunction with
7070 plgra to allow graphics and text to be interspersed. On a device
7071 which supports separate text and graphics windows, this command causes
7072 control to be switched to the text window. This can be useful for
7073 printing diagnostic messages or getting user input, which would
7074 otherwise interfere with the plots. The program must switch back to
7075 the graphics window before issuing plot commands, as the text (or
7076 console) device will probably become quite confused otherwise. If
7077 already in text mode, this command is ignored. It is also ignored on
7078 devices which only support a single window or use a different method
7079 for shifting focus (see also plgra).
7081 Redacted form: pltext()
7083 This function is used in example 1.
7092 return _plplotc.pltext()
7096 Set format for date / time labels
7100 Sets the format for date / time labels. To enable date / time format
7101 labels see the options to plbox and plenv.
7103 Redacted form: pltimefmt(fmt)
7105 This function is used in example 29.
7115 fmt (const char *, fmt) : This string is passed directly to the
7116 system strftime. See the system documentation for a full list of
7117 conversion specifications for your system. All conversion
7118 specifications take the form of a '%' character followed by
7119 further conversion specification character. All other text is
7120 printed as-is. Common options include: %c: The preferred date and
7121 time representation for the current locale.
7122 %d: The day of the month as a decimal number.
7123 %H: The hour as a decimal number using a 24-hour clock.
7124 %j: The day of the year as a decimal number.
7125 %m: The month as a decimal number.
7126 %M: The minute as a decimal number.
7127 %S: The second as a decimal number.
7128 %y: The year as a decimal number without a century.
7129 %Y: The year as a decimal number including a century.
7132 return _plplotc.pltimefmt(*args)
7136 Specify viewport using aspect ratio only
7140 Sets the viewport so that the ratio of the length of the y axis to
7141 that of the x axis is equal to aspect.
7143 Redacted form: plvasp(aspect)
7145 This function is used in example 13.
7155 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7159 return _plplotc.plvasp(*args)
7167 Draws a vector plot of the vector (
7173 ny]) . The scaling factor for the vectors is given by scale. A
7174 transformation routine pointed to by pltr with a pointer pltr_data for
7175 additional data required by the transformation routine is used to map
7176 indices within the array to the world coordinates. The style of the
7177 vector arrow may be set using plsvect.
7179 Redacted form: plvect(u, v, scale, pltr, pltr_data)
7181 This function is used in example 22.
7187 plvect(u, v, nx, ny, scale, pltr, pltr_data)
7191 u, v (const PLFLT * const *, input) : Pointers to a pair of
7192 vectored two-dimensional arrays containing the x and y components
7193 of the vector data to be plotted.
7195 nx, ny (PLINT, input) : Physical dimensions of the arrays u and v.
7197 scale (PLFLT, input) : Parameter to control the scaling factor of
7198 the vectors for plotting. If scale = 0 then the scaling factor is
7199 automatically calculated for the data. If scale < 0 then the
7200 scaling factor is automatically calculated for the data and then
7202 scale. If scale > 0 then the scaling factor is set to scale.
7204 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
7205 Pointer to function that defines transformation between indices
7206 in array z and the world coordinates (C only). Transformation
7207 functions are provided in the PLplot library: pltr0 for identity
7208 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
7209 defined by one- and two-dimensional arrays. In addition,
7210 user-supplied routines for the transformation can be used as well.
7211 Examples of all of these approaches are given in the PLplot
7212 documentation. The transformation function should have the form
7213 given by any of pltr0, pltr1, or pltr2.
7215 pltr_data (PLPointer, input) : Extra parameter to help pass
7216 information to pltr0, pltr1, pltr2, or whatever routine that is
7217 externally supplied.
7220 return _plplotc.plvect(*args)
7224 Specify viewport using coordinates and aspect ratio
7228 Device-independent routine for setting up the viewport. The viewport
7229 is chosen to be the largest with the given aspect ratio that fits
7230 within the specified region (in terms of normalized subpage
7231 coordinates). This routine is functionally equivalent to plvpor when
7232 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this
7233 routine reserves no extra space at the edges for labels.
7235 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect)
7237 This function is used in example 9.
7243 plvpas(xmin, xmax, ymin, ymax, aspect)
7247 xmin (PLFLT, input) : The normalized subpage coordinate of the
7248 left-hand edge of the viewport.
7250 xmax (PLFLT, input) : The normalized subpage coordinate of the
7251 right-hand edge of the viewport.
7253 ymin (PLFLT, input) : The normalized subpage coordinate of the
7254 bottom edge of the viewport.
7256 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7257 edge of the viewport.
7259 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7263 return _plplotc.plvpas(*args)
7267 Specify viewport using coordinates
7271 Device-independent routine for setting up the viewport. This defines
7272 the viewport in terms of normalized subpage coordinates which run from
7273 0.0 to 1.0 (left to right and bottom to top) along each edge of the
7274 current subpage. Use the alternate routine plsvpa in order to create
7275 a viewport of a definite size.
7277 Redacted form: plvpor(xmin, xmax, ymin, ymax)
7279 This function is used in examples
7280 2,6-8,10,11,15,16,18,21,23,24,26,27,31.
7286 plvpor(xmin, xmax, ymin, ymax)
7290 xmin (PLFLT, input) : The normalized subpage coordinate of the
7291 left-hand edge of the viewport.
7293 xmax (PLFLT, input) : The normalized subpage coordinate of the
7294 right-hand edge of the viewport.
7296 ymin (PLFLT, input) : The normalized subpage coordinate of the
7297 bottom edge of the viewport.
7299 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7300 edge of the viewport.
7303 return _plplotc.plvpor(*args)
7307 Select standard viewport
7311 Sets up a standard viewport, leaving a left-hand margin of seven
7312 character heights, and four character heights around the other three
7315 Redacted form: plvsta()
7317 This function is used in examples 1,12,14,17,25,29.
7326 return _plplotc.plvsta()
7330 Set up window for 3-d plotting
7334 Sets up a window for a three-dimensional surface plot within the
7335 currently defined two-dimensional window. The enclosing box for the
7336 surface plot defined by xmin, xmax, ymin, ymax, zmin and zmax in
7337 user-coordinate space is mapped into a box of world coordinate size
7338 basex by basey by height so that xmin maps to -
7339 basex/2 , xmax maps to basex/2 , ymin maps to -
7340 basey/2 , ymax maps to basey/2 , zmin maps to 0 and zmax maps to
7341 height. The resulting world-coordinate box is then viewed by an
7342 observer at altitude alt and azimuth az. This routine must be called
7343 before plbox3 or plot3d. For a more complete description of
7344 three-dimensional plotting see the PLplot documentation.
7346 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
7347 zmin, zmax, alt, az)
7349 This function is examples 8,11,18,21.
7355 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
7359 basex (PLFLT, input) : The x coordinate size of the
7360 world-coordinate box.
7362 basey (PLFLT, input) : The y coordinate size of the
7363 world-coordinate box.
7365 height (PLFLT, input) : The z coordinate size of the
7366 world-coordinate box.
7368 xmin (PLFLT, input) : The minimum user x coordinate value.
7370 xmax (PLFLT, input) : The maximum user x coordinate value.
7372 ymin (PLFLT, input) : The minimum user y coordinate value.
7374 ymax (PLFLT, input) : The maximum user y coordinate value.
7376 zmin (PLFLT, input) : The minimum user z coordinate value.
7378 zmax (PLFLT, input) : The maximum user z coordinate value.
7380 alt (PLFLT, input) : The viewing altitude in degrees above the XY
7383 az (PLFLT, input) : The viewing azimuth in degrees. When az=0 ,
7384 the observer is looking face onto the ZX plane, and as az is
7385 increased, the observer moves clockwise around the box when viewed
7386 from above the XY plane.
7389 return _plplotc.plw3d(*args)
7399 Redacted form: plwidth(width)
7401 This function is used in examples 1,2.
7411 width (PLFLT, input) : The desired pen width. If width is negative
7412 or the same as the previous value no action is taken. width = 0.
7413 should be interpreted as as the minimum valid pen width for the
7414 device. The interpretation of positive width values is also
7418 return _plplotc.plwidth(*args)
7422 Specify world coordinates of viewport boundaries
7426 Sets up the world coordinates of the edges of the viewport.
7428 Redacted form: plwind(xmin, xmax, ymin, ymax)
7430 This function is used in examples 1,2,4,6-12,14-16,18,21,23-27,29,31.
7436 plwind(xmin, xmax, ymin, ymax)
7440 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
7443 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
7446 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
7449 ymax (PLFLT, input) : The world y coordinate of the top edge of the
7453 return _plplotc.plwind(*args)
7457 Enter or leave xor mode
7461 Enter (when mode is true) or leave (when mode is false) xor mode for
7462 those drivers (e.g., the xwin driver) that support it. Enables
7463 erasing plots by drawing twice the same line, symbol, etc. If driver
7464 is not capable of xor operation it returns a status of false.
7466 Redacted form: plxormod(mode, status)
7468 This function is used in examples 1,20.
7474 plxormod(mode, status)
7478 mode (PLBOOL, input) : mode is true means enter xor mode and mode
7479 is false means leave xor mode.
7481 status (PLBOOL *, output) : Pointer to status. Returned modestatus
7482 of true (false) means driver is capable (incapable) of xor mode.
7485 return _plplotc.plxormod(*args)
7489 Plot continental outline or shapefile data in world coordinates
7493 Plots continental outlines or shapefile data in world coordinates. A
7494 demonstration of how to use this function to create different
7495 projections can be found in examples/c/x19c. Plplot is provided with
7496 basic coastal outlines and USA state borders. These can be used
7497 irrespective of whether Shapefile support is built into Plplot. With
7498 Shapefile support this function can also be used with user Shapefiles,
7499 in which case it will plot the entire contents of a Shapefile joining
7500 each point of each Shapefile element with a line. Shapefiles have
7501 become a popular standard for geographical data and data in this
7502 format can be easily found from a number of online sources. Shapefile
7503 data is actually provided as three or more files with the same
7504 filename, but different extensions. The .shp and .shx files are
7505 required for plotting Shapefile data with Plplot.
7507 Redacted form: plmap(mapform, name, minx, maxx, miny, maxy)
7509 This function is used in example 19.
7515 plmap(mapform, name, minx, maxx, miny, maxy)
7519 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7520 supplied function to transform the original map data coordinates
7521 to a new coordinate system. The Plplot supplied map data is
7522 provided as latitudes and longitudes; other Shapefile data may be
7523 provided in other coordinate systems as can be found in their .prj
7524 plain text files. For example, by using this transform we can
7525 change from a longitude, latitude coordinate to a polar
7526 stereographic projection. Initially, x[0]..[n-1] are the original
7527 x coordinates (longitudes for the Plplot suplied data) and
7528 y[0]..y[n-1] are the corresponding y coordinates (latitudes for
7529 the Plplot supplied data). After the call to mapform(), x[] and
7530 y[] should be replaced by the corresponding plot coordinates. If
7531 no transform is desired, mapform can be replaced by NULL.
7533 name (const char *, input) : A character string which determines
7534 the type of map plotted. This is either one of the Plplot built
7535 in maps or the file name of a set of Shapefile files without the
7536 file extensions. For the Plplot built in maps the possible values
7537 are: "globe" -- continental outlines
7538 "usa" -- USA and state boundaries
7539 "cglobe" -- continental outlines and countries
7540 "usaglobe" -- USA, state boundaries and continental outlines
7543 minx (PLFLT, input) : The minimum x value of map elements to be
7544 drawn. For the built in maps this is a measure of longitude. For
7545 Shapefiles the units must match the projection. The value of minx
7546 must be less than the value of maxx. Specifying a useful limit for
7547 these limits provides a useful optimization for complex or
7550 maxx (PLFLT, input) : The maximum x value of map elements to be
7553 miny (PLFLT, input) : The minimum y value of map elements to be
7554 drawn. For the built in maps this is a measure of latitude. For
7555 Shapefiles the units must match the projection. The value of miny
7556 must be less than the value of maxy.
7558 maxy (PLFLT, input) : The maximum y value of map elements to be
7562 return _plplotc.plmap(*args)
7566 Plot all or a subset of Shapefile data using lines in world coordinates
7570 Plot all or a subset of Shapefile data using lines in world
7571 coordinates. examples/c/x19c demonstrates how to use this function.
7572 This function plots data from a Shapefile using lines as in plmap,
7573 however it also has the option of also only drawing specified elements
7574 from the Shapefile. The indices of the required elements are passed
7575 into the function as an array. The Shapefile data should include a
7576 metadata file (extension.dbf) listing all items within the Shapefile.
7577 This file can be opened by most popular spreadsheet programs and can
7578 be used to decide which indices to pass to this function.
7580 Redacted form: plmapline(mapform, name, minx, maxx, miny, maxy,
7583 This function is used in example 19.
7589 plmapline(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
7593 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7594 supplied function to transform the coordinates given in the
7595 shapefile into a plot coordinate system. By using this transform,
7596 we can change from a longitude, latitude coordinate to a polar
7597 stereographic project, for example. Initially, x[0]..[n-1] are
7598 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
7599 After the call to mapform(), x[] and y[] should be replaced by the
7600 corresponding plot coordinates. If no transform is desired,
7601 mapform can be replaced by NULL.
7603 name (const char *, input) : The file name of a set of Shapefile
7604 files without the file extension.
7606 minx (PLFLT, input) : The minimum x value to be plotted. This must
7607 be in the same units as used by the Shapefile. You could use a
7608 very large negative number to plot everything, but you can improve
7609 performance by limiting the area drawn. The units must match those
7610 of the Shapefile projection, which may be for example longitude or
7611 distance. The value of minx must be less than the value of maxx.
7613 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7614 use a very large number to plot everything, but you can improve
7615 performance by limiting the area drawn.
7617 miny (PLFLT, input) : The minimum y value to be plotted. This must
7618 be in the same units as used by the Shapefile. You could use a
7619 very large negative number to plot everything, but you can improve
7620 performance by limiting the area drawn. The units must match those
7621 of the Shapefile projection, which may be for example latitude or
7622 distance. The value of miny must be less than the value of maxy.
7624 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7625 use a very large number to plot everything, but you can improve
7626 performance by limiting the area drawn.
7628 plotentries (const PLINT *, input) : An array of integers
7629 indicating the elements of the Shapefile (zero indexed) which will
7630 be drawn. Setting plotentries to NULL will plot all elements of
7633 nplotentries (PLINT, input) : The number of items in plotentries.
7634 Ignored if plotentries is NULL.
7637 return _plplotc.plmapline(*args)
7641 Plot all or a subset of Shapefile data using strings or points in world coordinates
7645 As per plmapline, however the items are plotted as strings or points
7646 in the same way as plstring.
7648 Redacted form: plmapstring(mapform, name, string, minx, maxx, miny,
7651 This function is used in example 19.
7657 plmapstring(mapform, name, string, minx, maxx, miny, maxy, plotentries, nplotentries)
7661 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7662 supplied function to transform the coordinates given in the
7663 shapefile into a plot coordinate system. By using this transform,
7664 we can change from a longitude, latitude coordinate to a polar
7665 stereographic project, for example. Initially, x[0]..[n-1] are
7666 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
7667 After the call to mapform(), x[] and y[] should be replaced by the
7668 corresponding plot coordinates. If no transform is desired,
7669 mapform can be replaced by NULL.
7671 name (const char *, input) : The file name of a set of Shapefile
7672 files without the file extension.
7674 string (const char *, input) : A NULL terminated string of
7675 characters to be drawn.
7677 minx (PLFLT, input) : The minimum x value to be plotted. This must
7678 be in the same units as used by the Shapefile. You could use a
7679 very large negative number to plot everything, but you can improve
7680 performance by limiting the area drawn. The units must match those
7681 of the Shapefile projection, which may be for example longitude or
7682 distance. The value of minx must be less than the value of maxx.
7684 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7685 use a very large number to plot everything, but you can improve
7686 performance by limiting the area drawn.
7688 miny (PLFLT, input) : The minimum y value to be plotted. This must
7689 be in the same units as used by the Shapefile. You could use a
7690 very large negative number to plot everything, but you can improve
7691 performance by limiting the area drawn. The units must match those
7692 of the Shapefile projection, which may be for example latitude or
7693 distance. The value of miny must be less than the value of maxy.
7695 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7696 use a very large number to plot everything, but you can improve
7697 performance by limiting the area drawn.
7699 plotentries (const PLINT *, input) : An array of integers
7700 indicating the elements of the Shapefile (zero indexed) which will
7701 be drawn. Setting plotentries to NULL will plot all elements of
7704 nplotentries (PLINT, input) : The number of items in plotentries.
7705 Ignored if plotentries is NULL.
7708 return _plplotc.plmapstring(*args)
7712 Draw text at points defined by Shapefile data in world coordinates
7716 As per plmapline, however the items are plotted as text in the same
7719 Redacted form: plmaptex(mapform, name, dx, dy, just, text, minx, maxx,
7720 miny, maxy, plotentry)
7722 This function is used in example 19.
7728 plmaptex(mapform, name, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
7732 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7733 supplied function to transform the coordinates given in the
7734 shapefile into a plot coordinate system. By using this transform,
7735 we can change from a longitude, latitude coordinate to a polar
7736 stereographic project, for example. Initially, x[0]..[n-1] are
7737 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
7738 After the call to mapform(), x[] and y[] should be replaced by the
7739 corresponding plot coordinates. If no transform is desired,
7740 mapform can be replaced by NULL.
7742 name (const char *, input) : The file name of a set of Shapefile
7743 files without the file extension.
7745 dx (PLFLT, input) : Used to define the slope of the texts which is
7748 dy (PLFLT, input) : Used to define the slope of the texts which is
7751 just (PLFLT, input) : Set the justification of the text. The value
7752 given will be the fraction of the distance along the string that
7753 sits at the given point. 0.0 gives left aligned text, 0.5 gives
7754 centralized text and 1.0 gives right aligned text.
7756 text (const char *, input) : A NULL-terminated string of characters
7759 minx (PLFLT, input) : The minimum x value to be plotted. This must
7760 be in the same units as used by the Shapefile. You could use a
7761 very large negative number to plot everything, but you can improve
7762 performance by limiting the area drawn. The units must match those
7763 of the Shapefile projection, which may be for example longitude or
7764 distance. The value of minx must be less than the value of maxx.
7766 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7767 use a very large number to plot everything, but you can improve
7768 performance by limiting the area drawn.
7770 miny (PLFLT, input) : The minimum y value to be plotted. This must
7771 be in the same units as used by the Shapefile. You could use a
7772 very large negative number to plot everything, but you can improve
7773 performance by limiting the area drawn. The units must match those
7774 of the Shapefile projection, which may be for example latitude or
7775 distance. The value of miny must be less than the value of maxy.
7777 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7778 use a very large number to plot everything, but you can improve
7779 performance by limiting the area drawn.
7781 plotentry (PLINT, input) : An integer indicating which text string
7782 of the Shapefile (zero indexed) will be drawn.
7785 return _plplotc.plmaptex(*args)
7789 Plot all or a subset of Shapefile data, filling the polygons
7793 As per plmapline, however the items are filled in the same way as
7796 Redacted form: plmapfill(mapform, name, minx, maxx, miny, maxy,
7799 This function is used in example 19.
7805 plmapfill(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
7809 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7810 supplied function to transform the coordinates given in the
7811 shapefile into a plot coordinate system. By using this transform,
7812 we can change from a longitude, latitude coordinate to a polar
7813 stereographic project, for example. Initially, x[0]..[n-1] are
7814 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
7815 After the call to mapform(), x[] and y[] should be replaced by the
7816 corresponding plot coordinates. If no transform is desired,
7817 mapform can be replaced by NULL.
7819 name (const char *, input) : The file name of a set of Shapefile
7820 files without the file extension.
7822 minx (PLFLT, input) : The minimum x value to be plotted. This must
7823 be in the same units as used by the Shapefile. You could use a
7824 very large negative number to plot everything, but you can improve
7825 performance by limiting the area drawn. The units must match those
7826 of the Shapefile projection, which may be for example longitude or
7827 distance. The value of minx must be less than the value of maxx.
7829 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7830 use a very large number to plot everything, but you can improve
7831 performance by limiting the area drawn.
7833 miny (PLFLT, input) : The minimum y value to be plotted. This must
7834 be in the same units as used by the Shapefile. You could use a
7835 very large negative number to plot everything, but you can improve
7836 performance by limiting the area drawn. The units must match those
7837 of the Shapefile projection, which may be for example latitude or
7838 distance. The value of miny must be less than the value of maxy.
7840 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7841 use a very large number to plot everything, but you can improve
7842 performance by limiting the area drawn.
7844 plotentries (const PLINT *, input) : An array of integers
7845 indicating the elements of the Shapefile (zero indexed) which will
7846 be drawn. Setting plotentries to NULL will plot all elements of
7849 nplotentries (PLINT, input) : The number of items in plotentries.
7850 Ignored if plotentries is NULL.
7853 return _plplotc.plmapfill(*args)
7857 Plot latitude and longitude lines
7861 Displays latitude and longitude on the current plot. The lines are
7862 plotted in the current color and line style.
7864 Redacted form: plmeridians(mapform, dlong, dlat, minlong, maxlong,
7867 This function is used in example 19.
7873 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
7877 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
7878 supplied function to transform the coordinate longitudes and
7879 latitudes to a plot coordinate system. By using this transform, we
7880 can change from a longitude, latitude coordinate to a polar
7881 stereographic project, for example. Initially, x[0]..[n-1] are
7882 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
7883 After the call to mapform(), x[] and y[] should be replaced by the
7884 corresponding plot coordinates. If no transform is desired,
7885 mapform can be replaced by NULL.
7887 dlong (PLFLT, input) : The interval in degrees at which the
7888 longitude lines are to be plotted.
7890 dlat (PLFLT, input) : The interval in degrees at which the latitude
7891 lines are to be plotted.
7893 minlong (PLFLT, input) : The value of the longitude on the left
7894 side of the plot. The value of minlong must be less than the value
7895 of maxlong, and the quantity maxlong-minlong must be less than or
7898 maxlong (PLFLT, input) : The value of the longitude on the right
7901 minlat (PLFLT, input) : The minimum latitude to be plotted on the
7902 background. One can always use -90.0 as the boundary outside the
7903 plot window will be automatically eliminated. However, the
7904 program will be faster if one can reduce the size of the
7907 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
7908 background. One can always use 90.0 as the boundary outside the
7909 plot window will be automatically eliminated.
7912 return _plplotc.plmeridians(*args)
7916 Plot a 2D matrix using cmap1 with automatic colour adjustment
7920 Plot a 2D matrix using color palette 1. The color scale is
7921 automatically adjusted to use the maximum and minimum values in idata
7922 as valuemin and valuemax in a call to plimagefr.
7924 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin,
7925 zmax, Dxmin, Dxmax, Dymin, Dymax)
7928 This function is used in example 20.
7934 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
7938 idata (const PLFLT * const *, input) : A 2D array of values
7939 (intensities) to plot. Should have dimensions idata[nx][ny].
7941 nx, ny (PLINT, input) : Dimensions of idata
7943 xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to stretch
7944 the image data to. idata[0][0] corresponds to (xmin, ymin) and
7945 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
7947 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
7948 (inclusive) will be plotted.
7950 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
7951 points whose plot coordinates fall inside the window of (Dxmin,
7952 Dymin) to (Dxmax, Dymax).
7955 return _plplotc.plimage(*args)
7959 Plot a 2D matrix using cmap1
7963 Plot a 2D matrix using cmap1.
7965 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax,
7966 zmin, zmax, valuemin, valuemax, pltr, pltr_data)
7969 This function is used in example 20.
7975 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
7979 idata (const PLFLT * const *, input) : A 2D array of values
7980 (intensities) to plot. Should have dimensions idata[nx][ny].
7982 nx, ny (PLINT, input) : Dimensions of idata
7984 xmin, xmax, ymin, ymax (PLFLT, input) : Stretch image data to these
7985 Plot coordinates. idata[0][0] corresponds to (xmin, ymin) and
7986 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
7988 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
7989 (inclusive) will be plotted.
7991 valuemin, valuemax (PLFLT, input) : The minimum and maximum data
7992 values to use for value to color mappings. A datum equal to or
7993 less than valuemin will be plotted with color 0.0, while a datum
7994 equal to or greater than valuemax will be plotted with color 1.0.
7995 Data between valuemin and valuemax map linearly to colors between
7998 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
7999 Pointer to function that defines a transformation between the
8000 data in the array idata and world coordinates. An input
8001 coordinate of (0, 0) corresponds to the "top-left" corner of idata
8002 while (nx, ny) corresponds to the "bottom-right" corner of idata.
8003 Some transformation functions are provided in the PLplot library:
8004 pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary
8005 mappings respectively defined by one- and two-dimensional arrays.
8006 In addition, user-supplied routines for the transformation can be
8007 used as well. Examples of all of these approaches are given in
8008 the PLplot documentation. The transformation function should have
8009 the form given by any of pltr0, pltr1, or pltr2.
8011 pltr_data (PLPointer, input) : Extra parameter to help pass
8012 information to pltr0, pltr1, pltr2, or whatever routine is
8013 externally supplied.
8016 return _plplotc.plimagefr(*args)
8019 return _plplotc.plClearOpts()
8020 plClearOpts = _plplotc.plClearOpts
8023 return _plplotc.plResetOpts()
8024 plResetOpts = _plplotc.plResetOpts
8027 return _plplotc.plSetUsage(*args)
8028 plSetUsage = _plplotc.plSetUsage
8031 return _plplotc.plOptUsage()
8032 plOptUsage = _plplotc.plOptUsage
8035 return _plplotc.plMinMax2dGrid(*args)
8036 plMinMax2dGrid = _plplotc.plMinMax2dGrid
8039 return _plplotc.plGetCursor(*args)
8040 plGetCursor = _plplotc.plGetCursor