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