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