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