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