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