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