PLplot 5.15.0
Loading...
Searching...
No Matches
plplotc.py
Go to the documentation of this file.
1# This file was automatically generated by SWIG (https://www.swig.org).
2# Version 4.5.0
3#
4# Do not make changes to this file unless you know what you are doing - modify
5# the SWIG interface file instead.
6
7import typing
8# Import the low-level C/C++ module
9if getattr(globals().get("__spec__"), "parent", None) or __package__ or "." in __name__:
10 from . import _plplotc
11else:
12 import _plplotc
13
14import builtins as __builtin__
15
16def _swig_repr(self):
17 try:
18 strthis = "proxy of " + self.this.__repr__()
19 except __builtin__.Exception:
20 strthis = ""
21 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
22
23
25 def set_instance_attr(self, name, value):
26 if name == "this":
27 set(self, name, value)
28 elif name == "thisown":
29 self.this.own(value)
30 elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
31 set(self, name, value)
32 else:
33 raise AttributeError("You cannot add instance attributes to %s" % self)
34 return set_instance_attr
35
36
38 def set_class_attr(cls, name, value):
39 if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
40 set(cls, name, value)
41 else:
42 raise AttributeError("You cannot add class attributes to %s" % cls)
43 return set_class_attr
44
45
47 """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
48 __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
49
50
51
52def pltr0(x, y):
53 return _plplotc.pltr0(x, y)
54
55def pltr1(x, y, cgrid):
56 return _plplotc.pltr1(x, y, cgrid)
57
58def pltr2(x, y, cgrid):
59 return _plplotc.pltr2(x, y, cgrid)
60PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
61PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
62PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
63PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
64PLESC_RESIZE = _plplotc.PLESC_RESIZE
65PLESC_REDRAW = _plplotc.PLESC_REDRAW
66PLESC_TEXT = _plplotc.PLESC_TEXT
67PLESC_GRAPH = _plplotc.PLESC_GRAPH
68PLESC_FILL = _plplotc.PLESC_FILL
69PLESC_DI = _plplotc.PLESC_DI
70PLESC_FLUSH = _plplotc.PLESC_FLUSH
71PLESC_EH = _plplotc.PLESC_EH
72PLESC_GETC = _plplotc.PLESC_GETC
73PLESC_SWIN = _plplotc.PLESC_SWIN
74PLESC_DOUBLEBUFFERING = _plplotc.PLESC_DOUBLEBUFFERING
75PLESC_XORMOD = _plplotc.PLESC_XORMOD
76PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
77PLESC_CLEAR = _plplotc.PLESC_CLEAR
78PLESC_DASH = _plplotc.PLESC_DASH
79PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
80PLESC_IMAGE = _plplotc.PLESC_IMAGE
81PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
82PLESC_PL2DEVCOL = _plplotc.PLESC_PL2DEVCOL
83PLESC_DEV2PLCOL = _plplotc.PLESC_DEV2PLCOL
84PLESC_SETBGFG = _plplotc.PLESC_SETBGFG
85PLESC_DEVINIT = _plplotc.PLESC_DEVINIT
86PLESC_GETBACKEND = _plplotc.PLESC_GETBACKEND
87PLESC_BEGIN_TEXT = _plplotc.PLESC_BEGIN_TEXT
88PLESC_TEXT_CHAR = _plplotc.PLESC_TEXT_CHAR
89PLESC_CONTROL_CHAR = _plplotc.PLESC_CONTROL_CHAR
90PLESC_END_TEXT = _plplotc.PLESC_END_TEXT
91PLESC_START_RASTERIZE = _plplotc.PLESC_START_RASTERIZE
92PLESC_END_RASTERIZE = _plplotc.PLESC_END_RASTERIZE
93PLESC_ARC = _plplotc.PLESC_ARC
94PLESC_GRADIENT = _plplotc.PLESC_GRADIENT
95PLESC_MODESET = _plplotc.PLESC_MODESET
96PLESC_MODEGET = _plplotc.PLESC_MODEGET
97PLESC_FIXASPECT = _plplotc.PLESC_FIXASPECT
98PLESC_IMPORT_BUFFER = _plplotc.PLESC_IMPORT_BUFFER
99PLESC_APPEND_BUFFER = _plplotc.PLESC_APPEND_BUFFER
100PLESC_FLUSH_REMAINING_BUFFER = _plplotc.PLESC_FLUSH_REMAINING_BUFFER
101PLTEXT_FONTCHANGE = _plplotc.PLTEXT_FONTCHANGE
102PLTEXT_SUPERSCRIPT = _plplotc.PLTEXT_SUPERSCRIPT
103PLTEXT_SUBSCRIPT = _plplotc.PLTEXT_SUBSCRIPT
104PLTEXT_BACKCHAR = _plplotc.PLTEXT_BACKCHAR
105PLTEXT_OVERLINE = _plplotc.PLTEXT_OVERLINE
106PLTEXT_UNDERLINE = _plplotc.PLTEXT_UNDERLINE
107ZEROW2B = _plplotc.ZEROW2B
108ZEROW2D = _plplotc.ZEROW2D
109ONEW2B = _plplotc.ONEW2B
110ONEW2D = _plplotc.ONEW2D
111PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
112PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
113PL_X_AXIS = _plplotc.PL_X_AXIS
114PL_Y_AXIS = _plplotc.PL_Y_AXIS
115PL_Z_AXIS = _plplotc.PL_Z_AXIS
116PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
117PL_OPT_ARG = _plplotc.PL_OPT_ARG
118PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
119PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
120PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
121PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
122PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
123PL_OPT_INT = _plplotc.PL_OPT_INT
124PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
125PL_OPT_STRING = _plplotc.PL_OPT_STRING
126PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
127PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
128PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
129PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
130PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
131PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
132PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
133PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
134PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
135PL_FCI_MARK = _plplotc.PL_FCI_MARK
136PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
137PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
138PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
139PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
140PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
141PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
142PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
143PL_FCI_SANS = _plplotc.PL_FCI_SANS
144PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
145PL_FCI_MONO = _plplotc.PL_FCI_MONO
146PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
147PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
148PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
149PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
150PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
151PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
152PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
153PL_MAXKEY = _plplotc.PL_MAXKEY
154PL_MASK_SHIFT = _plplotc.PL_MASK_SHIFT
155PL_MASK_CAPS = _plplotc.PL_MASK_CAPS
156PL_MASK_CONTROL = _plplotc.PL_MASK_CONTROL
157PL_MASK_ALT = _plplotc.PL_MASK_ALT
158PL_MASK_NUM = _plplotc.PL_MASK_NUM
159PL_MASK_ALTGR = _plplotc.PL_MASK_ALTGR
160PL_MASK_WIN = _plplotc.PL_MASK_WIN
161PL_MASK_SCROLL = _plplotc.PL_MASK_SCROLL
162PL_MASK_BUTTON1 = _plplotc.PL_MASK_BUTTON1
163PL_MASK_BUTTON2 = _plplotc.PL_MASK_BUTTON2
164PL_MASK_BUTTON3 = _plplotc.PL_MASK_BUTTON3
165PL_MASK_BUTTON4 = _plplotc.PL_MASK_BUTTON4
166PL_MASK_BUTTON5 = _plplotc.PL_MASK_BUTTON5
167PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
168PL_NOTSET = _plplotc.PL_NOTSET
169PL_DEFAULT_NCOL0 = _plplotc.PL_DEFAULT_NCOL0
170PL_DEFAULT_NCOL1 = _plplotc.PL_DEFAULT_NCOL1
171MIN_PLINT_RGB = _plplotc.MIN_PLINT_RGB
172MAX_PLINT_RGB = _plplotc.MAX_PLINT_RGB
173MIN_PLFLT_CMAP1 = _plplotc.MIN_PLFLT_CMAP1
174MAX_PLFLT_CMAP1 = _plplotc.MAX_PLFLT_CMAP1
175MIN_PLFLT_ALPHA = _plplotc.MIN_PLFLT_ALPHA
176MAX_PLFLT_ALPHA = _plplotc.MAX_PLFLT_ALPHA
177PLESC_DOUBLEBUFFERING_ENABLE = _plplotc.PLESC_DOUBLEBUFFERING_ENABLE
178PLESC_DOUBLEBUFFERING_DISABLE = _plplotc.PLESC_DOUBLEBUFFERING_DISABLE
179PLESC_DOUBLEBUFFERING_QUERY = _plplotc.PLESC_DOUBLEBUFFERING_QUERY
180PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
181PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
182PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
183PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
184GRID_CSA = _plplotc.GRID_CSA
185GRID_DTLI = _plplotc.GRID_DTLI
186GRID_NNI = _plplotc.GRID_NNI
187GRID_NNIDW = _plplotc.GRID_NNIDW
188GRID_NNLI = _plplotc.GRID_NNLI
189GRID_NNAIDW = _plplotc.GRID_NNAIDW
190PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
191PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
192PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
193PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
194PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
195PL_POSITION_NULL = _plplotc.PL_POSITION_NULL
196PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
197PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
198PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
199PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
200PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
201PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
202PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
203PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
204PL_LEGEND_NULL = _plplotc.PL_LEGEND_NULL
205PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
206PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
207PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
208PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
209PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
210PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
211PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
212PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
213PL_COLORBAR_NULL = _plplotc.PL_COLORBAR_NULL
214PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
215PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
216PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
217PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
218PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
219PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
220PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
221PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
222PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
223PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
224PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
225PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
226PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
227PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
228PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
229PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
230PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
231PL_DRAWMODE_UNKNOWN = _plplotc.PL_DRAWMODE_UNKNOWN
232PL_DRAWMODE_DEFAULT = _plplotc.PL_DRAWMODE_DEFAULT
233PL_DRAWMODE_REPLACE = _plplotc.PL_DRAWMODE_REPLACE
234PL_DRAWMODE_XOR = _plplotc.PL_DRAWMODE_XOR
235DRAW_LINEX = _plplotc.DRAW_LINEX
236DRAW_LINEY = _plplotc.DRAW_LINEY
237DRAW_LINEXY = _plplotc.DRAW_LINEXY
238MAG_COLOR = _plplotc.MAG_COLOR
239BASE_CONT = _plplotc.BASE_CONT
240TOP_CONT = _plplotc.TOP_CONT
241SURF_CONT = _plplotc.SURF_CONT
242DRAW_SIDES = _plplotc.DRAW_SIDES
243FACETED = _plplotc.FACETED
244MESH = _plplotc.MESH
245class PLGraphicsIn(object):
246 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
247 __repr__ = _swig_repr
248 type = property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
249 state = property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
250 keysym = property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
251 button = property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
252 subwindow = property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
253 string = property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
254 pX = property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
255 pY = property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
256 dX = property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
257 dY = property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
258 wX = property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
259 wY = property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
260
261 def __init__(self):
262 _plplotc.PLGraphicsIn_swiginit(self, _plplotc.new_PLGraphicsIn())
263 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
264
265# Register PLGraphicsIn in _plplotc:
266_plplotc.PLGraphicsIn_swigregister(PLGraphicsIn)
267
268def plsxwin(window_id):
269 return _plplotc.plsxwin(window_id)
270
271def pl_setcontlabelformat(lexp, sigdig):
272 r"""
273 Set format of numerical label for contours
274
275 DESCRIPTION:
276
277 Set format of numerical label for contours.
278
279 Redacted form: pl_setcontlabelformat(lexp, sigdig)
280
281 This function is used example 9.
282
283
284
285 SYNOPSIS:
286
287 pl_setcontlabelformat(lexp, sigdig)
288
289 ARGUMENTS:
290
291 lexp (PLINT, input) : If the contour numerical label is greater
292 than 10^(lexp) or less than 10^(-lexp), then the exponential
293 format is used. Default value of lexp is 4.
294
295 sigdig (PLINT, input) : Number of significant digits. Default
296 value is 2.
297
298 """
299 return _plplotc.pl_setcontlabelformat(lexp, sigdig)
300
301def pl_setcontlabelparam(offset, size, spacing, active):
302 r"""
303 Set parameters of contour labelling other than format of numerical label
304
305 DESCRIPTION:
306
307 Set parameters of contour labelling other than those handled by
308 pl_setcontlabelformat.
309
310 Redacted form: pl_setcontlabelparam(offset, size, spacing, active)
311
312 This function is used in example 9.
313
314
315
316 SYNOPSIS:
317
318 pl_setcontlabelparam(offset, size, spacing, active)
319
320 ARGUMENTS:
321
322 offset (PLFLT, input) : Offset of label from contour line (if set
323 to 0.0, labels are printed on the lines). Default value is 0.006.
324
325 size (PLFLT, input) : Font height for contour labels (normalized).
326 Default value is 0.3.
327
328 spacing (PLFLT, input) : Spacing parameter for contour labels.
329 Default value is 0.1.
330
331 active (PLINT, input) : Activate labels. Set to 1 if you want
332 contour labels on. Default is off (0).
333
334 """
335 return _plplotc.pl_setcontlabelparam(offset, size, spacing, active)
336
337def pladv(page):
338 r"""
339 Advance the (sub-)page
340
341 DESCRIPTION:
342
343 Advances to the next subpage if sub=0, performing a page advance if
344 there are no remaining subpages on the current page. If subpages
345 aren't being used, pladv(0) will always advance the page. If page>0,
346 PLplot switches to the specified subpage. Note that this allows you
347 to overwrite a plot on the specified subpage; if this is not what you
348 intended, use pleop followed by plbop to first advance the page. This
349 routine is called automatically (with page=0) by plenv, but if plenv
350 is not used, pladv must be called after initializing PLplot but before
351 defining the viewport.
352
353 Redacted form: pladv(page)
354
355 This function is used in examples 1, 2, 4, 6-12, 14-18, 20, 21, 23-27,
356 29, and 31.
357
358
359
360 SYNOPSIS:
361
362 pladv(page)
363
364 ARGUMENTS:
365
366 page (PLINT, input) : Specifies the subpage number (starting from 1
367 in the top left corner and increasing along the rows) to which to
368 advance. Set to zero to advance to the next subpage (or to the
369 next page if subpages are not being used).
370
371 """
372 return _plplotc.pladv(page)
373
374def plarc(x, y, a, b, angle1, angle2, rotate, fill):
375 r"""
376 Draw a circular or elliptical arc
377
378 DESCRIPTION:
379
380 Draw a possibly filled arc centered at x, y with semimajor axis a and
381 semiminor axis b, starting at angle1 and ending at angle2.
382
383 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate,
384 fill)
385
386
387 This function is used in examples 3 and 27.
388
389
390
391 SYNOPSIS:
392
393 plarc(x, y, a, b, angle1, angle2, rotate, fill)
394
395 ARGUMENTS:
396
397 x (PLFLT, input) : X coordinate of arc center.
398
399 y (PLFLT, input) : Y coordinate of arc center.
400
401 a (PLFLT, input) : Length of the semimajor axis of the arc.
402
403 b (PLFLT, input) : Length of the semiminor axis of the arc.
404
405 angle1 (PLFLT, input) : Starting angle of the arc relative to the
406 semimajor axis.
407
408 angle2 (PLFLT, input) : Ending angle of the arc relative to the
409 semimajor axis.
410
411 rotate (PLFLT, input) : Angle of the semimajor axis relative to the
412 X-axis.
413
414 fill (PLBOOL, input) : Draw a filled arc.
415
416 """
417 return _plplotc.plarc(x, y, a, b, angle1, angle2, rotate, fill)
418
419def plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub):
420 r"""
421 Draw a box with axes, etc. with arbitrary origin
422
423 DESCRIPTION:
424
425 Draws a box around the currently defined viewport with arbitrary
426 world-coordinate origin specified by x0 and y0 and labels it with
427 world coordinate values appropriate to the window. Thus plaxes should
428 only be called after defining both viewport and window. The ascii
429 character strings xopt and yopt specify how the box should be drawn as
430 described below. If ticks and/or subticks are to be drawn for a
431 particular axis, the tick intervals and number of subintervals may be
432 specified explicitly, or they may be defaulted by setting the
433 appropriate arguments to zero.
434
435 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt,
436 ytick, nysub)
437
438
439 This function is not used in any examples.
440
441
442
443 SYNOPSIS:
444
445 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
446
447 ARGUMENTS:
448
449 x0 (PLFLT, input) : World X coordinate of origin.
450
451 y0 (PLFLT, input) : World Y coordinate of origin.
452
453 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
454 options for the x axis. The string can include any combination of
455 the following letters (upper or lower case) in any order: a: Draws
456 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line
457 (x=0).
458 b: Draws bottom (X) or left (Y) edge of frame.
459 c: Draws top (X) or right (Y) edge of frame.
460 d: Plot labels as date / time. Values are assumed to be
461 seconds since the epoch (as used by gmtime).
462 f: Always use fixed point numeric labels.
463 g: Draws a grid at the major tick interval.
464 h: Draws a grid at the minor tick interval.
465 i: Inverts tick marks, so they are drawn outwards, rather than
466 inwards.
467 l: Labels axis logarithmically. This only affects the labels,
468 not the data, and so it is necessary to compute the logarithms
469 of data points before passing them to any of the drawing
470 routines.
471 m: Writes numeric labels at major tick intervals in the
472 unconventional location (above box for X, right of box for Y).
473 n: Writes numeric labels at major tick intervals in the
474 conventional location (below box for X, left of box for Y).
475 o: Use custom labelling function to generate axis label text.
476 The custom labelling function can be defined with the
477 plslabelfunc command.
478 s: Enables subticks between major ticks, only valid if t is
479 also specified.
480 t: Draws major ticks.
481 u: Exactly like "b" except don't draw edge line.
482 w: Exactly like "c" except don't draw edge line.
483 x: Exactly like "t" (including the side effect of the
484 numerical labels for the major ticks) except exclude drawing
485 the major and minor tick marks.
486
487
488 xtick (PLFLT, input) : World coordinate interval between major
489 ticks on the x axis. If it is set to zero, PLplot automatically
490 generates a suitable tick interval.
491
492 nxsub (PLINT, input) : Number of subintervals between major x axis
493 ticks for minor ticks. If it is set to zero, PLplot automatically
494 generates a suitable minor tick interval.
495
496 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
497 options for the y axis. The string can include any combination of
498 the letters defined above for xopt, and in addition may contain:
499 v: Write numeric labels for the y axis parallel to the base of the
500 graph, rather than parallel to the axis.
501
502
503 ytick (PLFLT, input) : World coordinate interval between major
504 ticks on the y axis. If it is set to zero, PLplot automatically
505 generates a suitable tick interval.
506
507 nysub (PLINT, input) : Number of subintervals between major y axis
508 ticks for minor ticks. If it is set to zero, PLplot automatically
509 generates a suitable minor tick interval.
510
511 """
512 return _plplotc.plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
513
514def plbin(n, ArrayCk, center):
515 r"""
516 Plot a histogram from binned data
517
518 DESCRIPTION:
519
520 Plots a histogram consisting of nbin bins. The value associated with
521 the i'th bin is placed in x[i], and the number of points in the bin is
522 placed in y[i]. For proper operation, the values in x[i] must form a
523 strictly increasing sequence. By default, x[i] is the left-hand edge
524 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
525 placed midway between the values in the x vector. Also see plhist for
526 drawing histograms from unbinned data.
527
528 Redacted form: General: plbin(x, y, opt)
529 Python: plbin(nbin, x, y, opt)
530
531
532 This function is not used in any examples.
533
534
535
536 SYNOPSIS:
537
538 plbin(nbin, x, y, opt)
539
540 ARGUMENTS:
541
542 nbin (PLINT, input) : Number of bins (i.e., number of values in x
543 and y vectors.)
544
545 x (PLFLT_VECTOR, input) : A vector containing values associated
546 with bins. These must form a strictly increasing sequence.
547
548 y (PLFLT_VECTOR, input) : A vector containing a number which is
549 proportional to the number of points in each bin. This is a PLFLT
550 (instead of PLINT) vector so as to allow histograms of
551 probabilities, etc.
552
553 opt (PLINT, input) : Is a combination of several flags:
554 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
555 outer bins are expanded to fill up the entire x-axis and bins of
556 zero height are simply drawn.
557 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
558 between the x values. If the values in x are equally spaced,
559 the values are the center values of the bins.
560 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal
561 size as the ones inside.
562 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn
563 (there is a gap for such bins).
564
565 """
566 return _plplotc.plbin(n, ArrayCk, center)
567
568def plbtime(ctime):
569 r"""
570 Calculate broken-down time from continuous time for the current stream
571
572 DESCRIPTION:
573
574 Calculate broken-down time; year, month, day, hour, min, sec; from
575 continuous time, ctime for the current stream. This function is the
576 inverse of plctime.
577
578 The PLplot definition of broken-down time is a calendar time that
579 completely ignores all time zone offsets, i.e., it is the user's
580 responsibility to apply those offsets (if so desired) before using the
581 PLplot time API. By default broken-down time is defined using the
582 proleptic Gregorian calendar without the insertion of leap seconds and
583 continuous time is defined as the number of seconds since the Unix
584 epoch of 1970-01-01T00:00:00Z. However, other definitions of
585 broken-down and continuous time are possible, see plconfigtime.
586
587 Redacted form: General: plbtime(year, month, day, hour, min, sec,
588 ctime)
589
590
591 This function is used in example 29.
592
593
594
595 SYNOPSIS:
596
597 plbtime(year, month, day, hour, min, sec, ctime)
598
599 ARGUMENTS:
600
601 year (PLINT_NC_SCALAR, output) : Returned value of years with
602 positive values corresponding to CE (i.e., 1 = 1 CE, etc.) and
603 non-negative values corresponding to BCE (e.g., 0 = 1 BCE, -1 = 2
604 BCE, etc.)
605
606 month (PLINT_NC_SCALAR, output) : Returned value of month within
607 the year in the range from 0 (January) to 11 (December).
608
609 day (PLINT_NC_SCALAR, output) : Returned value of day within the
610 month in the range from 1 to 31.
611
612 hour (PLINT_NC_SCALAR, output) : Returned value of hour within the
613 day in the range from 0 to 23.
614
615 min (PLINT_NC_SCALAR, output) : Returned value of minute within the
616 hour in the range from 0 to 59
617
618 sec (PLFLT_NC_SCALAR, output) : Returned value of second within the
619 minute in range from 0. to 60.
620
621 ctime (PLFLT, input) : Continuous time from which the broken-down
622 time is calculated.
623
624 """
625 return _plplotc.plbtime(ctime)
626
627def plbop():
628 r"""
629 Begin a new page
630
631 DESCRIPTION:
632
633 Begins a new page. For a file driver, the output file is opened if
634 necessary. Advancing the page via pleop and plbop is useful when a
635 page break is desired at a particular point when plotting to subpages.
636 Another use for pleop and plbop is when plotting pages to different
637 files, since you can manually set the file name by calling plsfnam
638 after the call to pleop. (In fact some drivers may only support a
639 single page per file, making this a necessity.) One way to handle
640 this case automatically is to page advance via pladv, but enable
641 familying (see plsfam) with a small limit on the file size so that a
642 new family member file will be created on each page break.
643
644 Redacted form: plbop()
645
646 This function is used in examples 2 and 20.
647
648
649
650 SYNOPSIS:
651
652 plbop()
653
654 """
655 return _plplotc.plbop()
656
657def plbox(xopt, xtick, nxsub, yopt, ytick, nysub):
658 r"""
659 Draw a box with axes, etc
660
661 DESCRIPTION:
662
663 Draws a box around the currently defined viewport, and labels it with
664 world coordinate values appropriate to the window. Thus plbox should
665 only be called after defining both viewport and window. The ascii
666 character strings xopt and yopt specify how the box should be drawn as
667 described below. If ticks and/or subticks are to be drawn for a
668 particular axis, the tick intervals and number of subintervals may be
669 specified explicitly, or they may be defaulted by setting the
670 appropriate arguments to zero.
671
672 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
673
674
675 This function is used in examples 1, 2, 4, 6, 6-12, 14-18, 21, 23-26,
676 and 29.
677
678
679
680 SYNOPSIS:
681
682 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
683
684 ARGUMENTS:
685
686 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
687 options for the x axis. The string can include any combination of
688 the following letters (upper or lower case) in any order: a: Draws
689 axis, X-axis is horizontal line (y=0), and Y-axis is vertical line
690 (x=0).
691 b: Draws bottom (X) or left (Y) edge of frame.
692 c: Draws top (X) or right (Y) edge of frame.
693 d: Plot labels as date / time. Values are assumed to be
694 seconds since the epoch (as used by gmtime).
695 f: Always use fixed point numeric labels.
696 g: Draws a grid at the major tick interval.
697 h: Draws a grid at the minor tick interval.
698 i: Inverts tick marks, so they are drawn outwards, rather than
699 inwards.
700 l: Labels axis logarithmically. This only affects the labels,
701 not the data, and so it is necessary to compute the logarithms
702 of data points before passing them to any of the drawing
703 routines.
704 m: Writes numeric labels at major tick intervals in the
705 unconventional location (above box for X, right of box for Y).
706 n: Writes numeric labels at major tick intervals in the
707 conventional location (below box for X, left of box for Y).
708 o: Use custom labelling function to generate axis label text.
709 The custom labelling function can be defined with the
710 plslabelfunc command.
711 s: Enables subticks between major ticks, only valid if t is
712 also specified.
713 t: Draws major ticks.
714 u: Exactly like "b" except don't draw edge line.
715 w: Exactly like "c" except don't draw edge line.
716 x: Exactly like "t" (including the side effect of the
717 numerical labels for the major ticks) except exclude drawing
718 the major and minor tick marks.
719
720
721 xtick (PLFLT, input) : World coordinate interval between major
722 ticks on the x axis. If it is set to zero, PLplot automatically
723 generates a suitable tick interval.
724
725 nxsub (PLINT, input) : Number of subintervals between major x axis
726 ticks for minor ticks. If it is set to zero, PLplot automatically
727 generates a suitable minor tick interval.
728
729 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
730 options for the y axis. The string can include any combination of
731 the letters defined above for xopt, and in addition may contain:
732 v: Write numeric labels for the y axis parallel to the base of the
733 graph, rather than parallel to the axis.
734
735
736 ytick (PLFLT, input) : World coordinate interval between major
737 ticks on the y axis. If it is set to zero, PLplot automatically
738 generates a suitable tick interval.
739
740 nysub (PLINT, input) : Number of subintervals between major y axis
741 ticks for minor ticks. If it is set to zero, PLplot automatically
742 generates a suitable minor tick interval.
743
744 """
745 return _plplotc.plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
746
747def plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz):
748 r"""
749 Draw a box with axes, etc, in 3-d
750
751 DESCRIPTION:
752
753 Draws axes, numeric and text labels for a three-dimensional surface
754 plot. For a more complete description of three-dimensional plotting
755 see the PLplot documentation.
756
757 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,
758 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
759
760
761 This function is used in examples 8, 11, 18, and 21.
762
763
764
765 SYNOPSIS:
766
767 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
768
769 ARGUMENTS:
770
771 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
772 options for the x axis. The string can include any combination of
773 the following letters (upper or lower case) in any order: b: Draws
774 axis at base, at height z=
775 zmin where zmin is defined by call to plw3d. This character must be
776 specified in order to use any of the other options.
777 d: Plot labels as date / time. Values are assumed to be
778 seconds since the epoch (as used by gmtime).
779 f: Always use fixed point numeric labels.
780 i: Inverts tick marks, so they are drawn downwards, rather
781 than upwards.
782 l: Labels axis logarithmically. This only affects the labels,
783 not the data, and so it is necessary to compute the logarithms
784 of data points before passing them to any of the drawing
785 routines.
786 n: Writes numeric labels at major tick intervals.
787 o: Use custom labelling function to generate axis label text.
788 The custom labelling function can be defined with the
789 plslabelfunc command.
790 s: Enables subticks between major ticks, only valid if t is
791 also specified.
792 t: Draws major ticks.
793 u: If this is specified, the text label for the axis is
794 written under the axis.
795
796
797 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
798 the text label for the x axis. It is only drawn if u is in the
799 xopt string.
800
801 xtick (PLFLT, input) : World coordinate interval between major
802 ticks on the x axis. If it is set to zero, PLplot automatically
803 generates a suitable tick interval.
804
805 nxsub (PLINT, input) : Number of subintervals between major x axis
806 ticks for minor ticks. If it is set to zero, PLplot automatically
807 generates a suitable minor tick interval.
808
809 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
810 options for the y axis. The string is interpreted in the same way
811 as xopt.
812
813 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
814 the text label for the y axis. It is only drawn if u is in the
815 yopt string.
816
817 ytick (PLFLT, input) : World coordinate interval between major
818 ticks on the y axis. If it is set to zero, PLplot automatically
819 generates a suitable tick interval.
820
821 nysub (PLINT, input) : Number of subintervals between major y axis
822 ticks for minor ticks. If it is set to zero, PLplot automatically
823 generates a suitable minor tick interval.
824
825 zopt (PLCHAR_VECTOR, input) : An ascii character string specifying
826 options for the z axis. The string can include any combination of
827 the following letters (upper or lower case) in any order: b: Draws
828 z axis to the left of the surface plot.
829 c: Draws z axis to the right of the surface plot.
830 d: Draws grid lines parallel to the x-y plane behind the
831 figure. These lines are not drawn until after plot3d or
832 plmesh are called because of the need for hidden line removal.
833 e: Plot labels as date / time. Values are assumed to be
834 seconds since the epoch (as used by gmtime). Note this
835 suboption is interpreted the same as the d suboption for xopt
836 and yopt, but it has to be identified as e for zopt since d
837 has already been used for the different purpose above.
838 f: Always use fixed point numeric labels.
839 i: Inverts tick marks, so they are drawn away from the center.
840 l: Labels axis logarithmically. This only affects the labels,
841 not the data, and so it is necessary to compute the logarithms
842 of data points before passing them to any of the drawing
843 routines.
844 m: Writes numeric labels at major tick intervals on the
845 right-hand z axis.
846 n: Writes numeric labels at major tick intervals on the
847 left-hand z axis.
848 o: Use custom labelling function to generate axis label text.
849 The custom labelling function can be defined with the
850 plslabelfunc command.
851 s: Enables subticks between major ticks, only valid if t is
852 also specified.
853 t: Draws major ticks.
854 u: If this is specified, the text label is written beside the
855 left-hand axis.
856 v: If this is specified, the text label is written beside the
857 right-hand axis.
858
859
860 zlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
861 the text label for the z axis. It is only drawn if u or v are in
862 the zopt string.
863
864 ztick (PLFLT, input) : World coordinate interval between major
865 ticks on the z axis. If it is set to zero, PLplot automatically
866 generates a suitable tick interval.
867
868 nzsub (PLINT, input) : Number of subintervals between major z axis
869 ticks for minor ticks. If it is set to zero, PLplot automatically
870 generates a suitable minor tick interval.
871
872 """
873 return _plplotc.plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz)
874
875def plcalc_world(rx, ry):
876 r"""
877 Calculate world coordinates and corresponding window index from relative device coordinates
878
879 DESCRIPTION:
880
881 Calculate world coordinates, wx and wy, and corresponding window index
882 from relative device coordinates, rx and ry.
883
884 Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
885
886
887 This function is used in example 31.
888
889
890
891 SYNOPSIS:
892
893 plcalc_world(rx, ry, wx, wy, window)
894
895 ARGUMENTS:
896
897 rx (PLFLT, input) : Input relative device coordinate (0.0-1.0) for
898 the x coordinate.
899
900 ry (PLFLT, input) : Input relative device coordinate (0.0-1.0) for
901 the y coordinate.
902
903 wx (PLFLT_NC_SCALAR, output) : Returned value of the x world
904 coordinate corresponding to the relative device coordinates rx and
905 ry.
906
907 wy (PLFLT_NC_SCALAR, output) : Returned value of the y world
908 coordinate corresponding to the relative device coordinates rx and
909 ry.
910
911 window (PLINT_NC_SCALAR, output) : Returned value of the last
912 defined window index that corresponds to the input relative device
913 coordinates (and the returned world coordinates). To give some
914 background on the window index, for each page the initial window
915 index is set to zero, and each time plwind is called within the
916 page, world and device coordinates are stored for the window and
917 the window index is incremented. Thus, for a simple page layout
918 with non-overlapping viewports and one window per viewport, window
919 corresponds to the viewport index (in the order which the
920 viewport/windows were created) of the only viewport/window
921 corresponding to rx and ry. However, for more complicated layouts
922 with potentially overlapping viewports and possibly more than one
923 window (set of world coordinates) per viewport, window and the
924 corresponding output world coordinates corresponds to the last
925 window created that fulfills the criterion that the relative
926 device coordinates are inside it. Finally, in all cases where the
927 input relative device coordinates are not inside any
928 viewport/window, then the returned value of the last defined
929 window index is set to -1.
930
931 """
932 return _plplotc.plcalc_world(rx, ry)
933
935 r"""
936 Clear current (sub)page
937
938 DESCRIPTION:
939
940 Clears the current page, effectively erasing everything that have been
941 drawn. This command only works with interactive drivers; if the
942 driver does not support this, the page is filled with the background
943 color in use. If the current page is divided into subpages, only the
944 current subpage is erased. The nth subpage can be selected with
945 pladv(n).
946
947 Redacted form: General: plclear()
948
949
950 This function is not used in any examples.
951
952
953
954 SYNOPSIS:
955
956 plclear()
957
958 """
959 return _plplotc.plclear()
960
961def plcol0(icol0):
962 r"""
963 Set color, cmap0
964
965 DESCRIPTION:
966
967 Sets the color index for cmap0 (see the PLplot documentation).
968
969 Redacted form: plcol0(icol0)
970
971 This function is used in examples 1-9, 11-16, 18-27, and 29.
972
973
974
975 SYNOPSIS:
976
977 plcol0(icol0)
978
979 ARGUMENTS:
980
981 icol0 (PLINT, input) : Integer representing the color. The
982 defaults at present are (these may change):
983 0 black (default background)
984 1 red (default foreground)
985 2 yellow
986 3 green
987 4 aquamarine
988 5 pink
989 6 wheat
990 7 grey
991 8 brown
992 9 blue
993 10 BlueViolet
994 11 cyan
995 12 turquoise
996 13 magenta
997 14 salmon
998 15 white
999
1000 Use plscmap0 to change the entire cmap0 color palette and plscol0 to
1001 change an individual color in the cmap0 color palette.
1002
1003 """
1004 return _plplotc.plcol0(icol0)
1005
1006def plcol1(col1):
1007 r"""
1008 Set color, cmap1
1009
1010 DESCRIPTION:
1011
1012 Sets the color for cmap1 (see the PLplot documentation).
1013
1014 Redacted form: plcol1(col1)
1015
1016 This function is used in examples 12 and 21.
1017
1018
1019
1020 SYNOPSIS:
1021
1022 plcol1(col1)
1023
1024 ARGUMENTS:
1025
1026 col1 (PLFLT, input) : This value must be in the range (0.0-1.0) and
1027 is mapped to color using the continuous cmap1 palette which by
1028 default ranges from blue to the background color to red. The
1029 cmap1 palette can also be straightforwardly changed by the user
1030 with plscmap1 or plscmap1l.
1031
1032 """
1033 return _plplotc.plcol1(col1)
1034
1035def plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec):
1036 r"""
1037 Configure the transformation between continuous and broken-down time for the current stream
1038
1039 DESCRIPTION:
1040
1041 Configure the transformation between continuous and broken-down time
1042 for the current stream. This transformation is used by both plbtime
1043 and plctime.
1044
1045 Redacted form: General: plconfigtime(scale, offset1, offset2,
1046 ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1047
1048
1049 This function is used in example 29.
1050
1051
1052
1053 SYNOPSIS:
1054
1055 plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1056
1057 ARGUMENTS:
1058
1059 scale (PLFLT, input) : The number of days per continuous time unit.
1060 As a special case, if
1061 scale is 0., then all other arguments are ignored, and the result (the
1062 default used by PLplot) is the equivalent of a call to
1063 plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.).
1064 That is, for this special case broken-down time is calculated with
1065 the proleptic Gregorian calendar with no leap seconds inserted,
1066 and the continuous time is defined as the number of seconds since
1067 the Unix epoch of 1970-01-01T00:00:00Z.
1068
1069 offset1 (PLFLT, input) : If
1070 ifbtime_offset is true, the parameters
1071 offset1 and
1072 offset2 are completely ignored. Otherwise, the sum of these parameters
1073 (with units in days) specify the epoch of the continuous time
1074 relative to the MJD epoch corresponding to the Gregorian calendar
1075 date of 1858-11-17T00:00:00Z or JD = 2400000.5. Two PLFLT numbers
1076 are used to specify the origin to allow users (by specifying
1077 offset1 as an integer that can be exactly represented by a
1078 floating-point variable and specifying
1079 offset2 as a number in the range from 0. to 1) the chance to minimize
1080 the numerical errors of the continuous time representation.
1081
1082 offset2 (PLFLT, input) : See documentation of
1083 offset1.
1084
1085 ccontrol (PLINT, input) : ccontrol contains bits controlling the
1086 transformation. If the 0x1 bit is set, then the proleptic Julian
1087 calendar is used for broken-down time rather than the proleptic
1088 Gregorian calendar. If the 0x2 bit is set, then leap seconds that
1089 have been historically used to define UTC are inserted into the
1090 broken-down time. Other possibilities for additional control bits
1091 for ccontrol exist such as making the historical time corrections
1092 in the broken-down time corresponding to ET (ephemeris time) or
1093 making the (slightly non-constant) corrections from international
1094 atomic time (TAI) to what astronomers define as terrestrial time
1095 (TT). But those additional possibilities have not been
1096 implemented yet in the qsastime library (one of the PLplot utility
1097 libraries).
1098
1099 ifbtime_offset (PLBOOL, input) : ifbtime_offset controls how the
1100 epoch of the continuous time scale is specified by the user. If
1101 ifbtime_offset is false, then
1102 offset1 and
1103 offset2 are used to specify the epoch, and the following broken-down
1104 time parameters are completely ignored. If
1105 ifbtime_offset is true, then
1106 offset1 and
1107 offset2 are completely ignored, and the following broken-down time
1108 parameters are used to specify the epoch.
1109
1110 year (PLINT, input) : Year of epoch.
1111
1112 month (PLINT, input) : Month of epoch in range from 0 (January) to
1113 11 (December).
1114
1115 day (PLINT, input) : Day of epoch in range from 1 to 31.
1116
1117 hour (PLINT, input) : Hour of epoch in range from 0 to 23
1118
1119 min (PLINT, input) : Minute of epoch in range from 0 to 59.
1120
1121 sec (PLFLT, input) : Second of epoch in range from 0. to 60.
1122
1123 """
1124 return _plplotc.plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1125
1126def plcont(*args):
1127 r"""
1128 Contour plot
1129
1130 DESCRIPTION:
1131
1132 Draws a contour plot of the data in f[
1133 nx][
1134 ny], using the nlevel contour levels specified by clevel. Only the
1135 region of the matrix from kx to lx and from ky to ly is plotted out
1136 where all these index ranges are interpreted as one-based for
1137 historical reasons. A transformation routine pointed to by pltr with
1138 a generic pointer pltr_data for additional data required by the
1139 transformation routine is used to map indices within the matrix to the
1140 world coordinates.
1141
1142 Redacted form: plcont(f, kx, lx, ky, ly, clevel, pltr, pltr_data)
1143 where (see above discussion) the pltr, pltr_data callback arguments
1144 are sometimes replaced by a tr vector with 6 elements; xg and yg
1145 vectors; or xg and yg matrices.
1146
1147 This function is used in examples 9, 14, 16, and 22.
1148
1149
1150
1151 SYNOPSIS:
1152
1153 plcont(f, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
1154
1155 ARGUMENTS:
1156
1157 f (PLFLT_MATRIX, input) : A matrix containing data to be contoured.
1158
1159 nx, ny (PLINT, input) : The dimensions of the matrix f.
1160
1161 kx, lx (PLINT, input) : Range of x indices to consider where 0 <=
1162 kx-1 < lx-1 < nx. Values of kx and lx are one-based rather than
1163 zero-based for historical backwards-compatibility reasons.
1164
1165 ky, ly (PLINT, input) : Range of y indices to consider where 0 <=
1166 ky-1 < ly-1 < ny. Values of ky and ly are one-based rather than
1167 zero-based for historical backwards-compatibility reasons.
1168
1169 clevel (PLFLT_VECTOR, input) : A vector specifying the levels at
1170 which to draw contours.
1171
1172 nlevel (PLINT, input) : Number of contour levels to draw.
1173
1174 pltr (PLTRANSFORM_callback, input) : A callback function that
1175 defines the transformation between the zero-based indices of the
1176 matrix f and the world coordinates.For the C case, transformation
1177 functions are provided in the PLplot library: pltr0 for the
1178 identity mapping, and pltr1 and pltr2 for arbitrary mappings
1179 respectively defined by vectors and matrices. In addition, C
1180 callback routines for the transformation can be supplied by the
1181 user such as the mypltr function in examples/c/x09c.c which
1182 provides a general linear transformation between index coordinates
1183 and world coordinates.For languages other than C you should
1184 consult the PLplot documentation for the details concerning how
1185 PLTRANSFORM_callback arguments are interfaced. However, in
1186 general, a particular pattern of callback-associated arguments
1187 such as a tr vector with 6 elements; xg and yg vectors; or xg and
1188 yg matrices are respectively interfaced to a linear-transformation
1189 routine similar to the above mypltr function; pltr1; and pltr2.
1190 Furthermore, some of our more sophisticated bindings (see, e.g.,
1191 the PLplot documentation) support native language callbacks for
1192 handling index to world-coordinate transformations. Examples of
1193 these various approaches are given in examples/<language>x09*,
1194 examples/<language>x16*, examples/<language>x20*,
1195 examples/<language>x21*, and examples/<language>x22*, for all our
1196 supported languages.
1197
1198 pltr_data (PLPointer, input) : Extra parameter to help pass
1199 information to pltr0, pltr1, pltr2, or whatever callback routine
1200 that is externally supplied.
1201
1202 """
1203 return _plplotc.plcont(*args)
1204
1205def plctime(year, month, day, hour, min, sec):
1206 r"""
1207 Calculate continuous time from broken-down time for the current stream
1208
1209 DESCRIPTION:
1210
1211 Calculate continuous time, ctime, from broken-down time for the
1212 current stream. The broken-down
1213 time is specified by the following parameters: year, month, day, hour,
1214 min, and sec. This function is the inverse of plbtime.
1215
1216 The PLplot definition of broken-down time is a calendar time that
1217 completely ignores all time zone offsets, i.e., it is the user's
1218 responsibility to apply those offsets (if so desired) before using the
1219 PLplot time API. By default broken-down time is defined using the
1220 proleptic Gregorian calendar without the insertion of leap seconds and
1221 continuous time is defined as the number of seconds since the Unix
1222 epoch of 1970-01-01T00:00:00Z. However, other definitions of
1223 broken-down and continuous time are possible, see plconfigtime which
1224 specifies that transformation for the current stream.
1225
1226 Redacted form: General: plctime(year, month, day, hour, min, sec,
1227 ctime)
1228
1229
1230 This function is used in example 29.
1231
1232
1233
1234 SYNOPSIS:
1235
1236 plctime(year, month, day, hour, min, sec, ctime)
1237
1238 ARGUMENTS:
1239
1240 year (PLINT, input) : Input year.
1241
1242 month (PLINT, input) : Input month in range from 0 (January) to 11
1243 (December).
1244
1245 day (PLINT, input) : Input day in range from 1 to 31.
1246
1247 hour (PLINT, input) : Input hour in range from 0 to 23
1248
1249 min (PLINT, input) : Input minute in range from 0 to 59.
1250
1251 sec (PLFLT, input) : Input second in range from 0. to 60.
1252
1253 ctime (PLFLT_NC_SCALAR, output) : Returned value of the continuous
1254 time calculated from the broken-down time specified by the
1255 previous parameters.
1256
1257 """
1258 return _plplotc.plctime(year, month, day, hour, min, sec)
1259
1260def plcpstrm(iplsr, flags):
1261 r"""
1262 Copy state parameters from the reference stream to the current stream
1263
1264 DESCRIPTION:
1265
1266 Copies state parameters from the reference stream to the current
1267 stream. Tell driver interface to map device coordinates unless flags
1268 == 1.
1269
1270 This function is used for making save files of selected plots (e.g.
1271 from the TK driver). After initializing, you can get a copy of the
1272 current plot to the specified device by switching to this stream and
1273 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as
1274 appropriate. The plot buffer must have previously been enabled (done
1275 automatically by some display drivers, such as X).
1276
1277 Redacted form: plcpstrm(iplsr, flags)
1278
1279 This function is used in example 1,20.
1280
1281
1282
1283 SYNOPSIS:
1284
1285 plcpstrm(iplsr, flags)
1286
1287 ARGUMENTS:
1288
1289 iplsr (PLINT, input) : Number of reference stream.
1290
1291 flags (PLBOOL, input) : If flags is set to true the device
1292 coordinates are not copied from the reference to current stream.
1293
1294 """
1295 return _plplotc.plcpstrm(iplsr, flags)
1296
1297def plend():
1298 r"""
1299 End plotting session
1300
1301 DESCRIPTION:
1302
1303 Ends a plotting session, tidies up all the output files, switches
1304 interactive devices back into text mode and frees up any memory that
1305 was allocated. Must be called before end of program.
1306
1307 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a
1308 wait state after a call to plend or other functions which trigger the
1309 end of a plot page. To avoid this, use the plspause function.
1310
1311 Redacted form: plend()
1312
1313 This function is used in all of the examples.
1314
1315
1316
1317 SYNOPSIS:
1318
1319 plend()
1320
1321 """
1322 return _plplotc.plend()
1323
1325 r"""
1326 End plotting session for current stream
1327
1328 DESCRIPTION:
1329
1330 Ends a plotting session for the current output stream only. See
1331 plsstrm for more info.
1332
1333 Redacted form: plend1()
1334
1335 This function is used in examples 1 and 20.
1336
1337
1338
1339 SYNOPSIS:
1340
1341 plend1()
1342
1343 """
1344 return _plplotc.plend1()
1345
1346def plenv(xmin, xmax, ymin, ymax, just, axis):
1347 r"""
1348 Set up standard window and draw box
1349
1350 DESCRIPTION:
1351
1352 Sets up plotter environment for simple graphs by calling pladv and
1353 setting up viewport and window to sensible default values. plenv
1354 leaves a standard margin (left-hand margin of eight character heights,
1355 and a margin around the other three sides of five character heights)
1356 around most graphs for axis labels and a title. When these defaults
1357 are not suitable, use the individual routines plvpas, plvpor, or
1358 plvasp for setting up the viewport, plwind for defining the window,
1359 and plbox for drawing the box.
1360
1361 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis)
1362
1363 This function is used in example 1,3,9,13,14,19-22,29.
1364
1365
1366
1367 SYNOPSIS:
1368
1369 plenv(xmin, xmax, ymin, ymax, just, axis)
1370
1371 ARGUMENTS:
1372
1373 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1374 world coordinates).
1375
1376 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1377 world coordinates).
1378
1379 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1380 coordinates).
1381
1382 ymax (PLFLT, input) : Value of y at top edge of window (in world
1383 coordinates).
1384
1385 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1386 scales will not be set, the user must set up the scale before
1387 calling plenv using plsvpa, plvasp or other.
1388 0: the x and y axes are scaled independently to use as much of
1389 the screen as possible.
1390 1: the scales of the x and y axes are made equal.
1391 2: the axis of the x and y axes are made equal, and the plot
1392 box will be square.
1393
1394
1395 axis (PLINT, input) : Controls drawing of the box around the plot:
1396 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1397 -1: draw box only.
1398 0: draw box, ticks, and numeric tick labels.
1399 1: also draw coordinate axes at x=0 and y=0.
1400 2: also draw a grid at major tick positions in both
1401 coordinates.
1402 3: also draw a grid at minor tick positions in both
1403 coordinates.
1404 10: same as 0 except logarithmic x tick marks. (The x data
1405 have to be converted to logarithms separately.)
1406 11: same as 1 except logarithmic x tick marks. (The x data
1407 have to be converted to logarithms separately.)
1408 12: same as 2 except logarithmic x tick marks. (The x data
1409 have to be converted to logarithms separately.)
1410 13: same as 3 except logarithmic x tick marks. (The x data
1411 have to be converted to logarithms separately.)
1412 20: same as 0 except logarithmic y tick marks. (The y data
1413 have to be converted to logarithms separately.)
1414 21: same as 1 except logarithmic y tick marks. (The y data
1415 have to be converted to logarithms separately.)
1416 22: same as 2 except logarithmic y tick marks. (The y data
1417 have to be converted to logarithms separately.)
1418 23: same as 3 except logarithmic y tick marks. (The y data
1419 have to be converted to logarithms separately.)
1420 30: same as 0 except logarithmic x and y tick marks. (The x
1421 and y data have to be converted to logarithms separately.)
1422 31: same as 1 except logarithmic x and y tick marks. (The x
1423 and y data have to be converted to logarithms separately.)
1424 32: same as 2 except logarithmic x and y tick marks. (The x
1425 and y data have to be converted to logarithms separately.)
1426 33: same as 3 except logarithmic x and y tick marks. (The x
1427 and y data have to be converted to logarithms separately.)
1428 40: same as 0 except date / time x labels.
1429 41: same as 1 except date / time x labels.
1430 42: same as 2 except date / time x labels.
1431 43: same as 3 except date / time x labels.
1432 50: same as 0 except date / time y labels.
1433 51: same as 1 except date / time y labels.
1434 52: same as 2 except date / time y labels.
1435 53: same as 3 except date / time y labels.
1436 60: same as 0 except date / time x and y labels.
1437 61: same as 1 except date / time x and y labels.
1438 62: same as 2 except date / time x and y labels.
1439 63: same as 3 except date / time x and y labels.
1440 70: same as 0 except custom x and y labels.
1441 71: same as 1 except custom x and y labels.
1442 72: same as 2 except custom x and y labels.
1443 73: same as 3 except custom x and y labels.
1444
1445 """
1446 return _plplotc.plenv(xmin, xmax, ymin, ymax, just, axis)
1447
1448def plenv0(xmin, xmax, ymin, ymax, just, axis):
1449 r"""
1450 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it
1451
1452 DESCRIPTION:
1453
1454 Sets up plotter environment for simple graphs by calling pladv and
1455 setting up viewport and window to sensible default values. plenv0
1456 leaves a standard margin (left-hand margin of eight character heights,
1457 and a margin around the other three sides of five character heights)
1458 around most graphs for axis labels and a title. When these defaults
1459 are not suitable, use the individual routines plvpas, plvpor, or
1460 plvasp for setting up the viewport, plwind for defining the window,
1461 and plbox for drawing the box.
1462
1463 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis)
1464
1465 This function is used in example 21.
1466
1467
1468
1469 SYNOPSIS:
1470
1471 plenv0(xmin, xmax, ymin, ymax, just, axis)
1472
1473 ARGUMENTS:
1474
1475 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
1476 world coordinates).
1477
1478 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
1479 world coordinates).
1480
1481 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
1482 coordinates).
1483
1484 ymax (PLFLT, input) : Value of y at top edge of window (in world
1485 coordinates).
1486
1487 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1488 scales will not be set, the user must set up the scale before
1489 calling plenv0 using plsvpa, plvasp or other.
1490 0: the x and y axes are scaled independently to use as much of
1491 the screen as possible.
1492 1: the scales of the x and y axes are made equal.
1493 2: the axis of the x and y axes are made equal, and the plot
1494 box will be square.
1495
1496
1497 axis (PLINT, input) : Controls drawing of the box around the plot:
1498 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1499 -1: draw box only.
1500 0: draw box, ticks, and numeric tick labels.
1501 1: also draw coordinate axes at x=0 and y=0.
1502 2: also draw a grid at major tick positions in both
1503 coordinates.
1504 3: also draw a grid at minor tick positions in both
1505 coordinates.
1506 10: same as 0 except logarithmic x tick marks. (The x data
1507 have to be converted to logarithms separately.)
1508 11: same as 1 except logarithmic x tick marks. (The x data
1509 have to be converted to logarithms separately.)
1510 12: same as 2 except logarithmic x tick marks. (The x data
1511 have to be converted to logarithms separately.)
1512 13: same as 3 except logarithmic x tick marks. (The x data
1513 have to be converted to logarithms separately.)
1514 20: same as 0 except logarithmic y tick marks. (The y data
1515 have to be converted to logarithms separately.)
1516 21: same as 1 except logarithmic y tick marks. (The y data
1517 have to be converted to logarithms separately.)
1518 22: same as 2 except logarithmic y tick marks. (The y data
1519 have to be converted to logarithms separately.)
1520 23: same as 3 except logarithmic y tick marks. (The y data
1521 have to be converted to logarithms separately.)
1522 30: same as 0 except logarithmic x and y tick marks. (The x
1523 and y data have to be converted to logarithms separately.)
1524 31: same as 1 except logarithmic x and y tick marks. (The x
1525 and y data have to be converted to logarithms separately.)
1526 32: same as 2 except logarithmic x and y tick marks. (The x
1527 and y data have to be converted to logarithms separately.)
1528 33: same as 3 except logarithmic x and y tick marks. (The x
1529 and y data have to be converted to logarithms separately.)
1530 40: same as 0 except date / time x labels.
1531 41: same as 1 except date / time x labels.
1532 42: same as 2 except date / time x labels.
1533 43: same as 3 except date / time x labels.
1534 50: same as 0 except date / time y labels.
1535 51: same as 1 except date / time y labels.
1536 52: same as 2 except date / time y labels.
1537 53: same as 3 except date / time y labels.
1538 60: same as 0 except date / time x and y labels.
1539 61: same as 1 except date / time x and y labels.
1540 62: same as 2 except date / time x and y labels.
1541 63: same as 3 except date / time x and y labels.
1542 70: same as 0 except custom x and y labels.
1543 71: same as 1 except custom x and y labels.
1544 72: same as 2 except custom x and y labels.
1545 73: same as 3 except custom x and y labels.
1546
1547 """
1548 return _plplotc.plenv0(xmin, xmax, ymin, ymax, just, axis)
1549
1550def pleop():
1551 r"""
1552 Eject current page
1553
1554 DESCRIPTION:
1555
1556 Clears the graphics screen of an interactive device, or ejects a page
1557 on a plotter. See plbop for more information.
1558
1559 Redacted form: pleop()
1560
1561 This function is used in example 2,14.
1562
1563
1564
1565 SYNOPSIS:
1566
1567 pleop()
1568
1569 """
1570 return _plplotc.pleop()
1571
1572def plerrx(n, arg2, arg3):
1573 r"""
1574 Draw error bars in x direction
1575
1576 DESCRIPTION:
1577
1578 Draws a set of n error bars in x direction, the i'th error bar
1579 extending from xmin[i] to xmax[i] at y coordinate y[i]. The terminals
1580 of the error bars are of length equal to the minor tick length
1581 (settable using plsmin).
1582
1583 Redacted form: General: plerrx(xmin, ymax, y)
1584
1585
1586 This function is used in example 29.
1587
1588
1589
1590 SYNOPSIS:
1591
1592 plerrx(n, xmin, xmax, y)
1593
1594 ARGUMENTS:
1595
1596 n (PLINT, input) : Number of error bars to draw.
1597
1598 xmin (PLFLT_VECTOR, input) : A vector containing the x coordinates
1599 of the left-hand endpoints of the error bars.
1600
1601 xmax (PLFLT_VECTOR, input) : A vector containing the x coordinates
1602 of the right-hand endpoints of the error bars.
1603
1604 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1605 the error bars.
1606
1607 """
1608 return _plplotc.plerrx(n, arg2, arg3)
1609
1610def plerry(n, arg2, arg3):
1611 r"""
1612 Draw error bars in the y direction
1613
1614 DESCRIPTION:
1615
1616 Draws a set of n error bars in the y direction, the i'th error bar
1617 extending from ymin[i] to ymax[i] at x coordinate x[i]. The terminals
1618 of the error bars are of length equal to the minor tick length
1619 (settable using plsmin).
1620
1621 Redacted form: General: plerry(x, ymin, ymax)
1622
1623
1624 This function is used in example 29.
1625
1626
1627
1628 SYNOPSIS:
1629
1630 plerry(n, x, ymin, ymax)
1631
1632 ARGUMENTS:
1633
1634 n (PLINT, input) : Number of error bars to draw.
1635
1636 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1637 the error bars.
1638
1639 ymin (PLFLT_VECTOR, input) : A vector containing the y coordinates
1640 of the lower endpoints of the error bars.
1641
1642 ymax (PLFLT_VECTOR, input) : A vector containing the y coordinates
1643 of the upper endpoints of the error bars.
1644
1645 """
1646 return _plplotc.plerry(n, arg2, arg3)
1647
1649 r"""
1650 Advance to the next family file on the next new page
1651
1652 DESCRIPTION:
1653
1654 Advance to the next family file on the next new page.
1655
1656 Redacted form: plfamadv()
1657
1658 This function is not used in any examples.
1659
1660
1661
1662 SYNOPSIS:
1663
1664 plfamadv()
1665
1666 """
1667 return _plplotc.plfamadv()
1668
1669def plfill(n, ArrayCk):
1670 r"""
1671 Draw filled polygon
1672
1673 DESCRIPTION:
1674
1675 Fills the polygon defined by the n points (
1676 x[i],
1677 y[i]) using the pattern defined by plpsty or plpat. The default fill
1678 style is a solid fill. The routine will automatically close the
1679 polygon between the last and first vertices. If multiple closed
1680 polygons are passed in x and y then plfill will fill in between them.
1681
1682 Redacted form: plfill(x,y)
1683
1684 This function is used in examples 12, 13, 15, 16, 21, 24, and 25.
1685
1686
1687
1688 SYNOPSIS:
1689
1690 plfill(n, x, y)
1691
1692 ARGUMENTS:
1693
1694 n (PLINT, input) : Number of vertices in polygon.
1695
1696 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1697 vertices.
1698
1699 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1700 vertices.
1701
1702 """
1703 return _plplotc.plfill(n, ArrayCk)
1704
1705def plfill3(n, arg2, arg3):
1706 r"""
1707 Draw filled polygon in 3D
1708
1709 DESCRIPTION:
1710
1711 Fills the 3D polygon defined by the n points in the x, y, and z
1712 vectors using the pattern defined by plpsty or plpat. The routine
1713 will automatically close the polygon between the last and first
1714 vertices. If multiple closed polygons are passed in x, y, and z then
1715 plfill3 will fill in between them.
1716
1717 Redacted form: General: plfill3(x, y, z)
1718
1719
1720 This function is used in example 15.
1721
1722
1723
1724 SYNOPSIS:
1725
1726 plfill3(n, x, y, z)
1727
1728 ARGUMENTS:
1729
1730 n (PLINT, input) : Number of vertices in polygon.
1731
1732 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1733 vertices.
1734
1735 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1736 vertices.
1737
1738 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
1739 vertices.
1740
1741 """
1742 return _plplotc.plfill3(n, arg2, arg3)
1743
1744def plgradient(n, ArrayCk, angle):
1745 r"""
1746 Draw linear gradient inside polygon
1747
1748 DESCRIPTION:
1749
1750 Draw a linear gradient using cmap1 inside the polygon defined by the n
1751 points (
1752 x[i],
1753 y[i]). Interpretation of the polygon is the same as for plfill. The
1754 polygon coordinates and the gradient angle are all expressed in world
1755 coordinates. The angle from the x axis for both the rotated
1756 coordinate system and the gradient vector is specified by angle. The
1757 magnitude of the gradient vector is the difference between the maximum
1758 and minimum values of x for the vertices in the rotated coordinate
1759 system. The origin of the gradient vector can be interpreted as being
1760 anywhere on the line corresponding to the minimum x value for the
1761 vertices in the rotated coordinate system. The distance along the
1762 gradient vector is linearly transformed to the independent variable of
1763 color map 1 which ranges from 0. at the tail of the gradient vector to
1764 1. at the head of the gradient vector. What is drawn is the RGBA
1765 color corresponding to the independent variable of cmap1. For more
1766 information about cmap1 (see the PLplot documentation).
1767
1768 Redacted form: plgradient(x,y,angle)
1769
1770 This function is used in examples 25 and 30.
1771
1772
1773
1774 SYNOPSIS:
1775
1776 plgradient(n, x, y, angle)
1777
1778 ARGUMENTS:
1779
1780 n (PLINT, input) : Number of vertices in polygon.
1781
1782 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1783 vertices.
1784
1785 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1786 vertices.
1787
1788 angle (PLFLT, input) : Angle (degrees) of gradient vector from x
1789 axis.
1790
1791 """
1792 return _plplotc.plgradient(n, ArrayCk, angle)
1793
1795 r"""
1796 Flushes the output stream
1797
1798 DESCRIPTION:
1799
1800 Flushes the output stream. Use sparingly, if at all.
1801
1802 Redacted form: plflush()
1803
1804 This function is used in examples 1 and 14.
1805
1806
1807
1808 SYNOPSIS:
1809
1810 plflush()
1811
1812 """
1813 return _plplotc.plflush()
1814
1815def plfont(ifont):
1816 r"""
1817 Set font
1818
1819 DESCRIPTION:
1820
1821 Sets the font used for subsequent text and symbols. For devices that
1822 still use Hershey fonts this routine has no effect unless the Hershey
1823 fonts with extended character set are loaded (see plfontld). For
1824 unicode-aware devices that use system fonts instead of Hershey fonts,
1825 this routine calls the plsfci routine with argument set up
1826 appropriately for the various cases below. However, this method of
1827 specifying the font for unicode-aware devices is deprecated, and the
1828 much more flexible method of calling plsfont directly is recommended
1829 instead (where plsfont provides a user-friendly interface to plsfci),
1830
1831 Redacted form: plfont(ifont)
1832
1833 This function is used in examples 1, 2, 4, 7, 13, 24, and 26.
1834
1835
1836
1837 SYNOPSIS:
1838
1839 plfont(ifont)
1840
1841 ARGUMENTS:
1842
1843 ifont (PLINT, input) : Specifies the font: 1: Sans serif font
1844 (simplest and fastest)
1845 2: Serif font
1846 3: Italic font
1847 4: Script font
1848
1849 """
1850 return _plplotc.plfont(ifont)
1851
1852def plfontld(fnt):
1853 r"""
1854 Load Hershey fonts
1855
1856 DESCRIPTION:
1857
1858 Loads the Hershey fonts used for text and symbols. This routine may
1859 be called before or after initializing PLplot. If not explicitly
1860 called before PLplot initialization, then by default that
1861 initialization loads Hershey fonts with the extended character set.
1862 This routine only has a practical effect for devices that still use
1863 Hershey fonts (as opposed to modern devices that use unicode-aware
1864 system fonts instead of Hershey fonts).
1865
1866 Redacted form: plfontld(fnt)
1867
1868 This function is used in examples 1 and 7.
1869
1870
1871
1872 SYNOPSIS:
1873
1874 plfontld(fnt)
1875
1876 ARGUMENTS:
1877
1878 fnt (PLINT, input) : Specifies the type of Hershey fonts to load.
1879 A zero value specifies Hershey fonts with the standard character
1880 set and a non-zero value (the default assumed if plfontld is never
1881 called) specifies Hershey fonts with the extended character set.
1882
1883 """
1884 return _plplotc.plfontld(fnt)
1885
1887 r"""
1888 Get character default height and current (scaled) height
1889
1890 DESCRIPTION:
1891
1892 Get character default height and current (scaled) height.
1893
1894 Redacted form: plgchr(p_def, p_ht)
1895
1896 This function is used in example 23.
1897
1898
1899
1900 SYNOPSIS:
1901
1902 plgchr(p_def, p_ht)
1903
1904 ARGUMENTS:
1905
1906 p_def (PLFLT_NC_SCALAR, output) : Returned value of the default
1907 character height (mm).
1908
1909 p_ht (PLFLT_NC_SCALAR, output) : Returned value of the scaled
1910 character height (mm).
1911
1912 """
1913 return _plplotc.plgchr()
1914
1915def plgcol0(icol0):
1916 r"""
1917 Returns 8-bit RGB values for given color index from cmap0
1918
1919 DESCRIPTION:
1920
1921 Returns 8-bit RGB values (0-255) for given color from cmap0 (see the
1922 PLplot documentation). Values are negative if an invalid color id is
1923 given.
1924
1925 Redacted form: plgcol0(icol0, r, g, b)
1926
1927 This function is used in example 2.
1928
1929
1930
1931 SYNOPSIS:
1932
1933 plgcol0(icol0, r, g, b)
1934
1935 ARGUMENTS:
1936
1937 icol0 (PLINT, input) : Index of desired cmap0 color.
1938
1939 r (PLINT_NC_SCALAR, output) : Returned value of the 8-bit red
1940 value.
1941
1942 g (PLINT_NC_SCALAR, output) : Returned value of the 8-bit green
1943 value.
1944
1945 b (PLINT_NC_SCALAR, output) : Returned value of the 8-bit blue
1946 value.
1947
1948 """
1949 return _plplotc.plgcol0(icol0)
1950
1951def plgcol0a(icol0):
1952 r"""
1953 Returns 8-bit RGB values and PLFLT alpha transparency value for given color index from cmap0
1954
1955 DESCRIPTION:
1956
1957 Returns 8-bit RGB values (0-255) and PLFLT alpha transparency value
1958 (0.0-1.0) for given color from cmap0 (see the PLplot documentation).
1959 Values are negative if an invalid color id is given.
1960
1961 Redacted form: plgcola(r, g, b)
1962
1963 This function is used in example 30.
1964
1965
1966
1967 SYNOPSIS:
1968
1969 plgcol0a(icol0, r, g, b, alpha)
1970
1971 ARGUMENTS:
1972
1973 icol0 (PLINT, input) : Index of desired cmap0 color.
1974
1975 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
1976 in the range from 0 to 255.
1977
1978 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
1979 in the range from 0 to 255.
1980
1981 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
1982 in the range from 0 to 255.
1983
1984 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
1985 transparency in the range from (0.0-1.0).
1986
1987 """
1988 return _plplotc.plgcol0a(icol0)
1989
1991 r"""
1992 Returns the background color (cmap0[0]) by 8-bit RGB value
1993
1994 DESCRIPTION:
1995
1996 Returns the background color (cmap0[0]) by 8-bit RGB value.
1997
1998 Redacted form: plgcolbg(r, g, b)
1999
2000 This function is used in example 31.
2001
2002
2003
2004 SYNOPSIS:
2005
2006 plgcolbg(r, g, b)
2007
2008 ARGUMENTS:
2009
2010 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2011 in the range from 0 to 255.
2012
2013 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2014 in the range from 0 to 255.
2015
2016 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2017 in the range from 0 to 255.
2018
2019 """
2020 return _plplotc.plgcolbg()
2021
2023 r"""
2024 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT alpha transparency value
2025
2026 DESCRIPTION:
2027
2028 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT
2029 alpha transparency value.
2030
2031 This function is used in example 31.
2032
2033
2034
2035 SYNOPSIS:
2036
2037 plgcolbga(r, g, b, alpha)
2038
2039 ARGUMENTS:
2040
2041 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2042 in the range from 0 to 255.
2043
2044 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2045 in the range from 0 to 255.
2046
2047 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2048 in the range from 0 to 255.
2049
2050 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
2051 transparency in the range (0.0-1.0).
2052
2053 """
2054 return _plplotc.plgcolbga()
2055
2057 r"""
2058 Get the current device-compression setting
2059
2060 DESCRIPTION:
2061
2062 Get the current device-compression setting. This parameter is only
2063 used for drivers that provide compression.
2064
2065 Redacted form: plgcompression(compression)
2066
2067 This function is used in example 31.
2068
2069
2070
2071 SYNOPSIS:
2072
2073 plgcompression(compression)
2074
2075 ARGUMENTS:
2076
2077 compression (PLINT_NC_SCALAR, output) : Returned value of the
2078 compression setting for the current device.
2079
2080 """
2081 return _plplotc.plgcompression()
2082
2084 r"""
2085 Get the current device (keyword) name
2086
2087 DESCRIPTION:
2088
2089 Get the current device (keyword) name. Note: you must have allocated
2090 space for this (80 characters is safe).
2091
2092 Redacted form: plgdev(p_dev)
2093
2094 This function is used in example 14.
2095
2096
2097
2098 SYNOPSIS:
2099
2100 plgdev(p_dev)
2101
2102 ARGUMENTS:
2103
2104 p_dev (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2105 (with preallocated length of 80 characters or more) containing the
2106 device (keyword) name.
2107
2108 """
2109 return _plplotc.plgdev()
2110
2112 r"""
2113 Get parameters that define current device-space window
2114
2115 DESCRIPTION:
2116
2117 Get relative margin width, aspect ratio, and relative justification
2118 that define current device-space window. If plsdidev has not been
2119 called the default values pointed to by p_mar, p_aspect, p_jx, and
2120 p_jy will all be 0.
2121
2122 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy)
2123
2124 This function is used in example 31.
2125
2126
2127
2128 SYNOPSIS:
2129
2130 plgdidev(p_mar, p_aspect, p_jx, p_jy)
2131
2132 ARGUMENTS:
2133
2134 p_mar (PLFLT_NC_SCALAR, output) : Returned value of the relative
2135 margin width.
2136
2137 p_aspect (PLFLT_NC_SCALAR, output) : Returned value of the aspect
2138 ratio.
2139
2140 p_jx (PLFLT_NC_SCALAR, output) : Returned value of the relative
2141 justification in x.
2142
2143 p_jy (PLFLT_NC_SCALAR, output) : Returned value of the relative
2144 justification in y.
2145
2146 """
2147 return _plplotc.plgdidev()
2148
2150 r"""
2151 Get plot orientation
2152
2153 DESCRIPTION:
2154
2155 Get plot orientation parameter which is multiplied by 90 degrees to
2156 obtain the angle of rotation. Note, arbitrary rotation parameters
2157 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
2158 values for the rotation parameter are 0., 1., 2., and 3. corresponding
2159 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
2160 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has
2161 not been called the default value pointed to by p_rot will be 0.
2162
2163 Redacted form: plgdiori(p_rot)
2164
2165 This function is not used in any examples.
2166
2167
2168
2169 SYNOPSIS:
2170
2171 plgdiori(p_rot)
2172
2173 ARGUMENTS:
2174
2175 p_rot (PLFLT_NC_SCALAR, output) : Returned value of the orientation
2176 parameter.
2177
2178 """
2179 return _plplotc.plgdiori()
2180
2182 r"""
2183 Get parameters that define current plot-space window
2184
2185 DESCRIPTION:
2186
2187 Get relative minima and maxima that define current plot-space window.
2188 If plsdiplt has not been called the default values pointed to by
2189 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1.
2190
2191 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2192
2193 This function is used in example 31.
2194
2195
2196
2197 SYNOPSIS:
2198
2199 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2200
2201 ARGUMENTS:
2202
2203 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2204 minimum in x.
2205
2206 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2207 minimum in y.
2208
2209 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2210 maximum in x.
2211
2212 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2213 maximum in y.
2214
2215 """
2216 return _plplotc.plgdiplt()
2217
2219 r"""
2220 Get family file parameters
2221
2222 DESCRIPTION:
2223
2224 Gets information about current family file, if familying is enabled.
2225 See the PLplot documentation for more information.
2226
2227 Redacted form: plgfam(p_fam, p_num, p_bmax)
2228
2229 This function is used in examples 14 and 31.
2230
2231
2232
2233 SYNOPSIS:
2234
2235 plgfam(p_fam, p_num, p_bmax)
2236
2237 ARGUMENTS:
2238
2239 p_fam (PLINT_NC_SCALAR, output) : Returned value of the current
2240 family flag value. If nonzero, familying is enabled for the
2241 current device.
2242
2243 p_num (PLINT_NC_SCALAR, output) : Returned value of the current
2244 family file number.
2245
2246 p_bmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2247 file size (in bytes) for a family file.
2248
2249 """
2250 return _plplotc.plgfam()
2251
2253 r"""
2254 Get FCI (font characterization integer)
2255
2256 DESCRIPTION:
2257
2258 Gets information about the current font using the FCI approach. See
2259 the PLplot documentation for more information.
2260
2261 Redacted form: plgfci(p_fci)
2262
2263 This function is used in example 23.
2264
2265
2266
2267 SYNOPSIS:
2268
2269 plgfci(p_fci)
2270
2271 ARGUMENTS:
2272
2273 p_fci (PLUNICODE_NC_SCALAR, output) : Returned value of the current
2274 FCI value.
2275
2276 """
2277 return _plplotc.plgfci()
2278
2280 r"""
2281 Get output file name
2282
2283 DESCRIPTION:
2284
2285 Gets the current output file name, if applicable.
2286
2287 Redacted form: plgfnam(fnam)
2288
2289 This function is used in example 31.
2290
2291
2292
2293 SYNOPSIS:
2294
2295 plgfnam(fnam)
2296
2297 ARGUMENTS:
2298
2299 fnam (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2300 (with preallocated length of 80 characters or more) containing the
2301 file name.
2302
2303 """
2304 return _plplotc.plgfnam()
2305
2307 r"""
2308 Get family, style and weight of the current font
2309
2310 DESCRIPTION:
2311
2312 Gets information about current font. See the PLplot documentation for
2313 more information on font selection.
2314
2315 Redacted form: plgfont(p_family, p_style, p_weight)
2316
2317 This function is used in example 23.
2318
2319
2320
2321 SYNOPSIS:
2322
2323 plgfont(p_family, p_style, p_weight)
2324
2325 ARGUMENTS:
2326
2327 p_family (PLINT_NC_SCALAR, output) : Returned value of the current
2328 font family. The available values are given by the PL_FCI_*
2329 constants in plplot.h. Current options are PL_FCI_SANS,
2330 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If
2331 p_family is NULL then the font family is not returned.
2332
2333 p_style (PLINT_NC_SCALAR, output) : Returned value of the current
2334 font style. The available values are given by the PL_FCI_*
2335 constants in plplot.h. Current options are PL_FCI_UPRIGHT,
2336 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the font
2337 style is not returned.
2338
2339 p_weight (PLINT_NC_SCALAR, output) : Returned value of the current
2340 font weight. The available values are given by the PL_FCI_*
2341 constants in plplot.h. Current options are PL_FCI_MEDIUM and
2342 PL_FCI_BOLD. If p_weight is NULL then the font weight is not
2343 returned.
2344
2345 """
2346 return _plplotc.plgfont()
2347
2349 r"""
2350 Get the (current) run level
2351
2352 DESCRIPTION:
2353
2354 Get the (current) run level. Valid settings are: 0, uninitialized
2355 1, initialized
2356 2, viewport defined
2357 3, world coordinates defined
2358
2359
2360 Redacted form: plglevel(p_level)
2361
2362 This function is used in example 31.
2363
2364
2365
2366 SYNOPSIS:
2367
2368 plglevel(p_level)
2369
2370 ARGUMENTS:
2371
2372 p_level (PLINT_NC_SCALAR, output) : Returned value of the run
2373 level.
2374
2375 """
2376 return _plplotc.plglevel()
2377
2379 r"""
2380 Get page parameters
2381
2382 DESCRIPTION:
2383
2384 Gets the current page configuration. The length and offset values are
2385 expressed in units that are specific to the current driver. For
2386 instance: screen drivers will usually interpret them as number of
2387 pixels, whereas printer drivers will usually use mm.
2388
2389 Redacted form: plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2390
2391 This function is used in examples 14 and 31.
2392
2393
2394
2395 SYNOPSIS:
2396
2397 plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2398
2399 ARGUMENTS:
2400
2401 p_xp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2402 pixels/inch (DPI) in x.
2403
2404 p_yp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2405 pixels/inch (DPI) in y.
2406
2407 p_xleng (PLINT_NC_SCALAR, output) : Returned value of the x page
2408 length.
2409
2410 p_yleng (PLINT_NC_SCALAR, output) : Returned value of the y page
2411 length.
2412
2413 p_xoff (PLINT_NC_SCALAR, output) : Returned value of the x page
2414 offset.
2415
2416 p_yoff (PLINT_NC_SCALAR, output) : Returned value of the y page
2417 offset.
2418
2419 """
2420 return _plplotc.plgpage()
2421
2422def plgra():
2423 r"""
2424 Switch to graphics screen
2425
2426 DESCRIPTION:
2427
2428 Sets an interactive device to graphics mode, used in conjunction with
2429 pltext to allow graphics and text to be interspersed. On a device
2430 which supports separate text and graphics windows, this command causes
2431 control to be switched to the graphics window. If already in graphics
2432 mode, this command is ignored. It is also ignored on devices which
2433 only support a single window or use a different method for shifting
2434 focus. See also pltext.
2435
2436 Redacted form: plgra()
2437
2438 This function is used in example 1.
2439
2440
2441
2442 SYNOPSIS:
2443
2444 plgra()
2445
2446 """
2447 return _plplotc.plgra()
2448
2449def plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data):
2450 r"""
2451 Grid data from irregularly sampled data
2452
2453 DESCRIPTION:
2454
2455 Real world data is frequently irregularly sampled, but PLplot 3D plots
2456 require data organized as a grid, i.e., with x sample point values
2457 independent of y coordinate and vice versa. This function takes
2458 irregularly sampled data from the x[npts], y[npts], and z[npts]
2459 vectors; reads the desired grid location from the input vectors
2460 xg[nptsx] and yg[nptsy]; and returns the interpolated result on that
2461 grid using the output matrix zg[nptsx][nptsy]. The algorithm used to
2462 interpolate the data to the grid is specified with the argument type
2463 which can have one parameter specified in argument data.
2464
2465 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data)
2466 Python: zg=plgriddata(x, y, z, xg, yg, type, data)
2467
2468
2469 This function is used in example 21.
2470
2471
2472
2473 SYNOPSIS:
2474
2475 plgriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
2476
2477 ARGUMENTS:
2478
2479 x (PLFLT_VECTOR, input) : The input x vector.
2480
2481 y (PLFLT_VECTOR, input) : The input y vector.
2482
2483 z (PLFLT_VECTOR, input) : The input z vector. Each triple x[i],
2484 y[i], z[i] represents one data sample coordinate.
2485
2486 npts (PLINT, input) : The number of data samples in the x, y and z
2487 vectors.
2488
2489 xg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2490 in the x direction. Usually xg has nptsx equally spaced values
2491 from the minimum to the maximum values of the x input vector.
2492
2493 nptsx (PLINT, input) : The number of points in the xg vector.
2494
2495 yg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2496 in the y direction. Similar to the xg parameter.
2497
2498 nptsy (PLINT, input) : The number of points in the yg vector.
2499
2500 zg (PLFLT_NC_MATRIX, output) : The matrix of interpolated results
2501 where data lies in the grid specified by xg and yg. Therefore the
2502 zg matrix must be dimensioned
2503 nptsx by
2504 nptsy.
2505
2506 type (PLINT, input) : The type of grid interpolation algorithm to
2507 use, which can be: GRID_CSA: Bivariate Cubic Spline approximation
2508 GRID_DTLI: Delaunay Triangulation Linear Interpolation
2509 GRID_NNI: Natural Neighbors Interpolation
2510 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
2511 GRID_NNLI: Nearest Neighbors Linear Interpolation
2512 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
2513 Weighted
2514 For details of the algorithms read the source file plgridd.c.
2515
2516 data (PLFLT, input) : Some gridding algorithms require extra data,
2517 which can be specified through this argument. Currently, for
2518 algorithm: GRID_NNIDW, data specifies the number of neighbors to
2519 use, the lower the value, the noisier (more local) the
2520 approximation is.
2521 GRID_NNLI, data specifies what a thin triangle is, in the
2522 range [1. .. 2.]. High values enable the usage of very thin
2523 triangles for interpolation, possibly resulting in error in
2524 the approximation.
2525 GRID_NNI, only weights greater than data will be accepted. If
2526 0, all weights will be accepted.
2527
2528 """
2529 return _plplotc.plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data)
2530
2532 r"""
2533 Get current subpage parameters
2534
2535 DESCRIPTION:
2536
2537 Gets the size of the current subpage in millimeters measured from the
2538 bottom left hand corner of the output device page or screen. Can be
2539 used in conjunction with plsvpa for setting the size of a viewport in
2540 absolute coordinates (millimeters).
2541
2542 Redacted form: plgspa(xmin, xmax, ymin, ymax)
2543
2544 This function is used in example 23.
2545
2546
2547
2548 SYNOPSIS:
2549
2550 plgspa(xmin, xmax, ymin, ymax)
2551
2552 ARGUMENTS:
2553
2554 xmin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2555 the left hand edge of the subpage in millimeters.
2556
2557 xmax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2558 the right hand edge of the subpage in millimeters.
2559
2560 ymin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2561 the bottom edge of the subpage in millimeters.
2562
2563 ymax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2564 the top edge of the subpage in millimeters.
2565
2566 """
2567 return _plplotc.plgspa()
2568
2570 r"""
2571 Get current stream number
2572
2573 DESCRIPTION:
2574
2575 Gets the number of the current output stream. See also plsstrm.
2576
2577 Redacted form: plgstrm(p_strm)
2578
2579 This function is used in example 1,20.
2580
2581
2582
2583 SYNOPSIS:
2584
2585 plgstrm(p_strm)
2586
2587 ARGUMENTS:
2588
2589 p_strm (PLINT_NC_SCALAR, output) : Returned value of the current
2590 stream value.
2591
2592 """
2593 return _plplotc.plgstrm()
2594
2596 r"""
2597 Get the current library version number
2598
2599 DESCRIPTION:
2600
2601 Get the current library version number. Note: you must have allocated
2602 space for this (80 characters is safe).
2603
2604 Redacted form: plgver(p_ver)
2605
2606 This function is used in example 1.
2607
2608
2609
2610 SYNOPSIS:
2611
2612 plgver(p_ver)
2613
2614 ARGUMENTS:
2615
2616 p_ver (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2617 (with preallocated length of 80 characters or more) containing the
2618 PLplot version number.
2619
2620 """
2621 return _plplotc.plgver()
2622
2624 r"""
2625 Get viewport limits in normalized device coordinates
2626
2627 DESCRIPTION:
2628
2629 Get viewport limits in normalized device coordinates.
2630
2631 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2632
2633
2634 This function is used in example 31.
2635
2636
2637
2638 SYNOPSIS:
2639
2640 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2641
2642 ARGUMENTS:
2643
2644 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2645 viewport limit of the normalized device coordinate in x.
2646
2647 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2648 viewport limit of the normalized device coordinate in x.
2649
2650 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2651 viewport limit of the normalized device coordinate in y.
2652
2653 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2654 viewport limit of the normalized device coordinate in y.
2655
2656 """
2657 return _plplotc.plgvpd()
2658
2660 r"""
2661 Get viewport limits in world coordinates
2662
2663 DESCRIPTION:
2664
2665 Get viewport limits in world coordinates.
2666
2667 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2668
2669
2670 This function is used in example 31.
2671
2672
2673
2674 SYNOPSIS:
2675
2676 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2677
2678 ARGUMENTS:
2679
2680 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2681 viewport limit of the world coordinate in x.
2682
2683 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2684 viewport limit of the world coordinate in x.
2685
2686 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2687 viewport limit of the world coordinate in y.
2688
2689 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2690 viewport limit of the world coordinate in y.
2691
2692 """
2693 return _plplotc.plgvpw()
2694
2696 r"""
2697 Get x axis parameters
2698
2699 DESCRIPTION:
2700
2701 Returns current values of the p_digmax and p_digits flags for the x
2702 axis. p_digits is updated after the plot is drawn, so this routine
2703 should only be called after the call to plbox (or plbox3) is complete.
2704 See the PLplot documentation for more information.
2705
2706 Redacted form: plgxax(p_digmax, p_digits)
2707
2708 This function is used in example 31.
2709
2710
2711
2712 SYNOPSIS:
2713
2714 plgxax(p_digmax, p_digits)
2715
2716 ARGUMENTS:
2717
2718 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2719 number of digits for the x axis. If nonzero, the printed label
2720 has been switched to a floating-point representation when the
2721 number of digits exceeds this value.
2722
2723 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2724 number of digits for the numeric labels (x axis) from the last
2725 plot.
2726
2727 """
2728 return _plplotc.plgxax()
2729
2731 r"""
2732 Get y axis parameters
2733
2734 DESCRIPTION:
2735
2736 Identical to plgxax, except that arguments are flags for y axis. See
2737 the description of plgxax for more detail.
2738
2739 Redacted form: plgyax(p_digmax, p_digits)
2740
2741 This function is used in example 31.
2742
2743
2744
2745 SYNOPSIS:
2746
2747 plgyax(p_digmax, p_digits)
2748
2749 ARGUMENTS:
2750
2751 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2752 number of digits for the y axis. If nonzero, the printed label
2753 has been switched to a floating-point representation when the
2754 number of digits exceeds this value.
2755
2756 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2757 number of digits for the numeric labels (y axis) from the last
2758 plot.
2759
2760 """
2761 return _plplotc.plgyax()
2762
2764 r"""
2765 Get z axis parameters
2766
2767 DESCRIPTION:
2768
2769 Identical to plgxax, except that arguments are flags for z axis. See
2770 the description of plgxax for more detail.
2771
2772 Redacted form: plgzax(p_digmax, p_digits)
2773
2774 This function is used in example 31.
2775
2776
2777
2778 SYNOPSIS:
2779
2780 plgzax(p_digmax, p_digits)
2781
2782 ARGUMENTS:
2783
2784 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2785 number of digits for the z axis. If nonzero, the printed label
2786 has been switched to a floating-point representation when the
2787 number of digits exceeds this value.
2788
2789 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2790 number of digits for the numeric labels (z axis) from the last
2791 plot.
2792
2793 """
2794 return _plplotc.plgzax()
2795
2796def plhist(n, datmin, datmax, nbin, oldwin):
2797 r"""
2798 Plot a histogram from unbinned data
2799
2800 DESCRIPTION:
2801
2802 Plots a histogram from n data points stored in the data vector. This
2803 routine bins the data into nbin bins equally spaced between datmin and
2804 datmax, and calls plbin to draw the resulting histogram. Parameter
2805 opt allows, among other things, the histogram either to be plotted in
2806 an existing window or causes plhist to call plenv with suitable limits
2807 before plotting the histogram.
2808
2809 Redacted form: plhist(data, datmin, datmax, nbin, opt)
2810
2811 This function is used in example 5.
2812
2813
2814
2815 SYNOPSIS:
2816
2817 plhist(n, data, datmin, datmax, nbin, opt)
2818
2819 ARGUMENTS:
2820
2821 n (PLINT, input) : Number of data points.
2822
2823 data (PLFLT_VECTOR, input) : A vector containing the values of the
2824 n data points.
2825
2826 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
2827
2828 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
2829
2830 nbin (PLINT, input) : Number of (equal-sized) bins into which to
2831 divide the interval xmin to xmax.
2832
2833 opt (PLINT, input) : Is a combination of several flags:
2834 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
2835 the histogram data, the outer bins are expanded to fill up the
2836 entire x-axis, data outside the given extremes are assigned to the
2837 outer bins and bins of zero height are simply drawn.
2838 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled
2839 to fit the histogram data, without this flag, plenv is called
2840 to set the world coordinates.
2841 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
2842 extremes are not taken into account. This option should
2843 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to
2844 properly present the data.
2845 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal
2846 size as the ones inside.
2847 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn
2848 (there is a gap for such bins).
2849
2850 """
2851 return _plplotc.plhist(n, datmin, datmax, nbin, oldwin)
2852
2853def plhlsrgb(h, l, s):
2854 r"""
2855 Convert HLS color to RGB
2856
2857 DESCRIPTION:
2858
2859 Convert HLS color coordinates to RGB.
2860
2861 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
2862
2863
2864 This function is used in example 2.
2865
2866
2867
2868 SYNOPSIS:
2869
2870 plhlsrgb(h, l, s, p_r, p_g, p_b)
2871
2872 ARGUMENTS:
2873
2874 h (PLFLT, input) : Hue in degrees (0.0-360.0) on the color
2875 cylinder.
2876
2877 l (PLFLT, input) : Lightness expressed as a fraction (0.0-1.0) of
2878 the axis of the color cylinder.
2879
2880 s (PLFLT, input) : Saturation expressed as a fraction (0.0-1.0) of
2881 the radius of the color cylinder.
2882
2883 p_r (PLFLT_NC_SCALAR, output) : Returned value of the red intensity
2884 (0.0-1.0) of the color.
2885
2886 p_g (PLFLT_NC_SCALAR, output) : Returned value of the green
2887 intensity (0.0-1.0) of the color.
2888
2889 p_b (PLFLT_NC_SCALAR, output) : Returned value of the blue
2890 intensity (0.0-1.0) of the color.
2891
2892 """
2893 return _plplotc.plhlsrgb(h, l, s)
2894
2896 r"""
2897 Initialize PLplot
2898
2899 DESCRIPTION:
2900
2901 Initializing the plotting package. The program prompts for the device
2902 keyword or number of the desired output device. Hitting a RETURN in
2903 response to the prompt is the same as selecting the first device.
2904 plinit will issue no prompt if either the device was specified
2905 previously (via command line flag, the plsetopt function, or the
2906 plsdev function), or if only one device is enabled when PLplot is
2907 installed. If subpages have been specified, the output device is
2908 divided into nx by ny subpages, each of which may be used
2909 independently. If plinit is called again during a program, the
2910 previously opened file will be closed. The subroutine pladv is used
2911 to advance from one subpage to the next.
2912
2913 Redacted form: plinit()
2914
2915 This function is used in all of the examples.
2916
2917
2918
2919 SYNOPSIS:
2920
2921 plinit()
2922
2923 """
2924 return _plplotc.plinit()
2925
2926def pljoin(x1, y1, x2, y2):
2927 r"""
2928 Draw a line between two points
2929
2930 DESCRIPTION:
2931
2932 Joins the point (
2933 x1,
2934 y1) to (
2935 x2,
2936 y2).
2937
2938 Redacted form: pljoin(x1,y1,x2,y2)
2939
2940 This function is used in examples 3 and 14.
2941
2942
2943
2944 SYNOPSIS:
2945
2946 pljoin(x1, y1, x2, y2)
2947
2948 ARGUMENTS:
2949
2950 x1 (PLFLT, input) : x coordinate of first point.
2951
2952 y1 (PLFLT, input) : y coordinate of first point.
2953
2954 x2 (PLFLT, input) : x coordinate of second point.
2955
2956 y2 (PLFLT, input) : y coordinate of second point.
2957
2958 """
2959 return _plplotc.pljoin(x1, y1, x2, y2)
2960
2961def pllab(xlabel, ylabel, tlabel):
2962 r"""
2963 Simple routine to write labels
2964
2965 DESCRIPTION:
2966
2967 Routine for writing simple labels. Use plmtex for more complex labels.
2968
2969 Redacted form: pllab(xlabel, ylabel, tlabel)
2970
2971 This function is used in examples 1, 5, 9, 12, 14-16, 20-22, and 29.
2972
2973
2974
2975 SYNOPSIS:
2976
2977 pllab(xlabel, ylabel, tlabel)
2978
2979 ARGUMENTS:
2980
2981 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2982 the label for the x axis.
2983
2984 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2985 the label for the y axis.
2986
2987 tlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2988 the title of the plot.
2989
2990 """
2991 return _plplotc.pllab(xlabel, ylabel, tlabel)
2992
2993def pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28):
2994 r"""
2995 Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols
2996
2997 DESCRIPTION:
2998
2999 Routine for creating a discrete plot legend with a plotted filled box,
3000 line, and/or line of symbols for each annotated legend entry. (See
3001 plcolorbar for similar functionality for creating continuous color
3002 bars.) The arguments of pllegend provide control over the location
3003 and size of the legend as well as the location and characteristics of
3004 the elements (most of which are optional) within that legend. The
3005 resulting legend is clipped at the boundaries of the current subpage.
3006 (N.B. the adopted coordinate system used for some of the parameters is
3007 defined in the documentation of the position parameter.)
3008
3009 Redacted form: pllegend(p_legend_width, p_legend_height, opt,
3010 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow,
3011 ncolumn, opt_array, text_offset, text_scale, text_spacing,
3012 test_justification, text_colors, text, box_colors, box_patterns,
3013 box_scales, box_line_widths, line_colors, line_styles, line_widths,
3014 symbol_colors, symbol_scales, symbol_numbers, symbols)
3015
3016 This function is used in examples 4, 26, and 33.
3017
3018
3019
3020 SYNOPSIS:
3021
3022 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)
3023
3024 ARGUMENTS:
3025
3026 p_legend_width (PLFLT_NC_SCALAR, output) : Returned value of the
3027 legend width in adopted coordinates. This quantity is calculated
3028 from plot_width, text_offset, ncolumn (possibly modified inside
3029 the routine depending on nlegend and nrow), and the length
3030 (calculated internally) of the longest text string.
3031
3032 p_legend_height (PLFLT_NC_SCALAR, output) : Returned value of the
3033 legend height in adopted coordinates. This quantity is calculated
3034 from text_scale, text_spacing, and nrow (possibly modified inside
3035 the routine depending on nlegend and nrow).
3036
3037 opt (PLINT, input) : opt contains bits controlling the overall
3038 legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area
3039 on the left of the legend and the plotted area on the right.
3040 Otherwise, put the text area on the right of the legend and the
3041 plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set,
3042 plot a (semitransparent) background for the legend. If the
3043 PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the
3044 legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the
3045 possibly internally transformed) nrow > 1 and ncolumn > 1, then
3046 plot the resulting array of legend entries in row-major order.
3047 Otherwise, plot the legend entries in column-major order.
3048
3049 position (PLINT, input) : position contains bits which control the
3050 overall position of the legend and the definition of the adopted
3051 coordinates used for positions just like what is done for the
3052 position argument for plcolorbar. However, note that the defaults
3053 for the position bits (see below) are different than the
3054 plcolorbar case. The combination of the PL_POSITION_LEFT,
3055 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3056 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3057 the 16 possible standard positions (the 4 corners and centers of
3058 the 4 sides for both the inside and outside cases) of the legend
3059 relative to the adopted coordinate system. The corner positions
3060 are specified by the appropriate combination of two of the
3061 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3062 PL_POSITION_BOTTOM bits while the sides are specified by a single
3063 value of one of those bits. The adopted coordinates are
3064 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3065 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3066 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3067 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3068 then use the combination of PL_POSITION_RIGHT and PL_POSITION_TOP.
3069 If neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set,
3070 use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or
3071 PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT.
3072
3073 x (PLFLT, input) : X offset of the legend position in adopted
3074 coordinates from the specified standard position of the legend.
3075 For positive x, the direction of motion away from the standard
3076 position is inward/outward from the standard corner positions or
3077 standard left or right positions if the
3078 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3079 For the standard top or bottom positions, the direction of motion
3080 is toward positive X.
3081
3082 y (PLFLT, input) : Y offset of the legend position in adopted
3083 coordinates from the specified standard position of the legend.
3084 For positive y, the direction of motion away from the standard
3085 position is inward/outward from the standard corner positions or
3086 standard top or bottom positions if the
3087 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. For
3088 the standard left or right positions, the direction of motion is
3089 toward positive Y.
3090
3091 plot_width (PLFLT, input) : Horizontal width in adopted coordinates
3092 of the plot area (where the colored boxes, lines, and/or lines of
3093 symbols are drawn) of the legend.
3094
3095 bg_color (PLINT, input) : The cmap0 color of the background for the
3096 legend (PL_LEGEND_BACKGROUND).
3097
3098 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3099 for the legend (PL_LEGEND_BOUNDING_BOX).
3100
3101 bb_style (PLINT, input) : The pllsty style number for the
3102 bounding-box line for the legend (PL_LEGEND_BACKGROUND).
3103
3104 nrow (PLINT, input) : The number of rows in the matrix used to
3105 render the
3106 nlegend legend entries. For internal transformations of
3107 nrow, see further remarks under
3108 nlegend.
3109
3110 ncolumn (PLINT, input) : The number of columns in the matrix used
3111 to render the
3112 nlegend legend entries. For internal transformations of
3113 ncolumn, see further remarks under
3114 nlegend.
3115
3116 nlegend (PLINT, input) : Number of legend entries. The above
3117 nrow and
3118 ncolumn values are transformed internally to be consistent with
3119 nlegend. If either
3120 nrow or
3121 ncolumn is non-positive it is replaced by 1. If the resulting product
3122 of
3123 nrow and
3124 ncolumn is less than
3125 nlegend, the smaller of the two (or
3126 nrow, if
3127 nrow ==
3128 ncolumn) is increased so the product is >=
3129 nlegend. Thus, for example, the common
3130 nrow = 0,
3131 ncolumn = 0 case is transformed internally to
3132 nrow =
3133 nlegend,
3134 ncolumn = 1; i.e., the usual case of a legend rendered as a single
3135 column.
3136
3137 opt_array (PLINT_VECTOR, input) : A vector of
3138 nlegend values of options to control each individual plotted area
3139 corresponding to a legend entry. If the
3140 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted
3141 area. If the
3142 PL_LEGEND_COLOR_BOX,
3143 PL_LEGEND_LINE, and/or
3144 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
3145 entry is plotted with a colored box; a line; and/or a line of
3146 symbols.
3147
3148 text_offset (PLFLT, input) : Offset of the text area from the plot
3149 area in units of character width.
3150
3151 text_scale (PLFLT, input) : Character height scale for text
3152 annotations.
3153
3154 text_spacing (PLFLT, input) : Vertical spacing in units of the
3155 character height from one legend entry to the next.
3156
3157 text_justification (PLFLT, input) : Justification parameter used
3158 for text justification. The most common values of
3159 text_justification are 0., 0.5, or 1. corresponding to a text that
3160 is left justified, centred, or right justified within the text
3161 area, but other values are allowed as well.
3162
3163 text_colors (PLINT_VECTOR, input) : A vector containing
3164 nlegend cmap0 text colors.
3165
3166 text (PLCHAR_MATRIX, input) : A vector of
3167 nlegend UTF-8 character strings containing the legend annotations.
3168
3169 box_colors (PLINT_VECTOR, input) : A vector containing
3170 nlegend cmap0 colors for the discrete colored boxes (
3171 PL_LEGEND_COLOR_BOX).
3172
3173 box_patterns (PLINT_VECTOR, input) : A vector containing
3174 nlegend patterns (plpsty indices) for the discrete colored boxes (
3175 PL_LEGEND_COLOR_BOX).
3176
3177 box_scales (PLFLT_VECTOR, input) : A vector containing
3178 nlegend scales (units of fraction of character height) for the height
3179 of the discrete colored boxes (
3180 PL_LEGEND_COLOR_BOX).
3181
3182 box_line_widths (PLFLT_VECTOR, input) : A vector containing
3183 nlegend line widths for the patterns specified by box_patterns (
3184 PL_LEGEND_COLOR_BOX).
3185
3186 line_colors (PLINT_VECTOR, input) : A vector containing
3187 nlegend cmap0 line colors (
3188 PL_LEGEND_LINE).
3189
3190 line_styles (PLINT_VECTOR, input) : A vector containing
3191 nlegend line styles (plsty indices) (
3192 PL_LEGEND_LINE).
3193
3194 line_widths (PLFLT_VECTOR, input) : A vector containing
3195 nlegend line widths (
3196 PL_LEGEND_LINE).
3197
3198 symbol_colors (PLINT_VECTOR, input) : A vector containing
3199 nlegend cmap0 symbol colors (
3200 PL_LEGEND_SYMBOL).
3201
3202 symbol_scales (PLFLT_VECTOR, input) : A vector containing
3203 nlegend scale values for the symbol height (
3204 PL_LEGEND_SYMBOL).
3205
3206 symbol_numbers (PLINT_VECTOR, input) : A vector containing
3207 nlegend numbers of symbols to be drawn across the width of the plotted
3208 area (
3209 PL_LEGEND_SYMBOL).
3210
3211 symbols (PLCHAR_MATRIX, input) : A vector of
3212 nlegend UTF-8 character strings containing the legend symbols. (
3213 PL_LEGEND_SYMBOL).
3214
3215 """
3216 return _plplotc.pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28)
3217
3218def plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk):
3219 r"""
3220 Plot color bar for image, shade or gradient plots
3221
3222 DESCRIPTION:
3223
3224 Routine for creating a continuous color bar for image, shade, or
3225 gradient plots. (See pllegend for similar functionality for creating
3226 legends with discrete elements). The arguments of plcolorbar provide
3227 control over the location and size of the color bar as well as the
3228 location and characteristics of the elements (most of which are
3229 optional) within that color bar. The resulting color bar is clipped
3230 at the boundaries of the current subpage. (N.B. the adopted coordinate
3231 system used for some of the parameters is defined in the documentation
3232 of the position parameter.)
3233
3234 Redacted form: plcolorbar(p_colorbar_width, p_colorbar_height, opt,
3235 position, x, y, x_length, y_length, bg_color, bb_color, bb_style,
3236 low_cap_color, high_cap_color, cont_color, cont_width, label_opts,
3237 labels, axis_opts, ticks, sub_ticks, values)
3238
3239 This function is used in examples 16 and 33.
3240
3241
3242
3243 SYNOPSIS:
3244
3245 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)
3246
3247 ARGUMENTS:
3248
3249 p_colorbar_width (PLFLT_NC_SCALAR, output) : Returned value of the
3250 labelled and decorated color bar width in adopted coordinates.
3251
3252 p_colorbar_height (PLFLT_NC_SCALAR, output) : Returned value of the
3253 labelled and decorated color bar height in adopted coordinates.
3254
3255 opt (PLINT, input) : opt contains bits controlling the overall
3256 color bar. The orientation (direction of the maximum value) of
3257 the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
3258 PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM. If none of these bits are
3259 specified, the default orientation is toward the top if the
3260 colorbar is placed on the left or right of the viewport or toward
3261 the right if the colorbar is placed on the top or bottom of the
3262 viewport. If the PL_COLORBAR_BACKGROUND bit is set, plot a
3263 (semitransparent) background for the color bar. If the
3264 PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the
3265 color bar. The type of color bar must be specified with one of
3266 PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If
3267 more than one of those bits is set only the first one in the above
3268 list is honored. The position of the (optional) label/title can be
3269 specified with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT, or
3270 PL_LABEL_BOTTOM. If no label position bit is set then no label
3271 will be drawn. If more than one of this list of bits is specified,
3272 only the first one on the list is honored. End-caps for the color
3273 bar can added with PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.
3274 If a particular color bar cap option is not specified then no cap
3275 will be drawn for that end. As a special case for
3276 PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be
3277 specified. If this option is provided then any tick marks and tick
3278 labels will be placed at the breaks between shaded segments. TODO:
3279 This should be expanded to support custom placement of tick marks
3280 and tick labels at custom value locations for any color bar type.
3281
3282 position (PLINT, input) : position contains bits which control the
3283 overall position of the color bar and the definition of the
3284 adopted coordinates used for positions just like what is done for
3285 the position argument for pllegend. However, note that the
3286 defaults for the position bits (see below) are different than the
3287 pllegend case. The combination of the PL_POSITION_LEFT,
3288 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3289 PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
3290 the 16 possible standard positions (the 4 corners and centers of
3291 the 4 sides for both the inside and outside cases) of the color
3292 bar relative to the adopted coordinate system. The corner
3293 positions are specified by the appropriate combination of two of
3294 the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
3295 PL_POSITION_BOTTOM bits while the sides are specified by a single
3296 value of one of those bits. The adopted coordinates are
3297 normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
3298 set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
3299 bit is set. Default position bits: If none of PL_POSITION_LEFT,
3300 PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
3301 then use PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE or
3302 PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE. If neither of
3303 PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use
3304 PL_POSITION_VIEWPORT.
3305
3306 x (PLFLT, input) : X offset of the color bar position in adopted
3307 coordinates from the specified standard position of the color bar.
3308 For positive x, the direction of motion away from the standard
3309 position is inward/outward from the standard corner positions or
3310 standard left or right positions if the
3311 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3312 For the standard top or bottom positions, the direction of motion
3313 is toward positive X.
3314
3315 y (PLFLT, input) : Y offset of the color bar position in adopted
3316 coordinates from the specified standard position of the color bar.
3317 For positive y, the direction of motion away from the standard
3318 position is inward/outward from the standard corner positions or
3319 standard top or bottom positions if the
3320 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position.
3321 For the standard left or right positions, the direction of motion
3322 is toward positive Y.
3323
3324 x_length (PLFLT, input) : Length of the body of the color bar in
3325 the X direction in adopted coordinates.
3326
3327 y_length (PLFLT, input) : Length of the body of the color bar in
3328 the Y direction in adopted coordinates.
3329
3330 bg_color (PLINT, input) : The cmap0 color of the background for the
3331 color bar (PL_COLORBAR_BACKGROUND).
3332
3333 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3334 for the color bar (PL_COLORBAR_BOUNDING_BOX).
3335
3336 bb_style (PLINT, input) : The pllsty style number for the
3337 bounding-box line for the color bar (PL_COLORBAR_BACKGROUND).
3338
3339 low_cap_color (PLFLT, input) : The cmap1 color of the low-end color
3340 bar cap, if it is drawn (PL_COLORBAR_CAP_LOW).
3341
3342 high_cap_color (PLFLT, input) : The cmap1 color of the high-end
3343 color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH).
3344
3345 cont_color (PLINT, input) : The cmap0 contour color for
3346 PL_COLORBAR_SHADE plots. This is passed directly to plshades, so
3347 it will be interpreted according to the design of plshades.
3348
3349 cont_width (PLFLT, input) : Contour width for PL_COLORBAR_SHADE
3350 plots. This is passed directly to plshades, so it will be
3351 interpreted according to the design of plshades.
3352
3353 n_labels (PLINT, input) : Number of labels to place around the
3354 color bar.
3355
3356 label_opts (PLINT_VECTOR, input) : A vector of options for each of
3357 n_labels labels.
3358
3359 labels (PLCHAR_MATRIX, input) : A vector of
3360 n_labels UTF-8 character strings containing the labels for the color
3361 bar. Ignored if no label position is specified with one of the
3362 PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP,
3363 PL_COLORBAR_LABEL_LEFT, or PL_COLORBAR_LABEL_BOTTOM bits in the
3364 corresponding label_opts field.
3365
3366 n_axes (PLINT, input) : Number of axis definitions provided. This
3367 value must be greater than 0. It is typically 1 (numerical axis
3368 labels are provided for one of the long edges of the color bar),
3369 but it can be larger if multiple numerical axis labels for the
3370 long edges of the color bar are desired.
3371
3372 axis_opts (PLCHAR_MATRIX, input) : A vector of
3373 n_axes ascii character strings containing options (interpreted as for
3374 plbox) for the color bar's axis definitions.
3375
3376 ticks (PLFLT_VECTOR, input) : A vector of n_axes values of the
3377 spacing of the major tick marks (interpreted as for plbox) for the
3378 color bar's axis definitions.
3379
3380 sub_ticks (PLINT_VECTOR, input) : A vector of n_axes values of the
3381 number of subticks (interpreted as for plbox) for the color bar's
3382 axis definitions.
3383
3384 n_values (PLINT_VECTOR, input) : A vector containing the number of
3385 elements in each of the n_axes rows of the values matrix.
3386
3387 values (PLFLT_MATRIX, input) : A matrix containing the numeric
3388 values for the data range represented by the color bar. For a row
3389 index of i_axis (where 0 < i_axis < n_axes), the number of
3390 elements in the row is specified by n_values[i_axis]. For
3391 PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT the number of elements
3392 is 2, and the corresponding row elements of the values matrix are
3393 the minimum and maximum value represented by the colorbar. For
3394 PL_COLORBAR_SHADE, the number and values of the elements of a row
3395 of the values matrix is interpreted the same as the nlevel and
3396 clevel arguments of plshades.
3397
3398 """
3399 return _plplotc.plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk)
3400
3401def pllightsource(x, y, z):
3402 r"""
3403 Sets the 3D position of the light source
3404
3405 DESCRIPTION:
3406
3407 Sets the 3D position of the light source for use with plsurf3d and
3408 plsurf3dl
3409
3410 Redacted form: pllightsource(x, y, z)
3411
3412 This function is used in example 8.
3413
3414
3415
3416 SYNOPSIS:
3417
3418 pllightsource(x, y, z)
3419
3420 ARGUMENTS:
3421
3422 x (PLFLT, input) : X-coordinate of the light source.
3423
3424 y (PLFLT, input) : Y-coordinate of the light source.
3425
3426 z (PLFLT, input) : Z-coordinate of the light source.
3427
3428 """
3429 return _plplotc.pllightsource(x, y, z)
3430
3431def plline(n, ArrayCk):
3432 r"""
3433 Draw a line
3434
3435 DESCRIPTION:
3436
3437 Draws line defined by n points in x and y.
3438
3439 Redacted form: plline(x, y)
3440
3441 This function is used in examples 1, 3, 4, 9, 12-14, 16, 18, 20, 22,
3442 25-27, and 29.
3443
3444
3445
3446 SYNOPSIS:
3447
3448 plline(n, x, y)
3449
3450 ARGUMENTS:
3451
3452 n (PLINT, input) : Number of points defining line.
3453
3454 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3455 points.
3456
3457 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3458 points.
3459
3460 """
3461 return _plplotc.plline(n, ArrayCk)
3462
3463def plline3(n, arg2, arg3):
3464 r"""
3465 Draw a line in 3 space
3466
3467 DESCRIPTION:
3468
3469 Draws line in 3 space defined by n points in x, y, and z. You must
3470 first set up the viewport, the 2d viewing window (in world
3471 coordinates), and the 3d normalized coordinate box. See x18c.c for
3472 more info.
3473
3474 Redacted form: plline3(x, y, z)
3475
3476 This function is used in example 18.
3477
3478
3479
3480 SYNOPSIS:
3481
3482 plline3(n, x, y, z)
3483
3484 ARGUMENTS:
3485
3486 n (PLINT, input) : Number of points defining line.
3487
3488 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3489 points.
3490
3491 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3492 points.
3493
3494 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
3495 points.
3496
3497 """
3498 return _plplotc.plline3(n, arg2, arg3)
3499
3500def pllsty(lin):
3501 r"""
3502 Select line style
3503
3504 DESCRIPTION:
3505
3506 This sets the line style according to one of eight predefined patterns
3507 (also see plstyl).
3508
3509 Redacted form: pllsty(lin)
3510
3511 This function is used in examples 9, 12, 22, and 25.
3512
3513
3514
3515 SYNOPSIS:
3516
3517 pllsty(lin)
3518
3519 ARGUMENTS:
3520
3521 lin (PLINT, input) : Integer value between 1 and 8. Line style 1 is
3522 a continuous line, line style 2 is a line with short dashes and
3523 gaps, line style 3 is a line with long dashes and gaps, line style
3524 4 has long dashes and short gaps and so on.
3525
3526 """
3527 return _plplotc.pllsty(lin)
3528
3529def plmesh(ArrayX, ArrayY, MatrixCk, opt):
3530 r"""
3531 Plot surface mesh
3532
3533 DESCRIPTION:
3534
3535 Plots a surface mesh within the environment set up by plw3d. The
3536 surface is defined by the matrix z[
3537 nx][
3538 ny] , the point z[i][j] being the value of the function at (
3539 x[i],
3540 y[j]). Note that the points in vectors x and y do not need to be
3541 equally spaced, but must be stored in ascending order. The parameter
3542 opt controls the way in which the surface is displayed. For further
3543 details see the PLplot documentation.
3544
3545 Redacted form: plmesh(x, y, z, opt)
3546
3547 This function is used in example 11.
3548
3549
3550
3551 SYNOPSIS:
3552
3553 plmesh(x, y, z, nx, ny, opt)
3554
3555 ARGUMENTS:
3556
3557 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3558 which the function is evaluated.
3559
3560 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3561 which the function is evaluated.
3562
3563 z (PLFLT_MATRIX, input) : A matrix containing function values to
3564 plot. Should have dimensions of
3565 nx by
3566 ny.
3567
3568 nx (PLINT, input) : Number of x values at which function has been
3569 evaluated.
3570
3571 ny (PLINT, input) : Number of y values at which function has been
3572 evaluated.
3573
3574 opt (PLINT, input) : Determines the way in which the surface is
3575 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3576 function of x for each value of y[j] .
3577 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3578 for each value of x[i] .
3579 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3580 at which function is defined.
3581
3582 """
3583 return _plplotc.plmesh(ArrayX, ArrayY, MatrixCk, opt)
3584
3585def plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array):
3586 r"""
3587 Magnitude colored plot surface mesh with contour
3588
3589 DESCRIPTION:
3590
3591 A more powerful form of plmesh: the surface mesh can be colored
3592 accordingly to the current z value being plotted, a contour plot can
3593 be drawn at the base XY plane, and a curtain can be drawn between the
3594 plotted function border and the base XY plane.
3595
3596 Redacted form: plmeshc(x, y, z, opt, clevel)
3597
3598 This function is used in example 11.
3599
3600
3601
3602 SYNOPSIS:
3603
3604 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
3605
3606 ARGUMENTS:
3607
3608 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3609 which the function is evaluated.
3610
3611 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3612 which the function is evaluated.
3613
3614 z (PLFLT_MATRIX, input) : A matrix containing function values to
3615 plot. Should have dimensions of
3616 nx by
3617 ny.
3618
3619 nx (PLINT, input) : Number of x values at which function is
3620 evaluated.
3621
3622 ny (PLINT, input) : Number of y values at which function is
3623 evaluated.
3624
3625 opt (PLINT, input) : Determines the way in which the surface is
3626 represented. To specify more than one option just add the options,
3627 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3628 showing z as a function of x for each value of y[j] .
3629 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3630 for each value of x[i] .
3631 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3632 at which function is defined.
3633 opt=MAG_COLOR : Each line in the mesh is colored according to
3634 the z value being plotted. The color is used from the current
3635 cmap1.
3636 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3637 using parameters
3638 nlevel and
3639 clevel.
3640 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3641 the borders of the plotted function.
3642
3643
3644 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3645 levels.
3646
3647 nlevel (PLINT, input) : Number of elements in the clevel vector.
3648
3649 """
3650 return _plplotc.plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array)
3651
3653 r"""
3654 Creates a new stream and makes it the default
3655
3656 DESCRIPTION:
3657
3658 Creates a new stream and makes it the default. Differs from using
3659 plsstrm, in that a free stream number is found, and returned.
3660 Unfortunately, I have to start at stream 1 and work upward, since
3661 stream 0 is preallocated. One of the big flaws in the PLplot API is
3662 that no initial, library-opening call is required. So stream 0 must
3663 be preallocated, and there is no simple way of determining whether it
3664 is already in use or not.
3665
3666 Redacted form: plmkstrm(p_strm)
3667
3668 This function is used in examples 1 and 20.
3669
3670
3671
3672 SYNOPSIS:
3673
3674 plmkstrm(p_strm)
3675
3676 ARGUMENTS:
3677
3678 p_strm (PLINT_NC_SCALAR, output) : Returned value of the stream
3679 number of the created stream.
3680
3681 """
3682 return _plplotc.plmkstrm()
3683
3684def plmtex(side, disp, pos, just, text):
3685 r"""
3686 Write text relative to viewport boundaries
3687
3688 DESCRIPTION:
3689
3690 Writes text at a specified position relative to the viewport
3691 boundaries. Text may be written inside or outside the viewport, but
3692 is clipped at the subpage boundaries. The reference point of a string
3693 lies along a line passing through the string at half the height of a
3694 capital letter. The position of the reference point along this line
3695 is determined by just, and the position of the reference point
3696 relative to the viewport is set by disp and pos.
3697
3698 Redacted form: General: plmtex(side, disp, pos, just, text)
3699
3700
3701 This function is used in examples 3, 4, 6-8, 11, 12, 14, 18, 23, and
3702 26.
3703
3704
3705
3706 SYNOPSIS:
3707
3708 plmtex(side, disp, pos, just, text)
3709
3710 ARGUMENTS:
3711
3712 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3713 the side of the viewport along which the text is to be written.
3714 The string must be one of: b: Bottom of viewport, text written
3715 parallel to edge.
3716 bv: Bottom of viewport, text written at right angles to edge.
3717 l: Left of viewport, text written parallel to edge.
3718 lv: Left of viewport, text written at right angles to edge.
3719 r: Right of viewport, text written parallel to edge.
3720 rv: Right of viewport, text written at right angles to edge.
3721 t: Top of viewport, text written parallel to edge.
3722 tv: Top of viewport, text written at right angles to edge.
3723
3724
3725 disp (PLFLT, input) : Position of the reference point of string,
3726 measured outwards from the specified viewport edge in units of the
3727 current character height. Use negative disp to write within the
3728 viewport.
3729
3730 pos (PLFLT, input) : Position of the reference point of string
3731 along the specified edge, expressed as a fraction of the length of
3732 the edge.
3733
3734 just (PLFLT, input) : Specifies the position of the string relative
3735 to its reference point. If just=0. , the reference point is at
3736 the left and if just=1. , it is at the right of the string. Other
3737 values of just give intermediate justifications.
3738
3739 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3740 written out.
3741
3742 """
3743 return _plplotc.plmtex(side, disp, pos, just, text)
3744
3745def plmtex3(side, disp, pos, just, text):
3746 r"""
3747 Write text relative to viewport boundaries in 3D plots
3748
3749 DESCRIPTION:
3750
3751 Writes text at a specified position relative to the viewport
3752 boundaries. Text may be written inside or outside the viewport, but
3753 is clipped at the subpage boundaries. The reference point of a string
3754 lies along a line passing through the string at half the height of a
3755 capital letter. The position of the reference point along this line
3756 is determined by just, and the position of the reference point
3757 relative to the viewport is set by disp and pos.
3758
3759 Redacted form: plmtex3(side, disp, pos, just, text)
3760
3761 This function is used in example 28.
3762
3763
3764
3765 SYNOPSIS:
3766
3767 plmtex3(side, disp, pos, just, text)
3768
3769 ARGUMENTS:
3770
3771 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3772 the side of the viewport along which the text is to be written.
3773 The string should contain one or more of the following characters:
3774 [xyz][ps][v]. Only one label is drawn at a time, i.e. xyp will
3775 only label the X axis, not both the X and Y axes. x: Label the X
3776 axis.
3777 y: Label the Y axis.
3778 z: Label the Z axis.
3779 p: Label the primary axis. For Z this is the leftmost Z axis.
3780 For X it is the axis that starts at y-min. For Y it is the
3781 axis that starts at x-min.
3782 s: Label the secondary axis.
3783 v: Draw the text perpendicular to the axis.
3784
3785
3786 disp (PLFLT, input) : Position of the reference point of string,
3787 measured outwards from the specified viewport edge in units of the
3788 current character height. Use negative disp to write within the
3789 viewport.
3790
3791 pos (PLFLT, input) : Position of the reference point of string
3792 along the specified edge, expressed as a fraction of the length of
3793 the edge.
3794
3795 just (PLFLT, input) : Specifies the position of the string relative
3796 to its reference point. If just=0. , the reference point is at
3797 the left and if just=1. , it is at the right of the string. Other
3798 values of just give intermediate justifications.
3799
3800 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3801 written out.
3802
3803 """
3804 return _plplotc.plmtex3(side, disp, pos, just, text)
3805
3806def plot3d(ArrayX, ArrayY, MatrixCk, opt, side):
3807 r"""
3808 Plot 3-d surface plot
3809
3810 DESCRIPTION:
3811
3812 Plots a three-dimensional surface plot within the environment set up
3813 by plw3d. The surface is defined by the matrix z[
3814 nx][
3815 ny] , the point z[i][j] being the value of the function at (
3816 x[i],
3817 y[j]). Note that the points in vectors x and y do not need to be
3818 equally spaced, but must be stored in ascending order. The parameter
3819 opt controls the way in which the surface is displayed. For further
3820 details see the PLplot documentation. The only difference between
3821 plmesh and plot3d is that plmesh draws the bottom side of the surface,
3822 while plot3d only draws the surface as viewed from the top.
3823
3824 Redacted form: plot3d(x, y, z, opt, side)
3825
3826 This function is used in examples 11 and 21.
3827
3828
3829
3830 SYNOPSIS:
3831
3832 plot3d(x, y, z, nx, ny, opt, side)
3833
3834 ARGUMENTS:
3835
3836 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3837 which the function is evaluated.
3838
3839 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3840 which the function is evaluated.
3841
3842 z (PLFLT_MATRIX, input) : A matrix containing function values to
3843 plot. Should have dimensions of
3844 nx by
3845 ny.
3846
3847 nx (PLINT, input) : Number of x values at which function is
3848 evaluated.
3849
3850 ny (PLINT, input) : Number of y values at which function is
3851 evaluated.
3852
3853 opt (PLINT, input) : Determines the way in which the surface is
3854 represented: opt=DRAW_LINEX : Lines are drawn showing z as a
3855 function of x for each value of y[j] .
3856 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3857 for each value of x[i] .
3858 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3859 at which function is defined.
3860
3861
3862 side (PLBOOL, input) : Flag to indicate whether or not ``sides''
3863 should be draw on the figure. If side is true sides are drawn,
3864 otherwise no sides are drawn.
3865
3866 """
3867 return _plplotc.plot3d(ArrayX, ArrayY, MatrixCk, opt, side)
3868
3869def plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array):
3870 r"""
3871 Magnitude colored plot surface with contour
3872
3873 DESCRIPTION:
3874
3875 Aside from dropping the
3876 side functionality this is a more powerful form of plot3d: the surface
3877 mesh can be colored accordingly to the current z value being plotted,
3878 a contour plot can be drawn at the base XY plane, and a curtain can be
3879 drawn between the plotted function border and the base XY plane. The
3880 arguments are identical to those of plmeshc. The only difference
3881 between plmeshc and plot3dc is that plmeshc draws the bottom side of
3882 the surface, while plot3dc only draws the surface as viewed from the
3883 top.
3884
3885 Redacted form: General: plot3dc(x, y, z, opt, clevel)
3886
3887
3888 This function is used in example 21.
3889
3890
3891
3892 SYNOPSIS:
3893
3894 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
3895
3896 ARGUMENTS:
3897
3898 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3899 which the function is evaluated.
3900
3901 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3902 which the function is evaluated.
3903
3904 z (PLFLT_MATRIX, input) : A matrix containing function values to
3905 plot. Should have dimensions of
3906 nx by
3907 ny.
3908
3909 nx (PLINT, input) : Number of x values at which function is
3910 evaluated.
3911
3912 ny (PLINT, input) : Number of y values at which function is
3913 evaluated.
3914
3915 opt (PLINT, input) : Determines the way in which the surface is
3916 represented. To specify more than one option just add the options,
3917 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3918 showing z as a function of x for each value of y[j] .
3919 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3920 for each value of x[i] .
3921 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3922 at which function is defined.
3923 opt=MAG_COLOR : Each line in the mesh is colored according to
3924 the z value being plotted. The color is used from the current
3925 cmap1.
3926 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3927 using parameters
3928 nlevel and
3929 clevel.
3930 opt=DRAW_SIDES : draws a curtain between the base XY plane and
3931 the borders of the plotted function.
3932
3933
3934 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3935 levels.
3936
3937 nlevel (PLINT, input) : Number of elements in the clevel vector.
3938
3939 """
3940 return _plplotc.plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array)
3941
3942def plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
3943 r"""
3944 Magnitude colored plot surface with contour for z[x][y] with y index limits
3945
3946 DESCRIPTION:
3947
3948 When the implementation is completed this variant of plot3dc (see that
3949 function's documentation for more details) should be suitable for the
3950 case where the area of the x, y coordinate grid where z is defined can
3951 be non-rectangular. The implementation is incomplete so the last 4
3952 parameters of plot3dcl; indexxmin, indexxmax, indexymin, and
3953 indexymax; are currently ignored and the functionality is otherwise
3954 identical to that of plot3dc.
3955
3956 Redacted form: General: plot3dcl(x, y, z, opt, clevel, indexxmin,
3957 indexymin, indexymax)
3958
3959
3960 This function is not used in any example.
3961
3962
3963
3964 SYNOPSIS:
3965
3966 plot3dcl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
3967
3968 ARGUMENTS:
3969
3970 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3971 which the function is evaluated.
3972
3973 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3974 which the function is evaluated.
3975
3976 z (PLFLT_MATRIX, input) : A matrix containing function values to
3977 plot. Should have dimensions of
3978 nx by
3979 ny.
3980
3981 nx (PLINT, input) : Number of x values at which the function is
3982 evaluated.
3983
3984 ny (PLINT, input) : Number of y values at which the function is
3985 evaluated.
3986
3987 opt (PLINT, input) : Determines the way in which the surface is
3988 represented. To specify more than one option just add the options,
3989 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3990 showing z as a function of x for each value of y[j] .
3991 opt=DRAW_LINEY : Lines are drawn showing z as a function of y
3992 for each value of x[i] .
3993 opt=DRAW_LINEXY : Network of lines is drawn connecting points
3994 at which function is defined.
3995 opt=MAG_COLOR : Each line in the mesh is colored according to
3996 the z value being plotted. The color is used from the current
3997 cmap1.
3998 opt=BASE_CONT : A contour plot is drawn at the base XY plane
3999 using parameters
4000 nlevel and
4001 clevel.
4002 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4003 the borders of the plotted function.
4004
4005
4006 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4007 levels.
4008
4009 nlevel (PLINT, input) : Number of elements in the clevel vector.
4010
4011 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4012 corresponds to the first x index where z is defined.
4013
4014 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4015 which corresponds (by convention) to one more than the last x
4016 index value where z is defined.
4017
4018 indexymin (PLINT_VECTOR, input) : A vector containing y index
4019 values which all must be ≥ 0. These values are the first y index
4020 where z is defined for a particular x index in the range from
4021 indexxmin to indexxmax - 1. The dimension of indexymin is
4022 indexxmax.
4023
4024 indexymax (PLINT_VECTOR, input) : A vector containing y index
4025 values which all must be ≤ ny. These values correspond (by
4026 convention) to one more than the last y index where z is defined
4027 for a particular x index in the range from indexxmin to indexxmax
4028 - 1. The dimension of indexymax is indexxmax.
4029
4030 """
4031 return _plplotc.plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4032
4033def plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array):
4034 r"""
4035 Plot shaded 3-d surface plot
4036
4037 DESCRIPTION:
4038
4039 Plots a three-dimensional shaded surface plot within the environment
4040 set up by plw3d. The surface is defined by the two-dimensional matrix
4041 z[
4042 nx][
4043 ny], the point z[i][j] being the value of the function at (
4044 x[i],
4045 y[j]). Note that the points in vectors x and y do not need to be
4046 equally spaced, but must be stored in ascending order. For further
4047 details see the PLplot documentation.
4048
4049 Redacted form: plsurf3d(x, y, z, opt, clevel)
4050
4051 This function is not used in any examples.
4052
4053
4054
4055 SYNOPSIS:
4056
4057 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
4058
4059 ARGUMENTS:
4060
4061 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4062 which the function is evaluated.
4063
4064 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4065 which the function is evaluated.
4066
4067 z (PLFLT_MATRIX, input) : A matrix containing function values to
4068 plot. Should have dimensions of
4069 nx by
4070 ny.
4071
4072 nx (PLINT, input) : Number of x values at which function is
4073 evaluated.
4074
4075 ny (PLINT, input) : Number of y values at which function is
4076 evaluated.
4077
4078 opt (PLINT, input) : Determines the way in which the surface is
4079 represented. To specify more than one option just add the options,
4080 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4081 connecting points at which function is defined.
4082 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4083 using parameters
4084 nlevel and
4085 clevel.
4086 opt=SURF_CONT : A contour plot is drawn at the surface plane
4087 using parameters
4088 nlevel and
4089 clevel.
4090 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4091 the borders of the plotted function.
4092 opt=MAG_COLOR : the surface is colored according to the value
4093 of Z; if MAG_COLOR is not used, then the surface is colored
4094 according to the intensity of the reflected light in the
4095 surface from a light source whose position is set using
4096 pllightsource.
4097
4098
4099 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4100 levels.
4101
4102 nlevel (PLINT, input) : Number of elements in the clevel vector.
4103
4104 """
4105 return _plplotc.plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array)
4106
4107def plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
4108 r"""
4109 Plot shaded 3-d surface plot for z[x][y] with y index limits
4110
4111 DESCRIPTION:
4112
4113 This variant of plsurf3d (see that function's documentation for more
4114 details) should be suitable for the case where the area of the x, y
4115 coordinate grid where z is defined can be non-rectangular. The limits
4116 of that grid are provided by the parameters indexxmin, indexxmax,
4117 indexymin, and indexymax.
4118
4119 Redacted form: plsurf3dl(x, y, z, opt, clevel, indexxmin, indexymin,
4120 indexymax)
4121
4122 This function is used in example 8.
4123
4124
4125
4126 SYNOPSIS:
4127
4128 plsurf3dl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
4129
4130 ARGUMENTS:
4131
4132 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4133 which the function is evaluated.
4134
4135 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4136 which the function is evaluated.
4137
4138 z (PLFLT_MATRIX, input) : A matrix containing function values to
4139 plot. Should have dimensions of
4140 nx by
4141 ny.
4142
4143 nx (PLINT, input) : Number of x values at which function is
4144 evaluated.
4145
4146 ny (PLINT, input) : Number of y values at which function is
4147 evaluated.
4148
4149 opt (PLINT, input) : Determines the way in which the surface is
4150 represented. To specify more than one option just add the options,
4151 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines is drawn
4152 connecting points at which function is defined.
4153 opt=BASE_CONT : A contour plot is drawn at the base XY plane
4154 using parameters
4155 nlevel and
4156 clevel.
4157 opt=SURF_CONT : A contour plot is drawn at the surface plane
4158 using parameters
4159 nlevel and
4160 clevel.
4161 opt=DRAW_SIDES : draws a curtain between the base XY plane and
4162 the borders of the plotted function.
4163 opt=MAG_COLOR : the surface is colored according to the value
4164 of Z; if MAG_COLOR is not used, then the surface is colored
4165 according to the intensity of the reflected light in the
4166 surface from a light source whose position is set using
4167 pllightsource.
4168
4169
4170 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4171 levels.
4172
4173 nlevel (PLINT, input) : Number of elements in the clevel vector.
4174
4175 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4176 corresponds to the first x index where z is defined.
4177
4178 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4179 which corresponds (by convention) to one more than the last x
4180 index value where z is defined.
4181
4182 indexymin (PLINT_VECTOR, input) : A vector containing the y index
4183 values which all must be ≥ 0. These values are the first y index
4184 where z is defined for a particular x index in the range from
4185 indexxmin to indexxmax - 1. The dimension of indexymin is
4186 indexxmax.
4187
4188 indexymax (PLINT_VECTOR, input) : A vector containing the y index
4189 values which all must be ≤ ny. These values correspond (by
4190 convention) to one more than the last y index where z is defined
4191 for a particular x index in the range from indexxmin to indexxmax
4192 - 1. The dimension of indexymax is indexxmax.
4193
4194 """
4195 return _plplotc.plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4196
4197def plparseopts(p_argc, mode):
4198 r"""
4199 Parse command-line arguments
4200
4201 DESCRIPTION:
4202
4203 Parse command-line arguments.
4204
4205 plparseopts removes all recognized flags (decreasing argc
4206 accordingly), so that invalid input may be readily detected. It can
4207 also be used to process user command line flags. The user can merge
4208 an option table of type PLOptionTable into the internal option table
4209 info structure using plMergeOpts. Or, the user can specify that ONLY
4210 the external table(s) be parsed by calling plClearOpts before
4211 plMergeOpts.
4212
4213 The default action taken by plparseopts is as follows:
4214 Returns with an error if an unrecognized option or badly formed
4215 option-value pair are encountered.
4216 Returns immediately (return code 0) when the first non-option command
4217 line argument is found.
4218 Returns with the return code of the option handler, if one was called.
4219
4220 Deletes command line arguments from argv list as they are found, and
4221 decrements argc accordingly.
4222 Does not show "invisible" options in usage or help messages.
4223 Assumes the program name is contained in argv[0].
4224
4225 These behaviors may be controlled through the
4226 mode argument.
4227
4228 Redacted form: General: plparseopts(argv, mode)
4229
4230
4231 This function is used in all of the examples.
4232
4233
4234
4235 SYNOPSIS:
4236
4237 PLINT plparseopts(p_argc, argv, mode)
4238
4239 ARGUMENTS:
4240
4241 p_argc (int *, input/output) : Number of arguments.
4242
4243 argv (PLCHAR_NC_MATRIX, input/output) : A vector of character
4244 strings containing *p_argc command-line arguments.
4245
4246 mode (PLINT, input) : Parsing mode with the following
4247 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
4248 and all error messages enabled, including program exit when an
4249 error occurs. Anything on the command line that isn't recognized
4250 as a valid option or option argument is flagged as an error.
4251 PL_PARSE_QUIET (2) -- Turns off all output except in the case
4252 of errors.
4253 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
4254 arguments.
4255 PL_PARSE_SHOWALL (8) -- Show invisible options
4256 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a
4257 pointer to the program name.
4258 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required.
4259 PL_PARSE_SKIP (128) -- Set to quietly skip over any
4260 unrecognized arguments.
4261
4262 """
4263 return _plplotc.plparseopts(p_argc, mode)
4264
4265def plpat(n, ArrayCk):
4266 r"""
4267 Set area line fill pattern
4268
4269 DESCRIPTION:
4270
4271 Sets the area line fill pattern to be used, e.g., for calls to plfill.
4272 The pattern consists of 1 or 2 sets of parallel lines with specified
4273 inclinations and spacings. The arguments to this routine are the
4274 number of sets to use (1 or 2) followed by two vectors (with 1 or 2
4275 elements) specifying the inclinations in tenths of a degree and the
4276 spacing in micrometers. (See also plpsty)
4277
4278 Redacted form: General: plpat(inc, del)
4279
4280
4281 This function is used in example 15.
4282
4283
4284
4285 SYNOPSIS:
4286
4287 plpat(nlin, inc, del)
4288
4289 ARGUMENTS:
4290
4291 nlin (PLINT, input) : Number of sets of lines making up the
4292 pattern, either 1 or 2.
4293
4294 inc (PLINT_VECTOR, input) : A vector containing nlin values of the
4295 inclination in tenths of a degree. (Should be between -900 and
4296 900).
4297
4298 del (PLINT_VECTOR, input) : A vector containing nlin values of the
4299 spacing in micrometers between the lines making up the pattern.
4300
4301 """
4302 return _plplotc.plpat(n, ArrayCk)
4303
4304def plpath(n, x1, y1, x2, y2):
4305 r"""
4306 Draw a line between two points, accounting for coordinate transforms
4307
4308 DESCRIPTION:
4309
4310 Joins the point (
4311 x1,
4312 y1) to (
4313 x2,
4314 y2) . If a global coordinate transform is defined then the line is
4315 broken in to n segments to approximate the path. If no transform is
4316 defined then this simply acts like a call to pljoin.
4317
4318 Redacted form: plpath(n,x1,y1,x2,y2)
4319
4320 This function is used in example 22.
4321
4322
4323
4324 SYNOPSIS:
4325
4326 plpath(n, x1, y1, x2, y2)
4327
4328 ARGUMENTS:
4329
4330 n (PLINT, input) : number of points to use to approximate the path.
4331
4332 x1 (PLFLT, input) : x coordinate of first point.
4333
4334 y1 (PLFLT, input) : y coordinate of first point.
4335
4336 x2 (PLFLT, input) : x coordinate of second point.
4337
4338 y2 (PLFLT, input) : y coordinate of second point.
4339
4340 """
4341 return _plplotc.plpath(n, x1, y1, x2, y2)
4342
4343def plpoin(n, ArrayCk, code):
4344 r"""
4345 Plot a glyph at the specified points
4346
4347 DESCRIPTION:
4348
4349 Plot a glyph at the specified points. (This function is largely
4350 superseded by plstring which gives access to many[!] more glyphs.)
4351 code=-1 means try to just draw a point. Right now it's just a move
4352 and a draw at the same place. Not ideal, since a sufficiently
4353 intelligent output device may optimize it away, or there may be faster
4354 ways of doing it. This is OK for now, though, and offers a 4X speedup
4355 over drawing a Hershey font "point" (which is actually diamond shaped
4356 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4357 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4358 code <= 127 the corresponding printable ASCII character is plotted.
4359
4360 Redacted form: plpoin(x, y, code)
4361
4362 This function is used in examples 1, 6, 14, and 29.
4363
4364
4365
4366 SYNOPSIS:
4367
4368 plpoin(n, x, y, code)
4369
4370 ARGUMENTS:
4371
4372 n (PLINT, input) : Number of points in the x and y vectors.
4373
4374 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4375 points.
4376
4377 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4378 points.
4379
4380 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4381 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4382 each of the n points.
4383
4384 """
4385 return _plplotc.plpoin(n, ArrayCk, code)
4386
4387def plpoin3(n, arg2, arg3, code):
4388 r"""
4389 Plot a glyph at the specified 3D points
4390
4391 DESCRIPTION:
4392
4393 Plot a glyph at the specified 3D points. (This function is largely
4394 superseded by plstring3 which gives access to many[!] more glyphs.)
4395 Set up the call to this function similar to what is done for plline3.
4396 code=-1 means try to just draw a point. Right now it's just a move
4397 and a draw at the same place. Not ideal, since a sufficiently
4398 intelligent output device may optimize it away, or there may be faster
4399 ways of doing it. This is OK for now, though, and offers a 4X speedup
4400 over drawing a Hershey font "point" (which is actually diamond shaped
4401 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4402 useful (but small subset) of Hershey symbols is plotted. If 32 <=
4403 code <= 127 the corresponding printable ASCII character is plotted.
4404
4405 Redacted form: plpoin3(x, y, z, code)
4406
4407 This function is not used in any example.
4408
4409
4410
4411 SYNOPSIS:
4412
4413 plpoin3(n, x, y, z, code)
4414
4415 ARGUMENTS:
4416
4417 n (PLINT, input) : Number of points in the x and y vectors.
4418
4419 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4420 points.
4421
4422 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4423 points.
4424
4425 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
4426 points.
4427
4428 code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form
4429 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4430 each of the n points.
4431
4432 """
4433 return _plplotc.plpoin3(n, arg2, arg3, code)
4434
4435def plpoly3(n, arg2, arg3, ArrayCkMinus1, flag):
4436 r"""
4437 Draw a polygon in 3 space
4438
4439 DESCRIPTION:
4440
4441 Draws a polygon in 3 space defined by n points in x, y, and z. Setup
4442 like plline3, but differs from that function in that plpoly3 attempts
4443 to determine if the polygon is viewable depending on the order of the
4444 points within the vector and the value of ifcc. If the back of
4445 polygon is facing the viewer, then it isn't drawn. If this isn't what
4446 you want, then use plline3 instead.
4447
4448 The points are assumed to be in a plane, and the directionality of the
4449 plane is determined from the first three points. Additional points do
4450 not have to lie on the plane defined by the first three, but if they
4451 do not, then the determination of visibility obviously can't be 100%
4452 accurate... So if you're 3 space polygons are too far from planar,
4453 consider breaking them into smaller polygons. 3 points define a plane
4454 :-).
4455
4456 Bugs: If one of the first two segments is of zero length, or if they
4457 are co-linear, the calculation of visibility has a 50/50 chance of
4458 being correct. Avoid such situations :-). See x18c.c for an example
4459 of this problem. (Search for 20.1).
4460
4461 Redacted form: plpoly3(x, y, z, code)
4462
4463 This function is used in example 18.
4464
4465
4466
4467 SYNOPSIS:
4468
4469 plpoly3(n, x, y, z, draw, ifcc)
4470
4471 ARGUMENTS:
4472
4473 n (PLINT, input) : Number of points defining line.
4474
4475 x (PLFLT_VECTOR, input) : A vector containing
4476 n x coordinates of points.
4477
4478 y (PLFLT_VECTOR, input) : A vector containing
4479 n y coordinates of points.
4480
4481 z (PLFLT_VECTOR, input) : A vector containing
4482 n z coordinates of points.
4483
4484 draw (PLBOOL_VECTOR, input) : A vector containing
4485 n-1 Boolean values which control drawing the segments of the polygon.
4486 If draw[i] is true, then the polygon segment from index [i] to
4487 [i+1] is drawn, otherwise, not.
4488
4489 ifcc (PLBOOL, input) : If ifcc is true the directionality of the
4490 polygon is determined by assuming the points are laid out in a
4491 counter-clockwise order. Otherwise, the directionality of the
4492 polygon is determined by assuming the points are laid out in a
4493 clockwise order.
4494
4495 """
4496 return _plplotc.plpoly3(n, arg2, arg3, ArrayCkMinus1, flag)
4497
4498def plprec(setp, prec):
4499 r"""
4500 Set precision in numeric labels
4501
4502 DESCRIPTION:
4503
4504 Sets the number of places after the decimal point in numeric labels.
4505
4506 Redacted form: plprec(setp, prec)
4507
4508 This function is used in example 29.
4509
4510
4511
4512 SYNOPSIS:
4513
4514 plprec(setp, prec)
4515
4516 ARGUMENTS:
4517
4518 setp (PLINT, input) : If setp is equal to 0 then PLplot
4519 automatically determines the number of places to use after the
4520 decimal point in numeric labels (like those used to label axes).
4521 If setp is 1 then prec sets the number of places.
4522
4523 prec (PLINT, input) : The number of characters to draw after the
4524 decimal point in numeric labels.
4525
4526 """
4527 return _plplotc.plprec(setp, prec)
4528
4529def plpsty(patt):
4530 r"""
4531 Select area fill pattern
4532
4533 DESCRIPTION:
4534
4535 If
4536 patt is zero or less use either a hardware solid fill if the drivers
4537 have that capability (virtually all do) or fall back to a software
4538 emulation of a solid fill using the eighth area line fill pattern. If
4539 0 <
4540 patt <= 8, then select one of eight predefined area line fill patterns
4541 to use (see plpat if you desire other patterns).
4542
4543 Redacted form: plpsty(patt)
4544
4545 This function is used in examples 12, 13, 15, 16, and 25.
4546
4547
4548
4549 SYNOPSIS:
4550
4551 plpsty(patt)
4552
4553 ARGUMENTS:
4554
4555 patt (PLINT, input) : The desired pattern index. If
4556 patt is zero or less, then a solid fill is (normally, see qualifiers
4557 above) used. For
4558 patt in the range from 1 to 8 and assuming the driver has not supplied
4559 line fill capability itself (most deliberately do not so that line
4560 fill patterns look identical for those drivers), the patterns
4561 consist of (1) horizontal lines, (2) vertical lines, (3) lines at
4562 45 degrees, (4) lines at -45 degrees, (5) lines at 30 degrees, (6)
4563 lines at -30 degrees, (7) both vertical and horizontal lines, and
4564 (8) lines at both 45 degrees and -45 degrees.
4565
4566 """
4567 return _plplotc.plpsty(patt)
4568
4569def plptex(x, y, dx, dy, just, text):
4570 r"""
4571 Write text inside the viewport
4572
4573 DESCRIPTION:
4574
4575 Writes text at a specified position and inclination within the
4576 viewport. Text is clipped at the viewport boundaries. The reference
4577 point of a string lies along a line passing through the string at half
4578 the height of a capital letter. The position of the reference point
4579 along this line is determined by just, the reference point is placed
4580 at world coordinates (
4581 x,
4582 y) within the viewport. The inclination of the string is specified
4583 in terms of differences of world coordinates making it easy to write
4584 text parallel to a line in a graph.
4585
4586 Redacted form: plptex(x, y, dx, dy, just, text)
4587
4588 This function is used in example 2-4,10,12-14,20,23,24,26.
4589
4590
4591
4592 SYNOPSIS:
4593
4594 plptex(x, y, dx, dy, just, text)
4595
4596 ARGUMENTS:
4597
4598 x (PLFLT, input) : x coordinate of reference point of string.
4599
4600 y (PLFLT, input) : y coordinate of reference point of string.
4601
4602 dx (PLFLT, input) : Together with dy, this specifies the
4603 inclination of the string. The baseline of the string is parallel
4604 to a line joining (
4605 x,
4606 y) to (
4607 x+
4608 dx,
4609 y+
4610 dy) .
4611
4612 dy (PLFLT, input) : Together with dx, this specifies the
4613 inclination of the string.
4614
4615 just (PLFLT, input) : Specifies the position of the string relative
4616 to its reference point. If just=0. , the reference point is at
4617 the left and if just=1. , it is at the right of the string. Other
4618 values of just give intermediate justifications.
4619
4620 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4621 written out.
4622
4623 """
4624 return _plplotc.plptex(x, y, dx, dy, just, text)
4625
4626def plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text):
4627 r"""
4628 Write text inside the viewport of a 3D plot
4629
4630 DESCRIPTION:
4631
4632 Writes text at a specified position and inclination and with a
4633 specified shear within the viewport. Text is clipped at the viewport
4634 boundaries. The reference point of a string lies along a line passing
4635 through the string at half the height of a capital letter. The
4636 position of the reference point along this line is determined by just,
4637 and the reference point is placed at world coordinates (
4638 wx,
4639 wy,
4640 wz) within the viewport. The inclination and shear of the string is
4641 specified in terms of differences of world coordinates making it easy
4642 to write text parallel to a line in a graph.
4643
4644 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4645
4646 This function is used in example 28.
4647
4648
4649
4650 SYNOPSIS:
4651
4652 plptex3(wx, wy, wz, dx, dy, dz, sx, sy, sz, just, text)
4653
4654 ARGUMENTS:
4655
4656 wx (PLFLT, input) : x world coordinate of reference point of
4657 string.
4658
4659 wy (PLFLT, input) : y world coordinate of reference point of
4660 string.
4661
4662 wz (PLFLT, input) : z world coordinate of reference point of
4663 string.
4664
4665 dx (PLFLT, input) : Together with dy and
4666 dz , this specifies the inclination of the string. The baseline of
4667 the string is parallel to a line joining (
4668 x,
4669 y,
4670 z) to (
4671 x+
4672 dx,
4673 y+
4674 dy,
4675 z+
4676 dz) .
4677
4678 dy (PLFLT, input) : Together with dx and
4679 dz, this specifies the inclination of the string.
4680
4681 dz (PLFLT, input) : Together with dx and
4682 dy, this specifies the inclination of the string.
4683
4684 sx (PLFLT, input) : Together with sy and
4685 sz , this specifies the shear of the string. The string is sheared so
4686 that the characters are vertically parallel to a line joining (
4687 x,
4688 y,
4689 z) to (
4690 x+
4691 sx,
4692 y+
4693 sy,
4694 z+
4695 sz) . If sx =
4696 sy =
4697 sz = 0.) then the text is not sheared.
4698
4699 sy (PLFLT, input) : Together with sx and
4700 sz, this specifies shear of the string.
4701
4702 sz (PLFLT, input) : Together with sx and
4703 sy, this specifies shear of the string.
4704
4705 just (PLFLT, input) : Specifies the position of the string relative
4706 to its reference point. If just=0. , the reference point is at
4707 the left and if just=1. , it is at the right of the string. Other
4708 values of just give intermediate justifications.
4709
4710 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4711 written out.
4712
4713 """
4714 return _plplotc.plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4715
4717 r"""
4718 Random number generator returning a real random number in the range [0,1]
4719
4720 DESCRIPTION:
4721
4722 Random number generator returning a real random number in the range
4723 [0,1]. The generator is based on the Mersenne Twister. Most languages
4724 / compilers provide their own random number generator, and so this is
4725 provided purely for convenience and to give a consistent random number
4726 generator across all languages supported by PLplot. This is
4727 particularly useful for comparing results from the test suite of
4728 examples.
4729
4730 Redacted form: plrandd()
4731
4732 This function is used in examples 17 and 21.
4733
4734
4735
4736 SYNOPSIS:
4737
4738 plrandd()
4739
4740 """
4741 return _plplotc.plrandd()
4742
4744 r"""
4745 Replays contents of plot buffer to current device/file
4746
4747 DESCRIPTION:
4748
4749 Replays contents of plot buffer to current device/file.
4750
4751 Redacted form: plreplot()
4752
4753 This function is used in example 1,20.
4754
4755
4756
4757 SYNOPSIS:
4758
4759 plreplot()
4760
4761 """
4762 return _plplotc.plreplot()
4763
4764def plrgbhls(r, g, b):
4765 r"""
4766 Convert RGB color to HLS
4767
4768 DESCRIPTION:
4769
4770 Convert RGB color coordinates to HLS
4771
4772 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
4773
4774
4775 This function is used in example 2.
4776
4777
4778
4779 SYNOPSIS:
4780
4781 plrgbhls(r, g, b, p_h, p_l, p_s)
4782
4783 ARGUMENTS:
4784
4785 r (PLFLT, input) : Red intensity (0.0-1.0) of the color.
4786
4787 g (PLFLT, input) : Green intensity (0.0-1.0) of the color.
4788
4789 b (PLFLT, input) : Blue intensity (0.0-1.0) of the color.
4790
4791 p_h (PLFLT_NC_SCALAR, output) : Returned value of the hue in
4792 degrees (0.0-360.0) on the color cylinder.
4793
4794 p_l (PLFLT_NC_SCALAR, output) : Returned value of the lightness
4795 expressed as a fraction (0.0-1.0) of the axis of the color
4796 cylinder.
4797
4798 p_s (PLFLT_NC_SCALAR, output) : Returned value of the saturation
4799 expressed as a fraction (0.0-1.0) of the radius of the color
4800 cylinder.
4801
4802 """
4803 return _plplotc.plrgbhls(r, g, b)
4804
4805def plschr(_def, scale):
4806 r"""
4807 Set character size
4808
4809 DESCRIPTION:
4810
4811 This sets up the size of all subsequent characters drawn. The actual
4812 height of a character is the product of the default character size and
4813 a scaling factor.
4814
4815 Redacted form: plschr(def, scale)
4816
4817 This function is used in examples 2, 13, 23, and 24.
4818
4819
4820
4821 SYNOPSIS:
4822
4823 plschr(def, scale)
4824
4825 ARGUMENTS:
4826
4827 def (PLFLT, input) : The default height of a character in
4828 millimeters, should be set to zero if the default height is to
4829 remain unchanged. For rasterized drivers the dx and dy values
4830 specified in plspage are used to convert from mm to pixels (note
4831 the different unit systems used). This dpi aware scaling is not
4832 implemented for all drivers yet.
4833
4834 scale (PLFLT, input) : Scale factor to be applied to default to get
4835 actual character height.
4836
4837 """
4838 return _plplotc.plschr(_def, scale)
4839
4840def plscmap0(Array, arg2, arg3):
4841 r"""
4842 Set cmap0 colors by 8-bit RGB values
4843
4844 DESCRIPTION:
4845
4846 Set cmap0 colors using 8-bit RGB values (see the PLplot
4847 documentation). This sets the entire color map -- only as many colors
4848 as specified will be allocated.
4849
4850 Redacted form: plscmap0(r, g, b)
4851
4852 This function is used in examples 2 and 24.
4853
4854
4855
4856 SYNOPSIS:
4857
4858 plscmap0(r, g, b, ncol0)
4859
4860 ARGUMENTS:
4861
4862 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4863 integers (0-255) representing the degree of red in the color.
4864
4865 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4866 integers (0-255) representing the degree of green in the color.
4867
4868 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4869 integers (0-255) representing the degree of blue in the color.
4870
4871 ncol0 (PLINT, input) : Number of items in the r, g, and b vectors.
4872
4873 """
4874 return _plplotc.plscmap0(Array, arg2, arg3)
4875
4876def plscmap0a(Array, arg2, arg3, arg4):
4877 r"""
4878 Set cmap0 colors by 8-bit RGB values and PLFLT alpha transparency value
4879
4880 DESCRIPTION:
4881
4882 Set cmap0 colors using 8-bit RGB values (see the PLplot documentation)
4883 and PLFLT alpha transparency value. This sets the entire color map --
4884 only as many colors as specified will be allocated.
4885
4886 Redacted form: plscmap0a(r, g, b, alpha)
4887
4888 This function is used in examples 30.
4889
4890
4891
4892 SYNOPSIS:
4893
4894 plscmap0a(r, g, b, alpha, ncol0)
4895
4896 ARGUMENTS:
4897
4898 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4899 integers (0-255) representing the degree of red in the color.
4900
4901 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4902 integers (0-255) representing the degree of green in the color.
4903
4904 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4905 integers (0-255) representing the degree of blue in the color.
4906
4907 alpha (PLFLT_VECTOR, input) : A vector containing values (0.0-1.0)
4908 representing the alpha transparency of the color.
4909
4910 ncol0 (PLINT, input) : Number of items in the r, g, b, and alpha
4911 vectors.
4912
4913 """
4914 return _plplotc.plscmap0a(Array, arg2, arg3, arg4)
4915
4916def plscmap0n(ncol0):
4917 r"""
4918 Set number of colors in cmap0
4919
4920 DESCRIPTION:
4921
4922 Set number of colors in cmap0 (see the PLplot documentation). Allocate
4923 (or reallocate) cmap0, and fill with default values for those colors
4924 not previously allocated. The first 16 default colors are given in
4925 the plcol0 documentation. For larger indices the default color is
4926 red.
4927
4928 The drivers are not guaranteed to support more than 16 colors.
4929
4930 Redacted form: plscmap0n(ncol0)
4931
4932 This function is used in examples 15, 16, and 24.
4933
4934
4935
4936 SYNOPSIS:
4937
4938 plscmap0n(ncol0)
4939
4940 ARGUMENTS:
4941
4942 ncol0 (PLINT, input) : Number of colors that will be allocated in
4943 the cmap0 palette. If this number is zero or less, then the value
4944 from the previous call to plscmap0n is used and if there is no
4945 previous call, then a default value is used.
4946
4947 """
4948 return _plplotc.plscmap0n(ncol0)
4949
4950def plscmap1(Array, arg2, arg3):
4951 r"""
4952 Set opaque RGB cmap1 colors values
4953
4954 DESCRIPTION:
4955
4956 Set opaque cmap1 colors (see the PLplot documentation) using RGB
4957 vector values. This function also sets the number of cmap1 colors.
4958 N.B. Continuous cmap1 colors are indexed with a floating-point index
4959 in the range from 0.0-1.0 which is linearly transformed (e.g., by
4960 plcol1) to an integer index of these RGB vectors in the range from 0
4961 to
4962 ncol1-1. So in order for this continuous color model to work
4963 properly, it is the responsibility of the user of plscmap1 to insure
4964 that these RGB vectors are continuous functions of their integer
4965 indices.
4966
4967 Redacted form: plscmap1(r, g, b)
4968
4969 This function is used in example 31.
4970
4971
4972
4973 SYNOPSIS:
4974
4975 plscmap1(r, g, b, ncol1)
4976
4977 ARGUMENTS:
4978
4979 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
4980 8-bit integers in the range from 0-255) the degree of red in the
4981 color as a continuous function of the integer index of the vector.
4982
4983 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
4984 8-bit integers in the range from 0-255) the degree of green in the
4985 color as a continuous function of the integer index of the vector.
4986
4987 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
4988 8-bit integers in the range from 0-255) the degree of blue in the
4989 color as a continuous function of the integer index of the vector.
4990
4991 ncol1 (PLINT, input) : Number of items in the r, g, and b vectors.
4992
4993 """
4994 return _plplotc.plscmap1(Array, arg2, arg3)
4995
4996def plscmap1a(Array, arg2, arg3, arg4):
4997 r"""
4998 Set semitransparent cmap1 RGBA colors.
4999
5000 DESCRIPTION:
5001
5002 Set semitransparent cmap1 colors (see the PLplot documentation) using
5003 RGBA vector values. This function also sets the number of cmap1
5004 colors. N.B. Continuous cmap1 colors are indexed with a
5005 floating-point index in the range from 0.0-1.0 which is linearly
5006 transformed (e.g., by plcol1) to an integer index of these RGBA
5007 vectors in the range from 0 to
5008 ncol1-1. So in order for this continuous color model to work
5009 properly, it is the responsibility of the user of plscmap1 to insure
5010 that these RGBA vectors are continuous functions of their integer
5011 indices.
5012
5013 Redacted form: plscmap1a(r, g, b, alpha)
5014
5015 This function is used in example 31.
5016
5017
5018
5019 SYNOPSIS:
5020
5021 plscmap1a(r, g, b, alpha, ncol1)
5022
5023 ARGUMENTS:
5024
5025 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
5026 8-bit integers in the range from 0-255) the degree of red in the
5027 color as a continuous function of the integer index of the vector.
5028
5029 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
5030 8-bit integers in the range from 0-255) the degree of green in the
5031 color as a continuous function of the integer index of the vector.
5032
5033 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
5034 8-bit integers in the range from 0-255) the degree of blue in the
5035 color as a continuous function of the integer index of the vector.
5036
5037 alpha (PLFLT_VECTOR, input) : A vector that represents (using PLFLT
5038 values in the range from 0.0-1.0 where 0.0 corresponds to
5039 completely transparent and 1.0 corresponds to completely opaque)
5040 the alpha transparency of the color as a continuous function of
5041 the integer index of the vector.
5042
5043 ncol1 (PLINT, input) : Number of items in the r, g, b, and alpha
5044 vectors.
5045
5046 """
5047 return _plplotc.plscmap1a(Array, arg2, arg3, arg4)
5048
5049def plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null):
5050 r"""
5051 Set cmap1 colors using a piece-wise linear relationship
5052
5053 DESCRIPTION:
5054
5055 Set cmap1 colors using a piece-wise linear relationship between the
5056 cmap1 intensity index (0.0-1.0) and position in HLS or RGB color space
5057 (see the PLplot documentation). May be called at any time.
5058
5059 The idea here is to specify a number of control points that define the
5060 mapping between input cmap1 intensity indices and HLS or RGB. Between
5061 these points, linear interpolation is used which gives a smooth
5062 variation of color with intensity index. Any number of control points
5063 may be specified, located at arbitrary positions, although typically 2
5064 - 4 are enough. Another way of stating this is that we are traversing
5065 a given number of lines through HLS or RGB space as we move through
5066 cmap1 intensity indices. The control points at the minimum and
5067 maximum position (0 and 1) must always be specified. By adding more
5068 control points you can get more variation. One good technique for
5069 plotting functions that vary about some expected average is to use an
5070 additional 2 control points in the center (position ~= 0.5) that are
5071 the same lightness as the background (typically white for paper
5072 output, black for crt), and same hue as the boundary control points.
5073 This allows the highs and lows to be very easily distinguished.
5074
5075 Each control point must specify the cmap1 intensity index and the
5076 associated three coordinates in HLS or RGB space. The first point
5077 must correspond to position = 0, and the last to position = 1.
5078
5079 If RGB colors are provided then the interpolation takes place in RGB
5080 space and is trivial. However if HLS colors are provided then, because
5081 of the circular nature of the color wheel for the hue coordinate, the
5082 interpolation could be performed in either direction around the color
5083 wheel. The default behaviour is for the hue to be linearly
5084 interpolated ignoring this circular property of hue. So for example,
5085 the hues 0 (red) and 240 (blue) will get interpolated via yellow,
5086 green and cyan. If instead you wish to interpolate the other way
5087 around the color wheel you have two options. You may provide hues
5088 outside the range [0, 360), so by using a hue of -120 for blue or 360
5089 for red the interpolation will proceed via magenta. Alternatively you
5090 can utilise the alt_hue_path variable to reverse the direction of
5091 interpolation if you need to provide hues within the [0-360) range.
5092
5093 Examples of interpolation Huealt_hue_pathcolor scheme[120
5094 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120
5095 -120]falsegreen-yellow-red-magenta-blue[240
5096 480]falseblue-magenta-red-yellow-green[120
5097 240]truegreen-yellow-red-magenta-blue[240
5098 120]trueblue-magenta-red-yellow-green
5099
5100 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
5101 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
5102 1]magnitudeHLSsaturation[0, 1]magnitude
5103
5104 Redacted form: plscmap1l(itype, intensity, coord1, coord2, coord3,
5105 alt_hue_path)
5106
5107 This function is used in examples 8, 11, 12, 15, 20, and 21.
5108
5109
5110
5111 SYNOPSIS:
5112
5113 plscmap1l(itype, npts, intensity, coord1, coord2, coord3, alt_hue_path)
5114
5115 ARGUMENTS:
5116
5117 itype (PLBOOL, input) : true: RGB, false: HLS.
5118
5119 npts (PLINT, input) : number of control points
5120
5121 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5122 intensity index (0.0-1.0) in ascending order for each control
5123 point.
5124
5125 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5126 coordinate (H or R) for each control point.
5127
5128 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5129 coordinate (L or G) for each control point.
5130
5131 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5132 coordinate (S or B) for each control point.
5133
5134 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with
5135 npts - 1 elements), each containing either true to use the reversed
5136 HLS interpolation or false to use the regular HLS interpolation.
5137 (alt_hue_path[i] refers to the interpolation interval between the
5138 i and i + 1 control points). This parameter is not used for RGB
5139 colors (
5140 itype = true).
5141
5142 """
5143 return _plplotc.plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null)
5144
5145def plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null):
5146 r"""
5147 Set cmap1 colors and alpha transparency using a piece-wise linear relationship
5148
5149 DESCRIPTION:
5150
5151 This is a variant of plscmap1l that supports alpha channel
5152 transparency. It sets cmap1 colors using a piece-wise linear
5153 relationship between cmap1 intensity index (0.0-1.0) and position in
5154 HLS or RGB color space (see the PLplot documentation) with alpha
5155 transparency value (0.0-1.0). It may be called at any time.
5156
5157 Redacted form: plscmap1la(itype, intensity, coord1, coord2, coord3,
5158 alpha, alt_hue_path)
5159
5160 This function is used in example 30.
5161
5162
5163
5164 SYNOPSIS:
5165
5166 plscmap1la(itype, npts, intensity, coord1, coord2, coord3, alpha, alt_hue_path)
5167
5168 ARGUMENTS:
5169
5170 itype (PLBOOL, input) : true: RGB, false: HLS.
5171
5172 npts (PLINT, input) : number of control points.
5173
5174 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5175 intensity index (0.0-1.0) in ascending order for each control
5176 point.
5177
5178 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5179 coordinate (H or R) for each control point.
5180
5181 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5182 coordinate (L or G) for each control point.
5183
5184 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5185 coordinate (S or B) for each control point.
5186
5187 alpha (PLFLT_VECTOR, input) : A vector containing the alpha
5188 transparency value (0.0-1.0) for each control point.
5189
5190 alt_hue_path (PLBOOL_VECTOR, input) : A vector (with
5191 npts - 1 elements) containing the alternative interpolation method
5192 Boolean value for each control point interval. (alt_hue_path[i]
5193 refers to the interpolation interval between the i and i + 1
5194 control points).
5195
5196 """
5197 return _plplotc.plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null)
5198
5199def plscmap1n(ncol1):
5200 r"""
5201 Set number of colors in cmap1
5202
5203 DESCRIPTION:
5204
5205 Set number of colors in cmap1, (re-)allocate cmap1, and set default
5206 values if this is the first allocation (see the PLplot documentation).
5207
5208 Redacted form: plscmap1n(ncol1)
5209
5210 This function is used in examples 8, 11, 20, and 21.
5211
5212
5213
5214 SYNOPSIS:
5215
5216 plscmap1n(ncol1)
5217
5218 ARGUMENTS:
5219
5220 ncol1 (PLINT, input) : Number of colors that will be allocated in
5221 the cmap1 palette. If this number is zero or less, then the value
5222 from the previous call to plscmap1n is used and if there is no
5223 previous call, then a default value is used.
5224
5225 """
5226 return _plplotc.plscmap1n(ncol1)
5227
5228def plscmap1_range(min_color, max_color):
5229 r"""
5230 Set the cmap1 argument range for continuous color plots
5231
5232 DESCRIPTION:
5233
5234 Set the cmap1 argument range for continuous color plots that
5235 corresponds to the range of data values. The maximum range
5236 corresponding to the entire cmap1 palette is 0.0-1.0, and the smaller
5237 the cmap1 argument range that is specified with this routine, the
5238 smaller the subset of the cmap1 color palette that is used to
5239 represent the continuous data being plotted. If
5240 min_color is greater than
5241 max_color or
5242 max_color is greater than 1.0 or
5243 min_color is less than 0.0 then no change is made to the cmap1
5244 argument range. (Use plgcmap1_range to get the cmap1 argument range.)
5245
5246 Redacted form: plscmap1_range(min_color, max_color)
5247
5248 This function is currently used in example 33.
5249
5250
5251
5252 SYNOPSIS:
5253
5254 plscmap1_range(min_color, max_color)
5255
5256 ARGUMENTS:
5257
5258 min_color (PLFLT, input) : The minimum cmap1 argument. If less
5259 than 0.0, then 0.0 is used instead.
5260
5261 max_color (PLFLT, input) : The maximum cmap1 argument. If greater
5262 than 1.0, then 1.0 is used instead.
5263
5264 """
5265 return _plplotc.plscmap1_range(min_color, max_color)
5266
5268 r"""
5269 Get the cmap1 argument range for continuous color plots
5270
5271 DESCRIPTION:
5272
5273 Get the cmap1 argument range for continuous color plots. (Use
5274 plscmap1_range to set the cmap1 argument range.)
5275
5276 Redacted form: plgcmap1_range(min_color, max_color)
5277
5278 This function is currently not used in any example.
5279
5280
5281
5282 SYNOPSIS:
5283
5284 plgcmap1_range(min_color, max_color)
5285
5286 ARGUMENTS:
5287
5288 min_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5289 minimum cmap1 argument.
5290
5291 max_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5292 maximum cmap1 argument.
5293
5294 """
5295 return _plplotc.plgcmap1_range()
5296
5297def plscol0(icol0, r, g, b):
5298 r"""
5299 Set 8-bit RGB values for given cmap0 color index
5300
5301 DESCRIPTION:
5302
5303 Set 8-bit RGB values for given cmap0 (see the PLplot documentation)
5304 index. Overwrites the previous color value for the given index and,
5305 thus, does not result in any additional allocation of space for
5306 colors.
5307
5308 Redacted form: plscol0(icol0, r, g, b)
5309
5310 This function is used in any example 31.
5311
5312
5313
5314 SYNOPSIS:
5315
5316 plscol0(icol0, r, g, b)
5317
5318 ARGUMENTS:
5319
5320 icol0 (PLINT, input) : Color index. Must be less than the maximum
5321 number of colors (which is set by default, by plscmap0n, or even
5322 by plscmap0).
5323
5324 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5325 degree of red in the color.
5326
5327 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5328 degree of green in the color.
5329
5330 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5331 degree of blue in the color.
5332
5333 """
5334 return _plplotc.plscol0(icol0, r, g, b)
5335
5336def plscol0a(icol0, r, g, b, a):
5337 r"""
5338 Set 8-bit RGB values and PLFLT alpha transparency value for given cmap0 color index
5339
5340 DESCRIPTION:
5341
5342 Set 8-bit RGB value and PLFLT alpha transparency value for given cmap0
5343 (see the PLplot documentation) index. Overwrites the previous color
5344 value for the given index and, thus, does not result in any additional
5345 allocation of space for colors.
5346
5347 This function is used in example 30.
5348
5349
5350
5351 SYNOPSIS:
5352
5353 plscol0a(icol0, r, g, b, alpha)
5354
5355 ARGUMENTS:
5356
5357 icol0 (PLINT, input) : Color index. Must be less than the maximum
5358 number of colors (which is set by default, by plscmap0n, or even
5359 by plscmap0).
5360
5361 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5362 degree of red in the color.
5363
5364 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5365 degree of green in the color.
5366
5367 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5368 degree of blue in the color.
5369
5370 alpha (PLFLT, input) : Value of the alpha transparency in the range
5371 (0.0-1.0).
5372
5373 """
5374 return _plplotc.plscol0a(icol0, r, g, b, a)
5375
5376def plscolbg(r, g, b):
5377 r"""
5378 Set the background color by 8-bit RGB value
5379
5380 DESCRIPTION:
5381
5382 Set the background color (color 0 in cmap0) by 8-bit RGB value (see
5383 the PLplot documentation).
5384
5385 Redacted form: plscolbg(r, g, b)
5386
5387 This function is used in examples 15 and 31.
5388
5389
5390
5391 SYNOPSIS:
5392
5393 plscolbg(r, g, b)
5394
5395 ARGUMENTS:
5396
5397 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5398 degree of red in the color.
5399
5400 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5401 degree of green in the color.
5402
5403 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5404 degree of blue in the color.
5405
5406 """
5407 return _plplotc.plscolbg(r, g, b)
5408
5409def plscolbga(r, g, b, a):
5410 r"""
5411 Set the background color by 8-bit RGB value and PLFLT alpha transparency value.
5412
5413 DESCRIPTION:
5414
5415 Set the background color (color 0 in cmap0) by 8-bit RGB value and
5416 PLFLT alpha transparency value (see the PLplot documentation).
5417
5418 This function is used in example 31.
5419
5420
5421
5422 SYNOPSIS:
5423
5424 plscolbga(r, g, b, alpha)
5425
5426 ARGUMENTS:
5427
5428 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5429 degree of red in the color.
5430
5431 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5432 degree of green in the color.
5433
5434 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5435 degree of blue in the color.
5436
5437 alpha (PLFLT, input) : Value of the alpha transparency in the range
5438 (0.0-1.0).
5439
5440 """
5441 return _plplotc.plscolbga(r, g, b, a)
5442
5443def plscolor(color):
5444 r"""
5445 Used to globally turn color output on/off
5446
5447 DESCRIPTION:
5448
5449 Used to globally turn color output on/off for those drivers/devices
5450 that support it.
5451
5452 Redacted form: plscolor(color)
5453
5454 This function is used in example 31.
5455
5456
5457
5458 SYNOPSIS:
5459
5460 plscolor(color)
5461
5462 ARGUMENTS:
5463
5464 color (PLINT, input) : Color flag (Boolean). If zero, color is
5465 turned off. If non-zero, color is turned on.
5466
5467 """
5468 return _plplotc.plscolor(color)
5469
5470def plscompression(compression):
5471 r"""
5472 Set device-compression level
5473
5474 DESCRIPTION:
5475
5476 Set device-compression level. Only used for drivers that provide
5477 compression. This function, if used, should be invoked before a call
5478 to plinit.
5479
5480 Redacted form: plscompression(compression)
5481
5482 This function is used in example 31.
5483
5484
5485
5486 SYNOPSIS:
5487
5488 plscompression(compression)
5489
5490 ARGUMENTS:
5491
5492 compression (PLINT, input) : The desired compression level. This is
5493 a device-dependent value. Currently only the jpeg and png devices
5494 use these values. For jpeg value is the jpeg quality which should
5495 normally be in the range 0-95. Higher values denote higher quality
5496 and hence larger image sizes. For png values are in the range -1
5497 to 99. Values of 0-9 are taken as the compression level for zlib.
5498 A value of -1 denotes the default zlib compression level. Values
5499 in the range 10-99 are divided by 10 and then used as the zlib
5500 compression level. Higher compression levels correspond to greater
5501 compression and small file sizes at the expense of more
5502 computation.
5503
5504 """
5505 return _plplotc.plscompression(compression)
5506
5507def plsdev(devname):
5508 r"""
5509 Set the device (keyword) name
5510
5511 DESCRIPTION:
5512
5513 Set the device (keyword) name.
5514
5515 Redacted form: plsdev(devname)
5516
5517 This function is used in examples 1, 14, and 20.
5518
5519
5520
5521 SYNOPSIS:
5522
5523 plsdev(devname)
5524
5525 ARGUMENTS:
5526
5527 devname (PLCHAR_VECTOR, input) : An ascii character string
5528 containing the device name keyword of the required output device.
5529 If
5530 devname is NULL or if the first character of the string is a ``?'',
5531 the normal (prompted) start up is used.
5532
5533 """
5534 return _plplotc.plsdev(devname)
5535
5536def plsdidev(mar, aspect, jx, jy):
5537 r"""
5538 Set parameters that define current device-space window
5539
5540 DESCRIPTION:
5541
5542 Set relative margin width, aspect ratio, and relative justification
5543 that define current device-space window. If you want to just use the
5544 previous value for any of these, just pass in the magic value
5545 PL_NOTSET. It is unlikely that one should ever need to change the
5546 aspect ratio but it's in there for completeness. If plsdidev is not
5547 called the default values of mar, jx, and jy are all 0. aspect is set
5548 to a device-specific value.
5549
5550 Redacted form: plsdidev(mar, aspect, jx, jy)
5551
5552 This function is used in example 31.
5553
5554
5555
5556 SYNOPSIS:
5557
5558 plsdidev(mar, aspect, jx, jy)
5559
5560 ARGUMENTS:
5561
5562 mar (PLFLT, input) : Relative margin width.
5563
5564 aspect (PLFLT, input) : Aspect ratio.
5565
5566 jx (PLFLT, input) : Relative justification in x. Value must lie in
5567 the range -0.5 to 0.5.
5568
5569 jy (PLFLT, input) : Relative justification in y. Value must lie in
5570 the range -0.5 to 0.5.
5571
5572 """
5573 return _plplotc.plsdidev(mar, aspect, jx, jy)
5574
5575def plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm):
5576 r"""
5577 Set up transformation from metafile coordinates
5578
5579 DESCRIPTION:
5580
5581 Set up transformation from metafile coordinates. The size of the plot
5582 is scaled so as to preserve aspect ratio. This isn't intended to be a
5583 general-purpose facility just yet (not sure why the user would need
5584 it, for one).
5585
5586 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
5587 dimypmm)
5588
5589 This function is not used in any examples.
5590
5591
5592
5593 SYNOPSIS:
5594
5595 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5596
5597 ARGUMENTS:
5598
5599 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
5600
5601 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
5602
5603 dimymin (PLINT, input) : NEEDS DOCUMENTATION
5604
5605 dimymax (PLINT, input) : NEEDS DOCUMENTATION
5606
5607 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
5608
5609 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
5610
5611 """
5612 return _plplotc.plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5613
5614def plsdiori(rot):
5615 r"""
5616 Set plot orientation
5617
5618 DESCRIPTION:
5619
5620 Set plot orientation parameter which is multiplied by 90 degrees to
5621 obtain the angle of rotation. Note, arbitrary rotation parameters
5622 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
5623 values for the rotation parameter are 0., 1., 2., and 3. corresponding
5624 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
5625 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is
5626 not called the default value of rot is 0.
5627
5628 N.B. aspect ratio is unaffected by calls to plsdiori. So you will
5629 probably want to change the aspect ratio to a value suitable for the
5630 plot orientation using a call to plsdidev or the command-line options
5631 -a or -freeaspect. For more documentation of those options see the
5632 PLplot documentation. Such command-line options can be set internally
5633 using plsetopt or set directly using the command line and parsed using
5634 a call to plparseopts.
5635
5636 Redacted form: plsdiori(rot)
5637
5638 This function is not used in any examples.
5639
5640
5641
5642 SYNOPSIS:
5643
5644 plsdiori(rot)
5645
5646 ARGUMENTS:
5647
5648 rot (PLFLT, input) : Plot orientation parameter.
5649
5650 """
5651 return _plplotc.plsdiori(rot)
5652
5653def plsdiplt(xmin, ymin, xmax, ymax):
5654 r"""
5655 Set parameters that define current plot-space window
5656
5657 DESCRIPTION:
5658
5659 Set relative minima and maxima that define the current plot-space
5660 window. If plsdiplt is not called the default values of xmin, ymin,
5661 xmax, and ymax are 0., 0., 1., and 1.
5662
5663 Redacted form: plsdiplt(xmin, ymin, xmax, ymax)
5664
5665 This function is used in example 31.
5666
5667
5668
5669 SYNOPSIS:
5670
5671 plsdiplt(xmin, ymin, xmax, ymax)
5672
5673 ARGUMENTS:
5674
5675 xmin (PLFLT, input) : Relative minimum in x.
5676
5677 ymin (PLFLT, input) : Relative minimum in y.
5678
5679 xmax (PLFLT, input) : Relative maximum in x.
5680
5681 ymax (PLFLT, input) : Relative maximum in y.
5682
5683 """
5684 return _plplotc.plsdiplt(xmin, ymin, xmax, ymax)
5685
5686def plsdiplz(xmin, ymin, xmax, ymax):
5687 r"""
5688 Set parameters incrementally (zoom mode) that define current plot-space window
5689
5690 DESCRIPTION:
5691
5692 Set relative minima and maxima incrementally (zoom mode) that define
5693 the current plot-space window. This function has the same effect as
5694 plsdiplt if that function has not been previously called. Otherwise,
5695 this function implements zoom mode using the transformation min_used =
5696 old_min + old_length*min and max_used = old_min + old_length*max for
5697 each axis. For example, if min = 0.05 and max = 0.95 for each axis,
5698 repeated calls to plsdiplz will zoom in by 10 per cent for each call.
5699
5700 Redacted form: plsdiplz(xmin, ymin, xmax, ymax)
5701
5702 This function is used in example 31.
5703
5704
5705
5706 SYNOPSIS:
5707
5708 plsdiplz(xmin, ymin, xmax, ymax)
5709
5710 ARGUMENTS:
5711
5712 xmin (PLFLT, input) : Relative (incremental) minimum in x.
5713
5714 ymin (PLFLT, input) : Relative (incremental) minimum in y.
5715
5716 xmax (PLFLT, input) : Relative (incremental) maximum in x.
5717
5718 ymax (PLFLT, input) : Relative (incremental) maximum in y.
5719
5720 """
5721 return _plplotc.plsdiplz(xmin, ymin, xmax, ymax)
5722
5723def plseed(s):
5724 r"""
5725 Set seed for internal random number generator.
5726
5727 DESCRIPTION:
5728
5729 Set the seed for the internal random number generator. See plrandd for
5730 further details.
5731
5732 Redacted form: plseed(seed)
5733
5734 This function is used in example 21.
5735
5736
5737
5738 SYNOPSIS:
5739
5740 plseed(seed)
5741
5742 ARGUMENTS:
5743
5744 seed (unsigned int, input) : Seed for random number generator.
5745
5746 """
5747 return _plplotc.plseed(s)
5748
5749def plsesc(esc):
5750 r"""
5751 Set the escape character for text strings
5752
5753 DESCRIPTION:
5754
5755 Set the escape character for text strings. From C (in contrast to
5756 Fortran, see plsescfortran) you pass esc as a character. Only selected
5757 characters are allowed to prevent the user from shooting himself in
5758 the foot (For example, a \ isn't allowed since it conflicts with C's
5759 use of backslash as a character escape). Here are the allowed escape
5760 characters and their corresponding decimal ASCII values: !, ASCII 33
5761 #, ASCII 35
5762 $, ASCII 36
5763 %, ASCII 37
5764 &, ASCII 38
5765 *, ASCII 42
5766 @, ASCII 64
5767 ^, ASCII 94
5768 ~, ASCII 126
5769
5770
5771 Redacted form: General: plsesc(esc)
5772
5773
5774 This function is used in example 29.
5775
5776
5777
5778 SYNOPSIS:
5779
5780 plsesc(esc)
5781
5782 ARGUMENTS:
5783
5784 esc (char, input) : Escape character.
5785
5786 """
5787 return _plplotc.plsesc(esc)
5788
5789def plsetopt(opt, optarg):
5790 r"""
5791 Set any command-line option
5792
5793 DESCRIPTION:
5794
5795 Set any command-line option internally from a program before it
5796 invokes plinit. opt is the name of the command-line option and optarg
5797 is the corresponding command-line option argument.
5798
5799 This function returns 0 on success.
5800
5801 Redacted form: plsetopt(opt, optarg)
5802
5803 This function is used in example 14.
5804
5805
5806
5807 SYNOPSIS:
5808
5809 PLINT plsetopt(opt, optarg)
5810
5811 ARGUMENTS:
5812
5813 opt (PLCHAR_VECTOR, input) : An ascii character string containing
5814 the command-line option.
5815
5816 optarg (PLCHAR_VECTOR, input) : An ascii character string
5817 containing the argument of the command-line option.
5818
5819 """
5820 return _plplotc.plsetopt(opt, optarg)
5821
5822def plsfam(fam, num, bmax):
5823 r"""
5824 Set family file parameters
5825
5826 DESCRIPTION:
5827
5828 Sets variables dealing with output file familying. Does nothing if
5829 familying not supported by the driver. This routine, if used, must be
5830 called before initializing PLplot. See the PLplot documentation for
5831 more information.
5832
5833 Redacted form: plsfam(fam, num, bmax)
5834
5835 This function is used in examples 14 and 31.
5836
5837
5838
5839 SYNOPSIS:
5840
5841 plsfam(fam, num, bmax)
5842
5843 ARGUMENTS:
5844
5845 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
5846 is enabled.
5847
5848 num (PLINT, input) : Current family file number.
5849
5850 bmax (PLINT, input) : Maximum file size (in bytes) for a family
5851 file.
5852
5853 """
5854 return _plplotc.plsfam(fam, num, bmax)
5855
5856def plsfci(fci):
5857 r"""
5858 Set FCI (font characterization integer)
5859
5860 DESCRIPTION:
5861
5862 Sets font characteristics to be used at the start of the next string
5863 using the FCI approach. See the PLplot documentation for more
5864 information. Note, plsfont (which calls plsfci internally) provides a
5865 more user-friendly API for setting the font characterisitics.
5866
5867 Redacted form: General: plsfci(fci)
5868
5869
5870 This function is used in example 23.
5871
5872
5873
5874 SYNOPSIS:
5875
5876 plsfci(fci)
5877
5878 ARGUMENTS:
5879
5880 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
5881 of FCI.
5882
5883 """
5884 return _plplotc.plsfci(fci)
5885
5886def plsfnam(fnam):
5887 r"""
5888 Set output file name
5889
5890 DESCRIPTION:
5891
5892 Sets the current output file name, if applicable. If the file name
5893 has not been specified and is required by the driver, the user will be
5894 prompted for it. If using the X-windows output driver, this sets the
5895 display name. This routine, if used, must be called before
5896 initializing PLplot.
5897
5898 Redacted form: plsfnam(fnam)
5899
5900 This function is used in examples 1 and 20.
5901
5902
5903
5904 SYNOPSIS:
5905
5906 plsfnam(fnam)
5907
5908 ARGUMENTS:
5909
5910 fnam (PLCHAR_VECTOR, input) : An ascii character string containing
5911 the file name.
5912
5913 """
5914 return _plplotc.plsfnam(fnam)
5915
5916def plsfont(family, style, weight):
5917 r"""
5918 Set family, style and weight of the current font
5919
5920 DESCRIPTION:
5921
5922 Sets the current font. See the PLplot documentation for more
5923 information on font selection.
5924
5925 Redacted form: plsfont(family, style, weight)
5926
5927 This function is used in example 23.
5928
5929
5930
5931 SYNOPSIS:
5932
5933 plsfont(family, style, weight)
5934
5935 ARGUMENTS:
5936
5937 family (PLINT, input) : Font family to select for the current font.
5938 The available values are given by the PL_FCI_* constants in
5939 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
5940 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value
5941 signifies that the font family should not be altered.
5942
5943 style (PLINT, input) : Font style to select for the current font.
5944 The available values are given by the PL_FCI_* constants in
5945 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and
5946 PL_FCI_OBLIQUE. A negative value signifies that the font style
5947 should not be altered.
5948
5949 weight (PLINT, input) : Font weight to select for the current font.
5950 The available values are given by the PL_FCI_* constants in
5951 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A
5952 negative value signifies that the font weight should not be
5953 altered.
5954
5955 """
5956 return _plplotc.plsfont(family, style, weight)
5957
5958def plshades(*args):
5959 r"""
5960 Shade regions on the basis of value
5961
5962 DESCRIPTION:
5963
5964 Shade regions on the basis of value. This is the high-level routine
5965 for making continuous color shaded plots with cmap1 while plshade
5966 should be used to plot individual shaded regions using either cmap0 or
5967 cmap1. examples/;<language>/x16* shows how to use plshades for each of
5968 our supported languages.
5969
5970 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
5971 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
5972 pltr_data)
5973
5974
5975 This function is used in examples 16, 21, and 22.
5976
5977
5978
5979 SYNOPSIS:
5980
5981 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
5982
5983 ARGUMENTS:
5984
5985 a (PLFLT_MATRIX, input) : A matrix containing function values to
5986 plot. Should have dimensions of
5987 nx by
5988 ny.
5989
5990 nx (PLINT, input) : First dimension of matrix "a".
5991
5992 ny (PLINT, input) : Second dimension of matrix "a".
5993
5994 defined (PLDEFINED_callback, input) : Callback function specifying
5995 the region that should be plotted in the shade plot. This
5996 function accepts x and y coordinates as input arguments and must
5997 return 1 if the point is to be included in the shade plot and 0
5998 otherwise. If you want to plot the entire shade plot (the usual
5999 case), this argument should be set to NULL.
6000
6001 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6002 pltr below for how these arguments are used (only for the special case
6003 when the callback function
6004 pltr is not supplied).
6005
6006 clevel (PLFLT_VECTOR, input) : A vector containing the data levels
6007 corresponding to the edges of each shaded region that will be
6008 plotted by this function. To work properly the levels should be
6009 monotonic.
6010
6011 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
6012 of shade edge values in clevel).
6013
6014 fill_width (PLFLT, input) : Defines the line width used by the fill
6015 pattern.
6016
6017 cont_color (PLINT, input) : Defines cmap0 pen color used for
6018 contours defining edges of shaded regions. The pen color is only
6019 temporary set for the contour drawing. Set this value to zero or
6020 less if no shade edge contours are wanted.
6021
6022 cont_width (PLFLT, input) : Defines line width used for contours
6023 defining edges of shaded regions. This value may not be honored
6024 by all drivers. The pen width is only temporary set for the
6025 contour drawing. Set this value to zero or less if no shade edge
6026 contours are wanted.
6027
6028 fill (PLFILL_callback, input) : Callback routine used to fill the
6029 region. Use plfill for this purpose.
6030
6031 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
6032 map to rectangles after coordinate transformation with pltrl.
6033 Otherwise, set rectangular to false. If rectangular is set to
6034 true, plshade tries to save time by filling large rectangles.
6035 This optimization fails if the coordinate transformation distorts
6036 the shape of rectangles. For example a plot in polar coordinates
6037 has to have rectangular set to false.
6038
6039 pltr (PLTRANSFORM_callback, input) : A callback function that
6040 defines the transformation between the zero-based indices of the
6041 matrix a and world coordinates. If
6042 pltr is not supplied (e.g., is set to NULL in the C case), then the x
6043 indices of a are mapped to the range
6044 xmin through
6045 xmax and the y indices of a are mapped to the range
6046 ymin through
6047 ymax.For the C case, transformation functions are provided in the
6048 PLplot library: pltr0 for the identity mapping, and pltr1 and
6049 pltr2 for arbitrary mappings respectively defined by vectors and
6050 matrices. In addition, C callback routines for the transformation
6051 can be supplied by the user such as the mypltr function in
6052 examples/c/x09c.c which provides a general linear transformation
6053 between index coordinates and world coordinates.For languages
6054 other than C you should consult the PLplot documentation for the
6055 details concerning how PLTRANSFORM_callback arguments are
6056 interfaced. However, in general, a particular pattern of
6057 callback-associated arguments such as a tr vector with 6 elements;
6058 xg and yg vectors; or xg and yg matrices are respectively
6059 interfaced to a linear-transformation routine similar to the above
6060 mypltr function; pltr1; and pltr2. Furthermore, some of our more
6061 sophisticated bindings (see, e.g., the PLplot documentation)
6062 support native language callbacks for handling index to
6063 world-coordinate transformations. Examples of these various
6064 approaches are given in examples/<language>x09*,
6065 examples/<language>x16*, examples/<language>x20*,
6066 examples/<language>x21*, and examples/<language>x22*, for all our
6067 supported languages.
6068
6069 pltr_data (PLPointer, input) : Extra parameter to help pass
6070 information to pltr0, pltr1, pltr2, or whatever routine that is
6071 externally supplied.
6072
6073 """
6074 return _plplotc.plshades(*args)
6075
6076def plshade(*args):
6077 r"""
6078 Shade individual region on the basis of value
6079
6080 DESCRIPTION:
6081
6082 Shade individual region on the basis of value. Use plshades if you
6083 want to shade a number of contiguous regions using continuous colors.
6084 In particular the edge contours are treated properly in plshades. If
6085 you attempt to do contiguous regions with plshade the contours at the
6086 edge of the shade are partially obliterated by subsequent plots of
6087 contiguous shaded regions.
6088
6089 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax,
6090 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
6091 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
6092
6093
6094 This function is used in example 15.
6095
6096
6097
6098 SYNOPSIS:
6099
6100 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)
6101
6102 ARGUMENTS:
6103
6104 a (PLFLT_MATRIX, input) : A matrix containing function values to
6105 plot. Should have dimensions of
6106 nx by
6107 ny.
6108
6109 nx (PLINT, input) : First dimension of the matrix "a".
6110
6111 ny (PLINT, input) : Second dimension of the matrix "a".
6112
6113 defined (PLDEFINED_callback, input) : Callback function specifying
6114 the region that should be plotted in the shade plot. This
6115 function accepts x and y coordinates as input arguments and must
6116 return 1 if the point is to be included in the shade plot and 0
6117 otherwise. If you want to plot the entire shade plot (the usual
6118 case), this argument should be set to NULL.
6119
6120 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6121 pltr below for how these arguments are used (only for the special case
6122 when the callback function
6123 pltr is not supplied).
6124
6125 shade_min (PLFLT, input) : Defines the lower end of the interval to
6126 be shaded. If shade_max <= shade_min, plshade does nothing.
6127
6128 shade_max (PLFLT, input) : Defines the upper end of the interval to
6129 be shaded. If shade_max <= shade_min, plshade does nothing.
6130
6131 sh_cmap (PLINT, input) : Defines color map. If sh_cmap=0, then
6132 sh_color is interpreted as a cmap0 (integer) index. If sh_cmap=1,
6133 then sh_color is interpreted as a cmap1 argument in the range
6134 (0.0-1.0).
6135
6136 sh_color (PLFLT, input) : Defines color map index with integer
6137 value if cmap0 or value in range (0.0-1.0) if cmap1.
6138
6139 sh_width (PLFLT, input) : Defines width used by the fill pattern.
6140
6141 min_color (PLINT, input) : Defines pen color, width used by the
6142 boundary of shaded region. The min values are used for the
6143 shade_min boundary, and the max values are used on the shade_max
6144 boundary. Set color and width to zero for no plotted boundaries.
6145
6146 min_width (PLFLT, input) : Defines pen color, width used by the
6147 boundary of shaded region. The min values are used for the
6148 shade_min boundary, and the max values are used on the shade_max
6149 boundary. Set color and width to zero for no plotted boundaries.
6150
6151 max_color (PLINT, input) : Defines pen color, width used by the
6152 boundary of shaded region. The min values are used for the
6153 shade_min boundary, and the max values are used on the shade_max
6154 boundary. Set color and width to zero for no plotted boundaries.
6155
6156 max_width (PLFLT, input) : Defines pen color, width used by the
6157 boundary of shaded region. The min values are used for the
6158 shade_min boundary, and the max values are used on the shade_max
6159 boundary. Set color and width to zero for no plotted boundaries.
6160
6161 fill (PLFILL_callback, input) : Routine used to fill the region.
6162 Use plfill. Future version of PLplot may have other fill
6163 routines.
6164
6165 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
6166 map to rectangles after coordinate transformation with pltrl.
6167 Otherwise, set rectangular to false. If rectangular is set to
6168 true, plshade tries to save time by filling large rectangles.
6169 This optimization fails if the coordinate transformation distorts
6170 the shape of rectangles. For example a plot in polar coordinates
6171 has to have rectangular set to false.
6172
6173 pltr (PLTRANSFORM_callback, input) : A callback function that
6174 defines the transformation between the zero-based indices of the
6175 matrix a and world coordinates. If
6176 pltr is not supplied (e.g., is set to NULL in the C case), then the x
6177 indices of a are mapped to the range
6178 xmin through
6179 xmax and the y indices of a are mapped to the range
6180 ymin through
6181 ymax.For the C case, transformation functions are provided in the
6182 PLplot library: pltr0 for the identity mapping, and pltr1 and
6183 pltr2 for arbitrary mappings respectively defined by vectors and
6184 matrices. In addition, C callback routines for the transformation
6185 can be supplied by the user such as the mypltr function in
6186 examples/c/x09c.c which provides a general linear transformation
6187 between index coordinates and world coordinates.For languages
6188 other than C you should consult the PLplot documentation for the
6189 details concerning how PLTRANSFORM_callback arguments are
6190 interfaced. However, in general, a particular pattern of
6191 callback-associated arguments such as a tr vector with 6 elements;
6192 xg and yg vectors; or xg and yg matrices are respectively
6193 interfaced to a linear-transformation routine similar to the above
6194 mypltr function; pltr1; and pltr2. Furthermore, some of our more
6195 sophisticated bindings (see, e.g., the PLplot documentation)
6196 support native language callbacks for handling index to
6197 world-coordinate transformations. Examples of these various
6198 approaches are given in examples/<language>x09*,
6199 examples/<language>x16*, examples/<language>x20*,
6200 examples/<language>x21*, and examples/<language>x22*, for all our
6201 supported languages.
6202
6203 pltr_data (PLPointer, input) : Extra parameter to help pass
6204 information to pltr0, pltr1, pltr2, or whatever routine that is
6205 externally supplied.
6206
6207 """
6208 return _plplotc.plshade(*args)
6209
6210def plslabelfunc(lf, data):
6211 r"""
6212 Assign a function to use for generating custom axis labels
6213
6214 DESCRIPTION:
6215
6216 This function allows a user to provide their own function to provide
6217 axis label text. The user function is given the numeric value for a
6218 point on an axis and returns a string label to correspond with that
6219 value. Custom axis labels can be enabled by passing appropriate
6220 arguments to plenv, plbox, plbox3 and similar functions.
6221
6222 This function is used in example 19.
6223
6224
6225
6226 SYNOPSIS:
6227
6228 plslabelfunc(label_func, label_data)
6229
6230 ARGUMENTS:
6231
6232 label_func (PLLABEL_FUNC_callback, input) : This is the custom
6233 label function. In order to reset to the default labelling, set
6234 this to NULL. The labelling function parameters are, in order:
6235 axis: This indicates which axis a label is being requested for.
6236 The value will be one of PL_X_AXIS, PL_Y_AXIS or PL_Z_AXIS.
6237
6238 value: This is the value along the axis which is being labelled.
6239
6240 label_text: The string representation of the label value.
6241
6242 length: The maximum length in characters allowed for label_text.
6243
6244
6245 label_data (PLPointer, input) : This parameter may be used to pass
6246 data to the label_func function.
6247
6248 """
6249 return _plplotc.plslabelfunc(lf, data)
6250
6251def plsmaj(_def, scale):
6252 r"""
6253 Set length of major ticks
6254
6255 DESCRIPTION:
6256
6257 This sets up the length of the major ticks. The actual length is the
6258 product of the default length and a scaling factor as for character
6259 height.
6260
6261 Redacted form: plsmaj(def, scale)
6262
6263 This function is used in example 29.
6264
6265
6266
6267 SYNOPSIS:
6268
6269 plsmaj(def, scale)
6270
6271 ARGUMENTS:
6272
6273 def (PLFLT, input) : The default length of a major tick in
6274 millimeters, should be set to zero if the default length is to
6275 remain unchanged.
6276
6277 scale (PLFLT, input) : Scale factor to be applied to default to get
6278 actual tick length.
6279
6280 """
6281 return _plplotc.plsmaj(_def, scale)
6282
6283def plsmem(maxx, maxy, plotmem):
6284 r"""
6285 Set the memory area to be plotted (RGB)
6286
6287 DESCRIPTION:
6288
6289 Set the memory area to be plotted (with the mem or memcairo driver) as
6290 the dev member of the stream structure. Also set the number of pixels
6291 in the memory passed in
6292 plotmem, which is a block of memory
6293 maxy by
6294 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
6295
6296 This memory will have to be freed by the user!
6297
6298 Redacted form: plsmem(maxx, maxy, plotmem)
6299
6300 This function is not used in any examples.
6301
6302
6303
6304 SYNOPSIS:
6305
6306 plsmem(maxx, maxy, plotmem)
6307
6308 ARGUMENTS:
6309
6310 maxx (PLINT, input) : Size of memory area in the X coordinate.
6311
6312 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6313
6314 plotmem (PLPointer, input) : Pointer to the beginning of a
6315 user-supplied writeable memory area.
6316
6317 """
6318 return _plplotc.plsmem(maxx, maxy, plotmem)
6319
6320def plsmema(maxx, maxy, plotmem):
6321 r"""
6322 Set the memory area to be plotted (RGBA)
6323
6324 DESCRIPTION:
6325
6326 Set the memory area to be plotted (with the memcairo driver) as the
6327 dev member of the stream structure. Also set the number of pixels in
6328 the memory passed in
6329 plotmem, which is a block of memory
6330 maxy by
6331 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
6332
6333 This memory will have to be freed by the user!
6334
6335 Redacted form: plsmema(maxx, maxy, plotmem)
6336
6337 This function is not used in any examples.
6338
6339
6340
6341 SYNOPSIS:
6342
6343 plsmema(maxx, maxy, plotmem)
6344
6345 ARGUMENTS:
6346
6347 maxx (PLINT, input) : Size of memory area in the X coordinate.
6348
6349 maxy (PLINT, input) : Size of memory area in the Y coordinate.
6350
6351 plotmem (PLPointer, input) : Pointer to the beginning of a
6352 user-supplied writeable memory area.
6353
6354 """
6355 return _plplotc.plsmema(maxx, maxy, plotmem)
6356
6357def plsmin(_def, scale):
6358 r"""
6359 Set length of minor ticks
6360
6361 DESCRIPTION:
6362
6363 This sets up the length of the minor ticks and the length of the
6364 terminals on error bars. The actual length is the product of the
6365 default length and a scaling factor as for character height.
6366
6367 Redacted form: plsmin(def, scale)
6368
6369 This function is used in example 29.
6370
6371
6372
6373 SYNOPSIS:
6374
6375 plsmin(def, scale)
6376
6377 ARGUMENTS:
6378
6379 def (PLFLT, input) : The default length of a minor tick in
6380 millimeters, should be set to zero if the default length is to
6381 remain unchanged.
6382
6383 scale (PLFLT, input) : Scale factor to be applied to default to get
6384 actual tick length.
6385
6386 """
6387 return _plplotc.plsmin(_def, scale)
6388
6389def plsori(ori):
6390 r"""
6391 Set orientation
6392
6393 DESCRIPTION:
6394
6395 Set integer plot orientation parameter. This function is identical to
6396 plsdiori except for the type of the argument, and should be used in
6397 the same way. See the documentation of plsdiori for details.
6398
6399 Redacted form: plsori(ori)
6400
6401 This function is used in example 3.
6402
6403
6404
6405 SYNOPSIS:
6406
6407 plsori(ori)
6408
6409 ARGUMENTS:
6410
6411 ori (PLINT, input) : Orientation value (0 for landscape, 1 for
6412 portrait, etc.) The value is multiplied by 90 degrees to get the
6413 angle.
6414
6415 """
6416 return _plplotc.plsori(ori)
6417
6418def plspage(xp, yp, xleng, yleng, xoff, yoff):
6419 r"""
6420 Set page parameters
6421
6422 DESCRIPTION:
6423
6424 Sets the page configuration (optional). If an individual parameter is
6425 zero then that parameter value is not updated. Not all parameters are
6426 recognized by all drivers and the interpretation is device-dependent.
6427 The X-window driver uses the length and offset parameters to determine
6428 the window size and location. The length and offset values are
6429 expressed in units that are specific to the current driver. For
6430 instance: screen drivers will usually interpret them as number of
6431 pixels, whereas printer drivers will usually use mm.
6432
6433 This routine, if used, must be called before initializing PLplot. It
6434 may be called at later times for interactive drivers to change only
6435 the dpi for subsequent redraws which you can force via a call to
6436 plreplot. If this function is not called then the page size defaults
6437 to landscape A4 for drivers which use real world page sizes and 744
6438 pixels wide by 538 pixels high for raster drivers. The default value
6439 for dx and dy is 90 pixels per inch for raster drivers.
6440
6441
6442
6443 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff)
6444
6445 This function is used in examples 14 and 31.
6446
6447
6448
6449 SYNOPSIS:
6450
6451 plspage(xp, yp, xleng, yleng, xoff, yoff)
6452
6453 ARGUMENTS:
6454
6455 xp (PLFLT, input) : Number of pixels per inch (DPI), x. Used only
6456 by raster drivers, ignored by drivers which use "real world" units
6457 (e.g. mm).
6458
6459 yp (PLFLT, input) : Number of pixels per inch (DPI), y. Used only
6460 by raster drivers, ignored by drivers which use "real world" units
6461 (e.g. mm).
6462
6463 xleng (PLINT, input) : Page length, x.
6464
6465 yleng (PLINT, input) : Page length, y.
6466
6467 xoff (PLINT, input) : Page offset, x.
6468
6469 yoff (PLINT, input) : Page offset, y.
6470
6471 """
6472 return _plplotc.plspage(xp, yp, xleng, yleng, xoff, yoff)
6473
6474def plspal0(filename):
6475 r"""
6476 Set the cmap0 palette using the specified cmap0*.pal format file
6477
6478 DESCRIPTION:
6479
6480 Set the cmap0 palette using the specified cmap0*.pal format file.
6481
6482 Redacted form: plspal0(filename)
6483
6484 This function is in example 16.
6485
6486
6487
6488 SYNOPSIS:
6489
6490 plspal0(filename)
6491
6492 ARGUMENTS:
6493
6494 filename (PLCHAR_VECTOR, input) : An ascii character string
6495 containing the name of the cmap0*.pal file. If this string is
6496 empty, use the default cmap0*.pal file.
6497
6498 """
6499 return _plplotc.plspal0(filename)
6500
6501def plspal1(filename, interpolate):
6502 r"""
6503 Set the cmap1 palette using the specified cmap1*.pal format file
6504
6505 DESCRIPTION:
6506
6507 Set the cmap1 palette using the specified cmap1*.pal format file.
6508
6509 Redacted form: plspal1(filename, interpolate)
6510
6511 This function is used in example 16.
6512
6513
6514
6515 SYNOPSIS:
6516
6517 plspal1(filename, interpolate)
6518
6519 ARGUMENTS:
6520
6521 filename (PLCHAR_VECTOR, input) : An ascii character string
6522 containing the name of the cmap1*.pal file. If this string is
6523 empty, use the default cmap1*.pal file.
6524
6525 interpolate (PLBOOL, input) : If this parameter is true, the
6526 columns containing the intensity index, r, g, b, alpha and
6527 alt_hue_path in the cmap1*.pal file are used to set the cmap1
6528 palette with a call to plscmap1la. (The cmap1*.pal header contains
6529 a flag which controls whether the r, g, b data sent to plscmap1la
6530 are interpreted as HLS or RGB.) If this parameter is false, the
6531 intensity index and alt_hue_path columns are ignored and the r, g,
6532 b (interpreted as RGB), and alpha columns of the cmap1*.pal file
6533 are used instead to set the cmap1 palette directly with a call to
6534 plscmap1a.
6535
6536 """
6537 return _plplotc.plspal1(filename, interpolate)
6538
6539def plspause(pause):
6540 r"""
6541 Set the pause (on end-of-page) status
6542
6543 DESCRIPTION:
6544
6545 Set the pause (on end-of-page) status.
6546
6547 Redacted form: plspause(pause)
6548
6549 This function is in examples 14,20.
6550
6551
6552
6553 SYNOPSIS:
6554
6555 plspause(pause)
6556
6557 ARGUMENTS:
6558
6559 pause (PLBOOL, input) : If pause is true there will be a pause on
6560 end-of-page for those drivers which support this. Otherwise there
6561 is no pause.
6562
6563 """
6564 return _plplotc.plspause(pause)
6565
6566def plsstrm(strm):
6567 r"""
6568 Set current output stream
6569
6570 DESCRIPTION:
6571
6572 Sets the number of the current output stream. The stream number
6573 defaults to 0 unless changed by this routine. The first use of this
6574 routine must be followed by a call initializing PLplot (e.g. plstar).
6575
6576 Redacted form: plsstrm(strm)
6577
6578 This function is examples 1,14,20.
6579
6580
6581
6582 SYNOPSIS:
6583
6584 plsstrm(strm)
6585
6586 ARGUMENTS:
6587
6588 strm (PLINT, input) : The current stream number.
6589
6590 """
6591 return _plplotc.plsstrm(strm)
6592
6593def plssub(nx, ny):
6594 r"""
6595 Set the number of subpages in x and y
6596
6597 DESCRIPTION:
6598
6599 Set the number of subpages in x and y.
6600
6601 Redacted form: plssub(nx, ny)
6602
6603 This function is examples 1,2,14,21,25,27.
6604
6605
6606
6607 SYNOPSIS:
6608
6609 plssub(nx, ny)
6610
6611 ARGUMENTS:
6612
6613 nx (PLINT, input) : Number of windows in x direction (i.e., number
6614 of window columns).
6615
6616 ny (PLINT, input) : Number of windows in y direction (i.e., number
6617 of window rows).
6618
6619 """
6620 return _plplotc.plssub(nx, ny)
6621
6622def plssym(_def, scale):
6623 r"""
6624 Set symbol size
6625
6626 DESCRIPTION:
6627
6628 This sets up the size of all subsequent symbols drawn by plpoin and
6629 plsym. The actual height of a symbol is the product of the default
6630 symbol size and a scaling factor as for the character height.
6631
6632 Redacted form: plssym(def, scale)
6633
6634 This function is used in example 29.
6635
6636
6637
6638 SYNOPSIS:
6639
6640 plssym(def, scale)
6641
6642 ARGUMENTS:
6643
6644 def (PLFLT, input) : The default height of a symbol in millimeters,
6645 should be set to zero if the default height is to remain
6646 unchanged.
6647
6648 scale (PLFLT, input) : Scale factor to be applied to default to get
6649 actual symbol height.
6650
6651 """
6652 return _plplotc.plssym(_def, scale)
6653
6654def plstar(nx, ny):
6655 r"""
6656 Initialization
6657
6658 DESCRIPTION:
6659
6660 Initializing the plotting package. The program prompts for the device
6661 keyword or number of the desired output device. Hitting a RETURN in
6662 response to the prompt is the same as selecting the first device. If
6663 only one device is enabled when PLplot is installed, plstar will issue
6664 no prompt. The output device is divided into nx by ny subpages, each
6665 of which may be used independently. The subroutine pladv is used to
6666 advance from one subpage to the next.
6667
6668 Redacted form: plstar(nx, ny)
6669
6670 This function is used in example 1.
6671
6672
6673
6674 SYNOPSIS:
6675
6676 plstar(nx, ny)
6677
6678 ARGUMENTS:
6679
6680 nx (PLINT, input) : Number of subpages to divide output page in the
6681 x direction.
6682
6683 ny (PLINT, input) : Number of subpages to divide output page in the
6684 y direction.
6685
6686 """
6687 return _plplotc.plstar(nx, ny)
6688
6689def plstart(devname, nx, ny):
6690 r"""
6691 Initialization
6692
6693 DESCRIPTION:
6694
6695 Alternative to plstar for initializing the plotting package. The
6696 device name keyword for the desired output device must be supplied as
6697 an argument. These keywords are the same as those printed out by
6698 plstar. If the requested device is not available, or if the input
6699 string is empty or begins with ``?'', the prompted start up of plstar
6700 is used. This routine also divides the output device page into nx by
6701 ny subpages, each of which may be used independently. The subroutine
6702 pladv is used to advance from one subpage to the next.
6703
6704 Redacted form: General: plstart(devname, nx, ny)
6705
6706
6707 This function is not used in any examples.
6708
6709
6710
6711 SYNOPSIS:
6712
6713 plstart(devname, nx, ny)
6714
6715 ARGUMENTS:
6716
6717 devname (PLCHAR_VECTOR, input) : An ascii character string
6718 containing the device name keyword of the required output device.
6719 If
6720 devname is NULL or if the first character of the string is a ``?'',
6721 the normal (prompted) start up is used.
6722
6723 nx (PLINT, input) : Number of subpages to divide output page in the
6724 x direction.
6725
6726 ny (PLINT, input) : Number of subpages to divide output page in the
6727 y direction.
6728
6729 """
6730 return _plplotc.plstart(devname, nx, ny)
6731
6732def plstransform(*args):
6733 r"""
6734 Set a global coordinate transform function
6735
6736 DESCRIPTION:
6737
6738 This function can be used to define a coordinate transformation which
6739 affects all elements drawn within the current plot window. The
6740 coordinate_transform callback function is similar to that provided for
6741 the plmap and plmeridians functions. The coordinate_transform_data
6742 parameter may be used to pass extra data to coordinate_transform.
6743
6744 Redacted form: General: plstransform(coordinate_transform,
6745 coordinate_transform_data)
6746
6747
6748 This function is used in examples 19 and 22.
6749
6750
6751
6752 SYNOPSIS:
6753
6754 plstransform(coordinate_transform, coordinate_transform_data)
6755
6756 ARGUMENTS:
6757
6758 coordinate_transform (PLTRANSFORM_callback, input) : A callback
6759 function that defines the transformation from the input (x, y)
6760 world coordinates to new PLplot world coordinates. If
6761 coordinate_transform is not supplied (e.g., is set to NULL in the C
6762 case), then no transform is applied.
6763
6764 coordinate_transform_data (PLPointer, input) : Optional extra data
6765 for
6766 coordinate_transform.
6767
6768 """
6769 return _plplotc.plstransform(*args)
6770
6771def plstring(n, ArrayCk, string):
6772 r"""
6773 Plot a glyph at the specified points
6774
6775 DESCRIPTION:
6776
6777 Plot a glyph at the specified points. (Supersedes plpoin and plsym
6778 because many[!] more glyphs are accessible with plstring.) The glyph
6779 is specified with a PLplot user string. Note that the user string is
6780 not actually limited to one glyph so it is possible (but not normally
6781 useful) to plot more than one glyph at the specified points with this
6782 function. As with plmtex and plptex, the user string can contain FCI
6783 escapes to determine the font, UTF-8 code to determine the glyph or
6784 else PLplot escapes for Hershey or unicode text to determine the
6785 glyph.
6786
6787 Redacted form: plstring(x, y, string)
6788
6789 This function is used in examples 4, 21 and 26.
6790
6791
6792
6793 SYNOPSIS:
6794
6795 plstring(n, x, y, string)
6796
6797 ARGUMENTS:
6798
6799 n (PLINT, input) : Number of points in the x and y vectors.
6800
6801 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6802 the points.
6803
6804 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6805 the points.
6806
6807 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6808 the glyph(s) to be plotted at each of the n points.
6809
6810 """
6811 return _plplotc.plstring(n, ArrayCk, string)
6812
6813def plstring3(n, arg2, arg3, string):
6814 r"""
6815 Plot a glyph at the specified 3D points
6816
6817 DESCRIPTION:
6818
6819 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because
6820 many[!] more glyphs are accessible with plstring3.) Set up the call to
6821 this function similar to what is done for plline3. The glyph is
6822 specified with a PLplot user string. Note that the user string is not
6823 actually limited to one glyph so it is possible (but not normally
6824 useful) to plot more than one glyph at the specified points with this
6825 function. As with plmtex and plptex, the user string can contain FCI
6826 escapes to determine the font, UTF-8 code to determine the glyph or
6827 else PLplot escapes for Hershey or unicode text to determine the
6828 glyph.
6829
6830 Redacted form: plstring3(x, y, z, string)
6831
6832 This function is used in example 18.
6833
6834
6835
6836 SYNOPSIS:
6837
6838 plstring3(n, x, y, z, string)
6839
6840 ARGUMENTS:
6841
6842 n (PLINT, input) : Number of points in the x, y, and z vectors.
6843
6844 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6845 the points.
6846
6847 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6848 the points.
6849
6850 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
6851 the points.
6852
6853 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6854 the glyph(s) to be plotted at each of the n points. points.
6855
6856 """
6857 return _plplotc.plstring3(n, arg2, arg3, string)
6858
6859def plstripa(id, pen, x, y):
6860 r"""
6861 Add a point to a strip chart
6862
6863 DESCRIPTION:
6864
6865 Add a point to a given pen of a given strip chart. There is no need
6866 for all pens to have the same number of points or to be equally
6867 sampled in the x coordinate. Allocates memory and rescales as
6868 necessary.
6869
6870 Redacted form: plstripa(id, pen, x, y)
6871
6872 This function is used in example 17.
6873
6874
6875
6876 SYNOPSIS:
6877
6878 plstripa(id, pen, x, y)
6879
6880 ARGUMENTS:
6881
6882 id (PLINT, input) : Identification number of the strip chart (set
6883 up in plstripc).
6884
6885 pen (PLINT, input) : Pen number (ranges from 0 to 3).
6886
6887 x (PLFLT, input) : X coordinate of point to plot.
6888
6889 y (PLFLT, input) : Y coordinate of point to plot.
6890
6891 """
6892 return _plplotc.plstripa(id, pen, x, y)
6893
6894def plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop):
6895 r"""
6896 Create a 4-pen strip chart
6897
6898 DESCRIPTION:
6899
6900 Create a 4-pen strip chart, to be used afterwards by plstripa
6901
6902 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
6903 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
6904 styline, legline, labx, laby, labz)
6905
6906
6907 This function is used in example 17.
6908
6909
6910
6911 SYNOPSIS:
6912
6913 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
6914
6915 ARGUMENTS:
6916
6917 id (PLINT_NC_SCALAR, output) : Returned value of the identification
6918 number of the strip chart to use on plstripa and plstripd.
6919
6920 xspec (PLCHAR_VECTOR, input) : An ascii character string containing
6921 the x-axis specification as in plbox.
6922
6923 yspec (PLCHAR_VECTOR, input) : An ascii character string containing
6924 the y-axis specification as in plbox.
6925
6926 xmin (PLFLT, input) : Initial coordinates of plot box; they will
6927 change as data are added.
6928
6929 xmax (PLFLT, input) : Initial coordinates of plot box; they will
6930 change as data are added.
6931
6932 xjump (PLFLT, input) : When x attains xmax, the length of the plot
6933 is multiplied by the factor (1 +
6934 xjump) .
6935
6936 ymin (PLFLT, input) : Initial coordinates of plot box; they will
6937 change as data are added.
6938
6939 ymax (PLFLT, input) : Initial coordinates of plot box; they will
6940 change as data are added.
6941
6942 xlpos (PLFLT, input) : X legend box position (range from 0 to 1).
6943
6944 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1).
6945
6946 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is
6947 true, otherwise not.
6948
6949 acc (PLBOOL, input) : Accumulate strip plot if acc is true,
6950 otherwise slide display.
6951
6952 colbox (PLINT, input) : Plot box color index (cmap0).
6953
6954 collab (PLINT, input) : Legend color index (cmap0).
6955
6956 colline (PLINT_VECTOR, input) : A vector containing the cmap0 color
6957 indices for the 4 pens.
6958
6959 styline (PLINT_VECTOR, input) : A vector containing the line style
6960 indices for the 4 pens.
6961
6962 legline (PLCHAR_MATRIX, input) : A vector of UTF-8 character
6963 strings containing legends for the 4 pens.
6964
6965 labx (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6966 the label for the x axis.
6967
6968 laby (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6969 the label for the y axis.
6970
6971 labtop (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6972 the plot title.
6973
6974 """
6975 return _plplotc.plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop)
6976
6977def plstripd(id):
6978 r"""
6979 Deletes and releases memory used by a strip chart
6980
6981 DESCRIPTION:
6982
6983 Deletes and releases memory used by a strip chart.
6984
6985 Redacted form: plstripd(id)
6986
6987 This function is used in example 17.
6988
6989
6990
6991 SYNOPSIS:
6992
6993 plstripd(id)
6994
6995 ARGUMENTS:
6996
6997 id (PLINT, input) : Identification number of strip chart to delete.
6998
6999 """
7000 return _plplotc.plstripd(id)
7001
7002def plstyl(n, ArrayCk):
7003 r"""
7004 Set line style
7005
7006 DESCRIPTION:
7007
7008 This sets up the line style for all lines subsequently drawn. A line
7009 consists of segments in which the pen is alternately down and up. The
7010 lengths of these segments are passed in the vectors mark and space
7011 respectively. The number of mark-space pairs is specified by nms. In
7012 order to return the line style to the default continuous line, plstyl
7013 should be called with nms =0 .(see also pllsty)
7014
7015 Redacted form: plstyl(mark, space)
7016
7017 This function is used in examples 1, 9, and 14.
7018
7019
7020
7021 SYNOPSIS:
7022
7023 plstyl(nms, mark, space)
7024
7025 ARGUMENTS:
7026
7027 nms (PLINT, input) : The number of mark and space elements in a
7028 line. Thus a simple broken line can be obtained by setting nms=1
7029 . A continuous line is specified by setting nms=0 .
7030
7031 mark (PLINT_VECTOR, input) : A vector containing the lengths of the
7032 segments during which the pen is down, measured in micrometers.
7033
7034 space (PLINT_VECTOR, input) : A vector containing the lengths of
7035 the segments during which the pen is up, measured in micrometers.
7036
7037 """
7038 return _plplotc.plstyl(n, ArrayCk)
7039
7040def plsvect(ArrayNull, ArrayCkNull, deffalse):
7041 r"""
7042 Set arrow style for vector plots
7043
7044 DESCRIPTION:
7045
7046 Set the style for the arrow used by plvect to plot vectors.
7047
7048 Redacted form: plsvect(arrowx, arrowy, fill)
7049
7050 This function is used in example 22.
7051
7052
7053
7054 SYNOPSIS:
7055
7056 plsvect(arrowx, arrowy, npts, fill)
7057
7058 ARGUMENTS:
7059
7060 arrowx, arrowy (PLFLT_VECTOR, input) : A pair of vectors containing
7061 the x and y points which make up the arrow. The arrow is plotted
7062 by joining these points to form a polygon. The scaling assumes
7063 that the x and y points in the arrow lie in the range -0.5 <= x,y
7064 <= 0.5. If both arrowx and arrowy are NULL then the arrow style
7065 will be reset to its default.
7066
7067 npts (PLINT, input) : Number of points in the vectors arrowx and
7068 arrowy.
7069
7070 fill (PLBOOL, input) : If fill is true then the arrow is closed, if
7071 fill is false then the arrow is open.
7072
7073 """
7074 return _plplotc.plsvect(ArrayNull, ArrayCkNull, deffalse)
7075
7076def plsvpa(xmin, xmax, ymin, ymax):
7077 r"""
7078 Specify viewport in absolute coordinates
7079
7080 DESCRIPTION:
7081
7082 Alternate routine to plvpor for setting up the viewport. This routine
7083 should be used only if the viewport is required to have a definite
7084 size in millimeters. The routine plgspa is useful for finding out the
7085 size of the current subpage.
7086
7087 Redacted form: plsvpa(xmin, xmax, ymin, ymax)
7088
7089 This function is used in example 10.
7090
7091
7092
7093 SYNOPSIS:
7094
7095 plsvpa(xmin, xmax, ymin, ymax)
7096
7097 ARGUMENTS:
7098
7099 xmin (PLFLT, input) : The distance of the left-hand edge of the
7100 viewport from the left-hand edge of the subpage in millimeters.
7101
7102 xmax (PLFLT, input) : The distance of the right-hand edge of the
7103 viewport from the left-hand edge of the subpage in millimeters.
7104
7105 ymin (PLFLT, input) : The distance of the bottom edge of the
7106 viewport from the bottom edge of the subpage in millimeters.
7107
7108 ymax (PLFLT, input) : The distance of the top edge of the viewport
7109 from the bottom edge of the subpage in millimeters.
7110
7111 """
7112 return _plplotc.plsvpa(xmin, xmax, ymin, ymax)
7113
7114def plsxax(digmax, digits):
7115 r"""
7116 Set x axis parameters
7117
7118 DESCRIPTION:
7119
7120 Sets values of the digmax and digits flags for the x axis. See the
7121 PLplot documentation for more information.
7122
7123 Redacted form: plsxax(digmax, digits)
7124
7125 This function is used in example 31.
7126
7127
7128
7129 SYNOPSIS:
7130
7131 plsxax(digmax, digits)
7132
7133 ARGUMENTS:
7134
7135 digmax (PLINT, input) : Variable to set the maximum number of
7136 digits for the x axis. If nonzero, the printed label will be
7137 switched to a floating-point representation when the number of
7138 digits exceeds digmax.
7139
7140 digits (PLINT, input) : Field digits value. Currently, changing
7141 its value here has no effect since it is set only by plbox or
7142 plbox3. However, the user may obtain its value after a call to
7143 either of these functions by calling plgxax.
7144
7145 """
7146 return _plplotc.plsxax(digmax, digits)
7147
7148def plsyax(digmax, digits):
7149 r"""
7150 Set y axis parameters
7151
7152 DESCRIPTION:
7153
7154 Identical to plsxax, except that arguments are flags for y axis. See
7155 the description of plsxax for more detail.
7156
7157 Redacted form: plsyax(digmax, digits)
7158
7159 This function is used in examples 1, 14, and 31.
7160
7161
7162
7163 SYNOPSIS:
7164
7165 plsyax(digmax, digits)
7166
7167 ARGUMENTS:
7168
7169 digmax (PLINT, input) : Variable to set the maximum number of
7170 digits for the y axis. If nonzero, the printed label will be
7171 switched to a floating-point representation when the number of
7172 digits exceeds digmax.
7173
7174 digits (PLINT, input) : Field digits value. Currently, changing
7175 its value here has no effect since it is set only by plbox or
7176 plbox3. However, the user may obtain its value after a call to
7177 either of these functions by calling plgyax.
7178
7179 """
7180 return _plplotc.plsyax(digmax, digits)
7181
7182def plsym(n, ArrayCk, code):
7183 r"""
7184 Plot a glyph at the specified points
7185
7186 DESCRIPTION:
7187
7188 Plot a glyph at the specified points. (This function is largely
7189 superseded by plstring which gives access to many[!] more glyphs.)
7190
7191 Redacted form: plsym(x, y, code)
7192
7193 This function is used in example 7.
7194
7195
7196
7197 SYNOPSIS:
7198
7199 plsym(n, x, y, code)
7200
7201 ARGUMENTS:
7202
7203 n (PLINT, input) : Number of points in the x and y vectors.
7204
7205 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
7206 the points.
7207
7208 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
7209 the points.
7210
7211 code (PLINT, input) : Hershey symbol code corresponding to a glyph
7212 to be plotted at each of the n points.
7213
7214 """
7215 return _plplotc.plsym(n, ArrayCk, code)
7216
7217def plszax(digmax, digits):
7218 r"""
7219 Set z axis parameters
7220
7221 DESCRIPTION:
7222
7223 Identical to plsxax, except that arguments are flags for z axis. See
7224 the description of plsxax for more detail.
7225
7226 Redacted form: plszax(digmax, digits)
7227
7228 This function is used in example 31.
7229
7230
7231
7232 SYNOPSIS:
7233
7234 plszax(digmax, digits)
7235
7236 ARGUMENTS:
7237
7238 digmax (PLINT, input) : Variable to set the maximum number of
7239 digits for the z axis. If nonzero, the printed label will be
7240 switched to a floating-point representation when the number of
7241 digits exceeds digmax.
7242
7243 digits (PLINT, input) : Field digits value. Currently, changing
7244 its value here has no effect since it is set only by plbox or
7245 plbox3. However, the user may obtain its value after a call to
7246 either of these functions by calling plgzax.
7247
7248 """
7249 return _plplotc.plszax(digmax, digits)
7250
7252 r"""
7253 Switch to text screen
7254
7255 DESCRIPTION:
7256
7257 Sets an interactive device to text mode, used in conjunction with
7258 plgra to allow graphics and text to be interspersed. On a device
7259 which supports separate text and graphics windows, this command causes
7260 control to be switched to the text window. This can be useful for
7261 printing diagnostic messages or getting user input, which would
7262 otherwise interfere with the plots. The program must switch back to
7263 the graphics window before issuing plot commands, as the text (or
7264 console) device will probably become quite confused otherwise. If
7265 already in text mode, this command is ignored. It is also ignored on
7266 devices which only support a single window or use a different method
7267 for shifting focus (see also plgra).
7268
7269 Redacted form: pltext()
7270
7271 This function is used in example 1.
7272
7273
7274
7275 SYNOPSIS:
7276
7277 pltext()
7278
7279 """
7280 return _plplotc.pltext()
7281
7282def pltimefmt(fmt):
7283 r"""
7284 Set format for date / time labels
7285
7286 DESCRIPTION:
7287
7288 Sets the format for date / time labels. To enable date / time format
7289 labels see the options to plbox, plbox3, and plenv.
7290
7291 Redacted form: pltimefmt(fmt)
7292
7293 This function is used in example 29.
7294
7295
7296
7297 SYNOPSIS:
7298
7299 pltimefmt(fmt)
7300
7301 ARGUMENTS:
7302
7303 fmt (PLCHAR_VECTOR, input) : An ascii character string which is
7304 interpreted similarly to the format specifier of typical system
7305 strftime routines except that PLplot ignores locale and also
7306 supplies some useful extensions in the context of plotting. All
7307 text in the string is printed as-is other than conversion
7308 specifications which take the form of a '%' character followed by
7309 further conversion specification character. The conversion
7310 specifications which are similar to those provided by system
7311 strftime routines are the following: %a: The abbreviated (English)
7312 weekday name.
7313 %A: The full (English) weekday name.
7314 %b: The abbreviated (English) month name.
7315 %B: The full (English) month name.
7316 %c: Equivalent to %a %b %d %T %Y (non-ISO).
7317 %C: The century number (year/100) as a 2-digit integer.
7318 %d: The day of the month as a decimal number (range 01 to 31).
7319 %D: Equivalent to %m/%d/%y (non-ISO).
7320 %e: Like %d, but a leading zero is replaced by a space.
7321 %F: Equivalent to %Y-%m-%d (the ISO 8601 date format).
7322 %h: Equivalent to %b.
7323 %H: The hour as a decimal number using a 24-hour clock (range
7324 00 to 23).
7325 %I: The hour as a decimal number using a 12-hour clock (range
7326 01 to 12).
7327 %j: The day of the year as a decimal number (range 001 to
7328 366).
7329 %k: The hour (24-hour clock) as a decimal number (range 0 to
7330 23); single digits are preceded by a blank. (See also %H.)
7331 %l: The hour (12-hour clock) as a decimal number (range 1 to
7332 12); single digits are preceded by a blank. (See also %I.)
7333 %m: The month as a decimal number (range 01 to 12).
7334 %M: The minute as a decimal number (range 00 to 59).
7335 %n: A newline character.
7336 %p: Either "AM" or "PM" according to the given time value.
7337 Noon is treated as "PM" and midnight as "AM".
7338 %r: Equivalent to %I:%M:%S %p.
7339 %R: The time in 24-hour notation (%H:%M). For a version
7340 including the seconds, see %T below.
7341 %s: The number of seconds since the Epoch, 1970-01-01 00:00:00
7342 +0000 (UTC).
7343 %S: The second as a decimal number (range 00 to 60). (The
7344 range is up to 60 to allow for occasional leap seconds.)
7345 %t: A tab character.
7346 %T: The time in 24-hour notation (%H:%M:%S).
7347 %u: The day of the week as a decimal, range 1 to 7, Monday
7348 being 1. See also %w.
7349 %U: The week number of the current year as a decimal number,
7350 range 00 to 53, starting with the first Sunday as the first
7351 day of week 01. See also %V and %W.
7352 %v: Equivalent to %e-%b-%Y.
7353 %V: The ISO 8601 week number of the current year as a decimal
7354 number, range 01 to 53, where week 1 is the first week that
7355 has at least 4 days in the new year. See also %U and %W.
7356 %w: The day of the week as a decimal, range 0 to 6, Sunday
7357 being 0. See also %u.
7358 %W: The week number of the current year as a decimal number,
7359 range 00 to 53, starting with the first Monday as the first
7360 day of week 01.
7361 %x: Equivalent to %a %b %d %Y.
7362 %X: Equivalent to %T.
7363 %y: The year as a decimal number without a century (range 00
7364 to 99).
7365 %Y: The year as a decimal number including a century.
7366 %z: The UTC time-zone string = "+0000".
7367 %Z: The UTC time-zone abbreviation = "UTC".
7368 %+: The UTC date and time in default format of the Unix date
7369 command which is equivalent to %a %b %d %T %Z %Y.
7370 %%: A literal "%" character.
7371 The conversion specifications which are extensions to those normally
7372 provided by system strftime routines are the following: %(0-9):
7373 The fractional part of the seconds field (including leading
7374 decimal point) to the specified accuracy. Thus %S%3 would give
7375 seconds to millisecond accuracy (00.000).
7376 %.: The fractional part of the seconds field (including
7377 leading decimal point) to the maximum available accuracy. Thus
7378 %S%. would give seconds with fractional part up to 9 decimal
7379 places if available.
7380
7381 """
7382 return _plplotc.pltimefmt(fmt)
7383
7384def plvasp(aspect):
7385 r"""
7386 Specify viewport using aspect ratio only
7387
7388 DESCRIPTION:
7389
7390 Selects the largest viewport with the given aspect ratio within the
7391 subpage that leaves a standard margin (left-hand margin of eight
7392 character heights, and a margin around the other three sides of five
7393 character heights).
7394
7395 Redacted form: plvasp(aspect)
7396
7397 This function is used in example 13.
7398
7399
7400
7401 SYNOPSIS:
7402
7403 plvasp(aspect)
7404
7405 ARGUMENTS:
7406
7407 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7408 axis of resulting viewport.
7409
7410 """
7411 return _plplotc.plvasp(aspect)
7412
7413def plvect(*args):
7414 r"""
7415 Vector plot
7416
7417 DESCRIPTION:
7418
7419 Draws a plot of vector data contained in the matrices (
7420 u[
7421 nx][
7422 ny],
7423 v[
7424 nx][
7425 ny]) . The scaling factor for the vectors is given by scale. A
7426 transformation routine pointed to by pltr with a pointer pltr_data for
7427 additional data required by the transformation routine to map indices
7428 within the matrices to the world coordinates. The style of the vector
7429 arrow may be set using plsvect.
7430
7431 Redacted form: plvect(u, v, scale, pltr, pltr_data) where (see above
7432 discussion) the pltr, pltr_data callback arguments are sometimes
7433 replaced by a tr vector with 6 elements, or xg and yg array arguments
7434 with either one or two dimensions.
7435
7436 This function is used in example 22.
7437
7438
7439
7440 SYNOPSIS:
7441
7442 plvect(u, v, nx, ny, scale, pltr, pltr_data)
7443
7444 ARGUMENTS:
7445
7446 u, v (PLFLT_MATRIX, input) : A pair of matrices containing the x
7447 and y components of the vector data to be plotted.
7448
7449 nx, ny (PLINT, input) : Dimensions of the matrices u and v.
7450
7451 scale (PLFLT, input) : Parameter to control the scaling factor of
7452 the vectors for plotting. If scale = 0 then the scaling factor is
7453 automatically calculated for the data. If scale < 0 then the
7454 scaling factor is automatically calculated for the data and then
7455 multiplied by -
7456 scale. If scale > 0 then the scaling factor is set to scale.
7457
7458 pltr (PLTRANSFORM_callback, input) : A callback function that
7459 defines the transformation between the zero-based indices of the
7460 matrices u and v and world coordinates.For the C case,
7461 transformation functions are provided in the PLplot library: pltr0
7462 for the identity mapping, and pltr1 and pltr2 for arbitrary
7463 mappings respectively defined by vectors and matrices. In
7464 addition, C callback routines for the transformation can be
7465 supplied by the user such as the mypltr function in
7466 examples/c/x09c.c which provides a general linear transformation
7467 between index coordinates and world coordinates.For languages
7468 other than C you should consult the PLplot documentation for the
7469 details concerning how PLTRANSFORM_callback arguments are
7470 interfaced. However, in general, a particular pattern of
7471 callback-associated arguments such as a tr vector with 6 elements;
7472 xg and yg vectors; or xg and yg matrices are respectively
7473 interfaced to a linear-transformation routine similar to the above
7474 mypltr function; pltr1; and pltr2. Furthermore, some of our more
7475 sophisticated bindings (see, e.g., the PLplot documentation)
7476 support native language callbacks for handling index to
7477 world-coordinate transformations. Examples of these various
7478 approaches are given in examples/<language>x09*,
7479 examples/<language>x16*, examples/<language>x20*,
7480 examples/<language>x21*, and examples/<language>x22*, for all our
7481 supported languages.
7482
7483 pltr_data (PLPointer, input) : Extra parameter to help pass
7484 information to pltr0, pltr1, pltr2, or whatever callback routine
7485 that is externally supplied.
7486
7487 """
7488 return _plplotc.plvect(*args)
7489
7490def plvpas(xmin, xmax, ymin, ymax, aspect):
7491 r"""
7492 Specify viewport using coordinates and aspect ratio
7493
7494 DESCRIPTION:
7495
7496 Device-independent routine for setting up the viewport. The viewport
7497 is chosen to be the largest with the given aspect ratio that fits
7498 within the specified region (in terms of normalized subpage
7499 coordinates). This routine is functionally equivalent to plvpor when
7500 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this
7501 routine reserves no extra space at the edges for labels.
7502
7503 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect)
7504
7505 This function is used in example 9.
7506
7507
7508
7509 SYNOPSIS:
7510
7511 plvpas(xmin, xmax, ymin, ymax, aspect)
7512
7513 ARGUMENTS:
7514
7515 xmin (PLFLT, input) : The normalized subpage coordinate of the
7516 left-hand edge of the viewport.
7517
7518 xmax (PLFLT, input) : The normalized subpage coordinate of the
7519 right-hand edge of the viewport.
7520
7521 ymin (PLFLT, input) : The normalized subpage coordinate of the
7522 bottom edge of the viewport.
7523
7524 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7525 edge of the viewport.
7526
7527 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7528 axis.
7529
7530 """
7531 return _plplotc.plvpas(xmin, xmax, ymin, ymax, aspect)
7532
7533def plvpor(xmin, xmax, ymin, ymax):
7534 r"""
7535 Specify viewport using normalized subpage coordinates
7536
7537 DESCRIPTION:
7538
7539 Device-independent routine for setting up the viewport. This defines
7540 the viewport in terms of normalized subpage coordinates which run from
7541 0.0 to 1.0 (left to right and bottom to top) along each edge of the
7542 current subpage. Use the alternate routine plsvpa in order to create
7543 a viewport of a definite size.
7544
7545 Redacted form: plvpor(xmin, xmax, ymin, ymax)
7546
7547 This function is used in examples 2, 6-8, 10, 11, 15, 16, 18, 21, 23,
7548 24, 26, 27, and 31.
7549
7550
7551
7552 SYNOPSIS:
7553
7554 plvpor(xmin, xmax, ymin, ymax)
7555
7556 ARGUMENTS:
7557
7558 xmin (PLFLT, input) : The normalized subpage coordinate of the
7559 left-hand edge of the viewport.
7560
7561 xmax (PLFLT, input) : The normalized subpage coordinate of the
7562 right-hand edge of the viewport.
7563
7564 ymin (PLFLT, input) : The normalized subpage coordinate of the
7565 bottom edge of the viewport.
7566
7567 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7568 edge of the viewport.
7569
7570 """
7571 return _plplotc.plvpor(xmin, xmax, ymin, ymax)
7572
7574 r"""
7575 Select standard viewport
7576
7577 DESCRIPTION:
7578
7579 Selects the largest viewport within the subpage that leaves a standard
7580 margin (left-hand margin of eight character heights, and a margin
7581 around the other three sides of five character heights).
7582
7583 Redacted form: plvsta()
7584
7585 This function is used in examples 1, 12, 14, 17, 25, and 29.
7586
7587
7588
7589 SYNOPSIS:
7590
7591 plvsta()
7592
7593 """
7594 return _plplotc.plvsta()
7595
7596def plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az):
7597 r"""
7598 Configure the transformations required for projecting a 3D surface on a 2D window
7599
7600 DESCRIPTION:
7601
7602 Configure the transformations required for projecting a 3D surface on
7603 an existing 2D window. Those transformations (see the PLplot
7604 documentation) are done to a rectangular cuboid enclosing the 3D
7605 surface which has its limits expressed in 3D world coordinates and
7606 also normalized 3D coordinates (used for interpreting the altitude and
7607 azimuth of the viewing angle). The transformations consist of the
7608 linear transform from 3D world coordinates to normalized 3D
7609 coordinates, and the 3D rotation of normalized coordinates required to
7610 align the pole of the new 3D coordinate system with the viewing
7611 direction specified by altitude and azimuth so that x and y of the
7612 surface elements in that transformed coordinate system are the
7613 projection of the 3D surface with given viewing direction on the 2D
7614 window.
7615
7616 The enclosing rectangular cuboid for the surface plot is defined by
7617 xmin, xmax, ymin, ymax, zmin and zmax in 3D world coordinates. It is
7618 mapped into the same rectangular cuboid with normalized 3D coordinate
7619 sizes of basex by basey by height so that xmin maps to -
7620 basex/2, xmax maps to basex/2, ymin maps to -
7621 basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height.
7622 The resulting rectangular cuboid in normalized coordinates is then
7623 viewed by an observer at altitude alt and azimuth az. This routine
7624 must be called before plbox3 or any of the 3D surface plotting
7625 routines; plmesh, plmeshc, plot3d, plot3dc, plot3dcl, plsurf3d,
7626 plsurf3dl or plfill3.
7627
7628 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
7629 zmin, zmax, alt, az)
7630
7631 This function is examples 8, 11, 18, and 21.
7632
7633
7634
7635 SYNOPSIS:
7636
7637 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
7638
7639 ARGUMENTS:
7640
7641 basex (PLFLT, input) : The normalized x coordinate size of the
7642 rectangular cuboid.
7643
7644 basey (PLFLT, input) : The normalized y coordinate size of the
7645 rectangular cuboid.
7646
7647 height (PLFLT, input) : The normalized z coordinate size of the
7648 rectangular cuboid.
7649
7650 xmin (PLFLT, input) : The minimum x world coordinate of the
7651 rectangular cuboid.
7652
7653 xmax (PLFLT, input) : The maximum x world coordinate of the
7654 rectangular cuboid.
7655
7656 ymin (PLFLT, input) : The minimum y world coordinate of the
7657 rectangular cuboid.
7658
7659 ymax (PLFLT, input) : The maximum y world coordinate of the
7660 rectangular cuboid.
7661
7662 zmin (PLFLT, input) : The minimum z world coordinate of the
7663 rectangular cuboid.
7664
7665 zmax (PLFLT, input) : The maximum z world coordinate of the
7666 rectangular cuboid.
7667
7668 alt (PLFLT, input) : The viewing altitude in degrees above the xy
7669 plane of the rectangular cuboid in normalized coordinates.
7670
7671 az (PLFLT, input) : The viewing azimuth in degrees of the
7672 rectangular cuboid in normalized coordinates. When az=0, the
7673 observer is looking face onto the zx plane of the rectangular
7674 cuboid in normalized coordinates, and as az is increased, the
7675 observer moves clockwise around that cuboid when viewed from above
7676 the xy plane.
7677
7678 """
7679 return _plplotc.plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az)
7680
7681def plwidth(width):
7682 r"""
7683 Set pen width
7684
7685 DESCRIPTION:
7686
7687 Sets the pen width.
7688
7689 Redacted form: plwidth(width)
7690
7691 This function is used in examples 1 and 2.
7692
7693
7694
7695 SYNOPSIS:
7696
7697 plwidth(width)
7698
7699 ARGUMENTS:
7700
7701 width (PLFLT, input) : The desired pen width. If width is negative
7702 or the same as the previous value no action is taken. width = 0.
7703 should be interpreted as as the minimum valid pen width for the
7704 device. The interpretation of positive width values is also
7705 device dependent.
7706
7707 """
7708 return _plplotc.plwidth(width)
7709
7710def plwind(xmin, xmax, ymin, ymax):
7711 r"""
7712 Specify window
7713
7714 DESCRIPTION:
7715
7716 Specify the window, i.e., the world coordinates of the edges of the
7717 viewport.
7718
7719 Redacted form: plwind(xmin, xmax, ymin, ymax)
7720
7721 This function is used in examples 1, 2, 4, 6-12, 14-16, 18, 21, 23-27,
7722 29, and 31.
7723
7724
7725
7726 SYNOPSIS:
7727
7728 plwind(xmin, xmax, ymin, ymax)
7729
7730 ARGUMENTS:
7731
7732 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
7733 of the viewport.
7734
7735 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
7736 of the viewport.
7737
7738 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
7739 the viewport.
7740
7741 ymax (PLFLT, input) : The world y coordinate of the top edge of the
7742 viewport.
7743
7744 """
7745 return _plplotc.plwind(xmin, xmax, ymin, ymax)
7746
7747def plxormod(mode):
7748 r"""
7749 Enter or leave xor mode
7750
7751 DESCRIPTION:
7752
7753 Enter (when mode is true) or leave (when mode is false) xor mode for
7754 those drivers (e.g., the xwin driver) that support it. Enables
7755 erasing plots by drawing twice the same line, symbol, etc. If driver
7756 is not capable of xor operation it returns a status of false.
7757
7758 Redacted form: plxormod(mode, status)
7759
7760 This function is used in examples 1 and 20.
7761
7762
7763
7764 SYNOPSIS:
7765
7766 plxormod(mode, status)
7767
7768 ARGUMENTS:
7769
7770 mode (PLBOOL, input) : mode is true means enter xor mode and mode
7771 is false means leave xor mode.
7772
7773 status (PLBOOL_NC_SCALAR, output) : Returned value of the status.
7774 modestatus of true (false) means driver is capable (incapable) of
7775 xor mode.
7776
7777 """
7778 return _plplotc.plxormod(mode)
7779
7780def plmap(mapform, type, minx, maxx, miny, maxy):
7781 r"""
7782 Plot continental outline or shapefile data in world coordinates
7783
7784 DESCRIPTION:
7785
7786 Plots continental outlines or shapefile data in world coordinates. A
7787 demonstration of how to use this function to create different
7788 projections can be found in examples/c/x19c. PLplot is provided with
7789 basic coastal outlines and USA state borders. To use the map
7790 functionality PLplot must be compiled with the shapelib library.
7791 Shapefiles have become a popular standard for geographical data and
7792 data in this format can be easily found from a number of online
7793 sources. Shapefile data is actually provided as three or more files
7794 with the same filename, but different extensions. The .shp and .shx
7795 files are required for plotting Shapefile data with PLplot.
7796
7797 PLplot currently supports the point, multipoint, polyline and polygon
7798 objects within shapefiles. However holes in polygons are not
7799 supported. When plmap is used the type of object is derived from the
7800 shapefile, if you wish to override the type then use one of the other
7801 plmap variants. The built in maps have line data only.
7802
7803 Redacted form: plmap(mapform, name, minx, maxx, miny, maxy)
7804
7805 This function is used in example 19.
7806
7807
7808
7809 SYNOPSIS:
7810
7811 plmap(mapform, name, minx, maxx, miny, maxy)
7812
7813 ARGUMENTS:
7814
7815 mapform (PLMAPFORM_callback, input) : A user supplied function to
7816 transform the original map data coordinates to a new coordinate
7817 system. The PLplot-supplied map data is provided as latitudes and
7818 longitudes; other Shapefile data may be provided in other
7819 coordinate systems as can be found in their .prj plain text files.
7820 For example, by using this transform we can change from a
7821 longitude, latitude coordinate to a polar stereographic
7822 projection. Initially, x[0]..[n-1] are the original x coordinates
7823 (longitudes for the PLplot-supplied data) and y[0]..y[n-1] are the
7824 corresponding y coordinates (latitudes for the PLplot supplied
7825 data). After the call to mapform(), x[] and y[] should be
7826 replaced by the corresponding plot coordinates. If no transform is
7827 desired, mapform can be replaced by NULL.
7828
7829 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7830 the type of map plotted. This is either one of the PLplot built-in
7831 maps or the file name of a set of Shapefile files without the file
7832 extensions. For the PLplot built-in maps the possible values are:
7833 "globe" -- continental outlines
7834 "usa" -- USA and state boundaries
7835 "cglobe" -- continental outlines and countries
7836 "usaglobe" -- USA, state boundaries and continental outlines
7837
7838
7839 minx (PLFLT, input) : The minimum x value of map elements to be
7840 drawn. The units must match the shapefile (built in maps are
7841 degrees lat/lon). Objects in the file which do not encroach on the
7842 box defined by minx, maxx, miny, maxy will not be rendered. But
7843 note this is simply an optimisation, not a clipping so for objects
7844 with some points inside the box and some points outside the box
7845 all the points will be rendered. These parameters also define
7846 latitude and longitude wrapping for shapefiles using these units.
7847 Longitude points will be wrapped by integer multiples of 360
7848 degrees to place them in the box. This allows the same data to be
7849 used on plots from -180-180 or 0-360 longitude ranges. In fact if
7850 you plot from -180-540 you will get two cycles of data drawn. The
7851 value of minx must be less than the value of maxx. Passing in a
7852 nan, max/-max floating point number or +/-infinity will case the
7853 bounding box from the shapefile to be used.
7854
7855 maxx (PLFLT, input) : The maximum x value of map elements to be
7856 drawn - see minx.
7857
7858 miny (PLFLT, input) : The minimum y value of map elements to be
7859 drawn - see minx.
7860
7861 maxy (PLFLT, input) : The maximum y value of map elements to be
7862 drawn - see minx.
7863
7864 """
7865 return _plplotc.plmap(mapform, type, minx, maxx, miny, maxy)
7866
7867def plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull):
7868 r"""
7869 Plot all or a subset of Shapefile data using lines in world coordinates
7870
7871 DESCRIPTION:
7872
7873 Plot all or a subset of Shapefile data using lines in world
7874 coordinates. Our 19th standard example demonstrates how to use this
7875 function. This function plots data from a Shapefile using lines as in
7876 plmap, however it also has the option of also only drawing specified
7877 elements from the Shapefile. The vector of indices of the required
7878 elements are passed as a function argument. The Shapefile data should
7879 include a metadata file (extension.dbf) listing all items within the
7880 Shapefile. This file can be opened by most popular spreadsheet
7881 programs and can be used to decide which indices to pass to this
7882 function.
7883
7884 Redacted form: plmapline(mapform, name, minx, maxx, miny, maxy,
7885 plotentries)
7886
7887 This function is used in example 19.
7888
7889
7890
7891 SYNOPSIS:
7892
7893 plmapline(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
7894
7895 ARGUMENTS:
7896
7897 mapform (PLMAPFORM_callback, input) : A user supplied function to
7898 transform the coordinates given in the shapefile into a plot
7899 coordinate system. By using this transform, we can change from a
7900 longitude, latitude coordinate to a polar stereographic project,
7901 for example. Initially, x[0]..[n-1] are the longitudes and
7902 y[0]..y[n-1] are the corresponding latitudes. After the call to
7903 mapform(), x[] and y[] should be replaced by the corresponding
7904 plot coordinates. If no transform is desired, mapform can be
7905 replaced by NULL.
7906
7907 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7908 the file name of a set of Shapefile files without the file
7909 extension.
7910
7911 minx (PLFLT, input) : The minimum x value to be plotted. This must
7912 be in the same units as used by the Shapefile. You could use a
7913 very large negative number to plot everything, but you can improve
7914 performance by limiting the area drawn. The units must match those
7915 of the Shapefile projection, which may be for example longitude or
7916 distance. The value of minx must be less than the value of maxx.
7917
7918 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7919 use a very large number to plot everything, but you can improve
7920 performance by limiting the area drawn.
7921
7922 miny (PLFLT, input) : The minimum y value to be plotted. This must
7923 be in the same units as used by the Shapefile. You could use a
7924 very large negative number to plot everything, but you can improve
7925 performance by limiting the area drawn. The units must match those
7926 of the Shapefile projection, which may be for example latitude or
7927 distance. The value of miny must be less than the value of maxy.
7928
7929 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7930 use a very large number to plot everything, but you can improve
7931 performance by limiting the area drawn.
7932
7933 plotentries (PLINT_VECTOR, input) : A vector containing the
7934 zero-based indices of the Shapefile elements which will be drawn.
7935 Setting
7936 plotentries to NULL will plot all elements of the Shapefile.
7937
7938 nplotentries (PLINT, input) : The number of items in
7939 plotentries. Ignored if
7940 plotentries is NULL.
7941
7942 """
7943 return _plplotc.plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull)
7944
7945def plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull):
7946 r"""
7947 Plot all or a subset of Shapefile data using strings or points in world coordinates
7948
7949 DESCRIPTION:
7950
7951 As per plmapline, however the items are plotted as strings or points
7952 in the same way as plstring.
7953
7954 Redacted form: plmapstring(mapform, name, string, minx, maxx, miny,
7955 maxy, plotentries)
7956
7957 This function is not used in any examples.
7958
7959
7960
7961 SYNOPSIS:
7962
7963 plmapstring(mapform, name, string, minx, maxx, miny, maxy, plotentries, nplotentries)
7964
7965 ARGUMENTS:
7966
7967 mapform (PLMAPFORM_callback, input) : A user supplied function to
7968 transform the coordinates given in the shapefile into a plot
7969 coordinate system. By using this transform, we can change from a
7970 longitude, latitude coordinate to a polar stereographic project,
7971 for example. Initially, x[0]..[n-1] are the longitudes and
7972 y[0]..y[n-1] are the corresponding latitudes. After the call to
7973 mapform(), x[] and y[] should be replaced by the corresponding
7974 plot coordinates. If no transform is desired, mapform can be
7975 replaced by NULL.
7976
7977 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7978 the file name of a set of Shapefile files without the file
7979 extension.
7980
7981 string (PLCHAR_VECTOR, input) : A UTF-8 character string to be
7982 drawn.
7983
7984 minx (PLFLT, input) : The minimum x value to be plotted. This must
7985 be in the same units as used by the Shapefile. You could use a
7986 very large negative number to plot everything, but you can improve
7987 performance by limiting the area drawn. The units must match those
7988 of the Shapefile projection, which may be for example longitude or
7989 distance. The value of minx must be less than the value of maxx.
7990
7991 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7992 use a very large number to plot everything, but you can improve
7993 performance by limiting the area drawn.
7994
7995 miny (PLFLT, input) : The minimum y value to be plotted. This must
7996 be in the same units as used by the Shapefile. You could use a
7997 very large negative number to plot everything, but you can improve
7998 performance by limiting the area drawn. The units must match those
7999 of the Shapefile projection, which may be for example latitude or
8000 distance. The value of miny must be less than the value of maxy.
8001
8002 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8003 use a very large number to plot everything, but you can improve
8004 performance by limiting the area drawn.
8005
8006 plotentries (PLINT_VECTOR, input) : A vector containing the
8007 zero-based indices of the Shapefile elements which will be drawn.
8008 Setting
8009 plotentries to NULL will plot all elements of the Shapefile.
8010
8011 nplotentries (PLINT, input) : The number of items in
8012 plotentries. Ignored if
8013 plotentries is NULL.
8014
8015 """
8016 return _plplotc.plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull)
8017
8018def plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry):
8019 r"""
8020 Draw text at points defined by Shapefile data in world coordinates
8021
8022 DESCRIPTION:
8023
8024 As per plmapline, however the items are plotted as text in the same
8025 way as plptex.
8026
8027 Redacted form: plmaptex(mapform, name, dx, dy, just, text, minx, maxx,
8028 miny, maxy, plotentry)
8029
8030 This function is used in example 19.
8031
8032
8033
8034 SYNOPSIS:
8035
8036 plmaptex(mapform, name, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8037
8038 ARGUMENTS:
8039
8040 mapform (PLMAPFORM_callback, input) : A user supplied function to
8041 transform the coordinates given in the shapefile into a plot
8042 coordinate system. By using this transform, we can change from a
8043 longitude, latitude coordinate to a polar stereographic project,
8044 for example. Initially, x[0]..[n-1] are the longitudes and
8045 y[0]..y[n-1] are the corresponding latitudes. After the call to
8046 mapform(), x[] and y[] should be replaced by the corresponding
8047 plot coordinates. If no transform is desired, mapform can be
8048 replaced by NULL.
8049
8050 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8051 the file name of a set of Shapefile files without the file
8052 extension.
8053
8054 dx (PLFLT, input) : Used to define the slope of the texts which is
8055 dy/dx.
8056
8057 dy (PLFLT, input) : Used to define the slope of the texts which is
8058 dy/dx.
8059
8060 just (PLFLT, input) : Set the justification of the text. The value
8061 given will be the fraction of the distance along the string that
8062 sits at the given point. 0.0 gives left aligned text, 0.5 gives
8063 centralized text and 1.0 gives right aligned text.
8064
8065 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be drawn.
8066
8067 minx (PLFLT, input) : The minimum x value to be plotted. This must
8068 be in the same units as used by the Shapefile. You could use a
8069 very large negative number to plot everything, but you can improve
8070 performance by limiting the area drawn. The units must match those
8071 of the Shapefile projection, which may be for example longitude or
8072 distance. The value of minx must be less than the value of maxx.
8073
8074 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8075 use a very large number to plot everything, but you can improve
8076 performance by limiting the area drawn.
8077
8078 miny (PLFLT, input) : The minimum y value to be plotted. This must
8079 be in the same units as used by the Shapefile. You could use a
8080 very large negative number to plot everything, but you can improve
8081 performance by limiting the area drawn. The units must match those
8082 of the Shapefile projection, which may be for example latitude or
8083 distance. The value of miny must be less than the value of maxy.
8084
8085 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8086 use a very large number to plot everything, but you can improve
8087 performance by limiting the area drawn.
8088
8089 plotentry (PLINT, input) : An integer indicating which text string
8090 of the Shapefile (zero indexed) will be drawn.
8091
8092 """
8093 return _plplotc.plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8094
8095def plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull):
8096 r"""
8097 Plot all or a subset of Shapefile data, filling the polygons
8098
8099 DESCRIPTION:
8100
8101 As per plmapline, however the items are filled in the same way as
8102 plfill.
8103
8104 Redacted form: plmapfill(mapform, name, minx, maxx, miny, maxy,
8105 plotentries)
8106
8107 This function is used in example 19.
8108
8109
8110
8111 SYNOPSIS:
8112
8113 plmapfill(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
8114
8115 ARGUMENTS:
8116
8117 mapform (PLMAPFORM_callback, input) : A user supplied function to
8118 transform the coordinates given in the shapefile into a plot
8119 coordinate system. By using this transform, we can change from a
8120 longitude, latitude coordinate to a polar stereographic project,
8121 for example. Initially, x[0]..[n-1] are the longitudes and
8122 y[0]..y[n-1] are the corresponding latitudes. After the call to
8123 mapform(), x[] and y[] should be replaced by the corresponding
8124 plot coordinates. If no transform is desired, mapform can be
8125 replaced by NULL.
8126
8127 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8128 the file name of a set of Shapefile files without the file
8129 extension.
8130
8131 minx (PLFLT, input) : The minimum x value to be plotted. This must
8132 be in the same units as used by the Shapefile. You could use a
8133 very large negative number to plot everything, but you can improve
8134 performance by limiting the area drawn. The units must match those
8135 of the Shapefile projection, which may be for example longitude or
8136 distance. The value of minx must be less than the value of maxx.
8137
8138 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8139 use a very large number to plot everything, but you can improve
8140 performance by limiting the area drawn.
8141
8142 miny (PLFLT, input) : The minimum y value to be plotted. This must
8143 be in the same units as used by the Shapefile. You could use a
8144 very large negative number to plot everything, but you can improve
8145 performance by limiting the area drawn. The units must match those
8146 of the Shapefile projection, which may be for example latitude or
8147 distance. The value of miny must be less than the value of maxy.
8148
8149 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8150 use a very large number to plot everything, but you can improve
8151 performance by limiting the area drawn.
8152
8153 plotentries (PLINT_VECTOR, input) : A vector containing the
8154 zero-based indices of the Shapefile elements which will be drawn.
8155 Setting
8156 plotentries to NULL will plot all elements of the Shapefile.
8157
8158 nplotentries (PLINT, input) : The number of items in
8159 plotentries. Ignored if
8160 plotentries is NULL.
8161
8162 """
8163 return _plplotc.plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull)
8164
8165def plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat):
8166 r"""
8167 Plot latitude and longitude lines
8168
8169 DESCRIPTION:
8170
8171 Displays latitude and longitude on the current plot. The lines are
8172 plotted in the current color and line style.
8173
8174 Redacted form: plmeridians(mapform, dlong, dlat, minlong, maxlong,
8175 minlat, maxlat)
8176
8177 This function is used in example 19.
8178
8179
8180
8181 SYNOPSIS:
8182
8183 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8184
8185 ARGUMENTS:
8186
8187 mapform (PLMAPFORM_callback, input) : A user supplied function to
8188 transform the coordinate longitudes and latitudes to a plot
8189 coordinate system. By using this transform, we can change from a
8190 longitude, latitude coordinate to a polar stereographic project,
8191 for example. Initially, x[0]..[n-1] are the longitudes and
8192 y[0]..y[n-1] are the corresponding latitudes. After the call to
8193 mapform(), x[] and y[] should be replaced by the corresponding
8194 plot coordinates. If no transform is desired, mapform can be
8195 replaced by NULL.
8196
8197 dlong (PLFLT, input) : The interval in degrees at which the
8198 longitude lines are to be plotted.
8199
8200 dlat (PLFLT, input) : The interval in degrees at which the latitude
8201 lines are to be plotted.
8202
8203 minlong (PLFLT, input) : The value of the longitude on the left
8204 side of the plot. The value of minlong must be less than the value
8205 of maxlong, and the quantity maxlong-minlong must be less than or
8206 equal to 360.
8207
8208 maxlong (PLFLT, input) : The value of the longitude on the right
8209 side of the plot.
8210
8211 minlat (PLFLT, input) : The minimum latitude to be plotted on the
8212 background. One can always use -90.0 as the boundary outside the
8213 plot window will be automatically eliminated. However, the
8214 program will be faster if one can reduce the size of the
8215 background plotted.
8216
8217 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
8218 background. One can always use 90.0 as the boundary outside the
8219 plot window will be automatically eliminated.
8220
8221 """
8222 return _plplotc.plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8223
8224def plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax):
8225 r"""
8226 Plot a 2D matrix using cmap1 with automatic color adjustment
8227
8228 DESCRIPTION:
8229
8230 Plot a 2D matrix using the cmap1 palette. The color scale is
8231 automatically adjusted to use the maximum and minimum values in idata
8232 as valuemin and valuemax in a call to plimagefr.
8233
8234 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin,
8235 zmax, Dxmin, Dxmax, Dymin, Dymax)
8236
8237
8238 This function is used in example 20.
8239
8240
8241
8242 SYNOPSIS:
8243
8244 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8245
8246 ARGUMENTS:
8247
8248 idata (PLFLT_MATRIX, input) : A matrix containing function values
8249 to plot. Should have dimensions of
8250 nx by
8251 ny.
8252
8253 nx, ny (PLINT, input) : Dimensions of idata
8254
8255 xmin, xmax, ymin, ymax (PLFLT, input) : The x and y index ranges
8256 are linearly transformed to these world coordinate ranges such
8257 that idata[0][0] corresponds to (xmin, ymin) and idata[nx - 1][ny
8258 - 1] corresponds to (xmax, ymax).
8259
8260 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
8261 (inclusive) will be plotted.
8262
8263 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
8264 points whose plot coordinates fall inside the window of (Dxmin,
8265 Dymin) to (Dxmax, Dymax).
8266
8267 """
8268 return _plplotc.plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8269
8270def plimagefr(*args):
8271 r"""
8272 Plot a 2D matrix using cmap1
8273
8274 DESCRIPTION:
8275
8276 Plot a 2D matrix using cmap1.
8277
8278 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin,
8279 zmax, valuemin, valuemax, pltr, pltr_data)
8280
8281
8282 This function is used in example 20.
8283
8284
8285
8286 SYNOPSIS:
8287
8288 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
8289
8290 ARGUMENTS:
8291
8292 idata (PLFLT_MATRIX, input) : A matrix of values (intensities) to
8293 plot. Should have dimensions of
8294 nx by
8295 ny.
8296
8297 nx, ny (PLINT, input) : Dimensions of idata
8298
8299 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
8300 pltr below for how these arguments are used (only for the special case
8301 when the callback function
8302 pltr is not supplied).
8303
8304 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
8305 (inclusive) will be plotted.
8306
8307 valuemin, valuemax (PLFLT, input) : The minimum and maximum data
8308 values to use for value to color mappings. A datum equal to or
8309 less than valuemin will be plotted with color 0.0, while a datum
8310 equal to or greater than valuemax will be plotted with color 1.0.
8311 Data between valuemin and valuemax map linearly to colors in the
8312 range (0.0-1.0).
8313
8314 pltr (PLTRANSFORM_callback, input) : A callback function that
8315 defines the transformation between the zero-based indices of the
8316 matrix idata and world coordinates. If
8317 pltr is not supplied (e.g., is set to NULL in the C case), then the x
8318 indices of idata are mapped to the range
8319 xmin through
8320 xmax and the y indices of idata are mapped to the range
8321 ymin through
8322 ymax.For the C case, transformation functions are provided in the
8323 PLplot library: pltr0 for the identity mapping, and pltr1 and
8324 pltr2 for arbitrary mappings respectively defined by vectors and
8325 matrices. In addition, C callback routines for the transformation
8326 can be supplied by the user such as the mypltr function in
8327 examples/c/x09c.c which provides a general linear transformation
8328 between index coordinates and world coordinates.For languages
8329 other than C you should consult the PLplot documentation for the
8330 details concerning how PLTRANSFORM_callback arguments are
8331 interfaced. However, in general, a particular pattern of
8332 callback-associated arguments such as a tr vector with 6 elements;
8333 xg and yg vectors; or xg and yg matrices are respectively
8334 interfaced to a linear-transformation routine similar to the above
8335 mypltr function; pltr1; and pltr2. Furthermore, some of our more
8336 sophisticated bindings (see, e.g., the PLplot documentation)
8337 support native language callbacks for handling index to
8338 world-coordinate transformations. Examples of these various
8339 approaches are given in examples/<language>x09*,
8340 examples/<language>x16*, examples/<language>x20*,
8341 examples/<language>x21*, and examples/<language>x22*, for all our
8342 supported languages.
8343
8344 pltr_data (PLPointer, input) : Extra parameter to help pass
8345 information to pltr0, pltr1, pltr2, or whatever routine is
8346 externally supplied.
8347
8348 """
8349 return _plplotc.plimagefr(*args)
8350
8352 return _plplotc.plClearOpts()
8353
8355 return _plplotc.plResetOpts()
8356
8357def plSetUsage(program_string, usage_string):
8358 return _plplotc.plSetUsage(program_string, usage_string)
8359
8361 return _plplotc.plOptUsage()
8362
8363def plMinMax2dGrid(Matrix):
8364 return _plplotc.plMinMax2dGrid(Matrix)
8365
8367 r"""
8368 Wait for graphics input event and translate to world coordinates.
8369
8370 DESCRIPTION:
8371
8372 Wait for graphics input event and translate to world coordinates.
8373 Returns 0 if no translation to world coordinates is possible.
8374
8375 This function returns 1 on success and 0 if no translation to world
8376 coordinates is possible.
8377
8378 Redacted form: plGetCursor(gin)
8379
8380 This function is used in examples 1 and 20.
8381
8382
8383
8384 SYNOPSIS:
8385
8386 PLINT plGetCursor(gin)
8387
8388 ARGUMENTS:
8389
8390 gin (PLGraphicsIn *, output) : Pointer to PLGraphicsIn structure
8391 which will contain the output. The structure is not allocated by
8392 the routine and must exist before the function is called.
8393
8394 """
8395 return _plplotc.plGetCursor(gin)
8396
plSetUsage(program_string, usage_string)
Definition plplotc.py:8357
plgcolbga()
Definition plplotc.py:2022
plmkstrm()
Definition plplotc.py:3652
_swig_repr(self)
Definition plplotc.py:16
plbop()
Definition plplotc.py:627
plgcolbg()
Definition plplotc.py:1990
plResetOpts()
Definition plplotc.py:8354
plglevel()
Definition plplotc.py:2348
pltr1(x, y, cgrid)
Definition plplotc.py:55
plfamadv()
Definition plplotc.py:1648
plgfnam()
Definition plplotc.py:2279
plgdidev()
Definition plplotc.py:2111
plrandd()
Definition plplotc.py:4716
plOptUsage()
Definition plplotc.py:8360
_swig_setattr_nondynamic_instance_variable(set)
Definition plplotc.py:24
plgfont()
Definition plplotc.py:2306
plsxwin(window_id)
Definition plplotc.py:268
plflush()
Definition plplotc.py:1794
pltr0(x, y)
Definition plplotc.py:52
plgdiplt()
Definition plplotc.py:2181
pltr2(x, y, cgrid)
Definition plplotc.py:58
plgcompression()
Definition plplotc.py:2056
plreplot()
Definition plplotc.py:4743
_swig_setattr_nondynamic_class_variable(set)
Definition plplotc.py:37
plClearOpts()
Definition plplotc.py:8351
plgdiori()
Definition plplotc.py:2149
plMinMax2dGrid(Matrix)
Definition plplotc.py:8363
plclear()
Definition plplotc.py:934
plgcmap1_range()
Definition plplotc.py:5267
plgstrm()
Definition plplotc.py:2569
plGetCursor(gin)
Definition plplotc.py:8366
plgpage()
Definition plplotc.py:2378
#define plpat
Definition plplot.h:779
#define plschr
Definition plplot.h:790
#define plfontld
Definition plplot.h:721
#define plpath
Definition plplot.h:761
#define plerry
Definition plplot.h:715
#define plsfam
Definition plplot.h:816
#define plsmaj
Definition plplot.h:826
#define plsmin
Definition plplot.h:829
#define plimage
Definition plplot.h:753
#define plstransform
Definition plplot.h:840
#define plmap
Definition plplot.h:764
#define plfill
Definition plplot.h:717
#define plvpas
Definition plplot.h:859
#define plerrx
Definition plplot.h:714
#define plscmap1l
Definition plplot.h:796
#define plsori
Definition plplot.h:830
#define plbox3
Definition plplot.h:698
#define plmapfill
Definition plplot.h:768
#define plcol1
Definition plplot.h:703
#define pltimefmt
Definition plplot.h:856
#define plmaptex
Definition plplot.h:767
#define plvect
Definition plplot.h:858
#define pllegend
Definition plplot.h:758
#define plsyax
Definition plplot.h:852
#define plscolbg
Definition plplot.h:802
#define plpsty
Definition plplot.h:784
#define plenv
Definition plplot.h:711
#define pllightsource
Definition plplot.h:759
#define plsmema
Definition plplot.h:828
#define plpoin3
Definition plplot.h:781
#define plscol0
Definition plplot.h:800
#define plptex
Definition plplot.h:785
#define plrgbhls
Definition plplot.h:789
#define plpoin
Definition plplot.h:780
#define plptex3
Definition plplot.h:786
#define plstripd
Definition plplot.h:845
#define plhist
Definition plplot.h:751
#define plmapline
Definition plplot.h:765
#define plszax
Definition plplot.h:854
#define plsmem
Definition plplot.h:827
#define plstripa
Definition plplot.h:843
#define plenv0
Definition plplot.h:712
#define plspal1
Definition plplot.h:833
#define plstring3
Definition plplot.h:842
#define plxormod
Definition plplot.h:865
#define plspause
Definition plplot.h:834
#define plgradient
Definition plplot.h:741
#define plspal0
Definition plplot.h:832
#define plcalc_world
Definition plplot.h:700
#define plwidth
Definition plplot.h:863
#define pllab
Definition plplot.h:757
#define plsurf3d
Definition plplot.h:847
#define plsurf3dl
Definition plplot.h:848
#define plvasp
Definition plplot.h:857
#define plscmap0n
Definition plplot.h:793
#define plmtex3
Definition plplot.h:774
#define plctime
Definition plplot.h:708
#define plsvpa
Definition plplot.h:850
#define plw3d
Definition plplot.h:862
#define plot3dcl
Definition plplot.h:777
#define plscmap1n
Definition plplot.h:798
#define plhlsrgb
Definition plplot.h:752
#define pl_setcontlabelformat
Definition plplot.h:690
#define plsdev
Definition plplot.h:806
#define plconfigtime
Definition plplot.h:705
#define plscolbga
Definition plplot.h:803
#define plscmap1
Definition plplot.h:794
#define plsdiplz
Definition plplot.h:811
#define plparseopts
Definition plplot.h:778
#define plmapstring
Definition plplot.h:766
#define plot3d
Definition plplot.h:775
#define plsesc
Definition plplot.h:814
#define plarc
Definition plplot.h:693
#define plsetopt
Definition plplot.h:815
#define plstring
Definition plplot.h:841
#define plsdiori
Definition plplot.h:809
#define plcont
Definition plplot.h:706
#define plspage
Definition plplot.h:831
#define plaxes
Definition plplot.h:694
#define pllsty
Definition plplot.h:763
#define plslabelfunc
Definition plplot.h:825
#define plshades
Definition plplot.h:824
#define plscompression
Definition plplot.h:805
#define plfont
Definition plplot.h:720
#define plscmap0a
Definition plplot.h:792
#define plgcol0a
Definition plplot.h:725
#define plscmap1_range
Definition plplot.h:799
#define plmeshc
Definition plplot.h:771
#define plshade
Definition plplot.h:820
#define plsym
Definition plplot.h:853
#define plscmap1a
Definition plplot.h:795
#define plscmap0
Definition plplot.h:791
#define plgriddata
Definition plplot.h:742
#define plstripc
Definition plplot.h:844
#define pl_setcontlabelparam
Definition plplot.h:691
#define plsvect
Definition plplot.h:849
#define plstyl
Definition plplot.h:846
#define plline
Definition plplot.h:760
#define pljoin
Definition plplot.h:756
#define plsstrm
Definition plplot.h:835
#define plscmap1la
Definition plplot.h:797
#define plssym
Definition plplot.h:837
#define plscolor
Definition plplot.h:804
#define plcol0
Definition plplot.h:702
#define plsdiplt
Definition plplot.h:810
#define plcolorbar
Definition plplot.h:704
#define plmeridians
Definition plplot.h:769
#define plot3dc
Definition plplot.h:776
#define plcpstrm
Definition plplot.h:707
#define plgcol0
Definition plplot.h:724
#define pladv
Definition plplot.h:692
#define plline3
Definition plplot.h:762
#define plprec
Definition plplot.h:783
#define plfill3
Definition plplot.h:718
#define plseed
Definition plplot.h:813
#define plimagefr
Definition plplot.h:754
#define plsfont
Definition plplot.h:819
#define plscol0a
Definition plplot.h:801
#define plbin
Definition plplot.h:695
#define plsdidev
Definition plplot.h:807
#define plsfnam
Definition plplot.h:818
#define plwind
Definition plplot.h:864
#define plstar
Definition plplot.h:838
#define plmtex
Definition plplot.h:773
#define plsdimap
Definition plplot.h:808
#define plsfci
Definition plplot.h:817
#define plmesh
Definition plplot.h:770
#define plstart
Definition plplot.h:839
#define plsxax
Definition plplot.h:851
#define plbox
Definition plplot.h:697
#define plbtime
Definition plplot.h:699
#define plvpor
Definition plplot.h:860
#define plpoly3
Definition plplot.h:782
#define plssub
Definition plplot.h:836