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