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