7 from sys
import version_info
as _swig_python_version_info
8 if _swig_python_version_info >= (2, 7, 0):
11 pkg = __name__.rpartition(
'.')[0]
12 mname =
'.'.join((pkg,
'_plplotc')).lstrip(
'.')
14 return importlib.import_module(mname)
16 return importlib.import_module(
'_plplotc')
18 del swig_import_helper
19 elif _swig_python_version_info >= (2, 6, 0):
21 from os.path
import dirname
25 fp, pathname, description = imp.find_module(
'_plplotc', [dirname(__file__)])
30 _mod = imp.load_module(
'_plplotc', fp, pathname, description)
36 del swig_import_helper
39 del _swig_python_version_info
42 _swig_property = property
47 import builtins
as __builtin__
52 if (name ==
"thisown"):
53 return self.this.own(value)
55 if type(value).__name__ ==
'SwigPyObject':
56 self.__dict__[name] = value
58 method = class_type.__swig_setmethods__.get(name,
None)
60 return method(self, value)
63 object.__setattr__(self, name, value)
65 self.__dict__[name] = value
67 raise AttributeError(
"You cannot add attributes to %s" % self)
75 if (name ==
"thisown"):
76 return self.this.own()
77 method = class_type.__swig_getmethods__.get(name,
None)
80 raise AttributeError(
"'%s' object has no attribute '%s'" % (class_type.__name__, name))
85 strthis =
"proxy of " + self.this.__repr__()
86 except __builtin__.Exception:
88 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
93 except __builtin__.Exception:
100 return _plplotc.pltr0(x, y)
101 pltr0 = _plplotc.pltr0
104 return _plplotc.pltr1(x, y, cgrid)
105 pltr1 = _plplotc.pltr1
108 return _plplotc.pltr2(x, y, cgrid)
109 pltr2 = _plplotc.pltr2
110 PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
111 PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
112 PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
113 PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
114 PLESC_RESIZE = _plplotc.PLESC_RESIZE
115 PLESC_REDRAW = _plplotc.PLESC_REDRAW
116 PLESC_TEXT = _plplotc.PLESC_TEXT
117 PLESC_GRAPH = _plplotc.PLESC_GRAPH
118 PLESC_FILL = _plplotc.PLESC_FILL
119 PLESC_DI = _plplotc.PLESC_DI
120 PLESC_FLUSH = _plplotc.PLESC_FLUSH
121 PLESC_EH = _plplotc.PLESC_EH
122 PLESC_GETC = _plplotc.PLESC_GETC
123 PLESC_SWIN = _plplotc.PLESC_SWIN
124 PLESC_DOUBLEBUFFERING = _plplotc.PLESC_DOUBLEBUFFERING
125 PLESC_XORMOD = _plplotc.PLESC_XORMOD
126 PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
127 PLESC_CLEAR = _plplotc.PLESC_CLEAR
128 PLESC_DASH = _plplotc.PLESC_DASH
129 PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
130 PLESC_IMAGE = _plplotc.PLESC_IMAGE
131 PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
132 PLESC_PL2DEVCOL = _plplotc.PLESC_PL2DEVCOL
133 PLESC_DEV2PLCOL = _plplotc.PLESC_DEV2PLCOL
134 PLESC_SETBGFG = _plplotc.PLESC_SETBGFG
135 PLESC_DEVINIT = _plplotc.PLESC_DEVINIT
136 PLESC_GETBACKEND = _plplotc.PLESC_GETBACKEND
137 PLESC_BEGIN_TEXT = _plplotc.PLESC_BEGIN_TEXT
138 PLESC_TEXT_CHAR = _plplotc.PLESC_TEXT_CHAR
139 PLESC_CONTROL_CHAR = _plplotc.PLESC_CONTROL_CHAR
140 PLESC_END_TEXT = _plplotc.PLESC_END_TEXT
141 PLESC_START_RASTERIZE = _plplotc.PLESC_START_RASTERIZE
142 PLESC_END_RASTERIZE = _plplotc.PLESC_END_RASTERIZE
143 PLESC_ARC = _plplotc.PLESC_ARC
144 PLESC_GRADIENT = _plplotc.PLESC_GRADIENT
145 PLESC_MODESET = _plplotc.PLESC_MODESET
146 PLESC_MODEGET = _plplotc.PLESC_MODEGET
147 PLESC_FIXASPECT = _plplotc.PLESC_FIXASPECT
148 PLESC_IMPORT_BUFFER = _plplotc.PLESC_IMPORT_BUFFER
149 PLESC_APPEND_BUFFER = _plplotc.PLESC_APPEND_BUFFER
150 PLESC_FLUSH_REMAINING_BUFFER = _plplotc.PLESC_FLUSH_REMAINING_BUFFER
151 PLTEXT_FONTCHANGE = _plplotc.PLTEXT_FONTCHANGE
152 PLTEXT_SUPERSCRIPT = _plplotc.PLTEXT_SUPERSCRIPT
153 PLTEXT_SUBSCRIPT = _plplotc.PLTEXT_SUBSCRIPT
154 PLTEXT_BACKCHAR = _plplotc.PLTEXT_BACKCHAR
155 PLTEXT_OVERLINE = _plplotc.PLTEXT_OVERLINE
156 PLTEXT_UNDERLINE = _plplotc.PLTEXT_UNDERLINE
157 ZEROW2B = _plplotc.ZEROW2B
158 ZEROW2D = _plplotc.ZEROW2D
159 ONEW2B = _plplotc.ONEW2B
160 ONEW2D = _plplotc.ONEW2D
161 PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
162 PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
163 PL_X_AXIS = _plplotc.PL_X_AXIS
164 PL_Y_AXIS = _plplotc.PL_Y_AXIS
165 PL_Z_AXIS = _plplotc.PL_Z_AXIS
166 PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
167 PL_OPT_ARG = _plplotc.PL_OPT_ARG
168 PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
169 PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
170 PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
171 PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
172 PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
173 PL_OPT_INT = _plplotc.PL_OPT_INT
174 PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
175 PL_OPT_STRING = _plplotc.PL_OPT_STRING
176 PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
177 PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
178 PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
179 PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
180 PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
181 PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
182 PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
183 PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
184 PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
185 PL_FCI_MARK = _plplotc.PL_FCI_MARK
186 PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
187 PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
188 PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
189 PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
190 PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
191 PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
192 PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
193 PL_FCI_SANS = _plplotc.PL_FCI_SANS
194 PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
195 PL_FCI_MONO = _plplotc.PL_FCI_MONO
196 PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
197 PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
198 PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
199 PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
200 PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
201 PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
202 PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
203 PL_MAXKEY = _plplotc.PL_MAXKEY
204 PL_MASK_SHIFT = _plplotc.PL_MASK_SHIFT
205 PL_MASK_CAPS = _plplotc.PL_MASK_CAPS
206 PL_MASK_CONTROL = _plplotc.PL_MASK_CONTROL
207 PL_MASK_ALT = _plplotc.PL_MASK_ALT
208 PL_MASK_NUM = _plplotc.PL_MASK_NUM
209 PL_MASK_ALTGR = _plplotc.PL_MASK_ALTGR
210 PL_MASK_WIN = _plplotc.PL_MASK_WIN
211 PL_MASK_SCROLL = _plplotc.PL_MASK_SCROLL
212 PL_MASK_BUTTON1 = _plplotc.PL_MASK_BUTTON1
213 PL_MASK_BUTTON2 = _plplotc.PL_MASK_BUTTON2
214 PL_MASK_BUTTON3 = _plplotc.PL_MASK_BUTTON3
215 PL_MASK_BUTTON4 = _plplotc.PL_MASK_BUTTON4
216 PL_MASK_BUTTON5 = _plplotc.PL_MASK_BUTTON5
217 PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
218 PL_NOTSET = _plplotc.PL_NOTSET
219 PL_DEFAULT_NCOL0 = _plplotc.PL_DEFAULT_NCOL0
220 PL_DEFAULT_NCOL1 = _plplotc.PL_DEFAULT_NCOL1
221 MIN_PLINT_RGB = _plplotc.MIN_PLINT_RGB
222 MAX_PLINT_RGB = _plplotc.MAX_PLINT_RGB
223 MIN_PLFLT_CMAP1 = _plplotc.MIN_PLFLT_CMAP1
224 MAX_PLFLT_CMAP1 = _plplotc.MAX_PLFLT_CMAP1
225 MIN_PLFLT_ALPHA = _plplotc.MIN_PLFLT_ALPHA
226 MAX_PLFLT_ALPHA = _plplotc.MAX_PLFLT_ALPHA
227 PLESC_DOUBLEBUFFERING_ENABLE = _plplotc.PLESC_DOUBLEBUFFERING_ENABLE
228 PLESC_DOUBLEBUFFERING_DISABLE = _plplotc.PLESC_DOUBLEBUFFERING_DISABLE
229 PLESC_DOUBLEBUFFERING_QUERY = _plplotc.PLESC_DOUBLEBUFFERING_QUERY
230 PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
231 PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
232 PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
233 PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
234 GRID_CSA = _plplotc.GRID_CSA
235 GRID_DTLI = _plplotc.GRID_DTLI
236 GRID_NNI = _plplotc.GRID_NNI
237 GRID_NNIDW = _plplotc.GRID_NNIDW
238 GRID_NNLI = _plplotc.GRID_NNLI
239 GRID_NNAIDW = _plplotc.GRID_NNAIDW
240 PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
241 PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
242 PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
243 PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
244 PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
245 PL_POSITION_NULL = _plplotc.PL_POSITION_NULL
246 PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
247 PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
248 PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
249 PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
250 PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
251 PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
252 PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
253 PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
254 PL_LEGEND_NULL = _plplotc.PL_LEGEND_NULL
255 PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
256 PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
257 PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
258 PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
259 PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
260 PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
261 PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
262 PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
263 PL_COLORBAR_NULL = _plplotc.PL_COLORBAR_NULL
264 PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
265 PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
266 PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
267 PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
268 PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
269 PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
270 PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
271 PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
272 PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
273 PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
274 PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
275 PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
276 PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
277 PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
278 PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
279 PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
280 PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
281 PL_DRAWMODE_UNKNOWN = _plplotc.PL_DRAWMODE_UNKNOWN
282 PL_DRAWMODE_DEFAULT = _plplotc.PL_DRAWMODE_DEFAULT
283 PL_DRAWMODE_REPLACE = _plplotc.PL_DRAWMODE_REPLACE
284 PL_DRAWMODE_XOR = _plplotc.PL_DRAWMODE_XOR
285 DRAW_LINEX = _plplotc.DRAW_LINEX
286 DRAW_LINEY = _plplotc.DRAW_LINEY
287 DRAW_LINEXY = _plplotc.DRAW_LINEXY
288 MAG_COLOR = _plplotc.MAG_COLOR
289 BASE_CONT = _plplotc.BASE_CONT
290 TOP_CONT = _plplotc.TOP_CONT
291 SURF_CONT = _plplotc.SURF_CONT
292 DRAW_SIDES = _plplotc.DRAW_SIDES
293 FACETED = _plplotc.FACETED
296 __swig_setmethods__ = {}
297 __setattr__ =
lambda self, name, value:
_swig_setattr(self, PLGraphicsIn, name, value)
298 __swig_getmethods__ = {}
300 __repr__ = _swig_repr
301 __swig_setmethods__[
"type"] = _plplotc.PLGraphicsIn_type_set
302 __swig_getmethods__[
"type"] = _plplotc.PLGraphicsIn_type_get
304 type =
_swig_property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
305 __swig_setmethods__[
"state"] = _plplotc.PLGraphicsIn_state_set
306 __swig_getmethods__[
"state"] = _plplotc.PLGraphicsIn_state_get
308 state =
_swig_property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
309 __swig_setmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_set
310 __swig_getmethods__[
"keysym"] = _plplotc.PLGraphicsIn_keysym_get
312 keysym =
_swig_property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
313 __swig_setmethods__[
"button"] = _plplotc.PLGraphicsIn_button_set
314 __swig_getmethods__[
"button"] = _plplotc.PLGraphicsIn_button_get
316 button =
_swig_property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
317 __swig_setmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_set
318 __swig_getmethods__[
"subwindow"] = _plplotc.PLGraphicsIn_subwindow_get
320 subwindow =
_swig_property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
321 __swig_setmethods__[
"string"] = _plplotc.PLGraphicsIn_string_set
322 __swig_getmethods__[
"string"] = _plplotc.PLGraphicsIn_string_get
324 string =
_swig_property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
325 __swig_setmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_set
326 __swig_getmethods__[
"pX"] = _plplotc.PLGraphicsIn_pX_get
329 __swig_setmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_set
330 __swig_getmethods__[
"pY"] = _plplotc.PLGraphicsIn_pY_get
333 __swig_setmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_set
334 __swig_getmethods__[
"dX"] = _plplotc.PLGraphicsIn_dX_get
337 __swig_setmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_set
338 __swig_getmethods__[
"dY"] = _plplotc.PLGraphicsIn_dY_get
341 __swig_setmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_set
342 __swig_getmethods__[
"wX"] = _plplotc.PLGraphicsIn_wX_get
345 __swig_setmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_set
346 __swig_getmethods__[
"wY"] = _plplotc.PLGraphicsIn_wY_get
351 this = _plplotc.new_PLGraphicsIn()
353 self.
this.append(this)
354 except __builtin__.Exception:
356 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
357 __del__ =
lambda self:
None 358 PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister
363 return _plplotc.plsxwin(window_id)
364 plsxwin = _plplotc.plsxwin
368 Set format of numerical label for contours 372 Set format of numerical label for contours. 374 Redacted form: pl_setcontlabelformat(lexp, sigdig) 376 This function is used example 9. 382 pl_setcontlabelformat(lexp, sigdig) 386 lexp (PLINT, input) : If the contour numerical label is greater 387 than 10^(lexp) or less than 10^(-lexp), then the exponential 388 format is used. Default value of lexp is 4. 390 sigdig (PLINT, input) : Number of significant digits. Default 394 return _plplotc.pl_setcontlabelformat(lexp, sigdig)
398 Set parameters of contour labelling other than format of numerical label 402 Set parameters of contour labelling other than those handled by 403 pl_setcontlabelformat. 405 Redacted form: pl_setcontlabelparam(offset, size, spacing, active) 407 This function is used in example 9. 413 pl_setcontlabelparam(offset, size, spacing, active) 417 offset (PLFLT, input) : Offset of label from contour line (if set 418 to 0.0, labels are printed on the lines). Default value is 0.006. 420 size (PLFLT, input) : Font height for contour labels (normalized). 421 Default value is 0.3. 423 spacing (PLFLT, input) : Spacing parameter for contour labels. 424 Default value is 0.1. 426 active (PLINT, input) : Activate labels. Set to 1 if you want 427 contour labels on. Default is off (0). 430 return _plplotc.pl_setcontlabelparam(offset, size, spacing, active)
434 Advance the (sub-)page 438 Advances to the next subpage if sub=0, performing a page advance if 439 there are no remaining subpages on the current page. If subpages 440 aren't being used, pladv(0) will always advance the page. If page>0, 441 PLplot switches to the specified subpage. Note that this allows you 442 to overwrite a plot on the specified subpage; if this is not what you 443 intended, use pleop followed by plbop to first advance the page. This 444 routine is called automatically (with page=0) by plenv, but if plenv 445 is not used, pladv must be called after initializing PLplot but before 446 defining the viewport. 448 Redacted form: pladv(page) 450 This function is used in examples 1, 2, 4, 6-12, 14-18, 20, 21, 23-27, 461 page (PLINT, input) : Specifies the subpage number (starting from 1 462 in the top left corner and increasing along the rows) to which to 463 advance. Set to zero to advance to the next subpage (or to the 464 next page if subpages are not being used). 467 return _plplotc.pladv(page)
469 def plarc(x, y, a, b, angle1, angle2, rotate, fill):
471 Draw a circular or elliptical arc 475 Draw a possibly filled arc centered at x, y with semimajor axis a and 476 semiminor axis b, starting at angle1 and ending at angle2. 478 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate, 482 This function is used in examples 3 and 27. 488 plarc(x, y, a, b, angle1, angle2, rotate, fill) 492 x (PLFLT, input) : X coordinate of arc center. 494 y (PLFLT, input) : Y coordinate of arc center. 496 a (PLFLT, input) : Length of the semimajor axis of the arc. 498 b (PLFLT, input) : Length of the semiminor axis of the arc. 500 angle1 (PLFLT, input) : Starting angle of the arc relative to the 503 angle2 (PLFLT, input) : Ending angle of the arc relative to the 506 rotate (PLFLT, input) : Angle of the semimajor axis relative to the 509 fill (PLBOOL, input) : Draw a filled arc. 512 return _plplotc.plarc(x, y, a, b, angle1, angle2, rotate, fill)
514 def plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub):
516 Draw a box with axes, etc. with arbitrary origin 520 Draws a box around the currently defined viewport with arbitrary 521 world-coordinate origin specified by x0 and y0 and labels it with 522 world coordinate values appropriate to the window. Thus plaxes should 523 only be called after defining both viewport and window. The ascii 524 character strings xopt and yopt specify how the box should be drawn as 525 described below. If ticks and/or subticks are to be drawn for a 526 particular axis, the tick intervals and number of subintervals may be 527 specified explicitly, or they may be defaulted by setting the 528 appropriate arguments to zero. 530 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt, 534 This function is not used in any examples. 540 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub) 544 x0 (PLFLT, input) : World X coordinate of origin. 546 y0 (PLFLT, input) : World Y coordinate of origin. 548 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying 549 options for the x axis. The string can include any combination of 550 the following letters (upper or lower case) in any order: a: Draws 551 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line 553 b: Draws bottom (X) or left (Y) edge of frame. 554 c: Draws top (X) or right (Y) edge of frame. 555 d: Plot labels as date / time. Values are assumed to be 556 seconds since the epoch (as used by gmtime). 557 f: Always use fixed point numeric labels. 558 g: Draws a grid at the major tick interval. 559 h: Draws a grid at the minor tick interval. 560 i: Inverts tick marks, so they are drawn outwards, rather than 562 l: Labels axis logarithmically. This only affects the labels, 563 not the data, and so it is necessary to compute the logarithms 564 of data points before passing them to any of the drawing 566 m: Writes numeric labels at major tick intervals in the 567 unconventional location (above box for X, right of box for Y). 568 n: Writes numeric labels at major tick intervals in the 569 conventional location (below box for X, left of box for Y). 570 o: Use custom labelling function to generate axis label text. 571 The custom labelling function can be defined with the 572 plslabelfunc command. 573 s: Enables subticks between major ticks, only valid if t is 575 t: Draws major ticks. 576 u: Exactly like "b" except don't draw edge line. 577 w: Exactly like "c" except don't draw edge line. 578 x: Exactly like "t" (including the side effect of the 579 numerical labels for the major ticks) except exclude drawing 580 the major and minor tick marks. 583 xtick (PLFLT, input) : World coordinate interval between major 584 ticks on the x axis. If it is set to zero, PLplot automatically 585 generates a suitable tick interval. 587 nxsub (PLINT, input) : Number of subintervals between major x axis 588 ticks for minor ticks. If it is set to zero, PLplot automatically 589 generates a suitable minor tick interval. 591 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying 592 options for the y axis. The string can include any combination of 593 the letters defined above for xopt, and in addition may contain: 594 v: Write numeric labels for the y axis parallel to the base of the 595 graph, rather than parallel to the axis. 598 ytick (PLFLT, input) : World coordinate interval between major 599 ticks on the y axis. If it is set to zero, PLplot automatically 600 generates a suitable tick interval. 602 nysub (PLINT, input) : Number of subintervals between major y axis 603 ticks for minor ticks. If it is set to zero, PLplot automatically 604 generates a suitable minor tick interval. 607 return _plplotc.plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
611 Plot a histogram from binned data 615 Plots a histogram consisting of nbin bins. The value associated with 616 the i'th bin is placed in x[i], and the number of points in the bin is 617 placed in y[i]. For proper operation, the values in x[i] must form a 618 strictly increasing sequence. By default, x[i] is the left-hand edge 619 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are 620 placed midway between the values in the x vector. Also see plhist for 621 drawing histograms from unbinned data. 623 Redacted form: General: plbin(x, y, opt) 624 Python: plbin(nbin, x, y, opt) 627 This function is not used in any examples. 633 plbin(nbin, x, y, opt) 637 nbin (PLINT, input) : Number of bins (i.e., number of values in x 640 x (PLFLT_VECTOR, input) : A vector containing values associated 641 with bins. These must form a strictly increasing sequence. 643 y (PLFLT_VECTOR, input) : A vector containing a number which is 644 proportional to the number of points in each bin. This is a PLFLT 645 (instead of PLINT) vector so as to allow histograms of 648 opt (PLINT, input) : Is a combination of several flags: 649 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the 650 outer bins are expanded to fill up the entire x-axis and bins of 651 zero height are simply drawn. 652 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway 653 between the x values. If the values in x are equally spaced, 654 the values are the center values of the bins. 655 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal 656 size as the ones inside. 657 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn 658 (there is a gap for such bins). 661 return _plplotc.plbin(n, ArrayCk, center)
665 Calculate broken-down time from continuous time for the current stream 669 Calculate broken-down time; year, month, day, hour, min, sec; from 670 continuous time, ctime for the current stream. This function is the 673 The PLplot definition of broken-down time is a calendar time that 674 completely ignores all time zone offsets, i.e., it is the user's 675 responsibility to apply those offsets (if so desired) before using the 676 PLplot time API. By default broken-down time is defined using the 677 proleptic Gregorian calendar without the insertion of leap seconds and 678 continuous time is defined as the number of seconds since the Unix 679 epoch of 1970-01-01T00:00:00Z. However, other definitions of 680 broken-down and continuous time are possible, see plconfigtime. 682 Redacted form: General: plbtime(year, month, day, hour, min, sec, 686 This function is used in example 29. 692 plbtime(year, month, day, hour, min, sec, ctime) 696 year (PLINT_NC_SCALAR, output) : Returned value of years with 697 positive values corresponding to CE (i.e., 1 = 1 CE, etc.) and 698 non-negative values corresponding to BCE (e.g., 0 = 1 BCE, -1 = 2 701 month (PLINT_NC_SCALAR, output) : Returned value of month within 702 the year in the range from 0 (January) to 11 (December). 704 day (PLINT_NC_SCALAR, output) : Returned value of day within the 705 month in the range from 1 to 31. 707 hour (PLINT_NC_SCALAR, output) : Returned value of hour within the 708 day in the range from 0 to 23. 710 min (PLINT_NC_SCALAR, output) : Returned value of minute within the 711 hour in the range from 0 to 59 713 sec (PLFLT_NC_SCALAR, output) : Returned value of second within the 714 minute in range from 0. to 60. 716 ctime (PLFLT, input) : Continuous time from which the broken-down 720 return _plplotc.plbtime(ctime)
728 Begins a new page. For a file driver, the output file is opened if 729 necessary. Advancing the page via pleop and plbop is useful when a 730 page break is desired at a particular point when plotting to subpages. 731 Another use for pleop and plbop is when plotting pages to different 732 files, since you can manually set the file name by calling plsfnam 733 after the call to pleop. (In fact some drivers may only support a 734 single page per file, making this a necessity.) One way to handle 735 this case automatically is to page advance via pladv, but enable 736 familying (see plsfam) with a small limit on the file size so that a 737 new family member file will be created on each page break. 739 Redacted form: plbop() 741 This function is used in examples 2 and 20. 750 return _plplotc.plbop()
752 def plbox(xopt, xtick, nxsub, yopt, ytick, nysub):
754 Draw a box with axes, etc 758 Draws a box around the currently defined viewport, and labels it with 759 world coordinate values appropriate to the window. Thus plbox should 760 only be called after defining both viewport and window. The ascii 761 character strings xopt and yopt specify how the box should be drawn as 762 described below. If ticks and/or subticks are to be drawn for a 763 particular axis, the tick intervals and number of subintervals may be 764 specified explicitly, or they may be defaulted by setting the 765 appropriate arguments to zero. 767 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub) 770 This function is used in examples 1, 2, 4, 6, 6-12, 14-18, 21, 23-26, 777 plbox(xopt, xtick, nxsub, yopt, ytick, nysub) 781 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying 782 options for the x axis. The string can include any combination of 783 the following letters (upper or lower case) in any order: a: Draws 784 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line 786 b: Draws bottom (X) or left (Y) edge of frame. 787 c: Draws top (X) or right (Y) edge of frame. 788 d: Plot labels as date / time. Values are assumed to be 789 seconds since the epoch (as used by gmtime). 790 f: Always use fixed point numeric labels. 791 g: Draws a grid at the major tick interval. 792 h: Draws a grid at the minor tick interval. 793 i: Inverts tick marks, so they are drawn outwards, rather than 795 l: Labels axis logarithmically. This only affects the labels, 796 not the data, and so it is necessary to compute the logarithms 797 of data points before passing them to any of the drawing 799 m: Writes numeric labels at major tick intervals in the 800 unconventional location (above box for X, right of box for Y). 801 n: Writes numeric labels at major tick intervals in the 802 conventional location (below box for X, left of box for Y). 803 o: Use custom labelling function to generate axis label text. 804 The custom labelling function can be defined with the 805 plslabelfunc command. 806 s: Enables subticks between major ticks, only valid if t is 808 t: Draws major ticks. 809 u: Exactly like "b" except don't draw edge line. 810 w: Exactly like "c" except don't draw edge line. 811 x: Exactly like "t" (including the side effect of the 812 numerical labels for the major ticks) except exclude drawing 813 the major and minor tick marks. 816 xtick (PLFLT, input) : World coordinate interval between major 817 ticks on the x axis. If it is set to zero, PLplot automatically 818 generates a suitable tick interval. 820 nxsub (PLINT, input) : Number of subintervals between major x axis 821 ticks for minor ticks. If it is set to zero, PLplot automatically 822 generates a suitable minor tick interval. 824 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying 825 options for the y axis. The string can include any combination of 826 the letters defined above for xopt, and in addition may contain: 827 v: Write numeric labels for the y axis parallel to the base of the 828 graph, rather than parallel to the axis. 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. 840 return _plplotc.plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
842 def plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz):
844 Draw a box with axes, etc, in 3-d 848 Draws axes, numeric and text labels for a three-dimensional surface 849 plot. For a more complete description of three-dimensional plotting 850 see the PLplot documentation. 852 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt, 853 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub) 856 This function is used in examples 8, 11, 18, and 21. 862 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub) 866 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying 867 options for the x axis. The string can include any combination of 868 the following letters (upper or lower case) in any order: b: Draws 869 axis at base, at height z= 870 zmin where zmin is defined by call to plw3d. This character must be 871 specified in order to use any of the other options. 872 d: Plot labels as date / time. Values are assumed to be 873 seconds since the epoch (as used by gmtime). 874 f: Always use fixed point numeric labels. 875 i: Inverts tick marks, so they are drawn downwards, rather 877 l: Labels axis logarithmically. This only affects the labels, 878 not the data, and so it is necessary to compute the logarithms 879 of data points before passing them to any of the drawing 881 n: Writes numeric labels at major tick intervals. 882 o: Use custom labelling function to generate axis label text. 883 The custom labelling function can be defined with the 884 plslabelfunc command. 885 s: Enables subticks between major ticks, only valid if t is 887 t: Draws major ticks. 888 u: If this is specified, the text label for the axis is 889 written under the axis. 892 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 893 the text label for the x axis. It is only drawn if u is in the 896 xtick (PLFLT, input) : World coordinate interval between major 897 ticks on the x axis. If it is set to zero, PLplot automatically 898 generates a suitable tick interval. 900 nxsub (PLINT, input) : Number of subintervals between major x axis 901 ticks for minor ticks. If it is set to zero, PLplot automatically 902 generates a suitable minor tick interval. 904 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying 905 options for the y axis. The string is interpreted in the same way 908 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 909 the text label for the y axis. It is only drawn if u is in the 912 ytick (PLFLT, input) : World coordinate interval between major 913 ticks on the y axis. If it is set to zero, PLplot automatically 914 generates a suitable tick interval. 916 nysub (PLINT, input) : Number of subintervals between major y axis 917 ticks for minor ticks. If it is set to zero, PLplot automatically 918 generates a suitable minor tick interval. 920 zopt (PLCHAR_VECTOR, input) : An ascii character string specifying 921 options for the z axis. The string can include any combination of 922 the following letters (upper or lower case) in any order: b: Draws 923 z axis to the left of the surface plot. 924 c: Draws z axis to the right of the surface plot. 925 d: Draws grid lines parallel to the x-y plane behind the 926 figure. These lines are not drawn until after plot3d or 927 plmesh are called because of the need for hidden line removal. 928 e: Plot labels as date / time. Values are assumed to be 929 seconds since the epoch (as used by gmtime). Note this 930 suboption is interpreted the same as the d suboption for xopt 931 and yopt, but it has to be identified as e for zopt since d 932 has already been used for the different purpose above. 933 f: Always use fixed point numeric labels. 934 i: Inverts tick marks, so they are drawn away from the center. 935 l: Labels axis logarithmically. This only affects the labels, 936 not the data, and so it is necessary to compute the logarithms 937 of data points before passing them to any of the drawing 939 m: Writes numeric labels at major tick intervals on the 941 n: Writes numeric labels at major tick intervals on the 943 o: Use custom labelling function to generate axis label text. 944 The custom labelling function can be defined with the 945 plslabelfunc command. 946 s: Enables subticks between major ticks, only valid if t is 948 t: Draws major ticks. 949 u: If this is specified, the text label is written beside the 951 v: If this is specified, the text label is written beside the 955 zlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 956 the text label for the z axis. It is only drawn if u or v are in 959 ztick (PLFLT, input) : World coordinate interval between major 960 ticks on the z axis. If it is set to zero, PLplot automatically 961 generates a suitable tick interval. 963 nzsub (PLINT, input) : Number of subintervals between major z axis 964 ticks for minor ticks. If it is set to zero, PLplot automatically 965 generates a suitable minor tick interval. 968 return _plplotc.plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz)
972 Calculate world coordinates and corresponding window index from relative device coordinates 976 Calculate world coordinates, wx and wy, and corresponding window index 977 from relative device coordinates, rx and ry. 979 Redacted form: General: plcalc_world(rx, ry, wx, wy, window) 982 This function is used in example 31. 988 plcalc_world(rx, ry, wx, wy, window) 992 rx (PLFLT, input) : Input relative device coordinate (0.0-1.0) for 995 ry (PLFLT, input) : Input relative device coordinate (0.0-1.0) for 998 wx (PLFLT_NC_SCALAR, output) : Returned value of the x world 999 coordinate corresponding to the relative device coordinates rx and 1002 wy (PLFLT_NC_SCALAR, output) : Returned value of the y world 1003 coordinate corresponding to the relative device coordinates rx and 1006 window (PLINT_NC_SCALAR, output) : Returned value of the last 1007 defined window index that corresponds to the input relative device 1008 coordinates (and the returned world coordinates). To give some 1009 background on the window index, for each page the initial window 1010 index is set to zero, and each time plwind is called within the 1011 page, world and device coordinates are stored for the window and 1012 the window index is incremented. Thus, for a simple page layout 1013 with non-overlapping viewports and one window per viewport, window 1014 corresponds to the viewport index (in the order which the 1015 viewport/windows were created) of the only viewport/window 1016 corresponding to rx and ry. However, for more complicated layouts 1017 with potentially overlapping viewports and possibly more than one 1018 window (set of world coordinates) per viewport, window and the 1019 corresponding output world coordinates corresponds to the last 1020 window created that fulfills the criterion that the relative 1021 device coordinates are inside it. Finally, in all cases where the 1022 input relative device coordinates are not inside any 1023 viewport/window, then the returned value of the last defined 1024 window index is set to -1. 1027 return _plplotc.plcalc_world(rx, ry)
1031 Clear current (sub)page 1035 Clears the current page, effectively erasing everything that have been 1036 drawn. This command only works with interactive drivers; if the 1037 driver does not support this, the page is filled with the background 1038 color in use. If the current page is divided into subpages, only the 1039 current subpage is erased. The nth subpage can be selected with 1042 Redacted form: General: plclear() 1045 This function is not used in any examples. 1054 return _plplotc.plclear()
1062 Sets the color index for cmap0 (see the PLplot documentation). 1064 Redacted form: plcol0(icol0) 1066 This function is used in examples 1-9, 11-16, 18-27, and 29. 1076 icol0 (PLINT, input) : Integer representing the color. The 1077 defaults at present are (these may change): 1078 0 black (default background) 1079 1 red (default foreground) 1095 Use plscmap0 to change the entire cmap0 color palette and plscol0 to 1096 change an individual color in the cmap0 color palette. 1099 return _plplotc.plcol0(icol0)
1107 Sets the color for cmap1 (see the PLplot documentation). 1109 Redacted form: plcol1(col1) 1111 This function is used in examples 12 and 21. 1121 col1 (PLFLT, input) : This value must be in the range (0.0-1.0) and 1122 is mapped to color using the continuous cmap1 palette which by 1123 default ranges from blue to the background color to red. The 1124 cmap1 palette can also be straightforwardly changed by the user 1125 with plscmap1 or plscmap1l. 1128 return _plplotc.plcol1(col1)
1130 def plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec):
1132 Configure the transformation between continuous and broken-down time for the current stream 1136 Configure the transformation between continuous and broken-down time 1137 for the current stream. This transformation is used by both plbtime 1140 Redacted form: General: plconfigtime(scale, offset1, offset2, 1141 ccontrol, ifbtime_offset, year, month, day, hour, min, sec) 1144 This function is used in example 29. 1150 plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec) 1154 scale (PLFLT, input) : The number of days per continuous time unit. 1155 As a special case, if 1156 scale is 0., then all other arguments are ignored, and the result (the 1157 default used by PLplot) is the equivalent of a call to 1158 plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.). 1159 That is, for this special case broken-down time is calculated with 1160 the proleptic Gregorian calendar with no leap seconds inserted, 1161 and the continuous time is defined as the number of seconds since 1162 the Unix epoch of 1970-01-01T00:00:00Z. 1164 offset1 (PLFLT, input) : If 1165 ifbtime_offset is true, the parameters 1167 offset2 are completely ignored. Otherwise, the sum of these parameters 1168 (with units in days) specify the epoch of the continuous time 1169 relative to the MJD epoch corresponding to the Gregorian calendar 1170 date of 1858-11-17T00:00:00Z or JD = 2400000.5. Two PLFLT numbers 1171 are used to specify the origin to allow users (by specifying 1172 offset1 as an integer that can be exactly represented by a 1173 floating-point variable and specifying 1174 offset2 as a number in the range from 0. to 1) the chance to minimize 1175 the numerical errors of the continuous time representation. 1177 offset2 (PLFLT, input) : See documentation of 1180 ccontrol (PLINT, input) : ccontrol contains bits controlling the 1181 transformation. If the 0x1 bit is set, then the proleptic Julian 1182 calendar is used for broken-down time rather than the proleptic 1183 Gregorian calendar. If the 0x2 bit is set, then leap seconds that 1184 have been historically used to define UTC are inserted into the 1185 broken-down time. Other possibilities for additional control bits 1186 for ccontrol exist such as making the historical time corrections 1187 in the broken-down time corresponding to ET (ephemeris time) or 1188 making the (slightly non-constant) corrections from international 1189 atomic time (TAI) to what astronomers define as terrestrial time 1190 (TT). But those additional possibilities have not been 1191 implemented yet in the qsastime library (one of the PLplot utility 1194 ifbtime_offset (PLBOOL, input) : ifbtime_offset controls how the 1195 epoch of the continuous time scale is specified by the user. If 1196 ifbtime_offset is false, then 1198 offset2 are used to specify the epoch, and the following broken-down 1199 time parameters are completely ignored. If 1200 ifbtime_offset is true, then 1202 offset2 are completely ignored, and the following broken-down time 1203 parameters are used to specify the epoch. 1205 year (PLINT, input) : Year of epoch. 1207 month (PLINT, input) : Month of epoch in range from 0 (January) to 1210 day (PLINT, input) : Day of epoch in range from 1 to 31. 1212 hour (PLINT, input) : Hour of epoch in range from 0 to 23 1214 min (PLINT, input) : Minute of epoch in range from 0 to 59. 1216 sec (PLFLT, input) : Second of epoch in range from 0. to 60. 1219 return _plplotc.plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1227 Draws a contour plot of the data in f[ 1229 ny], using the nlevel contour levels specified by clevel. Only the 1230 region of the matrix from kx to lx and from ky to ly is plotted out 1231 where all these index ranges are interpreted as one-based for 1232 historical reasons. A transformation routine pointed to by pltr with 1233 a generic pointer pltr_data for additional data required by the 1234 transformation routine is used to map indices within the matrix to the 1237 Redacted form: plcont(f, kx, lx, ky, ly, clevel, pltr, pltr_data) 1238 where (see above discussion) the pltr, pltr_data callback arguments 1239 are sometimes replaced by a tr vector with 6 elements; xg and yg 1240 vectors; or xg and yg matrices. 1242 This function is used in examples 9, 14, 16, and 22. 1248 plcont(f, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data) 1252 f (PLFLT_MATRIX, input) : A matrix containing data to be contoured. 1254 nx, ny (PLINT, input) : The dimensions of the matrix f. 1256 kx, lx (PLINT, input) : Range of x indices to consider where 0 <= 1257 kx-1 < lx-1 < nx. Values of kx and lx are one-based rather than 1258 zero-based for historical backwards-compatibility reasons. 1260 ky, ly (PLINT, input) : Range of y indices to consider where 0 <= 1261 ky-1 < ly-1 < ny. Values of ky and ly are one-based rather than 1262 zero-based for historical backwards-compatibility reasons. 1264 clevel (PLFLT_VECTOR, input) : A vector specifying the levels at 1265 which to draw contours. 1267 nlevel (PLINT, input) : Number of contour levels to draw. 1269 pltr (PLTRANSFORM_callback, input) : A callback function that 1270 defines the transformation between the zero-based indices of the 1271 matrix f and the world coordinates.For the C case, transformation 1272 functions are provided in the PLplot library: pltr0 for the 1273 identity mapping, and pltr1 and pltr2 for arbitrary mappings 1274 respectively defined by vectors and matrices. In addition, C 1275 callback routines for the transformation can be supplied by the 1276 user such as the mypltr function in examples/c/x09c.c which 1277 provides a general linear transformation between index coordinates 1278 and world coordinates.For languages other than C you should 1279 consult the PLplot documentation for the details concerning how 1280 PLTRANSFORM_callback arguments are interfaced. However, in 1281 general, a particular pattern of callback-associated arguments 1282 such as a tr vector with 6 elements; xg and yg vectors; or xg and 1283 yg matrices are respectively interfaced to a linear-transformation 1284 routine similar to the above mypltr function; pltr1; and pltr2. 1285 Furthermore, some of our more sophisticated bindings (see, e.g., 1286 the PLplot documentation) support native language callbacks for 1287 handling index to world-coordinate transformations. Examples of 1288 these various approaches are given in examples/<language>x09*, 1289 examples/<language>x16*, examples/<language>x20*, 1290 examples/<language>x21*, and examples/<language>x22*, for all our 1291 supported languages. 1293 pltr_data (PLPointer, input) : Extra parameter to help pass 1294 information to pltr0, pltr1, pltr2, or whatever callback routine 1295 that is externally supplied. 1298 return _plplotc.plcont(*args)
1302 Calculate continuous time from broken-down time for the current stream 1306 Calculate continuous time, ctime, from broken-down time for the 1307 current stream. The broken-down 1308 time is specified by the following parameters: year, month, day, hour, 1309 min, and sec. This function is the inverse of plbtime. 1311 The PLplot definition of broken-down time is a calendar time that 1312 completely ignores all time zone offsets, i.e., it is the user's 1313 responsibility to apply those offsets (if so desired) before using the 1314 PLplot time API. By default broken-down time is defined using the 1315 proleptic Gregorian calendar without the insertion of leap seconds and 1316 continuous time is defined as the number of seconds since the Unix 1317 epoch of 1970-01-01T00:00:00Z. However, other definitions of 1318 broken-down and continuous time are possible, see plconfigtime which 1319 specifies that transformation for the current stream. 1321 Redacted form: General: plctime(year, month, day, hour, min, sec, 1325 This function is used in example 29. 1331 plctime(year, month, day, hour, min, sec, ctime) 1335 year (PLINT, input) : Input year. 1337 month (PLINT, input) : Input month in range from 0 (January) to 11 1340 day (PLINT, input) : Input day in range from 1 to 31. 1342 hour (PLINT, input) : Input hour in range from 0 to 23 1344 min (PLINT, input) : Input minute in range from 0 to 59. 1346 sec (PLFLT, input) : Input second in range from 0. to 60. 1348 ctime (PLFLT_NC_SCALAR, output) : Returned value of the continuous 1349 time calculated from the broken-down time specified by the 1350 previous parameters. 1353 return _plplotc.plctime(year, month, day, hour, min, sec)
1357 Copy state parameters from the reference stream to the current stream 1361 Copies state parameters from the reference stream to the current 1362 stream. Tell driver interface to map device coordinates unless flags 1365 This function is used for making save files of selected plots (e.g. 1366 from the TK driver). After initializing, you can get a copy of the 1367 current plot to the specified device by switching to this stream and 1368 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as 1369 appropriate. The plot buffer must have previously been enabled (done 1370 automatically by some display drivers, such as X). 1372 Redacted form: plcpstrm(iplsr, flags) 1374 This function is used in example 1,20. 1380 plcpstrm(iplsr, flags) 1384 iplsr (PLINT, input) : Number of reference stream. 1386 flags (PLBOOL, input) : If flags is set to true the device 1387 coordinates are not copied from the reference to current stream. 1390 return _plplotc.plcpstrm(iplsr, flags)
1394 End plotting session 1398 Ends a plotting session, tidies up all the output files, switches 1399 interactive devices back into text mode and frees up any memory that 1400 was allocated. Must be called before end of program. 1402 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a 1403 wait state after a call to plend or other functions which trigger the 1404 end of a plot page. To avoid this, use the plspause function. 1406 Redacted form: plend() 1408 This function is used in all of the examples. 1417 return _plplotc.plend()
1421 End plotting session for current stream 1425 Ends a plotting session for the current output stream only. See 1426 plsstrm for more info. 1428 Redacted form: plend1() 1430 This function is used in examples 1 and 20. 1439 return _plplotc.plend1()
1441 def plenv(xmin, xmax, ymin, ymax, just, axis):
1443 Set up standard window and draw box 1447 Sets up plotter environment for simple graphs by calling pladv and 1448 setting up viewport and window to sensible default values. plenv 1449 leaves a standard margin (left-hand margin of eight character heights, 1450 and a margin around the other three sides of five character heights) 1451 around most graphs for axis labels and a title. When these defaults 1452 are not suitable, use the individual routines plvpas, plvpor, or 1453 plvasp for setting up the viewport, plwind for defining the window, 1454 and plbox for drawing the box. 1456 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis) 1458 This function is used in example 1,3,9,13,14,19-22,29. 1464 plenv(xmin, xmax, ymin, ymax, just, axis) 1468 xmin (PLFLT, input) : Value of x at left-hand edge of window (in 1471 xmax (PLFLT, input) : Value of x at right-hand edge of window (in 1474 ymin (PLFLT, input) : Value of y at bottom edge of window (in world 1477 ymax (PLFLT, input) : Value of y at top edge of window (in world 1480 just (PLINT, input) : Controls how the axes will be scaled: -1: the 1481 scales will not be set, the user must set up the scale before 1482 calling plenv using plsvpa, plvasp or other. 1483 0: the x and y axes are scaled independently to use as much of 1484 the screen as possible. 1485 1: the scales of the x and y axes are made equal. 1486 2: the axis of the x and y axes are made equal, and the plot 1490 axis (PLINT, input) : Controls drawing of the box around the plot: 1491 -2: draw no box, no tick marks, no numeric tick labels, no axes. 1493 0: draw box, ticks, and numeric tick labels. 1494 1: also draw coordinate axes at x=0 and y=0. 1495 2: also draw a grid at major tick positions in both 1497 3: also draw a grid at minor tick positions in both 1499 10: same as 0 except logarithmic x tick marks. (The x data 1500 have to be converted to logarithms separately.) 1501 11: same as 1 except logarithmic x tick marks. (The x data 1502 have to be converted to logarithms separately.) 1503 12: same as 2 except logarithmic x tick marks. (The x data 1504 have to be converted to logarithms separately.) 1505 13: same as 3 except logarithmic x tick marks. (The x data 1506 have to be converted to logarithms separately.) 1507 20: same as 0 except logarithmic y tick marks. (The y data 1508 have to be converted to logarithms separately.) 1509 21: same as 1 except logarithmic y tick marks. (The y data 1510 have to be converted to logarithms separately.) 1511 22: same as 2 except logarithmic y tick marks. (The y data 1512 have to be converted to logarithms separately.) 1513 23: same as 3 except logarithmic y tick marks. (The y data 1514 have to be converted to logarithms separately.) 1515 30: same as 0 except logarithmic x and y tick marks. (The x 1516 and y data have to be converted to logarithms separately.) 1517 31: same as 1 except logarithmic x and y tick marks. (The x 1518 and y data have to be converted to logarithms separately.) 1519 32: same as 2 except logarithmic x and y tick marks. (The x 1520 and y data have to be converted to logarithms separately.) 1521 33: same as 3 except logarithmic x and y tick marks. (The x 1522 and y data have to be converted to logarithms separately.) 1523 40: same as 0 except date / time x labels. 1524 41: same as 1 except date / time x labels. 1525 42: same as 2 except date / time x labels. 1526 43: same as 3 except date / time x labels. 1527 50: same as 0 except date / time y labels. 1528 51: same as 1 except date / time y labels. 1529 52: same as 2 except date / time y labels. 1530 53: same as 3 except date / time y labels. 1531 60: same as 0 except date / time x and y labels. 1532 61: same as 1 except date / time x and y labels. 1533 62: same as 2 except date / time x and y labels. 1534 63: same as 3 except date / time x and y labels. 1535 70: same as 0 except custom x and y labels. 1536 71: same as 1 except custom x and y labels. 1537 72: same as 2 except custom x and y labels. 1538 73: same as 3 except custom x and y labels. 1541 return _plplotc.plenv(xmin, xmax, ymin, ymax, just, axis)
1543 def plenv0(xmin, xmax, ymin, ymax, just, axis):
1545 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it 1549 Sets up plotter environment for simple graphs by calling pladv and 1550 setting up viewport and window to sensible default values. plenv0 1551 leaves a standard margin (left-hand margin of eight character heights, 1552 and a margin around the other three sides of five character heights) 1553 around most graphs for axis labels and a title. When these defaults 1554 are not suitable, use the individual routines plvpas, plvpor, or 1555 plvasp for setting up the viewport, plwind for defining the window, 1556 and plbox for drawing the box. 1558 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis) 1560 This function is used in example 21. 1566 plenv0(xmin, xmax, ymin, ymax, just, axis) 1570 xmin (PLFLT, input) : Value of x at left-hand edge of window (in 1573 xmax (PLFLT, input) : Value of x at right-hand edge of window (in 1576 ymin (PLFLT, input) : Value of y at bottom edge of window (in world 1579 ymax (PLFLT, input) : Value of y at top edge of window (in world 1582 just (PLINT, input) : Controls how the axes will be scaled: -1: the 1583 scales will not be set, the user must set up the scale before 1584 calling plenv0 using plsvpa, plvasp or other. 1585 0: the x and y axes are scaled independently to use as much of 1586 the screen as possible. 1587 1: the scales of the x and y axes are made equal. 1588 2: the axis of the x and y axes are made equal, and the plot 1592 axis (PLINT, input) : Controls drawing of the box around the plot: 1593 -2: draw no box, no tick marks, no numeric tick labels, no axes. 1595 0: draw box, ticks, and numeric tick labels. 1596 1: also draw coordinate axes at x=0 and y=0. 1597 2: also draw a grid at major tick positions in both 1599 3: also draw a grid at minor tick positions in both 1601 10: same as 0 except logarithmic x tick marks. (The x data 1602 have to be converted to logarithms separately.) 1603 11: same as 1 except logarithmic x tick marks. (The x data 1604 have to be converted to logarithms separately.) 1605 12: same as 2 except logarithmic x tick marks. (The x data 1606 have to be converted to logarithms separately.) 1607 13: same as 3 except logarithmic x tick marks. (The x data 1608 have to be converted to logarithms separately.) 1609 20: same as 0 except logarithmic y tick marks. (The y data 1610 have to be converted to logarithms separately.) 1611 21: same as 1 except logarithmic y tick marks. (The y data 1612 have to be converted to logarithms separately.) 1613 22: same as 2 except logarithmic y tick marks. (The y data 1614 have to be converted to logarithms separately.) 1615 23: same as 3 except logarithmic y tick marks. (The y data 1616 have to be converted to logarithms separately.) 1617 30: same as 0 except logarithmic x and y tick marks. (The x 1618 and y data have to be converted to logarithms separately.) 1619 31: same as 1 except logarithmic x and y tick marks. (The x 1620 and y data have to be converted to logarithms separately.) 1621 32: same as 2 except logarithmic x and y tick marks. (The x 1622 and y data have to be converted to logarithms separately.) 1623 33: same as 3 except logarithmic x and y tick marks. (The x 1624 and y data have to be converted to logarithms separately.) 1625 40: same as 0 except date / time x labels. 1626 41: same as 1 except date / time x labels. 1627 42: same as 2 except date / time x labels. 1628 43: same as 3 except date / time x labels. 1629 50: same as 0 except date / time y labels. 1630 51: same as 1 except date / time y labels. 1631 52: same as 2 except date / time y labels. 1632 53: same as 3 except date / time y labels. 1633 60: same as 0 except date / time x and y labels. 1634 61: same as 1 except date / time x and y labels. 1635 62: same as 2 except date / time x and y labels. 1636 63: same as 3 except date / time x and y labels. 1637 70: same as 0 except custom x and y labels. 1638 71: same as 1 except custom x and y labels. 1639 72: same as 2 except custom x and y labels. 1640 73: same as 3 except custom x and y labels. 1643 return _plplotc.plenv0(xmin, xmax, ymin, ymax, just, axis)
1651 Clears the graphics screen of an interactive device, or ejects a page 1652 on a plotter. See plbop for more information. 1654 Redacted form: pleop() 1656 This function is used in example 2,14. 1665 return _plplotc.pleop()
1669 Draw error bars in x direction 1673 Draws a set of n error bars in x direction, the i'th error bar 1674 extending from xmin[i] to xmax[i] at y coordinate y[i]. The terminals 1675 of the error bars are of length equal to the minor tick length 1676 (settable using plsmin). 1678 Redacted form: General: plerrx(xmin, ymax, y) 1681 This function is used in example 29. 1687 plerrx(n, xmin, xmax, y) 1691 n (PLINT, input) : Number of error bars to draw. 1693 xmin (PLFLT_VECTOR, input) : A vector containing the x coordinates 1694 of the left-hand endpoints of the error bars. 1696 xmax (PLFLT_VECTOR, input) : A vector containing the x coordinates 1697 of the right-hand endpoints of the error bars. 1699 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 1703 return _plplotc.plerrx(n, arg2, arg3)
1707 Draw error bars in the y direction 1711 Draws a set of n error bars in the y direction, the i'th error bar 1712 extending from ymin[i] to ymax[i] at x coordinate x[i]. The terminals 1713 of the error bars are of length equal to the minor tick length 1714 (settable using plsmin). 1716 Redacted form: General: plerry(x, ymin, ymax) 1719 This function is used in example 29. 1725 plerry(n, x, ymin, ymax) 1729 n (PLINT, input) : Number of error bars to draw. 1731 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 1734 ymin (PLFLT_VECTOR, input) : A vector containing the y coordinates 1735 of the lower endpoints of the error bars. 1737 ymax (PLFLT_VECTOR, input) : A vector containing the y coordinates 1738 of the upper endpoints of the error bars. 1741 return _plplotc.plerry(n, arg2, arg3)
1745 Advance to the next family file on the next new page 1749 Advance to the next family file on the next new page. 1751 Redacted form: plfamadv() 1753 This function is not used in any examples. 1762 return _plplotc.plfamadv()
1770 Fills the polygon defined by the n points ( 1772 y[i]) using the pattern defined by plpsty or plpat. The default fill 1773 style is a solid fill. The routine will automatically close the 1774 polygon between the last and first vertices. If multiple closed 1775 polygons are passed in x and y then plfill will fill in between them. 1777 Redacted form: plfill(x,y) 1779 This function is used in examples 12, 13, 15, 16, 21, 24, and 25. 1789 n (PLINT, input) : Number of vertices in polygon. 1791 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 1794 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 1798 return _plplotc.plfill(n, ArrayCk)
1802 Draw filled polygon in 3D 1806 Fills the 3D polygon defined by the n points in the x, y, and z 1807 vectors using the pattern defined by plpsty or plpat. The routine 1808 will automatically close the polygon between the last and first 1809 vertices. If multiple closed polygons are passed in x, y, and z then 1810 plfill3 will fill in between them. 1812 Redacted form: General: plfill3(x, y, z) 1815 This function is used in example 15. 1825 n (PLINT, input) : Number of vertices in polygon. 1827 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 1830 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 1833 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of 1837 return _plplotc.plfill3(n, arg2, arg3)
1841 Draw linear gradient inside polygon 1845 Draw a linear gradient using cmap1 inside the polygon defined by the n 1848 y[i]). Interpretation of the polygon is the same as for plfill. The 1849 polygon coordinates and the gradient angle are all expressed in world 1850 coordinates. The angle from the x axis for both the rotated 1851 coordinate system and the gradient vector is specified by angle. The 1852 magnitude of the gradient vector is the difference between the maximum 1853 and minimum values of x for the vertices in the rotated coordinate 1854 system. The origin of the gradient vector can be interpreted as being 1855 anywhere on the line corresponding to the minimum x value for the 1856 vertices in the rotated coordinate system. The distance along the 1857 gradient vector is linearly transformed to the independent variable of 1858 color map 1 which ranges from 0. at the tail of the gradient vector to 1859 1. at the head of the gradient vector. What is drawn is the RGBA 1860 color corresponding to the independent variable of cmap1. For more 1861 information about cmap1 (see the PLplot documentation). 1863 Redacted form: plgradient(x,y,angle) 1865 This function is used in examples 25 and 30. 1871 plgradient(n, x, y, angle) 1875 n (PLINT, input) : Number of vertices in polygon. 1877 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 1880 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 1883 angle (PLFLT, input) : Angle (degrees) of gradient vector from x 1887 return _plplotc.plgradient(n, ArrayCk, angle)
1891 Flushes the output stream 1895 Flushes the output stream. Use sparingly, if at all. 1897 Redacted form: plflush() 1899 This function is used in examples 1 and 14. 1908 return _plplotc.plflush()
1916 Sets the font used for subsequent text and symbols. For devices that 1917 still use Hershey fonts this routine has no effect unless the Hershey 1918 fonts with extended character set are loaded (see plfontld). For 1919 unicode-aware devices that use system fonts instead of Hershey fonts, 1920 this routine calls the plsfci routine with argument set up 1921 appropriately for the various cases below. However, this method of 1922 specifying the font for unicode-aware devices is deprecated, and the 1923 much more flexible method of calling plsfont directly is recommended 1924 instead (where plsfont provides a user-friendly interface to plsfci), 1926 Redacted form: plfont(ifont) 1928 This function is used in examples 1, 2, 4, 7, 13, 24, and 26. 1938 ifont (PLINT, input) : Specifies the font: 1: Sans serif font 1939 (simplest and fastest) 1945 return _plplotc.plfont(ifont)
1953 Loads the Hershey fonts used for text and symbols. This routine may 1954 be called before or after initializing PLplot. If not explicitly 1955 called before PLplot initialization, then by default that 1956 initialization loads Hershey fonts with the extended character set. 1957 This routine only has a practical effect for devices that still use 1958 Hershey fonts (as opposed to modern devices that use unicode-aware 1959 system fonts instead of Hershey fonts). 1961 Redacted form: plfontld(fnt) 1963 This function is used in examples 1 and 7. 1973 fnt (PLINT, input) : Specifies the type of Hershey fonts to load. 1974 A zero value specifies Hershey fonts with the standard character 1975 set and a non-zero value (the default assumed if plfontld is never 1976 called) specifies Hershey fonts with the extended character set. 1979 return _plplotc.plfontld(fnt)
1983 Get character default height and current (scaled) height 1987 Get character default height and current (scaled) height. 1989 Redacted form: plgchr(p_def, p_ht) 1991 This function is used in example 23. 2001 p_def (PLFLT_NC_SCALAR, output) : Returned value of the default 2002 character height (mm). 2004 p_ht (PLFLT_NC_SCALAR, output) : Returned value of the scaled 2005 character height (mm). 2008 return _plplotc.plgchr()
2012 Returns 8-bit RGB values for given color index from cmap0 2016 Returns 8-bit RGB values (0-255) for given color from cmap0 (see the 2017 PLplot documentation). Values are negative if an invalid color id is 2020 Redacted form: plgcol0(icol0, r, g, b) 2022 This function is used in example 2. 2028 plgcol0(icol0, r, g, b) 2032 icol0 (PLINT, input) : Index of desired cmap0 color. 2034 r (PLINT_NC_SCALAR, output) : Returned value of the 8-bit red 2037 g (PLINT_NC_SCALAR, output) : Returned value of the 8-bit green 2040 b (PLINT_NC_SCALAR, output) : Returned value of the 8-bit blue 2044 return _plplotc.plgcol0(icol0)
2048 Returns 8-bit RGB values and PLFLT alpha transparency value for given color index from cmap0 2052 Returns 8-bit RGB values (0-255) and PLFLT alpha transparency value 2053 (0.0-1.0) for given color from cmap0 (see the PLplot documentation). 2054 Values are negative if an invalid color id is given. 2056 Redacted form: plgcola(r, g, b) 2058 This function is used in example 30. 2064 plgcol0a(icol0, r, g, b, alpha) 2068 icol0 (PLINT, input) : Index of desired cmap0 color. 2070 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity 2071 in the range from 0 to 255. 2073 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity 2074 in the range from 0 to 255. 2076 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity 2077 in the range from 0 to 255. 2079 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha 2080 transparency in the range from (0.0-1.0). 2083 return _plplotc.plgcol0a(icol0)
2087 Returns the background color (cmap0[0]) by 8-bit RGB value 2091 Returns the background color (cmap0[0]) by 8-bit RGB value. 2093 Redacted form: plgcolbg(r, g, b) 2095 This function is used in example 31. 2105 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity 2106 in the range from 0 to 255. 2108 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity 2109 in the range from 0 to 255. 2111 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity 2112 in the range from 0 to 255. 2115 return _plplotc.plgcolbg()
2119 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT alpha transparency value 2123 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT 2124 alpha transparency value. 2126 This function is used in example 31. 2132 plgcolbga(r, g, b, alpha) 2136 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity 2137 in the range from 0 to 255. 2139 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity 2140 in the range from 0 to 255. 2142 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity 2143 in the range from 0 to 255. 2145 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha 2146 transparency in the range (0.0-1.0). 2149 return _plplotc.plgcolbga()
2153 Get the current device-compression setting 2157 Get the current device-compression setting. This parameter is only 2158 used for drivers that provide compression. 2160 Redacted form: plgcompression(compression) 2162 This function is used in example 31. 2168 plgcompression(compression) 2172 compression (PLINT_NC_SCALAR, output) : Returned value of the 2173 compression setting for the current device. 2176 return _plplotc.plgcompression()
2180 Get the current device (keyword) name 2184 Get the current device (keyword) name. Note: you must have allocated 2185 space for this (80 characters is safe). 2187 Redacted form: plgdev(p_dev) 2189 This function is used in example 14. 2199 p_dev (PLCHAR_NC_VECTOR, output) : Returned ascii character string 2200 (with preallocated length of 80 characters or more) containing the 2201 device (keyword) name. 2204 return _plplotc.plgdev()
2208 Get parameters that define current device-space window 2212 Get relative margin width, aspect ratio, and relative justification 2213 that define current device-space window. If plsdidev has not been 2214 called the default values pointed to by p_mar, p_aspect, p_jx, and 2217 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy) 2219 This function is used in example 31. 2225 plgdidev(p_mar, p_aspect, p_jx, p_jy) 2229 p_mar (PLFLT_NC_SCALAR, output) : Returned value of the relative 2232 p_aspect (PLFLT_NC_SCALAR, output) : Returned value of the aspect 2235 p_jx (PLFLT_NC_SCALAR, output) : Returned value of the relative 2238 p_jy (PLFLT_NC_SCALAR, output) : Returned value of the relative 2242 return _plplotc.plgdidev()
2246 Get plot orientation 2250 Get plot orientation parameter which is multiplied by 90 degrees to 2251 obtain the angle of rotation. Note, arbitrary rotation parameters 2252 such as 0.2 (corresponding to 18 degrees) are possible, but the usual 2253 values for the rotation parameter are 0., 1., 2., and 3. corresponding 2254 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees 2255 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has 2256 not been called the default value pointed to by p_rot will be 0. 2258 Redacted form: plgdiori(p_rot) 2260 This function is not used in any examples. 2270 p_rot (PLFLT_NC_SCALAR, output) : Returned value of the orientation 2274 return _plplotc.plgdiori()
2278 Get parameters that define current plot-space window 2282 Get relative minima and maxima that define current plot-space window. 2283 If plsdiplt has not been called the default values pointed to by 2284 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1. 2286 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax) 2288 This function is used in example 31. 2294 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax) 2298 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the relative 2301 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the relative 2304 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the relative 2307 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the relative 2311 return _plplotc.plgdiplt()
2315 Get family file parameters 2319 Gets information about current family file, if familying is enabled. 2320 See the PLplot documentation for more information. 2322 Redacted form: plgfam(p_fam, p_num, p_bmax) 2324 This function is used in examples 14 and 31. 2330 plgfam(p_fam, p_num, p_bmax) 2334 p_fam (PLINT_NC_SCALAR, output) : Returned value of the current 2335 family flag value. If nonzero, familying is enabled for the 2338 p_num (PLINT_NC_SCALAR, output) : Returned value of the current 2341 p_bmax (PLINT_NC_SCALAR, output) : Returned value of the maximum 2342 file size (in bytes) for a family file. 2345 return _plplotc.plgfam()
2349 Get FCI (font characterization integer) 2353 Gets information about the current font using the FCI approach. See 2354 the PLplot documentation for more information. 2356 Redacted form: plgfci(p_fci) 2358 This function is used in example 23. 2368 p_fci (PLUNICODE_NC_SCALAR, output) : Returned value of the current 2372 return _plplotc.plgfci()
2376 Get output file name 2380 Gets the current output file name, if applicable. 2382 Redacted form: plgfnam(fnam) 2384 This function is used in example 31. 2394 fnam (PLCHAR_NC_VECTOR, output) : Returned ascii character string 2395 (with preallocated length of 80 characters or more) containing the 2399 return _plplotc.plgfnam()
2403 Get family, style and weight of the current font 2407 Gets information about current font. See the PLplot documentation for 2408 more information on font selection. 2410 Redacted form: plgfont(p_family, p_style, p_weight) 2412 This function is used in example 23. 2418 plgfont(p_family, p_style, p_weight) 2422 p_family (PLINT_NC_SCALAR, output) : Returned value of the current 2423 font family. The available values are given by the PL_FCI_* 2424 constants in plplot.h. Current options are PL_FCI_SANS, 2425 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If 2426 p_family is NULL then the font family is not returned. 2428 p_style (PLINT_NC_SCALAR, output) : Returned value of the current 2429 font style. The available values are given by the PL_FCI_* 2430 constants in plplot.h. Current options are PL_FCI_UPRIGHT, 2431 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the font 2432 style is not returned. 2434 p_weight (PLINT_NC_SCALAR, output) : Returned value of the current 2435 font weight. The available values are given by the PL_FCI_* 2436 constants in plplot.h. Current options are PL_FCI_MEDIUM and 2437 PL_FCI_BOLD. If p_weight is NULL then the font weight is not 2441 return _plplotc.plgfont()
2445 Get the (current) run level 2449 Get the (current) run level. Valid settings are: 0, uninitialized 2452 3, world coordinates defined 2455 Redacted form: plglevel(p_level) 2457 This function is used in example 31. 2467 p_level (PLINT_NC_SCALAR, output) : Returned value of the run 2471 return _plplotc.plglevel()
2479 Gets the current page configuration. The length and offset values are 2480 expressed in units that are specific to the current driver. For 2481 instance: screen drivers will usually interpret them as number of 2482 pixels, whereas printer drivers will usually use mm. 2484 Redacted form: plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff) 2486 This function is used in examples 14 and 31. 2492 plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff) 2496 p_xp (PLFLT_NC_SCALAR, output) : Returned value of the number of 2497 pixels/inch (DPI) in x. 2499 p_yp (PLFLT_NC_SCALAR, output) : Returned value of the number of 2500 pixels/inch (DPI) in y. 2502 p_xleng (PLINT_NC_SCALAR, output) : Returned value of the x page 2505 p_yleng (PLINT_NC_SCALAR, output) : Returned value of the y page 2508 p_xoff (PLINT_NC_SCALAR, output) : Returned value of the x page 2511 p_yoff (PLINT_NC_SCALAR, output) : Returned value of the y page 2515 return _plplotc.plgpage()
2519 Switch to graphics screen 2523 Sets an interactive device to graphics mode, used in conjunction with 2524 pltext to allow graphics and text to be interspersed. On a device 2525 which supports separate text and graphics windows, this command causes 2526 control to be switched to the graphics window. If already in graphics 2527 mode, this command is ignored. It is also ignored on devices which 2528 only support a single window or use a different method for shifting 2529 focus. See also pltext. 2531 Redacted form: plgra() 2533 This function is used in example 1. 2542 return _plplotc.plgra()
2546 Grid data from irregularly sampled data 2550 Real world data is frequently irregularly sampled, but PLplot 3D plots 2551 require data organized as a grid, i.e., with x sample point values 2552 independent of y coordinate and vice versa. This function takes 2553 irregularly sampled data from the x[npts], y[npts], and z[npts] 2554 vectors; reads the desired grid location from the input vectors 2555 xg[nptsx] and yg[nptsy]; and returns the interpolated result on that 2556 grid using the output matrix zg[nptsx][nptsy]. The algorithm used to 2557 interpolate the data to the grid is specified with the argument type 2558 which can have one parameter specified in argument data. 2560 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data) 2561 Python: zg=plgriddata(x, y, z, xg, yg, type, data) 2564 This function is used in example 21. 2570 plgriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data) 2574 x (PLFLT_VECTOR, input) : The input x vector. 2576 y (PLFLT_VECTOR, input) : The input y vector. 2578 z (PLFLT_VECTOR, input) : The input z vector. Each triple x[i], 2579 y[i], z[i] represents one data sample coordinate. 2581 npts (PLINT, input) : The number of data samples in the x, y and z 2584 xg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing 2585 in the x direction. Usually xg has nptsx equally spaced values 2586 from the minimum to the maximum values of the x input vector. 2588 nptsx (PLINT, input) : The number of points in the xg vector. 2590 yg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing 2591 in the y direction. Similar to the xg parameter. 2593 nptsy (PLINT, input) : The number of points in the yg vector. 2595 zg (PLFLT_NC_MATRIX, output) : The matrix of interpolated results 2596 where data lies in the grid specified by xg and yg. Therefore the 2597 zg matrix must be dimensioned 2601 type (PLINT, input) : The type of grid interpolation algorithm to 2602 use, which can be: GRID_CSA: Bivariate Cubic Spline approximation 2603 GRID_DTLI: Delaunay Triangulation Linear Interpolation 2604 GRID_NNI: Natural Neighbors Interpolation 2605 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted 2606 GRID_NNLI: Nearest Neighbors Linear Interpolation 2607 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance 2609 For details of the algorithms read the source file plgridd.c. 2611 data (PLFLT, input) : Some gridding algorithms require extra data, 2612 which can be specified through this argument. Currently, for 2613 algorithm: GRID_NNIDW, data specifies the number of neighbors to 2614 use, the lower the value, the noisier (more local) the 2616 GRID_NNLI, data specifies what a thin triangle is, in the 2617 range [1. .. 2.]. High values enable the usage of very thin 2618 triangles for interpolation, possibly resulting in error in 2620 GRID_NNI, only weights greater than data will be accepted. If 2621 0, all weights will be accepted. 2624 return _plplotc.plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data)
2628 Get current subpage parameters 2632 Gets the size of the current subpage in millimeters measured from the 2633 bottom left hand corner of the output device page or screen. Can be 2634 used in conjunction with plsvpa for setting the size of a viewport in 2635 absolute coordinates (millimeters). 2637 Redacted form: plgspa(xmin, xmax, ymin, ymax) 2639 This function is used in example 23. 2645 plgspa(xmin, xmax, ymin, ymax) 2649 xmin (PLFLT_NC_SCALAR, output) : Returned value of the position of 2650 the left hand edge of the subpage in millimeters. 2652 xmax (PLFLT_NC_SCALAR, output) : Returned value of the position of 2653 the right hand edge of the subpage in millimeters. 2655 ymin (PLFLT_NC_SCALAR, output) : Returned value of the position of 2656 the bottom edge of the subpage in millimeters. 2658 ymax (PLFLT_NC_SCALAR, output) : Returned value of the position of 2659 the top edge of the subpage in millimeters. 2662 return _plplotc.plgspa()
2666 Get current stream number 2670 Gets the number of the current output stream. See also plsstrm. 2672 Redacted form: plgstrm(p_strm) 2674 This function is used in example 1,20. 2684 p_strm (PLINT_NC_SCALAR, output) : Returned value of the current 2688 return _plplotc.plgstrm()
2692 Get the current library version number 2696 Get the current library version number. Note: you must have allocated 2697 space for this (80 characters is safe). 2699 Redacted form: plgver(p_ver) 2701 This function is used in example 1. 2711 p_ver (PLCHAR_NC_VECTOR, output) : Returned ascii character string 2712 (with preallocated length of 80 characters or more) containing the 2713 PLplot version number. 2716 return _plplotc.plgver()
2720 Get viewport limits in normalized device coordinates 2724 Get viewport limits in normalized device coordinates. 2726 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax) 2729 This function is used in example 31. 2735 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax) 2739 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower 2740 viewport limit of the normalized device coordinate in x. 2742 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper 2743 viewport limit of the normalized device coordinate in x. 2745 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower 2746 viewport limit of the normalized device coordinate in y. 2748 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper 2749 viewport limit of the normalized device coordinate in y. 2752 return _plplotc.plgvpd()
2756 Get viewport limits in world coordinates 2760 Get viewport limits in world coordinates. 2762 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax) 2765 This function is used in example 31. 2771 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax) 2775 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower 2776 viewport limit of the world coordinate in x. 2778 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper 2779 viewport limit of the world coordinate in x. 2781 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower 2782 viewport limit of the world coordinate in y. 2784 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper 2785 viewport limit of the world coordinate in y. 2788 return _plplotc.plgvpw()
2792 Get x axis parameters 2796 Returns current values of the p_digmax and p_digits flags for the x 2797 axis. p_digits is updated after the plot is drawn, so this routine 2798 should only be called after the call to plbox (or plbox3) is complete. 2799 See the PLplot documentation for more information. 2801 Redacted form: plgxax(p_digmax, p_digits) 2803 This function is used in example 31. 2809 plgxax(p_digmax, p_digits) 2813 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum 2814 number of digits for the x axis. If nonzero, the printed label 2815 has been switched to a floating-point representation when the 2816 number of digits exceeds this value. 2818 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual 2819 number of digits for the numeric labels (x axis) from the last 2823 return _plplotc.plgxax()
2827 Get y axis parameters 2831 Identical to plgxax, except that arguments are flags for y axis. See 2832 the description of plgxax for more detail. 2834 Redacted form: plgyax(p_digmax, p_digits) 2836 This function is used in example 31. 2842 plgyax(p_digmax, p_digits) 2846 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum 2847 number of digits for the y axis. If nonzero, the printed label 2848 has been switched to a floating-point representation when the 2849 number of digits exceeds this value. 2851 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual 2852 number of digits for the numeric labels (y axis) from the last 2856 return _plplotc.plgyax()
2860 Get z axis parameters 2864 Identical to plgxax, except that arguments are flags for z axis. See 2865 the description of plgxax for more detail. 2867 Redacted form: plgzax(p_digmax, p_digits) 2869 This function is used in example 31. 2875 plgzax(p_digmax, p_digits) 2879 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum 2880 number of digits for the z axis. If nonzero, the printed label 2881 has been switched to a floating-point representation when the 2882 number of digits exceeds this value. 2884 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual 2885 number of digits for the numeric labels (z axis) from the last 2889 return _plplotc.plgzax()
2893 Plot a histogram from unbinned data 2897 Plots a histogram from n data points stored in the data vector. This 2898 routine bins the data into nbin bins equally spaced between datmin and 2899 datmax, and calls plbin to draw the resulting histogram. Parameter 2900 opt allows, among other things, the histogram either to be plotted in 2901 an existing window or causes plhist to call plenv with suitable limits 2902 before plotting the histogram. 2904 Redacted form: plhist(data, datmin, datmax, nbin, opt) 2906 This function is used in example 5. 2912 plhist(n, data, datmin, datmax, nbin, opt) 2916 n (PLINT, input) : Number of data points. 2918 data (PLFLT_VECTOR, input) : A vector containing the values of the 2921 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin. 2923 datmax (PLFLT, input) : Right-hand edge of highest-valued bin. 2925 nbin (PLINT, input) : Number of (equal-sized) bins into which to 2926 divide the interval xmin to xmax. 2928 opt (PLINT, input) : Is a combination of several flags: 2929 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit 2930 the histogram data, the outer bins are expanded to fill up the 2931 entire x-axis, data outside the given extremes are assigned to the 2932 outer bins and bins of zero height are simply drawn. 2933 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled 2934 to fit the histogram data, without this flag, plenv is called 2935 to set the world coordinates. 2936 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given 2937 extremes are not taken into account. This option should 2938 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to 2939 properly present the data. 2940 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal 2941 size as the ones inside. 2942 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn 2943 (there is a gap for such bins). 2946 return _plplotc.plhist(n, datmin, datmax, nbin, oldwin)
2950 Convert HLS color to RGB 2954 Convert HLS color coordinates to RGB. 2956 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b) 2959 This function is used in example 2. 2965 plhlsrgb(h, l, s, p_r, p_g, p_b) 2969 h (PLFLT, input) : Hue in degrees (0.0-360.0) on the color 2972 l (PLFLT, input) : Lightness expressed as a fraction (0.0-1.0) of 2973 the axis of the color cylinder. 2975 s (PLFLT, input) : Saturation expressed as a fraction (0.0-1.0) of 2976 the radius of the color cylinder. 2978 p_r (PLFLT_NC_SCALAR, output) : Returned value of the red intensity 2979 (0.0-1.0) of the color. 2981 p_g (PLFLT_NC_SCALAR, output) : Returned value of the green 2982 intensity (0.0-1.0) of the color. 2984 p_b (PLFLT_NC_SCALAR, output) : Returned value of the blue 2985 intensity (0.0-1.0) of the color. 2988 return _plplotc.plhlsrgb(h, l, s)
2996 Initializing the plotting package. The program prompts for the device 2997 keyword or number of the desired output device. Hitting a RETURN in 2998 response to the prompt is the same as selecting the first device. 2999 plinit will issue no prompt if either the device was specified 3000 previously (via command line flag, the plsetopt function, or the 3001 plsdev function), or if only one device is enabled when PLplot is 3002 installed. If subpages have been specified, the output device is 3003 divided into nx by ny subpages, each of which may be used 3004 independently. If plinit is called again during a program, the 3005 previously opened file will be closed. The subroutine pladv is used 3006 to advance from one subpage to the next. 3008 Redacted form: plinit() 3010 This function is used in all of the examples. 3019 return _plplotc.plinit()
3023 Draw a line between two points 3033 Redacted form: pljoin(x1,y1,x2,y2) 3035 This function is used in examples 3 and 14. 3041 pljoin(x1, y1, x2, y2) 3045 x1 (PLFLT, input) : x coordinate of first point. 3047 y1 (PLFLT, input) : y coordinate of first point. 3049 x2 (PLFLT, input) : x coordinate of second point. 3051 y2 (PLFLT, input) : y coordinate of second point. 3054 return _plplotc.pljoin(x1, y1, x2, y2)
3058 Simple routine to write labels 3062 Routine for writing simple labels. Use plmtex for more complex labels. 3064 Redacted form: pllab(xlabel, ylabel, tlabel) 3066 This function is used in examples 1, 5, 9, 12, 14-16, 20-22, and 29. 3072 pllab(xlabel, ylabel, tlabel) 3076 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 3077 the label for the x axis. 3079 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 3080 the label for the y axis. 3082 tlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying 3083 the title of the plot. 3086 return _plplotc.pllab(xlabel, ylabel, tlabel)
3088 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, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28, arg29, arg30):
3090 Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols 3094 Routine for creating a discrete plot legend with a plotted filled box, 3095 line, and/or line of symbols for each annotated legend entry. (See 3096 plcolorbar for similar functionality for creating continuous color 3097 bars.) The arguments of pllegend provide control over the location 3098 and size of the legend as well as the location and characteristics of 3099 the elements (most of which are optional) within that legend. The 3100 resulting legend is clipped at the boundaries of the current subpage. 3101 (N.B. the adopted coordinate system used for some of the parameters is 3102 defined in the documentation of the position parameter.) 3104 Redacted form: pllegend(p_legend_width, p_legend_height, opt, 3105 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, 3106 ncolumn, opt_array, text_offset, text_scale, text_spacing, 3107 test_justification, text_colors, text, box_colors, box_patterns, 3108 box_scales, box_line_widths, line_colors, line_styles, line_widths, 3109 symbol_colors, symbol_scales, symbol_numbers, symbols) 3111 This function is used in examples 4, 26, and 33. 3117 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) 3121 p_legend_width (PLFLT_NC_SCALAR, output) : Returned value of the 3122 legend width in adopted coordinates. This quantity is calculated 3123 from plot_width, text_offset, ncolumn (possibly modified inside 3124 the routine depending on nlegend and nrow), and the length 3125 (calculated internally) of the longest text string. 3127 p_legend_height (PLFLT_NC_SCALAR, output) : Returned value of the 3128 legend height in adopted coordinates. This quantity is calculated 3129 from text_scale, text_spacing, and nrow (possibly modified inside 3130 the routine depending on nlegend and nrow). 3132 opt (PLINT, input) : opt contains bits controlling the overall 3133 legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area 3134 on the left of the legend and the plotted area on the right. 3135 Otherwise, put the text area on the right of the legend and the 3136 plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set, 3137 plot a (semitransparent) background for the legend. If the 3138 PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the 3139 legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the 3140 possibly internally transformed) nrow > 1 and ncolumn > 1, then 3141 plot the resulting array of legend entries in row-major order. 3142 Otherwise, plot the legend entries in column-major order. 3144 position (PLINT, input) : position contains bits which control the 3145 overall position of the legend and the definition of the adopted 3146 coordinates used for positions just like what is done for the 3147 position argument for plcolorbar. However, note that the defaults 3148 for the position bits (see below) are different than the 3149 plcolorbar case. The combination of the PL_POSITION_LEFT, 3150 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM, 3151 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of 3152 the 16 possible standard positions (the 4 corners and centers of 3153 the 4 sides for both the inside and outside cases) of the legend 3154 relative to the adopted coordinate system. The corner positions 3155 are specified by the appropriate combination of two of the 3156 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and 3157 PL_POSITION_BOTTOM bits while the sides are specified by a single 3158 value of one of those bits. The adopted coordinates are 3159 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is 3160 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE 3161 bit is set. Default position bits: If none of PL_POSITION_LEFT, 3162 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set, 3163 then use the combination of PL_POSITION_RIGHT and PL_POSITION_TOP. 3164 If neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set, 3165 use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or 3166 PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT. 3168 x (PLFLT, input) : X offset of the legend position in adopted 3169 coordinates from the specified standard position of the legend. 3170 For positive x, the direction of motion away from the standard 3171 position is inward/outward from the standard corner positions or 3172 standard left or right positions if the 3173 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. 3174 For the standard top or bottom positions, the direction of motion 3175 is toward positive X. 3177 y (PLFLT, input) : Y offset of the legend position in adopted 3178 coordinates from the specified standard position of the legend. 3179 For positive y, the direction of motion away from the standard 3180 position is inward/outward from the standard corner positions or 3181 standard top or bottom positions if the 3182 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. For 3183 the standard left or right positions, the direction of motion is 3186 plot_width (PLFLT, input) : Horizontal width in adopted coordinates 3187 of the plot area (where the colored boxes, lines, and/or lines of 3188 symbols are drawn) of the legend. 3190 bg_color (PLINT, input) : The cmap0 color of the background for the 3191 legend (PL_LEGEND_BACKGROUND). 3193 bb_color (PLINT, input) : The cmap0 color of the bounding-box line 3194 for the legend (PL_LEGEND_BOUNDING_BOX). 3196 bb_style (PLINT, input) : The pllsty style number for the 3197 bounding-box line for the legend (PL_LEGEND_BACKGROUND). 3199 nrow (PLINT, input) : The number of rows in the matrix used to 3201 nlegend legend entries. For internal transformations of 3202 nrow, see further remarks under 3205 ncolumn (PLINT, input) : The number of columns in the matrix used 3207 nlegend legend entries. For internal transformations of 3208 ncolumn, see further remarks under 3211 nlegend (PLINT, input) : Number of legend entries. The above 3213 ncolumn values are transformed internally to be consistent with 3216 ncolumn is non-positive it is replaced by 1. If the resulting product 3219 ncolumn is less than 3220 nlegend, the smaller of the two (or 3223 ncolumn) is increased so the product is >= 3224 nlegend. Thus, for example, the common 3226 ncolumn = 0 case is transformed internally to 3229 ncolumn = 1; i.e., the usual case of a legend rendered as a single 3232 opt_array (PLINT_VECTOR, input) : A vector of 3233 nlegend values of options to control each individual plotted area 3234 corresponding to a legend entry. If the 3235 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted 3237 PL_LEGEND_COLOR_BOX, 3238 PL_LEGEND_LINE, and/or 3239 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend 3240 entry is plotted with a colored box; a line; and/or a line of 3243 text_offset (PLFLT, input) : Offset of the text area from the plot 3244 area in units of character width. 3246 text_scale (PLFLT, input) : Character height scale for text 3249 text_spacing (PLFLT, input) : Vertical spacing in units of the 3250 character height from one legend entry to the next. 3252 text_justification (PLFLT, input) : Justification parameter used 3253 for text justification. The most common values of 3254 text_justification are 0., 0.5, or 1. corresponding to a text that 3255 is left justified, centred, or right justified within the text 3256 area, but other values are allowed as well. 3258 text_colors (PLINT_VECTOR, input) : A vector containing 3259 nlegend cmap0 text colors. 3261 text (PLCHAR_MATRIX, input) : A vector of 3262 nlegend UTF-8 character strings containing the legend annotations. 3264 box_colors (PLINT_VECTOR, input) : A vector containing 3265 nlegend cmap0 colors for the discrete colored boxes ( 3266 PL_LEGEND_COLOR_BOX). 3268 box_patterns (PLINT_VECTOR, input) : A vector containing 3269 nlegend patterns (plpsty indices) for the discrete colored boxes ( 3270 PL_LEGEND_COLOR_BOX). 3272 box_scales (PLFLT_VECTOR, input) : A vector containing 3273 nlegend scales (units of fraction of character height) for the height 3274 of the discrete colored boxes ( 3275 PL_LEGEND_COLOR_BOX). 3277 box_line_widths (PLFLT_VECTOR, input) : A vector containing 3278 nlegend line widths for the patterns specified by box_patterns ( 3279 PL_LEGEND_COLOR_BOX). 3281 line_colors (PLINT_VECTOR, input) : A vector containing 3282 nlegend cmap0 line colors ( 3285 line_styles (PLINT_VECTOR, input) : A vector containing 3286 nlegend line styles (plsty indices) ( 3289 line_widths (PLFLT_VECTOR, input) : A vector containing 3290 nlegend line widths ( 3293 symbol_colors (PLINT_VECTOR, input) : A vector containing 3294 nlegend cmap0 symbol colors ( 3297 symbol_scales (PLFLT_VECTOR, input) : A vector containing 3298 nlegend scale values for the symbol height ( 3301 symbol_numbers (PLINT_VECTOR, input) : A vector containing 3302 nlegend numbers of symbols to be drawn across the width of the plotted 3306 symbols (PLCHAR_MATRIX, input) : A vector of 3307 nlegend UTF-8 character strings containing the legend symbols. ( 3311 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, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28, arg29, arg30)
3313 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, arg16, arg17, arg18, arg19, arg20, ArrayN, MatrixCk):
3315 Plot color bar for image, shade or gradient plots 3319 Routine for creating a continuous color bar for image, shade, or 3320 gradient plots. (See pllegend for similar functionality for creating 3321 legends with discrete elements). The arguments of plcolorbar provide 3322 control over the location and size of the color bar as well as the 3323 location and characteristics of the elements (most of which are 3324 optional) within that color bar. The resulting color bar is clipped 3325 at the boundaries of the current subpage. (N.B. the adopted coordinate 3326 system used for some of the parameters is defined in the documentation 3327 of the position parameter.) 3329 Redacted form: plcolorbar(p_colorbar_width, p_colorbar_height, opt, 3330 position, x, y, x_length, y_length, bg_color, bb_color, bb_style, 3331 low_cap_color, high_cap_color, cont_color, cont_width, label_opts, 3332 labels, axis_opts, ticks, sub_ticks, values) 3334 This function is used in examples 16 and 33. 3340 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) 3344 p_colorbar_width (PLFLT_NC_SCALAR, output) : Returned value of the 3345 labelled and decorated color bar width in adopted coordinates. 3347 p_colorbar_height (PLFLT_NC_SCALAR, output) : Returned value of the 3348 labelled and decorated color bar height in adopted coordinates. 3350 opt (PLINT, input) : opt contains bits controlling the overall 3351 color bar. The orientation (direction of the maximum value) of 3352 the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP, 3353 PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM. If none of these bits are 3354 specified, the default orientation is toward the top if the 3355 colorbar is placed on the left or right of the viewport or toward 3356 the right if the colorbar is placed on the top or bottom of the 3357 viewport. If the PL_COLORBAR_BACKGROUND bit is set, plot a 3358 (semitransparent) background for the color bar. If the 3359 PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the 3360 color bar. The type of color bar must be specified with one of 3361 PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If 3362 more than one of those bits is set only the first one in the above 3363 list is honored. The position of the (optional) label/title can be 3364 specified with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT, or 3365 PL_LABEL_BOTTOM. If no label position bit is set then no label 3366 will be drawn. If more than one of this list of bits is specified, 3367 only the first one on the list is honored. End-caps for the color 3368 bar can added with PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH. 3369 If a particular color bar cap option is not specified then no cap 3370 will be drawn for that end. As a special case for 3371 PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be 3372 specified. If this option is provided then any tick marks and tick 3373 labels will be placed at the breaks between shaded segments. TODO: 3374 This should be expanded to support custom placement of tick marks 3375 and tick labels at custom value locations for any color bar type. 3377 position (PLINT, input) : position contains bits which control the 3378 overall position of the color bar and the definition of the 3379 adopted coordinates used for positions just like what is done for 3380 the position argument for pllegend. However, note that the 3381 defaults for the position bits (see below) are different than the 3382 pllegend case. The combination of the PL_POSITION_LEFT, 3383 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM, 3384 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of 3385 the 16 possible standard positions (the 4 corners and centers of 3386 the 4 sides for both the inside and outside cases) of the color 3387 bar relative to the adopted coordinate system. The corner 3388 positions are specified by the appropriate combination of two of 3389 the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and 3390 PL_POSITION_BOTTOM bits while the sides are specified by a single 3391 value of one of those bits. The adopted coordinates are 3392 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is 3393 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE 3394 bit is set. Default position bits: If none of PL_POSITION_LEFT, 3395 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set, 3396 then use PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE or 3397 PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE. If neither of 3398 PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use 3399 PL_POSITION_VIEWPORT. 3401 x (PLFLT, input) : X offset of the color bar position in adopted 3402 coordinates from the specified standard position of the color bar. 3403 For positive x, the direction of motion away from the standard 3404 position is inward/outward from the standard corner positions or 3405 standard left or right positions if the 3406 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. 3407 For the standard top or bottom positions, the direction of motion 3408 is toward positive X. 3410 y (PLFLT, input) : Y offset of the color bar position in adopted 3411 coordinates from the specified standard position of the color bar. 3412 For positive y, the direction of motion away from the standard 3413 position is inward/outward from the standard corner positions or 3414 standard top or bottom positions if the 3415 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. 3416 For the standard left or right positions, the direction of motion 3417 is toward positive Y. 3419 x_length (PLFLT, input) : Length of the body of the color bar in 3420 the X direction in adopted coordinates. 3422 y_length (PLFLT, input) : Length of the body of the color bar in 3423 the Y direction in adopted coordinates. 3425 bg_color (PLINT, input) : The cmap0 color of the background for the 3426 color bar (PL_COLORBAR_BACKGROUND). 3428 bb_color (PLINT, input) : The cmap0 color of the bounding-box line 3429 for the color bar (PL_COLORBAR_BOUNDING_BOX). 3431 bb_style (PLINT, input) : The pllsty style number for the 3432 bounding-box line for the color bar (PL_COLORBAR_BACKGROUND). 3434 low_cap_color (PLFLT, input) : The cmap1 color of the low-end color 3435 bar cap, if it is drawn (PL_COLORBAR_CAP_LOW). 3437 high_cap_color (PLFLT, input) : The cmap1 color of the high-end 3438 color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH). 3440 cont_color (PLINT, input) : The cmap0 contour color for 3441 PL_COLORBAR_SHADE plots. This is passed directly to plshades, so 3442 it will be interpreted according to the design of plshades. 3444 cont_width (PLFLT, input) : Contour width for PL_COLORBAR_SHADE 3445 plots. This is passed directly to plshades, so it will be 3446 interpreted according to the design of plshades. 3448 n_labels (PLINT, input) : Number of labels to place around the 3451 label_opts (PLINT_VECTOR, input) : A vector of options for each of 3454 labels (PLCHAR_MATRIX, input) : A vector of 3455 n_labels UTF-8 character strings containing the labels for the color 3456 bar. Ignored if no label position is specified with one of the 3457 PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP, 3458 PL_COLORBAR_LABEL_LEFT, or PL_COLORBAR_LABEL_BOTTOM bits in the 3459 corresponding label_opts field. 3461 n_axes (PLINT, input) : Number of axis definitions provided. This 3462 value must be greater than 0. It is typically 1 (numerical axis 3463 labels are provided for one of the long edges of the color bar), 3464 but it can be larger if multiple numerical axis labels for the 3465 long edges of the color bar are desired. 3467 axis_opts (PLCHAR_MATRIX, input) : A vector of 3468 n_axes ascii character strings containing options (interpreted as for 3469 plbox) for the color bar's axis definitions. 3471 ticks (PLFLT_VECTOR, input) : A vector of n_axes values of the 3472 spacing of the major tick marks (interpreted as for plbox) for the 3473 color bar's axis definitions. 3475 sub_ticks (PLINT_VECTOR, input) : A vector of n_axes values of the 3476 number of subticks (interpreted as for plbox) for the color bar's 3479 n_values (PLINT_VECTOR, input) : A vector containing the number of 3480 elements in each of the n_axes rows of the values matrix. 3482 values (PLFLT_MATRIX, input) : A matrix containing the numeric 3483 values for the data range represented by the color bar. For a row 3484 index of i_axis (where 0 < i_axis < n_axes), the number of 3485 elements in the row is specified by n_values[i_axis]. For 3486 PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT the number of elements 3487 is 2, and the corresponding row elements of the values matrix are 3488 the minimum and maximum value represented by the colorbar. For 3489 PL_COLORBAR_SHADE, the number and values of the elements of a row 3490 of the values matrix is interpreted the same as the nlevel and 3491 clevel arguments of plshades. 3494 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, arg16, arg17, arg18, arg19, arg20, ArrayN, MatrixCk)
3498 Sets the 3D position of the light source 3502 Sets the 3D position of the light source for use with plsurf3d and 3505 Redacted form: pllightsource(x, y, z) 3507 This function is used in example 8. 3513 pllightsource(x, y, z) 3517 x (PLFLT, input) : X-coordinate of the light source. 3519 y (PLFLT, input) : Y-coordinate of the light source. 3521 z (PLFLT, input) : Z-coordinate of the light source. 3524 return _plplotc.pllightsource(x, y, z)
3532 Draws line defined by n points in x and y. 3534 Redacted form: plline(x, y) 3536 This function is used in examples 1, 3, 4, 9, 12-14, 16, 18, 20, 22, 3547 n (PLINT, input) : Number of points defining line. 3549 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 3552 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 3556 return _plplotc.plline(n, ArrayCk)
3560 Draw a line in 3 space 3564 Draws line in 3 space defined by n points in x, y, and z. You must 3565 first set up the viewport, the 2d viewing window (in world 3566 coordinates), and the 3d normalized coordinate box. See x18c.c for 3569 Redacted form: plline3(x, y, z) 3571 This function is used in example 18. 3581 n (PLINT, input) : Number of points defining line. 3583 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 3586 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 3589 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of 3593 return _plplotc.plline3(n, arg2, arg3)
3601 This sets the line style according to one of eight predefined patterns 3604 Redacted form: pllsty(lin) 3606 This function is used in examples 9, 12, 22, and 25. 3616 lin (PLINT, input) : Integer value between 1 and 8. Line style 1 is 3617 a continuous line, line style 2 is a line with short dashes and 3618 gaps, line style 3 is a line with long dashes and gaps, line style 3619 4 has long dashes and short gaps and so on. 3622 return _plplotc.pllsty(lin)
3630 Plots a surface mesh within the environment set up by plw3d. The 3631 surface is defined by the matrix z[ 3633 ny] , the point z[i][j] being the value of the function at ( 3635 y[j]). Note that the points in vectors x and y do not need to be 3636 equally spaced, but must be stored in ascending order. The parameter 3637 opt controls the way in which the surface is displayed. For further 3638 details see the PLplot documentation. 3640 Redacted form: plmesh(x, y, z, opt) 3642 This function is used in example 11. 3648 plmesh(x, y, z, nx, ny, opt) 3652 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 3653 which the function is evaluated. 3655 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 3656 which the function is evaluated. 3658 z (PLFLT_MATRIX, input) : A matrix containing function values to 3659 plot. Should have dimensions of 3663 nx (PLINT, input) : Number of x values at which function has been 3666 ny (PLINT, input) : Number of y values at which function has been 3669 opt (PLINT, input) : Determines the way in which the surface is 3670 represented: opt=DRAW_LINEX : Lines are drawn showing z as a 3671 function of x for each value of y[j] . 3672 opt=DRAW_LINEY : Lines are drawn showing z as a function of y 3673 for each value of x[i] . 3674 opt=DRAW_LINEXY : Network of lines is drawn connecting points 3675 at which function is defined. 3678 return _plplotc.plmesh(ArrayX, ArrayY, MatrixCk, opt)
3680 def plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array):
3682 Magnitude colored plot surface mesh with contour 3686 A more powerful form of plmesh: the surface mesh can be colored 3687 accordingly to the current z value being plotted, a contour plot can 3688 be drawn at the base XY plane, and a curtain can be drawn between the 3689 plotted function border and the base XY plane. 3691 Redacted form: plmeshc(x, y, z, opt, clevel) 3693 This function is used in example 11. 3699 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel) 3703 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 3704 which the function is evaluated. 3706 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 3707 which the function is evaluated. 3709 z (PLFLT_MATRIX, input) : A matrix containing function values to 3710 plot. Should have dimensions of 3714 nx (PLINT, input) : Number of x values at which function is 3717 ny (PLINT, input) : Number of y values at which function is 3720 opt (PLINT, input) : Determines the way in which the surface is 3721 represented. To specify more than one option just add the options, 3722 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn 3723 showing z as a function of x for each value of y[j] . 3724 opt=DRAW_LINEY : Lines are drawn showing z as a function of y 3725 for each value of x[i] . 3726 opt=DRAW_LINEXY : Network of lines is drawn connecting points 3727 at which function is defined. 3728 opt=MAG_COLOR : Each line in the mesh is colored according to 3729 the z value being plotted. The color is used from the current 3731 opt=BASE_CONT : A contour plot is drawn at the base XY plane 3735 opt=DRAW_SIDES : draws a curtain between the base XY plane and 3736 the borders of the plotted function. 3739 clevel (PLFLT_VECTOR, input) : A vector containing the contour 3742 nlevel (PLINT, input) : Number of elements in the clevel vector. 3745 return _plplotc.plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array)
3749 Creates a new stream and makes it the default 3753 Creates a new stream and makes it the default. Differs from using 3754 plsstrm, in that a free stream number is found, and returned. 3755 Unfortunately, I have to start at stream 1 and work upward, since 3756 stream 0 is preallocated. One of the big flaws in the PLplot API is 3757 that no initial, library-opening call is required. So stream 0 must 3758 be preallocated, and there is no simple way of determining whether it 3759 is already in use or not. 3761 Redacted form: plmkstrm(p_strm) 3763 This function is used in examples 1 and 20. 3773 p_strm (PLINT_NC_SCALAR, output) : Returned value of the stream 3774 number of the created stream. 3777 return _plplotc.plmkstrm()
3781 Write text relative to viewport boundaries 3785 Writes text at a specified position relative to the viewport 3786 boundaries. Text may be written inside or outside the viewport, but 3787 is clipped at the subpage boundaries. The reference point of a string 3788 lies along a line passing through the string at half the height of a 3789 capital letter. The position of the reference point along this line 3790 is determined by just, and the position of the reference point 3791 relative to the viewport is set by disp and pos. 3793 Redacted form: General: plmtex(side, disp, pos, just, text) 3796 This function is used in examples 3, 4, 6-8, 11, 12, 14, 18, 23, and 3803 plmtex(side, disp, pos, just, text) 3807 side (PLCHAR_VECTOR, input) : An ascii character string specifying 3808 the side of the viewport along which the text is to be written. 3809 The string must be one of: b: Bottom of viewport, text written 3811 bv: Bottom of viewport, text written at right angles to edge. 3812 l: Left of viewport, text written parallel to edge. 3813 lv: Left of viewport, text written at right angles to edge. 3814 r: Right of viewport, text written parallel to edge. 3815 rv: Right of viewport, text written at right angles to edge. 3816 t: Top of viewport, text written parallel to edge. 3817 tv: Top of viewport, text written at right angles to edge. 3820 disp (PLFLT, input) : Position of the reference point of string, 3821 measured outwards from the specified viewport edge in units of the 3822 current character height. Use negative disp to write within the 3825 pos (PLFLT, input) : Position of the reference point of string 3826 along the specified edge, expressed as a fraction of the length of 3829 just (PLFLT, input) : Specifies the position of the string relative 3830 to its reference point. If just=0. , the reference point is at 3831 the left and if just=1. , it is at the right of the string. Other 3832 values of just give intermediate justifications. 3834 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be 3838 return _plplotc.plmtex(side, disp, pos, just, text)
3842 Write text relative to viewport boundaries in 3D plots 3846 Writes text at a specified position relative to the viewport 3847 boundaries. Text may be written inside or outside the viewport, but 3848 is clipped at the subpage boundaries. The reference point of a string 3849 lies along a line passing through the string at half the height of a 3850 capital letter. The position of the reference point along this line 3851 is determined by just, and the position of the reference point 3852 relative to the viewport is set by disp and pos. 3854 Redacted form: plmtex3(side, disp, pos, just, text) 3856 This function is used in example 28. 3862 plmtex3(side, disp, pos, just, text) 3866 side (PLCHAR_VECTOR, input) : An ascii character string specifying 3867 the side of the viewport along which the text is to be written. 3868 The string should contain one or more of the following characters: 3869 [xyz][ps][v]. Only one label is drawn at a time, i.e. xyp will 3870 only label the X axis, not both the X and Y axes. x: Label the X 3872 y: Label the Y axis. 3873 z: Label the Z axis. 3874 p: Label the primary axis. For Z this is the leftmost Z axis. 3875 For X it is the axis that starts at y-min. For Y it is the 3876 axis that starts at x-min. 3877 s: Label the secondary axis. 3878 v: Draw the text perpendicular to the axis. 3881 disp (PLFLT, input) : Position of the reference point of string, 3882 measured outwards from the specified viewport edge in units of the 3883 current character height. Use negative disp to write within the 3886 pos (PLFLT, input) : Position of the reference point of string 3887 along the specified edge, expressed as a fraction of the length of 3890 just (PLFLT, input) : Specifies the position of the string relative 3891 to its reference point. If just=0. , the reference point is at 3892 the left and if just=1. , it is at the right of the string. Other 3893 values of just give intermediate justifications. 3895 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be 3899 return _plplotc.plmtex3(side, disp, pos, just, text)
3901 def plot3d(ArrayX, ArrayY, MatrixCk, opt, side):
3903 Plot 3-d surface plot 3907 Plots a three-dimensional surface plot within the environment set up 3908 by plw3d. The surface is defined by the matrix z[ 3910 ny] , the point z[i][j] being the value of the function at ( 3912 y[j]). Note that the points in vectors x and y do not need to be 3913 equally spaced, but must be stored in ascending order. The parameter 3914 opt controls the way in which the surface is displayed. For further 3915 details see the PLplot documentation. The only difference between 3916 plmesh and plot3d is that plmesh draws the bottom side of the surface, 3917 while plot3d only draws the surface as viewed from the top. 3919 Redacted form: plot3d(x, y, z, opt, side) 3921 This function is used in examples 11 and 21. 3927 plot3d(x, y, z, nx, ny, opt, side) 3931 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 3932 which the function is evaluated. 3934 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 3935 which the function is evaluated. 3937 z (PLFLT_MATRIX, input) : A matrix containing function values to 3938 plot. Should have dimensions of 3942 nx (PLINT, input) : Number of x values at which function is 3945 ny (PLINT, input) : Number of y values at which function is 3948 opt (PLINT, input) : Determines the way in which the surface is 3949 represented: opt=DRAW_LINEX : Lines are drawn showing z as a 3950 function of x for each value of y[j] . 3951 opt=DRAW_LINEY : Lines are drawn showing z as a function of y 3952 for each value of x[i] . 3953 opt=DRAW_LINEXY : Network of lines is drawn connecting points 3954 at which function is defined. 3957 side (PLBOOL, input) : Flag to indicate whether or not ``sides'' 3958 should be draw on the figure. If side is true sides are drawn, 3959 otherwise no sides are drawn. 3962 return _plplotc.plot3d(ArrayX, ArrayY, MatrixCk, opt, side)
3964 def plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array):
3966 Magnitude colored plot surface with contour 3970 Aside from dropping the 3971 side functionality this is a more powerful form of plot3d: the surface 3972 mesh can be colored accordingly to the current z value being plotted, 3973 a contour plot can be drawn at the base XY plane, and a curtain can be 3974 drawn between the plotted function border and the base XY plane. The 3975 arguments are identical to those of plmeshc. The only difference 3976 between plmeshc and plot3dc is that plmeshc draws the bottom side of 3977 the surface, while plot3dc only draws the surface as viewed from the 3980 Redacted form: General: plot3dc(x, y, z, opt, clevel) 3983 This function is used in example 21. 3989 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel) 3993 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 3994 which the function is evaluated. 3996 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 3997 which the function is evaluated. 3999 z (PLFLT_MATRIX, input) : A matrix containing function values to 4000 plot. Should have dimensions of 4004 nx (PLINT, input) : Number of x values at which function is 4007 ny (PLINT, input) : Number of y values at which function is 4010 opt (PLINT, input) : Determines the way in which the surface is 4011 represented. To specify more than one option just add the options, 4012 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn 4013 showing z as a function of x for each value of y[j] . 4014 opt=DRAW_LINEY : Lines are drawn showing z as a function of y 4015 for each value of x[i] . 4016 opt=DRAW_LINEXY : Network of lines is drawn connecting points 4017 at which function is defined. 4018 opt=MAG_COLOR : Each line in the mesh is colored according to 4019 the z value being plotted. The color is used from the current 4021 opt=BASE_CONT : A contour plot is drawn at the base XY plane 4025 opt=DRAW_SIDES : draws a curtain between the base XY plane and 4026 the borders of the plotted function. 4029 clevel (PLFLT_VECTOR, input) : A vector containing the contour 4032 nlevel (PLINT, input) : Number of elements in the clevel vector. 4035 return _plplotc.plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array)
4037 def plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
4039 Magnitude colored plot surface with contour for z[x][y] with y index limits 4043 When the implementation is completed this variant of plot3dc (see that 4044 function's documentation for more details) should be suitable for the 4045 case where the area of the x, y coordinate grid where z is defined can 4046 be non-rectangular. The implementation is incomplete so the last 4 4047 parameters of plot3dcl; indexxmin, indexxmax, indexymin, and 4048 indexymax; are currently ignored and the functionality is otherwise 4049 identical to that of plot3dc. 4051 Redacted form: General: plot3dcl(x, y, z, opt, clevel, indexxmin, 4052 indexymin, indexymax) 4055 This function is not used in any example. 4061 plot3dcl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax) 4065 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 4066 which the function is evaluated. 4068 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 4069 which the function is evaluated. 4071 z (PLFLT_MATRIX, input) : A matrix containing function values to 4072 plot. Should have dimensions of 4076 nx (PLINT, input) : Number of x values at which the function is 4079 ny (PLINT, input) : Number of y values at which the function is 4082 opt (PLINT, input) : Determines the way in which the surface is 4083 represented. To specify more than one option just add the options, 4084 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn 4085 showing z as a function of x for each value of y[j] . 4086 opt=DRAW_LINEY : Lines are drawn showing z as a function of y 4087 for each value of x[i] . 4088 opt=DRAW_LINEXY : Network of lines is drawn connecting points 4089 at which function is defined. 4090 opt=MAG_COLOR : Each line in the mesh is colored according to 4091 the z value being plotted. The color is used from the current 4093 opt=BASE_CONT : A contour plot is drawn at the base XY plane 4097 opt=DRAW_SIDES : draws a curtain between the base XY plane and 4098 the borders of the plotted function. 4101 clevel (PLFLT_VECTOR, input) : A vector containing the contour 4104 nlevel (PLINT, input) : Number of elements in the clevel vector. 4106 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that 4107 corresponds to the first x index where z is defined. 4109 indexxmax (PLINT, input) : The index value (which must be ≤ nx) 4110 which corresponds (by convention) to one more than the last x 4111 index value where z is defined. 4113 indexymin (PLINT_VECTOR, input) : A vector containing y index 4114 values which all must be ≥ 0. These values are the first y index 4115 where z is defined for a particular x index in the range from 4116 indexxmin to indexxmax - 1. The dimension of indexymin is 4119 indexymax (PLINT_VECTOR, input) : A vector containing y index 4120 values which all must be ≤ ny. These values correspond (by 4121 convention) to one more than the last y index where z is defined 4122 for a particular x index in the range from indexxmin to indexxmax 4123 - 1. The dimension of indexymax is indexxmax. 4126 return _plplotc.plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4130 Plot shaded 3-d surface plot 4134 Plots a three-dimensional shaded surface plot within the environment 4135 set up by plw3d. The surface is defined by the two-dimensional matrix 4138 ny], the point z[i][j] being the value of the function at ( 4140 y[j]). Note that the points in vectors x and y do not need to be 4141 equally spaced, but must be stored in ascending order. For further 4142 details see the PLplot documentation. 4144 Redacted form: plsurf3d(x, y, z, opt, clevel) 4146 This function is not used in any examples. 4152 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel) 4156 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 4157 which the function is evaluated. 4159 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 4160 which the function is evaluated. 4162 z (PLFLT_MATRIX, input) : A matrix containing function values to 4163 plot. Should have dimensions of 4167 nx (PLINT, input) : Number of x values at which function is 4170 ny (PLINT, input) : Number of y values at which function is 4173 opt (PLINT, input) : Determines the way in which the surface is 4174 represented. To specify more than one option just add the options, 4175 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn 4176 connecting points at which function is defined. 4177 opt=BASE_CONT : A contour plot is drawn at the base XY plane 4181 opt=SURF_CONT : A contour plot is drawn at the surface plane 4185 opt=DRAW_SIDES : draws a curtain between the base XY plane and 4186 the borders of the plotted function. 4187 opt=MAG_COLOR : the surface is colored according to the value 4188 of Z; if MAG_COLOR is not used, then the surface is colored 4189 according to the intensity of the reflected light in the 4190 surface from a light source whose position is set using 4194 clevel (PLFLT_VECTOR, input) : A vector containing the contour 4197 nlevel (PLINT, input) : Number of elements in the clevel vector. 4200 return _plplotc.plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array)
4202 def plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
4204 Plot shaded 3-d surface plot for z[x][y] with y index limits 4208 This variant of plsurf3d (see that function's documentation for more 4209 details) should be suitable for the case where the area of the x, y 4210 coordinate grid where z is defined can be non-rectangular. The limits 4211 of that grid are provided by the parameters indexxmin, indexxmax, 4212 indexymin, and indexymax. 4214 Redacted form: plsurf3dl(x, y, z, opt, clevel, indexxmin, indexymin, 4217 This function is used in example 8. 4223 plsurf3dl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax) 4227 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at 4228 which the function is evaluated. 4230 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at 4231 which the function is evaluated. 4233 z (PLFLT_MATRIX, input) : A matrix containing function values to 4234 plot. Should have dimensions of 4238 nx (PLINT, input) : Number of x values at which function is 4241 ny (PLINT, input) : Number of y values at which function is 4244 opt (PLINT, input) : Determines the way in which the surface is 4245 represented. To specify more than one option just add the options, 4246 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn 4247 connecting points at which function is defined. 4248 opt=BASE_CONT : A contour plot is drawn at the base XY plane 4252 opt=SURF_CONT : A contour plot is drawn at the surface plane 4256 opt=DRAW_SIDES : draws a curtain between the base XY plane and 4257 the borders of the plotted function. 4258 opt=MAG_COLOR : the surface is colored according to the value 4259 of Z; if MAG_COLOR is not used, then the surface is colored 4260 according to the intensity of the reflected light in the 4261 surface from a light source whose position is set using 4265 clevel (PLFLT_VECTOR, input) : A vector containing the contour 4268 nlevel (PLINT, input) : Number of elements in the clevel vector. 4270 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that 4271 corresponds to the first x index where z is defined. 4273 indexxmax (PLINT, input) : The index value (which must be ≤ nx) 4274 which corresponds (by convention) to one more than the last x 4275 index value where z is defined. 4277 indexymin (PLINT_VECTOR, input) : A vector containing the y index 4278 values which all must be ≥ 0. These values are the first y index 4279 where z is defined for a particular x index in the range from 4280 indexxmin to indexxmax - 1. The dimension of indexymin is 4283 indexymax (PLINT_VECTOR, input) : A vector containing the y index 4284 values which all must be ≤ ny. These values correspond (by 4285 convention) to one more than the last y index where z is defined 4286 for a particular x index in the range from indexxmin to indexxmax 4287 - 1. The dimension of indexymax is indexxmax. 4290 return _plplotc.plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4294 Parse command-line arguments 4298 Parse command-line arguments. 4300 plparseopts removes all recognized flags (decreasing argc 4301 accordingly), so that invalid input may be readily detected. It can 4302 also be used to process user command line flags. The user can merge 4303 an option table of type PLOptionTable into the internal option table 4304 info structure using plMergeOpts. Or, the user can specify that ONLY 4305 the external table(s) be parsed by calling plClearOpts before 4308 The default action taken by plparseopts is as follows: 4309 Returns with an error if an unrecognized option or badly formed 4310 option-value pair are encountered. 4311 Returns immediately (return code 0) when the first non-option command 4312 line argument is found. 4313 Returns with the return code of the option handler, if one was called. 4315 Deletes command line arguments from argv list as they are found, and 4316 decrements argc accordingly. 4317 Does not show "invisible" options in usage or help messages. 4318 Assumes the program name is contained in argv[0]. 4320 These behaviors may be controlled through the 4323 Redacted form: General: plparseopts(argv, mode) 4326 This function is used in all of the examples. 4332 PLINT plparseopts(p_argc, argv, mode) 4336 p_argc (int *, input/output) : Number of arguments. 4338 argv (PLCHAR_NC_MATRIX, input/output) : A vector of character 4339 strings containing *p_argc command-line arguments. 4341 mode (PLINT, input) : Parsing mode with the following 4342 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line 4343 and all error messages enabled, including program exit when an 4344 error occurs. Anything on the command line that isn't recognized 4345 as a valid option or option argument is flagged as an error. 4346 PL_PARSE_QUIET (2) -- Turns off all output except in the case 4348 PL_PARSE_NODELETE (4) -- Turns off deletion of processed 4350 PL_PARSE_SHOWALL (8) -- Show invisible options 4351 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a 4352 pointer to the program name. 4353 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required. 4354 PL_PARSE_SKIP (128) -- Set to quietly skip over any 4355 unrecognized arguments. 4358 return _plplotc.plparseopts(p_argc, mode)
4362 Set area line fill pattern 4366 Sets the area line fill pattern to be used, e.g., for calls to plfill. 4367 The pattern consists of 1 or 2 sets of parallel lines with specified 4368 inclinations and spacings. The arguments to this routine are the 4369 number of sets to use (1 or 2) followed by two vectors (with 1 or 2 4370 elements) specifying the inclinations in tenths of a degree and the 4371 spacing in micrometers. (See also plpsty) 4373 Redacted form: General: plpat(inc, del) 4376 This function is used in example 15. 4382 plpat(nlin, inc, del) 4386 nlin (PLINT, input) : Number of sets of lines making up the 4387 pattern, either 1 or 2. 4389 inc (PLINT_VECTOR, input) : A vector containing nlin values of the 4390 inclination in tenths of a degree. (Should be between -900 and 4393 del (PLINT_VECTOR, input) : A vector containing nlin values of the 4394 spacing in micrometers between the lines making up the pattern. 4397 return _plplotc.plpat(n, ArrayCk)
4401 Draw a line between two points, accounting for coordinate transforms 4409 y2) . If a global coordinate transform is defined then the line is 4410 broken in to n segments to approximate the path. If no transform is 4411 defined then this simply acts like a call to pljoin. 4413 Redacted form: plpath(n,x1,y1,x2,y2) 4415 This function is used in example 22. 4421 plpath(n, x1, y1, x2, y2) 4425 n (PLINT, input) : number of points to use to approximate the path. 4427 x1 (PLFLT, input) : x coordinate of first point. 4429 y1 (PLFLT, input) : y coordinate of first point. 4431 x2 (PLFLT, input) : x coordinate of second point. 4433 y2 (PLFLT, input) : y coordinate of second point. 4436 return _plplotc.plpath(n, x1, y1, x2, y2)
4440 Plot a glyph at the specified points 4444 Plot a glyph at the specified points. (This function is largely 4445 superseded by plstring which gives access to many[!] more glyphs.) 4446 code=-1 means try to just draw a point. Right now it's just a move 4447 and a draw at the same place. Not ideal, since a sufficiently 4448 intelligent output device may optimize it away, or there may be faster 4449 ways of doing it. This is OK for now, though, and offers a 4X speedup 4450 over drawing a Hershey font "point" (which is actually diamond shaped 4451 and therefore takes 4 strokes to draw). If 0 < code < 32, then a 4452 useful (but small subset) of Hershey symbols is plotted. If 32 <= 4453 code <= 127 the corresponding printable ASCII character is plotted. 4455 Redacted form: plpoin(x, y, code) 4457 This function is used in examples 1, 6, 14, and 29. 4463 plpoin(n, x, y, code) 4467 n (PLINT, input) : Number of points in the x and y vectors. 4469 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 4472 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 4475 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form 4476 with -1 <= code <= 127) corresponding to a glyph to be plotted at 4477 each of the n points. 4480 return _plplotc.plpoin(n, ArrayCk, code)
4484 Plot a glyph at the specified 3D points 4488 Plot a glyph at the specified 3D points. (This function is largely 4489 superseded by plstring3 which gives access to many[!] more glyphs.) 4490 Set up the call to this function similar to what is done for plline3. 4491 code=-1 means try to just draw a point. Right now it's just a move 4492 and a draw at the same place. Not ideal, since a sufficiently 4493 intelligent output device may optimize it away, or there may be faster 4494 ways of doing it. This is OK for now, though, and offers a 4X speedup 4495 over drawing a Hershey font "point" (which is actually diamond shaped 4496 and therefore takes 4 strokes to draw). If 0 < code < 32, then a 4497 useful (but small subset) of Hershey symbols is plotted. If 32 <= 4498 code <= 127 the corresponding printable ASCII character is plotted. 4500 Redacted form: plpoin3(x, y, z, code) 4502 This function is not used in any example. 4508 plpoin3(n, x, y, z, code) 4512 n (PLINT, input) : Number of points in the x and y vectors. 4514 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 4517 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 4520 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of 4523 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form 4524 with -1 <= code <= 127) corresponding to a glyph to be plotted at 4525 each of the n points. 4528 return _plplotc.plpoin3(n, arg2, arg3, code)
4532 Draw a polygon in 3 space 4536 Draws a polygon in 3 space defined by n points in x, y, and z. Setup 4537 like plline3, but differs from that function in that plpoly3 attempts 4538 to determine if the polygon is viewable depending on the order of the 4539 points within the vector and the value of ifcc. If the back of 4540 polygon is facing the viewer, then it isn't drawn. If this isn't what 4541 you want, then use plline3 instead. 4543 The points are assumed to be in a plane, and the directionality of the 4544 plane is determined from the first three points. Additional points do 4545 not have to lie on the plane defined by the first three, but if they 4546 do not, then the determination of visibility obviously can't be 100% 4547 accurate... So if you're 3 space polygons are too far from planar, 4548 consider breaking them into smaller polygons. 3 points define a plane 4551 Bugs: If one of the first two segments is of zero length, or if they 4552 are co-linear, the calculation of visibility has a 50/50 chance of 4553 being correct. Avoid such situations :-). See x18c.c for an example 4554 of this problem. (Search for 20.1). 4556 Redacted form: plpoly3(x, y, z, code) 4558 This function is used in example 18. 4564 plpoly3(n, x, y, z, draw, ifcc) 4568 n (PLINT, input) : Number of points defining line. 4570 x (PLFLT_VECTOR, input) : A vector containing 4571 n x coordinates of points. 4573 y (PLFLT_VECTOR, input) : A vector containing 4574 n y coordinates of points. 4576 z (PLFLT_VECTOR, input) : A vector containing 4577 n z coordinates of points. 4579 draw (PLBOOL_VECTOR, input) : A vector containing 4580 n-1 Boolean values which control drawing the segments of the polygon. 4581 If draw[i] is true, then the polygon segment from index [i] to 4582 [i+1] is drawn, otherwise, not. 4584 ifcc (PLBOOL, input) : If ifcc is true the directionality of the 4585 polygon is determined by assuming the points are laid out in a 4586 counter-clockwise order. Otherwise, the directionality of the 4587 polygon is determined by assuming the points are laid out in a 4591 return _plplotc.plpoly3(n, arg2, arg3, ArrayCkMinus1, flag)
4595 Set precision in numeric labels 4599 Sets the number of places after the decimal point in numeric labels. 4601 Redacted form: plprec(setp, prec) 4603 This function is used in example 29. 4613 setp (PLINT, input) : If setp is equal to 0 then PLplot 4614 automatically determines the number of places to use after the 4615 decimal point in numeric labels (like those used to label axes). 4616 If setp is 1 then prec sets the number of places. 4618 prec (PLINT, input) : The number of characters to draw after the 4619 decimal point in numeric labels. 4622 return _plplotc.plprec(setp, prec)
4626 Select area fill pattern 4631 patt is zero or less use either a hardware solid fill if the drivers 4632 have that capability (virtually all do) or fall back to a software 4633 emulation of a solid fill using the eighth area line fill pattern. If 4635 patt <= 8, then select one of eight predefined area line fill patterns 4636 to use (see plpat if you desire other patterns). 4638 Redacted form: plpsty(patt) 4640 This function is used in examples 12, 13, 15, 16, and 25. 4650 patt (PLINT, input) : The desired pattern index. If 4651 patt is zero or less, then a solid fill is (normally, see qualifiers 4653 patt in the range from 1 to 8 and assuming the driver has not supplied 4654 line fill capability itself (most deliberately do not so that line 4655 fill patterns look identical for those drivers), the patterns 4656 consist of (1) horizontal lines, (2) vertical lines, (3) lines at 4657 45 degrees, (4) lines at -45 degrees, (5) lines at 30 degrees, (6) 4658 lines at -30 degrees, (7) both vertical and horizontal lines, and 4659 (8) lines at both 45 degrees and -45 degrees. 4662 return _plplotc.plpsty(patt)
4666 Write text inside the viewport 4670 Writes text at a specified position and inclination within the 4671 viewport. Text is clipped at the viewport boundaries. The reference 4672 point of a string lies along a line passing through the string at half 4673 the height of a capital letter. The position of the reference point 4674 along this line is determined by just, the reference point is placed 4675 at world coordinates ( 4677 y) within the viewport. The inclination of the string is specified 4678 in terms of differences of world coordinates making it easy to write 4679 text parallel to a line in a graph. 4681 Redacted form: plptex(x, y, dx, dy, just, text) 4683 This function is used in example 2-4,10,12-14,20,23,24,26. 4689 plptex(x, y, dx, dy, just, text) 4693 x (PLFLT, input) : x coordinate of reference point of string. 4695 y (PLFLT, input) : y coordinate of reference point of string. 4697 dx (PLFLT, input) : Together with dy, this specifies the 4698 inclination of the string. The baseline of the string is parallel 4707 dy (PLFLT, input) : Together with dx, this specifies the 4708 inclination of the string. 4710 just (PLFLT, input) : Specifies the position of the string relative 4711 to its reference point. If just=0. , the reference point is at 4712 the left and if just=1. , it is at the right of the string. Other 4713 values of just give intermediate justifications. 4715 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be 4719 return _plplotc.plptex(x, y, dx, dy, just, text)
4721 def plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text):
4723 Write text inside the viewport of a 3D plot 4727 Writes text at a specified position and inclination and with a 4728 specified shear within the viewport. Text is clipped at the viewport 4729 boundaries. The reference point of a string lies along a line passing 4730 through the string at half the height of a capital letter. The 4731 position of the reference point along this line is determined by just, 4732 and the reference point is placed at world coordinates ( 4735 wz) within the viewport. The inclination and shear of the string is 4736 specified in terms of differences of world coordinates making it easy 4737 to write text parallel to a line in a graph. 4739 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text) 4741 This function is used in example 28. 4747 plptex3(wx, wy, wz, dx, dy, dz, sx, sy, sz, just, text) 4751 wx (PLFLT, input) : x world coordinate of reference point of 4754 wy (PLFLT, input) : y world coordinate of reference point of 4757 wz (PLFLT, input) : z world coordinate of reference point of 4760 dx (PLFLT, input) : Together with dy and 4761 dz , this specifies the inclination of the string. The baseline of 4762 the string is parallel to a line joining ( 4773 dy (PLFLT, input) : Together with dx and 4774 dz, this specifies the inclination of the string. 4776 dz (PLFLT, input) : Together with dx and 4777 dy, this specifies the inclination of the string. 4779 sx (PLFLT, input) : Together with sy and 4780 sz , this specifies the shear of the string. The string is sheared so 4781 that the characters are vertically parallel to a line joining ( 4792 sz = 0.) then the text is not sheared. 4794 sy (PLFLT, input) : Together with sx and 4795 sz, this specifies shear of the string. 4797 sz (PLFLT, input) : Together with sx and 4798 sy, this specifies shear of the string. 4800 just (PLFLT, input) : Specifies the position of the string relative 4801 to its reference point. If just=0. , the reference point is at 4802 the left and if just=1. , it is at the right of the string. Other 4803 values of just give intermediate justifications. 4805 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be 4809 return _plplotc.plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4813 Random number generator returning a real random number in the range [0,1] 4817 Random number generator returning a real random number in the range 4818 [0,1]. The generator is based on the Mersenne Twister. Most languages 4819 / compilers provide their own random number generator, and so this is 4820 provided purely for convenience and to give a consistent random number 4821 generator across all languages supported by PLplot. This is 4822 particularly useful for comparing results from the test suite of 4825 Redacted form: plrandd() 4827 This function is used in examples 17 and 21. 4836 return _plplotc.plrandd()
4840 Replays contents of plot buffer to current device/file 4844 Replays contents of plot buffer to current device/file. 4846 Redacted form: plreplot() 4848 This function is used in example 1,20. 4857 return _plplotc.plreplot()
4861 Convert RGB color to HLS 4865 Convert RGB color coordinates to HLS 4867 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s) 4870 This function is used in example 2. 4876 plrgbhls(r, g, b, p_h, p_l, p_s) 4880 r (PLFLT, input) : Red intensity (0.0-1.0) of the color. 4882 g (PLFLT, input) : Green intensity (0.0-1.0) of the color. 4884 b (PLFLT, input) : Blue intensity (0.0-1.0) of the color. 4886 p_h (PLFLT_NC_SCALAR, output) : Returned value of the hue in 4887 degrees (0.0-360.0) on the color cylinder. 4889 p_l (PLFLT_NC_SCALAR, output) : Returned value of the lightness 4890 expressed as a fraction (0.0-1.0) of the axis of the color 4893 p_s (PLFLT_NC_SCALAR, output) : Returned value of the saturation 4894 expressed as a fraction (0.0-1.0) of the radius of the color 4898 return _plplotc.plrgbhls(r, g, b)
4906 This sets up the size of all subsequent characters drawn. The actual 4907 height of a character is the product of the default character size and 4910 Redacted form: plschr(def, scale) 4912 This function is used in examples 2, 13, 23, and 24. 4922 def (PLFLT, input) : The default height of a character in 4923 millimeters, should be set to zero if the default height is to 4924 remain unchanged. For rasterized drivers the dx and dy values 4925 specified in plspage are used to convert from mm to pixels (note 4926 the different unit systems used). This dpi aware scaling is not 4927 implemented for all drivers yet. 4929 scale (PLFLT, input) : Scale factor to be applied to default to get 4930 actual character height. 4933 return _plplotc.plschr(arg1, scale)
4937 Set cmap0 colors by 8-bit RGB values 4941 Set cmap0 colors using 8-bit RGB values (see the PLplot 4942 documentation). This sets the entire color map -- only as many colors 4943 as specified will be allocated. 4945 Redacted form: plscmap0(r, g, b) 4947 This function is used in examples 2 and 24. 4953 plscmap0(r, g, b, ncol0) 4957 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 4958 integers (0-255) representing the degree of red in the color. 4960 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 4961 integers (0-255) representing the degree of green in the color. 4963 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 4964 integers (0-255) representing the degree of blue in the color. 4966 ncol0 (PLINT, input) : Number of items in the r, g, and b vectors. 4969 return _plplotc.plscmap0(Array, arg2, arg3)
4973 Set cmap0 colors by 8-bit RGB values and PLFLT alpha transparency value 4977 Set cmap0 colors using 8-bit RGB values (see the PLplot documentation) 4978 and PLFLT alpha transparency value. This sets the entire color map -- 4979 only as many colors as specified will be allocated. 4981 Redacted form: plscmap0a(r, g, b, alpha) 4983 This function is used in examples 30. 4989 plscmap0a(r, g, b, alpha, ncol0) 4993 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 4994 integers (0-255) representing the degree of red in the color. 4996 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 4997 integers (0-255) representing the degree of green in the color. 4999 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit 5000 integers (0-255) representing the degree of blue in the color. 5002 alpha (PLFLT_VECTOR, input) : A vector containing values (0.0-1.0) 5003 representing the alpha transparency of the color. 5005 ncol0 (PLINT, input) : Number of items in the r, g, b, and alpha 5009 return _plplotc.plscmap0a(Array, arg2, arg3, arg4)
5013 Set number of colors in cmap0 5017 Set number of colors in cmap0 (see the PLplot documentation). Allocate 5018 (or reallocate) cmap0, and fill with default values for those colors 5019 not previously allocated. The first 16 default colors are given in 5020 the plcol0 documentation. For larger indices the default color is 5023 The drivers are not guaranteed to support more than 16 colors. 5025 Redacted form: plscmap0n(ncol0) 5027 This function is used in examples 15, 16, and 24. 5037 ncol0 (PLINT, input) : Number of colors that will be allocated in 5038 the cmap0 palette. If this number is zero or less, then the value 5039 from the previous call to plscmap0n is used and if there is no 5040 previous call, then a default value is used. 5043 return _plplotc.plscmap0n(ncol0)
5047 Set opaque RGB cmap1 colors values 5051 Set opaque cmap1 colors (see the PLplot documentation) using RGB 5052 vector values. This function also sets the number of cmap1 colors. 5053 N.B. Continuous cmap1 colors are indexed with a floating-point index 5054 in the range from 0.0-1.0 which is linearly transformed (e.g., by 5055 plcol1) to an integer index of these RGB vectors in the range from 0 5057 ncol1-1. So in order for this continuous color model to work 5058 properly, it is the responsibility of the user of plscmap1 to insure 5059 that these RGB vectors are continuous functions of their integer 5062 Redacted form: plscmap1(r, g, b) 5064 This function is used in example 31. 5070 plscmap1(r, g, b, ncol1) 5074 r (PLINT_VECTOR, input) : A vector that represents (using unsigned 5075 8-bit integers in the range from 0-255) the degree of red in the 5076 color as a continuous function of the integer index of the vector. 5078 g (PLINT_VECTOR, input) : A vector that represents (using unsigned 5079 8-bit integers in the range from 0-255) the degree of green in the 5080 color as a continuous function of the integer index of the vector. 5082 b (PLINT_VECTOR, input) : A vector that represents (using unsigned 5083 8-bit integers in the range from 0-255) the degree of blue in the 5084 color as a continuous function of the integer index of the vector. 5086 ncol1 (PLINT, input) : Number of items in the r, g, and b vectors. 5089 return _plplotc.plscmap1(Array, arg2, arg3)
5093 Set semitransparent cmap1 RGBA colors. 5097 Set semitransparent cmap1 colors (see the PLplot documentation) using 5098 RGBA vector values. This function also sets the number of cmap1 5099 colors. N.B. Continuous cmap1 colors are indexed with a 5100 floating-point index in the range from 0.0-1.0 which is linearly 5101 transformed (e.g., by plcol1) to an integer index of these RGBA 5102 vectors in the range from 0 to 5103 ncol1-1. So in order for this continuous color model to work 5104 properly, it is the responsibility of the user of plscmap1 to insure 5105 that these RGBA vectors are continuous functions of their integer 5108 Redacted form: plscmap1a(r, g, b, alpha) 5110 This function is used in example 31. 5116 plscmap1a(r, g, b, alpha, ncol1) 5120 r (PLINT_VECTOR, input) : A vector that represents (using unsigned 5121 8-bit integers in the range from 0-255) the degree of red in the 5122 color as a continuous function of the integer index of the vector. 5124 g (PLINT_VECTOR, input) : A vector that represents (using unsigned 5125 8-bit integers in the range from 0-255) the degree of green in the 5126 color as a continuous function of the integer index of the vector. 5128 b (PLINT_VECTOR, input) : A vector that represents (using unsigned 5129 8-bit integers in the range from 0-255) the degree of blue in the 5130 color as a continuous function of the integer index of the vector. 5132 alpha (PLFLT_VECTOR, input) : A vector that represents (using PLFLT 5133 values in the range from 0.0-1.0 where 0.0 corresponds to 5134 completely transparent and 1.0 corresponds to completely opaque) 5135 the alpha transparency of the color as a continuous function of 5136 the integer index of the vector. 5138 ncol1 (PLINT, input) : Number of items in the r, g, b, and alpha 5142 return _plplotc.plscmap1a(Array, arg2, arg3, arg4)
5144 def plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null):
5146 Set cmap1 colors using a piece-wise linear relationship 5150 Set cmap1 colors using a piece-wise linear relationship between the 5151 cmap1 intensity index (0.0-1.0) and position in HLS or RGB color space 5152 (see the PLplot documentation). May be called at any time. 5154 The idea here is to specify a number of control points that define the 5155 mapping between input cmap1 intensity indices and HLS or RGB. Between 5156 these points, linear interpolation is used which gives a smooth 5157 variation of color with intensity index. Any number of control points 5158 may be specified, located at arbitrary positions, although typically 2 5159 - 4 are enough. Another way of stating this is that we are traversing 5160 a given number of lines through HLS or RGB space as we move through 5161 cmap1 intensity indices. The control points at the minimum and 5162 maximum position (0 and 1) must always be specified. By adding more 5163 control points you can get more variation. One good technique for 5164 plotting functions that vary about some expected average is to use an 5165 additional 2 control points in the center (position ~= 0.5) that are 5166 the same lightness as the background (typically white for paper 5167 output, black for crt), and same hue as the boundary control points. 5168 This allows the highs and lows to be very easily distinguished. 5170 Each control point must specify the cmap1 intensity index and the 5171 associated three coordinates in HLS or RGB space. The first point 5172 must correspond to position = 0, and the last to position = 1. 5174 If RGB colors are provided then the interpolation takes place in RGB 5175 space and is trivial. However if HLS colors are provided then, because 5176 of the circular nature of the color wheel for the hue coordinate, the 5177 interpolation could be performed in either direction around the color 5178 wheel. The default behaviour is for the hue to be linearly 5179 interpolated ignoring this circular property of hue. So for example, 5180 the hues 0 (red) and 240 (blue) will get interpolated via yellow, 5181 green and cyan. If instead you wish to interpolate the other way 5182 around the color wheel you have two options. You may provide hues 5183 outside the range [0, 360), so by using a hue of -120 for blue or 360 5184 for red the interpolation will proceed via magenta. Alternatively you 5185 can utilise the alt_hue_path variable to reverse the direction of 5186 interpolation if you need to provide hues within the [0-360) range. 5188 Examples of interpolation Huealt_hue_pathcolor scheme[120 5189 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120 5190 -120]falsegreen-yellow-red-magenta-blue[240 5191 480]falseblue-magenta-red-yellow-green[120 5192 240]truegreen-yellow-red-magenta-blue[240 5193 120]trueblue-magenta-red-yellow-green 5195 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0, 5196 1]magnitudeHLShue[0, 360]degreesHLSlightness[0, 5197 1]magnitudeHLSsaturation[0, 1]magnitude 5199 Redacted form: plscmap1l(itype, intensity, coord1, coord2, coord3, 5202 This function is used in examples 8, 11, 12, 15, 20, and 21. 5208 plscmap1l(itype, npts, intensity, coord1, coord2, coord3, alt_hue_path) 5212 itype (PLBOOL, input) : true: RGB, false: HLS. 5214 npts (PLINT, input) : number of control points 5216 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1 5217 intensity index (0.0-1.0) in ascending order for each control 5220 coord1 (PLFLT_VECTOR, input) : A vector containing the first 5221 coordinate (H or R) for each control point. 5223 coord2 (PLFLT_VECTOR, input) : A vector containing the second 5224 coordinate (L or G) for each control point. 5226 coord3 (PLFLT_VECTOR, input) : A vector containing the third 5227 coordinate (S or B) for each control point. 5229 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with 5230 npts - 1 elements), each containing either true to use the reversed 5231 HLS interpolation or false to use the regular HLS interpolation. 5232 (alt_hue_path[i] refers to the interpolation interval between the 5233 i and i + 1 control points). This parameter is not used for RGB 5238 return _plplotc.plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null)
5240 def plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null):
5242 Set cmap1 colors and alpha transparency using a piece-wise linear relationship 5246 This is a variant of plscmap1l that supports alpha channel 5247 transparency. It sets cmap1 colors using a piece-wise linear 5248 relationship between cmap1 intensity index (0.0-1.0) and position in 5249 HLS or RGB color space (see the PLplot documentation) with alpha 5250 transparency value (0.0-1.0). It may be called at any time. 5252 Redacted form: plscmap1la(itype, intensity, coord1, coord2, coord3, 5253 alpha, alt_hue_path) 5255 This function is used in example 30. 5261 plscmap1la(itype, npts, intensity, coord1, coord2, coord3, alpha, alt_hue_path) 5265 itype (PLBOOL, input) : true: RGB, false: HLS. 5267 npts (PLINT, input) : number of control points. 5269 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1 5270 intensity index (0.0-1.0) in ascending order for each control 5273 coord1 (PLFLT_VECTOR, input) : A vector containing the first 5274 coordinate (H or R) for each control point. 5276 coord2 (PLFLT_VECTOR, input) : A vector containing the second 5277 coordinate (L or G) for each control point. 5279 coord3 (PLFLT_VECTOR, input) : A vector containing the third 5280 coordinate (S or B) for each control point. 5282 alpha (PLFLT_VECTOR, input) : A vector containing the alpha 5283 transparency value (0.0-1.0) for each control point. 5285 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with 5286 npts - 1 elements) containing the alternative interpolation method 5287 Boolean value for each control point interval. (alt_hue_path[i] 5288 refers to the interpolation interval between the i and i + 1 5292 return _plplotc.plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null)
5296 Set number of colors in cmap1 5300 Set number of colors in cmap1, (re-)allocate cmap1, and set default 5301 values if this is the first allocation (see the PLplot documentation). 5303 Redacted form: plscmap1n(ncol1) 5305 This function is used in examples 8, 11, 20, and 21. 5315 ncol1 (PLINT, input) : Number of colors that will be allocated in 5316 the cmap1 palette. If this number is zero or less, then the value 5317 from the previous call to plscmap1n is used and if there is no 5318 previous call, then a default value is used. 5321 return _plplotc.plscmap1n(ncol1)
5325 Set the cmap1 argument range for continuous color plots 5329 Set the cmap1 argument range for continuous color plots that 5330 corresponds to the range of data values. The maximum range 5331 corresponding to the entire cmap1 palette is 0.0-1.0, and the smaller 5332 the cmap1 argument range that is specified with this routine, the 5333 smaller the subset of the cmap1 color palette that is used to 5334 represent the continuous data being plotted. If 5335 min_color is greater than 5337 max_color is greater than 1.0 or 5338 min_color is less than 0.0 then no change is made to the cmap1 5339 argument range. (Use plgcmap1_range to get the cmap1 argument range.) 5341 Redacted form: plscmap1_range(min_color, max_color) 5343 This function is currently used in example 33. 5349 plscmap1_range(min_color, max_color) 5353 min_color (PLFLT, input) : The minimum cmap1 argument. If less 5354 than 0.0, then 0.0 is used instead. 5356 max_color (PLFLT, input) : The maximum cmap1 argument. If greater 5357 than 1.0, then 1.0 is used instead. 5360 return _plplotc.plscmap1_range(min_color, max_color)
5364 Get the cmap1 argument range for continuous color plots 5368 Get the cmap1 argument range for continuous color plots. (Use 5369 plscmap1_range to set the cmap1 argument range.) 5371 Redacted form: plgcmap1_range(min_color, max_color) 5373 This function is currently not used in any example. 5379 plgcmap1_range(min_color, max_color) 5383 min_color (PLFLT_NC_SCALAR, output) : Returned value of the current 5384 minimum cmap1 argument. 5386 max_color (PLFLT_NC_SCALAR, output) : Returned value of the current 5387 maximum cmap1 argument. 5390 return _plplotc.plgcmap1_range()
5394 Set 8-bit RGB values for given cmap0 color index 5398 Set 8-bit RGB values for given cmap0 (see the PLplot documentation) 5399 index. Overwrites the previous color value for the given index and, 5400 thus, does not result in any additional allocation of space for 5403 Redacted form: plscol0(icol0, r, g, b) 5405 This function is used in any example 31. 5411 plscol0(icol0, r, g, b) 5415 icol0 (PLINT, input) : Color index. Must be less than the maximum 5416 number of colors (which is set by default, by plscmap0n, or even 5419 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5420 degree of red in the color. 5422 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5423 degree of green in the color. 5425 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5426 degree of blue in the color. 5429 return _plplotc.plscol0(icol0, r, g, b)
5433 Set 8-bit RGB values and PLFLT alpha transparency value for given cmap0 color index 5437 Set 8-bit RGB value and PLFLT alpha transparency value for given cmap0 5438 (see the PLplot documentation) index. Overwrites the previous color 5439 value for the given index and, thus, does not result in any additional 5440 allocation of space for colors. 5442 This function is used in example 30. 5448 plscol0a(icol0, r, g, b, alpha) 5452 icol0 (PLINT, input) : Color index. Must be less than the maximum 5453 number of colors (which is set by default, by plscmap0n, or even 5456 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5457 degree of red in the color. 5459 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5460 degree of green in the color. 5462 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5463 degree of blue in the color. 5465 alpha (PLFLT, input) : Value of the alpha transparency in the range 5469 return _plplotc.plscol0a(icol0, r, g, b, a)
5473 Set the background color by 8-bit RGB value 5477 Set the background color (color 0 in cmap0) by 8-bit RGB value (see 5478 the PLplot documentation). 5480 Redacted form: plscolbg(r, g, b) 5482 This function is used in examples 15 and 31. 5492 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5493 degree of red in the color. 5495 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5496 degree of green in the color. 5498 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5499 degree of blue in the color. 5502 return _plplotc.plscolbg(r, g, b)
5506 Set the background color by 8-bit RGB value and PLFLT alpha transparency value. 5510 Set the background color (color 0 in cmap0) by 8-bit RGB value and 5511 PLFLT alpha transparency value (see the PLplot documentation). 5513 This function is used in example 31. 5519 plscolbga(r, g, b, alpha) 5523 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5524 degree of red in the color. 5526 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5527 degree of green in the color. 5529 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the 5530 degree of blue in the color. 5532 alpha (PLFLT, input) : Value of the alpha transparency in the range 5536 return _plplotc.plscolbga(r, g, b, a)
5540 Used to globally turn color output on/off 5544 Used to globally turn color output on/off for those drivers/devices 5547 Redacted form: plscolor(color) 5549 This function is used in example 31. 5559 color (PLINT, input) : Color flag (Boolean). If zero, color is 5560 turned off. If non-zero, color is turned on. 5563 return _plplotc.plscolor(color)
5567 Set device-compression level 5571 Set device-compression level. Only used for drivers that provide 5572 compression. This function, if used, should be invoked before a call 5575 Redacted form: plscompression(compression) 5577 This function is used in example 31. 5583 plscompression(compression) 5587 compression (PLINT, input) : The desired compression level. This is 5588 a device-dependent value. Currently only the jpeg and png devices 5589 use these values. For jpeg value is the jpeg quality which should 5590 normally be in the range 0-95. Higher values denote higher quality 5591 and hence larger image sizes. For png values are in the range -1 5592 to 99. Values of 0-9 are taken as the compression level for zlib. 5593 A value of -1 denotes the default zlib compression level. Values 5594 in the range 10-99 are divided by 10 and then used as the zlib 5595 compression level. Higher compression levels correspond to greater 5596 compression and small file sizes at the expense of more 5600 return _plplotc.plscompression(compression)
5604 Set the device (keyword) name 5608 Set the device (keyword) name. 5610 Redacted form: plsdev(devname) 5612 This function is used in examples 1, 14, and 20. 5622 devname (PLCHAR_VECTOR, input) : An ascii character string 5623 containing the device name keyword of the required output device. 5625 devname is NULL or if the first character of the string is a ``?'', 5626 the normal (prompted) start up is used. 5629 return _plplotc.plsdev(devname)
5633 Set parameters that define current device-space window 5637 Set relative margin width, aspect ratio, and relative justification 5638 that define current device-space window. If you want to just use the 5639 previous value for any of these, just pass in the magic value 5640 PL_NOTSET. It is unlikely that one should ever need to change the 5641 aspect ratio but it's in there for completeness. If plsdidev is not 5642 called the default values of mar, jx, and jy are all 0. aspect is set 5643 to a device-specific value. 5645 Redacted form: plsdidev(mar, aspect, jx, jy) 5647 This function is used in example 31. 5653 plsdidev(mar, aspect, jx, jy) 5657 mar (PLFLT, input) : Relative margin width. 5659 aspect (PLFLT, input) : Aspect ratio. 5661 jx (PLFLT, input) : Relative justification in x. Value must lie in 5662 the range -0.5 to 0.5. 5664 jy (PLFLT, input) : Relative justification in y. Value must lie in 5665 the range -0.5 to 0.5. 5668 return _plplotc.plsdidev(mar, aspect, jx, jy)
5670 def plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm):
5672 Set up transformation from metafile coordinates 5676 Set up transformation from metafile coordinates. The size of the plot 5677 is scaled so as to preserve aspect ratio. This isn't intended to be a 5678 general-purpose facility just yet (not sure why the user would need 5681 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, 5684 This function is not used in any examples. 5690 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm) 5694 dimxmin (PLINT, input) : NEEDS DOCUMENTATION 5696 dimxmax (PLINT, input) : NEEDS DOCUMENTATION 5698 dimymin (PLINT, input) : NEEDS DOCUMENTATION 5700 dimymax (PLINT, input) : NEEDS DOCUMENTATION 5702 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION 5704 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION 5707 return _plplotc.plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5711 Set plot orientation 5715 Set plot orientation parameter which is multiplied by 90 degrees to 5716 obtain the angle of rotation. Note, arbitrary rotation parameters 5717 such as 0.2 (corresponding to 18 degrees) are possible, but the usual 5718 values for the rotation parameter are 0., 1., 2., and 3. corresponding 5719 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees 5720 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is 5721 not called the default value of rot is 0. 5723 N.B. aspect ratio is unaffected by calls to plsdiori. So you will 5724 probably want to change the aspect ratio to a value suitable for the 5725 plot orientation using a call to plsdidev or the command-line options 5726 -a or -freeaspect. For more documentation of those options see the 5727 PLplot documentation. Such command-line options can be set internally 5728 using plsetopt or set directly using the command line and parsed using 5729 a call to plparseopts. 5731 Redacted form: plsdiori(rot) 5733 This function is not used in any examples. 5743 rot (PLFLT, input) : Plot orientation parameter. 5746 return _plplotc.plsdiori(rot)
5750 Set parameters that define current plot-space window 5754 Set relative minima and maxima that define the current plot-space 5755 window. If plsdiplt is not called the default values of xmin, ymin, 5756 xmax, and ymax are 0., 0., 1., and 1. 5758 Redacted form: plsdiplt(xmin, ymin, xmax, ymax) 5760 This function is used in example 31. 5766 plsdiplt(xmin, ymin, xmax, ymax) 5770 xmin (PLFLT, input) : Relative minimum in x. 5772 ymin (PLFLT, input) : Relative minimum in y. 5774 xmax (PLFLT, input) : Relative maximum in x. 5776 ymax (PLFLT, input) : Relative maximum in y. 5779 return _plplotc.plsdiplt(xmin, ymin, xmax, ymax)
5783 Set parameters incrementally (zoom mode) that define current plot-space window 5787 Set relative minima and maxima incrementally (zoom mode) that define 5788 the current plot-space window. This function has the same effect as 5789 plsdiplt if that function has not been previously called. Otherwise, 5790 this function implements zoom mode using the transformation min_used = 5791 old_min + old_length*min and max_used = old_min + old_length*max for 5792 each axis. For example, if min = 0.05 and max = 0.95 for each axis, 5793 repeated calls to plsdiplz will zoom in by 10 per cent for each call. 5795 Redacted form: plsdiplz(xmin, ymin, xmax, ymax) 5797 This function is used in example 31. 5803 plsdiplz(xmin, ymin, xmax, ymax) 5807 xmin (PLFLT, input) : Relative (incremental) minimum in x. 5809 ymin (PLFLT, input) : Relative (incremental) minimum in y. 5811 xmax (PLFLT, input) : Relative (incremental) maximum in x. 5813 ymax (PLFLT, input) : Relative (incremental) maximum in y. 5816 return _plplotc.plsdiplz(xmin, ymin, xmax, ymax)
5820 Set seed for internal random number generator. 5824 Set the seed for the internal random number generator. See plrandd for 5827 Redacted form: plseed(seed) 5829 This function is used in example 21. 5839 seed (unsigned int, input) : Seed for random number generator. 5842 return _plplotc.plseed(s)
5846 Set the escape character for text strings 5850 Set the escape character for text strings. From C (in contrast to 5851 Fortran, see plsescfortran) you pass esc as a character. Only selected 5852 characters are allowed to prevent the user from shooting himself in 5853 the foot (For example, a \ isn't allowed since it conflicts with C's 5854 use of backslash as a character escape). Here are the allowed escape 5855 characters and their corresponding decimal ASCII values: !, ASCII 33 5866 Redacted form: General: plsesc(esc) 5869 This function is used in example 29. 5879 esc (char, input) : Escape character. 5882 return _plplotc.plsesc(esc)
5886 Set any command-line option 5890 Set any command-line option internally from a program before it 5891 invokes plinit. opt is the name of the command-line option and optarg 5892 is the corresponding command-line option argument. 5894 This function returns 0 on success. 5896 Redacted form: plsetopt(opt, optarg) 5898 This function is used in example 14. 5904 PLINT plsetopt(opt, optarg) 5908 opt (PLCHAR_VECTOR, input) : An ascii character string containing 5909 the command-line option. 5911 optarg (PLCHAR_VECTOR, input) : An ascii character string 5912 containing the argument of the command-line option. 5915 return _plplotc.plsetopt(opt, optarg)
5919 Set family file parameters 5923 Sets variables dealing with output file familying. Does nothing if 5924 familying not supported by the driver. This routine, if used, must be 5925 called before initializing PLplot. See the PLplot documentation for 5928 Redacted form: plsfam(fam, num, bmax) 5930 This function is used in examples 14 and 31. 5936 plsfam(fam, num, bmax) 5940 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying 5943 num (PLINT, input) : Current family file number. 5945 bmax (PLINT, input) : Maximum file size (in bytes) for a family 5949 return _plplotc.plsfam(fam, num, bmax)
5953 Set FCI (font characterization integer) 5957 Sets font characteristics to be used at the start of the next string 5958 using the FCI approach. See the PLplot documentation for more 5959 information. Note, plsfont (which calls plsfci internally) provides a 5960 more user-friendly API for setting the font characterisitics. 5962 Redacted form: General: plsfci(fci) 5965 This function is used in example 23. 5975 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value 5979 return _plplotc.plsfci(fci)
5983 Set output file name 5987 Sets the current output file name, if applicable. If the file name 5988 has not been specified and is required by the driver, the user will be 5989 prompted for it. If using the X-windows output driver, this sets the 5990 display name. This routine, if used, must be called before 5991 initializing PLplot. 5993 Redacted form: plsfnam(fnam) 5995 This function is used in examples 1 and 20. 6005 fnam (PLCHAR_VECTOR, input) : An ascii character string containing 6009 return _plplotc.plsfnam(fnam)
6013 Set family, style and weight of the current font 6017 Sets the current font. See the PLplot documentation for more 6018 information on font selection. 6020 Redacted form: plsfont(family, style, weight) 6022 This function is used in example 23. 6028 plsfont(family, style, weight) 6032 family (PLINT, input) : Font family to select for the current font. 6033 The available values are given by the PL_FCI_* constants in 6034 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF, 6035 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value 6036 signifies that the font family should not be altered. 6038 style (PLINT, input) : Font style to select for the current font. 6039 The available values are given by the PL_FCI_* constants in 6040 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and 6041 PL_FCI_OBLIQUE. A negative value signifies that the font style 6042 should not be altered. 6044 weight (PLINT, input) : Font weight to select for the current font. 6045 The available values are given by the PL_FCI_* constants in 6046 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A 6047 negative value signifies that the font weight should not be 6051 return _plplotc.plsfont(family, style, weight)
6055 Shade regions on the basis of value 6059 Shade regions on the basis of value. This is the high-level routine 6060 for making continuous color shaded plots with cmap1 while plshade 6061 should be used to plot individual shaded regions using either cmap0 or 6062 cmap1. examples/;<language>/x16* shows how to use plshades for each of 6063 our supported languages. 6065 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax, 6066 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, 6070 This function is used in examples 16, 21, and 22. 6076 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data) 6080 a (PLFLT_MATRIX, input) : A matrix containing function values to 6081 plot. Should have dimensions of 6085 nx (PLINT, input) : First dimension of matrix "a". 6087 ny (PLINT, input) : Second dimension of matrix "a". 6089 defined (PLDEFINED_callback, input) : Callback function specifying 6090 the region that should be plotted in the shade plot. This 6091 function accepts x and y coordinates as input arguments and must 6092 return 1 if the point is to be included in the shade plot and 0 6093 otherwise. If you want to plot the entire shade plot (the usual 6094 case), this argument should be set to NULL. 6096 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of 6097 pltr below for how these arguments are used (only for the special case 6098 when the callback function 6099 pltr is not supplied). 6101 clevel (PLFLT_VECTOR, input) : A vector containing the data levels 6102 corresponding to the edges of each shaded region that will be 6103 plotted by this function. To work properly the levels should be 6106 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number 6107 of shade edge values in clevel). 6109 fill_width (PLFLT, input) : Defines the line width used by the fill 6112 cont_color (PLINT, input) : Defines cmap0 pen color used for 6113 contours defining edges of shaded regions. The pen color is only 6114 temporary set for the contour drawing. Set this value to zero or 6115 less if no shade edge contours are wanted. 6117 cont_width (PLFLT, input) : Defines line width used for contours 6118 defining edges of shaded regions. This value may not be honored 6119 by all drivers. The pen width is only temporary set for the 6120 contour drawing. Set this value to zero or less if no shade edge 6121 contours are wanted. 6123 fill (PLFILL_callback, input) : Callback routine used to fill the 6124 region. Use plfill for this purpose. 6126 rectangular (PLBOOL, input) : Set rectangular to true if rectangles 6127 map to rectangles after coordinate transformation with pltrl. 6128 Otherwise, set rectangular to false. If rectangular is set to 6129 true, plshade tries to save time by filling large rectangles. 6130 This optimization fails if the coordinate transformation distorts 6131 the shape of rectangles. For example a plot in polar coordinates 6132 has to have rectangular set to false. 6134 pltr (PLTRANSFORM_callback, input) : A callback function that 6135 defines the transformation between the zero-based indices of the 6136 matrix a and world coordinates. If 6137 pltr is not supplied (e.g., is set to NULL in the C case), then the x 6138 indices of a are mapped to the range 6140 xmax and the y indices of a are mapped to the range 6142 ymax.For the C case, transformation functions are provided in the 6143 PLplot library: pltr0 for the identity mapping, and pltr1 and 6144 pltr2 for arbitrary mappings respectively defined by vectors and 6145 matrices. In addition, C callback routines for the transformation 6146 can be supplied by the user such as the mypltr function in 6147 examples/c/x09c.c which provides a general linear transformation 6148 between index coordinates and world coordinates.For languages 6149 other than C you should consult the PLplot documentation for the 6150 details concerning how PLTRANSFORM_callback arguments are 6151 interfaced. However, in general, a particular pattern of 6152 callback-associated arguments such as a tr vector with 6 elements; 6153 xg and yg vectors; or xg and yg matrices are respectively 6154 interfaced to a linear-transformation routine similar to the above 6155 mypltr function; pltr1; and pltr2. Furthermore, some of our more 6156 sophisticated bindings (see, e.g., the PLplot documentation) 6157 support native language callbacks for handling index to 6158 world-coordinate transformations. Examples of these various 6159 approaches are given in examples/<language>x09*, 6160 examples/<language>x16*, examples/<language>x20*, 6161 examples/<language>x21*, and examples/<language>x22*, for all our 6162 supported languages. 6164 pltr_data (PLPointer, input) : Extra parameter to help pass 6165 information to pltr0, pltr1, pltr2, or whatever routine that is 6166 externally supplied. 6169 return _plplotc.plshades(*args)
6173 Shade individual region on the basis of value 6177 Shade individual region on the basis of value. Use plshades if you 6178 want to shade a number of contiguous regions using continuous colors. 6179 In particular the edge contours are treated properly in plshades. If 6180 you attempt to do contiguous regions with plshade the contours at the 6181 edge of the shade are partially obliterated by subsequent plots of 6182 contiguous shaded regions. 6184 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax, 6185 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color, 6186 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data) 6189 This function is used in example 15. 6195 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) 6199 a (PLFLT_MATRIX, input) : A matrix containing function values to 6200 plot. Should have dimensions of 6204 nx (PLINT, input) : First dimension of the matrix "a". 6206 ny (PLINT, input) : Second dimension of the matrix "a". 6208 defined (PLDEFINED_callback, input) : Callback function specifying 6209 the region that should be plotted in the shade plot. This 6210 function accepts x and y coordinates as input arguments and must 6211 return 1 if the point is to be included in the shade plot and 0 6212 otherwise. If you want to plot the entire shade plot (the usual 6213 case), this argument should be set to NULL. 6215 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of 6216 pltr below for how these arguments are used (only for the special case 6217 when the callback function 6218 pltr is not supplied). 6220 shade_min (PLFLT, input) : Defines the lower end of the interval to 6221 be shaded. If shade_max <= shade_min, plshade does nothing. 6223 shade_max (PLFLT, input) : Defines the upper end of the interval to 6224 be shaded. If shade_max <= shade_min, plshade does nothing. 6226 sh_cmap (PLINT, input) : Defines color map. If sh_cmap=0, then 6227 sh_color is interpreted as a cmap0 (integer) index. If sh_cmap=1, 6228 then sh_color is interpreted as a cmap1 argument in the range 6231 sh_color (PLFLT, input) : Defines color map index with integer 6232 value if cmap0 or value in range (0.0-1.0) if cmap1. 6234 sh_width (PLFLT, input) : Defines width used by the fill pattern. 6236 min_color (PLINT, input) : Defines pen color, width used by the 6237 boundary of shaded region. The min values are used for the 6238 shade_min boundary, and the max values are used on the shade_max 6239 boundary. Set color and width to zero for no plotted boundaries. 6241 min_width (PLFLT, input) : Defines pen color, width used by the 6242 boundary of shaded region. The min values are used for the 6243 shade_min boundary, and the max values are used on the shade_max 6244 boundary. Set color and width to zero for no plotted boundaries. 6246 max_color (PLINT, input) : Defines pen color, width used by the 6247 boundary of shaded region. The min values are used for the 6248 shade_min boundary, and the max values are used on the shade_max 6249 boundary. Set color and width to zero for no plotted boundaries. 6251 max_width (PLFLT, input) : Defines pen color, width used by the 6252 boundary of shaded region. The min values are used for the 6253 shade_min boundary, and the max values are used on the shade_max 6254 boundary. Set color and width to zero for no plotted boundaries. 6256 fill (PLFILL_callback, input) : Routine used to fill the region. 6257 Use plfill. Future version of PLplot may have other fill 6260 rectangular (PLBOOL, input) : Set rectangular to true if rectangles 6261 map to rectangles after coordinate transformation with pltrl. 6262 Otherwise, set rectangular to false. If rectangular is set to 6263 true, plshade tries to save time by filling large rectangles. 6264 This optimization fails if the coordinate transformation distorts 6265 the shape of rectangles. For example a plot in polar coordinates 6266 has to have rectangular set to false. 6268 pltr (PLTRANSFORM_callback, input) : A callback function that 6269 defines the transformation between the zero-based indices of the 6270 matrix a and world coordinates. If 6271 pltr is not supplied (e.g., is set to NULL in the C case), then the x 6272 indices of a are mapped to the range 6274 xmax and the y indices of a are mapped to the range 6276 ymax.For the C case, transformation functions are provided in the 6277 PLplot library: pltr0 for the identity mapping, and pltr1 and 6278 pltr2 for arbitrary mappings respectively defined by vectors and 6279 matrices. In addition, C callback routines for the transformation 6280 can be supplied by the user such as the mypltr function in 6281 examples/c/x09c.c which provides a general linear transformation 6282 between index coordinates and world coordinates.For languages 6283 other than C you should consult the PLplot documentation for the 6284 details concerning how PLTRANSFORM_callback arguments are 6285 interfaced. However, in general, a particular pattern of 6286 callback-associated arguments such as a tr vector with 6 elements; 6287 xg and yg vectors; or xg and yg matrices are respectively 6288 interfaced to a linear-transformation routine similar to the above 6289 mypltr function; pltr1; and pltr2. Furthermore, some of our more 6290 sophisticated bindings (see, e.g., the PLplot documentation) 6291 support native language callbacks for handling index to 6292 world-coordinate transformations. Examples of these various 6293 approaches are given in examples/<language>x09*, 6294 examples/<language>x16*, examples/<language>x20*, 6295 examples/<language>x21*, and examples/<language>x22*, for all our 6296 supported languages. 6298 pltr_data (PLPointer, input) : Extra parameter to help pass 6299 information to pltr0, pltr1, pltr2, or whatever routine that is 6300 externally supplied. 6303 return _plplotc.plshade(*args)
6307 Assign a function to use for generating custom axis labels 6311 This function allows a user to provide their own function to provide 6312 axis label text. The user function is given the numeric value for a 6313 point on an axis and returns a string label to correspond with that 6314 value. Custom axis labels can be enabled by passing appropriate 6315 arguments to plenv, plbox, plbox3 and similar functions. 6317 This function is used in example 19. 6323 plslabelfunc(label_func, label_data) 6327 label_func (PLLABEL_FUNC_callback, input) : This is the custom 6328 label function. In order to reset to the default labelling, set 6329 this to NULL. The labelling function parameters are, in order: 6330 axis: This indicates which axis a label is being requested for. 6331 The value will be one of PL_X_AXIS, PL_Y_AXIS or PL_Z_AXIS. 6333 value: This is the value along the axis which is being labelled. 6335 label_text: The string representation of the label value. 6337 length: The maximum length in characters allowed for label_text. 6340 label_data (PLPointer, input) : This parameter may be used to pass 6341 data to the label_func function. 6344 return _plplotc.plslabelfunc(lf, data)
6348 Set length of major ticks 6352 This sets up the length of the major ticks. The actual length is the 6353 product of the default length and a scaling factor as for character 6356 Redacted form: plsmaj(def, scale) 6358 This function is used in example 29. 6368 def (PLFLT, input) : The default length of a major tick in 6369 millimeters, should be set to zero if the default length is to 6372 scale (PLFLT, input) : Scale factor to be applied to default to get 6376 return _plplotc.plsmaj(arg1, scale)
6380 Set the memory area to be plotted (RGB) 6384 Set the memory area to be plotted (with the mem or memcairo driver) as 6385 the dev member of the stream structure. Also set the number of pixels 6386 in the memory passed in 6387 plotmem, which is a block of memory 6389 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB) 6391 This memory will have to be freed by the user! 6393 Redacted form: plsmem(maxx, maxy, plotmem) 6395 This function is not used in any examples. 6401 plsmem(maxx, maxy, plotmem) 6405 maxx (PLINT, input) : Size of memory area in the X coordinate. 6407 maxy (PLINT, input) : Size of memory area in the Y coordinate. 6409 plotmem (PLPointer, input) : Pointer to the beginning of a 6410 user-supplied writeable memory area. 6413 return _plplotc.plsmem(maxx, maxy, plotmem)
6417 Set the memory area to be plotted (RGBA) 6421 Set the memory area to be plotted (with the memcairo driver) as the 6422 dev member of the stream structure. Also set the number of pixels in 6423 the memory passed in 6424 plotmem, which is a block of memory 6426 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA) 6428 This memory will have to be freed by the user! 6430 Redacted form: plsmema(maxx, maxy, plotmem) 6432 This function is not used in any examples. 6438 plsmema(maxx, maxy, plotmem) 6442 maxx (PLINT, input) : Size of memory area in the X coordinate. 6444 maxy (PLINT, input) : Size of memory area in the Y coordinate. 6446 plotmem (PLPointer, input) : Pointer to the beginning of a 6447 user-supplied writeable memory area. 6450 return _plplotc.plsmema(maxx, maxy, plotmem)
6454 Set length of minor ticks 6458 This sets up the length of the minor ticks and the length of the 6459 terminals on error bars. The actual length is the product of the 6460 default length and a scaling factor as for character height. 6462 Redacted form: plsmin(def, scale) 6464 This function is used in example 29. 6474 def (PLFLT, input) : The default length of a minor tick in 6475 millimeters, should be set to zero if the default length is to 6478 scale (PLFLT, input) : Scale factor to be applied to default to get 6482 return _plplotc.plsmin(arg1, scale)
6490 Set integer plot orientation parameter. This function is identical to 6491 plsdiori except for the type of the argument, and should be used in 6492 the same way. See the documentation of plsdiori for details. 6494 Redacted form: plsori(ori) 6496 This function is used in example 3. 6506 ori (PLINT, input) : Orientation value (0 for landscape, 1 for 6507 portrait, etc.) The value is multiplied by 90 degrees to get the 6511 return _plplotc.plsori(ori)
6519 Sets the page configuration (optional). If an individual parameter is 6520 zero then that parameter value is not updated. Not all parameters are 6521 recognized by all drivers and the interpretation is device-dependent. 6522 The X-window driver uses the length and offset parameters to determine 6523 the window size and location. The length and offset values are 6524 expressed in units that are specific to the current driver. For 6525 instance: screen drivers will usually interpret them as number of 6526 pixels, whereas printer drivers will usually use mm. 6528 This routine, if used, must be called before initializing PLplot. It 6529 may be called at later times for interactive drivers to change only 6530 the dpi for subsequent redraws which you can force via a call to 6531 plreplot. If this function is not called then the page size defaults 6532 to landscape A4 for drivers which use real world page sizes and 744 6533 pixels wide by 538 pixels high for raster drivers. The default value 6534 for dx and dy is 90 pixels per inch for raster drivers. 6538 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff) 6540 This function is used in examples 14 and 31. 6546 plspage(xp, yp, xleng, yleng, xoff, yoff) 6550 xp (PLFLT, input) : Number of pixels per inch (DPI), x. Used only 6551 by raster drivers, ignored by drivers which use "real world" units 6554 yp (PLFLT, input) : Number of pixels per inch (DPI), y. Used only 6555 by raster drivers, ignored by drivers which use "real world" units 6558 xleng (PLINT, input) : Page length, x. 6560 yleng (PLINT, input) : Page length, y. 6562 xoff (PLINT, input) : Page offset, x. 6564 yoff (PLINT, input) : Page offset, y. 6567 return _plplotc.plspage(xp, yp, xleng, yleng, xoff, yoff)
6571 Set the cmap0 palette using the specified cmap0*.pal format file 6575 Set the cmap0 palette using the specified cmap0*.pal format file. 6577 Redacted form: plspal0(filename) 6579 This function is in example 16. 6589 filename (PLCHAR_VECTOR, input) : An ascii character string 6590 containing the name of the cmap0*.pal file. If this string is 6591 empty, use the default cmap0*.pal file. 6594 return _plplotc.plspal0(filename)
6598 Set the cmap1 palette using the specified cmap1*.pal format file 6602 Set the cmap1 palette using the specified cmap1*.pal format file. 6604 Redacted form: plspal1(filename, interpolate) 6606 This function is used in example 16. 6612 plspal1(filename, interpolate) 6616 filename (PLCHAR_VECTOR, input) : An ascii character string 6617 containing the name of the cmap1*.pal file. If this string is 6618 empty, use the default cmap1*.pal file. 6620 interpolate (PLBOOL, input) : If this parameter is true, the 6621 columns containing the intensity index, r, g, b, alpha and 6622 alt_hue_path in the cmap1*.pal file are used to set the cmap1 6623 palette with a call to plscmap1la. (The cmap1*.pal header contains 6624 a flag which controls whether the r, g, b data sent to plscmap1la 6625 are interpreted as HLS or RGB.) If this parameter is false, the 6626 intensity index and alt_hue_path columns are ignored and the r, g, 6627 b (interpreted as RGB), and alpha columns of the cmap1*.pal file 6628 are used instead to set the cmap1 palette directly with a call to 6632 return _plplotc.plspal1(filename, interpolate)
6636 Set the pause (on end-of-page) status 6640 Set the pause (on end-of-page) status. 6642 Redacted form: plspause(pause) 6644 This function is in examples 14,20. 6654 pause (PLBOOL, input) : If pause is true there will be a pause on 6655 end-of-page for those drivers which support this. Otherwise there 6659 return _plplotc.plspause(pause)
6663 Set current output stream 6667 Sets the number of the current output stream. The stream number 6668 defaults to 0 unless changed by this routine. The first use of this 6669 routine must be followed by a call initializing PLplot (e.g. plstar). 6671 Redacted form: plsstrm(strm) 6673 This function is examples 1,14,20. 6683 strm (PLINT, input) : The current stream number. 6686 return _plplotc.plsstrm(strm)
6690 Set the number of subpages in x and y 6694 Set the number of subpages in x and y. 6696 Redacted form: plssub(nx, ny) 6698 This function is examples 1,2,14,21,25,27. 6708 nx (PLINT, input) : Number of windows in x direction (i.e., number 6711 ny (PLINT, input) : Number of windows in y direction (i.e., number 6715 return _plplotc.plssub(nx, ny)
6723 This sets up the size of all subsequent symbols drawn by plpoin and 6724 plsym. The actual height of a symbol is the product of the default 6725 symbol size and a scaling factor as for the character height. 6727 Redacted form: plssym(def, scale) 6729 This function is used in example 29. 6739 def (PLFLT, input) : The default height of a symbol in millimeters, 6740 should be set to zero if the default height is to remain 6743 scale (PLFLT, input) : Scale factor to be applied to default to get 6744 actual symbol height. 6747 return _plplotc.plssym(arg1, scale)
6755 Initializing the plotting package. The program prompts for the device 6756 keyword or number of the desired output device. Hitting a RETURN in 6757 response to the prompt is the same as selecting the first device. If 6758 only one device is enabled when PLplot is installed, plstar will issue 6759 no prompt. The output device is divided into nx by ny subpages, each 6760 of which may be used independently. The subroutine pladv is used to 6761 advance from one subpage to the next. 6763 Redacted form: plstar(nx, ny) 6765 This function is used in example 1. 6775 nx (PLINT, input) : Number of subpages to divide output page in the 6778 ny (PLINT, input) : Number of subpages to divide output page in the 6782 return _plplotc.plstar(nx, ny)
6790 Alternative to plstar for initializing the plotting package. The 6791 device name keyword for the desired output device must be supplied as 6792 an argument. These keywords are the same as those printed out by 6793 plstar. If the requested device is not available, or if the input 6794 string is empty or begins with ``?'', the prompted start up of plstar 6795 is used. This routine also divides the output device page into nx by 6796 ny subpages, each of which may be used independently. The subroutine 6797 pladv is used to advance from one subpage to the next. 6799 Redacted form: General: plstart(devname, nx, ny) 6802 This function is not used in any examples. 6808 plstart(devname, nx, ny) 6812 devname (PLCHAR_VECTOR, input) : An ascii character string 6813 containing the device name keyword of the required output device. 6815 devname is NULL or if the first character of the string is a ``?'', 6816 the normal (prompted) start up is used. 6818 nx (PLINT, input) : Number of subpages to divide output page in the 6821 ny (PLINT, input) : Number of subpages to divide output page in the 6825 return _plplotc.plstart(devname, nx, ny)
6829 Set a global coordinate transform function 6833 This function can be used to define a coordinate transformation which 6834 affects all elements drawn within the current plot window. The 6835 coordinate_transform callback function is similar to that provided for 6836 the plmap and plmeridians functions. The coordinate_transform_data 6837 parameter may be used to pass extra data to coordinate_transform. 6839 Redacted form: General: plstransform(coordinate_transform, 6840 coordinate_transform_data) 6843 This function is used in examples 19 and 22. 6849 plstransform(coordinate_transform, coordinate_transform_data) 6853 coordinate_transform (PLTRANSFORM_callback, input) : A callback 6854 function that defines the transformation from the input (x, y) 6855 world coordinates to new PLplot world coordinates. If 6856 coordinate_transform is not supplied (e.g., is set to NULL in the C 6857 case), then no transform is applied. 6859 coordinate_transform_data (PLPointer, input) : Optional extra data 6861 coordinate_transform. 6864 return _plplotc.plstransform(*args)
6868 Plot a glyph at the specified points 6872 Plot a glyph at the specified points. (Supersedes plpoin and plsym 6873 because many[!] more glyphs are accessible with plstring.) The glyph 6874 is specified with a PLplot user string. Note that the user string is 6875 not actually limited to one glyph so it is possible (but not normally 6876 useful) to plot more than one glyph at the specified points with this 6877 function. As with plmtex and plptex, the user string can contain FCI 6878 escapes to determine the font, UTF-8 code to determine the glyph or 6879 else PLplot escapes for Hershey or unicode text to determine the 6882 Redacted form: plstring(x, y, string) 6884 This function is used in examples 4, 21 and 26. 6890 plstring(n, x, y, string) 6894 n (PLINT, input) : Number of points in the x and y vectors. 6896 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 6899 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 6902 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing 6903 the glyph(s) to be plotted at each of the n points. 6906 return _plplotc.plstring(n, ArrayCk, string)
6910 Plot a glyph at the specified 3D points 6914 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because 6915 many[!] more glyphs are accessible with plstring3.) Set up the call to 6916 this function similar to what is done for plline3. The glyph is 6917 specified with a PLplot user string. Note that the user string is not 6918 actually limited to one glyph so it is possible (but not normally 6919 useful) to plot more than one glyph at the specified points with this 6920 function. As with plmtex and plptex, the user string can contain FCI 6921 escapes to determine the font, UTF-8 code to determine the glyph or 6922 else PLplot escapes for Hershey or unicode text to determine the 6925 Redacted form: plstring3(x, y, z, string) 6927 This function is used in example 18. 6933 plstring3(n, x, y, z, string) 6937 n (PLINT, input) : Number of points in the x, y, and z vectors. 6939 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 6942 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 6945 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of 6948 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing 6949 the glyph(s) to be plotted at each of the n points. points. 6952 return _plplotc.plstring3(n, arg2, arg3, string)
6956 Add a point to a strip chart 6960 Add a point to a given pen of a given strip chart. There is no need 6961 for all pens to have the same number of points or to be equally 6962 sampled in the x coordinate. Allocates memory and rescales as 6965 Redacted form: plstripa(id, pen, x, y) 6967 This function is used in example 17. 6973 plstripa(id, pen, x, y) 6977 id (PLINT, input) : Identification number of the strip chart (set 6980 pen (PLINT, input) : Pen number (ranges from 0 to 3). 6982 x (PLFLT, input) : X coordinate of point to plot. 6984 y (PLFLT, input) : Y coordinate of point to plot. 6987 return _plplotc.plstripa(id, pen, x, y)
6989 def plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop):
6991 Create a 4-pen strip chart 6995 Create a 4-pen strip chart, to be used afterwards by plstripa 6997 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump, 6998 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, 6999 styline, legline, labx, laby, labz) 7002 This function is used in example 17. 7008 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop) 7012 id (PLINT_NC_SCALAR, output) : Returned value of the identification 7013 number of the strip chart to use on plstripa and plstripd. 7015 xspec (PLCHAR_VECTOR, input) : An ascii character string containing 7016 the x-axis specification as in plbox. 7018 yspec (PLCHAR_VECTOR, input) : An ascii character string containing 7019 the y-axis specification as in plbox. 7021 xmin (PLFLT, input) : Initial coordinates of plot box; they will 7022 change as data are added. 7024 xmax (PLFLT, input) : Initial coordinates of plot box; they will 7025 change as data are added. 7027 xjump (PLFLT, input) : When x attains xmax, the length of the plot 7028 is multiplied by the factor (1 + 7031 ymin (PLFLT, input) : Initial coordinates of plot box; they will 7032 change as data are added. 7034 ymax (PLFLT, input) : Initial coordinates of plot box; they will 7035 change as data are added. 7037 xlpos (PLFLT, input) : X legend box position (range from 0 to 1). 7039 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1). 7041 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is 7042 true, otherwise not. 7044 acc (PLBOOL, input) : Accumulate strip plot if acc is true, 7045 otherwise slide display. 7047 colbox (PLINT, input) : Plot box color index (cmap0). 7049 collab (PLINT, input) : Legend color index (cmap0). 7051 colline (PLINT_VECTOR, input) : A vector containing the cmap0 color 7052 indices for the 4 pens. 7054 styline (PLINT_VECTOR, input) : A vector containing the line style 7055 indices for the 4 pens. 7057 legline (PLCHAR_MATRIX, input) : A vector of UTF-8 character 7058 strings containing legends for the 4 pens. 7060 labx (PLCHAR_VECTOR, input) : A UTF-8 character string containing 7061 the label for the x axis. 7063 laby (PLCHAR_VECTOR, input) : A UTF-8 character string containing 7064 the label for the y axis. 7066 labtop (PLCHAR_VECTOR, input) : A UTF-8 character string containing 7070 return _plplotc.plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop)
7074 Deletes and releases memory used by a strip chart 7078 Deletes and releases memory used by a strip chart. 7080 Redacted form: plstripd(id) 7082 This function is used in example 17. 7092 id (PLINT, input) : Identification number of strip chart to delete. 7095 return _plplotc.plstripd(id)
7103 This sets up the line style for all lines subsequently drawn. A line 7104 consists of segments in which the pen is alternately down and up. The 7105 lengths of these segments are passed in the vectors mark and space 7106 respectively. The number of mark-space pairs is specified by nms. In 7107 order to return the line style to the default continuous line, plstyl 7108 should be called with nms =0 .(see also pllsty) 7110 Redacted form: plstyl(mark, space) 7112 This function is used in examples 1, 9, and 14. 7118 plstyl(nms, mark, space) 7122 nms (PLINT, input) : The number of mark and space elements in a 7123 line. Thus a simple broken line can be obtained by setting nms=1 7124 . A continuous line is specified by setting nms=0 . 7126 mark (PLINT_VECTOR, input) : A vector containing the lengths of the 7127 segments during which the pen is down, measured in micrometers. 7129 space (PLINT_VECTOR, input) : A vector containing the lengths of 7130 the segments during which the pen is up, measured in micrometers. 7133 return _plplotc.plstyl(n, ArrayCk)
7137 Set arrow style for vector plots 7141 Set the style for the arrow used by plvect to plot vectors. 7143 Redacted form: plsvect(arrowx, arrowy, fill) 7145 This function is used in example 22. 7151 plsvect(arrowx, arrowy, npts, fill) 7155 arrowx, arrowy (PLFLT_VECTOR, input) : A pair of vectors containing 7156 the x and y points which make up the arrow. The arrow is plotted 7157 by joining these points to form a polygon. The scaling assumes 7158 that the x and y points in the arrow lie in the range -0.5 <= x,y 7159 <= 0.5. If both arrowx and arrowy are NULL then the arrow style 7160 will be reset to its default. 7162 npts (PLINT, input) : Number of points in the vectors arrowx and 7165 fill (PLBOOL, input) : If fill is true then the arrow is closed, if 7166 fill is false then the arrow is open. 7169 return _plplotc.plsvect(ArrayNull, ArrayCkNull, deffalse)
7173 Specify viewport in absolute coordinates 7177 Alternate routine to plvpor for setting up the viewport. This routine 7178 should be used only if the viewport is required to have a definite 7179 size in millimeters. The routine plgspa is useful for finding out the 7180 size of the current subpage. 7182 Redacted form: plsvpa(xmin, xmax, ymin, ymax) 7184 This function is used in example 10. 7190 plsvpa(xmin, xmax, ymin, ymax) 7194 xmin (PLFLT, input) : The distance of the left-hand edge of the 7195 viewport from the left-hand edge of the subpage in millimeters. 7197 xmax (PLFLT, input) : The distance of the right-hand edge of the 7198 viewport from the left-hand edge of the subpage in millimeters. 7200 ymin (PLFLT, input) : The distance of the bottom edge of the 7201 viewport from the bottom edge of the subpage in millimeters. 7203 ymax (PLFLT, input) : The distance of the top edge of the viewport 7204 from the bottom edge of the subpage in millimeters. 7207 return _plplotc.plsvpa(xmin, xmax, ymin, ymax)
7211 Set x axis parameters 7215 Sets values of the digmax and digits flags for the x axis. See the 7216 PLplot documentation for more information. 7218 Redacted form: plsxax(digmax, digits) 7220 This function is used in example 31. 7226 plsxax(digmax, digits) 7230 digmax (PLINT, input) : Variable to set the maximum number of 7231 digits for the x axis. If nonzero, the printed label will be 7232 switched to a floating-point representation when the number of 7233 digits exceeds digmax. 7235 digits (PLINT, input) : Field digits value. Currently, changing 7236 its value here has no effect since it is set only by plbox or 7237 plbox3. However, the user may obtain its value after a call to 7238 either of these functions by calling plgxax. 7241 return _plplotc.plsxax(digmax, digits)
7245 Set y axis parameters 7249 Identical to plsxax, except that arguments are flags for y axis. See 7250 the description of plsxax for more detail. 7252 Redacted form: plsyax(digmax, digits) 7254 This function is used in examples 1, 14, and 31. 7260 plsyax(digmax, digits) 7264 digmax (PLINT, input) : Variable to set the maximum number of 7265 digits for the y axis. If nonzero, the printed label will be 7266 switched to a floating-point representation when the number of 7267 digits exceeds digmax. 7269 digits (PLINT, input) : Field digits value. Currently, changing 7270 its value here has no effect since it is set only by plbox or 7271 plbox3. However, the user may obtain its value after a call to 7272 either of these functions by calling plgyax. 7275 return _plplotc.plsyax(digmax, digits)
7279 Plot a glyph at the specified points 7283 Plot a glyph at the specified points. (This function is largely 7284 superseded by plstring which gives access to many[!] more glyphs.) 7286 Redacted form: plsym(x, y, code) 7288 This function is used in example 7. 7294 plsym(n, x, y, code) 7298 n (PLINT, input) : Number of points in the x and y vectors. 7300 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of 7303 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of 7306 code (PLINT, input) : Hershey symbol code corresponding to a glyph 7307 to be plotted at each of the n points. 7310 return _plplotc.plsym(n, ArrayCk, code)
7314 Set z axis parameters 7318 Identical to plsxax, except that arguments are flags for z axis. See 7319 the description of plsxax for more detail. 7321 Redacted form: plszax(digmax, digits) 7323 This function is used in example 31. 7329 plszax(digmax, digits) 7333 digmax (PLINT, input) : Variable to set the maximum number of 7334 digits for the z axis. If nonzero, the printed label will be 7335 switched to a floating-point representation when the number of 7336 digits exceeds digmax. 7338 digits (PLINT, input) : Field digits value. Currently, changing 7339 its value here has no effect since it is set only by plbox or 7340 plbox3. However, the user may obtain its value after a call to 7341 either of these functions by calling plgzax. 7344 return _plplotc.plszax(digmax, digits)
7348 Switch to text screen 7352 Sets an interactive device to text mode, used in conjunction with 7353 plgra to allow graphics and text to be interspersed. On a device 7354 which supports separate text and graphics windows, this command causes 7355 control to be switched to the text window. This can be useful for 7356 printing diagnostic messages or getting user input, which would 7357 otherwise interfere with the plots. The program must switch back to 7358 the graphics window before issuing plot commands, as the text (or 7359 console) device will probably become quite confused otherwise. If 7360 already in text mode, this command is ignored. It is also ignored on 7361 devices which only support a single window or use a different method 7362 for shifting focus (see also plgra). 7364 Redacted form: pltext() 7366 This function is used in example 1. 7375 return _plplotc.pltext()
7379 Set format for date / time labels 7383 Sets the format for date / time labels. To enable date / time format 7384 labels see the options to plbox, plbox3, and plenv. 7386 Redacted form: pltimefmt(fmt) 7388 This function is used in example 29. 7398 fmt (PLCHAR_VECTOR, input) : An ascii character string which is 7399 interpreted similarly to the format specifier of typical system 7400 strftime routines except that PLplot ignores locale and also 7401 supplies some useful extensions in the context of plotting. All 7402 text in the string is printed as-is other than conversion 7403 specifications which take the form of a '%' character followed by 7404 further conversion specification character. The conversion 7405 specifications which are similar to those provided by system 7406 strftime routines are the following: %a: The abbreviated (English) 7408 %A: The full (English) weekday name. 7409 %b: The abbreviated (English) month name. 7410 %B: The full (English) month name. 7411 %c: Equivalent to %a %b %d %T %Y (non-ISO). 7412 %C: The century number (year/100) as a 2-digit integer. 7413 %d: The day of the month as a decimal number (range 01 to 31). 7414 %D: Equivalent to %m/%d/%y (non-ISO). 7415 %e: Like %d, but a leading zero is replaced by a space. 7416 %F: Equivalent to %Y-%m-%d (the ISO 8601 date format). 7417 %h: Equivalent to %b. 7418 %H: The hour as a decimal number using a 24-hour clock (range 7420 %I: The hour as a decimal number using a 12-hour clock (range 7422 %j: The day of the year as a decimal number (range 001 to 7424 %k: The hour (24-hour clock) as a decimal number (range 0 to 7425 23); single digits are preceded by a blank. (See also %H.) 7426 %l: The hour (12-hour clock) as a decimal number (range 1 to 7427 12); single digits are preceded by a blank. (See also %I.) 7428 %m: The month as a decimal number (range 01 to 12). 7429 %M: The minute as a decimal number (range 00 to 59). 7430 %n: A newline character. 7431 %p: Either "AM" or "PM" according to the given time value. 7432 Noon is treated as "PM" and midnight as "AM". 7433 %r: Equivalent to %I:%M:%S %p. 7434 %R: The time in 24-hour notation (%H:%M). For a version 7435 including the seconds, see %T below. 7436 %s: The number of seconds since the Epoch, 1970-01-01 00:00:00 7438 %S: The second as a decimal number (range 00 to 60). (The 7439 range is up to 60 to allow for occasional leap seconds.) 7440 %t: A tab character. 7441 %T: The time in 24-hour notation (%H:%M:%S). 7442 %u: The day of the week as a decimal, range 1 to 7, Monday 7443 being 1. See also %w. 7444 %U: The week number of the current year as a decimal number, 7445 range 00 to 53, starting with the first Sunday as the first 7446 day of week 01. See also %V and %W. 7447 %v: Equivalent to %e-%b-%Y. 7448 %V: The ISO 8601 week number of the current year as a decimal 7449 number, range 01 to 53, where week 1 is the first week that 7450 has at least 4 days in the new year. See also %U and %W. 7451 %w: The day of the week as a decimal, range 0 to 6, Sunday 7452 being 0. See also %u. 7453 %W: The week number of the current year as a decimal number, 7454 range 00 to 53, starting with the first Monday as the first 7456 %x: Equivalent to %a %b %d %Y. 7457 %X: Equivalent to %T. 7458 %y: The year as a decimal number without a century (range 00 7460 %Y: The year as a decimal number including a century. 7461 %z: The UTC time-zone string = "+0000". 7462 %Z: The UTC time-zone abbreviation = "UTC". 7463 %+: The UTC date and time in default format of the Unix date 7464 command which is equivalent to %a %b %d %T %Z %Y. 7465 %%: A literal "%" character. 7466 The conversion specifications which are extensions to those normally 7467 provided by system strftime routines are the following: %(0-9): 7468 The fractional part of the seconds field (including leading 7469 decimal point) to the specified accuracy. Thus %S%3 would give 7470 seconds to millisecond accuracy (00.000). 7471 %.: The fractional part of the seconds field (including 7472 leading decimal point) to the maximum available accuracy. Thus 7473 %S%. would give seconds with fractional part up to 9 decimal 7474 places if available. 7477 return _plplotc.pltimefmt(fmt)
7481 Specify viewport using aspect ratio only 7485 Selects the largest viewport with the given aspect ratio within the 7486 subpage that leaves a standard margin (left-hand margin of eight 7487 character heights, and a margin around the other three sides of five 7490 Redacted form: plvasp(aspect) 7492 This function is used in example 13. 7502 aspect (PLFLT, input) : Ratio of length of y axis to length of x 7503 axis of resulting viewport. 7506 return _plplotc.plvasp(aspect)
7514 Draws a plot of vector data contained in the matrices ( 7520 ny]) . The scaling factor for the vectors is given by scale. A 7521 transformation routine pointed to by pltr with a pointer pltr_data for 7522 additional data required by the transformation routine to map indices 7523 within the matrices to the world coordinates. The style of the vector 7524 arrow may be set using plsvect. 7526 Redacted form: plvect(u, v, scale, pltr, pltr_data) where (see above 7527 discussion) the pltr, pltr_data callback arguments are sometimes 7528 replaced by a tr vector with 6 elements, or xg and yg array arguments 7529 with either one or two dimensions. 7531 This function is used in example 22. 7537 plvect(u, v, nx, ny, scale, pltr, pltr_data) 7541 u, v (PLFLT_MATRIX, input) : A pair of matrices containing the x 7542 and y components of the vector data to be plotted. 7544 nx, ny (PLINT, input) : Dimensions of the matrices u and v. 7546 scale (PLFLT, input) : Parameter to control the scaling factor of 7547 the vectors for plotting. If scale = 0 then the scaling factor is 7548 automatically calculated for the data. If scale < 0 then the 7549 scaling factor is automatically calculated for the data and then 7551 scale. If scale > 0 then the scaling factor is set to scale. 7553 pltr (PLTRANSFORM_callback, input) : A callback function that 7554 defines the transformation between the zero-based indices of the 7555 matrices u and v and world coordinates.For the C case, 7556 transformation functions are provided in the PLplot library: pltr0 7557 for the identity mapping, and pltr1 and pltr2 for arbitrary 7558 mappings respectively defined by vectors and matrices. In 7559 addition, C callback routines for the transformation can be 7560 supplied by the user such as the mypltr function in 7561 examples/c/x09c.c which provides a general linear transformation 7562 between index coordinates and world coordinates.For languages 7563 other than C you should consult the PLplot documentation for the 7564 details concerning how PLTRANSFORM_callback arguments are 7565 interfaced. However, in general, a particular pattern of 7566 callback-associated arguments such as a tr vector with 6 elements; 7567 xg and yg vectors; or xg and yg matrices are respectively 7568 interfaced to a linear-transformation routine similar to the above 7569 mypltr function; pltr1; and pltr2. Furthermore, some of our more 7570 sophisticated bindings (see, e.g., the PLplot documentation) 7571 support native language callbacks for handling index to 7572 world-coordinate transformations. Examples of these various 7573 approaches are given in examples/<language>x09*, 7574 examples/<language>x16*, examples/<language>x20*, 7575 examples/<language>x21*, and examples/<language>x22*, for all our 7576 supported languages. 7578 pltr_data (PLPointer, input) : Extra parameter to help pass 7579 information to pltr0, pltr1, pltr2, or whatever callback routine 7580 that is externally supplied. 7583 return _plplotc.plvect(*args)
7587 Specify viewport using coordinates and aspect ratio 7591 Device-independent routine for setting up the viewport. The viewport 7592 is chosen to be the largest with the given aspect ratio that fits 7593 within the specified region (in terms of normalized subpage 7594 coordinates). This routine is functionally equivalent to plvpor when 7595 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this 7596 routine reserves no extra space at the edges for labels. 7598 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect) 7600 This function is used in example 9. 7606 plvpas(xmin, xmax, ymin, ymax, aspect) 7610 xmin (PLFLT, input) : The normalized subpage coordinate of the 7611 left-hand edge of the viewport. 7613 xmax (PLFLT, input) : The normalized subpage coordinate of the 7614 right-hand edge of the viewport. 7616 ymin (PLFLT, input) : The normalized subpage coordinate of the 7617 bottom edge of the viewport. 7619 ymax (PLFLT, input) : The normalized subpage coordinate of the top 7620 edge of the viewport. 7622 aspect (PLFLT, input) : Ratio of length of y axis to length of x 7626 return _plplotc.plvpas(xmin, xmax, ymin, ymax, aspect)
7630 Specify viewport using normalized subpage coordinates 7634 Device-independent routine for setting up the viewport. This defines 7635 the viewport in terms of normalized subpage coordinates which run from 7636 0.0 to 1.0 (left to right and bottom to top) along each edge of the 7637 current subpage. Use the alternate routine plsvpa in order to create 7638 a viewport of a definite size. 7640 Redacted form: plvpor(xmin, xmax, ymin, ymax) 7642 This function is used in examples 2, 6-8, 10, 11, 15, 16, 18, 21, 23, 7649 plvpor(xmin, xmax, ymin, ymax) 7653 xmin (PLFLT, input) : The normalized subpage coordinate of the 7654 left-hand edge of the viewport. 7656 xmax (PLFLT, input) : The normalized subpage coordinate of the 7657 right-hand edge of the viewport. 7659 ymin (PLFLT, input) : The normalized subpage coordinate of the 7660 bottom edge of the viewport. 7662 ymax (PLFLT, input) : The normalized subpage coordinate of the top 7663 edge of the viewport. 7666 return _plplotc.plvpor(xmin, xmax, ymin, ymax)
7670 Select standard viewport 7674 Selects the largest viewport within the subpage that leaves a standard 7675 margin (left-hand margin of eight character heights, and a margin 7676 around the other three sides of five character heights). 7678 Redacted form: plvsta() 7680 This function is used in examples 1, 12, 14, 17, 25, and 29. 7689 return _plplotc.plvsta()
7691 def plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az):
7693 Configure the transformations required for projecting a 3D surface on a 2D window 7697 Configure the transformations required for projecting a 3D surface on 7698 an existing 2D window. Those transformations (see the PLplot 7699 documentation) are done to a rectangular cuboid enclosing the 3D 7700 surface which has its limits expressed in 3D world coordinates and 7701 also normalized 3D coordinates (used for interpreting the altitude and 7702 azimuth of the viewing angle). The transformations consist of the 7703 linear transform from 3D world coordinates to normalized 3D 7704 coordinates, and the 3D rotation of normalized coordinates required to 7705 align the pole of the new 3D coordinate system with the viewing 7706 direction specified by altitude and azimuth so that x and y of the 7707 surface elements in that transformed coordinate system are the 7708 projection of the 3D surface with given viewing direction on the 2D 7711 The enclosing rectangular cuboid for the surface plot is defined by 7712 xmin, xmax, ymin, ymax, zmin and zmax in 3D world coordinates. It is 7713 mapped into the same rectangular cuboid with normalized 3D coordinate 7714 sizes of basex by basey by height so that xmin maps to - 7715 basex/2, xmax maps to basex/2, ymin maps to - 7716 basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height. 7717 The resulting rectangular cuboid in normalized coordinates is then 7718 viewed by an observer at altitude alt and azimuth az. This routine 7719 must be called before plbox3 or any of the 3D surface plotting 7720 routines; plmesh, plmeshc, plot3d, plot3dc, plot3dcl, plsurf3d, 7721 plsurf3dl or plfill3. 7723 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax, 7724 zmin, zmax, alt, az) 7726 This function is examples 8, 11, 18, and 21. 7732 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az) 7736 basex (PLFLT, input) : The normalized x coordinate size of the 7739 basey (PLFLT, input) : The normalized y coordinate size of the 7742 height (PLFLT, input) : The normalized z coordinate size of the 7745 xmin (PLFLT, input) : The minimum x world coordinate of the 7748 xmax (PLFLT, input) : The maximum x world coordinate of the 7751 ymin (PLFLT, input) : The minimum y world coordinate of the 7754 ymax (PLFLT, input) : The maximum y world coordinate of the 7757 zmin (PLFLT, input) : The minimum z world coordinate of the 7760 zmax (PLFLT, input) : The maximum z world coordinate of the 7763 alt (PLFLT, input) : The viewing altitude in degrees above the xy 7764 plane of the rectangular cuboid in normalized coordinates. 7766 az (PLFLT, input) : The viewing azimuth in degrees of the 7767 rectangular cuboid in normalized coordinates. When az=0, the 7768 observer is looking face onto the zx plane of the rectangular 7769 cuboid in normalized coordinates, and as az is increased, the 7770 observer moves clockwise around that cuboid when viewed from above 7774 return _plplotc.plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az)
7784 Redacted form: plwidth(width) 7786 This function is used in examples 1 and 2. 7796 width (PLFLT, input) : The desired pen width. If width is negative 7797 or the same as the previous value no action is taken. width = 0. 7798 should be interpreted as as the minimum valid pen width for the 7799 device. The interpretation of positive width values is also 7803 return _plplotc.plwidth(width)
7811 Specify the window, i.e., the world coordinates of the edges of the 7814 Redacted form: plwind(xmin, xmax, ymin, ymax) 7816 This function is used in examples 1, 2, 4, 6-12, 14-16, 18, 21, 23-27, 7823 plwind(xmin, xmax, ymin, ymax) 7827 xmin (PLFLT, input) : The world x coordinate of the left-hand edge 7830 xmax (PLFLT, input) : The world x coordinate of the right-hand edge 7833 ymin (PLFLT, input) : The world y coordinate of the bottom edge of 7836 ymax (PLFLT, input) : The world y coordinate of the top edge of the 7840 return _plplotc.plwind(xmin, xmax, ymin, ymax)
7844 Enter or leave xor mode 7848 Enter (when mode is true) or leave (when mode is false) xor mode for 7849 those drivers (e.g., the xwin driver) that support it. Enables 7850 erasing plots by drawing twice the same line, symbol, etc. If driver 7851 is not capable of xor operation it returns a status of false. 7853 Redacted form: plxormod(mode, status) 7855 This function is used in examples 1 and 20. 7861 plxormod(mode, status) 7865 mode (PLBOOL, input) : mode is true means enter xor mode and mode 7866 is false means leave xor mode. 7868 status (PLBOOL_NC_SCALAR, output) : Returned value of the status. 7869 modestatus of true (false) means driver is capable (incapable) of 7873 return _plplotc.plxormod(mode)
7875 def plmap(mapform, type, minx, maxx, miny, maxy):
7877 Plot continental outline or shapefile data in world coordinates 7881 Plots continental outlines or shapefile data in world coordinates. A 7882 demonstration of how to use this function to create different 7883 projections can be found in examples/c/x19c. PLplot is provided with 7884 basic coastal outlines and USA state borders. To use the map 7885 functionality PLplot must be compiled with the shapelib library. 7886 Shapefiles have become a popular standard for geographical data and 7887 data in this format can be easily found from a number of online 7888 sources. Shapefile data is actually provided as three or more files 7889 with the same filename, but different extensions. The .shp and .shx 7890 files are required for plotting Shapefile data with PLplot. 7892 PLplot currently supports the point, multipoint, polyline and polygon 7893 objects within shapefiles. However holes in polygons are not 7894 supported. When plmap is used the type of object is derived from the 7895 shapefile, if you wish to override the type then use one of the other 7896 plmap variants. The built in maps have line data only. 7898 Redacted form: plmap(mapform, name, minx, maxx, miny, maxy) 7900 This function is used in example 19. 7906 plmap(mapform, name, minx, maxx, miny, maxy) 7910 mapform (PLMAPFORM_callback, input) : A user supplied function to 7911 transform the original map data coordinates to a new coordinate 7912 system. The PLplot-supplied map data is provided as latitudes and 7913 longitudes; other Shapefile data may be provided in other 7914 coordinate systems as can be found in their .prj plain text files. 7915 For example, by using this transform we can change from a 7916 longitude, latitude coordinate to a polar stereographic 7917 projection. Initially, x[0]..[n-1] are the original x coordinates 7918 (longitudes for the PLplot-supplied data) and y[0]..y[n-1] are the 7919 corresponding y coordinates (latitudes for the PLplot supplied 7920 data). After the call to mapform(), x[] and y[] should be 7921 replaced by the corresponding plot coordinates. If no transform is 7922 desired, mapform can be replaced by NULL. 7924 name (PLCHAR_VECTOR, input) : An ascii character string specifying 7925 the type of map plotted. This is either one of the PLplot built-in 7926 maps or the file name of a set of Shapefile files without the file 7927 extensions. For the PLplot built-in maps the possible values are: 7928 "globe" -- continental outlines 7929 "usa" -- USA and state boundaries 7930 "cglobe" -- continental outlines and countries 7931 "usaglobe" -- USA, state boundaries and continental outlines 7934 minx (PLFLT, input) : The minimum x value of map elements to be 7935 drawn. The units must match the shapefile (built in maps are 7936 degrees lat/lon). Objects in the file which do not encroach on the 7937 box defined by minx, maxx, miny, maxy will not be rendered. But 7938 note this is simply an optimisation, not a clipping so for objects 7939 with some points inside the box and some points outside the box 7940 all the points will be rendered. These parameters also define 7941 latitude and longitude wrapping for shapefiles using these units. 7942 Longitude points will be wrapped by integer multiples of 360 7943 degrees to place them in the box. This allows the same data to be 7944 used on plots from -180-180 or 0-360 longitude ranges. In fact if 7945 you plot from -180-540 you will get two cycles of data drawn. The 7946 value of minx must be less than the value of maxx. Passing in a 7947 nan, max/-max floating point number or +/-infinity will case the 7948 bounding box from the shapefile to be used. 7950 maxx (PLFLT, input) : The maximum x value of map elements to be 7953 miny (PLFLT, input) : The minimum y value of map elements to be 7956 maxy (PLFLT, input) : The maximum y value of map elements to be 7960 return _plplotc.plmap(mapform, type, minx, maxx, miny, maxy)
7962 def plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull):
7964 Plot all or a subset of Shapefile data using lines in world coordinates 7968 Plot all or a subset of Shapefile data using lines in world 7969 coordinates. Our 19th standard example demonstrates how to use this 7970 function. This function plots data from a Shapefile using lines as in 7971 plmap, however it also has the option of also only drawing specified 7972 elements from the Shapefile. The vector of indices of the required 7973 elements are passed as a function argument. The Shapefile data should 7974 include a metadata file (extension.dbf) listing all items within the 7975 Shapefile. This file can be opened by most popular spreadsheet 7976 programs and can be used to decide which indices to pass to this 7979 Redacted form: plmapline(mapform, name, minx, maxx, miny, maxy, 7982 This function is used in example 19. 7988 plmapline(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries) 7992 mapform (PLMAPFORM_callback, input) : A user supplied function to 7993 transform the coordinates given in the shapefile into a plot 7994 coordinate system. By using this transform, we can change from a 7995 longitude, latitude coordinate to a polar stereographic project, 7996 for example. Initially, x[0]..[n-1] are the longitudes and 7997 y[0]..y[n-1] are the corresponding latitudes. After the call to 7998 mapform(), x[] and y[] should be replaced by the corresponding 7999 plot coordinates. If no transform is desired, mapform can be 8002 name (PLCHAR_VECTOR, input) : An ascii character string specifying 8003 the file name of a set of Shapefile files without the file 8006 minx (PLFLT, input) : The minimum x value to be plotted. This must 8007 be in the same units as used by the Shapefile. You could use a 8008 very large negative number to plot everything, but you can improve 8009 performance by limiting the area drawn. The units must match those 8010 of the Shapefile projection, which may be for example longitude or 8011 distance. The value of minx must be less than the value of maxx. 8013 maxx (PLFLT, input) : The maximum x value to be plotted. You could 8014 use a very large number to plot everything, but you can improve 8015 performance by limiting the area drawn. 8017 miny (PLFLT, input) : The minimum y value to be plotted. This must 8018 be in the same units as used by the Shapefile. You could use a 8019 very large negative number to plot everything, but you can improve 8020 performance by limiting the area drawn. The units must match those 8021 of the Shapefile projection, which may be for example latitude or 8022 distance. The value of miny must be less than the value of maxy. 8024 maxy (PLFLT, input) : The maximum y value to be plotted. You could 8025 use a very large number to plot everything, but you can improve 8026 performance by limiting the area drawn. 8028 plotentries (PLINT_VECTOR, input) : A vector containing the 8029 zero-based indices of the Shapefile elements which will be drawn. 8031 plotentries to NULL will plot all elements of the Shapefile. 8033 nplotentries (PLINT, input) : The number of items in 8034 plotentries. Ignored if 8035 plotentries is NULL. 8038 return _plplotc.plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull)
8040 def plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull):
8042 Plot all or a subset of Shapefile data using strings or points in world coordinates 8046 As per plmapline, however the items are plotted as strings or points 8047 in the same way as plstring. 8049 Redacted form: plmapstring(mapform, name, string, minx, maxx, miny, 8052 This function is not used in any examples. 8058 plmapstring(mapform, name, string, minx, maxx, miny, maxy, plotentries, nplotentries) 8062 mapform (PLMAPFORM_callback, input) : A user supplied function to 8063 transform the coordinates given in the shapefile into a plot 8064 coordinate system. By using this transform, we can change from a 8065 longitude, latitude coordinate to a polar stereographic project, 8066 for example. Initially, x[0]..[n-1] are the longitudes and 8067 y[0]..y[n-1] are the corresponding latitudes. After the call to 8068 mapform(), x[] and y[] should be replaced by the corresponding 8069 plot coordinates. If no transform is desired, mapform can be 8072 name (PLCHAR_VECTOR, input) : An ascii character string specifying 8073 the file name of a set of Shapefile files without the file 8076 string (PLCHAR_VECTOR, input) : A UTF-8 character string to be 8079 minx (PLFLT, input) : The minimum x value to be plotted. This must 8080 be in the same units as used by the Shapefile. You could use a 8081 very large negative number to plot everything, but you can improve 8082 performance by limiting the area drawn. The units must match those 8083 of the Shapefile projection, which may be for example longitude or 8084 distance. The value of minx must be less than the value of maxx. 8086 maxx (PLFLT, input) : The maximum x value to be plotted. You could 8087 use a very large number to plot everything, but you can improve 8088 performance by limiting the area drawn. 8090 miny (PLFLT, input) : The minimum y value to be plotted. This must 8091 be in the same units as used by the Shapefile. You could use a 8092 very large negative number to plot everything, but you can improve 8093 performance by limiting the area drawn. The units must match those 8094 of the Shapefile projection, which may be for example latitude or 8095 distance. The value of miny must be less than the value of maxy. 8097 maxy (PLFLT, input) : The maximum y value to be plotted. You could 8098 use a very large number to plot everything, but you can improve 8099 performance by limiting the area drawn. 8101 plotentries (PLINT_VECTOR, input) : A vector containing the 8102 zero-based indices of the Shapefile elements which will be drawn. 8104 plotentries to NULL will plot all elements of the Shapefile. 8106 nplotentries (PLINT, input) : The number of items in 8107 plotentries. Ignored if 8108 plotentries is NULL. 8111 return _plplotc.plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull)
8113 def plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry):
8115 Draw text at points defined by Shapefile data in world coordinates 8119 As per plmapline, however the items are plotted as text in the same 8122 Redacted form: plmaptex(mapform, name, dx, dy, just, text, minx, maxx, 8123 miny, maxy, plotentry) 8125 This function is used in example 19. 8131 plmaptex(mapform, name, dx, dy, just, text, minx, maxx, miny, maxy, plotentry) 8135 mapform (PLMAPFORM_callback, input) : A user supplied function to 8136 transform the coordinates given in the shapefile into a plot 8137 coordinate system. By using this transform, we can change from a 8138 longitude, latitude coordinate to a polar stereographic project, 8139 for example. Initially, x[0]..[n-1] are the longitudes and 8140 y[0]..y[n-1] are the corresponding latitudes. After the call to 8141 mapform(), x[] and y[] should be replaced by the corresponding 8142 plot coordinates. If no transform is desired, mapform can be 8145 name (PLCHAR_VECTOR, input) : An ascii character string specifying 8146 the file name of a set of Shapefile files without the file 8149 dx (PLFLT, input) : Used to define the slope of the texts which is 8152 dy (PLFLT, input) : Used to define the slope of the texts which is 8155 just (PLFLT, input) : Set the justification of the text. The value 8156 given will be the fraction of the distance along the string that 8157 sits at the given point. 0.0 gives left aligned text, 0.5 gives 8158 centralized text and 1.0 gives right aligned text. 8160 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be drawn. 8162 minx (PLFLT, input) : The minimum x value to be plotted. This must 8163 be in the same units as used by the Shapefile. You could use a 8164 very large negative number to plot everything, but you can improve 8165 performance by limiting the area drawn. The units must match those 8166 of the Shapefile projection, which may be for example longitude or 8167 distance. The value of minx must be less than the value of maxx. 8169 maxx (PLFLT, input) : The maximum x value to be plotted. You could 8170 use a very large number to plot everything, but you can improve 8171 performance by limiting the area drawn. 8173 miny (PLFLT, input) : The minimum y value to be plotted. This must 8174 be in the same units as used by the Shapefile. You could use a 8175 very large negative number to plot everything, but you can improve 8176 performance by limiting the area drawn. The units must match those 8177 of the Shapefile projection, which may be for example latitude or 8178 distance. The value of miny must be less than the value of maxy. 8180 maxy (PLFLT, input) : The maximum y value to be plotted. You could 8181 use a very large number to plot everything, but you can improve 8182 performance by limiting the area drawn. 8184 plotentry (PLINT, input) : An integer indicating which text string 8185 of the Shapefile (zero indexed) will be drawn. 8188 return _plplotc.plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8190 def plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull):
8192 Plot all or a subset of Shapefile data, filling the polygons 8196 As per plmapline, however the items are filled in the same way as 8199 Redacted form: plmapfill(mapform, name, minx, maxx, miny, maxy, 8202 This function is used in example 19. 8208 plmapfill(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries) 8212 mapform (PLMAPFORM_callback, input) : A user supplied function to 8213 transform the coordinates given in the shapefile into a plot 8214 coordinate system. By using this transform, we can change from a 8215 longitude, latitude coordinate to a polar stereographic project, 8216 for example. Initially, x[0]..[n-1] are the longitudes and 8217 y[0]..y[n-1] are the corresponding latitudes. After the call to 8218 mapform(), x[] and y[] should be replaced by the corresponding 8219 plot coordinates. If no transform is desired, mapform can be 8222 name (PLCHAR_VECTOR, input) : An ascii character string specifying 8223 the file name of a set of Shapefile files without the file 8226 minx (PLFLT, input) : The minimum x value to be plotted. This must 8227 be in the same units as used by the Shapefile. You could use a 8228 very large negative number to plot everything, but you can improve 8229 performance by limiting the area drawn. The units must match those 8230 of the Shapefile projection, which may be for example longitude or 8231 distance. The value of minx must be less than the value of maxx. 8233 maxx (PLFLT, input) : The maximum x value to be plotted. You could 8234 use a very large number to plot everything, but you can improve 8235 performance by limiting the area drawn. 8237 miny (PLFLT, input) : The minimum y value to be plotted. This must 8238 be in the same units as used by the Shapefile. You could use a 8239 very large negative number to plot everything, but you can improve 8240 performance by limiting the area drawn. The units must match those 8241 of the Shapefile projection, which may be for example latitude or 8242 distance. The value of miny must be less than the value of maxy. 8244 maxy (PLFLT, input) : The maximum y value to be plotted. You could 8245 use a very large number to plot everything, but you can improve 8246 performance by limiting the area drawn. 8248 plotentries (PLINT_VECTOR, input) : A vector containing the 8249 zero-based indices of the Shapefile elements which will be drawn. 8251 plotentries to NULL will plot all elements of the Shapefile. 8253 nplotentries (PLINT, input) : The number of items in 8254 plotentries. Ignored if 8255 plotentries is NULL. 8258 return _plplotc.plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull)
8260 def plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat):
8262 Plot latitude and longitude lines 8266 Displays latitude and longitude on the current plot. The lines are 8267 plotted in the current color and line style. 8269 Redacted form: plmeridians(mapform, dlong, dlat, minlong, maxlong, 8272 This function is used in example 19. 8278 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat) 8282 mapform (PLMAPFORM_callback, input) : A user supplied function to 8283 transform the coordinate longitudes and latitudes to a plot 8284 coordinate system. By using this transform, we can change from a 8285 longitude, latitude coordinate to a polar stereographic project, 8286 for example. Initially, x[0]..[n-1] are the longitudes and 8287 y[0]..y[n-1] are the corresponding latitudes. After the call to 8288 mapform(), x[] and y[] should be replaced by the corresponding 8289 plot coordinates. If no transform is desired, mapform can be 8292 dlong (PLFLT, input) : The interval in degrees at which the 8293 longitude lines are to be plotted. 8295 dlat (PLFLT, input) : The interval in degrees at which the latitude 8296 lines are to be plotted. 8298 minlong (PLFLT, input) : The value of the longitude on the left 8299 side of the plot. The value of minlong must be less than the value 8300 of maxlong, and the quantity maxlong-minlong must be less than or 8303 maxlong (PLFLT, input) : The value of the longitude on the right 8306 minlat (PLFLT, input) : The minimum latitude to be plotted on the 8307 background. One can always use -90.0 as the boundary outside the 8308 plot window will be automatically eliminated. However, the 8309 program will be faster if one can reduce the size of the 8312 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the 8313 background. One can always use 90.0 as the boundary outside the 8314 plot window will be automatically eliminated. 8317 return _plplotc.plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8319 def plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax):
8321 Plot a 2D matrix using cmap1 with automatic color adjustment 8325 Plot a 2D matrix using the cmap1 palette. The color scale is 8326 automatically adjusted to use the maximum and minimum values in idata 8327 as valuemin and valuemax in a call to plimagefr. 8329 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin, 8330 zmax, Dxmin, Dxmax, Dymin, Dymax) 8333 This function is used in example 20. 8339 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax) 8343 idata (PLFLT_MATRIX, input) : A matrix containing function values 8344 to plot. Should have dimensions of 8348 nx, ny (PLINT, input) : Dimensions of idata 8350 xmin, xmax, ymin, ymax (PLFLT, input) : The x and y index ranges 8351 are linearly transformed to these world coordinate ranges such 8352 that idata[0][0] corresponds to (xmin, ymin) and idata[nx - 1][ny 8353 - 1] corresponds to (xmax, ymax). 8355 zmin, zmax (PLFLT, input) : Only data between zmin and zmax 8356 (inclusive) will be plotted. 8358 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of 8359 points whose plot coordinates fall inside the window of (Dxmin, 8360 Dymin) to (Dxmax, Dymax). 8363 return _plplotc.plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8367 Plot a 2D matrix using cmap1 8371 Plot a 2D matrix using cmap1. 8373 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin, 8374 zmax, valuemin, valuemax, pltr, pltr_data) 8377 This function is used in example 20. 8383 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data) 8387 idata (PLFLT_MATRIX, input) : A matrix of values (intensities) to 8388 plot. Should have dimensions of 8392 nx, ny (PLINT, input) : Dimensions of idata 8394 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of 8395 pltr below for how these arguments are used (only for the special case 8396 when the callback function 8397 pltr is not supplied). 8399 zmin, zmax (PLFLT, input) : Only data between zmin and zmax 8400 (inclusive) will be plotted. 8402 valuemin, valuemax (PLFLT, input) : The minimum and maximum data 8403 values to use for value to color mappings. A datum equal to or 8404 less than valuemin will be plotted with color 0.0, while a datum 8405 equal to or greater than valuemax will be plotted with color 1.0. 8406 Data between valuemin and valuemax map linearly to colors in the 8409 pltr (PLTRANSFORM_callback, input) : A callback function that 8410 defines the transformation between the zero-based indices of the 8411 matrix idata and world coordinates. If 8412 pltr is not supplied (e.g., is set to NULL in the C case), then the x 8413 indices of idata are mapped to the range 8415 xmax and the y indices of idata are mapped to the range 8417 ymax.For the C case, transformation functions are provided in the 8418 PLplot library: pltr0 for the identity mapping, and pltr1 and 8419 pltr2 for arbitrary mappings respectively defined by vectors and 8420 matrices. In addition, C callback routines for the transformation 8421 can be supplied by the user such as the mypltr function in 8422 examples/c/x09c.c which provides a general linear transformation 8423 between index coordinates and world coordinates.For languages 8424 other than C you should consult the PLplot documentation for the 8425 details concerning how PLTRANSFORM_callback arguments are 8426 interfaced. However, in general, a particular pattern of 8427 callback-associated arguments such as a tr vector with 6 elements; 8428 xg and yg vectors; or xg and yg matrices are respectively 8429 interfaced to a linear-transformation routine similar to the above 8430 mypltr function; pltr1; and pltr2. Furthermore, some of our more 8431 sophisticated bindings (see, e.g., the PLplot documentation) 8432 support native language callbacks for handling index to 8433 world-coordinate transformations. Examples of these various 8434 approaches are given in examples/<language>x09*, 8435 examples/<language>x16*, examples/<language>x20*, 8436 examples/<language>x21*, and examples/<language>x22*, for all our 8437 supported languages. 8439 pltr_data (PLPointer, input) : Extra parameter to help pass 8440 information to pltr0, pltr1, pltr2, or whatever routine is 8441 externally supplied. 8444 return _plplotc.plimagefr(*args)
8447 return _plplotc.plClearOpts()
8448 plClearOpts = _plplotc.plClearOpts
8451 return _plplotc.plResetOpts()
8452 plResetOpts = _plplotc.plResetOpts
8455 return _plplotc.plSetUsage(program_string, usage_string)
8456 plSetUsage = _plplotc.plSetUsage
8459 return _plplotc.plOptUsage()
8460 plOptUsage = _plplotc.plOptUsage
8463 return _plplotc.plMinMax2dGrid(Matrix)
8464 plMinMax2dGrid = _plplotc.plMinMax2dGrid
8468 Wait for graphics input event and translate to world coordinates. 8472 Wait for graphics input event and translate to world coordinates. 8473 Returns 0 if no translation to world coordinates is possible. 8475 This function returns 1 on success and 0 if no translation to world 8476 coordinates is possible. 8478 Redacted form: plGetCursor(gin) 8480 This function is used in examples 1 and 20. 8486 PLINT plGetCursor(gin) 8490 gin (PLGraphicsIn *, output) : Pointer to PLGraphicsIn structure 8491 which will contain the output. The structure is not allocated by 8492 the routine and must exist before the function is called. 8495 return _plplotc.plGetCursor(gin)
def plstart(devname, nx, ny)
def plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
def pllab(xlabel, ylabel, tlabel)
def plsfont(family, style, weight)
def plspage(xp, yp, xleng, yleng, xoff, yoff)
def plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
def pl_setcontlabelformat(lexp, sigdig)
def pl_setcontlabelparam(offset, size, spacing, active)
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, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28, arg29, arg30)
def plhist(n, datmin, datmax, nbin, oldwin)
def plscompression(compression)
def pllightsource(x, y, z)
def plvpas(xmin, xmax, ymin, ymax, aspect)
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, arg16, arg17, arg18, arg19, arg20, ArrayN, MatrixCk)
def plenv(xmin, xmax, ymin, ymax, just, axis)
def plerry(n, arg2, arg3)
def plenv0(xmin, xmax, ymin, ymax, just, axis)
def plsmema(maxx, maxy, plotmem)
def plspal1(filename, interpolate)
def plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array)
def plwind(xmin, xmax, ymin, ymax)
def plerrx(n, arg2, arg3)
def plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
def plslabelfunc(lf, data)
def plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null)
def plsdiplt(xmin, ymin, xmax, ymax)
def plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
def plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
def plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull)
def plbin(n, ArrayCk, center)
def plcpstrm(iplsr, flags)
def plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
def _swig_getattr(self, class_type, name)
def plscmap1(Array, arg2, arg3)
def plsvpa(xmin, xmax, ymin, ymax)
def plscolbga(r, g, b, a)
def plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data)
def plfill3(n, arg2, arg3)
def plmap(mapform, type, minx, maxx, miny, maxy)
def plptex(x, y, dx, dy, just, text)
def plpoin3(n, arg2, arg3, code)
def plsvect(ArrayNull, ArrayCkNull, deffalse)
def plsfam(fam, num, bmax)
def plscmap1a(Array, arg2, arg3, arg4)
def plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
def plsxax(digmax, digits)
def plvpor(xmin, xmax, ymin, ymax)
def plsetopt(opt, optarg)
def plstripa(id, pen, x, y)
def plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull)
def plparseopts(p_argc, mode)
def plstring(n, ArrayCk, string)
def plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array)
def plscol0a(icol0, r, g, b, a)
def plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array)
def pljoin(x1, y1, x2, y2)
def plmesh(ArrayX, ArrayY, MatrixCk, opt)
def _swig_setattr(self, class_type, name, value)
def plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
def plmtex(side, disp, pos, just, text)
def plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull)
def plpoin(n, ArrayCk, code)
def plscmap0a(Array, arg2, arg3, arg4)
def plgradient(n, ArrayCk, angle)
def plarc(x, y, a, b, angle1, angle2, rotate, fill)
def plpath(n, x1, y1, x2, y2)
def plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz)
def plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
def _swig_setattr_nondynamic(self, class_type, name, value, static=1)
def plot3d(ArrayX, ArrayY, MatrixCk, opt, side)
def plmtex3(side, disp, pos, just, text)
def plscmap0(Array, arg2, arg3)
def plline3(n, arg2, arg3)
def plsdidev(mar, aspect, jx, jy)
def plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null)
def plctime(year, month, day, hour, min, sec)
def plsmem(maxx, maxy, plotmem)
def plscmap1_range(min_color, max_color)
def PLGraphicsIn_swigregister
def plstring3(n, arg2, arg3, string)
def plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
def plpoly3(n, arg2, arg3, ArrayCkMinus1, flag)
def plscol0(icol0, r, g, b)
def plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop)
def plszax(digmax, digits)
def plsdiplz(xmin, ymin, xmax, ymax)
def plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az)
def plsyax(digmax, digits)
def plsym(n, ArrayCk, code)