7 from sys
import version_info
as _swig_python_version_info
8 if _swig_python_version_info < (2, 7, 0):
9 raise RuntimeError(
"Python 2.7 or later required")
12 if __package__
or "." in __name__:
13 from .
import _plplotc
18 import builtins
as __builtin__
24 strthis =
"proxy of " + self.this.__repr__()
25 except __builtin__.Exception:
27 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
31 def set_instance_attr(self, name, value):
35 set(self, name, value)
36 elif hasattr(self, name)
and isinstance(getattr(type(self), name), property):
37 set(self, name, value)
39 raise AttributeError(
"You cannot add instance attributes to %s" % self)
40 return set_instance_attr
44 def set_class_attr(cls, name, value):
45 if hasattr(cls, name)
and not isinstance(getattr(cls, name), property):
48 raise AttributeError(
"You cannot add class attributes to %s" % cls)
53 """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
55 return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
60 """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
66 return _plplotc.pltr0(x, y)
69 return _plplotc.pltr1(x, y, cgrid)
72 return _plplotc.pltr2(x, y, cgrid)
73 PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
74 PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
75 PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
76 PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
77 PLESC_RESIZE = _plplotc.PLESC_RESIZE
78 PLESC_REDRAW = _plplotc.PLESC_REDRAW
79 PLESC_TEXT = _plplotc.PLESC_TEXT
80 PLESC_GRAPH = _plplotc.PLESC_GRAPH
81 PLESC_FILL = _plplotc.PLESC_FILL
82 PLESC_DI = _plplotc.PLESC_DI
83 PLESC_FLUSH = _plplotc.PLESC_FLUSH
84 PLESC_EH = _plplotc.PLESC_EH
85 PLESC_GETC = _plplotc.PLESC_GETC
86 PLESC_SWIN = _plplotc.PLESC_SWIN
87 PLESC_DOUBLEBUFFERING = _plplotc.PLESC_DOUBLEBUFFERING
88 PLESC_XORMOD = _plplotc.PLESC_XORMOD
89 PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
90 PLESC_CLEAR = _plplotc.PLESC_CLEAR
91 PLESC_DASH = _plplotc.PLESC_DASH
92 PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
93 PLESC_IMAGE = _plplotc.PLESC_IMAGE
94 PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
95 PLESC_PL2DEVCOL = _plplotc.PLESC_PL2DEVCOL
96 PLESC_DEV2PLCOL = _plplotc.PLESC_DEV2PLCOL
97 PLESC_SETBGFG = _plplotc.PLESC_SETBGFG
98 PLESC_DEVINIT = _plplotc.PLESC_DEVINIT
99 PLESC_GETBACKEND = _plplotc.PLESC_GETBACKEND
100 PLESC_BEGIN_TEXT = _plplotc.PLESC_BEGIN_TEXT
101 PLESC_TEXT_CHAR = _plplotc.PLESC_TEXT_CHAR
102 PLESC_CONTROL_CHAR = _plplotc.PLESC_CONTROL_CHAR
103 PLESC_END_TEXT = _plplotc.PLESC_END_TEXT
104 PLESC_START_RASTERIZE = _plplotc.PLESC_START_RASTERIZE
105 PLESC_END_RASTERIZE = _plplotc.PLESC_END_RASTERIZE
106 PLESC_ARC = _plplotc.PLESC_ARC
107 PLESC_GRADIENT = _plplotc.PLESC_GRADIENT
108 PLESC_MODESET = _plplotc.PLESC_MODESET
109 PLESC_MODEGET = _plplotc.PLESC_MODEGET
110 PLESC_FIXASPECT = _plplotc.PLESC_FIXASPECT
111 PLESC_IMPORT_BUFFER = _plplotc.PLESC_IMPORT_BUFFER
112 PLESC_APPEND_BUFFER = _plplotc.PLESC_APPEND_BUFFER
113 PLESC_FLUSH_REMAINING_BUFFER = _plplotc.PLESC_FLUSH_REMAINING_BUFFER
114 PLTEXT_FONTCHANGE = _plplotc.PLTEXT_FONTCHANGE
115 PLTEXT_SUPERSCRIPT = _plplotc.PLTEXT_SUPERSCRIPT
116 PLTEXT_SUBSCRIPT = _plplotc.PLTEXT_SUBSCRIPT
117 PLTEXT_BACKCHAR = _plplotc.PLTEXT_BACKCHAR
118 PLTEXT_OVERLINE = _plplotc.PLTEXT_OVERLINE
119 PLTEXT_UNDERLINE = _plplotc.PLTEXT_UNDERLINE
120 ZEROW2B = _plplotc.ZEROW2B
121 ZEROW2D = _plplotc.ZEROW2D
122 ONEW2B = _plplotc.ONEW2B
123 ONEW2D = _plplotc.ONEW2D
124 PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
125 PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
126 PL_X_AXIS = _plplotc.PL_X_AXIS
127 PL_Y_AXIS = _plplotc.PL_Y_AXIS
128 PL_Z_AXIS = _plplotc.PL_Z_AXIS
129 PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
130 PL_OPT_ARG = _plplotc.PL_OPT_ARG
131 PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
132 PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
133 PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
134 PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
135 PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
136 PL_OPT_INT = _plplotc.PL_OPT_INT
137 PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
138 PL_OPT_STRING = _plplotc.PL_OPT_STRING
139 PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
140 PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
141 PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
142 PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
143 PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
144 PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
145 PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
146 PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
147 PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
148 PL_FCI_MARK = _plplotc.PL_FCI_MARK
149 PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
150 PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
151 PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
152 PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
153 PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
154 PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
155 PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
156 PL_FCI_SANS = _plplotc.PL_FCI_SANS
157 PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
158 PL_FCI_MONO = _plplotc.PL_FCI_MONO
159 PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
160 PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
161 PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
162 PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
163 PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
164 PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
165 PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
166 PL_MAXKEY = _plplotc.PL_MAXKEY
167 PL_MASK_SHIFT = _plplotc.PL_MASK_SHIFT
168 PL_MASK_CAPS = _plplotc.PL_MASK_CAPS
169 PL_MASK_CONTROL = _plplotc.PL_MASK_CONTROL
170 PL_MASK_ALT = _plplotc.PL_MASK_ALT
171 PL_MASK_NUM = _plplotc.PL_MASK_NUM
172 PL_MASK_ALTGR = _plplotc.PL_MASK_ALTGR
173 PL_MASK_WIN = _plplotc.PL_MASK_WIN
174 PL_MASK_SCROLL = _plplotc.PL_MASK_SCROLL
175 PL_MASK_BUTTON1 = _plplotc.PL_MASK_BUTTON1
176 PL_MASK_BUTTON2 = _plplotc.PL_MASK_BUTTON2
177 PL_MASK_BUTTON3 = _plplotc.PL_MASK_BUTTON3
178 PL_MASK_BUTTON4 = _plplotc.PL_MASK_BUTTON4
179 PL_MASK_BUTTON5 = _plplotc.PL_MASK_BUTTON5
180 PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
181 PL_NOTSET = _plplotc.PL_NOTSET
182 PL_DEFAULT_NCOL0 = _plplotc.PL_DEFAULT_NCOL0
183 PL_DEFAULT_NCOL1 = _plplotc.PL_DEFAULT_NCOL1
184 MIN_PLINT_RGB = _plplotc.MIN_PLINT_RGB
185 MAX_PLINT_RGB = _plplotc.MAX_PLINT_RGB
186 MIN_PLFLT_CMAP1 = _plplotc.MIN_PLFLT_CMAP1
187 MAX_PLFLT_CMAP1 = _plplotc.MAX_PLFLT_CMAP1
188 MIN_PLFLT_ALPHA = _plplotc.MIN_PLFLT_ALPHA
189 MAX_PLFLT_ALPHA = _plplotc.MAX_PLFLT_ALPHA
190 PLESC_DOUBLEBUFFERING_ENABLE = _plplotc.PLESC_DOUBLEBUFFERING_ENABLE
191 PLESC_DOUBLEBUFFERING_DISABLE = _plplotc.PLESC_DOUBLEBUFFERING_DISABLE
192 PLESC_DOUBLEBUFFERING_QUERY = _plplotc.PLESC_DOUBLEBUFFERING_QUERY
193 PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
194 PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
195 PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
196 PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
197 GRID_CSA = _plplotc.GRID_CSA
198 GRID_DTLI = _plplotc.GRID_DTLI
199 GRID_NNI = _plplotc.GRID_NNI
200 GRID_NNIDW = _plplotc.GRID_NNIDW
201 GRID_NNLI = _plplotc.GRID_NNLI
202 GRID_NNAIDW = _plplotc.GRID_NNAIDW
203 PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
204 PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
205 PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
206 PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
207 PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
208 PL_POSITION_NULL = _plplotc.PL_POSITION_NULL
209 PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
210 PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
211 PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
212 PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
213 PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
214 PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
215 PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
216 PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
217 PL_LEGEND_NULL = _plplotc.PL_LEGEND_NULL
218 PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
219 PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
220 PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
221 PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
222 PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
223 PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
224 PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
225 PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
226 PL_COLORBAR_NULL = _plplotc.PL_COLORBAR_NULL
227 PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
228 PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
229 PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
230 PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
231 PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
232 PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
233 PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
234 PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
235 PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
236 PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
237 PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
238 PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
239 PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
240 PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
241 PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
242 PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
243 PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
244 PL_DRAWMODE_UNKNOWN = _plplotc.PL_DRAWMODE_UNKNOWN
245 PL_DRAWMODE_DEFAULT = _plplotc.PL_DRAWMODE_DEFAULT
246 PL_DRAWMODE_REPLACE = _plplotc.PL_DRAWMODE_REPLACE
247 PL_DRAWMODE_XOR = _plplotc.PL_DRAWMODE_XOR
248 DRAW_LINEX = _plplotc.DRAW_LINEX
249 DRAW_LINEY = _plplotc.DRAW_LINEY
250 DRAW_LINEXY = _plplotc.DRAW_LINEXY
251 MAG_COLOR = _plplotc.MAG_COLOR
252 BASE_CONT = _plplotc.BASE_CONT
253 TOP_CONT = _plplotc.TOP_CONT
254 SURF_CONT = _plplotc.SURF_CONT
255 DRAW_SIDES = _plplotc.DRAW_SIDES
256 FACETED = _plplotc.FACETED
259 thisown = property(
lambda x: x.this.own(),
lambda x, v: x.this.own(v), doc=
"The membership flag")
260 __repr__ = _swig_repr
261 type = property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
262 state = property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
263 keysym = property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
264 button = property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
265 subwindow = property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
266 string = property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
267 pX = property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
268 pY = property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
269 dX = property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
270 dY = property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
271 wX = property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
272 wY = property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
275 _plplotc.PLGraphicsIn_swiginit(self, _plplotc.new_PLGraphicsIn())
276 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
279 _plplotc.PLGraphicsIn_swigregister(PLGraphicsIn)
283 return _plplotc.plsxwin(window_id)
287 Set format of numerical label for contours
291 Set format of numerical label for contours.
293 Redacted form: pl_setcontlabelformat(lexp, sigdig)
295 This function is used example 9.
301 pl_setcontlabelformat(lexp, sigdig)
305 lexp (PLINT, input) : If the contour numerical label is greater
306 than 10^(lexp) or less than 10^(-lexp), then the exponential
307 format is used. Default value of lexp is 4.
309 sigdig (PLINT, input) : Number of significant digits. Default
313 return _plplotc.pl_setcontlabelformat(lexp, sigdig)
317 Set parameters of contour labelling other than format of numerical label
321 Set parameters of contour labelling other than those handled by
322 pl_setcontlabelformat.
324 Redacted form: pl_setcontlabelparam(offset, size, spacing, active)
326 This function is used in example 9.
332 pl_setcontlabelparam(offset, size, spacing, active)
336 offset (PLFLT, input) : Offset of label from contour line (if set
337 to 0.0, labels are printed on the lines). Default value is 0.006.
339 size (PLFLT, input) : Font height for contour labels (normalized).
340 Default value is 0.3.
342 spacing (PLFLT, input) : Spacing parameter for contour labels.
343 Default value is 0.1.
345 active (PLINT, input) : Activate labels. Set to 1 if you want
346 contour labels on. Default is off (0).
349 return _plplotc.pl_setcontlabelparam(offset, size, spacing, active)
353 Advance the (sub-)page
357 Advances to the next subpage if sub=0, performing a page advance if
358 there are no remaining subpages on the current page. If subpages
359 aren't being used, pladv(0) will always advance the page. If page>0,
360 PLplot switches to the specified subpage. Note that this allows you
361 to overwrite a plot on the specified subpage; if this is not what you
362 intended, use pleop followed by plbop to first advance the page. This
363 routine is called automatically (with page=0) by plenv, but if plenv
364 is not used, pladv must be called after initializing PLplot but before
365 defining the viewport.
367 Redacted form: pladv(page)
369 This function is used in examples 1, 2, 4, 6-12, 14-18, 20, 21, 23-27,
380 page (PLINT, input) : Specifies the subpage number (starting from 1
381 in the top left corner and increasing along the rows) to which to
382 advance. Set to zero to advance to the next subpage (or to the
383 next page if subpages are not being used).
386 return _plplotc.pladv(page)
388 def plarc(x, y, a, b, angle1, angle2, rotate, fill):
390 Draw a circular or elliptical arc
394 Draw a possibly filled arc centered at x, y with semimajor axis a and
395 semiminor axis b, starting at angle1 and ending at angle2.
397 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate,
401 This function is used in examples 3 and 27.
407 plarc(x, y, a, b, angle1, angle2, rotate, fill)
411 x (PLFLT, input) : X coordinate of arc center.
413 y (PLFLT, input) : Y coordinate of arc center.
415 a (PLFLT, input) : Length of the semimajor axis of the arc.
417 b (PLFLT, input) : Length of the semiminor axis of the arc.
419 angle1 (PLFLT, input) : Starting angle of the arc relative to the
422 angle2 (PLFLT, input) : Ending angle of the arc relative to the
425 rotate (PLFLT, input) : Angle of the semimajor axis relative to the
428 fill (PLBOOL, input) : Draw a filled arc.
431 return _plplotc.plarc(x, y, a, b, angle1, angle2, rotate, fill)
433 def plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub):
435 Draw a box with axes, etc. with arbitrary origin
439 Draws a box around the currently defined viewport with arbitrary
440 world-coordinate origin specified by x0 and y0 and labels it with
441 world coordinate values appropriate to the window. Thus plaxes should
442 only be called after defining both viewport and window. The ascii
443 character strings xopt and yopt specify how the box should be drawn as
444 described below. If ticks and/or subticks are to be drawn for a
445 particular axis, the tick intervals and number of subintervals may be
446 specified explicitly, or they may be defaulted by setting the
447 appropriate arguments to zero.
449 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt,
453 This function is not used in any examples.
459 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
463 x0 (PLFLT, input) : World X coordinate of origin.
465 y0 (PLFLT, input) : World Y coordinate of origin.
467 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
468 options for the x axis. The string can include any combination of
469 the following letters (upper or lower case) in any order: a: Draws
470 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line
472 b: Draws bottom (X) or left (Y) edge of frame.
473 c: Draws top (X) or right (Y) edge of frame.
474 d: Plot labels as date / time. Values are assumed to be
475 seconds since the epoch (as used by gmtime).
476 f: Always use fixed point numeric labels.
477 g: Draws a grid at the major tick interval.
478 h: Draws a grid at the minor tick interval.
479 i: Inverts tick marks, so they are drawn outwards, rather than
481 l: Labels axis logarithmically. This only affects the labels,
482 not the data, and so it is necessary to compute the logarithms
483 of data points before passing them to any of the drawing
485 m: Writes numeric labels at major tick intervals in the
486 unconventional location (above box for X, right of box for Y).
487 n: Writes numeric labels at major tick intervals in the
488 conventional location (below box for X, left of box for Y).
489 o: Use custom labelling function to generate axis label text.
490 The custom labelling function can be defined with the
491 plslabelfunc command.
492 s: Enables subticks between major ticks, only valid if t is
494 t: Draws major ticks.
495 u: Exactly like "b" except don't draw edge line.
496 w: Exactly like "c" except don't draw edge line.
497 x: Exactly like "t" (including the side effect of the
498 numerical labels for the major ticks) except exclude drawing
499 the major and minor tick marks.
502 xtick (PLFLT, input) : World coordinate interval between major
503 ticks on the x axis. If it is set to zero, PLplot automatically
504 generates a suitable tick interval.
506 nxsub (PLINT, input) : Number of subintervals between major x axis
507 ticks for minor ticks. If it is set to zero, PLplot automatically
508 generates a suitable minor tick interval.
510 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
511 options for the y axis. The string can include any combination of
512 the letters defined above for xopt, and in addition may contain:
513 v: Write numeric labels for the y axis parallel to the base of the
514 graph, rather than parallel to the axis.
517 ytick (PLFLT, input) : World coordinate interval between major
518 ticks on the y axis. If it is set to zero, PLplot automatically
519 generates a suitable tick interval.
521 nysub (PLINT, input) : Number of subintervals between major y axis
522 ticks for minor ticks. If it is set to zero, PLplot automatically
523 generates a suitable minor tick interval.
526 return _plplotc.plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
530 Plot a histogram from binned data
534 Plots a histogram consisting of nbin bins. The value associated with
535 the i'th bin is placed in x[i], and the number of points in the bin is
536 placed in y[i]. For proper operation, the values in x[i] must form a
537 strictly increasing sequence. By default, x[i] is the left-hand edge
538 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
539 placed midway between the values in the x vector. Also see plhist for
540 drawing histograms from unbinned data.
542 Redacted form: General: plbin(x, y, opt)
543 Python: plbin(nbin, x, y, opt)
546 This function is not used in any examples.
552 plbin(nbin, x, y, opt)
556 nbin (PLINT, input) : Number of bins (i.e., number of values in x
559 x (PLFLT_VECTOR, input) : A vector containing values associated
560 with bins. These must form a strictly increasing sequence.
562 y (PLFLT_VECTOR, input) : A vector containing a number which is
563 proportional to the number of points in each bin. This is a PLFLT
564 (instead of PLINT) vector so as to allow histograms of
567 opt (PLINT, input) : Is a combination of several flags:
568 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
569 outer bins are expanded to fill up the entire x-axis and bins of
570 zero height are simply drawn.
571 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
572 between the x values. If the values in x are equally spaced,
573 the values are the center values of the bins.
574 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal
575 size as the ones inside.
576 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn
577 (there is a gap for such bins).
580 return _plplotc.plbin(n, ArrayCk, center)
584 Calculate broken-down time from continuous time for the current stream
588 Calculate broken-down time; year, month, day, hour, min, sec; from
589 continuous time, ctime for the current stream. This function is the
592 The PLplot definition of broken-down time is a calendar time that
593 completely ignores all time zone offsets, i.e., it is the user's
594 responsibility to apply those offsets (if so desired) before using the
595 PLplot time API. By default broken-down time is defined using the
596 proleptic Gregorian calendar without the insertion of leap seconds and
597 continuous time is defined as the number of seconds since the Unix
598 epoch of 1970-01-01T00:00:00Z. However, other definitions of
599 broken-down and continuous time are possible, see plconfigtime.
601 Redacted form: General: plbtime(year, month, day, hour, min, sec,
605 This function is used in example 29.
611 plbtime(year, month, day, hour, min, sec, ctime)
615 year (PLINT_NC_SCALAR, output) : Returned value of years with
616 positive values corresponding to CE (i.e., 1 = 1 CE, etc.) and
617 non-negative values corresponding to BCE (e.g., 0 = 1 BCE, -1 = 2
620 month (PLINT_NC_SCALAR, output) : Returned value of month within
621 the year in the range from 0 (January) to 11 (December).
623 day (PLINT_NC_SCALAR, output) : Returned value of day within the
624 month in the range from 1 to 31.
626 hour (PLINT_NC_SCALAR, output) : Returned value of hour within the
627 day in the range from 0 to 23.
629 min (PLINT_NC_SCALAR, output) : Returned value of minute within the
630 hour in the range from 0 to 59
632 sec (PLFLT_NC_SCALAR, output) : Returned value of second within the
633 minute in range from 0. to 60.
635 ctime (PLFLT, input) : Continuous time from which the broken-down
639 return _plplotc.plbtime(ctime)
647 Begins a new page. For a file driver, the output file is opened if
648 necessary. Advancing the page via pleop and plbop is useful when a
649 page break is desired at a particular point when plotting to subpages.
650 Another use for pleop and plbop is when plotting pages to different
651 files, since you can manually set the file name by calling plsfnam
652 after the call to pleop. (In fact some drivers may only support a
653 single page per file, making this a necessity.) One way to handle
654 this case automatically is to page advance via pladv, but enable
655 familying (see plsfam) with a small limit on the file size so that a
656 new family member file will be created on each page break.
658 Redacted form: plbop()
660 This function is used in examples 2 and 20.
669 return _plplotc.plbop()
671 def plbox(xopt, xtick, nxsub, yopt, ytick, nysub):
673 Draw a box with axes, etc
677 Draws a box around the currently defined viewport, and labels it with
678 world coordinate values appropriate to the window. Thus plbox should
679 only be called after defining both viewport and window. The ascii
680 character strings xopt and yopt specify how the box should be drawn as
681 described below. If ticks and/or subticks are to be drawn for a
682 particular axis, the tick intervals and number of subintervals may be
683 specified explicitly, or they may be defaulted by setting the
684 appropriate arguments to zero.
686 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
689 This function is used in examples 1, 2, 4, 6, 6-12, 14-18, 21, 23-26,
696 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
700 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
701 options for the x axis. The string can include any combination of
702 the following letters (upper or lower case) in any order: a: Draws
703 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line
705 b: Draws bottom (X) or left (Y) edge of frame.
706 c: Draws top (X) or right (Y) edge of frame.
707 d: Plot labels as date / time. Values are assumed to be
708 seconds since the epoch (as used by gmtime).
709 f: Always use fixed point numeric labels.
710 g: Draws a grid at the major tick interval.
711 h: Draws a grid at the minor tick interval.
712 i: Inverts tick marks, so they are drawn outwards, rather than
714 l: Labels axis logarithmically. This only affects the labels,
715 not the data, and so it is necessary to compute the logarithms
716 of data points before passing them to any of the drawing
718 m: Writes numeric labels at major tick intervals in the
719 unconventional location (above box for X, right of box for Y).
720 n: Writes numeric labels at major tick intervals in the
721 conventional location (below box for X, left of box for Y).
722 o: Use custom labelling function to generate axis label text.
723 The custom labelling function can be defined with the
724 plslabelfunc command.
725 s: Enables subticks between major ticks, only valid if t is
727 t: Draws major ticks.
728 u: Exactly like "b" except don't draw edge line.
729 w: Exactly like "c" except don't draw edge line.
730 x: Exactly like "t" (including the side effect of the
731 numerical labels for the major ticks) except exclude drawing
732 the major and minor tick marks.
735 xtick (PLFLT, input) : World coordinate interval between major
736 ticks on the x axis. If it is set to zero, PLplot automatically
737 generates a suitable tick interval.
739 nxsub (PLINT, input) : Number of subintervals between major x axis
740 ticks for minor ticks. If it is set to zero, PLplot automatically
741 generates a suitable minor tick interval.
743 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
744 options for the y axis. The string can include any combination of
745 the letters defined above for xopt, and in addition may contain:
746 v: Write numeric labels for the y axis parallel to the base of the
747 graph, rather than parallel to the axis.
750 ytick (PLFLT, input) : World coordinate interval between major
751 ticks on the y axis. If it is set to zero, PLplot automatically
752 generates a suitable tick interval.
754 nysub (PLINT, input) : Number of subintervals between major y axis
755 ticks for minor ticks. If it is set to zero, PLplot automatically
756 generates a suitable minor tick interval.
759 return _plplotc.plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
761 def plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz):
763 Draw a box with axes, etc, in 3-d
767 Draws axes, numeric and text labels for a three-dimensional surface
768 plot. For a more complete description of three-dimensional plotting
769 see the PLplot documentation.
771 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,
772 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
775 This function is used in examples 8, 11, 18, and 21.
781 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
785 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
786 options for the x axis. The string can include any combination of
787 the following letters (upper or lower case) in any order: b: Draws
788 axis at base, at height z=
789 zmin where zmin is defined by call to plw3d. This character must be
790 specified in order to use any of the other options.
791 d: Plot labels as date / time. Values are assumed to be
792 seconds since the epoch (as used by gmtime).
793 f: Always use fixed point numeric labels.
794 i: Inverts tick marks, so they are drawn downwards, rather
796 l: Labels axis logarithmically. This only affects the labels,
797 not the data, and so it is necessary to compute the logarithms
798 of data points before passing them to any of the drawing
800 n: Writes numeric labels at major tick intervals.
801 o: Use custom labelling function to generate axis label text.
802 The custom labelling function can be defined with the
803 plslabelfunc command.
804 s: Enables subticks between major ticks, only valid if t is
806 t: Draws major ticks.
807 u: If this is specified, the text label for the axis is
808 written under the axis.
811 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
812 the text label for the x axis. It is only drawn if u is in the
815 xtick (PLFLT, input) : World coordinate interval between major
816 ticks on the x axis. If it is set to zero, PLplot automatically
817 generates a suitable tick interval.
819 nxsub (PLINT, input) : Number of subintervals between major x axis
820 ticks for minor ticks. If it is set to zero, PLplot automatically
821 generates a suitable minor tick interval.
823 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
824 options for the y axis. The string is interpreted in the same way
827 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
828 the text label for the y axis. It is only drawn if u is in the
831 ytick (PLFLT, input) : World coordinate interval between major
832 ticks on the y axis. If it is set to zero, PLplot automatically
833 generates a suitable tick interval.
835 nysub (PLINT, input) : Number of subintervals between major y axis
836 ticks for minor ticks. If it is set to zero, PLplot automatically
837 generates a suitable minor tick interval.
839 zopt (PLCHAR_VECTOR, input) : An ascii character string specifying
840 options for the z axis. The string can include any combination of
841 the following letters (upper or lower case) in any order: b: Draws
842 z axis to the left of the surface plot.
843 c: Draws z axis to the right of the surface plot.
844 d: Draws grid lines parallel to the x-y plane behind the
845 figure. These lines are not drawn until after plot3d or
846 plmesh are called because of the need for hidden line removal.
847 e: Plot labels as date / time. Values are assumed to be
848 seconds since the epoch (as used by gmtime). Note this
849 suboption is interpreted the same as the d suboption for xopt
850 and yopt, but it has to be identified as e for zopt since d
851 has already been used for the different purpose above.
852 f: Always use fixed point numeric labels.
853 i: Inverts tick marks, so they are drawn away from the center.
854 l: Labels axis logarithmically. This only affects the labels,
855 not the data, and so it is necessary to compute the logarithms
856 of data points before passing them to any of the drawing
858 m: Writes numeric labels at major tick intervals on the
860 n: Writes numeric labels at major tick intervals on the
862 o: Use custom labelling function to generate axis label text.
863 The custom labelling function can be defined with the
864 plslabelfunc command.
865 s: Enables subticks between major ticks, only valid if t is
867 t: Draws major ticks.
868 u: If this is specified, the text label is written beside the
870 v: If this is specified, the text label is written beside the
874 zlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
875 the text label for the z axis. It is only drawn if u or v are in
878 ztick (PLFLT, input) : World coordinate interval between major
879 ticks on the z axis. If it is set to zero, PLplot automatically
880 generates a suitable tick interval.
882 nzsub (PLINT, input) : Number of subintervals between major z axis
883 ticks for minor ticks. If it is set to zero, PLplot automatically
884 generates a suitable minor tick interval.
887 return _plplotc.plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz)
891 Calculate world coordinates and corresponding window index from relative device coordinates
895 Calculate world coordinates, wx and wy, and corresponding window index
896 from relative device coordinates, rx and ry.
898 Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
901 This function is used in example 31.
907 plcalc_world(rx, ry, wx, wy, window)
911 rx (PLFLT, input) : Input relative device coordinate (0.0-1.0) for
914 ry (PLFLT, input) : Input relative device coordinate (0.0-1.0) for
917 wx (PLFLT_NC_SCALAR, output) : Returned value of the x world
918 coordinate corresponding to the relative device coordinates rx and
921 wy (PLFLT_NC_SCALAR, output) : Returned value of the y world
922 coordinate corresponding to the relative device coordinates rx and
925 window (PLINT_NC_SCALAR, output) : Returned value of the last
926 defined window index that corresponds to the input relative device
927 coordinates (and the returned world coordinates). To give some
928 background on the window index, for each page the initial window
929 index is set to zero, and each time plwind is called within the
930 page, world and device coordinates are stored for the window and
931 the window index is incremented. Thus, for a simple page layout
932 with non-overlapping viewports and one window per viewport, window
933 corresponds to the viewport index (in the order which the
934 viewport/windows were created) of the only viewport/window
935 corresponding to rx and ry. However, for more complicated layouts
936 with potentially overlapping viewports and possibly more than one
937 window (set of world coordinates) per viewport, window and the
938 corresponding output world coordinates corresponds to the last
939 window created that fulfills the criterion that the relative
940 device coordinates are inside it. Finally, in all cases where the
941 input relative device coordinates are not inside any
942 viewport/window, then the returned value of the last defined
943 window index is set to -1.
946 return _plplotc.plcalc_world(rx, ry)
950 Clear current (sub)page
954 Clears the current page, effectively erasing everything that have been
955 drawn. This command only works with interactive drivers; if the
956 driver does not support this, the page is filled with the background
957 color in use. If the current page is divided into subpages, only the
958 current subpage is erased. The nth subpage can be selected with
961 Redacted form: General: plclear()
964 This function is not used in any examples.
973 return _plplotc.plclear()
981 Sets the color index for cmap0 (see the PLplot documentation).
983 Redacted form: plcol0(icol0)
985 This function is used in examples 1-9, 11-16, 18-27, and 29.
995 icol0 (PLINT, input) : Integer representing the color. The
996 defaults at present are (these may change):
997 0 black (default background)
998 1 red (default foreground)
1014 Use plscmap0 to change the entire cmap0 color palette and plscol0 to
1015 change an individual color in the cmap0 color palette.
1018 return _plplotc.plcol0(icol0)
1026 Sets the color for cmap1 (see the PLplot documentation).
1028 Redacted form: plcol1(col1)
1030 This function is used in examples 12 and 21.
1040 col1 (PLFLT, input) : This value must be in the range (0.0-1.0) and
1041 is mapped to color using the continuous cmap1 palette which by
1042 default ranges from blue to the background color to red. The
1043 cmap1 palette can also be straightforwardly changed by the user
1044 with plscmap1 or plscmap1l.
1047 return _plplotc.plcol1(col1)
1049 def plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec):
1051 Configure the transformation between continuous and broken-down time for the current stream
1055 Configure the transformation between continuous and broken-down time
1056 for the current stream. This transformation is used by both plbtime
1059 Redacted form: General: plconfigtime(scale, offset1, offset2,
1060 ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1063 This function is used in example 29.
1069 plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1073 scale (PLFLT, input) : The number of days per continuous time unit.
1074 As a special case, if
1075 scale is 0., then all other arguments are ignored, and the result (the
1076 default used by PLplot) is the equivalent of a call to
1077 plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.).
1078 That is, for this special case broken-down time is calculated with
1079 the proleptic Gregorian calendar with no leap seconds inserted,
1080 and the continuous time is defined as the number of seconds since
1081 the Unix epoch of 1970-01-01T00:00:00Z.
1083 offset1 (PLFLT, input) : If
1084 ifbtime_offset is true, the parameters
1086 offset2 are completely ignored. Otherwise, the sum of these parameters
1087 (with units in days) specify the epoch of the continuous time
1088 relative to the MJD epoch corresponding to the Gregorian calendar
1089 date of 1858-11-17T00:00:00Z or JD = 2400000.5. Two PLFLT numbers
1090 are used to specify the origin to allow users (by specifying
1091 offset1 as an integer that can be exactly represented by a
1092 floating-point variable and specifying
1093 offset2 as a number in the range from 0. to 1) the chance to minimize
1094 the numerical errors of the continuous time representation.
1096 offset2 (PLFLT, input) : See documentation of
1099 ccontrol (PLINT, input) : ccontrol contains bits controlling the
1100 transformation. If the 0x1 bit is set, then the proleptic Julian
1101 calendar is used for broken-down time rather than the proleptic
1102 Gregorian calendar. If the 0x2 bit is set, then leap seconds that
1103 have been historically used to define UTC are inserted into the
1104 broken-down time. Other possibilities for additional control bits
1105 for ccontrol exist such as making the historical time corrections
1106 in the broken-down time corresponding to ET (ephemeris time) or
1107 making the (slightly non-constant) corrections from international
1108 atomic time (TAI) to what astronomers define as terrestrial time
1109 (TT). But those additional possibilities have not been
1110 implemented yet in the qsastime library (one of the PLplot utility
1113 ifbtime_offset (PLBOOL, input) : ifbtime_offset controls how the
1114 epoch of the continuous time scale is specified by the user. If
1115 ifbtime_offset is false, then
1117 offset2 are used to specify the epoch, and the following broken-down
1118 time parameters are completely ignored. If
1119 ifbtime_offset is true, then
1121 offset2 are completely ignored, and the following broken-down time
1122 parameters are used to specify the epoch.
1124 year (PLINT, input) : Year of epoch.
1126 month (PLINT, input) : Month of epoch in range from 0 (January) to
1129 day (PLINT, input) : Day of epoch in range from 1 to 31.
1131 hour (PLINT, input) : Hour of epoch in range from 0 to 23
1133 min (PLINT, input) : Minute of epoch in range from 0 to 59.
1135 sec (PLFLT, input) : Second of epoch in range from 0. to 60.
1138 return _plplotc.plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1146 Draws a contour plot of the data in f[
1148 ny], using the nlevel contour levels specified by clevel. Only the
1149 region of the matrix from kx to lx and from ky to ly is plotted out
1150 where all these index ranges are interpreted as one-based for
1151 historical reasons. A transformation routine pointed to by pltr with
1152 a generic pointer pltr_data for additional data required by the
1153 transformation routine is used to map indices within the matrix to the
1156 Redacted form: plcont(f, kx, lx, ky, ly, clevel, pltr, pltr_data)
1157 where (see above discussion) the pltr, pltr_data callback arguments
1158 are sometimes replaced by a tr vector with 6 elements; xg and yg
1159 vectors; or xg and yg matrices.
1161 This function is used in examples 9, 14, 16, and 22.
1167 plcont(f, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
1171 f (PLFLT_MATRIX, input) : A matrix containing data to be contoured.
1173 nx, ny (PLINT, input) : The dimensions of the matrix f.
1175 kx, lx (PLINT, input) : Range of x indices to consider where 0 <=
1176 kx-1 < lx-1 < nx. Values of kx and lx are one-based rather than
1177 zero-based for historical backwards-compatibility reasons.
1179 ky, ly (PLINT, input) : Range of y indices to consider where 0 <=
1180 ky-1 < ly-1 < ny. Values of ky and ly are one-based rather than
1181 zero-based for historical backwards-compatibility reasons.
1183 clevel (PLFLT_VECTOR, input) : A vector specifying the levels at
1184 which to draw contours.
1186 nlevel (PLINT, input) : Number of contour levels to draw.
1188 pltr (PLTRANSFORM_callback, input) : A callback function that
1189 defines the transformation between the zero-based indices of the
1190 matrix f and the world coordinates.For the C case, transformation
1191 functions are provided in the PLplot library: pltr0 for the
1192 identity mapping, and pltr1 and pltr2 for arbitrary mappings
1193 respectively defined by vectors and matrices. In addition, C
1194 callback routines for the transformation can be supplied by the
1195 user such as the mypltr function in examples/c/x09c.c which
1196 provides a general linear transformation between index coordinates
1197 and world coordinates.For languages other than C you should
1198 consult the PLplot documentation for the details concerning how
1199 PLTRANSFORM_callback arguments are interfaced. However, in
1200 general, a particular pattern of callback-associated arguments
1201 such as a tr vector with 6 elements; xg and yg vectors; or xg and
1202 yg matrices are respectively interfaced to a linear-transformation
1203 routine similar to the above mypltr function; pltr1; and pltr2.
1204 Furthermore, some of our more sophisticated bindings (see, e.g.,
1205 the PLplot documentation) support native language callbacks for
1206 handling index to world-coordinate transformations. Examples of
1207 these various approaches are given in examples/<language>x09*,
1208 examples/<language>x16*, examples/<language>x20*,
1209 examples/<language>x21*, and examples/<language>x22*, for all our
1210 supported languages.
1212 pltr_data (PLPointer, input) : Extra parameter to help pass
1213 information to pltr0, pltr1, pltr2, or whatever callback routine
1214 that is externally supplied.
1217 return _plplotc.plcont(*args)
1221 Calculate continuous time from broken-down time for the current stream
1225 Calculate continuous time, ctime, from broken-down time for the
1226 current stream. The broken-down
1227 time is specified by the following parameters: year, month, day, hour,
1228 min, and sec. This function is the inverse of plbtime.
1230 The PLplot definition of broken-down time is a calendar time that
1231 completely ignores all time zone offsets, i.e., it is the user's
1232 responsibility to apply those offsets (if so desired) before using the
1233 PLplot time API. By default broken-down time is defined using the
1234 proleptic Gregorian calendar without the insertion of leap seconds and
1235 continuous time is defined as the number of seconds since the Unix
1236 epoch of 1970-01-01T00:00:00Z. However, other definitions of
1237 broken-down and continuous time are possible, see plconfigtime which
1238 specifies that transformation for the current stream.
1240 Redacted form: General: plctime(year, month, day, hour, min, sec,
1244 This function is used in example 29.
1250 plctime(year, month, day, hour, min, sec, ctime)
1254 year (PLINT, input) : Input year.
1256 month (PLINT, input) : Input month in range from 0 (January) to 11
1259 day (PLINT, input) : Input day in range from 1 to 31.
1261 hour (PLINT, input) : Input hour in range from 0 to 23
1263 min (PLINT, input) : Input minute in range from 0 to 59.
1265 sec (PLFLT, input) : Input second in range from 0. to 60.
1267 ctime (PLFLT_NC_SCALAR, output) : Returned value of the continuous
1268 time calculated from the broken-down time specified by the
1269 previous parameters.
1272 return _plplotc.plctime(year, month, day, hour, min, sec)
1276 Copy state parameters from the reference stream to the current stream
1280 Copies state parameters from the reference stream to the current
1281 stream. Tell driver interface to map device coordinates unless flags
1284 This function is used for making save files of selected plots (e.g.
1285 from the TK driver). After initializing, you can get a copy of the
1286 current plot to the specified device by switching to this stream and
1287 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as
1288 appropriate. The plot buffer must have previously been enabled (done
1289 automatically by some display drivers, such as X).
1291 Redacted form: plcpstrm(iplsr, flags)
1293 This function is used in example 1,20.
1299 plcpstrm(iplsr, flags)
1303 iplsr (PLINT, input) : Number of reference stream.
1305 flags (PLBOOL, input) : If flags is set to true the device
1306 coordinates are not copied from the reference to current stream.
1309 return _plplotc.plcpstrm(iplsr, flags)
1313 End plotting session
1317 Ends a plotting session, tidies up all the output files, switches
1318 interactive devices back into text mode and frees up any memory that
1319 was allocated. Must be called before end of program.
1321 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a
1322 wait state after a call to plend or other functions which trigger the
1323 end of a plot page. To avoid this, use the plspause function.
1325 Redacted form: plend()
1327 This function is used in all of the examples.
1336 return _plplotc.plend()
1340 End plotting session for current stream
1344 Ends a plotting session for the current output stream only. See
1345 plsstrm for more info.
1347 Redacted form: plend1()
1349 This function is used in examples 1 and 20.
1358 return _plplotc.plend1()
1360 def plenv(xmin, xmax, ymin, ymax, just, axis):
1362 Set up standard window and draw box
1366 Sets up plotter environment for simple graphs by calling pladv and
1367 setting up viewport and window to sensible default values. plenv
1368 leaves a standard margin (left-hand margin of eight character heights,
1369 and a margin around the other three sides of five character heights)
1370 around most graphs for axis labels and a title. When these defaults
1371 are not suitable, use the individual routines plvpas, plvpor, or
1372 plvasp for setting up the viewport, plwind for defining the window,
1373 and plbox for drawing the box.
1375 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis)
1377 This function is used in example 1,3,9,13,14,19-22,29.
1383 plenv(xmin, xmax, ymin, ymax, just, axis)
1387 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1390 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1393 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1396 ymax (PLFLT, input) : Value of y at top edge of window (in world
1399 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1400 scales will not be set, the user must set up the scale before
1401 calling plenv using plsvpa, plvasp or other.
1402 0: the x and y axes are scaled independently to use as much of
1403 the screen as possible.
1404 1: the scales of the x and y axes are made equal.
1405 2: the axis of the x and y axes are made equal, and the plot
1409 axis (PLINT, input) : Controls drawing of the box around the plot:
1410 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1412 0: draw box, ticks, and numeric tick labels.
1413 1: also draw coordinate axes at x=0 and y=0.
1414 2: also draw a grid at major tick positions in both
1416 3: also draw a grid at minor tick positions in both
1418 10: same as 0 except logarithmic x tick marks. (The x data
1419 have to be converted to logarithms separately.)
1420 11: same as 1 except logarithmic x tick marks. (The x data
1421 have to be converted to logarithms separately.)
1422 12: same as 2 except logarithmic x tick marks. (The x data
1423 have to be converted to logarithms separately.)
1424 13: same as 3 except logarithmic x tick marks. (The x data
1425 have to be converted to logarithms separately.)
1426 20: same as 0 except logarithmic y tick marks. (The y data
1427 have to be converted to logarithms separately.)
1428 21: same as 1 except logarithmic y tick marks. (The y data
1429 have to be converted to logarithms separately.)
1430 22: same as 2 except logarithmic y tick marks. (The y data
1431 have to be converted to logarithms separately.)
1432 23: same as 3 except logarithmic y tick marks. (The y data
1433 have to be converted to logarithms separately.)
1434 30: same as 0 except logarithmic x and y tick marks. (The x
1435 and y data have to be converted to logarithms separately.)
1436 31: same as 1 except logarithmic x and y tick marks. (The x
1437 and y data have to be converted to logarithms separately.)
1438 32: same as 2 except logarithmic x and y tick marks. (The x
1439 and y data have to be converted to logarithms separately.)
1440 33: same as 3 except logarithmic x and y tick marks. (The x
1441 and y data have to be converted to logarithms separately.)
1442 40: same as 0 except date / time x labels.
1443 41: same as 1 except date / time x labels.
1444 42: same as 2 except date / time x labels.
1445 43: same as 3 except date / time x labels.
1446 50: same as 0 except date / time y labels.
1447 51: same as 1 except date / time y labels.
1448 52: same as 2 except date / time y labels.
1449 53: same as 3 except date / time y labels.
1450 60: same as 0 except date / time x and y labels.
1451 61: same as 1 except date / time x and y labels.
1452 62: same as 2 except date / time x and y labels.
1453 63: same as 3 except date / time x and y labels.
1454 70: same as 0 except custom x and y labels.
1455 71: same as 1 except custom x and y labels.
1456 72: same as 2 except custom x and y labels.
1457 73: same as 3 except custom x and y labels.
1460 return _plplotc.plenv(xmin, xmax, ymin, ymax, just, axis)
1462 def plenv0(xmin, xmax, ymin, ymax, just, axis):
1464 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it
1468 Sets up plotter environment for simple graphs by calling pladv and
1469 setting up viewport and window to sensible default values. plenv0
1470 leaves a standard margin (left-hand margin of eight character heights,
1471 and a margin around the other three sides of five character heights)
1472 around most graphs for axis labels and a title. When these defaults
1473 are not suitable, use the individual routines plvpas, plvpor, or
1474 plvasp for setting up the viewport, plwind for defining the window,
1475 and plbox for drawing the box.
1477 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis)
1479 This function is used in example 21.
1485 plenv0(xmin, xmax, ymin, ymax, just, axis)
1489 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1492 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1495 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1498 ymax (PLFLT, input) : Value of y at top edge of window (in world
1501 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1502 scales will not be set, the user must set up the scale before
1503 calling plenv0 using plsvpa, plvasp or other.
1504 0: the x and y axes are scaled independently to use as much of
1505 the screen as possible.
1506 1: the scales of the x and y axes are made equal.
1507 2: the axis of the x and y axes are made equal, and the plot
1511 axis (PLINT, input) : Controls drawing of the box around the plot:
1512 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1514 0: draw box, ticks, and numeric tick labels.
1515 1: also draw coordinate axes at x=0 and y=0.
1516 2: also draw a grid at major tick positions in both
1518 3: also draw a grid at minor tick positions in both
1520 10: same as 0 except logarithmic x tick marks. (The x data
1521 have to be converted to logarithms separately.)
1522 11: same as 1 except logarithmic x tick marks. (The x data
1523 have to be converted to logarithms separately.)
1524 12: same as 2 except logarithmic x tick marks. (The x data
1525 have to be converted to logarithms separately.)
1526 13: same as 3 except logarithmic x tick marks. (The x data
1527 have to be converted to logarithms separately.)
1528 20: same as 0 except logarithmic y tick marks. (The y data
1529 have to be converted to logarithms separately.)
1530 21: same as 1 except logarithmic y tick marks. (The y data
1531 have to be converted to logarithms separately.)
1532 22: same as 2 except logarithmic y tick marks. (The y data
1533 have to be converted to logarithms separately.)
1534 23: same as 3 except logarithmic y tick marks. (The y data
1535 have to be converted to logarithms separately.)
1536 30: same as 0 except logarithmic x and y tick marks. (The x
1537 and y data have to be converted to logarithms separately.)
1538 31: same as 1 except logarithmic x and y tick marks. (The x
1539 and y data have to be converted to logarithms separately.)
1540 32: same as 2 except logarithmic x and y tick marks. (The x
1541 and y data have to be converted to logarithms separately.)
1542 33: same as 3 except logarithmic x and y tick marks. (The x
1543 and y data have to be converted to logarithms separately.)
1544 40: same as 0 except date / time x labels.
1545 41: same as 1 except date / time x labels.
1546 42: same as 2 except date / time x labels.
1547 43: same as 3 except date / time x labels.
1548 50: same as 0 except date / time y labels.
1549 51: same as 1 except date / time y labels.
1550 52: same as 2 except date / time y labels.
1551 53: same as 3 except date / time y labels.
1552 60: same as 0 except date / time x and y labels.
1553 61: same as 1 except date / time x and y labels.
1554 62: same as 2 except date / time x and y labels.
1555 63: same as 3 except date / time x and y labels.
1556 70: same as 0 except custom x and y labels.
1557 71: same as 1 except custom x and y labels.
1558 72: same as 2 except custom x and y labels.
1559 73: same as 3 except custom x and y labels.
1562 return _plplotc.plenv0(xmin, xmax, ymin, ymax, just, axis)
1570 Clears the graphics screen of an interactive device, or ejects a page
1571 on a plotter. See plbop for more information.
1573 Redacted form: pleop()
1575 This function is used in example 2,14.
1584 return _plplotc.pleop()
1588 Draw error bars in x direction
1592 Draws a set of n error bars in x direction, the i'th error bar
1593 extending from xmin[i] to xmax[i] at y coordinate y[i]. The terminals
1594 of the error bars are of length equal to the minor tick length
1595 (settable using plsmin).
1597 Redacted form: General: plerrx(xmin, ymax, y)
1600 This function is used in example 29.
1606 plerrx(n, xmin, xmax, y)
1610 n (PLINT, input) : Number of error bars to draw.
1612 xmin (PLFLT_VECTOR, input) : A vector containing the x coordinates
1613 of the left-hand endpoints of the error bars.
1615 xmax (PLFLT_VECTOR, input) : A vector containing the x coordinates
1616 of the right-hand endpoints of the error bars.
1618 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1622 return _plplotc.plerrx(n, arg2, arg3)
1626 Draw error bars in the y direction
1630 Draws a set of n error bars in the y direction, the i'th error bar
1631 extending from ymin[i] to ymax[i] at x coordinate x[i]. The terminals
1632 of the error bars are of length equal to the minor tick length
1633 (settable using plsmin).
1635 Redacted form: General: plerry(x, ymin, ymax)
1638 This function is used in example 29.
1644 plerry(n, x, ymin, ymax)
1648 n (PLINT, input) : Number of error bars to draw.
1650 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1653 ymin (PLFLT_VECTOR, input) : A vector containing the y coordinates
1654 of the lower endpoints of the error bars.
1656 ymax (PLFLT_VECTOR, input) : A vector containing the y coordinates
1657 of the upper endpoints of the error bars.
1660 return _plplotc.plerry(n, arg2, arg3)
1664 Advance to the next family file on the next new page
1668 Advance to the next family file on the next new page.
1670 Redacted form: plfamadv()
1672 This function is not used in any examples.
1681 return _plplotc.plfamadv()
1689 Fills the polygon defined by the n points (
1691 y[i]) using the pattern defined by plpsty or plpat. The default fill
1692 style is a solid fill. The routine will automatically close the
1693 polygon between the last and first vertices. If multiple closed
1694 polygons are passed in x and y then plfill will fill in between them.
1696 Redacted form: plfill(x,y)
1698 This function is used in examples 12, 13, 15, 16, 21, 24, and 25.
1708 n (PLINT, input) : Number of vertices in polygon.
1710 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1713 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1717 return _plplotc.plfill(n, ArrayCk)
1721 Draw filled polygon in 3D
1725 Fills the 3D polygon defined by the n points in the x, y, and z
1726 vectors using the pattern defined by plpsty or plpat. The routine
1727 will automatically close the polygon between the last and first
1728 vertices. If multiple closed polygons are passed in x, y, and z then
1729 plfill3 will fill in between them.
1731 Redacted form: General: plfill3(x, y, z)
1734 This function is used in example 15.
1744 n (PLINT, input) : Number of vertices in polygon.
1746 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1749 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1752 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
1756 return _plplotc.plfill3(n, arg2, arg3)
1760 Draw linear gradient inside polygon
1764 Draw a linear gradient using cmap1 inside the polygon defined by the n
1767 y[i]). Interpretation of the polygon is the same as for plfill. The
1768 polygon coordinates and the gradient angle are all expressed in world
1769 coordinates. The angle from the x axis for both the rotated
1770 coordinate system and the gradient vector is specified by angle. The
1771 magnitude of the gradient vector is the difference between the maximum
1772 and minimum values of x for the vertices in the rotated coordinate
1773 system. The origin of the gradient vector can be interpreted as being
1774 anywhere on the line corresponding to the minimum x value for the
1775 vertices in the rotated coordinate system. The distance along the
1776 gradient vector is linearly transformed to the independent variable of
1777 color map 1 which ranges from 0. at the tail of the gradient vector to
1778 1. at the head of the gradient vector. What is drawn is the RGBA
1779 color corresponding to the independent variable of cmap1. For more
1780 information about cmap1 (see the PLplot documentation).
1782 Redacted form: plgradient(x,y,angle)
1784 This function is used in examples 25 and 30.
1790 plgradient(n, x, y, angle)
1794 n (PLINT, input) : Number of vertices in polygon.
1796 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1799 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1802 angle (PLFLT, input) : Angle (degrees) of gradient vector from x
1806 return _plplotc.plgradient(n, ArrayCk, angle)
1810 Flushes the output stream
1814 Flushes the output stream. Use sparingly, if at all.
1816 Redacted form: plflush()
1818 This function is used in examples 1 and 14.
1827 return _plplotc.plflush()
1835 Sets the font used for subsequent text and symbols. For devices that
1836 still use Hershey fonts this routine has no effect unless the Hershey
1837 fonts with extended character set are loaded (see plfontld). For
1838 unicode-aware devices that use system fonts instead of Hershey fonts,
1839 this routine calls the plsfci routine with argument set up
1840 appropriately for the various cases below. However, this method of
1841 specifying the font for unicode-aware devices is deprecated, and the
1842 much more flexible method of calling plsfont directly is recommended
1843 instead (where plsfont provides a user-friendly interface to plsfci),
1845 Redacted form: plfont(ifont)
1847 This function is used in examples 1, 2, 4, 7, 13, 24, and 26.
1857 ifont (PLINT, input) : Specifies the font: 1: Sans serif font
1858 (simplest and fastest)
1864 return _plplotc.plfont(ifont)
1872 Loads the Hershey fonts used for text and symbols. This routine may
1873 be called before or after initializing PLplot. If not explicitly
1874 called before PLplot initialization, then by default that
1875 initialization loads Hershey fonts with the extended character set.
1876 This routine only has a practical effect for devices that still use
1877 Hershey fonts (as opposed to modern devices that use unicode-aware
1878 system fonts instead of Hershey fonts).
1880 Redacted form: plfontld(fnt)
1882 This function is used in examples 1 and 7.
1892 fnt (PLINT, input) : Specifies the type of Hershey fonts to load.
1893 A zero value specifies Hershey fonts with the standard character
1894 set and a non-zero value (the default assumed if plfontld is never
1895 called) specifies Hershey fonts with the extended character set.
1898 return _plplotc.plfontld(fnt)
1902 Get character default height and current (scaled) height
1906 Get character default height and current (scaled) height.
1908 Redacted form: plgchr(p_def, p_ht)
1910 This function is used in example 23.
1920 p_def (PLFLT_NC_SCALAR, output) : Returned value of the default
1921 character height (mm).
1923 p_ht (PLFLT_NC_SCALAR, output) : Returned value of the scaled
1924 character height (mm).
1927 return _plplotc.plgchr()
1931 Returns 8-bit RGB values for given color index from cmap0
1935 Returns 8-bit RGB values (0-255) for given color from cmap0 (see the
1936 PLplot documentation). Values are negative if an invalid color id is
1939 Redacted form: plgcol0(icol0, r, g, b)
1941 This function is used in example 2.
1947 plgcol0(icol0, r, g, b)
1951 icol0 (PLINT, input) : Index of desired cmap0 color.
1953 r (PLINT_NC_SCALAR, output) : Returned value of the 8-bit red
1956 g (PLINT_NC_SCALAR, output) : Returned value of the 8-bit green
1959 b (PLINT_NC_SCALAR, output) : Returned value of the 8-bit blue
1963 return _plplotc.plgcol0(icol0)
1967 Returns 8-bit RGB values and PLFLT alpha transparency value for given color index from cmap0
1971 Returns 8-bit RGB values (0-255) and PLFLT alpha transparency value
1972 (0.0-1.0) for given color from cmap0 (see the PLplot documentation).
1973 Values are negative if an invalid color id is given.
1975 Redacted form: plgcola(r, g, b)
1977 This function is used in example 30.
1983 plgcol0a(icol0, r, g, b, alpha)
1987 icol0 (PLINT, input) : Index of desired cmap0 color.
1989 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
1990 in the range from 0 to 255.
1992 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
1993 in the range from 0 to 255.
1995 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
1996 in the range from 0 to 255.
1998 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
1999 transparency in the range from (0.0-1.0).
2002 return _plplotc.plgcol0a(icol0)
2006 Returns the background color (cmap0[0]) by 8-bit RGB value
2010 Returns the background color (cmap0[0]) by 8-bit RGB value.
2012 Redacted form: plgcolbg(r, g, b)
2014 This function is used in example 31.
2024 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2025 in the range from 0 to 255.
2027 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2028 in the range from 0 to 255.
2030 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2031 in the range from 0 to 255.
2034 return _plplotc.plgcolbg()
2038 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT alpha transparency value
2042 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT
2043 alpha transparency value.
2045 This function is used in example 31.
2051 plgcolbga(r, g, b, alpha)
2055 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2056 in the range from 0 to 255.
2058 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2059 in the range from 0 to 255.
2061 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2062 in the range from 0 to 255.
2064 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
2065 transparency in the range (0.0-1.0).
2068 return _plplotc.plgcolbga()
2072 Get the current device-compression setting
2076 Get the current device-compression setting. This parameter is only
2077 used for drivers that provide compression.
2079 Redacted form: plgcompression(compression)
2081 This function is used in example 31.
2087 plgcompression(compression)
2091 compression (PLINT_NC_SCALAR, output) : Returned value of the
2092 compression setting for the current device.
2095 return _plplotc.plgcompression()
2099 Get the current device (keyword) name
2103 Get the current device (keyword) name. Note: you must have allocated
2104 space for this (80 characters is safe).
2106 Redacted form: plgdev(p_dev)
2108 This function is used in example 14.
2118 p_dev (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2119 (with preallocated length of 80 characters or more) containing the
2120 device (keyword) name.
2123 return _plplotc.plgdev()
2127 Get parameters that define current device-space window
2131 Get relative margin width, aspect ratio, and relative justification
2132 that define current device-space window. If plsdidev has not been
2133 called the default values pointed to by p_mar, p_aspect, p_jx, and
2136 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy)
2138 This function is used in example 31.
2144 plgdidev(p_mar, p_aspect, p_jx, p_jy)
2148 p_mar (PLFLT_NC_SCALAR, output) : Returned value of the relative
2151 p_aspect (PLFLT_NC_SCALAR, output) : Returned value of the aspect
2154 p_jx (PLFLT_NC_SCALAR, output) : Returned value of the relative
2157 p_jy (PLFLT_NC_SCALAR, output) : Returned value of the relative
2161 return _plplotc.plgdidev()
2165 Get plot orientation
2169 Get plot orientation parameter which is multiplied by 90 degrees to
2170 obtain the angle of rotation. Note, arbitrary rotation parameters
2171 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
2172 values for the rotation parameter are 0., 1., 2., and 3. corresponding
2173 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
2174 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has
2175 not been called the default value pointed to by p_rot will be 0.
2177 Redacted form: plgdiori(p_rot)
2179 This function is not used in any examples.
2189 p_rot (PLFLT_NC_SCALAR, output) : Returned value of the orientation
2193 return _plplotc.plgdiori()
2197 Get parameters that define current plot-space window
2201 Get relative minima and maxima that define current plot-space window.
2202 If plsdiplt has not been called the default values pointed to by
2203 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1.
2205 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2207 This function is used in example 31.
2213 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2217 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2220 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2223 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2226 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2230 return _plplotc.plgdiplt()
2234 Get family file parameters
2238 Gets information about current family file, if familying is enabled.
2239 See the PLplot documentation for more information.
2241 Redacted form: plgfam(p_fam, p_num, p_bmax)
2243 This function is used in examples 14 and 31.
2249 plgfam(p_fam, p_num, p_bmax)
2253 p_fam (PLINT_NC_SCALAR, output) : Returned value of the current
2254 family flag value. If nonzero, familying is enabled for the
2257 p_num (PLINT_NC_SCALAR, output) : Returned value of the current
2260 p_bmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2261 file size (in bytes) for a family file.
2264 return _plplotc.plgfam()
2268 Get FCI (font characterization integer)
2272 Gets information about the current font using the FCI approach. See
2273 the PLplot documentation for more information.
2275 Redacted form: plgfci(p_fci)
2277 This function is used in example 23.
2287 p_fci (PLUNICODE_NC_SCALAR, output) : Returned value of the current
2291 return _plplotc.plgfci()
2295 Get output file name
2299 Gets the current output file name, if applicable.
2301 Redacted form: plgfnam(fnam)
2303 This function is used in example 31.
2313 fnam (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2314 (with preallocated length of 80 characters or more) containing the
2318 return _plplotc.plgfnam()
2322 Get family, style and weight of the current font
2326 Gets information about current font. See the PLplot documentation for
2327 more information on font selection.
2329 Redacted form: plgfont(p_family, p_style, p_weight)
2331 This function is used in example 23.
2337 plgfont(p_family, p_style, p_weight)
2341 p_family (PLINT_NC_SCALAR, output) : Returned value of the current
2342 font family. The available values are given by the PL_FCI_*
2343 constants in plplot.h. Current options are PL_FCI_SANS,
2344 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If
2345 p_family is NULL then the font family is not returned.
2347 p_style (PLINT_NC_SCALAR, output) : Returned value of the current
2348 font style. The available values are given by the PL_FCI_*
2349 constants in plplot.h. Current options are PL_FCI_UPRIGHT,
2350 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the font
2351 style is not returned.
2353 p_weight (PLINT_NC_SCALAR, output) : Returned value of the current
2354 font weight. The available values are given by the PL_FCI_*
2355 constants in plplot.h. Current options are PL_FCI_MEDIUM and
2356 PL_FCI_BOLD. If p_weight is NULL then the font weight is not
2360 return _plplotc.plgfont()
2364 Get the (current) run level
2368 Get the (current) run level. Valid settings are: 0, uninitialized
2371 3, world coordinates defined
2374 Redacted form: plglevel(p_level)
2376 This function is used in example 31.
2386 p_level (PLINT_NC_SCALAR, output) : Returned value of the run
2390 return _plplotc.plglevel()
2398 Gets the current page configuration. The length and offset values are
2399 expressed in units that are specific to the current driver. For
2400 instance: screen drivers will usually interpret them as number of
2401 pixels, whereas printer drivers will usually use mm.
2403 Redacted form: plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2405 This function is used in examples 14 and 31.
2411 plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2415 p_xp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2416 pixels/inch (DPI) in x.
2418 p_yp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2419 pixels/inch (DPI) in y.
2421 p_xleng (PLINT_NC_SCALAR, output) : Returned value of the x page
2424 p_yleng (PLINT_NC_SCALAR, output) : Returned value of the y page
2427 p_xoff (PLINT_NC_SCALAR, output) : Returned value of the x page
2430 p_yoff (PLINT_NC_SCALAR, output) : Returned value of the y page
2434 return _plplotc.plgpage()
2438 Switch to graphics screen
2442 Sets an interactive device to graphics mode, used in conjunction with
2443 pltext to allow graphics and text to be interspersed. On a device
2444 which supports separate text and graphics windows, this command causes
2445 control to be switched to the graphics window. If already in graphics
2446 mode, this command is ignored. It is also ignored on devices which
2447 only support a single window or use a different method for shifting
2448 focus. See also pltext.
2450 Redacted form: plgra()
2452 This function is used in example 1.
2461 return _plplotc.plgra()
2465 Grid data from irregularly sampled data
2469 Real world data is frequently irregularly sampled, but PLplot 3D plots
2470 require data organized as a grid, i.e., with x sample point values
2471 independent of y coordinate and vice versa. This function takes
2472 irregularly sampled data from the x[npts], y[npts], and z[npts]
2473 vectors; reads the desired grid location from the input vectors
2474 xg[nptsx] and yg[nptsy]; and returns the interpolated result on that
2475 grid using the output matrix zg[nptsx][nptsy]. The algorithm used to
2476 interpolate the data to the grid is specified with the argument type
2477 which can have one parameter specified in argument data.
2479 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data)
2480 Python: zg=plgriddata(x, y, z, xg, yg, type, data)
2483 This function is used in example 21.
2489 plgriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
2493 x (PLFLT_VECTOR, input) : The input x vector.
2495 y (PLFLT_VECTOR, input) : The input y vector.
2497 z (PLFLT_VECTOR, input) : The input z vector. Each triple x[i],
2498 y[i], z[i] represents one data sample coordinate.
2500 npts (PLINT, input) : The number of data samples in the x, y and z
2503 xg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2504 in the x direction. Usually xg has nptsx equally spaced values
2505 from the minimum to the maximum values of the x input vector.
2507 nptsx (PLINT, input) : The number of points in the xg vector.
2509 yg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2510 in the y direction. Similar to the xg parameter.
2512 nptsy (PLINT, input) : The number of points in the yg vector.
2514 zg (PLFLT_NC_MATRIX, output) : The matrix of interpolated results
2515 where data lies in the grid specified by xg and yg. Therefore the
2516 zg matrix must be dimensioned
2520 type (PLINT, input) : The type of grid interpolation algorithm to
2521 use, which can be: GRID_CSA: Bivariate Cubic Spline approximation
2522 GRID_DTLI: Delaunay Triangulation Linear Interpolation
2523 GRID_NNI: Natural Neighbors Interpolation
2524 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
2525 GRID_NNLI: Nearest Neighbors Linear Interpolation
2526 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
2528 For details of the algorithms read the source file plgridd.c.
2530 data (PLFLT, input) : Some gridding algorithms require extra data,
2531 which can be specified through this argument. Currently, for
2532 algorithm: GRID_NNIDW, data specifies the number of neighbors to
2533 use, the lower the value, the noisier (more local) the
2535 GRID_NNLI, data specifies what a thin triangle is, in the
2536 range [1. .. 2.]. High values enable the usage of very thin
2537 triangles for interpolation, possibly resulting in error in
2539 GRID_NNI, only weights greater than data will be accepted. If
2540 0, all weights will be accepted.
2543 return _plplotc.plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data)
2547 Get current subpage parameters
2551 Gets the size of the current subpage in millimeters measured from the
2552 bottom left hand corner of the output device page or screen. Can be
2553 used in conjunction with plsvpa for setting the size of a viewport in
2554 absolute coordinates (millimeters).
2556 Redacted form: plgspa(xmin, xmax, ymin, ymax)
2558 This function is used in example 23.
2564 plgspa(xmin, xmax, ymin, ymax)
2568 xmin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2569 the left hand edge of the subpage in millimeters.
2571 xmax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2572 the right hand edge of the subpage in millimeters.
2574 ymin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2575 the bottom edge of the subpage in millimeters.
2577 ymax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2578 the top edge of the subpage in millimeters.
2581 return _plplotc.plgspa()
2585 Get current stream number
2589 Gets the number of the current output stream. See also plsstrm.
2591 Redacted form: plgstrm(p_strm)
2593 This function is used in example 1,20.
2603 p_strm (PLINT_NC_SCALAR, output) : Returned value of the current
2607 return _plplotc.plgstrm()
2611 Get the current library version number
2615 Get the current library version number. Note: you must have allocated
2616 space for this (80 characters is safe).
2618 Redacted form: plgver(p_ver)
2620 This function is used in example 1.
2630 p_ver (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2631 (with preallocated length of 80 characters or more) containing the
2632 PLplot version number.
2635 return _plplotc.plgver()
2639 Get viewport limits in normalized device coordinates
2643 Get viewport limits in normalized device coordinates.
2645 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2648 This function is used in example 31.
2654 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2658 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2659 viewport limit of the normalized device coordinate in x.
2661 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2662 viewport limit of the normalized device coordinate in x.
2664 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2665 viewport limit of the normalized device coordinate in y.
2667 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2668 viewport limit of the normalized device coordinate in y.
2671 return _plplotc.plgvpd()
2675 Get viewport limits in world coordinates
2679 Get viewport limits in world coordinates.
2681 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2684 This function is used in example 31.
2690 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2694 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2695 viewport limit of the world coordinate in x.
2697 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2698 viewport limit of the world coordinate in x.
2700 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2701 viewport limit of the world coordinate in y.
2703 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2704 viewport limit of the world coordinate in y.
2707 return _plplotc.plgvpw()
2711 Get x axis parameters
2715 Returns current values of the p_digmax and p_digits flags for the x
2716 axis. p_digits is updated after the plot is drawn, so this routine
2717 should only be called after the call to plbox (or plbox3) is complete.
2718 See the PLplot documentation for more information.
2720 Redacted form: plgxax(p_digmax, p_digits)
2722 This function is used in example 31.
2728 plgxax(p_digmax, p_digits)
2732 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2733 number of digits for the x axis. If nonzero, the printed label
2734 has been switched to a floating-point representation when the
2735 number of digits exceeds this value.
2737 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2738 number of digits for the numeric labels (x axis) from the last
2742 return _plplotc.plgxax()
2746 Get y axis parameters
2750 Identical to plgxax, except that arguments are flags for y axis. See
2751 the description of plgxax for more detail.
2753 Redacted form: plgyax(p_digmax, p_digits)
2755 This function is used in example 31.
2761 plgyax(p_digmax, p_digits)
2765 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2766 number of digits for the y axis. If nonzero, the printed label
2767 has been switched to a floating-point representation when the
2768 number of digits exceeds this value.
2770 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2771 number of digits for the numeric labels (y axis) from the last
2775 return _plplotc.plgyax()
2779 Get z axis parameters
2783 Identical to plgxax, except that arguments are flags for z axis. See
2784 the description of plgxax for more detail.
2786 Redacted form: plgzax(p_digmax, p_digits)
2788 This function is used in example 31.
2794 plgzax(p_digmax, p_digits)
2798 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2799 number of digits for the z axis. If nonzero, the printed label
2800 has been switched to a floating-point representation when the
2801 number of digits exceeds this value.
2803 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2804 number of digits for the numeric labels (z axis) from the last
2808 return _plplotc.plgzax()
2812 Plot a histogram from unbinned data
2816 Plots a histogram from n data points stored in the data vector. This
2817 routine bins the data into nbin bins equally spaced between datmin and
2818 datmax, and calls plbin to draw the resulting histogram. Parameter
2819 opt allows, among other things, the histogram either to be plotted in
2820 an existing window or causes plhist to call plenv with suitable limits
2821 before plotting the histogram.
2823 Redacted form: plhist(data, datmin, datmax, nbin, opt)
2825 This function is used in example 5.
2831 plhist(n, data, datmin, datmax, nbin, opt)
2835 n (PLINT, input) : Number of data points.
2837 data (PLFLT_VECTOR, input) : A vector containing the values of the
2840 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
2842 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
2844 nbin (PLINT, input) : Number of (equal-sized) bins into which to
2845 divide the interval xmin to xmax.
2847 opt (PLINT, input) : Is a combination of several flags:
2848 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
2849 the histogram data, the outer bins are expanded to fill up the
2850 entire x-axis, data outside the given extremes are assigned to the
2851 outer bins and bins of zero height are simply drawn.
2852 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled
2853 to fit the histogram data, without this flag, plenv is called
2854 to set the world coordinates.
2855 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
2856 extremes are not taken into account. This option should
2857 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to
2858 properly present the data.
2859 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal
2860 size as the ones inside.
2861 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn
2862 (there is a gap for such bins).
2865 return _plplotc.plhist(n, datmin, datmax, nbin, oldwin)
2869 Convert HLS color to RGB
2873 Convert HLS color coordinates to RGB.
2875 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
2878 This function is used in example 2.
2884 plhlsrgb(h, l, s, p_r, p_g, p_b)
2888 h (PLFLT, input) : Hue in degrees (0.0-360.0) on the color
2891 l (PLFLT, input) : Lightness expressed as a fraction (0.0-1.0) of
2892 the axis of the color cylinder.
2894 s (PLFLT, input) : Saturation expressed as a fraction (0.0-1.0) of
2895 the radius of the color cylinder.
2897 p_r (PLFLT_NC_SCALAR, output) : Returned value of the red intensity
2898 (0.0-1.0) of the color.
2900 p_g (PLFLT_NC_SCALAR, output) : Returned value of the green
2901 intensity (0.0-1.0) of the color.
2903 p_b (PLFLT_NC_SCALAR, output) : Returned value of the blue
2904 intensity (0.0-1.0) of the color.
2907 return _plplotc.plhlsrgb(h, l, s)
2915 Initializing the plotting package. The program prompts for the device
2916 keyword or number of the desired output device. Hitting a RETURN in
2917 response to the prompt is the same as selecting the first device.
2918 plinit will issue no prompt if either the device was specified
2919 previously (via command line flag, the plsetopt function, or the
2920 plsdev function), or if only one device is enabled when PLplot is
2921 installed. If subpages have been specified, the output device is
2922 divided into nx by ny subpages, each of which may be used
2923 independently. If plinit is called again during a program, the
2924 previously opened file will be closed. The subroutine pladv is used
2925 to advance from one subpage to the next.
2927 Redacted form: plinit()
2929 This function is used in all of the examples.
2938 return _plplotc.plinit()
2942 Draw a line between two points
2952 Redacted form: pljoin(x1,y1,x2,y2)
2954 This function is used in examples 3 and 14.
2960 pljoin(x1, y1, x2, y2)
2964 x1 (PLFLT, input) : x coordinate of first point.
2966 y1 (PLFLT, input) : y coordinate of first point.
2968 x2 (PLFLT, input) : x coordinate of second point.
2970 y2 (PLFLT, input) : y coordinate of second point.
2973 return _plplotc.pljoin(x1, y1, x2, y2)
2977 Simple routine to write labels
2981 Routine for writing simple labels. Use plmtex for more complex labels.
2983 Redacted form: pllab(xlabel, ylabel, tlabel)
2985 This function is used in examples 1, 5, 9, 12, 14-16, 20-22, and 29.
2991 pllab(xlabel, ylabel, tlabel)
2995 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2996 the label for the x axis.
2998 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2999 the label for the y axis.
3001 tlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
3002 the title of the plot.
3005 return _plplotc.pllab(xlabel, ylabel, tlabel)
3007 def pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28):
3009 Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols
3013 Routine for creating a discrete plot legend with a plotted filled box,
3014 line, and/or line of symbols for each annotated legend entry. (See
3015 plcolorbar for similar functionality for creating continuous color
3016 bars.) The arguments of pllegend provide control over the location
3017 and size of the legend as well as the location and characteristics of
3018 the elements (most of which are optional) within that legend. The
3019 resulting legend is clipped at the boundaries of the current subpage.
3020 (N.B. the adopted coordinate system used for some of the parameters is
3021 defined in the documentation of the position parameter.)
3023 Redacted form: pllegend(p_legend_width, p_legend_height, opt,
3024 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow,
3025 ncolumn, opt_array, text_offset, text_scale, text_spacing,
3026 test_justification, text_colors, text, box_colors, box_patterns,
3027 box_scales, box_line_widths, line_colors, line_styles, line_widths,
3028 symbol_colors, symbol_scales, symbol_numbers, symbols)
3030 This function is used in examples 4, 26, and 33.
3036 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)
3040 p_legend_width (PLFLT_NC_SCALAR, output) : Returned value of the
3041 legend width in adopted coordinates. This quantity is calculated
3042 from plot_width, text_offset, ncolumn (possibly modified inside
3043 the routine depending on nlegend and nrow), and the length
3044 (calculated internally) of the longest text string.
3046 p_legend_height (PLFLT_NC_SCALAR, output) : Returned value of the
3047 legend height in adopted coordinates. This quantity is calculated
3048 from text_scale, text_spacing, and nrow (possibly modified inside
3049 the routine depending on nlegend and nrow).
3051 opt (PLINT, input) : opt contains bits controlling the overall
3052 legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area
3053 on the left of the legend and the plotted area on the right.
3054 Otherwise, put the text area on the right of the legend and the
3055 plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set,
3056 plot a (semitransparent) background for the legend. If the
3057 PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the
3058 legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the
3059 possibly internally transformed) nrow > 1 and ncolumn > 1, then
3060 plot the resulting array of legend entries in row-major order.
3061 Otherwise, plot the legend entries in column-major order.
3063 position (PLINT, input) : position contains bits which control the
3064 overall position of the legend and the definition of the adopted
3065 coordinates used for positions just like what is done for the
3066 position argument for plcolorbar. However, note that the defaults
3067 for the position bits (see below) are different than the
3068 plcolorbar case. The combination of the PL_POSITION_LEFT,
3069 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3070 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3071 the 16 possible standard positions (the 4 corners and centers of
3072 the 4 sides for both the inside and outside cases) of the legend
3073 relative to the adopted coordinate system. The corner positions
3074 are specified by the appropriate combination of two of the
3075 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3076 PL_POSITION_BOTTOM bits while the sides are specified by a single
3077 value of one of those bits. The adopted coordinates are
3078 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3079 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3080 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3081 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3082 then use the combination of PL_POSITION_RIGHT and PL_POSITION_TOP.
3083 If neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set,
3084 use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or
3085 PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT.
3087 x (PLFLT, input) : X offset of the legend position in adopted
3088 coordinates from the specified standard position of the legend.
3089 For positive x, the direction of motion away from the standard
3090 position is inward/outward from the standard corner positions or
3091 standard left or right positions if the
3092 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3093 For the standard top or bottom positions, the direction of motion
3094 is toward positive X.
3096 y (PLFLT, input) : Y offset of the legend position in adopted
3097 coordinates from the specified standard position of the legend.
3098 For positive y, the direction of motion away from the standard
3099 position is inward/outward from the standard corner positions or
3100 standard top or bottom positions if the
3101 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. For
3102 the standard left or right positions, the direction of motion is
3105 plot_width (PLFLT, input) : Horizontal width in adopted coordinates
3106 of the plot area (where the colored boxes, lines, and/or lines of
3107 symbols are drawn) of the legend.
3109 bg_color (PLINT, input) : The cmap0 color of the background for the
3110 legend (PL_LEGEND_BACKGROUND).
3112 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3113 for the legend (PL_LEGEND_BOUNDING_BOX).
3115 bb_style (PLINT, input) : The pllsty style number for the
3116 bounding-box line for the legend (PL_LEGEND_BACKGROUND).
3118 nrow (PLINT, input) : The number of rows in the matrix used to
3120 nlegend legend entries. For internal transformations of
3121 nrow, see further remarks under
3124 ncolumn (PLINT, input) : The number of columns in the matrix used
3126 nlegend legend entries. For internal transformations of
3127 ncolumn, see further remarks under
3130 nlegend (PLINT, input) : Number of legend entries. The above
3132 ncolumn values are transformed internally to be consistent with
3135 ncolumn is non-positive it is replaced by 1. If the resulting product
3138 ncolumn is less than
3139 nlegend, the smaller of the two (or
3142 ncolumn) is increased so the product is >=
3143 nlegend. Thus, for example, the common
3145 ncolumn = 0 case is transformed internally to
3148 ncolumn = 1; i.e., the usual case of a legend rendered as a single
3151 opt_array (PLINT_VECTOR, input) : A vector of
3152 nlegend values of options to control each individual plotted area
3153 corresponding to a legend entry. If the
3154 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted
3156 PL_LEGEND_COLOR_BOX,
3157 PL_LEGEND_LINE, and/or
3158 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
3159 entry is plotted with a colored box; a line; and/or a line of
3162 text_offset (PLFLT, input) : Offset of the text area from the plot
3163 area in units of character width.
3165 text_scale (PLFLT, input) : Character height scale for text
3168 text_spacing (PLFLT, input) : Vertical spacing in units of the
3169 character height from one legend entry to the next.
3171 text_justification (PLFLT, input) : Justification parameter used
3172 for text justification. The most common values of
3173 text_justification are 0., 0.5, or 1. corresponding to a text that
3174 is left justified, centred, or right justified within the text
3175 area, but other values are allowed as well.
3177 text_colors (PLINT_VECTOR, input) : A vector containing
3178 nlegend cmap0 text colors.
3180 text (PLCHAR_MATRIX, input) : A vector of
3181 nlegend UTF-8 character strings containing the legend annotations.
3183 box_colors (PLINT_VECTOR, input) : A vector containing
3184 nlegend cmap0 colors for the discrete colored boxes (
3185 PL_LEGEND_COLOR_BOX).
3187 box_patterns (PLINT_VECTOR, input) : A vector containing
3188 nlegend patterns (plpsty indices) for the discrete colored boxes (
3189 PL_LEGEND_COLOR_BOX).
3191 box_scales (PLFLT_VECTOR, input) : A vector containing
3192 nlegend scales (units of fraction of character height) for the height
3193 of the discrete colored boxes (
3194 PL_LEGEND_COLOR_BOX).
3196 box_line_widths (PLFLT_VECTOR, input) : A vector containing
3197 nlegend line widths for the patterns specified by box_patterns (
3198 PL_LEGEND_COLOR_BOX).
3200 line_colors (PLINT_VECTOR, input) : A vector containing
3201 nlegend cmap0 line colors (
3204 line_styles (PLINT_VECTOR, input) : A vector containing
3205 nlegend line styles (plsty indices) (
3208 line_widths (PLFLT_VECTOR, input) : A vector containing
3209 nlegend line widths (
3212 symbol_colors (PLINT_VECTOR, input) : A vector containing
3213 nlegend cmap0 symbol colors (
3216 symbol_scales (PLFLT_VECTOR, input) : A vector containing
3217 nlegend scale values for the symbol height (
3220 symbol_numbers (PLINT_VECTOR, input) : A vector containing
3221 nlegend numbers of symbols to be drawn across the width of the plotted
3225 symbols (PLCHAR_MATRIX, input) : A vector of
3226 nlegend UTF-8 character strings containing the legend symbols. (
3230 return _plplotc.pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28)
3232 def plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk):
3234 Plot color bar for image, shade or gradient plots
3238 Routine for creating a continuous color bar for image, shade, or
3239 gradient plots. (See pllegend for similar functionality for creating
3240 legends with discrete elements). The arguments of plcolorbar provide
3241 control over the location and size of the color bar as well as the
3242 location and characteristics of the elements (most of which are
3243 optional) within that color bar. The resulting color bar is clipped
3244 at the boundaries of the current subpage. (N.B. the adopted coordinate
3245 system used for some of the parameters is defined in the documentation
3246 of the position parameter.)
3248 Redacted form: plcolorbar(p_colorbar_width, p_colorbar_height, opt,
3249 position, x, y, x_length, y_length, bg_color, bb_color, bb_style,
3250 low_cap_color, high_cap_color, cont_color, cont_width, label_opts,
3251 labels, axis_opts, ticks, sub_ticks, values)
3253 This function is used in examples 16 and 33.
3259 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)
3263 p_colorbar_width (PLFLT_NC_SCALAR, output) : Returned value of the
3264 labelled and decorated color bar width in adopted coordinates.
3266 p_colorbar_height (PLFLT_NC_SCALAR, output) : Returned value of the
3267 labelled and decorated color bar height in adopted coordinates.
3269 opt (PLINT, input) : opt contains bits controlling the overall
3270 color bar. The orientation (direction of the maximum value) of
3271 the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
3272 PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM. If none of these bits are
3273 specified, the default orientation is toward the top if the
3274 colorbar is placed on the left or right of the viewport or toward
3275 the right if the colorbar is placed on the top or bottom of the
3276 viewport. If the PL_COLORBAR_BACKGROUND bit is set, plot a
3277 (semitransparent) background for the color bar. If the
3278 PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the
3279 color bar. The type of color bar must be specified with one of
3280 PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If
3281 more than one of those bits is set only the first one in the above
3282 list is honored. The position of the (optional) label/title can be
3283 specified with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT, or
3284 PL_LABEL_BOTTOM. If no label position bit is set then no label
3285 will be drawn. If more than one of this list of bits is specified,
3286 only the first one on the list is honored. End-caps for the color
3287 bar can added with PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.
3288 If a particular color bar cap option is not specified then no cap
3289 will be drawn for that end. As a special case for
3290 PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be
3291 specified. If this option is provided then any tick marks and tick
3292 labels will be placed at the breaks between shaded segments. TODO:
3293 This should be expanded to support custom placement of tick marks
3294 and tick labels at custom value locations for any color bar type.
3296 position (PLINT, input) : position contains bits which control the
3297 overall position of the color bar and the definition of the
3298 adopted coordinates used for positions just like what is done for
3299 the position argument for pllegend. However, note that the
3300 defaults for the position bits (see below) are different than the
3301 pllegend case. The combination of the PL_POSITION_LEFT,
3302 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3303 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3304 the 16 possible standard positions (the 4 corners and centers of
3305 the 4 sides for both the inside and outside cases) of the color
3306 bar relative to the adopted coordinate system. The corner
3307 positions are specified by the appropriate combination of two of
3308 the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3309 PL_POSITION_BOTTOM bits while the sides are specified by a single
3310 value of one of those bits. The adopted coordinates are
3311 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3312 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3313 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3314 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3315 then use PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE or
3316 PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE. If neither of
3317 PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use
3318 PL_POSITION_VIEWPORT.
3320 x (PLFLT, input) : X offset of the color bar position in adopted
3321 coordinates from the specified standard position of the color bar.
3322 For positive x, the direction of motion away from the standard
3323 position is inward/outward from the standard corner positions or
3324 standard left or right positions if the
3325 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3326 For the standard top or bottom positions, the direction of motion
3327 is toward positive X.
3329 y (PLFLT, input) : Y offset of the color bar position in adopted
3330 coordinates from the specified standard position of the color bar.
3331 For positive y, the direction of motion away from the standard
3332 position is inward/outward from the standard corner positions or
3333 standard top or bottom positions if the
3334 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3335 For the standard left or right positions, the direction of motion
3336 is toward positive Y.
3338 x_length (PLFLT, input) : Length of the body of the color bar in
3339 the X direction in adopted coordinates.
3341 y_length (PLFLT, input) : Length of the body of the color bar in
3342 the Y direction in adopted coordinates.
3344 bg_color (PLINT, input) : The cmap0 color of the background for the
3345 color bar (PL_COLORBAR_BACKGROUND).
3347 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3348 for the color bar (PL_COLORBAR_BOUNDING_BOX).
3350 bb_style (PLINT, input) : The pllsty style number for the
3351 bounding-box line for the color bar (PL_COLORBAR_BACKGROUND).
3353 low_cap_color (PLFLT, input) : The cmap1 color of the low-end color
3354 bar cap, if it is drawn (PL_COLORBAR_CAP_LOW).
3356 high_cap_color (PLFLT, input) : The cmap1 color of the high-end
3357 color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH).
3359 cont_color (PLINT, input) : The cmap0 contour color for
3360 PL_COLORBAR_SHADE plots. This is passed directly to plshades, so
3361 it will be interpreted according to the design of plshades.
3363 cont_width (PLFLT, input) : Contour width for PL_COLORBAR_SHADE
3364 plots. This is passed directly to plshades, so it will be
3365 interpreted according to the design of plshades.
3367 n_labels (PLINT, input) : Number of labels to place around the
3370 label_opts (PLINT_VECTOR, input) : A vector of options for each of
3373 labels (PLCHAR_MATRIX, input) : A vector of
3374 n_labels UTF-8 character strings containing the labels for the color
3375 bar. Ignored if no label position is specified with one of the
3376 PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP,
3377 PL_COLORBAR_LABEL_LEFT, or PL_COLORBAR_LABEL_BOTTOM bits in the
3378 corresponding label_opts field.
3380 n_axes (PLINT, input) : Number of axis definitions provided. This
3381 value must be greater than 0. It is typically 1 (numerical axis
3382 labels are provided for one of the long edges of the color bar),
3383 but it can be larger if multiple numerical axis labels for the
3384 long edges of the color bar are desired.
3386 axis_opts (PLCHAR_MATRIX, input) : A vector of
3387 n_axes ascii character strings containing options (interpreted as for
3388 plbox) for the color bar's axis definitions.
3390 ticks (PLFLT_VECTOR, input) : A vector of n_axes values of the
3391 spacing of the major tick marks (interpreted as for plbox) for the
3392 color bar's axis definitions.
3394 sub_ticks (PLINT_VECTOR, input) : A vector of n_axes values of the
3395 number of subticks (interpreted as for plbox) for the color bar's
3398 n_values (PLINT_VECTOR, input) : A vector containing the number of
3399 elements in each of the n_axes rows of the values matrix.
3401 values (PLFLT_MATRIX, input) : A matrix containing the numeric
3402 values for the data range represented by the color bar. For a row
3403 index of i_axis (where 0 < i_axis < n_axes), the number of
3404 elements in the row is specified by n_values[i_axis]. For
3405 PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT the number of elements
3406 is 2, and the corresponding row elements of the values matrix are
3407 the minimum and maximum value represented by the colorbar. For
3408 PL_COLORBAR_SHADE, the number and values of the elements of a row
3409 of the values matrix is interpreted the same as the nlevel and
3410 clevel arguments of plshades.
3413 return _plplotc.plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk)
3417 Sets the 3D position of the light source
3421 Sets the 3D position of the light source for use with plsurf3d and
3424 Redacted form: pllightsource(x, y, z)
3426 This function is used in example 8.
3432 pllightsource(x, y, z)
3436 x (PLFLT, input) : X-coordinate of the light source.
3438 y (PLFLT, input) : Y-coordinate of the light source.
3440 z (PLFLT, input) : Z-coordinate of the light source.
3443 return _plplotc.pllightsource(x, y, z)
3451 Draws line defined by n points in x and y.
3453 Redacted form: plline(x, y)
3455 This function is used in examples 1, 3, 4, 9, 12-14, 16, 18, 20, 22,
3466 n (PLINT, input) : Number of points defining line.
3468 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3471 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3475 return _plplotc.plline(n, ArrayCk)
3479 Draw a line in 3 space
3483 Draws line in 3 space defined by n points in x, y, and z. You must
3484 first set up the viewport, the 2d viewing window (in world
3485 coordinates), and the 3d normalized coordinate box. See x18c.c for
3488 Redacted form: plline3(x, y, z)
3490 This function is used in example 18.
3500 n (PLINT, input) : Number of points defining line.
3502 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3505 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3508 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
3512 return _plplotc.plline3(n, arg2, arg3)
3520 This sets the line style according to one of eight predefined patterns
3523 Redacted form: pllsty(lin)
3525 This function is used in examples 9, 12, 22, and 25.
3535 lin (PLINT, input) : Integer value between 1 and 8. Line style 1 is
3536 a continuous line, line style 2 is a line with short dashes and
3537 gaps, line style 3 is a line with long dashes and gaps, line style
3538 4 has long dashes and short gaps and so on.
3541 return _plplotc.pllsty(lin)
3549 Plots a surface mesh within the environment set up by plw3d. The
3550 surface is defined by the matrix z[
3552 ny] , the point z[i][j] being the value of the function at (
3554 y[j]). Note that the points in vectors x and y do not need to be
3555 equally spaced, but must be stored in ascending order. The parameter
3556 opt controls the way in which the surface is displayed. For further
3557 details see the PLplot documentation.
3559 Redacted form: plmesh(x, y, z, opt)
3561 This function is used in example 11.
3567 plmesh(x, y, z, nx, ny, opt)
3571 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3572 which the function is evaluated.
3574 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3575 which the function is evaluated.
3577 z (PLFLT_MATRIX, input) : A matrix containing function values to
3578 plot. Should have dimensions of
3582 nx (PLINT, input) : Number of x values at which function has been
3585 ny (PLINT, input) : Number of y values at which function has been
3588 opt (PLINT, input) : Determines the way in which the surface is
3589 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3590 function of x for each value of y[j] .
3591 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3592 for each value of x[i] .
3593 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3594 at which function is defined.
3597 return _plplotc.plmesh(ArrayX, ArrayY, MatrixCk, opt)
3599 def plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array):
3601 Magnitude colored plot surface mesh with contour
3605 A more powerful form of plmesh: the surface mesh can be colored
3606 accordingly to the current z value being plotted, a contour plot can
3607 be drawn at the base XY plane, and a curtain can be drawn between the
3608 plotted function border and the base XY plane.
3610 Redacted form: plmeshc(x, y, z, opt, clevel)
3612 This function is used in example 11.
3618 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
3622 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3623 which the function is evaluated.
3625 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3626 which the function is evaluated.
3628 z (PLFLT_MATRIX, input) : A matrix containing function values to
3629 plot. Should have dimensions of
3633 nx (PLINT, input) : Number of x values at which function is
3636 ny (PLINT, input) : Number of y values at which function is
3639 opt (PLINT, input) : Determines the way in which the surface is
3640 represented. To specify more than one option just add the options,
3641 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3642 showing z as a function of x for each value of y[j] .
3643 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3644 for each value of x[i] .
3645 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3646 at which function is defined.
3647 opt=MAG_COLOR : Each line in the mesh is colored according to
3648 the z value being plotted. The color is used from the current
3650 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3654 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3655 the borders of the plotted function.
3658 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3661 nlevel (PLINT, input) : Number of elements in the clevel vector.
3664 return _plplotc.plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array)
3668 Creates a new stream and makes it the default
3672 Creates a new stream and makes it the default. Differs from using
3673 plsstrm, in that a free stream number is found, and returned.
3674 Unfortunately, I have to start at stream 1 and work upward, since
3675 stream 0 is preallocated. One of the big flaws in the PLplot API is
3676 that no initial, library-opening call is required. So stream 0 must
3677 be preallocated, and there is no simple way of determining whether it
3678 is already in use or not.
3680 Redacted form: plmkstrm(p_strm)
3682 This function is used in examples 1 and 20.
3692 p_strm (PLINT_NC_SCALAR, output) : Returned value of the stream
3693 number of the created stream.
3696 return _plplotc.plmkstrm()
3700 Write text relative to viewport boundaries
3704 Writes text at a specified position relative to the viewport
3705 boundaries. Text may be written inside or outside the viewport, but
3706 is clipped at the subpage boundaries. The reference point of a string
3707 lies along a line passing through the string at half the height of a
3708 capital letter. The position of the reference point along this line
3709 is determined by just, and the position of the reference point
3710 relative to the viewport is set by disp and pos.
3712 Redacted form: General: plmtex(side, disp, pos, just, text)
3715 This function is used in examples 3, 4, 6-8, 11, 12, 14, 18, 23, and
3722 plmtex(side, disp, pos, just, text)
3726 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3727 the side of the viewport along which the text is to be written.
3728 The string must be one of: b: Bottom of viewport, text written
3730 bv: Bottom of viewport, text written at right angles to edge.
3731 l: Left of viewport, text written parallel to edge.
3732 lv: Left of viewport, text written at right angles to edge.
3733 r: Right of viewport, text written parallel to edge.
3734 rv: Right of viewport, text written at right angles to edge.
3735 t: Top of viewport, text written parallel to edge.
3736 tv: Top of viewport, text written at right angles to edge.
3739 disp (PLFLT, input) : Position of the reference point of string,
3740 measured outwards from the specified viewport edge in units of the
3741 current character height. Use negative disp to write within the
3744 pos (PLFLT, input) : Position of the reference point of string
3745 along the specified edge, expressed as a fraction of the length of
3748 just (PLFLT, input) : Specifies the position of the string relative
3749 to its reference point. If just=0. , the reference point is at
3750 the left and if just=1. , it is at the right of the string. Other
3751 values of just give intermediate justifications.
3753 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3757 return _plplotc.plmtex(side, disp, pos, just, text)
3761 Write text relative to viewport boundaries in 3D plots
3765 Writes text at a specified position relative to the viewport
3766 boundaries. Text may be written inside or outside the viewport, but
3767 is clipped at the subpage boundaries. The reference point of a string
3768 lies along a line passing through the string at half the height of a
3769 capital letter. The position of the reference point along this line
3770 is determined by just, and the position of the reference point
3771 relative to the viewport is set by disp and pos.
3773 Redacted form: plmtex3(side, disp, pos, just, text)
3775 This function is used in example 28.
3781 plmtex3(side, disp, pos, just, text)
3785 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3786 the side of the viewport along which the text is to be written.
3787 The string should contain one or more of the following characters:
3788 [xyz][ps][v]. Only one label is drawn at a time, i.e. xyp will
3789 only label the X axis, not both the X and Y axes. x: Label the X
3791 y: Label the Y axis.
3792 z: Label the Z axis.
3793 p: Label the primary axis. For Z this is the leftmost Z axis.
3794 For X it is the axis that starts at y-min. For Y it is the
3795 axis that starts at x-min.
3796 s: Label the secondary axis.
3797 v: Draw the text perpendicular to the axis.
3800 disp (PLFLT, input) : Position of the reference point of string,
3801 measured outwards from the specified viewport edge in units of the
3802 current character height. Use negative disp to write within the
3805 pos (PLFLT, input) : Position of the reference point of string
3806 along the specified edge, expressed as a fraction of the length of
3809 just (PLFLT, input) : Specifies the position of the string relative
3810 to its reference point. If just=0. , the reference point is at
3811 the left and if just=1. , it is at the right of the string. Other
3812 values of just give intermediate justifications.
3814 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3818 return _plplotc.plmtex3(side, disp, pos, just, text)
3820 def plot3d(ArrayX, ArrayY, MatrixCk, opt, side):
3822 Plot 3-d surface plot
3826 Plots a three-dimensional surface plot within the environment set up
3827 by plw3d. The surface is defined by the matrix z[
3829 ny] , the point z[i][j] being the value of the function at (
3831 y[j]). Note that the points in vectors x and y do not need to be
3832 equally spaced, but must be stored in ascending order. The parameter
3833 opt controls the way in which the surface is displayed. For further
3834 details see the PLplot documentation. The only difference between
3835 plmesh and plot3d is that plmesh draws the bottom side of the surface,
3836 while plot3d only draws the surface as viewed from the top.
3838 Redacted form: plot3d(x, y, z, opt, side)
3840 This function is used in examples 11 and 21.
3846 plot3d(x, y, z, nx, ny, opt, side)
3850 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3851 which the function is evaluated.
3853 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3854 which the function is evaluated.
3856 z (PLFLT_MATRIX, input) : A matrix containing function values to
3857 plot. Should have dimensions of
3861 nx (PLINT, input) : Number of x values at which function is
3864 ny (PLINT, input) : Number of y values at which function is
3867 opt (PLINT, input) : Determines the way in which the surface is
3868 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3869 function of x for each value of y[j] .
3870 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3871 for each value of x[i] .
3872 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3873 at which function is defined.
3876 side (PLBOOL, input) : Flag to indicate whether or not ``sides''
3877 should be draw on the figure. If side is true sides are drawn,
3878 otherwise no sides are drawn.
3881 return _plplotc.plot3d(ArrayX, ArrayY, MatrixCk, opt, side)
3883 def plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array):
3885 Magnitude colored plot surface with contour
3889 Aside from dropping the
3890 side functionality this is a more powerful form of plot3d: the surface
3891 mesh can be colored accordingly to the current z value being plotted,
3892 a contour plot can be drawn at the base XY plane, and a curtain can be
3893 drawn between the plotted function border and the base XY plane. The
3894 arguments are identical to those of plmeshc. The only difference
3895 between plmeshc and plot3dc is that plmeshc draws the bottom side of
3896 the surface, while plot3dc only draws the surface as viewed from the
3899 Redacted form: General: plot3dc(x, y, z, opt, clevel)
3902 This function is used in example 21.
3908 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
3912 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3913 which the function is evaluated.
3915 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3916 which the function is evaluated.
3918 z (PLFLT_MATRIX, input) : A matrix containing function values to
3919 plot. Should have dimensions of
3923 nx (PLINT, input) : Number of x values at which function is
3926 ny (PLINT, input) : Number of y values at which function is
3929 opt (PLINT, input) : Determines the way in which the surface is
3930 represented. To specify more than one option just add the options,
3931 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3932 showing z as a function of x for each value of y[j] .
3933 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3934 for each value of x[i] .
3935 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3936 at which function is defined.
3937 opt=MAG_COLOR : Each line in the mesh is colored according to
3938 the z value being plotted. The color is used from the current
3940 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3944 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3945 the borders of the plotted function.
3948 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3951 nlevel (PLINT, input) : Number of elements in the clevel vector.
3954 return _plplotc.plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array)
3956 def plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
3958 Magnitude colored plot surface with contour for z[x][y] with y index limits
3962 When the implementation is completed this variant of plot3dc (see that
3963 function's documentation for more details) should be suitable for the
3964 case where the area of the x, y coordinate grid where z is defined can
3965 be non-rectangular. The implementation is incomplete so the last 4
3966 parameters of plot3dcl; indexxmin, indexxmax, indexymin, and
3967 indexymax; are currently ignored and the functionality is otherwise
3968 identical to that of plot3dc.
3970 Redacted form: General: plot3dcl(x, y, z, opt, clevel, indexxmin,
3971 indexymin, indexymax)
3974 This function is not used in any example.
3980 plot3dcl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
3984 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3985 which the function is evaluated.
3987 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3988 which the function is evaluated.
3990 z (PLFLT_MATRIX, input) : A matrix containing function values to
3991 plot. Should have dimensions of
3995 nx (PLINT, input) : Number of x values at which the function is
3998 ny (PLINT, input) : Number of y values at which the function is
4001 opt (PLINT, input) : Determines the way in which the surface is
4002 represented. To specify more than one option just add the options,
4003 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
4004 showing z as a function of x for each value of y[j] .
4005 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
4006 for each value of x[i] .
4007 opt=DRAW_LINEXY : Network of lines is drawn connecting points
4008 at which function is defined.
4009 opt=MAG_COLOR : Each line in the mesh is colored according to
4010 the z value being plotted. The color is used from the current
4012 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4016 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4017 the borders of the plotted function.
4020 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4023 nlevel (PLINT, input) : Number of elements in the clevel vector.
4025 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4026 corresponds to the first x index where z is defined.
4028 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4029 which corresponds (by convention) to one more than the last x
4030 index value where z is defined.
4032 indexymin (PLINT_VECTOR, input) : A vector containing y index
4033 values which all must be ≥ 0. These values are the first y index
4034 where z is defined for a particular x index in the range from
4035 indexxmin to indexxmax - 1. The dimension of indexymin is
4038 indexymax (PLINT_VECTOR, input) : A vector containing y index
4039 values which all must be ≤ ny. These values correspond (by
4040 convention) to one more than the last y index where z is defined
4041 for a particular x index in the range from indexxmin to indexxmax
4042 - 1. The dimension of indexymax is indexxmax.
4045 return _plplotc.plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4049 Plot shaded 3-d surface plot
4053 Plots a three-dimensional shaded surface plot within the environment
4054 set up by plw3d. The surface is defined by the two-dimensional matrix
4057 ny], the point z[i][j] being the value of the function at (
4059 y[j]). Note that the points in vectors x and y do not need to be
4060 equally spaced, but must be stored in ascending order. For further
4061 details see the PLplot documentation.
4063 Redacted form: plsurf3d(x, y, z, opt, clevel)
4065 This function is not used in any examples.
4071 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
4075 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4076 which the function is evaluated.
4078 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4079 which the function is evaluated.
4081 z (PLFLT_MATRIX, input) : A matrix containing function values to
4082 plot. Should have dimensions of
4086 nx (PLINT, input) : Number of x values at which function is
4089 ny (PLINT, input) : Number of y values at which function is
4092 opt (PLINT, input) : Determines the way in which the surface is
4093 represented. To specify more than one option just add the options,
4094 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4095 connecting points at which function is defined.
4096 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4100 opt=SURF_CONT : A contour plot is drawn at the surface plane
4104 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4105 the borders of the plotted function.
4106 opt=MAG_COLOR : the surface is colored according to the value
4107 of Z; if MAG_COLOR is not used, then the surface is colored
4108 according to the intensity of the reflected light in the
4109 surface from a light source whose position is set using
4113 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4116 nlevel (PLINT, input) : Number of elements in the clevel vector.
4119 return _plplotc.plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array)
4121 def plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
4123 Plot shaded 3-d surface plot for z[x][y] with y index limits
4127 This variant of plsurf3d (see that function's documentation for more
4128 details) should be suitable for the case where the area of the x, y
4129 coordinate grid where z is defined can be non-rectangular. The limits
4130 of that grid are provided by the parameters indexxmin, indexxmax,
4131 indexymin, and indexymax.
4133 Redacted form: plsurf3dl(x, y, z, opt, clevel, indexxmin, indexymin,
4136 This function is used in example 8.
4142 plsurf3dl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
4146 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4147 which the function is evaluated.
4149 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4150 which the function is evaluated.
4152 z (PLFLT_MATRIX, input) : A matrix containing function values to
4153 plot. Should have dimensions of
4157 nx (PLINT, input) : Number of x values at which function is
4160 ny (PLINT, input) : Number of y values at which function is
4163 opt (PLINT, input) : Determines the way in which the surface is
4164 represented. To specify more than one option just add the options,
4165 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4166 connecting points at which function is defined.
4167 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4171 opt=SURF_CONT : A contour plot is drawn at the surface plane
4175 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4176 the borders of the plotted function.
4177 opt=MAG_COLOR : the surface is colored according to the value
4178 of Z; if MAG_COLOR is not used, then the surface is colored
4179 according to the intensity of the reflected light in the
4180 surface from a light source whose position is set using
4184 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4187 nlevel (PLINT, input) : Number of elements in the clevel vector.
4189 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4190 corresponds to the first x index where z is defined.
4192 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4193 which corresponds (by convention) to one more than the last x
4194 index value where z is defined.
4196 indexymin (PLINT_VECTOR, input) : A vector containing the y index
4197 values which all must be ≥ 0. These values are the first y index
4198 where z is defined for a particular x index in the range from
4199 indexxmin to indexxmax - 1. The dimension of indexymin is
4202 indexymax (PLINT_VECTOR, input) : A vector containing the y index
4203 values which all must be ≤ ny. These values correspond (by
4204 convention) to one more than the last y index where z is defined
4205 for a particular x index in the range from indexxmin to indexxmax
4206 - 1. The dimension of indexymax is indexxmax.
4209 return _plplotc.plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4213 Parse command-line arguments
4217 Parse command-line arguments.
4219 plparseopts removes all recognized flags (decreasing argc
4220 accordingly), so that invalid input may be readily detected. It can
4221 also be used to process user command line flags. The user can merge
4222 an option table of type PLOptionTable into the internal option table
4223 info structure using plMergeOpts. Or, the user can specify that ONLY
4224 the external table(s) be parsed by calling plClearOpts before
4227 The default action taken by plparseopts is as follows:
4228 Returns with an error if an unrecognized option or badly formed
4229 option-value pair are encountered.
4230 Returns immediately (return code 0) when the first non-option command
4231 line argument is found.
4232 Returns with the return code of the option handler, if one was called.
4234 Deletes command line arguments from argv list as they are found, and
4235 decrements argc accordingly.
4236 Does not show "invisible" options in usage or help messages.
4237 Assumes the program name is contained in argv[0].
4239 These behaviors may be controlled through the
4242 Redacted form: General: plparseopts(argv, mode)
4245 This function is used in all of the examples.
4251 PLINT plparseopts(p_argc, argv, mode)
4255 p_argc (int *, input/output) : Number of arguments.
4257 argv (PLCHAR_NC_MATRIX, input/output) : A vector of character
4258 strings containing *p_argc command-line arguments.
4260 mode (PLINT, input) : Parsing mode with the following
4261 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
4262 and all error messages enabled, including program exit when an
4263 error occurs. Anything on the command line that isn't recognized
4264 as a valid option or option argument is flagged as an error.
4265 PL_PARSE_QUIET (2) -- Turns off all output except in the case
4267 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
4269 PL_PARSE_SHOWALL (8) -- Show invisible options
4270 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a
4271 pointer to the program name.
4272 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required.
4273 PL_PARSE_SKIP (128) -- Set to quietly skip over any
4274 unrecognized arguments.
4277 return _plplotc.plparseopts(p_argc, mode)
4281 Set area line fill pattern
4285 Sets the area line fill pattern to be used, e.g., for calls to plfill.
4286 The pattern consists of 1 or 2 sets of parallel lines with specified
4287 inclinations and spacings. The arguments to this routine are the
4288 number of sets to use (1 or 2) followed by two vectors (with 1 or 2
4289 elements) specifying the inclinations in tenths of a degree and the
4290 spacing in micrometers. (See also plpsty)
4292 Redacted form: General: plpat(inc, del)
4295 This function is used in example 15.
4301 plpat(nlin, inc, del)
4305 nlin (PLINT, input) : Number of sets of lines making up the
4306 pattern, either 1 or 2.
4308 inc (PLINT_VECTOR, input) : A vector containing nlin values of the
4309 inclination in tenths of a degree. (Should be between -900 and
4312 del (PLINT_VECTOR, input) : A vector containing nlin values of the
4313 spacing in micrometers between the lines making up the pattern.
4316 return _plplotc.plpat(n, ArrayCk)
4320 Draw a line between two points, accounting for coordinate transforms
4328 y2) . If a global coordinate transform is defined then the line is
4329 broken in to n segments to approximate the path. If no transform is
4330 defined then this simply acts like a call to pljoin.
4332 Redacted form: plpath(n,x1,y1,x2,y2)
4334 This function is used in example 22.
4340 plpath(n, x1, y1, x2, y2)
4344 n (PLINT, input) : number of points to use to approximate the path.
4346 x1 (PLFLT, input) : x coordinate of first point.
4348 y1 (PLFLT, input) : y coordinate of first point.
4350 x2 (PLFLT, input) : x coordinate of second point.
4352 y2 (PLFLT, input) : y coordinate of second point.
4355 return _plplotc.plpath(n, x1, y1, x2, y2)
4359 Plot a glyph at the specified points
4363 Plot a glyph at the specified points. (This function is largely
4364 superseded by plstring which gives access to many[!] more glyphs.)
4365 code=-1 means try to just draw a point. Right now it's just a move
4366 and a draw at the same place. Not ideal, since a sufficiently
4367 intelligent output device may optimize it away, or there may be faster
4368 ways of doing it. This is OK for now, though, and offers a 4X speedup
4369 over drawing a Hershey font "point" (which is actually diamond shaped
4370 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4371 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4372 code <= 127 the corresponding printable ASCII character is plotted.
4374 Redacted form: plpoin(x, y, code)
4376 This function is used in examples 1, 6, 14, and 29.
4382 plpoin(n, x, y, code)
4386 n (PLINT, input) : Number of points in the x and y vectors.
4388 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4391 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4394 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4395 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4396 each of the n points.
4399 return _plplotc.plpoin(n, ArrayCk, code)
4403 Plot a glyph at the specified 3D points
4407 Plot a glyph at the specified 3D points. (This function is largely
4408 superseded by plstring3 which gives access to many[!] more glyphs.)
4409 Set up the call to this function similar to what is done for plline3.
4410 code=-1 means try to just draw a point. Right now it's just a move
4411 and a draw at the same place. Not ideal, since a sufficiently
4412 intelligent output device may optimize it away, or there may be faster
4413 ways of doing it. This is OK for now, though, and offers a 4X speedup
4414 over drawing a Hershey font "point" (which is actually diamond shaped
4415 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4416 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4417 code <= 127 the corresponding printable ASCII character is plotted.
4419 Redacted form: plpoin3(x, y, z, code)
4421 This function is not used in any example.
4427 plpoin3(n, x, y, z, code)
4431 n (PLINT, input) : Number of points in the x and y vectors.
4433 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4436 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4439 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
4442 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4443 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4444 each of the n points.
4447 return _plplotc.plpoin3(n, arg2, arg3, code)
4451 Draw a polygon in 3 space
4455 Draws a polygon in 3 space defined by n points in x, y, and z. Setup
4456 like plline3, but differs from that function in that plpoly3 attempts
4457 to determine if the polygon is viewable depending on the order of the
4458 points within the vector and the value of ifcc. If the back of
4459 polygon is facing the viewer, then it isn't drawn. If this isn't what
4460 you want, then use plline3 instead.
4462 The points are assumed to be in a plane, and the directionality of the
4463 plane is determined from the first three points. Additional points do
4464 not have to lie on the plane defined by the first three, but if they
4465 do not, then the determination of visibility obviously can't be 100%
4466 accurate... So if you're 3 space polygons are too far from planar,
4467 consider breaking them into smaller polygons. 3 points define a plane
4470 Bugs: If one of the first two segments is of zero length, or if they
4471 are co-linear, the calculation of visibility has a 50/50 chance of
4472 being correct. Avoid such situations :-). See x18c.c for an example
4473 of this problem. (Search for 20.1).
4475 Redacted form: plpoly3(x, y, z, code)
4477 This function is used in example 18.
4483 plpoly3(n, x, y, z, draw, ifcc)
4487 n (PLINT, input) : Number of points defining line.
4489 x (PLFLT_VECTOR, input) : A vector containing
4490 n x coordinates of points.
4492 y (PLFLT_VECTOR, input) : A vector containing
4493 n y coordinates of points.
4495 z (PLFLT_VECTOR, input) : A vector containing
4496 n z coordinates of points.
4498 draw (PLBOOL_VECTOR, input) : A vector containing
4499 n-1 Boolean values which control drawing the segments of the polygon.
4500 If draw[i] is true, then the polygon segment from index [i] to
4501 [i+1] is drawn, otherwise, not.
4503 ifcc (PLBOOL, input) : If ifcc is true the directionality of the
4504 polygon is determined by assuming the points are laid out in a
4505 counter-clockwise order. Otherwise, the directionality of the
4506 polygon is determined by assuming the points are laid out in a
4510 return _plplotc.plpoly3(n, arg2, arg3, ArrayCkMinus1, flag)
4514 Set precision in numeric labels
4518 Sets the number of places after the decimal point in numeric labels.
4520 Redacted form: plprec(setp, prec)
4522 This function is used in example 29.
4532 setp (PLINT, input) : If setp is equal to 0 then PLplot
4533 automatically determines the number of places to use after the
4534 decimal point in numeric labels (like those used to label axes).
4535 If setp is 1 then prec sets the number of places.
4537 prec (PLINT, input) : The number of characters to draw after the
4538 decimal point in numeric labels.
4541 return _plplotc.plprec(setp, prec)
4545 Select area fill pattern
4550 patt is zero or less use either a hardware solid fill if the drivers
4551 have that capability (virtually all do) or fall back to a software
4552 emulation of a solid fill using the eighth area line fill pattern. If
4554 patt <= 8, then select one of eight predefined area line fill patterns
4555 to use (see plpat if you desire other patterns).
4557 Redacted form: plpsty(patt)
4559 This function is used in examples 12, 13, 15, 16, and 25.
4569 patt (PLINT, input) : The desired pattern index. If
4570 patt is zero or less, then a solid fill is (normally, see qualifiers
4572 patt in the range from 1 to 8 and assuming the driver has not supplied
4573 line fill capability itself (most deliberately do not so that line
4574 fill patterns look identical for those drivers), the patterns
4575 consist of (1) horizontal lines, (2) vertical lines, (3) lines at
4576 45 degrees, (4) lines at -45 degrees, (5) lines at 30 degrees, (6)
4577 lines at -30 degrees, (7) both vertical and horizontal lines, and
4578 (8) lines at both 45 degrees and -45 degrees.
4581 return _plplotc.plpsty(patt)
4585 Write text inside the viewport
4589 Writes text at a specified position and inclination within the
4590 viewport. Text is clipped at the viewport boundaries. The reference
4591 point of a string lies along a line passing through the string at half
4592 the height of a capital letter. The position of the reference point
4593 along this line is determined by just, the reference point is placed
4594 at world coordinates (
4596 y) within the viewport. The inclination of the string is specified
4597 in terms of differences of world coordinates making it easy to write
4598 text parallel to a line in a graph.
4600 Redacted form: plptex(x, y, dx, dy, just, text)
4602 This function is used in example 2-4,10,12-14,20,23,24,26.
4608 plptex(x, y, dx, dy, just, text)
4612 x (PLFLT, input) : x coordinate of reference point of string.
4614 y (PLFLT, input) : y coordinate of reference point of string.
4616 dx (PLFLT, input) : Together with dy, this specifies the
4617 inclination of the string. The baseline of the string is parallel
4626 dy (PLFLT, input) : Together with dx, this specifies the
4627 inclination of the string.
4629 just (PLFLT, input) : Specifies the position of the string relative
4630 to its reference point. If just=0. , the reference point is at
4631 the left and if just=1. , it is at the right of the string. Other
4632 values of just give intermediate justifications.
4634 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4638 return _plplotc.plptex(x, y, dx, dy, just, text)
4640 def plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text):
4642 Write text inside the viewport of a 3D plot
4646 Writes text at a specified position and inclination and with a
4647 specified shear within the viewport. Text is clipped at the viewport
4648 boundaries. The reference point of a string lies along a line passing
4649 through the string at half the height of a capital letter. The
4650 position of the reference point along this line is determined by just,
4651 and the reference point is placed at world coordinates (
4654 wz) within the viewport. The inclination and shear of the string is
4655 specified in terms of differences of world coordinates making it easy
4656 to write text parallel to a line in a graph.
4658 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4660 This function is used in example 28.
4666 plptex3(wx, wy, wz, dx, dy, dz, sx, sy, sz, just, text)
4670 wx (PLFLT, input) : x world coordinate of reference point of
4673 wy (PLFLT, input) : y world coordinate of reference point of
4676 wz (PLFLT, input) : z world coordinate of reference point of
4679 dx (PLFLT, input) : Together with dy and
4680 dz , this specifies the inclination of the string. The baseline of
4681 the string is parallel to a line joining (
4692 dy (PLFLT, input) : Together with dx and
4693 dz, this specifies the inclination of the string.
4695 dz (PLFLT, input) : Together with dx and
4696 dy, this specifies the inclination of the string.
4698 sx (PLFLT, input) : Together with sy and
4699 sz , this specifies the shear of the string. The string is sheared so
4700 that the characters are vertically parallel to a line joining (
4711 sz = 0.) then the text is not sheared.
4713 sy (PLFLT, input) : Together with sx and
4714 sz, this specifies shear of the string.
4716 sz (PLFLT, input) : Together with sx and
4717 sy, this specifies shear of the string.
4719 just (PLFLT, input) : Specifies the position of the string relative
4720 to its reference point. If just=0. , the reference point is at
4721 the left and if just=1. , it is at the right of the string. Other
4722 values of just give intermediate justifications.
4724 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4728 return _plplotc.plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4732 Random number generator returning a real random number in the range [0,1]
4736 Random number generator returning a real random number in the range
4737 [0,1]. The generator is based on the Mersenne Twister. Most languages
4738 / compilers provide their own random number generator, and so this is
4739 provided purely for convenience and to give a consistent random number
4740 generator across all languages supported by PLplot. This is
4741 particularly useful for comparing results from the test suite of
4744 Redacted form: plrandd()
4746 This function is used in examples 17 and 21.
4755 return _plplotc.plrandd()
4759 Replays contents of plot buffer to current device/file
4763 Replays contents of plot buffer to current device/file.
4765 Redacted form: plreplot()
4767 This function is used in example 1,20.
4776 return _plplotc.plreplot()
4780 Convert RGB color to HLS
4784 Convert RGB color coordinates to HLS
4786 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
4789 This function is used in example 2.
4795 plrgbhls(r, g, b, p_h, p_l, p_s)
4799 r (PLFLT, input) : Red intensity (0.0-1.0) of the color.
4801 g (PLFLT, input) : Green intensity (0.0-1.0) of the color.
4803 b (PLFLT, input) : Blue intensity (0.0-1.0) of the color.
4805 p_h (PLFLT_NC_SCALAR, output) : Returned value of the hue in
4806 degrees (0.0-360.0) on the color cylinder.
4808 p_l (PLFLT_NC_SCALAR, output) : Returned value of the lightness
4809 expressed as a fraction (0.0-1.0) of the axis of the color
4812 p_s (PLFLT_NC_SCALAR, output) : Returned value of the saturation
4813 expressed as a fraction (0.0-1.0) of the radius of the color
4817 return _plplotc.plrgbhls(r, g, b)
4825 This sets up the size of all subsequent characters drawn. The actual
4826 height of a character is the product of the default character size and
4829 Redacted form: plschr(def, scale)
4831 This function is used in examples 2, 13, 23, and 24.
4841 def (PLFLT, input) : The default height of a character in
4842 millimeters, should be set to zero if the default height is to
4843 remain unchanged. For rasterized drivers the dx and dy values
4844 specified in plspage are used to convert from mm to pixels (note
4845 the different unit systems used). This dpi aware scaling is not
4846 implemented for all drivers yet.
4848 scale (PLFLT, input) : Scale factor to be applied to default to get
4849 actual character height.
4852 return _plplotc.plschr(_def, scale)
4856 Set cmap0 colors by 8-bit RGB values
4860 Set cmap0 colors using 8-bit RGB values (see the PLplot
4861 documentation). This sets the entire color map -- only as many colors
4862 as specified will be allocated.
4864 Redacted form: plscmap0(r, g, b)
4866 This function is used in examples 2 and 24.
4872 plscmap0(r, g, b, ncol0)
4876 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4877 integers (0-255) representing the degree of red in the color.
4879 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4880 integers (0-255) representing the degree of green in the color.
4882 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4883 integers (0-255) representing the degree of blue in the color.
4885 ncol0 (PLINT, input) : Number of items in the r, g, and b vectors.
4888 return _plplotc.plscmap0(Array, arg2, arg3)
4892 Set cmap0 colors by 8-bit RGB values and PLFLT alpha transparency value
4896 Set cmap0 colors using 8-bit RGB values (see the PLplot documentation)
4897 and PLFLT alpha transparency value. This sets the entire color map --
4898 only as many colors as specified will be allocated.
4900 Redacted form: plscmap0a(r, g, b, alpha)
4902 This function is used in examples 30.
4908 plscmap0a(r, g, b, alpha, ncol0)
4912 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4913 integers (0-255) representing the degree of red in the color.
4915 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4916 integers (0-255) representing the degree of green in the color.
4918 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4919 integers (0-255) representing the degree of blue in the color.
4921 alpha (PLFLT_VECTOR, input) : A vector containing values (0.0-1.0)
4922 representing the alpha transparency of the color.
4924 ncol0 (PLINT, input) : Number of items in the r, g, b, and alpha
4928 return _plplotc.plscmap0a(Array, arg2, arg3, arg4)
4932 Set number of colors in cmap0
4936 Set number of colors in cmap0 (see the PLplot documentation). Allocate
4937 (or reallocate) cmap0, and fill with default values for those colors
4938 not previously allocated. The first 16 default colors are given in
4939 the plcol0 documentation. For larger indices the default color is
4942 The drivers are not guaranteed to support more than 16 colors.
4944 Redacted form: plscmap0n(ncol0)
4946 This function is used in examples 15, 16, and 24.
4956 ncol0 (PLINT, input) : Number of colors that will be allocated in
4957 the cmap0 palette. If this number is zero or less, then the value
4958 from the previous call to plscmap0n is used and if there is no
4959 previous call, then a default value is used.
4962 return _plplotc.plscmap0n(ncol0)
4966 Set opaque RGB cmap1 colors values
4970 Set opaque cmap1 colors (see the PLplot documentation) using RGB
4971 vector values. This function also sets the number of cmap1 colors.
4972 N.B. Continuous cmap1 colors are indexed with a floating-point index
4973 in the range from 0.0-1.0 which is linearly transformed (e.g., by
4974 plcol1) to an integer index of these RGB vectors in the range from 0
4976 ncol1-1. So in order for this continuous color model to work
4977 properly, it is the responsibility of the user of plscmap1 to insure
4978 that these RGB vectors are continuous functions of their integer
4981 Redacted form: plscmap1(r, g, b)
4983 This function is used in example 31.
4989 plscmap1(r, g, b, ncol1)
4993 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
4994 8-bit integers in the range from 0-255) the degree of red in the
4995 color as a continuous function of the integer index of the vector.
4997 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
4998 8-bit integers in the range from 0-255) the degree of green in the
4999 color as a continuous function of the integer index of the vector.
5001 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
5002 8-bit integers in the range from 0-255) the degree of blue in the
5003 color as a continuous function of the integer index of the vector.
5005 ncol1 (PLINT, input) : Number of items in the r, g, and b vectors.
5008 return _plplotc.plscmap1(Array, arg2, arg3)
5012 Set semitransparent cmap1 RGBA colors.
5016 Set semitransparent cmap1 colors (see the PLplot documentation) using
5017 RGBA vector values. This function also sets the number of cmap1
5018 colors. N.B. Continuous cmap1 colors are indexed with a
5019 floating-point index in the range from 0.0-1.0 which is linearly
5020 transformed (e.g., by plcol1) to an integer index of these RGBA
5021 vectors in the range from 0 to
5022 ncol1-1. So in order for this continuous color model to work
5023 properly, it is the responsibility of the user of plscmap1 to insure
5024 that these RGBA vectors are continuous functions of their integer
5027 Redacted form: plscmap1a(r, g, b, alpha)
5029 This function is used in example 31.
5035 plscmap1a(r, g, b, alpha, ncol1)
5039 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
5040 8-bit integers in the range from 0-255) the degree of red in the
5041 color as a continuous function of the integer index of the vector.
5043 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
5044 8-bit integers in the range from 0-255) the degree of green in the
5045 color as a continuous function of the integer index of the vector.
5047 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
5048 8-bit integers in the range from 0-255) the degree of blue in the
5049 color as a continuous function of the integer index of the vector.
5051 alpha (PLFLT_VECTOR, input) : A vector that represents (using PLFLT
5052 values in the range from 0.0-1.0 where 0.0 corresponds to
5053 completely transparent and 1.0 corresponds to completely opaque)
5054 the alpha transparency of the color as a continuous function of
5055 the integer index of the vector.
5057 ncol1 (PLINT, input) : Number of items in the r, g, b, and alpha
5061 return _plplotc.plscmap1a(Array, arg2, arg3, arg4)
5063 def plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null):
5065 Set cmap1 colors using a piece-wise linear relationship
5069 Set cmap1 colors using a piece-wise linear relationship between the
5070 cmap1 intensity index (0.0-1.0) and position in HLS or RGB color space
5071 (see the PLplot documentation). May be called at any time.
5073 The idea here is to specify a number of control points that define the
5074 mapping between input cmap1 intensity indices and HLS or RGB. Between
5075 these points, linear interpolation is used which gives a smooth
5076 variation of color with intensity index. Any number of control points
5077 may be specified, located at arbitrary positions, although typically 2
5078 - 4 are enough. Another way of stating this is that we are traversing
5079 a given number of lines through HLS or RGB space as we move through
5080 cmap1 intensity indices. The control points at the minimum and
5081 maximum position (0 and 1) must always be specified. By adding more
5082 control points you can get more variation. One good technique for
5083 plotting functions that vary about some expected average is to use an
5084 additional 2 control points in the center (position ~= 0.5) that are
5085 the same lightness as the background (typically white for paper
5086 output, black for crt), and same hue as the boundary control points.
5087 This allows the highs and lows to be very easily distinguished.
5089 Each control point must specify the cmap1 intensity index and the
5090 associated three coordinates in HLS or RGB space. The first point
5091 must correspond to position = 0, and the last to position = 1.
5093 If RGB colors are provided then the interpolation takes place in RGB
5094 space and is trivial. However if HLS colors are provided then, because
5095 of the circular nature of the color wheel for the hue coordinate, the
5096 interpolation could be performed in either direction around the color
5097 wheel. The default behaviour is for the hue to be linearly
5098 interpolated ignoring this circular property of hue. So for example,
5099 the hues 0 (red) and 240 (blue) will get interpolated via yellow,
5100 green and cyan. If instead you wish to interpolate the other way
5101 around the color wheel you have two options. You may provide hues
5102 outside the range [0, 360), so by using a hue of -120 for blue or 360
5103 for red the interpolation will proceed via magenta. Alternatively you
5104 can utilise the alt_hue_path variable to reverse the direction of
5105 interpolation if you need to provide hues within the [0-360) range.
5107 Examples of interpolation Huealt_hue_pathcolor scheme[120
5108 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120
5109 -120]falsegreen-yellow-red-magenta-blue[240
5110 480]falseblue-magenta-red-yellow-green[120
5111 240]truegreen-yellow-red-magenta-blue[240
5112 120]trueblue-magenta-red-yellow-green
5114 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
5115 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
5116 1]magnitudeHLSsaturation[0, 1]magnitude
5118 Redacted form: plscmap1l(itype, intensity, coord1, coord2, coord3,
5121 This function is used in examples 8, 11, 12, 15, 20, and 21.
5127 plscmap1l(itype, npts, intensity, coord1, coord2, coord3, alt_hue_path)
5131 itype (PLBOOL, input) : true: RGB, false: HLS.
5133 npts (PLINT, input) : number of control points
5135 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5136 intensity index (0.0-1.0) in ascending order for each control
5139 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5140 coordinate (H or R) for each control point.
5142 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5143 coordinate (L or G) for each control point.
5145 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5146 coordinate (S or B) for each control point.
5148 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with
5149 npts - 1 elements), each containing either true to use the reversed
5150 HLS interpolation or false to use the regular HLS interpolation.
5151 (alt_hue_path[i] refers to the interpolation interval between the
5152 i and i + 1 control points). This parameter is not used for RGB
5157 return _plplotc.plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null)
5159 def plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null):
5161 Set cmap1 colors and alpha transparency using a piece-wise linear relationship
5165 This is a variant of plscmap1l that supports alpha channel
5166 transparency. It sets cmap1 colors using a piece-wise linear
5167 relationship between cmap1 intensity index (0.0-1.0) and position in
5168 HLS or RGB color space (see the PLplot documentation) with alpha
5169 transparency value (0.0-1.0). It may be called at any time.
5171 Redacted form: plscmap1la(itype, intensity, coord1, coord2, coord3,
5172 alpha, alt_hue_path)
5174 This function is used in example 30.
5180 plscmap1la(itype, npts, intensity, coord1, coord2, coord3, alpha, alt_hue_path)
5184 itype (PLBOOL, input) : true: RGB, false: HLS.
5186 npts (PLINT, input) : number of control points.
5188 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5189 intensity index (0.0-1.0) in ascending order for each control
5192 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5193 coordinate (H or R) for each control point.
5195 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5196 coordinate (L or G) for each control point.
5198 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5199 coordinate (S or B) for each control point.
5201 alpha (PLFLT_VECTOR, input) : A vector containing the alpha
5202 transparency value (0.0-1.0) for each control point.
5204 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with
5205 npts - 1 elements) containing the alternative interpolation method
5206 Boolean value for each control point interval. (alt_hue_path[i]
5207 refers to the interpolation interval between the i and i + 1
5211 return _plplotc.plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null)
5215 Set number of colors in cmap1
5219 Set number of colors in cmap1, (re-)allocate cmap1, and set default
5220 values if this is the first allocation (see the PLplot documentation).
5222 Redacted form: plscmap1n(ncol1)
5224 This function is used in examples 8, 11, 20, and 21.
5234 ncol1 (PLINT, input) : Number of colors that will be allocated in
5235 the cmap1 palette. If this number is zero or less, then the value
5236 from the previous call to plscmap1n is used and if there is no
5237 previous call, then a default value is used.
5240 return _plplotc.plscmap1n(ncol1)
5244 Set the cmap1 argument range for continuous color plots
5248 Set the cmap1 argument range for continuous color plots that
5249 corresponds to the range of data values. The maximum range
5250 corresponding to the entire cmap1 palette is 0.0-1.0, and the smaller
5251 the cmap1 argument range that is specified with this routine, the
5252 smaller the subset of the cmap1 color palette that is used to
5253 represent the continuous data being plotted. If
5254 min_color is greater than
5256 max_color is greater than 1.0 or
5257 min_color is less than 0.0 then no change is made to the cmap1
5258 argument range. (Use plgcmap1_range to get the cmap1 argument range.)
5260 Redacted form: plscmap1_range(min_color, max_color)
5262 This function is currently used in example 33.
5268 plscmap1_range(min_color, max_color)
5272 min_color (PLFLT, input) : The minimum cmap1 argument. If less
5273 than 0.0, then 0.0 is used instead.
5275 max_color (PLFLT, input) : The maximum cmap1 argument. If greater
5276 than 1.0, then 1.0 is used instead.
5279 return _plplotc.plscmap1_range(min_color, max_color)
5283 Get the cmap1 argument range for continuous color plots
5287 Get the cmap1 argument range for continuous color plots. (Use
5288 plscmap1_range to set the cmap1 argument range.)
5290 Redacted form: plgcmap1_range(min_color, max_color)
5292 This function is currently not used in any example.
5298 plgcmap1_range(min_color, max_color)
5302 min_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5303 minimum cmap1 argument.
5305 max_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5306 maximum cmap1 argument.
5309 return _plplotc.plgcmap1_range()
5313 Set 8-bit RGB values for given cmap0 color index
5317 Set 8-bit RGB values for given cmap0 (see the PLplot documentation)
5318 index. Overwrites the previous color value for the given index and,
5319 thus, does not result in any additional allocation of space for
5322 Redacted form: plscol0(icol0, r, g, b)
5324 This function is used in any example 31.
5330 plscol0(icol0, r, g, b)
5334 icol0 (PLINT, input) : Color index. Must be less than the maximum
5335 number of colors (which is set by default, by plscmap0n, or even
5338 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5339 degree of red in the color.
5341 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5342 degree of green in the color.
5344 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5345 degree of blue in the color.
5348 return _plplotc.plscol0(icol0, r, g, b)
5352 Set 8-bit RGB values and PLFLT alpha transparency value for given cmap0 color index
5356 Set 8-bit RGB value and PLFLT alpha transparency value for given cmap0
5357 (see the PLplot documentation) index. Overwrites the previous color
5358 value for the given index and, thus, does not result in any additional
5359 allocation of space for colors.
5361 This function is used in example 30.
5367 plscol0a(icol0, r, g, b, alpha)
5371 icol0 (PLINT, input) : Color index. Must be less than the maximum
5372 number of colors (which is set by default, by plscmap0n, or even
5375 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5376 degree of red in the color.
5378 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5379 degree of green in the color.
5381 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5382 degree of blue in the color.
5384 alpha (PLFLT, input) : Value of the alpha transparency in the range
5388 return _plplotc.plscol0a(icol0, r, g, b, a)
5392 Set the background color by 8-bit RGB value
5396 Set the background color (color 0 in cmap0) by 8-bit RGB value (see
5397 the PLplot documentation).
5399 Redacted form: plscolbg(r, g, b)
5401 This function is used in examples 15 and 31.
5411 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5412 degree of red in the color.
5414 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5415 degree of green in the color.
5417 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5418 degree of blue in the color.
5421 return _plplotc.plscolbg(r, g, b)
5425 Set the background color by 8-bit RGB value and PLFLT alpha transparency value.
5429 Set the background color (color 0 in cmap0) by 8-bit RGB value and
5430 PLFLT alpha transparency value (see the PLplot documentation).
5432 This function is used in example 31.
5438 plscolbga(r, g, b, alpha)
5442 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5443 degree of red in the color.
5445 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5446 degree of green in the color.
5448 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5449 degree of blue in the color.
5451 alpha (PLFLT, input) : Value of the alpha transparency in the range
5455 return _plplotc.plscolbga(r, g, b, a)
5459 Used to globally turn color output on/off
5463 Used to globally turn color output on/off for those drivers/devices
5466 Redacted form: plscolor(color)
5468 This function is used in example 31.
5478 color (PLINT, input) : Color flag (Boolean). If zero, color is
5479 turned off. If non-zero, color is turned on.
5482 return _plplotc.plscolor(color)
5486 Set device-compression level
5490 Set device-compression level. Only used for drivers that provide
5491 compression. This function, if used, should be invoked before a call
5494 Redacted form: plscompression(compression)
5496 This function is used in example 31.
5502 plscompression(compression)
5506 compression (PLINT, input) : The desired compression level. This is
5507 a device-dependent value. Currently only the jpeg and png devices
5508 use these values. For jpeg value is the jpeg quality which should
5509 normally be in the range 0-95. Higher values denote higher quality
5510 and hence larger image sizes. For png values are in the range -1
5511 to 99. Values of 0-9 are taken as the compression level for zlib.
5512 A value of -1 denotes the default zlib compression level. Values
5513 in the range 10-99 are divided by 10 and then used as the zlib
5514 compression level. Higher compression levels correspond to greater
5515 compression and small file sizes at the expense of more
5519 return _plplotc.plscompression(compression)
5523 Set the device (keyword) name
5527 Set the device (keyword) name.
5529 Redacted form: plsdev(devname)
5531 This function is used in examples 1, 14, and 20.
5541 devname (PLCHAR_VECTOR, input) : An ascii character string
5542 containing the device name keyword of the required output device.
5544 devname is NULL or if the first character of the string is a ``?'',
5545 the normal (prompted) start up is used.
5548 return _plplotc.plsdev(devname)
5552 Set parameters that define current device-space window
5556 Set relative margin width, aspect ratio, and relative justification
5557 that define current device-space window. If you want to just use the
5558 previous value for any of these, just pass in the magic value
5559 PL_NOTSET. It is unlikely that one should ever need to change the
5560 aspect ratio but it's in there for completeness. If plsdidev is not
5561 called the default values of mar, jx, and jy are all 0. aspect is set
5562 to a device-specific value.
5564 Redacted form: plsdidev(mar, aspect, jx, jy)
5566 This function is used in example 31.
5572 plsdidev(mar, aspect, jx, jy)
5576 mar (PLFLT, input) : Relative margin width.
5578 aspect (PLFLT, input) : Aspect ratio.
5580 jx (PLFLT, input) : Relative justification in x. Value must lie in
5581 the range -0.5 to 0.5.
5583 jy (PLFLT, input) : Relative justification in y. Value must lie in
5584 the range -0.5 to 0.5.
5587 return _plplotc.plsdidev(mar, aspect, jx, jy)
5589 def plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm):
5591 Set up transformation from metafile coordinates
5595 Set up transformation from metafile coordinates. The size of the plot
5596 is scaled so as to preserve aspect ratio. This isn't intended to be a
5597 general-purpose facility just yet (not sure why the user would need
5600 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
5603 This function is not used in any examples.
5609 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5613 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
5615 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
5617 dimymin (PLINT, input) : NEEDS DOCUMENTATION
5619 dimymax (PLINT, input) : NEEDS DOCUMENTATION
5621 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
5623 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
5626 return _plplotc.plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5630 Set plot orientation
5634 Set plot orientation parameter which is multiplied by 90 degrees to
5635 obtain the angle of rotation. Note, arbitrary rotation parameters
5636 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
5637 values for the rotation parameter are 0., 1., 2., and 3. corresponding
5638 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
5639 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is
5640 not called the default value of rot is 0.
5642 N.B. aspect ratio is unaffected by calls to plsdiori. So you will
5643 probably want to change the aspect ratio to a value suitable for the
5644 plot orientation using a call to plsdidev or the command-line options
5645 -a or -freeaspect. For more documentation of those options see the
5646 PLplot documentation. Such command-line options can be set internally
5647 using plsetopt or set directly using the command line and parsed using
5648 a call to plparseopts.
5650 Redacted form: plsdiori(rot)
5652 This function is not used in any examples.
5662 rot (PLFLT, input) : Plot orientation parameter.
5665 return _plplotc.plsdiori(rot)
5669 Set parameters that define current plot-space window
5673 Set relative minima and maxima that define the current plot-space
5674 window. If plsdiplt is not called the default values of xmin, ymin,
5675 xmax, and ymax are 0., 0., 1., and 1.
5677 Redacted form: plsdiplt(xmin, ymin, xmax, ymax)
5679 This function is used in example 31.
5685 plsdiplt(xmin, ymin, xmax, ymax)
5689 xmin (PLFLT, input) : Relative minimum in x.
5691 ymin (PLFLT, input) : Relative minimum in y.
5693 xmax (PLFLT, input) : Relative maximum in x.
5695 ymax (PLFLT, input) : Relative maximum in y.
5698 return _plplotc.plsdiplt(xmin, ymin, xmax, ymax)
5702 Set parameters incrementally (zoom mode) that define current plot-space window
5706 Set relative minima and maxima incrementally (zoom mode) that define
5707 the current plot-space window. This function has the same effect as
5708 plsdiplt if that function has not been previously called. Otherwise,
5709 this function implements zoom mode using the transformation min_used =
5710 old_min + old_length*min and max_used = old_min + old_length*max for
5711 each axis. For example, if min = 0.05 and max = 0.95 for each axis,
5712 repeated calls to plsdiplz will zoom in by 10 per cent for each call.
5714 Redacted form: plsdiplz(xmin, ymin, xmax, ymax)
5716 This function is used in example 31.
5722 plsdiplz(xmin, ymin, xmax, ymax)
5726 xmin (PLFLT, input) : Relative (incremental) minimum in x.
5728 ymin (PLFLT, input) : Relative (incremental) minimum in y.
5730 xmax (PLFLT, input) : Relative (incremental) maximum in x.
5732 ymax (PLFLT, input) : Relative (incremental) maximum in y.
5735 return _plplotc.plsdiplz(xmin, ymin, xmax, ymax)
5739 Set seed for internal random number generator.
5743 Set the seed for the internal random number generator. See plrandd for
5746 Redacted form: plseed(seed)
5748 This function is used in example 21.
5758 seed (unsigned int, input) : Seed for random number generator.
5761 return _plplotc.plseed(s)
5765 Set the escape character for text strings
5769 Set the escape character for text strings. From C (in contrast to
5770 Fortran, see plsescfortran) you pass esc as a character. Only selected
5771 characters are allowed to prevent the user from shooting himself in
5772 the foot (For example, a \ isn't allowed since it conflicts with C's
5773 use of backslash as a character escape). Here are the allowed escape
5774 characters and their corresponding decimal ASCII values: !, ASCII 33
5785 Redacted form: General: plsesc(esc)
5788 This function is used in example 29.
5798 esc (char, input) : Escape character.
5801 return _plplotc.plsesc(esc)
5805 Set any command-line option
5809 Set any command-line option internally from a program before it
5810 invokes plinit. opt is the name of the command-line option and optarg
5811 is the corresponding command-line option argument.
5813 This function returns 0 on success.
5815 Redacted form: plsetopt(opt, optarg)
5817 This function is used in example 14.
5823 PLINT plsetopt(opt, optarg)
5827 opt (PLCHAR_VECTOR, input) : An ascii character string containing
5828 the command-line option.
5830 optarg (PLCHAR_VECTOR, input) : An ascii character string
5831 containing the argument of the command-line option.
5834 return _plplotc.plsetopt(opt, optarg)
5838 Set family file parameters
5842 Sets variables dealing with output file familying. Does nothing if
5843 familying not supported by the driver. This routine, if used, must be
5844 called before initializing PLplot. See the PLplot documentation for
5847 Redacted form: plsfam(fam, num, bmax)
5849 This function is used in examples 14 and 31.
5855 plsfam(fam, num, bmax)
5859 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
5862 num (PLINT, input) : Current family file number.
5864 bmax (PLINT, input) : Maximum file size (in bytes) for a family
5868 return _plplotc.plsfam(fam, num, bmax)
5872 Set FCI (font characterization integer)
5876 Sets font characteristics to be used at the start of the next string
5877 using the FCI approach. See the PLplot documentation for more
5878 information. Note, plsfont (which calls plsfci internally) provides a
5879 more user-friendly API for setting the font characterisitics.
5881 Redacted form: General: plsfci(fci)
5884 This function is used in example 23.
5894 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
5898 return _plplotc.plsfci(fci)
5902 Set output file name
5906 Sets the current output file name, if applicable. If the file name
5907 has not been specified and is required by the driver, the user will be
5908 prompted for it. If using the X-windows output driver, this sets the
5909 display name. This routine, if used, must be called before
5910 initializing PLplot.
5912 Redacted form: plsfnam(fnam)
5914 This function is used in examples 1 and 20.
5924 fnam (PLCHAR_VECTOR, input) : An ascii character string containing
5928 return _plplotc.plsfnam(fnam)
5932 Set family, style and weight of the current font
5936 Sets the current font. See the PLplot documentation for more
5937 information on font selection.
5939 Redacted form: plsfont(family, style, weight)
5941 This function is used in example 23.
5947 plsfont(family, style, weight)
5951 family (PLINT, input) : Font family to select for the current font.
5952 The available values are given by the PL_FCI_* constants in
5953 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
5954 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value
5955 signifies that the font family should not be altered.
5957 style (PLINT, input) : Font style to select for the current font.
5958 The available values are given by the PL_FCI_* constants in
5959 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and
5960 PL_FCI_OBLIQUE. A negative value signifies that the font style
5961 should not be altered.
5963 weight (PLINT, input) : Font weight to select for the current font.
5964 The available values are given by the PL_FCI_* constants in
5965 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A
5966 negative value signifies that the font weight should not be
5970 return _plplotc.plsfont(family, style, weight)
5974 Shade regions on the basis of value
5978 Shade regions on the basis of value. This is the high-level routine
5979 for making continuous color shaded plots with cmap1 while plshade
5980 should be used to plot individual shaded regions using either cmap0 or
5981 cmap1. examples/;<language>/x16* shows how to use plshades for each of
5982 our supported languages.
5984 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
5985 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
5989 This function is used in examples 16, 21, and 22.
5995 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
5999 a (PLFLT_MATRIX, input) : A matrix containing function values to
6000 plot. Should have dimensions of
6004 nx (PLINT, input) : First dimension of matrix "a".
6006 ny (PLINT, input) : Second dimension of matrix "a".
6008 defined (PLDEFINED_callback, input) : Callback function specifying
6009 the region that should be plotted in the shade plot. This
6010 function accepts x and y coordinates as input arguments and must
6011 return 1 if the point is to be included in the shade plot and 0
6012 otherwise. If you want to plot the entire shade plot (the usual
6013 case), this argument should be set to NULL.
6015 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6016 pltr below for how these arguments are used (only for the special case
6017 when the callback function
6018 pltr is not supplied).
6020 clevel (PLFLT_VECTOR, input) : A vector containing the data levels
6021 corresponding to the edges of each shaded region that will be
6022 plotted by this function. To work properly the levels should be
6025 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
6026 of shade edge values in clevel).
6028 fill_width (PLFLT, input) : Defines the line width used by the fill
6031 cont_color (PLINT, input) : Defines cmap0 pen color used for
6032 contours defining edges of shaded regions. The pen color is only
6033 temporary set for the contour drawing. Set this value to zero or
6034 less if no shade edge contours are wanted.
6036 cont_width (PLFLT, input) : Defines line width used for contours
6037 defining edges of shaded regions. This value may not be honored
6038 by all drivers. The pen width is only temporary set for the
6039 contour drawing. Set this value to zero or less if no shade edge
6040 contours are wanted.
6042 fill (PLFILL_callback, input) : Callback routine used to fill the
6043 region. Use plfill for this purpose.
6045 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
6046 map to rectangles after coordinate transformation with pltrl.
6047 Otherwise, set rectangular to false. If rectangular is set to
6048 true, plshade tries to save time by filling large rectangles.
6049 This optimization fails if the coordinate transformation distorts
6050 the shape of rectangles. For example a plot in polar coordinates
6051 has to have rectangular set to false.
6053 pltr (PLTRANSFORM_callback, input) : A callback function that
6054 defines the transformation between the zero-based indices of the
6055 matrix a and world coordinates. If
6056 pltr is not supplied (e.g., is set to NULL in the C case), then the x
6057 indices of a are mapped to the range
6059 xmax and the y indices of a are mapped to the range
6061 ymax.For the C case, transformation functions are provided in the
6062 PLplot library: pltr0 for the identity mapping, and pltr1 and
6063 pltr2 for arbitrary mappings respectively defined by vectors and
6064 matrices. In addition, C callback routines for the transformation
6065 can be supplied by the user such as the mypltr function in
6066 examples/c/x09c.c which provides a general linear transformation
6067 between index coordinates and world coordinates.For languages
6068 other than C you should consult the PLplot documentation for the
6069 details concerning how PLTRANSFORM_callback arguments are
6070 interfaced. However, in general, a particular pattern of
6071 callback-associated arguments such as a tr vector with 6 elements;
6072 xg and yg vectors; or xg and yg matrices are respectively
6073 interfaced to a linear-transformation routine similar to the above
6074 mypltr function; pltr1; and pltr2. Furthermore, some of our more
6075 sophisticated bindings (see, e.g., the PLplot documentation)
6076 support native language callbacks for handling index to
6077 world-coordinate transformations. Examples of these various
6078 approaches are given in examples/<language>x09*,
6079 examples/<language>x16*, examples/<language>x20*,
6080 examples/<language>x21*, and examples/<language>x22*, for all our
6081 supported languages.
6083 pltr_data (PLPointer, input) : Extra parameter to help pass
6084 information to pltr0, pltr1, pltr2, or whatever routine that is
6085 externally supplied.
6088 return _plplotc.plshades(*args)
6092 Shade individual region on the basis of value
6096 Shade individual region on the basis of value. Use plshades if you
6097 want to shade a number of contiguous regions using continuous colors.
6098 In particular the edge contours are treated properly in plshades. If
6099 you attempt to do contiguous regions with plshade the contours at the
6100 edge of the shade are partially obliterated by subsequent plots of
6101 contiguous shaded regions.
6103 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax,
6104 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
6105 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
6108 This function is used in example 15.
6114 plshade(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)
6118 a (PLFLT_MATRIX, input) : A matrix containing function values to
6119 plot. Should have dimensions of
6123 nx (PLINT, input) : First dimension of the matrix "a".
6125 ny (PLINT, input) : Second dimension of the matrix "a".
6127 defined (PLDEFINED_callback, input) : Callback function specifying
6128 the region that should be plotted in the shade plot. This
6129 function accepts x and y coordinates as input arguments and must
6130 return 1 if the point is to be included in the shade plot and 0
6131 otherwise. If you want to plot the entire shade plot (the usual
6132 case), this argument should be set to NULL.
6134 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6135 pltr below for how these arguments are used (only for the special case
6136 when the callback function
6137 pltr is not supplied).
6139 shade_min (PLFLT, input) : Defines the lower end of the interval to
6140 be shaded. If shade_max <= shade_min, plshade does nothing.
6142 shade_max (PLFLT, input) : Defines the upper end of the interval to
6143 be shaded. If shade_max <= shade_min, plshade does nothing.
6145 sh_cmap (PLINT, input) : Defines color map. If sh_cmap=0, then
6146 sh_color is interpreted as a cmap0 (integer) index. If sh_cmap=1,
6147 then sh_color is interpreted as a cmap1 argument in the range
6150 sh_color (PLFLT, input) : Defines color map index with integer
6151 value if cmap0 or value in range (0.0-1.0) if cmap1.
6153 sh_width (PLFLT, input) : Defines width used by the fill pattern.
6155 min_color (PLINT, input) : Defines pen color, width used by the
6156 boundary of shaded region. The min values are used for the
6157 shade_min boundary, and the max values are used on the shade_max
6158 boundary. Set color and width to zero for no plotted boundaries.
6160 min_width (PLFLT, input) : Defines pen color, width used by the
6161 boundary of shaded region. The min values are used for the
6162 shade_min boundary, and the max values are used on the shade_max
6163 boundary. Set color and width to zero for no plotted boundaries.
6165 max_color (PLINT, input) : Defines pen color, width used by the
6166 boundary of shaded region. The min values are used for the
6167 shade_min boundary, and the max values are used on the shade_max
6168 boundary. Set color and width to zero for no plotted boundaries.
6170 max_width (PLFLT, input) : Defines pen color, width used by the
6171 boundary of shaded region. The min values are used for the
6172 shade_min boundary, and the max values are used on the shade_max
6173 boundary. Set color and width to zero for no plotted boundaries.
6175 fill (PLFILL_callback, input) : Routine used to fill the region.
6176 Use plfill. Future version of PLplot may have other fill
6179 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
6180 map to rectangles after coordinate transformation with pltrl.
6181 Otherwise, set rectangular to false. If rectangular is set to
6182 true, plshade tries to save time by filling large rectangles.
6183 This optimization fails if the coordinate transformation distorts
6184 the shape of rectangles. For example a plot in polar coordinates
6185 has to have rectangular set to false.
6187 pltr (PLTRANSFORM_callback, input) : A callback function that
6188 defines the transformation between the zero-based indices of the
6189 matrix a and world coordinates. If
6190 pltr is not supplied (e.g., is set to NULL in the C case), then the x
6191 indices of a are mapped to the range
6193 xmax and the y indices of a are mapped to the range
6195 ymax.For the C case, transformation functions are provided in the
6196 PLplot library: pltr0 for the identity mapping, and pltr1 and
6197 pltr2 for arbitrary mappings respectively defined by vectors and
6198 matrices. In addition, C callback routines for the transformation
6199 can be supplied by the user such as the mypltr function in
6200 examples/c/x09c.c which provides a general linear transformation
6201 between index coordinates and world coordinates.For languages
6202 other than C you should consult the PLplot documentation for the
6203 details concerning how PLTRANSFORM_callback arguments are
6204 interfaced. However, in general, a particular pattern of
6205 callback-associated arguments such as a tr vector with 6 elements;
6206 xg and yg vectors; or xg and yg matrices are respectively
6207 interfaced to a linear-transformation routine similar to the above
6208 mypltr function; pltr1; and pltr2. Furthermore, some of our more
6209 sophisticated bindings (see, e.g., the PLplot documentation)
6210 support native language callbacks for handling index to
6211 world-coordinate transformations. Examples of these various
6212 approaches are given in examples/<language>x09*,
6213 examples/<language>x16*, examples/<language>x20*,
6214 examples/<language>x21*, and examples/<language>x22*, for all our
6215 supported languages.
6217 pltr_data (PLPointer, input) : Extra parameter to help pass
6218 information to pltr0, pltr1, pltr2, or whatever routine that is
6219 externally supplied.
6222 return _plplotc.plshade(*args)
6226 Assign a function to use for generating custom axis labels
6230 This function allows a user to provide their own function to provide
6231 axis label text. The user function is given the numeric value for a
6232 point on an axis and returns a string label to correspond with that
6233 value. Custom axis labels can be enabled by passing appropriate
6234 arguments to plenv, plbox, plbox3 and similar functions.
6236 This function is used in example 19.
6242 plslabelfunc(label_func, label_data)
6246 label_func (PLLABEL_FUNC_callback, input) : This is the custom
6247 label function. In order to reset to the default labelling, set
6248 this to NULL. The labelling function parameters are, in order:
6249 axis: This indicates which axis a label is being requested for.
6250 The value will be one of PL_X_AXIS, PL_Y_AXIS or PL_Z_AXIS.
6252 value: This is the value along the axis which is being labelled.
6254 label_text: The string representation of the label value.
6256 length: The maximum length in characters allowed for label_text.
6259 label_data (PLPointer, input) : This parameter may be used to pass
6260 data to the label_func function.
6263 return _plplotc.plslabelfunc(lf, data)
6267 Set length of major ticks
6271 This sets up the length of the major ticks. The actual length is the
6272 product of the default length and a scaling factor as for character
6275 Redacted form: plsmaj(def, scale)
6277 This function is used in example 29.
6287 def (PLFLT, input) : The default length of a major tick in
6288 millimeters, should be set to zero if the default length is to
6291 scale (PLFLT, input) : Scale factor to be applied to default to get
6295 return _plplotc.plsmaj(_def, scale)
6299 Set the memory area to be plotted (RGB)
6303 Set the memory area to be plotted (with the mem or memcairo driver) as
6304 the dev member of the stream structure. Also set the number of pixels
6305 in the memory passed in
6306 plotmem, which is a block of memory
6308 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
6310 This memory will have to be freed by the user!
6312 Redacted form: plsmem(maxx, maxy, plotmem)
6314 This function is not used in any examples.
6320 plsmem(maxx, maxy, plotmem)
6324 maxx (PLINT, input) : Size of memory area in the X coordinate.
6326 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6328 plotmem (PLPointer, input) : Pointer to the beginning of a
6329 user-supplied writeable memory area.
6332 return _plplotc.plsmem(maxx, maxy, plotmem)
6336 Set the memory area to be plotted (RGBA)
6340 Set the memory area to be plotted (with the memcairo driver) as the
6341 dev member of the stream structure. Also set the number of pixels in
6342 the memory passed in
6343 plotmem, which is a block of memory
6345 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
6347 This memory will have to be freed by the user!
6349 Redacted form: plsmema(maxx, maxy, plotmem)
6351 This function is not used in any examples.
6357 plsmema(maxx, maxy, plotmem)
6361 maxx (PLINT, input) : Size of memory area in the X coordinate.
6363 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6365 plotmem (PLPointer, input) : Pointer to the beginning of a
6366 user-supplied writeable memory area.
6369 return _plplotc.plsmema(maxx, maxy, plotmem)
6373 Set length of minor ticks
6377 This sets up the length of the minor ticks and the length of the
6378 terminals on error bars. The actual length is the product of the
6379 default length and a scaling factor as for character height.
6381 Redacted form: plsmin(def, scale)
6383 This function is used in example 29.
6393 def (PLFLT, input) : The default length of a minor tick in
6394 millimeters, should be set to zero if the default length is to
6397 scale (PLFLT, input) : Scale factor to be applied to default to get
6401 return _plplotc.plsmin(_def, scale)
6409 Set integer plot orientation parameter. This function is identical to
6410 plsdiori except for the type of the argument, and should be used in
6411 the same way. See the documentation of plsdiori for details.
6413 Redacted form: plsori(ori)
6415 This function is used in example 3.
6425 ori (PLINT, input) : Orientation value (0 for landscape, 1 for
6426 portrait, etc.) The value is multiplied by 90 degrees to get the
6430 return _plplotc.plsori(ori)
6438 Sets the page configuration (optional). If an individual parameter is
6439 zero then that parameter value is not updated. Not all parameters are
6440 recognized by all drivers and the interpretation is device-dependent.
6441 The X-window driver uses the length and offset parameters to determine
6442 the window size and location. The length and offset values are
6443 expressed in units that are specific to the current driver. For
6444 instance: screen drivers will usually interpret them as number of
6445 pixels, whereas printer drivers will usually use mm.
6447 This routine, if used, must be called before initializing PLplot. It
6448 may be called at later times for interactive drivers to change only
6449 the dpi for subsequent redraws which you can force via a call to
6450 plreplot. If this function is not called then the page size defaults
6451 to landscape A4 for drivers which use real world page sizes and 744
6452 pixels wide by 538 pixels high for raster drivers. The default value
6453 for dx and dy is 90 pixels per inch for raster drivers.
6457 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff)
6459 This function is used in examples 14 and 31.
6465 plspage(xp, yp, xleng, yleng, xoff, yoff)
6469 xp (PLFLT, input) : Number of pixels per inch (DPI), x. Used only
6470 by raster drivers, ignored by drivers which use "real world" units
6473 yp (PLFLT, input) : Number of pixels per inch (DPI), y. Used only
6474 by raster drivers, ignored by drivers which use "real world" units
6477 xleng (PLINT, input) : Page length, x.
6479 yleng (PLINT, input) : Page length, y.
6481 xoff (PLINT, input) : Page offset, x.
6483 yoff (PLINT, input) : Page offset, y.
6486 return _plplotc.plspage(xp, yp, xleng, yleng, xoff, yoff)
6490 Set the cmap0 palette using the specified cmap0*.pal format file
6494 Set the cmap0 palette using the specified cmap0*.pal format file.
6496 Redacted form: plspal0(filename)
6498 This function is in example 16.
6508 filename (PLCHAR_VECTOR, input) : An ascii character string
6509 containing the name of the cmap0*.pal file. If this string is
6510 empty, use the default cmap0*.pal file.
6513 return _plplotc.plspal0(filename)
6517 Set the cmap1 palette using the specified cmap1*.pal format file
6521 Set the cmap1 palette using the specified cmap1*.pal format file.
6523 Redacted form: plspal1(filename, interpolate)
6525 This function is used in example 16.
6531 plspal1(filename, interpolate)
6535 filename (PLCHAR_VECTOR, input) : An ascii character string
6536 containing the name of the cmap1*.pal file. If this string is
6537 empty, use the default cmap1*.pal file.
6539 interpolate (PLBOOL, input) : If this parameter is true, the
6540 columns containing the intensity index, r, g, b, alpha and
6541 alt_hue_path in the cmap1*.pal file are used to set the cmap1
6542 palette with a call to plscmap1la. (The cmap1*.pal header contains
6543 a flag which controls whether the r, g, b data sent to plscmap1la
6544 are interpreted as HLS or RGB.) If this parameter is false, the
6545 intensity index and alt_hue_path columns are ignored and the r, g,
6546 b (interpreted as RGB), and alpha columns of the cmap1*.pal file
6547 are used instead to set the cmap1 palette directly with a call to
6551 return _plplotc.plspal1(filename, interpolate)
6555 Set the pause (on end-of-page) status
6559 Set the pause (on end-of-page) status.
6561 Redacted form: plspause(pause)
6563 This function is in examples 14,20.
6573 pause (PLBOOL, input) : If pause is true there will be a pause on
6574 end-of-page for those drivers which support this. Otherwise there
6578 return _plplotc.plspause(pause)
6582 Set current output stream
6586 Sets the number of the current output stream. The stream number
6587 defaults to 0 unless changed by this routine. The first use of this
6588 routine must be followed by a call initializing PLplot (e.g. plstar).
6590 Redacted form: plsstrm(strm)
6592 This function is examples 1,14,20.
6602 strm (PLINT, input) : The current stream number.
6605 return _plplotc.plsstrm(strm)
6609 Set the number of subpages in x and y
6613 Set the number of subpages in x and y.
6615 Redacted form: plssub(nx, ny)
6617 This function is examples 1,2,14,21,25,27.
6627 nx (PLINT, input) : Number of windows in x direction (i.e., number
6630 ny (PLINT, input) : Number of windows in y direction (i.e., number
6634 return _plplotc.plssub(nx, ny)
6642 This sets up the size of all subsequent symbols drawn by plpoin and
6643 plsym. The actual height of a symbol is the product of the default
6644 symbol size and a scaling factor as for the character height.
6646 Redacted form: plssym(def, scale)
6648 This function is used in example 29.
6658 def (PLFLT, input) : The default height of a symbol in millimeters,
6659 should be set to zero if the default height is to remain
6662 scale (PLFLT, input) : Scale factor to be applied to default to get
6663 actual symbol height.
6666 return _plplotc.plssym(_def, scale)
6674 Initializing the plotting package. The program prompts for the device
6675 keyword or number of the desired output device. Hitting a RETURN in
6676 response to the prompt is the same as selecting the first device. If
6677 only one device is enabled when PLplot is installed, plstar will issue
6678 no prompt. The output device is divided into nx by ny subpages, each
6679 of which may be used independently. The subroutine pladv is used to
6680 advance from one subpage to the next.
6682 Redacted form: plstar(nx, ny)
6684 This function is used in example 1.
6694 nx (PLINT, input) : Number of subpages to divide output page in the
6697 ny (PLINT, input) : Number of subpages to divide output page in the
6701 return _plplotc.plstar(nx, ny)
6709 Alternative to plstar for initializing the plotting package. The
6710 device name keyword for the desired output device must be supplied as
6711 an argument. These keywords are the same as those printed out by
6712 plstar. If the requested device is not available, or if the input
6713 string is empty or begins with ``?'', the prompted start up of plstar
6714 is used. This routine also divides the output device page into nx by
6715 ny subpages, each of which may be used independently. The subroutine
6716 pladv is used to advance from one subpage to the next.
6718 Redacted form: General: plstart(devname, nx, ny)
6721 This function is not used in any examples.
6727 plstart(devname, nx, ny)
6731 devname (PLCHAR_VECTOR, input) : An ascii character string
6732 containing the device name keyword of the required output device.
6734 devname is NULL or if the first character of the string is a ``?'',
6735 the normal (prompted) start up is used.
6737 nx (PLINT, input) : Number of subpages to divide output page in the
6740 ny (PLINT, input) : Number of subpages to divide output page in the
6744 return _plplotc.plstart(devname, nx, ny)
6748 Set a global coordinate transform function
6752 This function can be used to define a coordinate transformation which
6753 affects all elements drawn within the current plot window. The
6754 coordinate_transform callback function is similar to that provided for
6755 the plmap and plmeridians functions. The coordinate_transform_data
6756 parameter may be used to pass extra data to coordinate_transform.
6758 Redacted form: General: plstransform(coordinate_transform,
6759 coordinate_transform_data)
6762 This function is used in examples 19 and 22.
6768 plstransform(coordinate_transform, coordinate_transform_data)
6772 coordinate_transform (PLTRANSFORM_callback, input) : A callback
6773 function that defines the transformation from the input (x, y)
6774 world coordinates to new PLplot world coordinates. If
6775 coordinate_transform is not supplied (e.g., is set to NULL in the C
6776 case), then no transform is applied.
6778 coordinate_transform_data (PLPointer, input) : Optional extra data
6780 coordinate_transform.
6783 return _plplotc.plstransform(*args)
6787 Plot a glyph at the specified points
6791 Plot a glyph at the specified points. (Supersedes plpoin and plsym
6792 because many[!] more glyphs are accessible with plstring.) The glyph
6793 is specified with a PLplot user string. Note that the user string is
6794 not actually limited to one glyph so it is possible (but not normally
6795 useful) to plot more than one glyph at the specified points with this
6796 function. As with plmtex and plptex, the user string can contain FCI
6797 escapes to determine the font, UTF-8 code to determine the glyph or
6798 else PLplot escapes for Hershey or unicode text to determine the
6801 Redacted form: plstring(x, y, string)
6803 This function is used in examples 4, 21 and 26.
6809 plstring(n, x, y, string)
6813 n (PLINT, input) : Number of points in the x and y vectors.
6815 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6818 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6821 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6822 the glyph(s) to be plotted at each of the n points.
6825 return _plplotc.plstring(n, ArrayCk, string)
6829 Plot a glyph at the specified 3D points
6833 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because
6834 many[!] more glyphs are accessible with plstring3.) Set up the call to
6835 this function similar to what is done for plline3. The glyph is
6836 specified with a PLplot user string. Note that the user string is not
6837 actually limited to one glyph so it is possible (but not normally
6838 useful) to plot more than one glyph at the specified points with this
6839 function. As with plmtex and plptex, the user string can contain FCI
6840 escapes to determine the font, UTF-8 code to determine the glyph or
6841 else PLplot escapes for Hershey or unicode text to determine the
6844 Redacted form: plstring3(x, y, z, string)
6846 This function is used in example 18.
6852 plstring3(n, x, y, z, string)
6856 n (PLINT, input) : Number of points in the x, y, and z vectors.
6858 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6861 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6864 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
6867 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6868 the glyph(s) to be plotted at each of the n points. points.
6871 return _plplotc.plstring3(n, arg2, arg3, string)
6875 Add a point to a strip chart
6879 Add a point to a given pen of a given strip chart. There is no need
6880 for all pens to have the same number of points or to be equally
6881 sampled in the x coordinate. Allocates memory and rescales as
6884 Redacted form: plstripa(id, pen, x, y)
6886 This function is used in example 17.
6892 plstripa(id, pen, x, y)
6896 id (PLINT, input) : Identification number of the strip chart (set
6899 pen (PLINT, input) : Pen number (ranges from 0 to 3).
6901 x (PLFLT, input) : X coordinate of point to plot.
6903 y (PLFLT, input) : Y coordinate of point to plot.
6906 return _plplotc.plstripa(id, pen, x, y)
6908 def plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop):
6910 Create a 4-pen strip chart
6914 Create a 4-pen strip chart, to be used afterwards by plstripa
6916 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
6917 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
6918 styline, legline, labx, laby, labz)
6921 This function is used in example 17.
6927 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
6931 id (PLINT_NC_SCALAR, output) : Returned value of the identification
6932 number of the strip chart to use on plstripa and plstripd.
6934 xspec (PLCHAR_VECTOR, input) : An ascii character string containing
6935 the x-axis specification as in plbox.
6937 yspec (PLCHAR_VECTOR, input) : An ascii character string containing
6938 the y-axis specification as in plbox.
6940 xmin (PLFLT, input) : Initial coordinates of plot box; they will
6941 change as data are added.
6943 xmax (PLFLT, input) : Initial coordinates of plot box; they will
6944 change as data are added.
6946 xjump (PLFLT, input) : When x attains xmax, the length of the plot
6947 is multiplied by the factor (1 +
6950 ymin (PLFLT, input) : Initial coordinates of plot box; they will
6951 change as data are added.
6953 ymax (PLFLT, input) : Initial coordinates of plot box; they will
6954 change as data are added.
6956 xlpos (PLFLT, input) : X legend box position (range from 0 to 1).
6958 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1).
6960 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is
6961 true, otherwise not.
6963 acc (PLBOOL, input) : Accumulate strip plot if acc is true,
6964 otherwise slide display.
6966 colbox (PLINT, input) : Plot box color index (cmap0).
6968 collab (PLINT, input) : Legend color index (cmap0).
6970 colline (PLINT_VECTOR, input) : A vector containing the cmap0 color
6971 indices for the 4 pens.
6973 styline (PLINT_VECTOR, input) : A vector containing the line style
6974 indices for the 4 pens.
6976 legline (PLCHAR_MATRIX, input) : A vector of UTF-8 character
6977 strings containing legends for the 4 pens.
6979 labx (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6980 the label for the x axis.
6982 laby (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6983 the label for the y axis.
6985 labtop (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6989 return _plplotc.plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop)
6993 Deletes and releases memory used by a strip chart
6997 Deletes and releases memory used by a strip chart.
6999 Redacted form: plstripd(id)
7001 This function is used in example 17.
7011 id (PLINT, input) : Identification number of strip chart to delete.
7014 return _plplotc.plstripd(id)
7022 This sets up the line style for all lines subsequently drawn. A line
7023 consists of segments in which the pen is alternately down and up. The
7024 lengths of these segments are passed in the vectors mark and space
7025 respectively. The number of mark-space pairs is specified by nms. In
7026 order to return the line style to the default continuous line, plstyl
7027 should be called with nms =0 .(see also pllsty)
7029 Redacted form: plstyl(mark, space)
7031 This function is used in examples 1, 9, and 14.
7037 plstyl(nms, mark, space)
7041 nms (PLINT, input) : The number of mark and space elements in a
7042 line. Thus a simple broken line can be obtained by setting nms=1
7043 . A continuous line is specified by setting nms=0 .
7045 mark (PLINT_VECTOR, input) : A vector containing the lengths of the
7046 segments during which the pen is down, measured in micrometers.
7048 space (PLINT_VECTOR, input) : A vector containing the lengths of
7049 the segments during which the pen is up, measured in micrometers.
7052 return _plplotc.plstyl(n, ArrayCk)
7056 Set arrow style for vector plots
7060 Set the style for the arrow used by plvect to plot vectors.
7062 Redacted form: plsvect(arrowx, arrowy, fill)
7064 This function is used in example 22.
7070 plsvect(arrowx, arrowy, npts, fill)
7074 arrowx, arrowy (PLFLT_VECTOR, input) : A pair of vectors containing
7075 the x and y points which make up the arrow. The arrow is plotted
7076 by joining these points to form a polygon. The scaling assumes
7077 that the x and y points in the arrow lie in the range -0.5 <= x,y
7078 <= 0.5. If both arrowx and arrowy are NULL then the arrow style
7079 will be reset to its default.
7081 npts (PLINT, input) : Number of points in the vectors arrowx and
7084 fill (PLBOOL, input) : If fill is true then the arrow is closed, if
7085 fill is false then the arrow is open.
7088 return _plplotc.plsvect(ArrayNull, ArrayCkNull, deffalse)
7092 Specify viewport in absolute coordinates
7096 Alternate routine to plvpor for setting up the viewport. This routine
7097 should be used only if the viewport is required to have a definite
7098 size in millimeters. The routine plgspa is useful for finding out the
7099 size of the current subpage.
7101 Redacted form: plsvpa(xmin, xmax, ymin, ymax)
7103 This function is used in example 10.
7109 plsvpa(xmin, xmax, ymin, ymax)
7113 xmin (PLFLT, input) : The distance of the left-hand edge of the
7114 viewport from the left-hand edge of the subpage in millimeters.
7116 xmax (PLFLT, input) : The distance of the right-hand edge of the
7117 viewport from the left-hand edge of the subpage in millimeters.
7119 ymin (PLFLT, input) : The distance of the bottom edge of the
7120 viewport from the bottom edge of the subpage in millimeters.
7122 ymax (PLFLT, input) : The distance of the top edge of the viewport
7123 from the bottom edge of the subpage in millimeters.
7126 return _plplotc.plsvpa(xmin, xmax, ymin, ymax)
7130 Set x axis parameters
7134 Sets values of the digmax and digits flags for the x axis. See the
7135 PLplot documentation for more information.
7137 Redacted form: plsxax(digmax, digits)
7139 This function is used in example 31.
7145 plsxax(digmax, digits)
7149 digmax (PLINT, input) : Variable to set the maximum number of
7150 digits for the x axis. If nonzero, the printed label will be
7151 switched to a floating-point representation when the number of
7152 digits exceeds digmax.
7154 digits (PLINT, input) : Field digits value. Currently, changing
7155 its value here has no effect since it is set only by plbox or
7156 plbox3. However, the user may obtain its value after a call to
7157 either of these functions by calling plgxax.
7160 return _plplotc.plsxax(digmax, digits)
7164 Set y axis parameters
7168 Identical to plsxax, except that arguments are flags for y axis. See
7169 the description of plsxax for more detail.
7171 Redacted form: plsyax(digmax, digits)
7173 This function is used in examples 1, 14, and 31.
7179 plsyax(digmax, digits)
7183 digmax (PLINT, input) : Variable to set the maximum number of
7184 digits for the y axis. If nonzero, the printed label will be
7185 switched to a floating-point representation when the number of
7186 digits exceeds digmax.
7188 digits (PLINT, input) : Field digits value. Currently, changing
7189 its value here has no effect since it is set only by plbox or
7190 plbox3. However, the user may obtain its value after a call to
7191 either of these functions by calling plgyax.
7194 return _plplotc.plsyax(digmax, digits)
7198 Plot a glyph at the specified points
7202 Plot a glyph at the specified points. (This function is largely
7203 superseded by plstring which gives access to many[!] more glyphs.)
7205 Redacted form: plsym(x, y, code)
7207 This function is used in example 7.
7213 plsym(n, x, y, code)
7217 n (PLINT, input) : Number of points in the x and y vectors.
7219 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
7222 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
7225 code (PLINT, input) : Hershey symbol code corresponding to a glyph
7226 to be plotted at each of the n points.
7229 return _plplotc.plsym(n, ArrayCk, code)
7233 Set z axis parameters
7237 Identical to plsxax, except that arguments are flags for z axis. See
7238 the description of plsxax for more detail.
7240 Redacted form: plszax(digmax, digits)
7242 This function is used in example 31.
7248 plszax(digmax, digits)
7252 digmax (PLINT, input) : Variable to set the maximum number of
7253 digits for the z axis. If nonzero, the printed label will be
7254 switched to a floating-point representation when the number of
7255 digits exceeds digmax.
7257 digits (PLINT, input) : Field digits value. Currently, changing
7258 its value here has no effect since it is set only by plbox or
7259 plbox3. However, the user may obtain its value after a call to
7260 either of these functions by calling plgzax.
7263 return _plplotc.plszax(digmax, digits)
7267 Switch to text screen
7271 Sets an interactive device to text mode, used in conjunction with
7272 plgra to allow graphics and text to be interspersed. On a device
7273 which supports separate text and graphics windows, this command causes
7274 control to be switched to the text window. This can be useful for
7275 printing diagnostic messages or getting user input, which would
7276 otherwise interfere with the plots. The program must switch back to
7277 the graphics window before issuing plot commands, as the text (or
7278 console) device will probably become quite confused otherwise. If
7279 already in text mode, this command is ignored. It is also ignored on
7280 devices which only support a single window or use a different method
7281 for shifting focus (see also plgra).
7283 Redacted form: pltext()
7285 This function is used in example 1.
7294 return _plplotc.pltext()
7298 Set format for date / time labels
7302 Sets the format for date / time labels. To enable date / time format
7303 labels see the options to plbox, plbox3, and plenv.
7305 Redacted form: pltimefmt(fmt)
7307 This function is used in example 29.
7317 fmt (PLCHAR_VECTOR, input) : An ascii character string which is
7318 interpreted similarly to the format specifier of typical system
7319 strftime routines except that PLplot ignores locale and also
7320 supplies some useful extensions in the context of plotting. All
7321 text in the string is printed as-is other than conversion
7322 specifications which take the form of a '%' character followed by
7323 further conversion specification character. The conversion
7324 specifications which are similar to those provided by system
7325 strftime routines are the following: %a: The abbreviated (English)
7327 %A: The full (English) weekday name.
7328 %b: The abbreviated (English) month name.
7329 %B: The full (English) month name.
7330 %c: Equivalent to %a %b %d %T %Y (non-ISO).
7331 %C: The century number (year/100) as a 2-digit integer.
7332 %d: The day of the month as a decimal number (range 01 to 31).
7333 %D: Equivalent to %m/%d/%y (non-ISO).
7334 %e: Like %d, but a leading zero is replaced by a space.
7335 %F: Equivalent to %Y-%m-%d (the ISO 8601 date format).
7336 %h: Equivalent to %b.
7337 %H: The hour as a decimal number using a 24-hour clock (range
7339 %I: The hour as a decimal number using a 12-hour clock (range
7341 %j: The day of the year as a decimal number (range 001 to
7343 %k: The hour (24-hour clock) as a decimal number (range 0 to
7344 23); single digits are preceded by a blank. (See also %H.)
7345 %l: The hour (12-hour clock) as a decimal number (range 1 to
7346 12); single digits are preceded by a blank. (See also %I.)
7347 %m: The month as a decimal number (range 01 to 12).
7348 %M: The minute as a decimal number (range 00 to 59).
7349 %n: A newline character.
7350 %p: Either "AM" or "PM" according to the given time value.
7351 Noon is treated as "PM" and midnight as "AM".
7352 %r: Equivalent to %I:%M:%S %p.
7353 %R: The time in 24-hour notation (%H:%M). For a version
7354 including the seconds, see %T below.
7355 %s: The number of seconds since the Epoch, 1970-01-01 00:00:00
7357 %S: The second as a decimal number (range 00 to 60). (The
7358 range is up to 60 to allow for occasional leap seconds.)
7359 %t: A tab character.
7360 %T: The time in 24-hour notation (%H:%M:%S).
7361 %u: The day of the week as a decimal, range 1 to 7, Monday
7362 being 1. See also %w.
7363 %U: The week number of the current year as a decimal number,
7364 range 00 to 53, starting with the first Sunday as the first
7365 day of week 01. See also %V and %W.
7366 %v: Equivalent to %e-%b-%Y.
7367 %V: The ISO 8601 week number of the current year as a decimal
7368 number, range 01 to 53, where week 1 is the first week that
7369 has at least 4 days in the new year. See also %U and %W.
7370 %w: The day of the week as a decimal, range 0 to 6, Sunday
7371 being 0. See also %u.
7372 %W: The week number of the current year as a decimal number,
7373 range 00 to 53, starting with the first Monday as the first
7375 %x: Equivalent to %a %b %d %Y.
7376 %X: Equivalent to %T.
7377 %y: The year as a decimal number without a century (range 00
7379 %Y: The year as a decimal number including a century.
7380 %z: The UTC time-zone string = "+0000".
7381 %Z: The UTC time-zone abbreviation = "UTC".
7382 %+: The UTC date and time in default format of the Unix date
7383 command which is equivalent to %a %b %d %T %Z %Y.
7384 %%: A literal "%" character.
7385 The conversion specifications which are extensions to those normally
7386 provided by system strftime routines are the following: %(0-9):
7387 The fractional part of the seconds field (including leading
7388 decimal point) to the specified accuracy. Thus %S%3 would give
7389 seconds to millisecond accuracy (00.000).
7390 %.: The fractional part of the seconds field (including
7391 leading decimal point) to the maximum available accuracy. Thus
7392 %S%. would give seconds with fractional part up to 9 decimal
7393 places if available.
7396 return _plplotc.pltimefmt(fmt)
7400 Specify viewport using aspect ratio only
7404 Selects the largest viewport with the given aspect ratio within the
7405 subpage that leaves a standard margin (left-hand margin of eight
7406 character heights, and a margin around the other three sides of five
7409 Redacted form: plvasp(aspect)
7411 This function is used in example 13.
7421 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7422 axis of resulting viewport.
7425 return _plplotc.plvasp(aspect)
7433 Draws a plot of vector data contained in the matrices (
7439 ny]) . The scaling factor for the vectors is given by scale. A
7440 transformation routine pointed to by pltr with a pointer pltr_data for
7441 additional data required by the transformation routine to map indices
7442 within the matrices to the world coordinates. The style of the vector
7443 arrow may be set using plsvect.
7445 Redacted form: plvect(u, v, scale, pltr, pltr_data) where (see above
7446 discussion) the pltr, pltr_data callback arguments are sometimes
7447 replaced by a tr vector with 6 elements, or xg and yg array arguments
7448 with either one or two dimensions.
7450 This function is used in example 22.
7456 plvect(u, v, nx, ny, scale, pltr, pltr_data)
7460 u, v (PLFLT_MATRIX, input) : A pair of matrices containing the x
7461 and y components of the vector data to be plotted.
7463 nx, ny (PLINT, input) : Dimensions of the matrices u and v.
7465 scale (PLFLT, input) : Parameter to control the scaling factor of
7466 the vectors for plotting. If scale = 0 then the scaling factor is
7467 automatically calculated for the data. If scale < 0 then the
7468 scaling factor is automatically calculated for the data and then
7470 scale. If scale > 0 then the scaling factor is set to scale.
7472 pltr (PLTRANSFORM_callback, input) : A callback function that
7473 defines the transformation between the zero-based indices of the
7474 matrices u and v and world coordinates.For the C case,
7475 transformation functions are provided in the PLplot library: pltr0
7476 for the identity mapping, and pltr1 and pltr2 for arbitrary
7477 mappings respectively defined by vectors and matrices. In
7478 addition, C callback routines for the transformation can be
7479 supplied by the user such as the mypltr function in
7480 examples/c/x09c.c which provides a general linear transformation
7481 between index coordinates and world coordinates.For languages
7482 other than C you should consult the PLplot documentation for the
7483 details concerning how PLTRANSFORM_callback arguments are
7484 interfaced. However, in general, a particular pattern of
7485 callback-associated arguments such as a tr vector with 6 elements;
7486 xg and yg vectors; or xg and yg matrices are respectively
7487 interfaced to a linear-transformation routine similar to the above
7488 mypltr function; pltr1; and pltr2. Furthermore, some of our more
7489 sophisticated bindings (see, e.g., the PLplot documentation)
7490 support native language callbacks for handling index to
7491 world-coordinate transformations. Examples of these various
7492 approaches are given in examples/<language>x09*,
7493 examples/<language>x16*, examples/<language>x20*,
7494 examples/<language>x21*, and examples/<language>x22*, for all our
7495 supported languages.
7497 pltr_data (PLPointer, input) : Extra parameter to help pass
7498 information to pltr0, pltr1, pltr2, or whatever callback routine
7499 that is externally supplied.
7502 return _plplotc.plvect(*args)
7506 Specify viewport using coordinates and aspect ratio
7510 Device-independent routine for setting up the viewport. The viewport
7511 is chosen to be the largest with the given aspect ratio that fits
7512 within the specified region (in terms of normalized subpage
7513 coordinates). This routine is functionally equivalent to plvpor when
7514 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this
7515 routine reserves no extra space at the edges for labels.
7517 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect)
7519 This function is used in example 9.
7525 plvpas(xmin, xmax, ymin, ymax, aspect)
7529 xmin (PLFLT, input) : The normalized subpage coordinate of the
7530 left-hand edge of the viewport.
7532 xmax (PLFLT, input) : The normalized subpage coordinate of the
7533 right-hand edge of the viewport.
7535 ymin (PLFLT, input) : The normalized subpage coordinate of the
7536 bottom edge of the viewport.
7538 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7539 edge of the viewport.
7541 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7545 return _plplotc.plvpas(xmin, xmax, ymin, ymax, aspect)
7549 Specify viewport using normalized subpage coordinates
7553 Device-independent routine for setting up the viewport. This defines
7554 the viewport in terms of normalized subpage coordinates which run from
7555 0.0 to 1.0 (left to right and bottom to top) along each edge of the
7556 current subpage. Use the alternate routine plsvpa in order to create
7557 a viewport of a definite size.
7559 Redacted form: plvpor(xmin, xmax, ymin, ymax)
7561 This function is used in examples 2, 6-8, 10, 11, 15, 16, 18, 21, 23,
7568 plvpor(xmin, xmax, ymin, ymax)
7572 xmin (PLFLT, input) : The normalized subpage coordinate of the
7573 left-hand edge of the viewport.
7575 xmax (PLFLT, input) : The normalized subpage coordinate of the
7576 right-hand edge of the viewport.
7578 ymin (PLFLT, input) : The normalized subpage coordinate of the
7579 bottom edge of the viewport.
7581 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7582 edge of the viewport.
7585 return _plplotc.plvpor(xmin, xmax, ymin, ymax)
7589 Select standard viewport
7593 Selects the largest viewport within the subpage that leaves a standard
7594 margin (left-hand margin of eight character heights, and a margin
7595 around the other three sides of five character heights).
7597 Redacted form: plvsta()
7599 This function is used in examples 1, 12, 14, 17, 25, and 29.
7608 return _plplotc.plvsta()
7610 def plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az):
7612 Configure the transformations required for projecting a 3D surface on a 2D window
7616 Configure the transformations required for projecting a 3D surface on
7617 an existing 2D window. Those transformations (see the PLplot
7618 documentation) are done to a rectangular cuboid enclosing the 3D
7619 surface which has its limits expressed in 3D world coordinates and
7620 also normalized 3D coordinates (used for interpreting the altitude and
7621 azimuth of the viewing angle). The transformations consist of the
7622 linear transform from 3D world coordinates to normalized 3D
7623 coordinates, and the 3D rotation of normalized coordinates required to
7624 align the pole of the new 3D coordinate system with the viewing
7625 direction specified by altitude and azimuth so that x and y of the
7626 surface elements in that transformed coordinate system are the
7627 projection of the 3D surface with given viewing direction on the 2D
7630 The enclosing rectangular cuboid for the surface plot is defined by
7631 xmin, xmax, ymin, ymax, zmin and zmax in 3D world coordinates. It is
7632 mapped into the same rectangular cuboid with normalized 3D coordinate
7633 sizes of basex by basey by height so that xmin maps to -
7634 basex/2, xmax maps to basex/2, ymin maps to -
7635 basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height.
7636 The resulting rectangular cuboid in normalized coordinates is then
7637 viewed by an observer at altitude alt and azimuth az. This routine
7638 must be called before plbox3 or any of the 3D surface plotting
7639 routines; plmesh, plmeshc, plot3d, plot3dc, plot3dcl, plsurf3d,
7640 plsurf3dl or plfill3.
7642 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
7643 zmin, zmax, alt, az)
7645 This function is examples 8, 11, 18, and 21.
7651 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
7655 basex (PLFLT, input) : The normalized x coordinate size of the
7658 basey (PLFLT, input) : The normalized y coordinate size of the
7661 height (PLFLT, input) : The normalized z coordinate size of the
7664 xmin (PLFLT, input) : The minimum x world coordinate of the
7667 xmax (PLFLT, input) : The maximum x world coordinate of the
7670 ymin (PLFLT, input) : The minimum y world coordinate of the
7673 ymax (PLFLT, input) : The maximum y world coordinate of the
7676 zmin (PLFLT, input) : The minimum z world coordinate of the
7679 zmax (PLFLT, input) : The maximum z world coordinate of the
7682 alt (PLFLT, input) : The viewing altitude in degrees above the xy
7683 plane of the rectangular cuboid in normalized coordinates.
7685 az (PLFLT, input) : The viewing azimuth in degrees of the
7686 rectangular cuboid in normalized coordinates. When az=0, the
7687 observer is looking face onto the zx plane of the rectangular
7688 cuboid in normalized coordinates, and as az is increased, the
7689 observer moves clockwise around that cuboid when viewed from above
7693 return _plplotc.plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az)
7703 Redacted form: plwidth(width)
7705 This function is used in examples 1 and 2.
7715 width (PLFLT, input) : The desired pen width. If width is negative
7716 or the same as the previous value no action is taken. width = 0.
7717 should be interpreted as as the minimum valid pen width for the
7718 device. The interpretation of positive width values is also
7722 return _plplotc.plwidth(width)
7730 Specify the window, i.e., the world coordinates of the edges of the
7733 Redacted form: plwind(xmin, xmax, ymin, ymax)
7735 This function is used in examples 1, 2, 4, 6-12, 14-16, 18, 21, 23-27,
7742 plwind(xmin, xmax, ymin, ymax)
7746 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
7749 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
7752 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
7755 ymax (PLFLT, input) : The world y coordinate of the top edge of the
7759 return _plplotc.plwind(xmin, xmax, ymin, ymax)
7763 Enter or leave xor mode
7767 Enter (when mode is true) or leave (when mode is false) xor mode for
7768 those drivers (e.g., the xwin driver) that support it. Enables
7769 erasing plots by drawing twice the same line, symbol, etc. If driver
7770 is not capable of xor operation it returns a status of false.
7772 Redacted form: plxormod(mode, status)
7774 This function is used in examples 1 and 20.
7780 plxormod(mode, status)
7784 mode (PLBOOL, input) : mode is true means enter xor mode and mode
7785 is false means leave xor mode.
7787 status (PLBOOL_NC_SCALAR, output) : Returned value of the status.
7788 modestatus of true (false) means driver is capable (incapable) of
7792 return _plplotc.plxormod(mode)
7794 def plmap(mapform, type, minx, maxx, miny, maxy):
7796 Plot continental outline or shapefile data in world coordinates
7800 Plots continental outlines or shapefile data in world coordinates. A
7801 demonstration of how to use this function to create different
7802 projections can be found in examples/c/x19c. PLplot is provided with
7803 basic coastal outlines and USA state borders. To use the map
7804 functionality PLplot must be compiled with the shapelib library.
7805 Shapefiles have become a popular standard for geographical data and
7806 data in this format can be easily found from a number of online
7807 sources. Shapefile data is actually provided as three or more files
7808 with the same filename, but different extensions. The .shp and .shx
7809 files are required for plotting Shapefile data with PLplot.
7811 PLplot currently supports the point, multipoint, polyline and polygon
7812 objects within shapefiles. However holes in polygons are not
7813 supported. When plmap is used the type of object is derived from the
7814 shapefile, if you wish to override the type then use one of the other
7815 plmap variants. The built in maps have line data only.
7817 Redacted form: plmap(mapform, name, minx, maxx, miny, maxy)
7819 This function is used in example 19.
7825 plmap(mapform, name, minx, maxx, miny, maxy)
7829 mapform (PLMAPFORM_callback, input) : A user supplied function to
7830 transform the original map data coordinates to a new coordinate
7831 system. The PLplot-supplied map data is provided as latitudes and
7832 longitudes; other Shapefile data may be provided in other
7833 coordinate systems as can be found in their .prj plain text files.
7834 For example, by using this transform we can change from a
7835 longitude, latitude coordinate to a polar stereographic
7836 projection. Initially, x[0]..[n-1] are the original x coordinates
7837 (longitudes for the PLplot-supplied data) and y[0]..y[n-1] are the
7838 corresponding y coordinates (latitudes for the PLplot supplied
7839 data). After the call to mapform(), x[] and y[] should be
7840 replaced by the corresponding plot coordinates. If no transform is
7841 desired, mapform can be replaced by NULL.
7843 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7844 the type of map plotted. This is either one of the PLplot built-in
7845 maps or the file name of a set of Shapefile files without the file
7846 extensions. For the PLplot built-in maps the possible values are:
7847 "globe" -- continental outlines
7848 "usa" -- USA and state boundaries
7849 "cglobe" -- continental outlines and countries
7850 "usaglobe" -- USA, state boundaries and continental outlines
7853 minx (PLFLT, input) : The minimum x value of map elements to be
7854 drawn. The units must match the shapefile (built in maps are
7855 degrees lat/lon). Objects in the file which do not encroach on the
7856 box defined by minx, maxx, miny, maxy will not be rendered. But
7857 note this is simply an optimisation, not a clipping so for objects
7858 with some points inside the box and some points outside the box
7859 all the points will be rendered. These parameters also define
7860 latitude and longitude wrapping for shapefiles using these units.
7861 Longitude points will be wrapped by integer multiples of 360
7862 degrees to place them in the box. This allows the same data to be
7863 used on plots from -180-180 or 0-360 longitude ranges. In fact if
7864 you plot from -180-540 you will get two cycles of data drawn. The
7865 value of minx must be less than the value of maxx. Passing in a
7866 nan, max/-max floating point number or +/-infinity will case the
7867 bounding box from the shapefile to be used.
7869 maxx (PLFLT, input) : The maximum x value of map elements to be
7872 miny (PLFLT, input) : The minimum y value of map elements to be
7875 maxy (PLFLT, input) : The maximum y value of map elements to be
7879 return _plplotc.plmap(mapform, type, minx, maxx, miny, maxy)
7881 def plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull):
7883 Plot all or a subset of Shapefile data using lines in world coordinates
7887 Plot all or a subset of Shapefile data using lines in world
7888 coordinates. Our 19th standard example demonstrates how to use this
7889 function. This function plots data from a Shapefile using lines as in
7890 plmap, however it also has the option of also only drawing specified
7891 elements from the Shapefile. The vector of indices of the required
7892 elements are passed as a function argument. The Shapefile data should
7893 include a metadata file (extension.dbf) listing all items within the
7894 Shapefile. This file can be opened by most popular spreadsheet
7895 programs and can be used to decide which indices to pass to this
7898 Redacted form: plmapline(mapform, name, minx, maxx, miny, maxy,
7901 This function is used in example 19.
7907 plmapline(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
7911 mapform (PLMAPFORM_callback, input) : A user supplied function to
7912 transform the coordinates given in the shapefile into a plot
7913 coordinate system. By using this transform, we can change from a
7914 longitude, latitude coordinate to a polar stereographic project,
7915 for example. Initially, x[0]..[n-1] are the longitudes and
7916 y[0]..y[n-1] are the corresponding latitudes. After the call to
7917 mapform(), x[] and y[] should be replaced by the corresponding
7918 plot coordinates. If no transform is desired, mapform can be
7921 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7922 the file name of a set of Shapefile files without the file
7925 minx (PLFLT, input) : The minimum x value to be plotted. This must
7926 be in the same units as used by the Shapefile. You could use a
7927 very large negative number to plot everything, but you can improve
7928 performance by limiting the area drawn. The units must match those
7929 of the Shapefile projection, which may be for example longitude or
7930 distance. The value of minx must be less than the value of maxx.
7932 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7933 use a very large number to plot everything, but you can improve
7934 performance by limiting the area drawn.
7936 miny (PLFLT, input) : The minimum y value to be plotted. This must
7937 be in the same units as used by the Shapefile. You could use a
7938 very large negative number to plot everything, but you can improve
7939 performance by limiting the area drawn. The units must match those
7940 of the Shapefile projection, which may be for example latitude or
7941 distance. The value of miny must be less than the value of maxy.
7943 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7944 use a very large number to plot everything, but you can improve
7945 performance by limiting the area drawn.
7947 plotentries (PLINT_VECTOR, input) : A vector containing the
7948 zero-based indices of the Shapefile elements which will be drawn.
7950 plotentries to NULL will plot all elements of the Shapefile.
7952 nplotentries (PLINT, input) : The number of items in
7953 plotentries. Ignored if
7954 plotentries is NULL.
7957 return _plplotc.plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull)
7959 def plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull):
7961 Plot all or a subset of Shapefile data using strings or points in world coordinates
7965 As per plmapline, however the items are plotted as strings or points
7966 in the same way as plstring.
7968 Redacted form: plmapstring(mapform, name, string, minx, maxx, miny,
7971 This function is not used in any examples.
7977 plmapstring(mapform, name, string, minx, maxx, miny, maxy, plotentries, nplotentries)
7981 mapform (PLMAPFORM_callback, input) : A user supplied function to
7982 transform the coordinates given in the shapefile into a plot
7983 coordinate system. By using this transform, we can change from a
7984 longitude, latitude coordinate to a polar stereographic project,
7985 for example. Initially, x[0]..[n-1] are the longitudes and
7986 y[0]..y[n-1] are the corresponding latitudes. After the call to
7987 mapform(), x[] and y[] should be replaced by the corresponding
7988 plot coordinates. If no transform is desired, mapform can be
7991 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7992 the file name of a set of Shapefile files without the file
7995 string (PLCHAR_VECTOR, input) : A UTF-8 character string to be
7998 minx (PLFLT, input) : The minimum x value to be plotted. This must
7999 be in the same units as used by the Shapefile. You could use a
8000 very large negative number to plot everything, but you can improve
8001 performance by limiting the area drawn. The units must match those
8002 of the Shapefile projection, which may be for example longitude or
8003 distance. The value of minx must be less than the value of maxx.
8005 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8006 use a very large number to plot everything, but you can improve
8007 performance by limiting the area drawn.
8009 miny (PLFLT, input) : The minimum y value to be plotted. This must
8010 be in the same units as used by the Shapefile. You could use a
8011 very large negative number to plot everything, but you can improve
8012 performance by limiting the area drawn. The units must match those
8013 of the Shapefile projection, which may be for example latitude or
8014 distance. The value of miny must be less than the value of maxy.
8016 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8017 use a very large number to plot everything, but you can improve
8018 performance by limiting the area drawn.
8020 plotentries (PLINT_VECTOR, input) : A vector containing the
8021 zero-based indices of the Shapefile elements which will be drawn.
8023 plotentries to NULL will plot all elements of the Shapefile.
8025 nplotentries (PLINT, input) : The number of items in
8026 plotentries. Ignored if
8027 plotentries is NULL.
8030 return _plplotc.plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull)
8032 def plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry):
8034 Draw text at points defined by Shapefile data in world coordinates
8038 As per plmapline, however the items are plotted as text in the same
8041 Redacted form: plmaptex(mapform, name, dx, dy, just, text, minx, maxx,
8042 miny, maxy, plotentry)
8044 This function is used in example 19.
8050 plmaptex(mapform, name, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8054 mapform (PLMAPFORM_callback, input) : A user supplied function to
8055 transform the coordinates given in the shapefile into a plot
8056 coordinate system. By using this transform, we can change from a
8057 longitude, latitude coordinate to a polar stereographic project,
8058 for example. Initially, x[0]..[n-1] are the longitudes and
8059 y[0]..y[n-1] are the corresponding latitudes. After the call to
8060 mapform(), x[] and y[] should be replaced by the corresponding
8061 plot coordinates. If no transform is desired, mapform can be
8064 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8065 the file name of a set of Shapefile files without the file
8068 dx (PLFLT, input) : Used to define the slope of the texts which is
8071 dy (PLFLT, input) : Used to define the slope of the texts which is
8074 just (PLFLT, input) : Set the justification of the text. The value
8075 given will be the fraction of the distance along the string that
8076 sits at the given point. 0.0 gives left aligned text, 0.5 gives
8077 centralized text and 1.0 gives right aligned text.
8079 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be drawn.
8081 minx (PLFLT, input) : The minimum x value to be plotted. This must
8082 be in the same units as used by the Shapefile. You could use a
8083 very large negative number to plot everything, but you can improve
8084 performance by limiting the area drawn. The units must match those
8085 of the Shapefile projection, which may be for example longitude or
8086 distance. The value of minx must be less than the value of maxx.
8088 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8089 use a very large number to plot everything, but you can improve
8090 performance by limiting the area drawn.
8092 miny (PLFLT, input) : The minimum y value to be plotted. This must
8093 be in the same units as used by the Shapefile. You could use a
8094 very large negative number to plot everything, but you can improve
8095 performance by limiting the area drawn. The units must match those
8096 of the Shapefile projection, which may be for example latitude or
8097 distance. The value of miny must be less than the value of maxy.
8099 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8100 use a very large number to plot everything, but you can improve
8101 performance by limiting the area drawn.
8103 plotentry (PLINT, input) : An integer indicating which text string
8104 of the Shapefile (zero indexed) will be drawn.
8107 return _plplotc.plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8109 def plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull):
8111 Plot all or a subset of Shapefile data, filling the polygons
8115 As per plmapline, however the items are filled in the same way as
8118 Redacted form: plmapfill(mapform, name, minx, maxx, miny, maxy,
8121 This function is used in example 19.
8127 plmapfill(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
8131 mapform (PLMAPFORM_callback, input) : A user supplied function to
8132 transform the coordinates given in the shapefile into a plot
8133 coordinate system. By using this transform, we can change from a
8134 longitude, latitude coordinate to a polar stereographic project,
8135 for example. Initially, x[0]..[n-1] are the longitudes and
8136 y[0]..y[n-1] are the corresponding latitudes. After the call to
8137 mapform(), x[] and y[] should be replaced by the corresponding
8138 plot coordinates. If no transform is desired, mapform can be
8141 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8142 the file name of a set of Shapefile files without the file
8145 minx (PLFLT, input) : The minimum x value to be plotted. This must
8146 be in the same units as used by the Shapefile. You could use a
8147 very large negative number to plot everything, but you can improve
8148 performance by limiting the area drawn. The units must match those
8149 of the Shapefile projection, which may be for example longitude or
8150 distance. The value of minx must be less than the value of maxx.
8152 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8153 use a very large number to plot everything, but you can improve
8154 performance by limiting the area drawn.
8156 miny (PLFLT, input) : The minimum y value to be plotted. This must
8157 be in the same units as used by the Shapefile. You could use a
8158 very large negative number to plot everything, but you can improve
8159 performance by limiting the area drawn. The units must match those
8160 of the Shapefile projection, which may be for example latitude or
8161 distance. The value of miny must be less than the value of maxy.
8163 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8164 use a very large number to plot everything, but you can improve
8165 performance by limiting the area drawn.
8167 plotentries (PLINT_VECTOR, input) : A vector containing the
8168 zero-based indices of the Shapefile elements which will be drawn.
8170 plotentries to NULL will plot all elements of the Shapefile.
8172 nplotentries (PLINT, input) : The number of items in
8173 plotentries. Ignored if
8174 plotentries is NULL.
8177 return _plplotc.plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull)
8179 def plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat):
8181 Plot latitude and longitude lines
8185 Displays latitude and longitude on the current plot. The lines are
8186 plotted in the current color and line style.
8188 Redacted form: plmeridians(mapform, dlong, dlat, minlong, maxlong,
8191 This function is used in example 19.
8197 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8201 mapform (PLMAPFORM_callback, input) : A user supplied function to
8202 transform the coordinate longitudes and latitudes to a plot
8203 coordinate system. By using this transform, we can change from a
8204 longitude, latitude coordinate to a polar stereographic project,
8205 for example. Initially, x[0]..[n-1] are the longitudes and
8206 y[0]..y[n-1] are the corresponding latitudes. After the call to
8207 mapform(), x[] and y[] should be replaced by the corresponding
8208 plot coordinates. If no transform is desired, mapform can be
8211 dlong (PLFLT, input) : The interval in degrees at which the
8212 longitude lines are to be plotted.
8214 dlat (PLFLT, input) : The interval in degrees at which the latitude
8215 lines are to be plotted.
8217 minlong (PLFLT, input) : The value of the longitude on the left
8218 side of the plot. The value of minlong must be less than the value
8219 of maxlong, and the quantity maxlong-minlong must be less than or
8222 maxlong (PLFLT, input) : The value of the longitude on the right
8225 minlat (PLFLT, input) : The minimum latitude to be plotted on the
8226 background. One can always use -90.0 as the boundary outside the
8227 plot window will be automatically eliminated. However, the
8228 program will be faster if one can reduce the size of the
8231 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
8232 background. One can always use 90.0 as the boundary outside the
8233 plot window will be automatically eliminated.
8236 return _plplotc.plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8238 def plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax):
8240 Plot a 2D matrix using cmap1 with automatic color adjustment
8244 Plot a 2D matrix using the cmap1 palette. The color scale is
8245 automatically adjusted to use the maximum and minimum values in idata
8246 as valuemin and valuemax in a call to plimagefr.
8248 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin,
8249 zmax, Dxmin, Dxmax, Dymin, Dymax)
8252 This function is used in example 20.
8258 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8262 idata (PLFLT_MATRIX, input) : A matrix containing function values
8263 to plot. Should have dimensions of
8267 nx, ny (PLINT, input) : Dimensions of idata
8269 xmin, xmax, ymin, ymax (PLFLT, input) : The x and y index ranges
8270 are linearly transformed to these world coordinate ranges such
8271 that idata[0][0] corresponds to (xmin, ymin) and idata[nx - 1][ny
8272 - 1] corresponds to (xmax, ymax).
8274 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
8275 (inclusive) will be plotted.
8277 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
8278 points whose plot coordinates fall inside the window of (Dxmin,
8279 Dymin) to (Dxmax, Dymax).
8282 return _plplotc.plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8286 Plot a 2D matrix using cmap1
8290 Plot a 2D matrix using cmap1.
8292 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin,
8293 zmax, valuemin, valuemax, pltr, pltr_data)
8296 This function is used in example 20.
8302 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
8306 idata (PLFLT_MATRIX, input) : A matrix of values (intensities) to
8307 plot. Should have dimensions of
8311 nx, ny (PLINT, input) : Dimensions of idata
8313 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
8314 pltr below for how these arguments are used (only for the special case
8315 when the callback function
8316 pltr is not supplied).
8318 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
8319 (inclusive) will be plotted.
8321 valuemin, valuemax (PLFLT, input) : The minimum and maximum data
8322 values to use for value to color mappings. A datum equal to or
8323 less than valuemin will be plotted with color 0.0, while a datum
8324 equal to or greater than valuemax will be plotted with color 1.0.
8325 Data between valuemin and valuemax map linearly to colors in the
8328 pltr (PLTRANSFORM_callback, input) : A callback function that
8329 defines the transformation between the zero-based indices of the
8330 matrix idata and world coordinates. If
8331 pltr is not supplied (e.g., is set to NULL in the C case), then the x
8332 indices of idata are mapped to the range
8334 xmax and the y indices of idata are mapped to the range
8336 ymax.For the C case, transformation functions are provided in the
8337 PLplot library: pltr0 for the identity mapping, and pltr1 and
8338 pltr2 for arbitrary mappings respectively defined by vectors and
8339 matrices. In addition, C callback routines for the transformation
8340 can be supplied by the user such as the mypltr function in
8341 examples/c/x09c.c which provides a general linear transformation
8342 between index coordinates and world coordinates.For languages
8343 other than C you should consult the PLplot documentation for the
8344 details concerning how PLTRANSFORM_callback arguments are
8345 interfaced. However, in general, a particular pattern of
8346 callback-associated arguments such as a tr vector with 6 elements;
8347 xg and yg vectors; or xg and yg matrices are respectively
8348 interfaced to a linear-transformation routine similar to the above
8349 mypltr function; pltr1; and pltr2. Furthermore, some of our more
8350 sophisticated bindings (see, e.g., the PLplot documentation)
8351 support native language callbacks for handling index to
8352 world-coordinate transformations. Examples of these various
8353 approaches are given in examples/<language>x09*,
8354 examples/<language>x16*, examples/<language>x20*,
8355 examples/<language>x21*, and examples/<language>x22*, for all our
8356 supported languages.
8358 pltr_data (PLPointer, input) : Extra parameter to help pass
8359 information to pltr0, pltr1, pltr2, or whatever routine is
8360 externally supplied.
8363 return _plplotc.plimagefr(*args)
8366 return _plplotc.plClearOpts()
8369 return _plplotc.plResetOpts()
8372 return _plplotc.plSetUsage(program_string, usage_string)
8375 return _plplotc.plOptUsage()
8378 return _plplotc.plMinMax2dGrid(Matrix)
8382 Wait for graphics input event and translate to world coordinates.
8386 Wait for graphics input event and translate to world coordinates.
8387 Returns 0 if no translation to world coordinates is possible.
8389 This function returns 1 on success and 0 if no translation to world
8390 coordinates is possible.
8392 Redacted form: plGetCursor(gin)
8394 This function is used in examples 1 and 20.
8400 PLINT plGetCursor(gin)
8404 gin (PLGraphicsIn *, output) : Pointer to PLGraphicsIn structure
8405 which will contain the output. The structure is not allocated by
8406 the routine and must exist before the function is called.
8409 return _plplotc.plGetCursor(gin)