00001
00002
00003
00004
00005
00006
00007
00008 from sys import version_info
00009 if version_info >= (2,6,0):
00010 def swig_import_helper():
00011 from os.path import dirname
00012 import imp
00013 fp = None
00014 try:
00015 fp, pathname, description = imp.find_module('_plplotc', [dirname(__file__)])
00016 except ImportError:
00017 import _plplotc
00018 return _plplotc
00019 if fp is not None:
00020 try:
00021 _mod = imp.load_module('_plplotc', fp, pathname, description)
00022 finally:
00023 fp.close()
00024 return _mod
00025 _plplotc = swig_import_helper()
00026 del swig_import_helper
00027 else:
00028 import _plplotc
00029 del version_info
00030 try:
00031 _swig_property = property
00032 except NameError:
00033 pass
00034 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
00035 if (name == "thisown"): return self.this.own(value)
00036 if (name == "this"):
00037 if type(value).__name__ == 'SwigPyObject':
00038 self.__dict__[name] = value
00039 return
00040 method = class_type.__swig_setmethods__.get(name,None)
00041 if method: return method(self,value)
00042 if (not static) or hasattr(self,name):
00043 self.__dict__[name] = value
00044 else:
00045 raise AttributeError("You cannot add attributes to %s" % self)
00046
00047 def _swig_setattr(self,class_type,name,value):
00048 return _swig_setattr_nondynamic(self,class_type,name,value,0)
00049
00050 def _swig_getattr(self,class_type,name):
00051 if (name == "thisown"): return self.this.own()
00052 method = class_type.__swig_getmethods__.get(name,None)
00053 if method: return method(self)
00054 raise AttributeError(name)
00055
00056 def _swig_repr(self):
00057 try: strthis = "proxy of " + self.this.__repr__()
00058 except: strthis = ""
00059 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
00060
00061 try:
00062 _object = object
00063 _newclass = 1
00064 except AttributeError:
00065 class _object : pass
00066 _newclass = 0
00067
00068
00069
00070 def pltr0(*args):
00071 return _plplotc.pltr0(*args)
00072 pltr0 = _plplotc.pltr0
00073
00074 def pltr1(*args):
00075 return _plplotc.pltr1(*args)
00076 pltr1 = _plplotc.pltr1
00077
00078 def pltr2(*args):
00079 return _plplotc.pltr2(*args)
00080 pltr2 = _plplotc.pltr2
00081 PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
00082 PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
00083 PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
00084 PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
00085 PLESC_RESIZE = _plplotc.PLESC_RESIZE
00086 PLESC_REDRAW = _plplotc.PLESC_REDRAW
00087 PLESC_TEXT = _plplotc.PLESC_TEXT
00088 PLESC_GRAPH = _plplotc.PLESC_GRAPH
00089 PLESC_FILL = _plplotc.PLESC_FILL
00090 PLESC_DI = _plplotc.PLESC_DI
00091 PLESC_FLUSH = _plplotc.PLESC_FLUSH
00092 PLESC_EH = _plplotc.PLESC_EH
00093 PLESC_GETC = _plplotc.PLESC_GETC
00094 PLESC_SWIN = _plplotc.PLESC_SWIN
00095 PLESC_PLFLTBUFFERING = _plplotc.PLESC_PLFLTBUFFERING
00096 PLESC_XORMOD = _plplotc.PLESC_XORMOD
00097 PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
00098 PLESC_CLEAR = _plplotc.PLESC_CLEAR
00099 PLESC_DASH = _plplotc.PLESC_DASH
00100 PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
00101 PLESC_IMAGE = _plplotc.PLESC_IMAGE
00102 PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
00103 DRAW_LINEX = _plplotc.DRAW_LINEX
00104 DRAW_LINEY = _plplotc.DRAW_LINEY
00105 DRAW_LINEXY = _plplotc.DRAW_LINEXY
00106 MAG_COLOR = _plplotc.MAG_COLOR
00107 BASE_CONT = _plplotc.BASE_CONT
00108 TOP_CONT = _plplotc.TOP_CONT
00109 SURF_CONT = _plplotc.SURF_CONT
00110 DRAW_SIDES = _plplotc.DRAW_SIDES
00111 FACETED = _plplotc.FACETED
00112 MESH = _plplotc.MESH
00113 PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
00114 PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
00115 PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
00116 PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
00117 PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
00118 PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
00119 PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
00120 PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
00121 PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
00122 PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
00123 PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
00124 PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
00125 PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
00126 PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
00127 PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
00128 PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
00129 PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
00130 PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
00131 PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
00132 PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
00133 PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
00134 PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
00135 PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
00136 PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
00137 PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
00138 PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
00139 PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
00140 PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
00141 PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
00142 PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
00143 PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
00144 PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
00145 PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
00146 PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
00147 PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
00148 PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
00149 PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
00150 PL_X_AXIS = _plplotc.PL_X_AXIS
00151 PL_Y_AXIS = _plplotc.PL_Y_AXIS
00152 PL_Z_AXIS = _plplotc.PL_Z_AXIS
00153 PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
00154 PL_OPT_ARG = _plplotc.PL_OPT_ARG
00155 PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
00156 PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
00157 PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
00158 PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
00159 PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
00160 PL_OPT_INT = _plplotc.PL_OPT_INT
00161 PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
00162 PL_OPT_STRING = _plplotc.PL_OPT_STRING
00163 PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
00164 PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
00165 PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
00166 PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
00167 PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
00168 PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
00169 PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
00170 PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
00171 PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
00172 PL_FCI_MARK = _plplotc.PL_FCI_MARK
00173 PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
00174 PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
00175 PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
00176 PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
00177 PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
00178 PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
00179 PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
00180 PL_FCI_SANS = _plplotc.PL_FCI_SANS
00181 PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
00182 PL_FCI_MONO = _plplotc.PL_FCI_MONO
00183 PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
00184 PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
00185 PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
00186 PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
00187 PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
00188 PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
00189 PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
00190 PL_MAXKEY = _plplotc.PL_MAXKEY
00191 class PLGraphicsIn(_object):
00192 __swig_setmethods__ = {}
00193 __setattr__ = lambda self, name, value: _swig_setattr(self, PLGraphicsIn, name, value)
00194 __swig_getmethods__ = {}
00195 __getattr__ = lambda self, name: _swig_getattr(self, PLGraphicsIn, name)
00196 __repr__ = _swig_repr
00197 __swig_setmethods__["type"] = _plplotc.PLGraphicsIn_type_set
00198 __swig_getmethods__["type"] = _plplotc.PLGraphicsIn_type_get
00199 if _newclass:type = _swig_property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
00200 __swig_setmethods__["state"] = _plplotc.PLGraphicsIn_state_set
00201 __swig_getmethods__["state"] = _plplotc.PLGraphicsIn_state_get
00202 if _newclass:state = _swig_property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
00203 __swig_setmethods__["keysym"] = _plplotc.PLGraphicsIn_keysym_set
00204 __swig_getmethods__["keysym"] = _plplotc.PLGraphicsIn_keysym_get
00205 if _newclass:keysym = _swig_property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
00206 __swig_setmethods__["button"] = _plplotc.PLGraphicsIn_button_set
00207 __swig_getmethods__["button"] = _plplotc.PLGraphicsIn_button_get
00208 if _newclass:button = _swig_property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
00209 __swig_setmethods__["subwindow"] = _plplotc.PLGraphicsIn_subwindow_set
00210 __swig_getmethods__["subwindow"] = _plplotc.PLGraphicsIn_subwindow_get
00211 if _newclass:subwindow = _swig_property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
00212 __swig_setmethods__["string"] = _plplotc.PLGraphicsIn_string_set
00213 __swig_getmethods__["string"] = _plplotc.PLGraphicsIn_string_get
00214 if _newclass:string = _swig_property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
00215 __swig_setmethods__["pX"] = _plplotc.PLGraphicsIn_pX_set
00216 __swig_getmethods__["pX"] = _plplotc.PLGraphicsIn_pX_get
00217 if _newclass:pX = _swig_property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
00218 __swig_setmethods__["pY"] = _plplotc.PLGraphicsIn_pY_set
00219 __swig_getmethods__["pY"] = _plplotc.PLGraphicsIn_pY_get
00220 if _newclass:pY = _swig_property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
00221 __swig_setmethods__["dX"] = _plplotc.PLGraphicsIn_dX_set
00222 __swig_getmethods__["dX"] = _plplotc.PLGraphicsIn_dX_get
00223 if _newclass:dX = _swig_property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
00224 __swig_setmethods__["dY"] = _plplotc.PLGraphicsIn_dY_set
00225 __swig_getmethods__["dY"] = _plplotc.PLGraphicsIn_dY_get
00226 if _newclass:dY = _swig_property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
00227 __swig_setmethods__["wX"] = _plplotc.PLGraphicsIn_wX_set
00228 __swig_getmethods__["wX"] = _plplotc.PLGraphicsIn_wX_get
00229 if _newclass:wX = _swig_property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
00230 __swig_setmethods__["wY"] = _plplotc.PLGraphicsIn_wY_set
00231 __swig_getmethods__["wY"] = _plplotc.PLGraphicsIn_wY_get
00232 if _newclass:wY = _swig_property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
00233 def __init__(self):
00234 this = _plplotc.new_PLGraphicsIn()
00235 try: self.this.append(this)
00236 except: self.this = this
00237 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
00238 __del__ = lambda self : None;
00239 PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister
00240 PLGraphicsIn_swigregister(PLGraphicsIn)
00241
00242 PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
00243 PL_NOTSET = _plplotc.PL_NOTSET
00244 PLESPLFLTBUFFERING_ENABLE = _plplotc.PLESPLFLTBUFFERING_ENABLE
00245 PLESPLFLTBUFFERING_DISABLE = _plplotc.PLESPLFLTBUFFERING_DISABLE
00246 PLESPLFLTBUFFERING_QUERY = _plplotc.PLESPLFLTBUFFERING_QUERY
00247 GRID_CSA = _plplotc.GRID_CSA
00248 GRID_DTLI = _plplotc.GRID_DTLI
00249 GRID_NNI = _plplotc.GRID_NNI
00250 GRID_NNIDW = _plplotc.GRID_NNIDW
00251 GRID_NNLI = _plplotc.GRID_NNLI
00252 GRID_NNAIDW = _plplotc.GRID_NNAIDW
00253
00254 def plsxwin(*args):
00255 return _plplotc.plsxwin(*args)
00256 plsxwin = _plplotc.plsxwin
00257
00258 def pl_setcontlabelformat(*args):
00259 """
00260 Set format of numerical label for contours
00261
00262 DESCRIPTION:
00263
00264 Set format of numerical label for contours.
00265
00266 Redacted form: pl_setcontlabelformat(lexp, sigdig)
00267
00268 This function is used example 9.
00269
00270
00271
00272 SYNOPSIS:
00273
00274 pl_setcontlabelformat(lexp, sigdig)
00275
00276 ARGUMENTS:
00277
00278 lexp (PLINT, input) : If the contour numerical label is greater
00279 than 10^(lexp) or less than 10^(-lexp), then the exponential
00280 format is used. Default value of lexp is 4.
00281
00282 sigdig (PLINT, input) : Number of significant digits. Default
00283 value is 2.
00284
00285 """
00286 return _plplotc.pl_setcontlabelformat(*args)
00287
00288 def pl_setcontlabelparam(*args):
00289 """
00290 Set parameters of contour labelling other than format of numerical label
00291
00292 DESCRIPTION:
00293
00294 Set parameters of contour labelling other than those handled by
00295 pl_setcontlabelformat.
00296
00297 Redacted form: pl_setcontlabelparam(offset, size, spacing, active)
00298
00299 This function is used in example 9.
00300
00301
00302
00303 SYNOPSIS:
00304
00305 pl_setcontlabelparam(offset, size, spacing, active)
00306
00307 ARGUMENTS:
00308
00309 offset (PLFLT, input) : Offset of label from contour line (if set
00310 to 0.0, labels are printed on the lines). Default value is 0.006.
00311
00312 size (PLFLT, input) : Font height for contour labels (normalized).
00313 Default value is 0.3.
00314
00315 spacing (PLFLT, input) : Spacing parameter for contour labels.
00316 Default value is 0.1.
00317
00318 active (PLINT, input) : Activate labels. Set to 1 if you want
00319 contour labels on. Default is off (0).
00320
00321 """
00322 return _plplotc.pl_setcontlabelparam(*args)
00323
00324 def pladv(*args):
00325 """
00326 Advance the (sub-)page
00327
00328 DESCRIPTION:
00329
00330 Advances to the next subpage if sub=0, performing a page advance if
00331 there are no remaining subpages on the current page. If subpages
00332 aren't being used, pladv(0) will always advance the page. If sub>0,
00333 PLplot switches to the specified subpage. Note that this allows you
00334 to overwrite a plot on the specified subpage; if this is not what you
00335 intended, use pleop followed by plbop to first advance the page. This
00336 routine is called automatically (with sub=0) by plenv, but if plenv is
00337 not used, pladv must be called after initializing PLplot but before
00338 defining the viewport.
00339
00340 Redacted form: pladv(sub)
00341
00342 This function is used in examples 1,2,4,6-12,14-18,20,21,23-27,29,31.
00343
00344
00345
00346 SYNOPSIS:
00347
00348 pladv(sub)
00349
00350 ARGUMENTS:
00351
00352 sub (PLINT, input) : Specifies the subpage number (starting from 1
00353 in the top left corner and increasing along the rows) to which to
00354 advance. Set to zero to advance to the next subpage.
00355
00356 """
00357 return _plplotc.pladv(*args)
00358
00359 def plarc(*args):
00360 """
00361 Draw a circular or elliptical arc
00362
00363 DESCRIPTION:
00364
00365 Draw a possible filled arc centered at x, y with semimajor axis a and
00366 semiminor axis b, starting at angle1 and ending at angle2.
00367
00368 Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate, fill)
00369
00370
00371 This function is used in example 3.
00372
00373
00374
00375 SYNOPSIS:
00376
00377 plarc(x, y, a, b, angle1, angle2, rotate, fill)
00378
00379 ARGUMENTS:
00380
00381 x (PLFLT, input) : X coordinate of arc center.
00382
00383 y (PLFLT, input) : Y coordinate of arc center.
00384
00385 a (PLFLT, input) : Length of the semimajor axis of the arc.
00386
00387 b (PLFLT, input) : Length of the semiminor axis of the arc.
00388
00389 angle1 (PLFLT, input) : Starting angle of the arc.
00390
00391 angle2 (PLFLT, input) : Ending angle of the arc.
00392
00393 rotate (PLFLT, input) : Rotation of arc
00394
00395 fill (PLBOOL, input) : Draw a filled arc.
00396
00397 """
00398 return _plplotc.plarc(*args)
00399
00400 def plaxes(*args):
00401 """
00402 Draw a box with axes, etc. with arbitrary origin
00403
00404 DESCRIPTION:
00405
00406 Draws a box around the currently defined viewport with arbitrary
00407 world-coordinate origin specified by x0 and y0 and labels it with
00408 world coordinate values appropriate to the window. Thus plaxes should
00409 only be called after defining both viewport and window. The character
00410 strings xopt and yopt specify how the box should be drawn as described
00411 below. If ticks and/or subticks are to be drawn for a particular
00412 axis, the tick intervals and number of subintervals may be specified
00413 explicitly, or they may be defaulted by setting the appropriate
00414 arguments to zero.
00415
00416 Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt,
00417 ytick, nysub)
00418 Perl/PDL: plaxes(x0, y0, xtick, nxsub, ytick, nysub, xopt,
00419 yopt)
00420
00421
00422 This function is not used in any examples.
00423
00424
00425
00426 SYNOPSIS:
00427
00428 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
00429
00430 ARGUMENTS:
00431
00432 x0 (PLFLT, input) : World X coordinate of origin.
00433
00434 y0 (PLFLT, input) : World Y coordinate of origin.
00435
00436 xopt (const char *, input) : Pointer to character string specifying
00437 options for horizontal axis. The string can include any
00438 combination of the following letters (upper or lower case) in any
00439 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
00440 is vertical line (x=0).
00441 b: Draws bottom (X) or left (Y) edge of frame.
00442 c: Draws top (X) or right (Y) edge of frame.
00443 d: Plot labels as date / time. Values are assumed to be
00444 seconds since the epoch (as used by gmtime).
00445 f: Always use fixed point numeric labels.
00446 g: Draws a grid at the major tick interval.
00447 h: Draws a grid at the minor tick interval.
00448 i: Inverts tick marks, so they are drawn outwards, rather than
00449 inwards.
00450 l: Labels axis logarithmically. This only affects the labels,
00451 not the data, and so it is necessary to compute the logarithms
00452 of data points before passing them to any of the drawing
00453 routines.
00454 m: Writes numeric labels at major tick intervals in the
00455 unconventional location (above box for X, right of box for Y).
00456 n: Writes numeric labels at major tick intervals in the
00457 conventional location (below box for X, left of box for Y).
00458 o: Use custom labeling function to generate axis label text.
00459 The custom labeling function can be defined with the
00460 plslabelfuncplslabelfunc; command.
00461 s: Enables subticks between major ticks, only valid if t is
00462 also specified.
00463 t: Draws major ticks.
00464
00465
00466 xtick (PLFLT, input) : World coordinate interval between major
00467 ticks on the x axis. If it is set to zero, PLplot automatically
00468 generates a suitable tick interval.
00469
00470 nxsub (PLINT, input) : Number of subintervals between major x axis
00471 ticks for minor ticks. If it is set to zero, PLplot automatically
00472 generates a suitable minor tick interval.
00473
00474 yopt (const char *, input) : Pointer to character string specifying
00475 options for vertical axis. The string can include any combination
00476 of the letters defined above for xopt, and in addition may
00477 contain: v: Write numeric labels for vertical axis parallel to the
00478 base of the graph, rather than parallel to the axis.
00479
00480
00481 ytick (PLFLT, input) : World coordinate interval between major
00482 ticks on the y axis. If it is set to zero, PLplot automatically
00483 generates a suitable tick interval.
00484
00485 nysub (PLINT, input) : Number of subintervals between major y axis
00486 ticks for minor ticks. If it is set to zero, PLplot automatically
00487 generates a suitable minor tick interval.
00488
00489 """
00490 return _plplotc.plaxes(*args)
00491
00492 def plbin(*args):
00493 """
00494 Plot a histogram from binned data
00495
00496 DESCRIPTION:
00497
00498 Plots a histogram consisting of nbin bins. The value associated with
00499 the i'th bin is placed in x[i], and the number of points in the bin is
00500 placed in y[i]. For proper operation, the values in x[i] must form a
00501 strictly increasing sequence. By default, x[i] is the left-hand edge
00502 of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
00503 placed midway between the values in the x array. Also see plhist for
00504 drawing histograms from unbinned data.
00505
00506 Redacted form: General: plbin(x, y, opt)
00507 Perl/PDL: plbin(nbin, x, y, opt)
00508 Python: plbin(nbin, x, y, opt)
00509
00510
00511 This function is not used in any examples.
00512
00513
00514
00515 SYNOPSIS:
00516
00517 plbin(nbin, x, y, opt)
00518
00519 ARGUMENTS:
00520
00521 nbin (PLINT, input) : Number of bins (i.e., number of values in x
00522 and y arrays.)
00523
00524 x (PLFLT *, input) : Pointer to array containing values associated
00525 with bins. These must form a strictly increasing sequence.
00526
00527 y (PLFLT *, input) : Pointer to array containing number of points
00528 in bin. This is a PLFLT (instead of PLINT) array so as to allow
00529 histograms of probabilities, etc.
00530
00531 opt (PLINT, input) : Is a combination of several flags:
00532 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
00533 outer bins are expanded to fill up the entire x-axis and bins of
00534 zero height are simply drawn.
00535 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
00536 between the x values. If the values in x are equally spaced,
00537 the values are the center values of the bins.
00538 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal
00539 size as the ones inside.
00540 opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn
00541 (there is a gap for such bins).
00542
00543 """
00544 return _plplotc.plbin(*args)
00545
00546 def plbtime(*args):
00547 return _plplotc.plbtime(*args)
00548 plbtime = _plplotc.plbtime
00549
00550 def plbop():
00551 """
00552 Begin a new page
00553
00554 DESCRIPTION:
00555
00556 Begins a new page. For a file driver, the output file is opened if
00557 necessary. Advancing the page via pleop and plbop is useful when a
00558 page break is desired at a particular point when plotting to subpages.
00559 Another use for pleop and plbop is when plotting pages to different
00560 files, since you can manually set the file name by calling plsfnam
00561 after the call to pleop. (In fact some drivers may only support a
00562 single page per file, making this a necessity.) One way to handle
00563 this case automatically is to page advance via pladv, but enable
00564 familying (see plsfam) with a small limit on the file size so that a
00565 new family member file will be created on each page break.
00566
00567 Redacted form: plbop()
00568
00569 This function is used in examples 2,20.
00570
00571
00572
00573 SYNOPSIS:
00574
00575 plbop()
00576
00577 """
00578 return _plplotc.plbop()
00579
00580 def plbox(*args):
00581 """
00582 Draw a box with axes, etc
00583
00584 DESCRIPTION:
00585
00586 Draws a box around the currently defined viewport, and labels it with
00587 world coordinate values appropriate to the window. Thus plbox should
00588 only be called after defining both viewport and window. The character
00589 strings xopt and yopt specify how the box should be drawn as described
00590 below. If ticks and/or subticks are to be drawn for a particular
00591 axis, the tick intervals and number of subintervals may be specified
00592 explicitly, or they may be defaulted by setting the appropriate
00593 arguments to zero.
00594
00595 Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
00596 Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt)
00597
00598
00599 This function is used in examples 1,2,4,6,6-12,14-18,21,23-26,29.
00600
00601
00602
00603 SYNOPSIS:
00604
00605 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
00606
00607 ARGUMENTS:
00608
00609 xopt (const char *, input) : Pointer to character string specifying
00610 options for horizontal axis. The string can include any
00611 combination of the following letters (upper or lower case) in any
00612 order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis
00613 is vertical line (x=0).
00614 b: Draws bottom (X) or left (Y) edge of frame.
00615 c: Draws top (X) or right (Y) edge of frame.
00616 d: Plot labels as date / time. Values are assumed to be
00617 seconds since the epoch (as used by gmtime).
00618 f: Always use fixed point numeric labels.
00619 g: Draws a grid at the major tick interval.
00620 h: Draws a grid at the minor tick interval.
00621 i: Inverts tick marks, so they are drawn outwards, rather than
00622 inwards.
00623 l: Labels axis logarithmically. This only affects the labels,
00624 not the data, and so it is necessary to compute the logarithms
00625 of data points before passing them to any of the drawing
00626 routines.
00627 m: Writes numeric labels at major tick intervals in the
00628 unconventional location (above box for X, right of box for Y).
00629 n: Writes numeric labels at major tick intervals in the
00630 conventional location (below box for X, left of box for Y).
00631 o: Use custom labeling function to generate axis label text.
00632 The custom labeling function can be defined with the
00633 plslabelfuncplslabelfunc; command.
00634 s: Enables subticks between major ticks, only valid if t is
00635 also specified.
00636 t: Draws major ticks.
00637
00638
00639 xtick (PLFLT, input) : World coordinate interval between major
00640 ticks on the x axis. If it is set to zero, PLplot automatically
00641 generates a suitable tick interval.
00642
00643 nxsub (PLINT, input) : Number of subintervals between major x axis
00644 ticks for minor ticks. If it is set to zero, PLplot automatically
00645 generates a suitable minor tick interval.
00646
00647 yopt (const char *, input) : Pointer to character string specifying
00648 options for vertical axis. The string can include any combination
00649 of the letters defined above for xopt, and in addition may
00650 contain: v: Write numeric labels for vertical axis parallel to the
00651 base of the graph, rather than parallel to the axis.
00652
00653
00654 ytick (PLFLT, input) : World coordinate interval between major
00655 ticks on the y axis. If it is set to zero, PLplot automatically
00656 generates a suitable tick interval.
00657
00658 nysub (PLINT, input) : Number of subintervals between major y axis
00659 ticks for minor ticks. If it is set to zero, PLplot automatically
00660 generates a suitable minor tick interval.
00661
00662 """
00663 return _plplotc.plbox(*args)
00664
00665 def plbox3(*args):
00666 """
00667 Draw a box with axes, etc, in 3-d
00668
00669 DESCRIPTION:
00670
00671 Draws axes, numeric and text labels for a three-dimensional surface
00672 plot. For a more complete description of three-dimensional plotting
00673 see the PLplot documentation.
00674
00675 Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt,
00676 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
00677 Perl/PDL: plbox3(xtick, nxsub, ytick, nysub, ztick, nzsub,
00678 xopt, xlabel, yopt, ylabel, zopt, zlabel)
00679
00680
00681 This function is used in examples 8,11,18,21.
00682
00683
00684
00685 SYNOPSIS:
00686
00687 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
00688
00689 ARGUMENTS:
00690
00691 xopt (const char *, input) : Pointer to character string specifying
00692 options for the x axis. The string can include any combination of
00693 the following letters (upper or lower case) in any order: b: Draws
00694 axis at base, at height z=
00695 zmin where zmin is defined by call to plw3d. This character must be
00696 specified in order to use any of the other options.
00697 f: Always use fixed point numeric labels.
00698 i: Inverts tick marks, so they are drawn downwards, rather
00699 than upwards.
00700 l: Labels axis logarithmically. This only affects the labels,
00701 not the data, and so it is necessary to compute the logarithms
00702 of data points before passing them to any of the drawing
00703 routines.
00704 n: Writes numeric labels at major tick intervals.
00705 o: Use custom labeling function to generate axis label text.
00706 The custom labeling function can be defined with the
00707 plslabelfuncplslabelfunc; command.
00708 s: Enables subticks between major ticks, only valid if t is
00709 also specified.
00710 t: Draws major ticks.
00711 u: If this is specified, the text label for the axis is
00712 written under the axis.
00713
00714
00715 xlabel (const char *, input) : Pointer to character string
00716 specifying text label for the x axis. It is only drawn if u is in
00717 the xopt string.
00718
00719 xtick (PLFLT, input) : World coordinate interval between major
00720 ticks on the x axis. If it is set to zero, PLplot automatically
00721 generates a suitable tick interval.
00722
00723 nxsub (PLINT, input) : Number of subintervals between major x axis
00724 ticks for minor ticks. If it is set to zero, PLplot automatically
00725 generates a suitable minor tick interval.
00726
00727 yopt (const char *, input) : Pointer to character string specifying
00728 options for the y axis. The string is interpreted in the same way
00729 as xopt.
00730
00731 ylabel (const char *, input) : Pointer to character string
00732 specifying text label for the y axis. It is only drawn if u is in
00733 the yopt string.
00734
00735 ytick (PLFLT, input) : World coordinate interval between major
00736 ticks on the y axis. If it is set to zero, PLplot automatically
00737 generates a suitable tick interval.
00738
00739 nysub (PLINT, input) : Number of subintervals between major y axis
00740 ticks for minor ticks. If it is set to zero, PLplot automatically
00741 generates a suitable minor tick interval.
00742
00743 zopt (const char *, input) : Pointer to character string specifying
00744 options for the z axis. The string can include any combination of
00745 the following letters (upper or lower case) in any order: b: Draws
00746 z axis to the left of the surface plot.
00747 c: Draws z axis to the right of the surface plot.
00748 d: Draws grid lines parallel to the x-y plane behind the
00749 figure. These lines are not drawn until after plot3d or
00750 plmesh are called because of the need for hidden line removal.
00751 f: Always use fixed point numeric labels.
00752 i: Inverts tick marks, so they are drawn away from the center.
00753 l: Labels axis logarithmically. This only affects the labels,
00754 not the data, and so it is necessary to compute the logarithms
00755 of data points before passing them to any of the drawing
00756 routines.
00757 m: Writes numeric labels at major tick intervals on the
00758 right-hand vertical axis.
00759 n: Writes numeric labels at major tick intervals on the
00760 left-hand vertical axis.
00761 o: Use custom labeling function to generate axis label text.
00762 The custom labeling function can be defined with the
00763 plslabelfuncplslabelfunc; command.
00764 s: Enables subticks between major ticks, only valid if t is
00765 also specified.
00766 t: Draws major ticks.
00767 u: If this is specified, the text label is written beside the
00768 left-hand axis.
00769 v: If this is specified, the text label is written beside the
00770 right-hand axis.
00771
00772
00773 zlabel (const char *, input) : Pointer to character string
00774 specifying text label for the z axis. It is only drawn if u or v
00775 are in the zopt string.
00776
00777 ztick (PLFLT, input) : World coordinate interval between major
00778 ticks on the z axis. If it is set to zero, PLplot automatically
00779 generates a suitable tick interval.
00780
00781 nzsub (PLINT, input) : Number of subintervals between major z axis
00782 ticks for minor ticks. If it is set to zero, PLplot automatically
00783 generates a suitable minor tick interval.
00784
00785 """
00786 return _plplotc.plbox3(*args)
00787
00788 def plcalc_world(*args):
00789 """
00790 Calculate world coordinates and corresponding window index from relative device coordinates
00791
00792 DESCRIPTION:
00793
00794 Calculate world coordinates, wx and wy, and corresponding window index
00795 from relative device coordinates, rx and ry.
00796
00797 Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
00798 Perl/PDL: Not available?
00799
00800
00801 This function is used in example 31.
00802
00803
00804
00805 SYNOPSIS:
00806
00807 plcalc_world(rx, ry, wx, wy, window)
00808
00809 ARGUMENTS:
00810
00811 rx (PLFLT, input) : Input relative device coordinate (ranging from
00812 0. to 1.) for the x coordinate.
00813
00814 ry (PLFLT, input) : Input relative device coordinate (ranging from
00815 0. to 1.) for the y coordinate.
00816
00817 wx (PLFLT *, output) : Pointer to the returned world coordinate for
00818 x corresponding to the relative device coordinates rx and ry.
00819
00820 wy (PLFLT *, output) : Pointer to the returned world coordinate for
00821 y corresponding to the relative device coordinates rx and ry.
00822
00823 window (PLINT *, output) : Pointer to the returned last defined
00824 window index that corresponds to the input relative device
00825 coordinates (and the returned world coordinates). To give some
00826 background on the window index, for each page the initial window
00827 index is set to zero, and each time plwind is called within the
00828 page, world and device coordinates are stored for the window and
00829 the window index is incremented. Thus, for a simple page layout
00830 with non-overlapping viewports and one window per viewport, window
00831 corresponds to the viewport index (in the order which the
00832 viewport/windows were created) of the only viewport/window
00833 corresponding to rx and ry. However, for more complicated layouts
00834 with potentially overlapping viewports and possibly more than one
00835 window (set of world coordinates) per viewport, window and the
00836 corresponding output world coordinates corresponds to the last
00837 window created that fulfils the criterion that the relative device
00838 coordinates are inside it. Finally, in all cases where the input
00839 relative device coordinates are not inside any viewport/window,
00840 then window is set to -1.
00841
00842 """
00843 return _plplotc.plcalc_world(*args)
00844
00845 def plclear():
00846 """
00847 Clear current (sub)page
00848
00849 DESCRIPTION:
00850
00851 Clears the current page, effectively erasing everything that have been
00852 drawn. This command only works with interactive drivers; if the
00853 driver does not support this, the page is filled with the background
00854 color in use. If the current page is divided into subpages, only the
00855 current subpage is erased. The nth subpage can be selected with
00856 pladv(n).
00857
00858 Redacted form: General: plclear()
00859 Perl/PDL: Not available?
00860
00861
00862 This function is not used in any examples.
00863
00864
00865
00866 SYNOPSIS:
00867
00868 plclear()
00869
00870 """
00871 return _plplotc.plclear()
00872
00873 def plcol0(*args):
00874 """
00875 Set color, map0
00876
00877 DESCRIPTION:
00878
00879 Sets the color for color map0 (see the PLplot documentation).
00880
00881 Redacted form: plcol0(color)
00882
00883 This function is used in examples 1-9,11-16,18-27,29.
00884
00885
00886
00887 SYNOPSIS:
00888
00889 plcol0(color)
00890
00891 ARGUMENTS:
00892
00893 color (PLINT, input) : Integer representing the color. The
00894 defaults at present are (these may change):
00895 0 black (default background)
00896 1 red (default foreground)
00897 2 yellow
00898 3 green
00899 4 aquamarine
00900 5 pink
00901 6 wheat
00902 7 grey
00903 8 brown
00904 9 blue
00905 10 BlueViolet
00906 11 cyan
00907 12 turquoise
00908 13 magenta
00909 14 salmon
00910 15 white
00911 Use plscmap0 to change the entire map0 color palette and plscol0 to
00912 change an individual color in the map0 color palette.
00913
00914 """
00915 return _plplotc.plcol0(*args)
00916
00917 def plcol1(*args):
00918 """
00919 Set color, map1
00920
00921 DESCRIPTION:
00922
00923 Sets the color for color map1 (see the PLplot documentation).
00924
00925 Redacted form: plcol1(col1)
00926
00927 This function is used in example 12.
00928
00929
00930
00931 SYNOPSIS:
00932
00933 plcol1(col1)
00934
00935 ARGUMENTS:
00936
00937 col1 (PLFLT, input) : This value must be in the range from 0. to 1.
00938 and is mapped to color using the continuous map1 color palette
00939 which by default ranges from blue to the background color to red.
00940 The map1 palette can also be straightforwardly changed by the user
00941 with plscmap1 or plscmap1l.
00942
00943 """
00944 return _plplotc.plcol1(*args)
00945
00946 def plconfigtime(*args):
00947 return _plplotc.plconfigtime(*args)
00948 plconfigtime = _plplotc.plconfigtime
00949
00950 def plcont(*args):
00951 """
00952 Contour plot
00953
00954 DESCRIPTION:
00955
00956 Draws a contour plot of the data in z[
00957 nx][
00958 ny], using the nlevel contour levels specified by clevel. Only the
00959 region of the array from kx to lx and from ky to ly is plotted out. A
00960 transformation routine pointed to by pltr with a pointer pltr_data for
00961 additional data required by the transformation routine is used to map
00962 indices within the array to the world coordinates. See the following
00963 discussion of the arguments and the PLplot documentation for more
00964 information.
00965
00966 Redacted form: [PLEASE UPDATE! ONLY PERL INFO IS LIKELY CORRECT!] F95:
00967 plcont(z, kx, lx, ky, ly, clevel, tr?) or plcont(z, kx, lx, ky, ly,
00968 clevel, xgrid, ygrid)
00969 Java: pls.cont(z, kx, lx, ky, ly, clevel, xgrid, ygrid)
00970 Perl/PDL: plcont(z, kx, lx, ky, ly, clevel, pltr, pltr_data)
00971 Python: plcont2(z, kx, lx, ky, ly, clevel)
00972
00973
00974 This function is used in examples 9,14,16,22.
00975
00976
00977
00978 SYNOPSIS:
00979
00980 plcont(z, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
00981
00982 ARGUMENTS:
00983
00984 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
00985 containing data to be contoured.
00986
00987 nx, ny (PLINT, input) : Physical dimensions of array z.
00988
00989 kx, lx (PLINT, input) : Range of x indices to consider.
00990
00991 ky, ly (PLINT, input) : Range of y indices to consider.
00992
00993 clevel (PLFLT *, input) : Pointer to array specifying levels at
00994 which to draw contours.
00995
00996 nlevel (PLINT, input) : Number of contour levels to draw.
00997
00998 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
00999 Pointer to function that defines transformation between indices
01000 in array z and the world coordinates (C only). Transformation
01001 functions are provided in the PLplot library: pltr0 for identity
01002 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
01003 defined by one- and two-dimensional arrays. In addition,
01004 user-supplied routines for the transformation can be used as well.
01005 Examples of all of these approaches are given in the PLplot
01006 documentation. The transformation function should have the form
01007 given by any of pltr0, pltr1, or pltr2. Note that unlike plshades
01008 and similar PLplot functions which have a pltr argument, plcont
01009 requires that a transformation function be provided in the C
01010 interface. Leaving pltr NULL will result in an error.
01011
01012 pltr_data (PLPointer, input) : Extra parameter to help pass
01013 information to pltr0, pltr1, pltr2, or whatever routine that is
01014 externally supplied.
01015
01016 """
01017 return _plplotc.plcont(*args)
01018
01019 def plctime(*args):
01020 return _plplotc.plctime(*args)
01021 plctime = _plplotc.plctime
01022
01023 def plcpstrm(*args):
01024 """
01025 Copy state parameters from the reference stream to the current stream
01026
01027 DESCRIPTION:
01028
01029 Copies state parameters from the reference stream to the current
01030 stream. Tell driver interface to map device coordinates unless flags
01031 == 1.
01032
01033 This function is used for making save files of selected plots (e.g.
01034 from the TK driver). After initializing, you can get a copy of the
01035 current plot to the specified device by switching to this stream and
01036 issuing a plcpstrm and a plreplot, with calls to plbop and pleop as
01037 appropriate. The plot buffer must have previously been enabled (done
01038 automatically by some display drivers, such as X).
01039
01040 Redacted form: plcpstrm(iplsr, flags)
01041
01042 This function is used in example 1,20.
01043
01044
01045
01046 SYNOPSIS:
01047
01048 plcpstrm(iplsr, flags)
01049
01050 ARGUMENTS:
01051
01052 iplsr (PLINT, input) : Number of reference stream.
01053
01054 flags (PLBOOL, input) : If flags is set to true the device
01055 coordinates are not copied from the reference to current stream.
01056
01057 """
01058 return _plplotc.plcpstrm(*args)
01059
01060 def plend():
01061 """
01062 End plotting session
01063
01064 DESCRIPTION:
01065
01066 Ends a plotting session, tidies up all the output files, switches
01067 interactive devices back into text mode and frees up any memory that
01068 was allocated. Must be called before end of program.
01069
01070 By default, PLplot's interactive devices (Xwin, TK, etc.) go into a
01071 wait state after a call to plend or other functions which trigger the
01072 end of a plot page. To avoid this, use the plspause function.
01073
01074 Redacted form: plend()
01075
01076 This function is used in all of the examples.
01077
01078
01079
01080 SYNOPSIS:
01081
01082 plend()
01083
01084 """
01085 return _plplotc.plend()
01086
01087 def plend1():
01088 """
01089 End plotting session for current stream
01090
01091 DESCRIPTION:
01092
01093 Ends a plotting session for the current output stream only. See
01094 plsstrm for more info.
01095
01096 Redacted form: plend1()
01097
01098 This function is used in examples 1,20.
01099
01100
01101
01102 SYNOPSIS:
01103
01104 plend1()
01105
01106 """
01107 return _plplotc.plend1()
01108
01109 def plenv(*args):
01110 """
01111 Set up standard window and draw box
01112
01113 DESCRIPTION:
01114
01115 Sets up plotter environment for simple graphs by calling pladv and
01116 setting up viewport and window to sensible default values. plenv
01117 leaves enough room around most graphs for axis labels and a title.
01118 When these defaults are not suitable, use the individual routines
01119 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
01120 defining the window, and plbox for drawing the box.
01121
01122 Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis)
01123
01124 This function is used in example 1,3,9,13,14,19-22,29.
01125
01126
01127
01128 SYNOPSIS:
01129
01130 plenv(xmin, xmax, ymin, ymax, just, axis)
01131
01132 ARGUMENTS:
01133
01134 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
01135 world coordinates).
01136
01137 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
01138 world coordinates).
01139
01140 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
01141 coordinates).
01142
01143 ymax (PLFLT, input) : Value of y at top edge of window (in world
01144 coordinates).
01145
01146 just (PLINT, input) : Controls how the axes will be scaled: -1: the
01147 scales will not be set, the user must set up the scale before
01148 calling plenv using plsvpa, plvasp or other.
01149 0: the x and y axes are scaled independently to use as much of
01150 the screen as possible.
01151 1: the scales of the x and y axes are made equal.
01152 2: the axis of the x and y axes are made equal, and the plot
01153 box will be square.
01154
01155
01156 axis (PLINT, input) : Controls drawing of the box around the plot:
01157 -2: draw no box, no tick marks, no numeric tick labels, no axes.
01158 -1: draw box only.
01159 0: draw box, ticks, and numeric tick labels.
01160 1: also draw coordinate axes at x=0 and y=0.
01161 2: also draw a grid at major tick positions in both
01162 coordinates.
01163 3: also draw a grid at minor tick positions in both
01164 coordinates.
01165 10: same as 0 except logarithmic x tick marks. (The x data
01166 have to be converted to logarithms separately.)
01167 11: same as 1 except logarithmic x tick marks. (The x data
01168 have to be converted to logarithms separately.)
01169 12: same as 2 except logarithmic x tick marks. (The x data
01170 have to be converted to logarithms separately.)
01171 13: same as 3 except logarithmic x tick marks. (The x data
01172 have to be converted to logarithms separately.)
01173 20: same as 0 except logarithmic y tick marks. (The y data
01174 have to be converted to logarithms separately.)
01175 21: same as 1 except logarithmic y tick marks. (The y data
01176 have to be converted to logarithms separately.)
01177 22: same as 2 except logarithmic y tick marks. (The y data
01178 have to be converted to logarithms separately.)
01179 23: same as 3 except logarithmic y tick marks. (The y data
01180 have to be converted to logarithms separately.)
01181 30: same as 0 except logarithmic x and y tick marks. (The x
01182 and y data have to be converted to logarithms separately.)
01183 31: same as 1 except logarithmic x and y tick marks. (The x
01184 and y data have to be converted to logarithms separately.)
01185 32: same as 2 except logarithmic x and y tick marks. (The x
01186 and y data have to be converted to logarithms separately.)
01187 33: same as 3 except logarithmic x and y tick marks. (The x
01188 and y data have to be converted to logarithms separately.)
01189 40: same as 0 except date / time x labels.
01190 41: same as 1 except date / time x labels.
01191 42: same as 2 except date / time x labels.
01192 43: same as 3 except date / time x labels.
01193 50: same as 0 except date / time y labels.
01194 51: same as 1 except date / time y labels.
01195 52: same as 2 except date / time y labels.
01196 53: same as 3 except date / time y labels.
01197 60: same as 0 except date / time x and y labels.
01198 61: same as 1 except date / time x and y labels.
01199 62: same as 2 except date / time x and y labels.
01200 63: same as 3 except date / time x and y labels.
01201 70: same as 0 except custom x and y labels.
01202 71: same as 1 except custom x and y labels.
01203 72: same as 2 except custom x and y labels.
01204 73: same as 3 except custom x and y labels.
01205
01206 """
01207 return _plplotc.plenv(*args)
01208
01209 def plenv0(*args):
01210 """
01211 Same as plenv but if in multiplot mode does not advance the subpage, instead clears it.
01212
01213 DESCRIPTION:
01214
01215 Sets up plotter environment for simple graphs by calling pladv and
01216 setting up viewport and window to sensible default values. plenv0
01217 leaves enough room around most graphs for axis labels and a title.
01218 When these defaults are not suitable, use the individual routines
01219 plvpas, plvpor, or plvasp for setting up the viewport, plwind for
01220 defining the window, and plbox for drawing the box.
01221
01222 Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis)
01223
01224 This function is used in example 21.
01225
01226
01227
01228 SYNOPSIS:
01229
01230 plenv0(xmin, xmax, ymin, ymax, just, axis)
01231
01232 ARGUMENTS:
01233
01234 xmin (PLFLT, input) : Value of x at left-hand edge of window (in
01235 world coordinates).
01236
01237 xmax (PLFLT, input) : Value of x at right-hand edge of window (in
01238 world coordinates).
01239
01240 ymin (PLFLT, input) : Value of y at bottom edge of window (in world
01241 coordinates).
01242
01243 ymax (PLFLT, input) : Value of y at top edge of window (in world
01244 coordinates).
01245
01246 just (PLINT, input) : Controls how the axes will be scaled: -1: the
01247 scales will not be set, the user must set up the scale before
01248 calling plenv0 using plsvpa, plvasp or other.
01249 0: the x and y axes are scaled independently to use as much of
01250 the screen as possible.
01251 1: the scales of the x and y axes are made equal.
01252 2: the axis of the x and y axes are made equal, and the plot
01253 box will be square.
01254
01255
01256 axis (PLINT, input) : Controls drawing of the box around the plot:
01257 -2: draw no box, no tick marks, no numeric tick labels, no axes.
01258 -1: draw box only.
01259 0: draw box, ticks, and numeric tick labels.
01260 1: also draw coordinate axes at x=0 and y=0.
01261 2: also draw a grid at major tick positions in both
01262 coordinates.
01263 3: also draw a grid at minor tick positions in both
01264 coordinates.
01265 10: same as 0 except logarithmic x tick marks. (The x data
01266 have to be converted to logarithms separately.)
01267 11: same as 1 except logarithmic x tick marks. (The x data
01268 have to be converted to logarithms separately.)
01269 12: same as 2 except logarithmic x tick marks. (The x data
01270 have to be converted to logarithms separately.)
01271 13: same as 3 except logarithmic x tick marks. (The x data
01272 have to be converted to logarithms separately.)
01273 20: same as 0 except logarithmic y tick marks. (The y data
01274 have to be converted to logarithms separately.)
01275 21: same as 1 except logarithmic y tick marks. (The y data
01276 have to be converted to logarithms separately.)
01277 22: same as 2 except logarithmic y tick marks. (The y data
01278 have to be converted to logarithms separately.)
01279 23: same as 3 except logarithmic y tick marks. (The y data
01280 have to be converted to logarithms separately.)
01281 30: same as 0 except logarithmic x and y tick marks. (The x
01282 and y data have to be converted to logarithms separately.)
01283 31: same as 1 except logarithmic x and y tick marks. (The x
01284 and y data have to be converted to logarithms separately.)
01285 32: same as 2 except logarithmic x and y tick marks. (The x
01286 and y data have to be converted to logarithms separately.)
01287 33: same as 3 except logarithmic x and y tick marks. (The x
01288 and y data have to be converted to logarithms separately.)
01289 40: same as 0 except date / time x labels.
01290 41: same as 1 except date / time x labels.
01291 42: same as 2 except date / time x labels.
01292 43: same as 3 except date / time x labels.
01293 50: same as 0 except date / time y labels.
01294 51: same as 1 except date / time y labels.
01295 52: same as 2 except date / time y labels.
01296 53: same as 3 except date / time y labels.
01297 60: same as 0 except date / time x and y labels.
01298 61: same as 1 except date / time x and y labels.
01299 62: same as 2 except date / time x and y labels.
01300 63: same as 3 except date / time x and y labels.
01301 70: same as 0 except custom x and y labels.
01302 71: same as 1 except custom x and y labels.
01303 72: same as 2 except custom x and y labels.
01304 73: same as 3 except custom x and y labels.
01305
01306 """
01307 return _plplotc.plenv0(*args)
01308
01309 def pleop():
01310 """
01311 Eject current page
01312
01313 DESCRIPTION:
01314
01315 Clears the graphics screen of an interactive device, or ejects a page
01316 on a plotter. See plbop for more information.
01317
01318 Redacted form: pleop()
01319
01320 This function is used in example 2,14.
01321
01322
01323
01324 SYNOPSIS:
01325
01326 pleop()
01327
01328 """
01329 return _plplotc.pleop()
01330
01331 def plerrx(*args):
01332 """
01333 Draw x error bar
01334
01335 DESCRIPTION:
01336
01337 Draws a set of n horizontal error bars, the i'th error bar extending
01338 from xmin[i] to xmax[i] at y coordinate y[i]. The terminals of the
01339 error bar are of length equal to the minor tick length (settable using
01340 plsmin).
01341
01342 Redacted form: General: plerrx(xmin, ymax, y)
01343 Perl/PDL: plerrx(n, xmin, xmax, y)
01344
01345
01346 This function is used in example 29.
01347
01348
01349
01350 SYNOPSIS:
01351
01352 plerrx(n, xmin, xmax, y)
01353
01354 ARGUMENTS:
01355
01356 n (PLINT, input) : Number of error bars to draw.
01357
01358 xmin (PLFLT *, input) : Pointer to array with x coordinates of
01359 left-hand endpoint of error bars.
01360
01361 xmax (PLFLT *, input) : Pointer to array with x coordinates of
01362 right-hand endpoint of error bars.
01363
01364 y (PLFLT *, input) : Pointer to array with y coordinates of error
01365 bar.
01366
01367 """
01368 return _plplotc.plerrx(*args)
01369
01370 def plerry(*args):
01371 """
01372 Draw y error bar
01373
01374 DESCRIPTION:
01375
01376 Draws a set of n vertical error bars, the i'th error bar extending
01377 from ymin[i] to ymax[i] at x coordinate x[i]. The terminals of the
01378 error bar are of length equal to the minor tick length (settable using
01379 plsmin).
01380
01381 Redacted form: General: plerry(x, ymin, ymax)
01382 Perl/PDL: plerry(n, x, ymin, ymax)
01383
01384
01385 This function is used in example 29.
01386
01387
01388
01389 SYNOPSIS:
01390
01391 plerry(n, x, ymin, ymax)
01392
01393 ARGUMENTS:
01394
01395 n (PLINT, input) : Number of error bars to draw.
01396
01397 x (PLFLT *, input) : Pointer to array with x coordinates of error
01398 bars.
01399
01400 ymin (PLFLT *, input) : Pointer to array with y coordinates of
01401 lower endpoint of error bars.
01402
01403 ymax (PLFLT *, input) : Pointer to array with y coordinate of upper
01404 endpoint of error bar.
01405
01406 """
01407 return _plplotc.plerry(*args)
01408
01409 def plfamadv():
01410 """
01411 Advance to the next family file on the next new page
01412
01413 DESCRIPTION:
01414
01415 Advance to the next family file on the next new page.
01416
01417 Redacted form: plfamadv()
01418
01419 This function is not used in any examples.
01420
01421
01422
01423 SYNOPSIS:
01424
01425 plfamadv()
01426
01427 """
01428 return _plplotc.plfamadv()
01429
01430 def plfill(*args):
01431 """
01432 Draw filled polygon
01433
01434 DESCRIPTION:
01435
01436 Fills the polygon defined by the n points (
01437 x[i],
01438 y[i]) using the pattern defined by plpsty or plpat. The routine will
01439 automatically close the polygon between the last and first vertices.
01440 If multiple closed polygons are passed in x and y then plfill will
01441 fill in between them.
01442
01443 Redacted form: plfill(x,y)
01444
01445 This function is used in examples 12,13,15,16,21,24,25.
01446
01447
01448
01449 SYNOPSIS:
01450
01451 plfill(n, x, y)
01452
01453 ARGUMENTS:
01454
01455 n (PLINT, input) : Number of vertices in polygon.
01456
01457 x (PLFLT *, input) : Pointer to array with x coordinates of
01458 vertices.
01459
01460 y (PLFLT *, input) : Pointer to array with y coordinates of
01461 vertices.
01462
01463 """
01464 return _plplotc.plfill(*args)
01465
01466 def plfill3(*args):
01467 """
01468 Draw filled polygon in 3D
01469
01470 DESCRIPTION:
01471
01472 Fills the 3D polygon defined by the n points in the x, y, and z arrays
01473 using the pattern defined by plpsty or plpat. The routine will
01474 automatically close the polygon between the last and first vertices.
01475 If multiple closed polygons are passed in x, y, and z then plfill3
01476 will fill in between them.
01477
01478 Redacted form: General: plfill3(x, y, z)
01479 Perl/PDL: plfill3(n, x, y, z)
01480
01481
01482 This function is used in example 15.
01483
01484
01485
01486 SYNOPSIS:
01487
01488 plfill3(n, x, y, z)
01489
01490 ARGUMENTS:
01491
01492 n (PLINT, input) : Number of vertices in polygon.
01493
01494 x (PLFLT *, input) : Pointer to array with x coordinates of
01495 vertices.
01496
01497 y (PLFLT *, input) : Pointer to array with y coordinates of
01498 vertices.
01499
01500 z (PLFLT *, input) : Pointer to array with z coordinates of
01501 vertices.
01502
01503 """
01504 return _plplotc.plfill3(*args)
01505
01506 def plgradient(*args):
01507 """
01508 Draw linear gradient inside polygon
01509
01510 DESCRIPTION:
01511
01512 Draw a linear gradient using colour map 1 inside the polygon defined
01513 by the n points (
01514 x[i],
01515 y[i]). Interpretation of the polygon is the same as for plfill. The
01516 polygon coordinates and the gradient angle are all expressed in world
01517 coordinates. The angle from the x axis for both the rotated
01518 coordinate system and the gradient vector is specified by angle. The
01519 magnitude of the gradient vector is the difference between the maximum
01520 and minimum values of x for the vertices in the rotated coordinate
01521 system. The origin of the gradient vector can be interpreted as being
01522 anywhere on the line corresponding to the minimum x value for the
01523 vertices in the rotated coordinate system. The distance along the
01524 gradient vector is linearly transformed to the independent variable of
01525 colour map 1 which ranges from 0. at the tail of the gradient vector
01526 to 1. at the head of the gradient vector. What is drawn is the RGBA
01527 colour corresponding to the independent variable of colour map 1. For
01528 more information about colour map 1 (see the PLplot documentation).
01529
01530 Redacted form: plgradient(x,y,angle)
01531
01532 This function is used in examples 25,30.
01533
01534
01535
01536 SYNOPSIS:
01537
01538 plgradient(n, x, y, angle)
01539
01540 ARGUMENTS:
01541
01542 n (PLINT, input) : Number of vertices in polygon.
01543
01544 x (PLFLT *, input) : Pointer to array with x coordinates of
01545 vertices.
01546
01547 y (PLFLT *, input) : Pointer to array with y coordinates of
01548 vertices.
01549
01550 angle (PLFLT, input) : Angle (degrees) of gradient vector from x
01551 axis.
01552
01553 """
01554 return _plplotc.plgradient(*args)
01555
01556 def plflush():
01557 """
01558 Flushes the output stream
01559
01560 DESCRIPTION:
01561
01562 Flushes the output stream. Use sparingly, if at all.
01563
01564 Redacted form: plflush()
01565
01566 This function is used in examples 1,14.
01567
01568
01569
01570 SYNOPSIS:
01571
01572 plflush()
01573
01574 """
01575 return _plplotc.plflush()
01576
01577 def plfont(*args):
01578 """
01579 Set character font
01580
01581 DESCRIPTION:
01582
01583 Sets the default character font for subsequent character drawing. Also
01584 affects symbols produced by plpoin. This routine has no effect unless
01585 the extended character set is loaded (see plfontld).
01586
01587 Redacted form: plfont(font)
01588
01589 This function is used in examples 1,2,4,7,13,24,26.
01590
01591
01592
01593 SYNOPSIS:
01594
01595 plfont(font)
01596
01597 ARGUMENTS:
01598
01599 font (PLINT, input) : Specifies the font: 1: Normal font (simplest
01600 and fastest)
01601 2: Roman font
01602 3: Italic font
01603 4: Script font
01604
01605 """
01606 return _plplotc.plfont(*args)
01607
01608 def plfontld(*args):
01609 """
01610 Load character font
01611
01612 DESCRIPTION:
01613
01614 Sets the character set to use for subsequent character drawing. May
01615 be called before initializing PLplot.
01616
01617 Redacted form: plfontld(set)
01618
01619 This function is used in examples 1,7.
01620
01621
01622
01623 SYNOPSIS:
01624
01625 plfontld(set)
01626
01627 ARGUMENTS:
01628
01629 set (PLINT, input) : Specifies the character set to load: 0:
01630 Standard character set
01631 1: Extended character set
01632
01633 """
01634 return _plplotc.plfontld(*args)
01635
01636 def plgchr():
01637 """
01638 Get character default height and current (scaled) height
01639
01640 DESCRIPTION:
01641
01642 Get character default height and current (scaled) height.
01643
01644 Redacted form: plgchr(p_def, p_ht)
01645
01646 This function is used in example 23.
01647
01648
01649
01650 SYNOPSIS:
01651
01652 plgchr(p_def, p_ht)
01653
01654 ARGUMENTS:
01655
01656 p_def (PLFLT *, output) : Pointer to default character height (mm).
01657
01658 p_ht (PLFLT *, output) : Pointer to current (scaled) character
01659 height (mm).
01660
01661 """
01662 return _plplotc.plgchr()
01663
01664 def plgcol0(*args):
01665 """
01666 Returns 8-bit RGB values for given color from color map0
01667
01668 DESCRIPTION:
01669
01670 Returns 8-bit RGB values (0-255) for given color from color map0 (see
01671 the PLplot documentation). Values are negative if an invalid color id
01672 is given.
01673
01674 Redacted form: plgcol0(icol0, r, g, b)
01675
01676 This function is used in example 2.
01677
01678
01679
01680 SYNOPSIS:
01681
01682 plgcol0(icol0, r, g, b)
01683
01684 ARGUMENTS:
01685
01686 icol0 (PLINT, input) : Index of desired cmap0 color.
01687
01688 r (PLINT *, output) : Pointer to 8-bit red value.
01689
01690 g (PLINT *, output) : Pointer to 8-bit green value.
01691
01692 b (PLINT *, output) : Pointer to 8-bit blue value.
01693
01694 """
01695 return _plplotc.plgcol0(*args)
01696
01697 def plgcol0a(*args):
01698 """
01699 Returns 8-bit RGB values and double alpha value for given color from color map0.
01700
01701 DESCRIPTION:
01702
01703 Returns 8-bit RGB values (0-255) and double alpha value (0.0 - 1.0)
01704 for given color from color map0 (see the PLplot documentation).
01705 Values are negative if an invalid color id is given.
01706
01707 This function is used in example 30.
01708
01709
01710
01711 SYNOPSIS:
01712
01713 plgcol0a(icol0, r, g, b, a)
01714
01715 ARGUMENTS:
01716
01717 icol0 (PLINT, input) : Index of desired cmap0 color.
01718
01719 r (PLINT *, output) : Pointer to 8-bit red value.
01720
01721 g (PLINT *, output) : Pointer to 8-bit green value.
01722
01723 b (PLINT *, output) : Pointer to 8-bit blue value.
01724
01725 a (PLFLT *, output) : Pointer to PLFLT alpha value.
01726
01727 """
01728 return _plplotc.plgcol0a(*args)
01729
01730 def plgcolbg():
01731 """
01732 Returns the background color (cmap0[0]) by 8-bit RGB value
01733
01734 ESCRIPTION:
01735
01736 Returns the background color (cmap0[0]) by 8-bit RGB value.
01737
01738 Redacted form: plgcolbg(r, g, b)
01739
01740 This function is used in example 31.
01741
01742
01743
01744 YNOPSIS:
01745
01746 lgcolbg(r, g, b)
01747
01748 RGUMENTS:
01749
01750 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01751 representing the degree of red in the color.
01752
01753 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01754 representing the degree of green in the color.
01755
01756 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01757 representing the degree of blue in the color.
01758
01759 """
01760 return _plplotc.plgcolbg()
01761
01762 def plgcolbga():
01763 """
01764 Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha value.
01765
01766 ESCRIPTION:
01767
01768 Returns the background color (cmap0[0]) by 8-bit RGB value and double
01769 alpha value.
01770
01771 This function is used in example 31.
01772
01773
01774
01775 YNOPSIS:
01776
01777 lgcolbga(r, g, b, a)
01778
01779 RGUMENTS:
01780
01781 r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01782 representing the degree of red in the color.
01783
01784 g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01785 representing the degree of green in the color.
01786
01787 b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255)
01788 representing the degree of blue in the color.
01789
01790 a (PLFLT *, output) : Pointer to PLFLT alpha value.
01791
01792 """
01793 return _plplotc.plgcolbga()
01794
01795 def plgcompression():
01796 """
01797 Get the current device-compression setting
01798
01799 DESCRIPTION:
01800
01801 Get the current device-compression setting. This parameter is only
01802 used for drivers that provide compression.
01803
01804 Redacted form: plgcompression(compression)
01805
01806 This function is used in example 31.
01807
01808
01809
01810 SYNOPSIS:
01811
01812 plgcompression(compression)
01813
01814 ARGUMENTS:
01815
01816 compression (PLINT *, output) : Pointer to a variable to be filled
01817 with the current device-compression setting.
01818
01819 """
01820 return _plplotc.plgcompression()
01821
01822 def plgdev():
01823 """
01824 Get the current device (keyword) name
01825
01826 DESCRIPTION:
01827
01828 Get the current device (keyword) name. Note: you must have allocated
01829 space for this (80 characters is safe).
01830
01831 Redacted form: plgdev(p_dev)
01832
01833 This function is used in example 14.
01834
01835
01836
01837 SYNOPSIS:
01838
01839 plgdev(p_dev)
01840
01841 ARGUMENTS:
01842
01843 p_dev (char *, output) : Pointer to device (keyword) name string.
01844
01845 """
01846 return _plplotc.plgdev()
01847
01848 def plgdidev():
01849 """
01850 Get parameters that define current device-space window
01851
01852 DESCRIPTION:
01853
01854 Get relative margin width, aspect ratio, and relative justification
01855 that define current device-space window. If plsdidev has not been
01856 called the default values pointed to by p_mar, p_aspect, p_jx, and
01857 p_jy will all be 0.
01858
01859 Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy)
01860
01861 This function is used in example 31.
01862
01863
01864
01865 SYNOPSIS:
01866
01867 plgdidev(p_mar, p_aspect, p_jx, p_jy)
01868
01869 ARGUMENTS:
01870
01871 p_mar (PLFLT *, output) : Pointer to relative margin width.
01872
01873 p_aspect (PLFLT *, output) : Pointer to aspect ratio.
01874
01875 p_jx (PLFLT *, output) : Pointer to relative justification in x.
01876
01877 p_jy (PLFLT *, output) : Pointer to relative justification in y.
01878
01879 """
01880 return _plplotc.plgdidev()
01881
01882 def plgdiori():
01883 """
01884 Get plot orientation
01885
01886 DESCRIPTION:
01887
01888 Get plot orientation parameter which is multiplied by 90 degrees to
01889 obtain the angle of rotation. Note, arbitrary rotation parameters
01890 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
01891 values for the rotation parameter are 0., 1., 2., and 3. corresponding
01892 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
01893 (seascape mode), and 270 degrees (upside-down mode). If plsdiori has
01894 not been called the default value pointed to by p_rot will be 0.
01895
01896 Redacted form: plgdiori(p_rot)
01897
01898 This function is not used in any examples.
01899
01900
01901
01902 SYNOPSIS:
01903
01904 plgdiori(p_rot)
01905
01906 ARGUMENTS:
01907
01908 p_rot (PLFLT *, output) : Pointer to orientation parameter.
01909
01910 """
01911 return _plplotc.plgdiori()
01912
01913 def plgdiplt():
01914 """
01915 Get parameters that define current plot-space window
01916
01917 DESCRIPTION:
01918
01919 Get relative minima and maxima that define current plot-space window.
01920 If plsdiplt has not been called the default values pointed to by
01921 p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1.
01922
01923 Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
01924
01925 This function is used in example 31.
01926
01927
01928
01929 SYNOPSIS:
01930
01931 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
01932
01933 ARGUMENTS:
01934
01935 p_xmin (PLFLT *, output) : Pointer to relative minimum in x.
01936
01937 p_ymin (PLFLT *, output) : Pointer to relative minimum in y.
01938
01939 p_xmax (PLFLT *, output) : Pointer to relative maximum in x.
01940
01941 p_ymax (PLFLT *, output) : Pointer to relative maximum in y.
01942
01943 """
01944 return _plplotc.plgdiplt()
01945
01946 def plgfam():
01947 """
01948 Get family file parameters
01949
01950 DESCRIPTION:
01951
01952 Gets information about current family file, if familying is enabled.
01953 See the PLplot documentation for more information.
01954
01955 Redacted form: plgfam(fam, num, bmax)
01956
01957 This function is used in examples 14,31.
01958
01959
01960
01961 SYNOPSIS:
01962
01963 plgfam(fam, num, bmax)
01964
01965 ARGUMENTS:
01966
01967 fam (PLINT *, output) : Pointer to variable with the Boolean family
01968 flag value. If nonzero, familying is enabled.
01969
01970 num (PLINT *, output) : Pointer to variable with the current family
01971 file number.
01972
01973 bmax (PLINT *, output) : Pointer to variable with the maximum file
01974 size (in bytes) for a family file.
01975
01976 """
01977 return _plplotc.plgfam()
01978
01979 def plgfci():
01980 """
01981 Get FCI (font characterization integer)
01982
01983 DESCRIPTION:
01984
01985 Gets information about the current font using the FCI approach. See
01986 the PLplot documentation for more information.
01987
01988 Redacted form: plgfci(fci)
01989
01990 This function is used in example 23.
01991
01992
01993
01994 SYNOPSIS:
01995
01996 plgfci(fci)
01997
01998 ARGUMENTS:
01999
02000 fci (PLUNICODE *, output) : Pointer to PLUNICODE (unsigned 32-bit
02001 integer) variable which is updated with current FCI value.
02002
02003 """
02004 return _plplotc.plgfci()
02005
02006 def plgfnam():
02007 """
02008 Get output file name
02009
02010 DESCRIPTION:
02011
02012 Gets the current output file name, if applicable.
02013
02014 Redacted form: plgfnam(fnam)
02015
02016 This function is used in example 31.
02017
02018
02019
02020 SYNOPSIS:
02021
02022 plgfnam(fnam)
02023
02024 ARGUMENTS:
02025
02026 fnam (char *, output) : Pointer to file name string (a preallocated
02027 string of 80 characters or more).
02028
02029 """
02030 return _plplotc.plgfnam()
02031
02032 def plgfont():
02033 """
02034 Get family, style and weight of the current font
02035
02036 DESCRIPTION:
02037
02038 Gets information about current font. See the PLplot documentation for
02039 more information on font selection.
02040
02041 Redacted form: plgfont(p_family, p_style, p_weight)
02042
02043 This function is used in example 23.
02044
02045
02046
02047 SYNOPSIS:
02048
02049 plgfont(p_family, p_style, p_weight)
02050
02051 ARGUMENTS:
02052
02053 p_family (PLINT *, output) : Pointer to variable with the current
02054 font family. The available values are given by the PL_FCI_*
02055 constants in plplot.h. Current options are PL_FCI_SANS,
02056 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If
02057 p_family is NULL then the font family is not returned.
02058
02059 p_style (PLINT *, output) : Pointer to variable with the current
02060 font style. The available values are given by the PL_FCI_*
02061 constants in plplot.h. Current options are PL_FCI_UPRIGHT,
02062 PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the
02063 font style is not returned.
02064
02065 p_weight (PLINT *, output) : Pointer to variable with the current
02066 font weight. The available values are given by the PL_FCI_*
02067 constants in plplot.h. Current options are PL_FCI_MEDIUM and
02068 PL_FCI_BOLD. If p_weight is NULL then the font weight is not
02069 returned.
02070
02071 """
02072 return _plplotc.plgfont()
02073
02074 def plglevel():
02075 """
02076 Get the (current) run level
02077
02078 DESCRIPTION:
02079
02080 Get the (current) run level. Valid settings are: 0, uninitialized
02081 1, initialized
02082 2, viewport defined
02083 3, world coordinates defined
02084
02085
02086 Redacted form: plglevel(p_level)
02087
02088 This function is used in example 31.
02089
02090
02091
02092 SYNOPSIS:
02093
02094 plglevel(p_level)
02095
02096 ARGUMENTS:
02097
02098 p_level (PLINT *, output) : Pointer to the run level.
02099
02100 """
02101 return _plplotc.plglevel()
02102
02103 def plgpage():
02104 """
02105 Get page parameters
02106
02107 DESCRIPTION:
02108
02109 Gets the current page configuration. The length and offset values are
02110 expressed in units that are specific to the current driver. For
02111 instance: screen drivers will usually interpret them as number of
02112 pixels, whereas printer drivers will usually use mm.
02113
02114 Redacted form: plgpage(xp, yp, xleng, yleng, xoff, yoff)
02115
02116 This function is used in example 31.
02117
02118
02119
02120 SYNOPSIS:
02121
02122 plgpage(xp, yp, xleng, yleng, xoff, yoff)
02123
02124 ARGUMENTS:
02125
02126 xp (PLFLT *, output) : Pointer to number of pixels/inch (DPI), x.
02127
02128 yp (PLFLT *, output) : Pointer to number of pixels/inch (DPI) in y.
02129
02130 xleng (PLINT *, output) : Pointer to x page length value.
02131
02132 yleng (PLINT *, output) : Pointer to y page length value.
02133
02134 xoff (PLINT *, output) : Pointer to x page offset.
02135
02136 yoff (PLINT *, output) : Pointer to y page offset.
02137
02138 """
02139 return _plplotc.plgpage()
02140
02141 def plgra():
02142 """
02143 Switch to graphics screen
02144
02145 DESCRIPTION:
02146
02147 Sets an interactive device to graphics mode, used in conjunction with
02148 pltext to allow graphics and text to be interspersed. On a device
02149 which supports separate text and graphics windows, this command causes
02150 control to be switched to the graphics window. If already in graphics
02151 mode, this command is ignored. It is also ignored on devices which
02152 only support a single window or use a different method for shifting
02153 focus. See also pltext.
02154
02155 Redacted form: plgra()
02156
02157 This function is used in example 1.
02158
02159
02160
02161 SYNOPSIS:
02162
02163 plgra()
02164
02165 """
02166 return _plplotc.plgra()
02167
02168 def plgriddata(*args):
02169 """
02170 Grid data from irregularly sampled data
02171
02172 DESCRIPTION:
02173
02174 Real world data is frequently irregularly sampled, but all PLplot 3D
02175 plots require data placed in a uniform grid. This function takes
02176 irregularly sampled data from three input arrays x[npts], y[npts], and
02177 z[npts], reads the desired grid location from input arrays xg[nptsx]
02178 and yg[nptsy], and returns the gridded data into output array
02179 zg[nptsx][nptsy]. The algorithm used to grid the data is specified
02180 with the argument type which can have one parameter specified in
02181 argument data.
02182
02183 Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data)
02184 Perl/PDL: Not available?
02185
02186
02187 This function is used in example 21.
02188
02189
02190
02191 SYNOPSIS:
02192
02193 plggriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
02194
02195 ARGUMENTS:
02196
02197 x (PLFLT *, input) : The input x array.
02198
02199 y (PLFLT *, input) : The input y array.
02200
02201 z (PLFLT *, input) : The input z array. Each triple x[i], y[i],
02202 z[i] represents one data sample coordinate.
02203
02204 npts (PLINT, input) : The number of data samples in the x, y and z
02205 arrays.
02206
02207 xg (PLFLT *, input) : The input array that specifies the grid
02208 spacing in the x direction. Usually xg has nptsx equally spaced
02209 values from the minimum to the maximum values of the x input
02210 array.
02211
02212 nptsx (PLINT, input) : The number of points in the xg array.
02213
02214 yg (PLFLT *, input) : The input array that specifies the grid
02215 spacing in the y direction. Similar to the xg parameter.
02216
02217 nptsy (PLINT, input) : The number of points in the yg array.
02218
02219 zg (PLFLT **, output) : The output array, where data lies in the
02220 regular grid specified by xg and yg. the zg array must exist or be
02221 allocated by the user prior to the call, and must have dimension
02222 zg[nptsx][nptsy].
02223
02224 type (PLINT, input) : The type of gridding algorithm to use, which
02225 can be: GRID_CSA: Bivariate Cubic Spline approximation
02226 GRID_DTLI: Delaunay Triangulation Linear Interpolation
02227 GRID_NNI: Natural Neighbors Interpolation
02228 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
02229 GRID_NNLI: Nearest Neighbors Linear Interpolation
02230 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
02231 Weighted
02232 For details of the algorithms read the source file plgridd.c.
02233
02234 data (PLFLT, input) : Some gridding algorithms require extra data,
02235 which can be specified through this argument. Currently, for
02236 algorithm: GRID_NNIDW, data specifies the number of neighbors to
02237 use, the lower the value, the noisier (more local) the
02238 approximation is.
02239 GRID_NNLI, data specifies what a thin triangle is, in the
02240 range [1. .. 2.]. High values enable the usage of very thin
02241 triangles for interpolation, possibly resulting in error in
02242 the approximation.
02243 GRID_NNI, only weights greater than data will be accepted. If
02244 0, all weights will be accepted.
02245
02246 """
02247 return _plplotc.plgriddata(*args)
02248
02249 def plgspa():
02250 """
02251 Get current subpage parameters
02252
02253 DESCRIPTION:
02254
02255 Gets the size of the current subpage in millimeters measured from the
02256 bottom left hand corner of the output device page or screen. Can be
02257 used in conjunction with plsvpa for setting the size of a viewport in
02258 absolute coordinates (millimeters).
02259
02260 Redacted form: plgspa(xmin, xmax, ymin, ymax)
02261
02262 This function is used in example 23.
02263
02264
02265
02266 SYNOPSIS:
02267
02268 plgspa(xmin, xmax, ymin, ymax)
02269
02270 ARGUMENTS:
02271
02272 xmin (PLFLT *, output) : Pointer to variable with position of left
02273 hand edge of subpage in millimeters.
02274
02275 xmax (PLFLT *, output) : Pointer to variable with position of right
02276 hand edge of subpage in millimeters.
02277
02278 ymin (PLFLT *, output) : Pointer to variable with position of
02279 bottom edge of subpage in millimeters.
02280
02281 ymax (PLFLT *, output) : Pointer to variable with position of top
02282 edge of subpage in millimeters.
02283
02284 """
02285 return _plplotc.plgspa()
02286
02287 def plgstrm():
02288 """
02289 Get current stream number
02290
02291 DESCRIPTION:
02292
02293 Gets the number of the current output stream. See also plsstrm.
02294
02295 Redacted form: plgstrm(strm)
02296
02297 This function is used in example 1,20.
02298
02299
02300
02301 SYNOPSIS:
02302
02303 plgstrm(strm)
02304
02305 ARGUMENTS:
02306
02307 strm (PLINT *, output) : Pointer to current stream value.
02308
02309 """
02310 return _plplotc.plgstrm()
02311
02312 def plgver():
02313 """
02314 Get the current library version number
02315
02316 DESCRIPTION:
02317
02318 Get the current library version number. Note: you must have allocated
02319 space for this (80 characters is safe).
02320
02321 Redacted form: plgver(p_ver)
02322
02323 This function is used in example 1.
02324
02325
02326
02327 SYNOPSIS:
02328
02329 plgver(p_ver)
02330
02331 ARGUMENTS:
02332
02333 p_ver (char *, output) : Pointer to the current library version
02334 number.
02335
02336 """
02337 return _plplotc.plgver()
02338
02339 def plgvpd():
02340 """
02341 Get viewport limits in normalized device coordinates
02342
02343 DESCRIPTION:
02344
02345 Get viewport limits in normalized device coordinates.
02346
02347 Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
02348 Perl/PDL: Not available?
02349
02350
02351 This function is used in example 31.
02352
02353
02354
02355 SYNOPSIS:
02356
02357 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
02358
02359 ARGUMENTS:
02360
02361 p_xmin (PLFLT *, output) : Lower viewport limit of the normalized
02362 device coordinate in x.
02363
02364 p_xmax (PLFLT *, output) : Upper viewport limit of the normalized
02365 device coordinate in x.
02366
02367 p_ymin (PLFLT *, output) : Lower viewport limit of the normalized
02368 device coordinate in y.
02369
02370 p_ymax (PLFLT *, output) : Upper viewport limit of the normalized
02371 device coordinate in y.
02372
02373 """
02374 return _plplotc.plgvpd()
02375
02376 def plgvpw():
02377 """
02378 Get viewport limits in world coordinates
02379
02380 DESCRIPTION:
02381
02382 Get viewport limits in world coordinates.
02383
02384 Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
02385 Perl/PDL: Not available?
02386
02387
02388 This function is used in example 31.
02389
02390
02391
02392 SYNOPSIS:
02393
02394 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
02395
02396 ARGUMENTS:
02397
02398 p_xmin (PLFLT *, output) : Lower viewport limit of the world
02399 coordinate in x.
02400
02401 p_xmax (PLFLT *, output) : Upper viewport limit of the world
02402 coordinate in x.
02403
02404 p_ymin (PLFLT *, output) : Lower viewport limit of the world
02405 coordinate in y.
02406
02407 p_ymax (PLFLT *, output) : Upper viewport limit of the world
02408 coordinate in y.
02409
02410 """
02411 return _plplotc.plgvpw()
02412
02413 def plgxax():
02414 """
02415 Get x axis parameters
02416
02417 DESCRIPTION:
02418
02419 Returns current values of the digmax and digits flags for the x axis.
02420 digits is updated after the plot is drawn, so this routine should only
02421 be called after the call to plbox (or plbox3) is complete. See the
02422 PLplot documentation for more information.
02423
02424 Redacted form: plgxax(digmax, digits)
02425
02426 This function is used in example 31.
02427
02428
02429
02430 SYNOPSIS:
02431
02432 plgxax(digmax, digits)
02433
02434 ARGUMENTS:
02435
02436 digmax (PLINT *, output) : Pointer to variable with the maximum
02437 number of digits for the x axis. If nonzero, the printed label
02438 has been switched to a floating point representation when the
02439 number of digits exceeds digmax.
02440
02441 digits (PLINT *, output) : Pointer to variable with the actual
02442 number of digits for the numeric labels (x axis) from the last
02443 plot.
02444
02445 """
02446 return _plplotc.plgxax()
02447
02448 def plgyax():
02449 """
02450 Get y axis parameters
02451
02452 DESCRIPTION:
02453
02454 Identical to plgxax, except that arguments are flags for y axis. See
02455 the description of plgxax for more detail.
02456
02457 Redacted form: plgyax(digmax, digits)
02458
02459 This function is used in example 31.
02460
02461
02462
02463 SYNOPSIS:
02464
02465 plgyax(digmax, digits)
02466
02467 ARGUMENTS:
02468
02469 digmax (PLINT *, output) : Pointer to variable with the maximum
02470 number of digits for the y axis. If nonzero, the printed label
02471 has been switched to a floating point representation when the
02472 number of digits exceeds digmax.
02473
02474 digits (PLINT *, output) : Pointer to variable with the actual
02475 number of digits for the numeric labels (y axis) from the last
02476 plot.
02477
02478 """
02479 return _plplotc.plgyax()
02480
02481 def plgzax():
02482 """
02483 Get z axis parameters
02484
02485 DESCRIPTION:
02486
02487 Identical to plgxax, except that arguments are flags for z axis. See
02488 the description of plgxax for more detail.
02489
02490 Redacted form: plgzax(digmax, digits)
02491
02492 This function is used in example 31.
02493
02494
02495
02496 SYNOPSIS:
02497
02498 plgzax(digmax, digits)
02499
02500 ARGUMENTS:
02501
02502 digmax (PLINT *, output) : Pointer to variable with the maximum
02503 number of digits for the z axis. If nonzero, the printed label
02504 has been switched to a floating point representation when the
02505 number of digits exceeds digmax.
02506
02507 digits (PLINT *, output) : Pointer to variable with the actual
02508 number of digits for the numeric labels (z axis) from the last
02509 plot.
02510
02511 """
02512 return _plplotc.plgzax()
02513
02514 def plhist(*args):
02515 """
02516 Plot a histogram from unbinned data
02517
02518 DESCRIPTION:
02519
02520 Plots a histogram from n data points stored in the array data. This
02521 routine bins the data into nbin bins equally spaced between datmin and
02522 datmax, and calls plbin to draw the resulting histogram. Parameter
02523 opt allows, among other things, the histogram either to be plotted in
02524 an existing window or causes plhist to call plenv with suitable limits
02525 before plotting the histogram.
02526
02527 Redacted form: plhist(data, datmin, datmax, nbin, opt)
02528
02529 This function is used in example 5.
02530
02531
02532
02533 SYNOPSIS:
02534
02535 plhist(n, data, datmin, datmax, nbin, opt)
02536
02537 ARGUMENTS:
02538
02539 n (PLINT, input) : Number of data points.
02540
02541 data (PLFLT *, input) : Pointer to array with values of the n data
02542 points.
02543
02544 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
02545
02546 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
02547
02548 nbin (PLINT, input) : Number of (equal-sized) bins into which to
02549 divide the interval xmin to xmax.
02550
02551 opt (PLINT, input) : Is a combination of several flags:
02552 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
02553 the histogram data, the outer bins are expanded to fill up the
02554 entire x-axis, data outside the given extremes are assigned to the
02555 outer bins and bins of zero height are simply drawn.
02556 opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled
02557 to fit the histogram data, without this flag, plenv is called
02558 to set the world coordinates.
02559 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
02560 extremes are not taken into account. This option should
02561 probably be combined with opt=PL_HIST_NOEXPAND|..., so as to
02562 properly present the data.
02563 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal
02564 size as the ones inside.
02565 opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn
02566 (there is a gap for such bins).
02567
02568 """
02569 return _plplotc.plhist(*args)
02570
02571 def plhlsrgb(*args):
02572 """
02573 Convert HLS color to RGB
02574
02575 DESCRIPTION:
02576
02577 Convert HLS color coordinates to RGB.
02578
02579 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
02580 Perl/PDL: Not available? Implemented as plhls?
02581
02582
02583 This function is used in example 2.
02584
02585
02586
02587 SYNOPSIS:
02588
02589 plhlsrgb(h, l, s, p_r, p_g, p_b)
02590
02591 ARGUMENTS:
02592
02593 h (PLFLT, input) : Hue, in degrees on the colour cone (0.0-360.0)
02594
02595 l (PLFLT, input) : Lightness, expressed as a fraction of the axis
02596 of the colour cone (0.0-1.0)
02597
02598 s (PLFLT, input) : Saturation, expressed as a fraction of the
02599 radius of the colour cone (0.0-1.0)
02600
02601 p_r (PLFLT *, output) : Pointer to red intensity (0.0-1.0) of the
02602 colour
02603
02604 p_g (PLFLT *, output) : Pointer to green intensity (0.0-1.0) of the
02605 colour
02606
02607 p_b (PLFLT *, output) : Pointer to blue intensity (0.0-1.0) of the
02608 colour
02609
02610 """
02611 return _plplotc.plhlsrgb(*args)
02612
02613 def plinit():
02614 """
02615 Initialize PLplot
02616
02617 DESCRIPTION:
02618
02619 Initializing the plotting package. The program prompts for the device
02620 keyword or number of the desired output device. Hitting a RETURN in
02621 response to the prompt is the same as selecting the first device.
02622 plinit will issue no prompt if either the device was specified
02623 previously (via command line flag, the plsetopt function, or the
02624 plsdev function), or if only one device is enabled when PLplot is
02625 installed. If subpages have been specified, the output device is
02626 divided into nx by ny subpages, each of which may be used
02627 independently. If plinit is called again during a program, the
02628 previously opened file will be closed. The subroutine pladv is used
02629 to advance from one subpage to the next.
02630
02631 Redacted form: plinit()
02632
02633 This function is used in all of the examples.
02634
02635
02636
02637 SYNOPSIS:
02638
02639 plinit()
02640
02641 """
02642 return _plplotc.plinit()
02643
02644 def pljoin(*args):
02645 """
02646 Draw a line between two points
02647
02648 DESCRIPTION:
02649
02650 Joins the point (
02651 x1,
02652 y1) to (
02653 x2,
02654 y2).
02655
02656 Redacted form: pljoin(x1,y1,x2,y2)
02657
02658 This function is used in examples 3,14.
02659
02660
02661
02662 SYNOPSIS:
02663
02664 pljoin(x1, y1, x2, y2)
02665
02666 ARGUMENTS:
02667
02668 x1 (PLFLT, input) : x coordinate of first point.
02669
02670 y1 (PLFLT, input) : y coordinate of first point.
02671
02672 x2 (PLFLT, input) : x coordinate of second point.
02673
02674 y2 (PLFLT, input) : y coordinate of second point.
02675
02676 """
02677 return _plplotc.pljoin(*args)
02678
02679 def pllab(*args):
02680 """
02681 Simple routine to write labels
02682
02683 DESCRIPTION:
02684
02685 Routine for writing simple labels. Use plmtex for more complex labels.
02686
02687 Redacted form: pllab(xlabel, ylabel, tlabel)
02688
02689 This function is used in examples 1,5,9,12,14-16,20-22,29.
02690
02691
02692
02693 SYNOPSIS:
02694
02695 pllab(xlabel, ylabel, tlabel)
02696
02697 ARGUMENTS:
02698
02699 xlabel (const char *, input) : Label for horizontal axis.
02700
02701 ylabel (const char *, input) : Label for vertical axis.
02702
02703 tlabel (const char *, input) : Title of graph.
02704
02705 """
02706 return _plplotc.pllab(*args)
02707
02708 def pllegend(*args):
02709 """
02710 Create a discrete annotated legend using boxes, lines, and/or lines of symbols
02711
02712 DESCRIPTION:
02713
02714 (N.B. This is an experimental API that may be subject to further
02715 change as we gain more experience with it.) Routine for creating a
02716 discrete plot legend with a plotted box, line, and/or line of symbols
02717 for each annotated legend entry. The arguments of pllegend provide
02718 control over the location and size of the legend within the current
02719 subpage as well as the location and characteristics of the elements
02720 (most of which are optional) within that legend. The resulting legend
02721 is clipped at the boundaries of the current subpage
02722
02723 Redacted form: pllegend(opt, x, y, plot_width, bg_color, opt_array,
02724 text_offset, text_scale, text_spacing, test_justification,
02725 text_colors, text, box_colors, box_patterns, box_scales, line_colors,
02726 line_styles, line_widths, symbol_colors, symbol_scales,
02727 symbol_numbers, symbols)
02728
02729 This function is used in examples 4 and 26.
02730
02731
02732
02733 SYNOPSIS:
02734
02735 pllegend(opt, x, y, plot_width, bg_color, nlegend, opt_array, text_offset, text_scale, text_spacing, test_justification, text_colors, text, box_colors, box_patterns, box_scales, line_colors, line_styles, line_widths, symbol_colors, symbol_scales, symbol_numbers, symbols)
02736
02737 ARGUMENTS:
02738
02739 opt (PLINT, input) : opt contains bits controlling the overall
02740 legend. If the
02741 PL_LEGEND_BACKGROUND bit is set, plot a (semi-transparent) background
02742 for the legend. If the
02743 PL_LEGEND_TEXT_LEFT bit is set, put the text area on the left of the
02744 legend and the plotted area on the right. Otherwise, put the text
02745 area on the right of the legend and the plotted area on the left.
02746
02747 x (PLFLT, input) : Normalized sub-page X position of the upper-left
02748 corner of the legend.
02749
02750 y (PLFLT, input) : Normalized sub-page Y position of the upper-left
02751 corner of the legend.
02752
02753 plot_width (PLFLT, input) : Horizontal width in normalized subpage
02754 units of the plot area (where the rectangular boxes, lines, and/or
02755 lines of symbols are drawn) of the legend. N.B. The total
02756 horizontal width of the legend in normalized subpage coordinates
02757 is calculated internally from
02758 plot_width,
02759 text_offset (see below), and length (calculated internally) of the
02760 longest text string.
02761
02762 bg_color (PLINT, input) : The cmap0 index of the background color
02763 for the legend (
02764 PL_LEGEND_BACKGROUND).
02765
02766 nlegend (PLINT, input) : Number of legend entries. N.B. The total
02767 vertical height of the legend in normalized subpage coordinates is
02768 calculated internally from
02769 nlegend,
02770 text_scale (see below), and
02771 text_spacing (see below).
02772
02773 opt_array (const PLINT *, input) : Array of nlegend values of
02774 options to control each individual plotted area corresponding to a
02775 legend entry. If the
02776 PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted
02777 area. If the
02778 PL_LEGEND_COLOR_BOX,
02779 PL_LEGEND_LINE, and/or
02780 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
02781 entry is plotted with a colored box; a line; and/or a line of
02782 symbols.
02783
02784 text_offset (PLFLT, input) : Offset of the text area from the plot
02785 area in units of character width. N.B. The total horizontal
02786 width of the legend in normalized subpage coordinates is
02787 calculated internally from
02788 plot_width (see above),
02789 text_offset, and length (calculated internally) of the longest text
02790 string.
02791
02792 text_scale (PLFLT, input) : Character height scale for text
02793 annotations. N.B. The total vertical height of the legend in
02794 normalized subpage coordinates is calculated internally from
02795 nlegend (see above),
02796 text_scale, and
02797 text_spacing (see below).
02798
02799 text_spacing (PLFLT, input) : Vertical spacing in units of the
02800 character height from one legend entry to the next. N.B. The
02801 total vertical height of the legend in normalized subpage
02802 coordinates is calculated internally from
02803 nlegend (see above),
02804 text_scale (see above), and
02805 text_spacing.
02806
02807 text_justification (PLFLT, input) : Justification parameter used
02808 for text justification. The most common values of
02809 text_justification are 0., 0.5, or 1. corresponding to a text that
02810 is left justified, centred, or right justified within the text
02811 area, but other values are allowed as well.
02812
02813 text_colors (const PLINT *, input) : Array of nlegend text colors
02814 (cmap0 indices).
02815
02816 text (const char **, input) : Array of nlegend text string
02817 annotations.
02818
02819 box_colors (const PLINT *, input) : Array of nlegend colors (cmap0
02820 indices) for the discrete colored boxes (
02821 PL_LEGEND_COLOR_BOX).
02822
02823 box_patterns (const PLINT *, input) : Array of nlegend patterns
02824 (plpsty indices) for the discrete colored boxes (
02825 PL_LEGEND_COLOR_BOX).
02826
02827 box_scales (const PLFLT *, input) : Array of nlegend scales (units
02828 of fraction of character height) for the height of the discrete
02829 colored boxes (
02830 PL_LEGEND_COLOR_BOX).
02831
02832 line_colors (const PLINT *, input) : Array of nlegend line colors
02833 (cmap0 indices) (
02834 PL_LEGEND_LINE).
02835
02836 line_styles (const PLINT *, input) : Array of nlegend line styles
02837 (plsty indices) (
02838 PL_LEGEND_LINE).
02839
02840 line_widths (const PLINT *, input) : Array of nlegend line widths (
02841 PL_LEGEND_LINE).
02842
02843 symbol_colors (const PLINT *, input) : Array of nlegend symbol
02844 colors (cmap0 indices) (
02845 PL_LEGEND_SYMBOL).
02846
02847 symbol_scales (const PLFLT *, input) : Array of nlegend scale
02848 values for the symbol height (
02849 PL_LEGEND_SYMBOL).
02850
02851 symbol_numbers (const PLINT *, input) : Array of nlegend numbers of
02852 symbols to be drawn across the width of the plotted area (
02853 PL_LEGEND_SYMBOL).
02854
02855 symbols (const PLINT *, input) : Array of nlegend symbols (plpoin
02856 indices) (
02857 PL_LEGEND_SYMBOL).
02858
02859 """
02860 return _plplotc.pllegend(*args)
02861
02862 def pllightsource(*args):
02863 """
02864 Sets the 3D position of the light source
02865
02866 DESCRIPTION:
02867
02868 Sets the 3D position of the light source for use with plsurf3d.
02869
02870 Redacted form: pllightsource(x, y, z)
02871
02872 This function is used in example 8.
02873
02874
02875
02876 SYNOPSIS:
02877
02878 pllightsource(x, y, z)
02879
02880 ARGUMENTS:
02881
02882 x (PLFLT, input) : X-coordinate of the light source.
02883
02884 y (PLFLT, input) : Y-coordinate of the light source.
02885
02886 z (PLFLT, input) : Z-coordinate of the light source.
02887
02888 """
02889 return _plplotc.pllightsource(*args)
02890
02891 def plline(*args):
02892 """
02893 Draw a line
02894
02895 DESCRIPTION:
02896
02897 Draws line defined by n points in x and y.
02898
02899 Redacted form: plline(x, y)
02900
02901 This function is used in examples 1,3,4,9,12-14,16,18,20,22,25-27,29.
02902
02903
02904
02905 SYNOPSIS:
02906
02907 plline(n, x, y)
02908
02909 ARGUMENTS:
02910
02911 n (PLINT, input) : Number of points defining line.
02912
02913 x (PLFLT *, input) : Pointer to array with x coordinates of points.
02914
02915 y (PLFLT *, input) : Pointer to array with y coordinates of points.
02916
02917 """
02918 return _plplotc.plline(*args)
02919
02920 def plline3(*args):
02921 """
02922 Draw a line in 3 space
02923
02924 DESCRIPTION:
02925
02926 Draws line in 3 space defined by n points in x, y, and z. You must
02927 first set up the viewport, the 2d viewing window (in world
02928 coordinates), and the 3d normalized coordinate box. See x18c.c for
02929 more info.
02930
02931 Redacted form: plline3(x, y, z)
02932
02933 This function is used in example 18.
02934
02935
02936
02937 SYNOPSIS:
02938
02939 plline3(n, x, y, z)
02940
02941 ARGUMENTS:
02942
02943 n (PLINT, input) : Number of points defining line.
02944
02945 x (PLFLT *, input) : Pointer to array with x coordinates of points.
02946
02947 y (PLFLT *, input) : Pointer to array with y coordinates of points.
02948
02949 z (PLFLT *, input) : Pointer to array with z coordinates of points.
02950
02951 """
02952 return _plplotc.plline3(*args)
02953
02954 def pllsty(*args):
02955 """
02956 Select line style
02957
02958 DESCRIPTION:
02959
02960 This sets the line style according to one of eight predefined patterns
02961 (also see plstyl).
02962
02963 Redacted form: pllsty(n)
02964
02965 This function is used in examples 9,12,22,25.
02966
02967
02968
02969 SYNOPSIS:
02970
02971 pllsty(n)
02972
02973 ARGUMENTS:
02974
02975 n (PLINT, input) : Integer value between 1 and 8. Line style 1 is a
02976 continuous line, line style 2 is a line with short dashes and
02977 gaps, line style 3 is a line with long dashes and gaps, line style
02978 4 has long dashes and short gaps and so on.
02979
02980 """
02981 return _plplotc.pllsty(*args)
02982
02983 def plmesh(*args):
02984 """
02985 Plot surface mesh
02986
02987 DESCRIPTION:
02988
02989 Plots a surface mesh within the environment set up by plw3d. The
02990 surface is defined by the two-dimensional array z[
02991 nx][
02992 ny], the point z[i][j] being the value of the function at (
02993 x[i],
02994 y[j]). Note that the points in arrays x and y do not need to be
02995 equally spaced, but must be stored in ascending order. The parameter
02996 opt controls the way in which the surface is displayed. For further
02997 details see the PLplot documentation.
02998
02999 Redacted form: plmesh(x, y, z, opt)
03000
03001 This function is used in example 11.
03002
03003
03004
03005 SYNOPSIS:
03006
03007 plmesh(x, y, z, nx, ny, opt)
03008
03009 ARGUMENTS:
03010
03011 x (PLFLT *, input) : Pointer to set of x coordinate values at which
03012 the function is evaluated.
03013
03014 y (PLFLT *, input) : Pointer to set of y coordinate values at which
03015 the function is evaluated.
03016
03017 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
03018 with set of function values.
03019
03020 nx (PLINT, input) : Number of x values at which function is
03021 evaluated.
03022
03023 ny (PLINT, input) : Number of y values at which function is
03024 evaluated.
03025
03026 opt (PLINT, input) : Determines the way in which the surface is
03027 represented: opt=DRAW_LINEX: Lines are drawn showing z as a
03028 function of x for each value of y[j].
03029 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
03030 for each value of x[i].
03031 opt=DRAW_LINEXY: Network of lines is drawn connecting points
03032 at which function is defined.
03033
03034 """
03035 return _plplotc.plmesh(*args)
03036
03037 def plmeshc(*args):
03038 """
03039 Magnitude colored plot surface mesh with contour.
03040
03041 DESCRIPTION:
03042
03043 Identical to plmesh but with extra functionalities: the surface mesh
03044 can be colored accordingly to the current z value being plotted, a
03045 contour plot can be drawn at the base XY plane, and a curtain can be
03046 drawn between the plotted function border and the base XY plane.
03047
03048 Redacted form: plmeshc(x, y, z, opt, clevel)
03049
03050 This function is used in example 11.
03051
03052
03053
03054 SYNOPSIS:
03055
03056 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
03057
03058 ARGUMENTS:
03059
03060 x (PLFLT *, input) : Pointer to set of x coordinate values at which
03061 the function is evaluated.
03062
03063 y (PLFLT *, input) : Pointer to set of y coordinate values at which
03064 the function is evaluated.
03065
03066 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
03067 with set of function values.
03068
03069 nx (PLINT, input) : Number of x values at which function is
03070 evaluated.
03071
03072 ny (PLINT, input) : Number of y values at which function is
03073 evaluated.
03074
03075 opt (PLINT, input) : Determines the way in which the surface is
03076 represented. To specify more than one option just add the options,
03077 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX: Lines are drawn
03078 showing z as a function of x for each value of y[j].
03079 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
03080 for each value of x[i].
03081 opt=DRAW_LINEXY: Network of lines is drawn connecting points
03082 at which function is defined.
03083 opt=MAG_COLOR: Each line in the mesh is colored according to
03084 the z value being plotted. The color is used from the current
03085 colormap 1.
03086 opt=BASE_CONT: A contour plot is drawn at the base XY plane
03087 using parameters
03088 nlevel and
03089 clevel.
03090 opt=DRAW_SIDES: draws a curtain between the base XY plane and
03091 the borders of the plotted function.
03092
03093
03094 clevel (PLFLT *, input) : Pointer to the array that defines the
03095 contour level spacing.
03096
03097 nlevel (PLINT, input) : Number of elements in the clevel array.
03098
03099 """
03100 return _plplotc.plmeshc(*args)
03101
03102 def plmkstrm():
03103 """
03104 Creates a new stream and makes it the default
03105
03106 DESCRIPTION:
03107
03108 Creates a new stream and makes it the default. Differs from using
03109 plsstrm, in that a free stream number is found, and returned.
03110 Unfortunately, I have to start at stream 1 and work upward, since
03111 stream 0 is preallocated. One of the big flaws in the PLplot API is
03112 that no initial, library-opening call is required. So stream 0 must
03113 be preallocated, and there is no simple way of determining whether it
03114 is already in use or not.
03115
03116 Redacted form: plmkstrm(p_strm)
03117
03118 This function is used in examples 1,20.
03119
03120
03121
03122 SYNOPSIS:
03123
03124 plmkstrm(p_strm)
03125
03126 ARGUMENTS:
03127
03128 p_strm (PLINT *, output) : Pointer to stream number of the created
03129 stream.
03130
03131 """
03132 return _plplotc.plmkstrm()
03133
03134 def plmtex(*args):
03135 """
03136 Write text relative to viewport boundaries
03137
03138 DESCRIPTION:
03139
03140 Writes text at a specified position relative to the viewport
03141 boundaries. Text may be written inside or outside the viewport, but
03142 is clipped at the subpage boundaries. The reference point of a string
03143 lies along a line passing through the string at half the height of a
03144 capital letter. The position of the reference point along this line
03145 is determined by just, and the position of the reference point
03146 relative to the viewport is set by disp and pos.
03147
03148 Redacted form: General: plmtex(side, disp, pos, just, text)
03149 Perl/PDL: plmtex(disp, pos, just, side, text)
03150
03151
03152 This function is used in examples 3,4,6-8,11,12,14,18,23,26.
03153
03154
03155
03156 SYNOPSIS:
03157
03158 plmtex(side, disp, pos, just, text)
03159
03160 ARGUMENTS:
03161
03162 side (const char *, input) : Specifies the side of the viewport
03163 along which the text is to be written. The string must be one of:
03164 b: Bottom of viewport, text written parallel to edge.
03165 bv: Bottom of viewport, text written at right angles to edge.
03166 l: Left of viewport, text written parallel to edge.
03167 lv: Left of viewport, text written at right angles to edge.
03168 r: Right of viewport, text written parallel to edge.
03169 rv: Right of viewport, text written at right angles to edge.
03170 t: Top of viewport, text written parallel to edge.
03171 tv: Top of viewport, text written at right angles to edge.
03172
03173
03174 disp (PLFLT, input) : Position of the reference point of string,
03175 measured outwards from the specified viewport edge in units of the
03176 current character height. Use negative disp to write within the
03177 viewport.
03178
03179 pos (PLFLT, input) : Position of the reference point of string
03180 along the specified edge, expressed as a fraction of the length of
03181 the edge.
03182
03183 just (PLFLT, input) : Specifies the position of the string relative
03184 to its reference point. If just=0., the reference point is at the
03185 left and if just=1., it is at the right of the string. Other
03186 values of just give intermediate justifications.
03187
03188 text (const char *, input) : The string to be written out.
03189
03190 """
03191 return _plplotc.plmtex(*args)
03192
03193 def plmtex3(*args):
03194 """
03195 Write text relative to viewport boundaries in 3D plots.
03196
03197 DESCRIPTION:
03198
03199 Writes text at a specified position relative to the viewport
03200 boundaries. Text may be written inside or outside the viewport, but
03201 is clipped at the subpage boundaries. The reference point of a string
03202 lies along a line passing through the string at half the height of a
03203 capital letter. The position of the reference point along this line
03204 is determined by just, and the position of the reference point
03205 relative to the viewport is set by disp and pos.
03206
03207 Redacted form: plmtex3(side, disp, pos, just, text)
03208
03209 This function is used in example 28.
03210
03211
03212
03213 SYNOPSIS:
03214
03215 plmtex3(side, disp, pos, just, text)
03216
03217 ARGUMENTS:
03218
03219 side (const char *, input) : Specifies the side of the viewport
03220 along which the text is to be written. The string should contain
03221 one or more of the following characters: [xyz][ps][v]. Only one
03222 label is drawn at a time, i.e. xyp will only label the X axis, not
03223 both the X and Y axes. x: Label the X axis.
03224 y: Label the Y axis.
03225 z: Label the Z axis.
03226 p: Label the primary axis. For Z this is the leftmost Z axis.
03227 For X it is the axis that starts at y-min. For Y it is the
03228 axis that starts at x-min.
03229 s: Label the secondary axis.
03230 v: Draw the text perpendicular to the axis.
03231
03232
03233 disp (PLFLT, input) : Position of the reference point of string,
03234 measured outwards from the specified viewport edge in units of the
03235 current character height. Use negative disp to write within the
03236 viewport.
03237
03238 pos (PLFLT, input) : Position of the reference point of string
03239 along the specified edge, expressed as a fraction of the length of
03240 the edge.
03241
03242 just (PLFLT, input) : Specifies the position of the string relative
03243 to its reference point. If just=0., the reference point is at the
03244 left and if just=1., it is at the right of the string. Other
03245 values of just give intermediate justifications.
03246
03247 text (const char *, input) : The string to be written out.
03248
03249 """
03250 return _plplotc.plmtex3(*args)
03251
03252 def plot3d(*args):
03253 """
03254 Plot 3-d surface plot
03255
03256 DESCRIPTION:
03257
03258 Plots a three dimensional surface plot within the environment set up
03259 by plw3d. The surface is defined by the two-dimensional array z[
03260 nx][
03261 ny], the point z[i][j] being the value of the function at (
03262 x[i],
03263 y[j]). Note that the points in arrays x and y do not need to be
03264 equally spaced, but must be stored in ascending order. The parameter
03265 opt controls the way in which the surface is displayed. For further
03266 details see the PLplot documentation. The only difference between
03267 plmesh and plot3d is that plmesh draws the bottom side of the surface,
03268 while plot3d only draws the surface as viewed from the top.
03269
03270 Redacted form: plot3d(x, y, z, opt, side)
03271
03272 This function is used in examples 11,21.
03273
03274
03275
03276 SYNOPSIS:
03277
03278 plot3d(x, y, z, nx, ny, opt, side)
03279
03280 ARGUMENTS:
03281
03282 x (PLFLT *, input) : Pointer to set of x coordinate values at which
03283 the function is evaluated.
03284
03285 y (PLFLT *, input) : Pointer to set of y coordinate values at which
03286 the function is evaluated.
03287
03288 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
03289 with set of function values.
03290
03291 nx (PLINT, input) : Number of x values at which function is
03292 evaluated.
03293
03294 ny (PLINT, input) : Number of y values at which function is
03295 evaluated.
03296
03297 opt (PLINT, input) : Determines the way in which the surface is
03298 represented: opt=DRAW_LINEX: Lines are drawn showing z as a
03299 function of x for each value of y[j].
03300 opt=DRAW_LINEY: Lines are drawn showing z as a function of y
03301 for each value of x[i].
03302 opt=DRAW_LINEXY: Network of lines is drawn connecting points
03303 at which function is defined.
03304
03305
03306 side (PLBOOL, input) : Flag to indicate whether or not ``sides''
03307 should be draw on the figure. If side is true sides are drawn,
03308 otherwise no sides are drawn.
03309
03310 """
03311 return _plplotc.plot3d(*args)
03312
03313 def plot3dc(*args):
03314 """
03315 Magnitude colored plot surface with contour.
03316
03317 DESCRIPTION:
03318
03319 Identical to plot3d but with extra functionalities: the surface mesh
03320 can be colored accordingly to the current z value being plotted, a
03321 contour plot can be drawn at the base XY plane, and a curtain can be
03322 drawn between the plotted function border and the base XY plane. The
03323 arguments are identical to plmeshc. The only difference between
03324 plmeshc and plot3dc is that plmeshc draws the bottom side of the
03325 surface, while plot3dc only draws the surface as viewed from the top.
03326
03327 Redacted form: General: plot3dc(x, y, z, opt, clevel)
03328 Perl/PDL: Not available?
03329
03330
03331 This function is used in example 21.
03332
03333
03334
03335 SYNOPSIS:
03336
03337 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
03338
03339 """
03340 return _plplotc.plot3dc(*args)
03341
03342 def plot3dcl(*args):
03343 return _plplotc.plot3dcl(*args)
03344 plot3dcl = _plplotc.plot3dcl
03345
03346 def plsurf3d(*args):
03347 """
03348 Plot shaded 3-d surface plot
03349
03350 DESCRIPTION:
03351
03352 Plots a three dimensional shaded surface plot within the environment
03353 set up by plw3d. The surface is defined by the two-dimensional array
03354 z[
03355 nx][
03356 ny], the point z[i][j] being the value of the function at (
03357 x[i],
03358 y[j]). Note that the points in arrays x and y do not need to be
03359 equally spaced, but must be stored in ascending order. For further
03360 details see the PLplot documentation.
03361
03362 Redacted form: plsurf3d(x, y, z, opt, clevel)
03363
03364 This function is not used in any examples.
03365
03366
03367
03368 SYNOPSIS:
03369
03370 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
03371
03372 ARGUMENTS:
03373
03374 x (PLFLT *, input) : Pointer to set of x coordinate values at which
03375 the function is evaluated.
03376
03377 y (PLFLT *, input) : Pointer to set of y coordinate values at which
03378 the function is evaluated.
03379
03380 z (PLFLT **, input) : Pointer to a vectored two-dimensional array
03381 with set of function values.
03382
03383 nx (PLINT, input) : Number of x values at which function is
03384 evaluated.
03385
03386 ny (PLINT, input) : Number of y values at which function is
03387 evaluated.
03388
03389 opt (PLINT, input) : Determines the way in which the surface is
03390 represented. To specify more than one option just add the options,
03391 e.g. FACETED + SURF_CONT opt=FACETED: Network of lines is drawn
03392 connecting points at which function is defined.
03393 opt=BASE_CONT: A contour plot is drawn at the base XY plane
03394 using parameters
03395 nlevel and
03396 clevel.
03397 opt=SURF_CONT: A contour plot is drawn at the surface plane
03398 using parameters
03399 nlevel and
03400 clevel.
03401 opt=DRAW_SIDES: draws a curtain between the base XY plane and
03402 the borders of the plotted function.
03403 opt=MAG_COLOR: the surface is colored according to the value
03404 of Z; if MAG_COLOR is not used, then the default the surface
03405 is colored according to the intensity of the reflected light
03406 in the surface from a light source whose position is set using
03407 pllightsource.
03408
03409
03410 clevel (PLFLT *, input) : Pointer to the array that defines the
03411 contour level spacing.
03412
03413 nlevel (PLINT, input) : Number of elements in the clevel array.
03414
03415 """
03416 return _plplotc.plsurf3d(*args)
03417
03418 def plsurf3dl(*args):
03419 return _plplotc.plsurf3dl(*args)
03420 plsurf3dl = _plplotc.plsurf3dl
03421
03422 def plparseopts(*args):
03423 """
03424 Parse command-line arguments
03425
03426 DESCRIPTION:
03427
03428 Parse command-line arguments.
03429
03430 plparseopts removes all recognized flags (decreasing argc
03431 accordingly), so that invalid input may be readily detected. It can
03432 also be used to process user command line flags. The user can merge
03433 an option table of type PLOptionTable into the internal option table
03434 info structure using plMergeOpts. Or, the user can specify that ONLY
03435 the external table(s) be parsed by calling plClearOpts before
03436 plMergeOpts.
03437
03438 The default action taken by plparseopts is as follows:
03439 Returns with an error if an unrecognized option or badly formed
03440 option-value pair are encountered.
03441 Returns immediately (return code 0) when the first non-option command
03442 line argument is found.
03443 Returns with the return code of the option handler, if one was called.
03444
03445 Deletes command line arguments from argv list as they are found, and
03446 decrements argc accordingly.
03447 Does not show "invisible" options in usage or help messages.
03448 Assumes the program name is contained in argv[0].
03449
03450
03451 These behaviors may be controlled through the
03452 mode argument.
03453
03454 Redacted form: General: plparseopts(argv, mode)
03455 Perl/PDL: Not available?
03456
03457
03458 This function is used in all of the examples.
03459
03460
03461
03462 SYNOPSIS:
03463
03464 int plparseopts(p_argc, argv, mode)
03465
03466 ARGUMENTS:
03467
03468 p_argc (int *, input) : pointer to number of arguments.
03469
03470 argv (char **, input) : Pointer to character array containing
03471 *p_argc command-line arguments.
03472
03473 mode (PLINT, input) : Parsing mode with the following
03474 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
03475 and all error messages enabled, including program exit when an
03476 error occurs. Anything on the command line that isn't recognized
03477 as a valid option or option argument is flagged as an error.
03478 PL_PARSE_QUIET (2) -- Turns off all output except in the case
03479 of errors.
03480 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
03481 arguments.
03482 PL_PARSE_SHOWALL (8) -- Show invisible options
03483 PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a
03484 pointer to the program name.
03485 PL_PARSE_NODASH (64) -- Set if leading dash is NOT required.
03486 PL_PARSE_SKIP (128) -- Set to quietly skip over any
03487 unrecognized arguments.
03488
03489 """
03490 return _plplotc.plparseopts(*args)
03491
03492 def plpat(*args):
03493 """
03494 Set area fill pattern
03495
03496 DESCRIPTION:
03497
03498 Sets the area fill pattern. The pattern consists of 1 or 2 sets of
03499 parallel lines with specified inclinations and spacings. The
03500 arguments to this routine are the number of sets to use (1 or 2)
03501 followed by two pointers to integer arrays (of 1 or 2 elements)
03502 specifying the inclinations in tenths of a degree and the spacing in
03503 micrometers. (also see plpsty)
03504
03505 Redacted form: General: plpat(inc, del)
03506 Perl/PDL: plpat(nlin, inc, del)
03507
03508
03509 This function is used in example 15.
03510
03511
03512
03513 SYNOPSIS:
03514
03515 plpat(nlin, inc, del)
03516
03517 ARGUMENTS:
03518
03519 nlin (PLINT, input) : Number of sets of lines making up the
03520 pattern, either 1 or 2.
03521
03522 inc (PLINT *, input) : Pointer to array with nlin elements.
03523 Specifies the line inclination in tenths of a degree. (Should be
03524 between -900 and 900).
03525
03526 del (PLINT *, input) : Pointer to array with nlin elements.
03527 Specifies the spacing in micrometers between the lines making up
03528 the pattern.
03529
03530 """
03531 return _plplotc.plpat(*args)
03532
03533 def plpoin(*args):
03534 """
03535 Plots a character at the specified points
03536
03537 DESCRIPTION:
03538
03539 Marks a set of n points in x and y using the symbol defined by code.
03540 If code is between 32 and 127, the symbol is simply the corresponding
03541 printable ASCII character in the default font.
03542
03543 Redacted form: plpoin(x, y, code)
03544
03545 This function is used in examples 1,6,14,18,21,29.
03546
03547
03548
03549 SYNOPSIS:
03550
03551 plpoin(n, x, y, code)
03552
03553 ARGUMENTS:
03554
03555 n (PLINT, input) : Number of points to be marked.
03556
03557 x (PLFLT *, input) : Pointer to array with x coordinates of the
03558 points.
03559
03560 y (PLFLT *, input) : Pointer to array with y coordinates of the
03561 points.
03562
03563 code (PLINT, input) : Code number for the symbol to be plotted.
03564
03565 """
03566 return _plplotc.plpoin(*args)
03567
03568 def plpoin3(*args):
03569 """
03570 Plots a character at the specified points in 3 space
03571
03572 ESCRIPTION:
03573
03574 Marks a set of n points in x, y, and z using the symbol defined by
03575 code. If code is between 32 and 127, the symbol is simply the
03576 corresponding printable ASCII character in the default font. Setup
03577 similar to plline3.
03578
03579 Redacted form: plpoin3(x, y, z, code)
03580
03581 This function is used in example 18.
03582
03583
03584
03585 YNOPSIS:
03586
03587 lpoin3(n, x, y, z, code)
03588
03589 RGUMENTS:
03590
03591 n (PLINT, input) : Number of points to be marked.
03592
03593 x (PLFLT *, input) : Pointer to array with x coordinates of the
03594 points.
03595
03596 y (PLFLT *, input) : Pointer to array with y coordinates of the
03597 points.
03598
03599 z (PLFLT *, input) : Pointer to array with z coordinates of the
03600 points.
03601
03602 code (PLINT, input) : Code number for the symbol to be plotted.
03603
03604 """
03605 return _plplotc.plpoin3(*args)
03606
03607 def plpoly3(*args):
03608 """
03609 Draw a polygon in 3 space
03610
03611 DESCRIPTION:
03612
03613 Draws a polygon in 3 space defined by n points in x, y, and z. Setup
03614 like plline3, but differs from that function in that plpoly3 attempts
03615 to determine if the polygon is viewable depending on the order of the
03616 points within the arrays and the value of ifcc. If the back of
03617 polygon is facing the viewer, then it isn't drawn. If this isn't what
03618 you want, then use plline3 instead.
03619
03620 The points are assumed to be in a plane, and the directionality of the
03621 plane is determined from the first three points. Additional points do
03622 not have to lie on the plane defined by the first three, but if they
03623 do not, then the determination of visibility obviously can't be 100%
03624 accurate... So if you're 3 space polygons are too far from planar,
03625 consider breaking them into smaller polygons. 3 points define a plane
03626 :-).
03627
03628 Bugs: If one of the first two segments is of zero length, or if they
03629 are co-linear, the calculation of visibility has a 50/50 chance of
03630 being correct. Avoid such situations :-). See x18c.c for an example
03631 of this problem. (Search for 20.1).
03632
03633 Redacted form: plpoly3(x, y, z, code)
03634
03635 This function is used in example 18.
03636
03637
03638
03639 SYNOPSIS:
03640
03641 plpoly3(n, x, y, z, draw, ifcc)
03642
03643 ARGUMENTS:
03644
03645 n (PLINT, input) : Number of points defining line.
03646
03647 x (PLFLT *, input) : Pointer to array with x coordinates of points.
03648
03649 y (PLFLT *, input) : Pointer to array with y coordinates of points.
03650
03651 z (PLFLT *, input) : Pointer to array with z coordinates of points.
03652
03653 draw (PLBOOL *, input) : Pointer to array which controls drawing
03654 the segments of the polygon. If draw[i] is true, then the polygon
03655 segment from index [i] to [i+1] is drawn, otherwise, not.
03656
03657 ifcc (PLBOOL, input) : If ifcc is true the directionality of the
03658 polygon is determined by assuming the points are laid out in a
03659 counter-clockwise order. Otherwise, the directionality of the
03660 polygon is determined by assuming the points are laid out in a
03661 clockwise order.
03662
03663 """
03664 return _plplotc.plpoly3(*args)
03665
03666 def plprec(*args):
03667 """
03668 Set precision in numeric labels
03669
03670 DESCRIPTION:
03671
03672 Sets the number of places after the decimal point in numeric labels.
03673
03674 Redacted form: plprec(set, prec)
03675
03676 This function is used in example 29.
03677
03678
03679
03680 SYNOPSIS:
03681
03682 plprec(set, prec)
03683
03684 ARGUMENTS:
03685
03686 set (PLINT, input) : If set is equal to 0 then PLplot automatically
03687 determines the number of places to use after the decimal point in
03688 numeric labels (like those used to label axes). If set is 1 then
03689 prec sets the number of places.
03690
03691 prec (PLINT, input) : The number of characters to draw after the
03692 decimal point in numeric labels.
03693
03694 """
03695 return _plplotc.plprec(*args)
03696
03697 def plpsty(*args):
03698 """
03699 Select area fill pattern
03700
03701 DESCRIPTION:
03702
03703 Select one of eight predefined area fill patterns to use (also see
03704 plpat).
03705
03706 Redacted form: plpsty(n)
03707
03708 This function is used in examples 12,13,15,16,25.
03709
03710
03711
03712 SYNOPSIS:
03713
03714 plpsty(n)
03715
03716 ARGUMENTS:
03717
03718 n (PLINT, input) : The desired pattern. Pattern 1 consists of
03719 horizontal lines, pattern 2 consists of vertical lines, pattern 3
03720 consists of lines at 45 degrees angle (upward), and so on.
03721
03722 """
03723 return _plplotc.plpsty(*args)
03724
03725 def plptex(*args):
03726 """
03727 Write text inside the viewport
03728
03729 DESCRIPTION:
03730
03731 Writes text at a specified position and inclination within the
03732 viewport. Text is clipped at the viewport boundaries. The reference
03733 point of a string lies along a line passing through the string at half
03734 the height of a capital letter. The position of the reference point
03735 along this line is determined by just, the reference point is placed
03736 at world coordinates (
03737 x,
03738 y) within the viewport. The inclination of the string is specified in
03739 terms of differences of world coordinates making it easy to write text
03740 parallel to a line in a graph.
03741
03742 Redacted form: plptex(x, y, dx, dy, just, text)
03743
03744 This function is used in example 2-4,10,12-14,20,23,24,26.
03745
03746
03747
03748 SYNOPSIS:
03749
03750 plptex(x, y, dx, dy, just, text)
03751
03752 ARGUMENTS:
03753
03754 x (PLFLT, input) : x coordinate of reference point of string.
03755
03756 y (PLFLT, input) : y coordinate of reference point of string.
03757
03758 dx (PLFLT, input) : Together with dy, this specifies the
03759 inclination of the string. The baseline of the string is parallel
03760 to a line joining (
03761 x,
03762 y) to (
03763 x+
03764 dx,
03765 y+
03766 dy).
03767
03768 dy (PLFLT, input) : Together with dx, this specifies the
03769 inclination of the string.
03770
03771 just (PLFLT, input) : Specifies the position of the string relative
03772 to its reference point. If just=0., the reference point is at the
03773 left and if just=1., it is at the right of the string. Other
03774 values of just give intermediate justifications.
03775
03776 text (const char *, input) : The string to be written out.
03777
03778 """
03779 return _plplotc.plptex(*args)
03780
03781 def plptex3(*args):
03782 """
03783 Write text inside the viewport of a 3D plot.
03784
03785 DESCRIPTION:
03786
03787 Writes text at a specified position and inclination and with a
03788 specified shear within the viewport. Text is clipped at the viewport
03789 boundaries. The reference point of a string lies along a line passing
03790 through the string at half the height of a capital letter. The
03791 position of the reference point along this line is determined by just,
03792 and the reference point is placed at world coordinates (
03793 x,
03794 y,
03795 z) within the viewport. The inclination and shear of the string is
03796 specified in terms of differences of world coordinates making it easy
03797 to write text parallel to a line in a graph.
03798
03799 Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
03800
03801 This function is used in example 28.
03802
03803
03804
03805 SYNOPSIS:
03806
03807 plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
03808
03809 ARGUMENTS:
03810
03811 x (PLFLT, input) : x coordinate of reference point of string.
03812
03813 y (PLFLT, input) : y coordinate of reference point of string.
03814
03815 z (PLFLT, input) : z coordinate of reference point of string.
03816
03817 dx (PLFLT, input) : Together with dy and
03818 dz, this specifies the inclination of the string. The baseline of
03819 the string is parallel to a line joining (
03820 x,
03821 y,
03822 z) to (
03823 x+
03824 dx,
03825 y+
03826 dy,
03827 z+
03828 dz).
03829
03830 dy (PLFLT, input) : Together with dx and
03831 dz, this specifies the inclination of the string.
03832
03833 dz (PLFLT, input) : Together with dx and
03834 dy, this specifies the inclination of the string.
03835
03836 sx (PLFLT, input) : Together with sy and
03837 sz, this specifies the shear of the string. The string is sheared so
03838 that the characters are vertically parallel to a line joining (
03839 x,
03840 y,
03841 z) to (
03842 x+
03843 sx,
03844 y+
03845 sy,
03846 z+
03847 sz). If sx =
03848 sy =
03849 sz = 0.) then the text is not sheared.
03850
03851 sy (PLFLT, input) : Together with sx and
03852 sz, this specifies shear of the string.
03853
03854 sz (PLFLT, input) : Together with sx and
03855 sy, this specifies shear of the string.
03856
03857 just (PLFLT, input) : Specifies the position of the string relative
03858 to its reference point. If just=0., the reference point is at the
03859 left and if just=1., it is at the right of the string. Other
03860 values of just give intermediate justifications.
03861
03862 text (const char *, input) : The string to be written out.
03863
03864 """
03865 return _plplotc.plptex3(*args)
03866
03867 def plrandd():
03868 """
03869 Random number generator returning a real random number in the range [0,1].
03870
03871 DESCRIPTION:
03872
03873 Random number generator returning a real random number in the range
03874 [0,1]. The generator is based on the Mersenne Twister. Most languages
03875 / compilers provide their own random number generator, and so this is
03876 provided purely for convenience and to give a consistent random number
03877 generator across all languages supported by PLplot. This is
03878 particularly useful for comparing results from the test suite of
03879 examples.
03880
03881 Redacted form: plrandd()
03882
03883 This function is used in examples 17,21.
03884
03885
03886
03887 SYNOPSIS:
03888
03889 plrandd()
03890
03891 """
03892 return _plplotc.plrandd()
03893
03894 def plreplot():
03895 """
03896 Replays contents of plot buffer to current device/file
03897
03898 DESCRIPTION:
03899
03900 Replays contents of plot buffer to current device/file.
03901
03902 Redacted form: plreplot()
03903
03904 This function is used in example 1,20.
03905
03906
03907
03908 SYNOPSIS:
03909
03910 plreplot()
03911
03912 """
03913 return _plplotc.plreplot()
03914
03915 def plrgbhls(*args):
03916 """
03917 Convert RGB color to HLS
03918
03919 DESCRIPTION:
03920
03921 Convert RGB color coordinates to HLS
03922
03923 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
03924 Perl/PDL: Not available? Implemented as plrgb/plrgb1?
03925
03926
03927 This function is used in example 2.
03928
03929
03930
03931 SYNOPSIS:
03932
03933 plrgbhls(r, g, b, p_h, p_l, p_s)
03934
03935 ARGUMENTS:
03936
03937 r (PLFLT, input) : Red intensity (0.0-1.0) of the colour
03938
03939 g (PLFLT, input) : Green intensity (0.0-1.0) of the colour
03940
03941 b (PLFLT, input) : Blue intensity (0.0-1.0) of the colour
03942
03943 p_h (PLFLT *, output) : Pointer to hue, in degrees on the colour
03944 cone (0.0-360.0)
03945
03946 p_l (PLFLT *, output) : Pointer to lightness, expressed as a
03947 fraction of the axis of the colour cone (0.0-1.0)
03948
03949 p_s (PLFLT *, output) : Pointer to saturation, expressed as a
03950 fraction of the radius of the colour cone (0.0-1.0)
03951
03952 """
03953 return _plplotc.plrgbhls(*args)
03954
03955 def plschr(*args):
03956 """
03957 Set character size
03958
03959 DESCRIPTION:
03960
03961 This sets up the size of all subsequent characters drawn. The actual
03962 height of a character is the product of the default character size and
03963 a scaling factor.
03964
03965 Redacted form: plschr(def, scale)
03966
03967 This function is used in example 2,13,23,24.
03968
03969
03970
03971 SYNOPSIS:
03972
03973 plschr(def, scale)
03974
03975 ARGUMENTS:
03976
03977 def (PLFLT, input) : The default height of a character in
03978 millimeters, should be set to zero if the default height is to
03979 remain unchanged.
03980
03981 scale (PLFLT, input) : Scale factor to be applied to default to get
03982 actual character height.
03983
03984 """
03985 return _plplotc.plschr(*args)
03986
03987 def plscmap0(*args):
03988 """
03989 Set color map0 colors by 8-bit RGB values
03990
03991 DESCRIPTION:
03992
03993 Set color map0 colors using 8-bit RGB values (see the PLplot
03994 documentation). This sets the entire color map -- only as many colors
03995 as specified will be allocated.
03996
03997 Redacted form: plscmap0(r, g, b, ncol0)
03998
03999 This function is used in examples 2,24.
04000
04001
04002
04003 SYNOPSIS:
04004
04005 plscmap0(r, g, b, ncol0)
04006
04007 ARGUMENTS:
04008
04009 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04010 integers (0-255) representing the degree of red in the color.
04011
04012 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04013 integers (0-255) representing the degree of green in the color.
04014
04015 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04016 integers (0-255) representing the degree of blue in the color.
04017
04018 ncol0 (PLINT, input) : Number of items in the r, g, and b arrays.
04019
04020 """
04021 return _plplotc.plscmap0(*args)
04022
04023 def plscmap0a(*args):
04024 """
04025 Set color map0 colors by 8-bit RGB values and double alpha value.
04026
04027 DESCRIPTION:
04028
04029 Set color map0 colors using 8-bit RGB values (see the PLplot
04030 documentation) and floating point alpha value. This sets the entire
04031 color map -- only as many colors as specified will be allocated.
04032
04033 This function is used in examples 30.
04034
04035
04036
04037 SYNOPSIS:
04038
04039 plscmap0a(r, g, b, a, ncol0)
04040
04041 ARGUMENTS:
04042
04043 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04044 integers (0-255) representing the degree of red in the color.
04045
04046 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04047 integers (0-255) representing the degree of green in the color.
04048
04049 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04050 integers (0-255) representing the degree of blue in the color.
04051
04052 a (PLFLT *, input) : Pointer to array with set of PLFLT values (0.0
04053 - 1.0) representing the transparency of the color.
04054
04055 ncol0 (PLINT, input) : Number of items in the r, g, b, and a
04056 arrays.
04057
04058 """
04059 return _plplotc.plscmap0a(*args)
04060
04061 def plscmap0n(*args):
04062 """
04063 Set number of colors in color map0
04064
04065 DESCRIPTION:
04066
04067 Set number of colors in color map0 (see the PLplot documentation).
04068 Allocate (or reallocate) color map0, and fill with default values for
04069 those colors not previously allocated. The first 16 default colors are
04070 given in the plcol0 documentation. For larger indices the default
04071 color is red.
04072
04073 The drivers are not guaranteed to support more than 16 colors.
04074
04075 Redacted form: plscmap0n(ncol0)
04076
04077 This function is used in examples 15,16,24.
04078
04079
04080
04081 SYNOPSIS:
04082
04083 plscmap0n(ncol0)
04084
04085 ARGUMENTS:
04086
04087 ncol0 (PLINT, input) : Number of colors that will be allocated in
04088 the map0 palette. If this number is zero or less, then the value
04089 from the previous call to plscmap0n is used and if there is no
04090 previous call, then a default value is used.
04091
04092 """
04093 return _plplotc.plscmap0n(*args)
04094
04095 def plscmap1(*args):
04096 """
04097 Set color map1 colors using 8-bit RGB values
04098
04099 DESCRIPTION:
04100
04101 Set color map1 colors using 8-bit RGB values (see the PLplot
04102 documentation). This also sets the number of colors.
04103
04104 Redacted form: plscmap1(r, g, b, ncol1)
04105
04106 This function is used in example 31.
04107
04108
04109
04110 SYNOPSIS:
04111
04112 plscmap1(r, g, b, ncol1)
04113
04114 ARGUMENTS:
04115
04116 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04117 integers (0-255) representing the degree of red in the color.
04118
04119 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04120 integers (0-255) representing the degree of green in the color.
04121
04122 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04123 integers (0-255) representing the degree of blue in the color.
04124
04125 ncol1 (PLINT, input) : Number of items in the r, g, and b arrays.
04126
04127 """
04128 return _plplotc.plscmap1(*args)
04129
04130 def plscmap1a(*args):
04131 """
04132 Set color map1 colors using 8-bit RGB values and double alpha values.
04133
04134 DESCRIPTION:
04135
04136 Set color map1 colors using 8-bit RGB values (see the PLplot
04137 documentation) and double alpha values. This also sets the number of
04138 colors.
04139
04140 This function is used in example 31.
04141
04142
04143
04144 SYNOPSIS:
04145
04146 plscmap1a(r, g, b, a, ncol1)
04147
04148 ARGUMENTS:
04149
04150 r (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04151 integers (0-255) representing the degree of red in the color.
04152
04153 g (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04154 integers (0-255) representing the degree of green in the color.
04155
04156 b (PLINT *, input) : Pointer to array with set of unsigned 8-bit
04157 integers (0-255) representing the degree of blue in the color.
04158
04159 a (PLFLT *, input) : Pointer to array with set of double values
04160 (0.0-1.0) representing the alpha value of the color.
04161
04162 ncol1 (PLINT, input) : Number of items in the r, g, b, and a
04163 arrays.
04164
04165 """
04166 return _plplotc.plscmap1a(*args)
04167
04168 def plscmap1l(*args):
04169 """
04170 Set color map1 colors using a piece-wise linear relationship
04171
04172 DESCRIPTION:
04173
04174 Set color map1 colors using a piece-wise linear relationship between
04175 position in the color map (from 0 to 1) and position in HLS or RGB
04176 color space (see the PLplot documentation). May be called at any
04177 time.
04178
04179 The idea here is to specify a number of control points that define the
04180 mapping between palette 1 input positions (intensities) and HLS (or
04181 RGB). Between these points, linear interpolation is used which gives
04182 a smooth variation of color with input position. Any number of
04183 control points may be specified, located at arbitrary positions,
04184 although typically 2 - 4 are enough. Another way of stating this is
04185 that we are traversing a given number of lines through HLS (or RGB)
04186 space as we move through color map1 entries. The control points at
04187 the minimum and maximum position (0 and 1) must always be specified.
04188 By adding more control points you can get more variation. One good
04189 technique for plotting functions that vary about some expected average
04190 is to use an additional 2 control points in the center (position ~=
04191 0.5) that are the same lightness as the background (typically white
04192 for paper output, black for crt), and same hue as the boundary control
04193 points. This allows the highs and lows to be very easily
04194 distinguished.
04195
04196 Each control point must specify the position in color map1 as well as
04197 three coordinates in HLS or RGB space. The first point must
04198 correspond to position = 0, and the last to position = 1.
04199
04200 The hue is interpolated around the "front" of the color wheel
04201 (red<->green<->blue<->red) unless the "rev" flag is set to true, in
04202 which case interpolation (between the i and i + 1 control point for
04203 rev[i]) proceeds around the back (reverse) side. Specifying rev=NULL
04204 is equivalent to setting rev[]= false for every control point.
04205
04206 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
04207 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
04208 1]magnitudeHLSsaturation[0, 1]magnitude
04209
04210 Redacted form: plscmap1l(itype, pos, coord1, coord2, coord3, rev)
04211
04212 This function is used in examples 8,11,12,15,20,21.
04213
04214
04215
04216 SYNOPSIS:
04217
04218 plscmap1l(itype, npts, pos, coord1, coord2, coord3, rev)
04219
04220 ARGUMENTS:
04221
04222 itype (PLBOOL, input) : true: RGB, false: HLS.
04223
04224 npts (PLINT, input) : number of control points
04225
04226 pos (PLFLT *, input) : position for each control point (between 0.0
04227 and 1.0, in ascending order)
04228
04229 coord1 (PLFLT *, input) : first coordinate (H or R) for each
04230 control point
04231
04232 coord2 (PLFLT *, input) : second coordinate (L or G) for each
04233 control point
04234
04235 coord3 (PLFLT *, input) : third coordinate (S or B) for each
04236 control point
04237
04238 rev (PLBOOL: *, input) : reverse flag for each control point.
04239 (rev[i] refers to the interpolation interval between the i and i +
04240 1 control points).
04241
04242 """
04243 return _plplotc.plscmap1l(*args)
04244
04245 def plscmap1la(*args):
04246 """
04247 Set color map1 colors using a piece-wise linear relationship
04248
04249 DESCRIPTION:
04250
04251 This is a version of plscmap1l that supports alpha transparency. It
04252 sets color map1 colors using a piece-wise linear relationship between
04253 position in the color map (from 0 to 1) and position in HLS or RGB
04254 color space (see the PLplot documentation) with alpha value (0.0 -
04255 1.0). It may be called at any time.
04256
04257 This function is used in example 30.
04258
04259
04260
04261 SYNOPSIS:
04262
04263 plscmap1la(itype, npts, pos, coord1, coord2, coord3, coord4, rev)
04264
04265 ARGUMENTS:
04266
04267 itype (PLBOOL, input) : true: RGB, false: HLS.
04268
04269 npts (PLINT, input) : number of control points
04270
04271 pos (PLFLT *, input) : position for each control point (between 0.0
04272 and 1.0, in ascending order)
04273
04274 coord1 (PLFLT *, input) : first coordinate (H or R) for each
04275 control point
04276
04277 coord2 (PLFLT *, input) : second coordinate (L or G) for each
04278 control point
04279
04280 coord3 (PLFLT *, input) : third coordinate (S or B) for each
04281 control point
04282
04283 coord4 (PLFLT *, input) : fourth coordinate, the alpha value for
04284 each control point
04285
04286 rev (PLBOOL: *, input) : reverse flag for each control point.
04287 (rev[i] refers to the interpolation interval between the i and i +
04288 1 control points).
04289
04290 """
04291 return _plplotc.plscmap1la(*args)
04292
04293 def plscmap1n(*args):
04294 """
04295 Set number of colors in color map1
04296
04297 DESCRIPTION:
04298
04299 Set number of colors in color map1, (re-)allocate color map1, and set
04300 default values if this is the first allocation (see the PLplot
04301 documentation).
04302
04303 Redacted form: plscmap1n(ncol1)
04304
04305 This function is used in examples 8,11,20,21.
04306
04307
04308
04309 SYNOPSIS:
04310
04311 plscmap1n(ncol1)
04312
04313 ARGUMENTS:
04314
04315 ncol1 (PLINT, input) : Number of colors that will be allocated in
04316 the map1 palette. If this number is zero or less, then the value
04317 from the previous call to plscmap1n is used and if there is no
04318 previous call, then a default value is used.
04319
04320 """
04321 return _plplotc.plscmap1n(*args)
04322
04323 def plscol0(*args):
04324 """
04325 Set a given color from color map0 by 8 bit RGB value
04326
04327 ESCRIPTION:
04328
04329 Set a given color by 8-bit RGB value for color map0 (see the PLplot
04330 documentation). Overwrites the previous color value for the given
04331 index and, thus, does not result in any additional allocation of space
04332 for colors.
04333
04334 Redacted form: plscol0(icol0, r, g, b)
04335
04336 This function is not used in any examples.
04337
04338
04339
04340 YNOPSIS:
04341
04342 lscol0(icol0, r, g, b)
04343
04344 RGUMENTS:
04345
04346 icol0 (PLINT, input) : Color index. Must be less than the maximum
04347 number of colors (which is set by default, by plscmap0n, or even
04348 by plscmap0).
04349
04350 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04351 degree of red in the color.
04352
04353 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04354 degree of green in the color.
04355
04356 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04357 degree of blue in the color.
04358
04359 """
04360 return _plplotc.plscol0(*args)
04361
04362 def plscol0a(*args):
04363 """
04364 Set a given color from color map0 by 8 bit RGB value and double alpha value.
04365
04366 ESCRIPTION:
04367
04368 Set a given color by 8-bit RGB value and double alpha value for color
04369 map0 (see the PLplot documentation). Overwrites the previous color
04370 value for the given index and, thus, does not result in any
04371 additional allocation of space for colors.
04372
04373 This function is used in example 30.
04374
04375
04376
04377 YNOPSIS:
04378
04379 lscol0a(icol0, r, g, b, a)
04380
04381 RGUMENTS:
04382
04383 icol0 (PLINT, input) : Color index. Must be less than the maximum
04384 number of colors (which is set by default, by plscmap0n, or even
04385 by plscmap0).
04386
04387 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04388 degree of red in the color.
04389
04390 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04391 degree of green in the color.
04392
04393 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04394 degree of blue in the color.
04395
04396 a (PLFLT, input) : double value (0.0-1.0) representing the alpha
04397 value of the color.
04398
04399 """
04400 return _plplotc.plscol0a(*args)
04401
04402 def plscolbg(*args):
04403 """
04404 Set the background color by 8-bit RGB value
04405
04406 DESCRIPTION:
04407
04408 Set the background color (color 0 in color map 0) by 8-bit RGB value
04409 (see the PLplot documentation).
04410
04411 Redacted form: plscolbg(r, g, b)
04412
04413 This function is used in examples 15,31.
04414
04415
04416
04417 SYNOPSIS:
04418
04419 plscolbg(r, g, b)
04420
04421 ARGUMENTS:
04422
04423 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04424 degree of red in the color.
04425
04426 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04427 degree of green in the color.
04428
04429 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04430 degree of blue in the color.
04431
04432 """
04433 return _plplotc.plscolbg(*args)
04434
04435 def plscolbga(*args):
04436 """
04437 Set the background color by 8-bit RGB value and double alpha value.
04438
04439 DESCRIPTION:
04440
04441 Set the background color (color 0 in color map 0) by 8-bit RGB value
04442 (see the PLplot documentation) and double alpha value.
04443
04444 This function is used in example 31.
04445
04446
04447
04448 SYNOPSIS:
04449
04450 plscolbga(r, g, b, a)
04451
04452 ARGUMENTS:
04453
04454 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04455 degree of red in the color.
04456
04457 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04458 degree of green in the color.
04459
04460 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
04461 degree of blue in the color.
04462
04463 a (PLFLT, input) : double value (0.0-1.0) representing the alpha
04464 value of the color.
04465
04466 """
04467 return _plplotc.plscolbga(*args)
04468
04469 def plscolor(*args):
04470 """
04471 Used to globally turn color output on/off
04472
04473 DESCRIPTION:
04474
04475 Used to globally turn color output on/off for those drivers/devices
04476 that support it.
04477
04478 Redacted form: plscolor(color)
04479
04480 This function is used in example 31.
04481
04482
04483
04484 SYNOPSIS:
04485
04486 plscolor(color)
04487
04488 ARGUMENTS:
04489
04490 color (PLINT, input) : Color flag (Boolean). If zero, color is
04491 turned off. If non-zero, color is turned on.
04492
04493 """
04494 return _plplotc.plscolor(*args)
04495
04496 def plscompression(*args):
04497 """
04498 Set device-compression level
04499
04500 DESCRIPTION:
04501
04502 Set device-compression level. Only used for drivers that provide
04503 compression. This function, if used, should be invoked before a call
04504 to plinit.
04505
04506 Redacted form: plscompression(compression)
04507
04508 This function is used in example 31.
04509
04510
04511
04512 SYNOPSIS:
04513
04514 plscompression(compression)
04515
04516 ARGUMENTS:
04517
04518 compression (PLINT, input) : The desired compression level. This is
04519 a device-dependent value. Currently only the jpeg and png devices
04520 use these values. For jpeg value is the jpeg quality which should
04521 normally be in the range 0-95. Higher values denote higher quality
04522 and hence larger image sizes. For png values are in the range -1
04523 to 99. Values of 0-9 are taken as the compression level for zlib.
04524 A value of -1 denotes the default zlib compression level. Values
04525 in the range 10-99 are divided by 10 and then used as the zlib
04526 compression level. Higher compression levels correspond to greater
04527 compression and small file sizes at the expense of more
04528 computation.
04529
04530 """
04531 return _plplotc.plscompression(*args)
04532
04533 def plsdev(*args):
04534 """
04535 Set the device (keyword) name
04536
04537 DESCRIPTION:
04538
04539 Set the device (keyword) name.
04540
04541 Redacted form: plsdev(devname)
04542
04543 This function is used in examples 1,14,20.
04544
04545
04546
04547 SYNOPSIS:
04548
04549 plsdev(devname)
04550
04551 ARGUMENTS:
04552
04553 devname (const char *, input) : Pointer to device (keyword) name
04554 string.
04555
04556 """
04557 return _plplotc.plsdev(*args)
04558
04559 def plsdidev(*args):
04560 """
04561 Set parameters that define current device-space window
04562
04563 DESCRIPTION:
04564
04565 Set relative margin width, aspect ratio, and relative justification
04566 that define current device-space window. If you want to just use the
04567 previous value for any of these, just pass in the magic value
04568 PL_NOTSET. It is unlikely that one should ever need to change the
04569 aspect ratio but it's in there for completeness. If plsdidev is not
04570 called the default values of mar, jx, and jy are all 0. aspect is set
04571 to a device-specific value.
04572
04573 Redacted form: plsdidev(mar, aspect, jx, jy)
04574
04575 This function is used in example 31.
04576
04577
04578
04579 SYNOPSIS:
04580
04581 plsdidev(mar, aspect, jx, jy)
04582
04583 ARGUMENTS:
04584
04585 mar (PLFLT, input) : Relative margin width.
04586
04587 aspect (PLFLT, input) : Aspect ratio.
04588
04589 jx (PLFLT, input) : Relative justification in x. Value must lie in
04590 the range -0.5 to 0.5.
04591
04592 jy (PLFLT, input) : Relative justification in y. Value must lie in
04593 the range -0.5 to 0.5.
04594
04595 """
04596 return _plplotc.plsdidev(*args)
04597
04598 def plsdimap(*args):
04599 """
04600 Set up transformation from metafile coordinates
04601
04602 DESCRIPTION:
04603
04604 Set up transformation from metafile coordinates. The size of the plot
04605 is scaled so as to preserve aspect ratio. This isn't intended to be a
04606 general-purpose facility just yet (not sure why the user would need
04607 it, for one).
04608
04609 Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
04610 dimypmm)
04611
04612 This function is not used in any examples.
04613
04614
04615
04616 SYNOPSIS:
04617
04618 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
04619
04620 ARGUMENTS:
04621
04622 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
04623
04624 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
04625
04626 dimymin (PLINT, input) : NEEDS DOCUMENTATION
04627
04628 dimymax (PLINT, input) : NEEDS DOCUMENTATION
04629
04630 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
04631
04632 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
04633
04634 """
04635 return _plplotc.plsdimap(*args)
04636
04637 def plsdiori(*args):
04638 """
04639 Set plot orientation
04640
04641 DESCRIPTION:
04642
04643 Set plot orientation parameter which is multiplied by 90 degrees to
04644 obtain the angle of rotation. Note, arbitrary rotation parameters
04645 such as 0.2 (corresponding to 18 degrees) are possible, but the usual
04646 values for the rotation parameter are 0., 1., 2., and 3. corresponding
04647 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
04648 (seascape mode), and 270 degrees (upside-down mode). If plsdiori is
04649 not called the default value of rot is 0.
04650
04651 N.B. aspect ratio is unaffected by calls to plsdiori. So you will
04652 probably want to change the aspect ratio to a value suitable for the
04653 plot orientation using a call to plsdidev or the command-line options
04654 -a or -freeaspect. For more documentation of those options see the
04655 PLplot documentation. Such command-line options can be set internally
04656 using plsetopt or set directly using the command line and parsed using
04657 a call to plparseopts.
04658
04659 Redacted form: plsdiori(rot)
04660
04661 This function is not used in any examples.
04662
04663
04664
04665 SYNOPSIS:
04666
04667 plsdiori(rot)
04668
04669 ARGUMENTS:
04670
04671 rot (PLFLT, input) : Plot orientation parameter.
04672
04673 """
04674 return _plplotc.plsdiori(*args)
04675
04676 def plsdiplt(*args):
04677 """
04678 Set parameters that define current plot-space window
04679
04680 DESCRIPTION:
04681
04682 Set relative minima and maxima that define the current plot-space
04683 window. If plsdiplt is not called the default values of xmin, ymin,
04684 xmax, and ymax are 0., 0., 1., and 1.
04685
04686 Redacted form: plsdiplt(xmin, ymin, xmax, ymax)
04687
04688 This function is used in example 31.
04689
04690
04691
04692 SYNOPSIS:
04693
04694 plsdiplt(xmin, ymin, xmax, ymax)
04695
04696 ARGUMENTS:
04697
04698 xmin (PLFLT, input) : Relative minimum in x.
04699
04700 ymin (PLFLT, input) : Relative minimum in y.
04701
04702 xmax (PLFLT, input) : Relative maximum in x.
04703
04704 ymax (PLFLT, input) : Relative maximum in y.
04705
04706 """
04707 return _plplotc.plsdiplt(*args)
04708
04709 def plsdiplz(*args):
04710 """
04711 Set parameters incrementally (zoom mode) that define current plot-space window
04712
04713 DESCRIPTION:
04714
04715 Set relative minima and maxima incrementally (zoom mode) that define
04716 the current plot-space window. This function has the same effect as
04717 plsdiplt if that function has not been previously called. Otherwise,
04718 this function implements zoom mode using the transformation min_used =
04719 old_min + old_length*min and max_used = old_min + old_length*max for
04720 each axis. For example, if min = 0.05 and max = 0.95 for each axis,
04721 repeated calls to plsdiplz will zoom in by 10 per cent for each call.
04722
04723 Redacted form: plsdiplz(xmin, ymin, xmax, ymax)
04724
04725 This function is used in example 31.
04726
04727
04728
04729 SYNOPSIS:
04730
04731 plsdiplz(xmin, ymin, xmax, ymax)
04732
04733 ARGUMENTS:
04734
04735 xmin (PLFLT, input) : Relative (incremental) minimum in x.
04736
04737 ymin (PLFLT, input) : Relative (incremental) minimum in y.
04738
04739 xmax (PLFLT, input) : Relative (incremental) maximum in x.
04740
04741 ymax (PLFLT, input) : Relative (incremental) maximum in y.
04742
04743 """
04744 return _plplotc.plsdiplz(*args)
04745
04746 def plseed(*args):
04747 """
04748 Set seed for internal random number generator.
04749
04750 DESCRIPTION:
04751
04752 Set the seed for the internal random number generator. See plrandd for
04753 further details.
04754
04755 Redacted form: plseed(seed)
04756
04757 This function is used in example 21.
04758
04759
04760
04761 SYNOPSIS:
04762
04763 plseed(seed)
04764
04765 ARGUMENTS:
04766
04767 seed (unsigned int, input) : Seed for random number generator.
04768
04769 """
04770 return _plplotc.plseed(*args)
04771
04772 def plsesc(*args):
04773 """
04774 Set the escape character for text strings
04775
04776 DESCRIPTION:
04777
04778 Set the escape character for text strings. From C (in contrast to
04779 Fortran 77, see plsescfortran77) you pass esc as a character. Only
04780 selected characters are allowed to prevent the user from shooting
04781 himself in the foot (For example, a \ isn't allowed since it conflicts
04782 with C's use of backslash as a character escape). Here are the
04783 allowed escape characters and their corresponding decimal ASCII
04784 values: !, ASCII 33
04785 #, ASCII 35
04786 $, ASCII 36
04787 %, ASCII 37
04788 &, ASCII 38
04789 *, ASCII 42
04790 @, ASCII 64
04791 ^, ASCII 94
04792 ~, ASCII 126
04793
04794
04795 Redacted form: General: plsesc(esc)
04796 Perl/PDL: Not available?
04797
04798
04799 This function is used in example 29.
04800
04801
04802
04803 SYNOPSIS:
04804
04805 plsesc(esc)
04806
04807 ARGUMENTS:
04808
04809 esc (char, input) : Escape character.
04810
04811 """
04812 return _plplotc.plsesc(*args)
04813
04814 def plsetopt(*args):
04815 """
04816 Set any command-line option
04817
04818 DESCRIPTION:
04819
04820 Set any command-line option internally from a program before it
04821 invokes plinit. opt is the name of the command-line option and optarg
04822 is the corresponding command-line option argument.
04823
04824 This function returns 0 on success.
04825
04826 Redacted form: plsetopt(opt, optarg)
04827
04828 This function is used in example 14.
04829
04830
04831
04832 SYNOPSIS:
04833
04834 int plsetopt(opt, optarg)
04835
04836 ARGUMENTS:
04837
04838 opt (const char *, input) : Pointer to string containing the
04839 command-line option.
04840
04841 optarg (const char *, input) : Pointer to string containing the
04842 argument of the command-line option.
04843
04844 """
04845 return _plplotc.plsetopt(*args)
04846
04847 def plsfam(*args):
04848 """
04849 Set family file parameters
04850
04851 DESCRIPTION:
04852
04853 Sets variables dealing with output file familying. Does nothing if
04854 familying not supported by the driver. This routine, if used, must be
04855 called before initializing PLplot. See the PLplot documentation for
04856 more information.
04857
04858 Redacted form: plsfam(fam, num, bmax)
04859
04860 This function is used in examples 14,31.
04861
04862
04863
04864 SYNOPSIS:
04865
04866 plsfam(fam, num, bmax)
04867
04868 ARGUMENTS:
04869
04870 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
04871 is enabled.
04872
04873 num (PLINT, input) : Current family file number.
04874
04875 bmax (PLINT, input) : Maximum file size (in bytes) for a family
04876 file.
04877
04878 """
04879 return _plplotc.plsfam(*args)
04880
04881 def plsfci(*args):
04882 """
04883 Set FCI (font characterization integer)
04884
04885 DESCRIPTION:
04886
04887 Sets font characteristics to be used at the start of the next string
04888 using the FCI approach. See the PLplot documentation for more
04889 information.
04890
04891 Redacted form: General: plsfci(fci)
04892 Perl/PDL: Not available?
04893
04894
04895 This function is used in example 23.
04896
04897
04898
04899 SYNOPSIS:
04900
04901 plsfci(fci)
04902
04903 ARGUMENTS:
04904
04905 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
04906 of FCI.
04907
04908 """
04909 return _plplotc.plsfci(*args)
04910
04911 def plsfnam(*args):
04912 """
04913 Set output file name
04914
04915 DESCRIPTION:
04916
04917 Sets the current output file name, if applicable. If the file name
04918 has not been specified and is required by the driver, the user will be
04919 prompted for it. If using the X-windows output driver, this sets the
04920 display name. This routine, if used, must be called before
04921 initializing PLplot.
04922
04923 Redacted form: plsfnam(fnam)
04924
04925 This function is used in examples 1,20.
04926
04927
04928
04929 SYNOPSIS:
04930
04931 plsfnam(fnam)
04932
04933 ARGUMENTS:
04934
04935 fnam (const char *, input) : Pointer to file name string.
04936
04937 """
04938 return _plplotc.plsfnam(*args)
04939
04940 def plsfont(*args):
04941 """
04942 Set family, style and weight of the current font
04943
04944 DESCRIPTION:
04945
04946 Sets the current font. See the PLplot documentation for more
04947 information on font selection.
04948
04949 Redacted form: plsfont(family, style, weight)
04950
04951 This function is used in example 23.
04952
04953
04954
04955 SYNOPSIS:
04956
04957 plsfont(family, style, weight)
04958
04959 ARGUMENTS:
04960
04961 family (PLINT, input) : Font family to select for the current font.
04962 The available values are given by the PL_FCI_* constants in
04963 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
04964 PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value
04965 signifies that the font family should not be altered.
04966
04967 style (PLINT, input) : Font style to select for the current font.
04968 The available values are given by the PL_FCI_* constants in
04969 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and
04970 PL_FCI_OBLIQUE. A negative value signifies that the font style
04971 should not be altered.
04972
04973 weight (PLINT, input) : Font weight to select for the current font.
04974 The available values are given by the PL_FCI_* constants in
04975 plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A
04976 negative value signifies that the font weight should not be
04977 altered.
04978
04979 """
04980 return _plplotc.plsfont(*args)
04981
04982 def plshades(*args):
04983 """
04984 Shade regions on the basis of value
04985
04986 DESCRIPTION:
04987
04988 Shade regions on the basis of value. This is the high-level routine
04989 for making continuous color shaded plots with cmap1 while plshade (or
04990 plshade1) are used for individual shaded regions using either cmap0 or
04991 cmap1. examples/c/x16c.c shows a number of examples for using this
04992 function. See the following discussion of the arguments and the PLplot
04993 documentation for more information.
04994
04995 Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax,
04996 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
04997 pltr_data)
04998 Perl/PDL: plshades(a, xmin, xmax, ymin, ymax, clevel,
04999 fill_width, cont_color, cont_width, fill, rectangular, defined, pltr,
05000 pltr_data)
05001
05002
05003 This function is used in examples 16,21.
05004
05005
05006
05007 SYNOPSIS:
05008
05009 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
05010
05011 ARGUMENTS:
05012
05013 a (PLFLT **, input) : Contains ** pointer to array to be plotted.
05014 The array must have been declared as PLFLT a[nx][ny].
05015
05016 nx (PLINT, input) : First dimension of array "a".
05017
05018 ny (PLINT, input) : Second dimension of array "a".
05019
05020 defined (PLINT (*) (PLFLT, PLFLT), input) : User function
05021 specifying regions excluded from the shading plot. This function
05022 accepts x and y coordinates as input arguments and must return 0
05023 if the point is in the excluded region or 1 otherwise. This
05024 argument can be NULL if all the values are valid.
05025
05026 xmin (PLFLT, input) : Defines the "grid" coordinates. The data
05027 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
05028 at (xmax,ymin) and so on.
05029
05030 xmax (PLFLT, input) : Defines the "grid" coordinates. The data
05031 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
05032 at (xmax,ymin) and so on.
05033
05034 ymin (PLFLT, input) : Defines the "grid" coordinates. The data
05035 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
05036 at (xmax,ymin) and so on.
05037
05038 ymax (PLFLT, input) : Defines the "grid" coordinates. The data
05039 a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position
05040 at (xmax,ymin) and so on.
05041
05042 clevel (PLFLT *, input) : Pointer to array containing the data
05043 levels corresponding to the edges of each shaded region that will
05044 be plotted by this function. To work properly the levels should
05045 be monotonic.
05046
05047 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
05048 of shade edge values in clevel).
05049
05050 fill_width (PLINT, input) : Defines width used by the fill pattern.
05051
05052 cont_color (PLINT, input) : Defines pen color used for contours
05053 defining edges of shaded regions. The pen color is only temporary
05054 set for the contour drawing. Set this value to zero or less if no
05055 shade edge contours are wanted.
05056
05057 cont_width (PLINT, input) : Defines pen width used for contours
05058 defining edges of shaded regions. This value may not be honored
05059 by all drivers. The pen width is only temporary set for the
05060 contour drawing. Set this value to zero or less if no shade edge
05061 contours are wanted.
05062
05063 fill (void (*) (PLINT, PLFLT *, PLFLT *), input) : Routine used to
05064 fill the region. Use plfill. Future version of PLplot may have
05065 other fill routines.
05066
05067 rectangular (PLBOOL, input) : Set rectangular to true if rectangles
05068 map to rectangles after coordinate transformation with pltrl.
05069 Otherwise, set rectangular to false. If rectangular is set to
05070 true, plshade tries to save time by filling large rectangles.
05071 This optimization fails if the coordinate transformation distorts
05072 the shape of rectangles. For example a plot in polar coordinates
05073 has to have rectangular set to false.
05074
05075 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
05076 Pointer to function that defines transformation between indices
05077 in array z and the world coordinates (C only). Transformation
05078 functions are provided in the PLplot library: pltr0 for identity
05079 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
05080 defined by one- and two-dimensional arrays. In addition,
05081 user-supplied routines for the transformation can be used as well.
05082 Examples of all of these approaches are given in the PLplot
05083 documentation. The transformation function should have the form
05084 given by any of pltr0, pltr1, or pltr2.
05085
05086 pltr_data (PLPointer, input) : Extra parameter to help pass
05087 information to pltr0, pltr1, pltr2, or whatever routine that is
05088 externally supplied.
05089
05090 """
05091 return _plplotc.plshades(*args)
05092
05093 def plshade(*args):
05094 """
05095 Shade individual region on the basis of value
05096
05097 ESCRIPTION:
05098
05099 Shade individual region on the basis of value. Use plshades if you
05100 want to shade a number of regions using continuous colors. plshade is
05101 identical to plshade1 except for the type of the first parameter. See
05102 plshade1 for further discussion.
05103
05104 Redacted form: General: plshade(a, defined, xmin, xmax, ymin, ymax,
05105 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
05106 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
05107 Perl/PDL: Not available?
05108
05109
05110 This function is used in example 15.
05111
05112
05113
05114 YNOPSIS:
05115
05116 lshade(a, nx, ny, defined, xmin, xmax, ymin, ymax, shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color, min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
05117
05118 RGUMENTS:
05119
05120 a (PLFLT **, input) :
05121
05122 nx (PLINT, input) :
05123
05124 ny (PLINT, input) :
05125
05126 defined (PLINT (*) (PLFLT, PLFLT), input) :
05127
05128 xmin (PLFLT, input) :
05129
05130 xmax (PLFLT, input) :
05131
05132 ymin (PLFLT, input) :
05133
05134 ymax (PLFLT, input) :
05135
05136 shade_min (PLFLT, input) :
05137
05138 shade_max (PLFLT, input) :
05139
05140 sh_cmap (PLINT, input) :
05141
05142 sh_color (PLFLT, input) :
05143
05144 sh_width (PLINT, input) :
05145
05146 min_color (PLINT, input) :
05147
05148 min_width (PLINT, input) :
05149
05150 max_color (PLINT, input) :
05151
05152 max_width (PLINT, input) :
05153
05154 fill (void (*) (PLINT, PLFLT *, PLFLT *), input) :
05155
05156 rectangular (PLBOOL, input) :
05157
05158 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
05159
05160 pltr_data (PLPointer, input) :
05161
05162 """
05163 return _plplotc.plshade(*args)
05164
05165 def plslabelfunc(*args):
05166 """
05167 Assign a function to use for generating custom axis labels
05168
05169 DESCRIPTION:
05170
05171 This function allows a user to provide their own function to provide
05172 axis label text. The user function is given the numeric value for a
05173 point on an axis and returns a string label to correspond with that
05174 value. Custom axis labels can be enabled by passing appropriate
05175 arguments to plenv, plbox, plbox3 and similar functions.
05176
05177 This function is used in example 19.
05178
05179
05180
05181 SYNOPSIS:
05182
05183 plslabelfunc(label_func, label_data)
05184
05185 ARGUMENTS:
05186
05187 label_func (void (*) (PLINT, PLFLT, char *, PLINT, void *), input) :
05188 This is the custom label function. In order to reset to the
05189 default labeling, set this to NULL. The labeling function
05190 parameters are, in order: axis: This indicates which axis a
05191 label is being requested for. The value will be one of PL_X_AXIS,
05192 PL_Y_AXIS or PL_Z_AXIS.
05193
05194 value: This is the value along the axis which is being labeled.
05195
05196 label_text: The string representation of the label value.
05197
05198 length: The maximum length in characters allowed for label_text.
05199
05200
05201 label_data (void *, input) : This parameter may be used to pass
05202 data to the label_func function.
05203
05204 """
05205 return _plplotc.plslabelfunc(*args)
05206
05207 def plsmaj(*args):
05208 """
05209 Set length of major ticks
05210
05211 DESCRIPTION:
05212
05213 This sets up the length of the major ticks. The actual length is the
05214 product of the default length and a scaling factor as for character
05215 height.
05216
05217 Redacted form: plsmaj(def, scale)
05218
05219 This function is used in example 29.
05220
05221
05222
05223 SYNOPSIS:
05224
05225 plsmaj(def, scale)
05226
05227 ARGUMENTS:
05228
05229 def (PLFLT, input) : The default length of a major tick in
05230 millimeters, should be set to zero if the default length is to
05231 remain unchanged.
05232
05233 scale (PLFLT, input) : Scale factor to be applied to default to get
05234 actual tick length.
05235
05236 """
05237 return _plplotc.plsmaj(*args)
05238
05239 def plsmem(*args):
05240 """
05241 Set the memory area to be plotted (RGB)
05242
05243 DESCRIPTION:
05244
05245 Set the memory area to be plotted (with the mem or memcairo driver) as
05246 the dev member of the stream structure. Also set the number of pixels
05247 in the memory passed in
05248 plotmem, which is a block of memory
05249 maxy by
05250 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
05251
05252 This memory will have to be freed by the user!
05253
05254 Redacted form: plsmem(maxx, maxy, plotmem)
05255
05256 This function is not used in any examples.
05257
05258
05259
05260 SYNOPSIS:
05261
05262 plsmem(maxx, maxy, plotmem)
05263
05264 ARGUMENTS:
05265
05266 maxx (PLINT, input) : Size of memory area in the X coordinate.
05267
05268 maxy (PLINT, input) : Size of memory area in the Y coordinate.
05269
05270 plotmem (void *, input) : Pointer to the beginning of the
05271 user-supplied memory area.
05272
05273 """
05274 return _plplotc.plsmem(*args)
05275
05276 def plsmema(*args):
05277 """
05278 Set the memory area to be plotted (RGBA)
05279
05280 DESCRIPTION:
05281
05282 Set the memory area to be plotted (with the memcairo driver) as the
05283 dev member of the stream structure. Also set the number of pixels in
05284 the memory passed in
05285 plotmem, which is a block of memory
05286 maxy by
05287 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
05288
05289 This memory will have to be freed by the user!
05290
05291 Redacted form: plsmema(maxx, maxy, plotmem)
05292
05293 This function is not used in any examples.
05294
05295
05296
05297 SYNOPSIS:
05298
05299 plsmema(maxx, maxy, plotmem)
05300
05301 ARGUMENTS:
05302
05303 maxx (PLINT, input) : Size of memory area in the X coordinate.
05304
05305 maxy (PLINT, input) : Size of memory area in the Y coordinate.
05306
05307 plotmem (void *, input) : Pointer to the beginning of the
05308 user-supplied memory area.
05309
05310 """
05311 return _plplotc.plsmema(*args)
05312
05313 def plsmin(*args):
05314 """
05315 Set length of minor ticks
05316
05317 DESCRIPTION:
05318
05319 This sets up the length of the minor ticks and the length of the
05320 terminals on error bars. The actual length is the product of the
05321 default length and a scaling factor as for character height.
05322
05323 Redacted form: plsmin(def, scale)
05324
05325 This function is used in example 29.
05326
05327
05328
05329 SYNOPSIS:
05330
05331 plsmin(def, scale)
05332
05333 ARGUMENTS:
05334
05335 def (PLFLT, input) : The default length of a minor tick in
05336 millimeters, should be set to zero if the default length is to
05337 remain unchanged.
05338
05339 scale (PLFLT, input) : Scale factor to be applied to default to get
05340 actual tick length.
05341
05342 """
05343 return _plplotc.plsmin(*args)
05344
05345 def plsori(*args):
05346 """
05347 Set orientation
05348
05349 DESCRIPTION:
05350
05351 Set integer plot orientation parameter. This function is identical to
05352 plsdiori except for the type of the argument, and should be used in
05353 the same way. See the PLplot documentation for details.
05354
05355 Redacted form: plsori(ori)
05356
05357 This function is used in example 3.
05358
05359
05360
05361 SYNOPSIS:
05362
05363 plsori(ori)
05364
05365 ARGUMENTS:
05366
05367 ori (PLINT, input) : Orientation value (0 for landscape, 1 for
05368 portrait, etc.) The value is multiplied by 90 degrees to get the
05369 angle.
05370
05371 """
05372 return _plplotc.plsori(*args)
05373
05374 def plspage(*args):
05375 """
05376 Set page parameters
05377
05378 DESCRIPTION:
05379
05380 Sets the page configuration (optional). If an individual parameter is
05381 zero then that parameter value is not updated. Not all parameters are
05382 recognized by all drivers and the interpretation is device-dependent.
05383 The X-window driver uses the length and offset parameters to determine
05384 the window size and location. The length and offset values are
05385 expressed in units that are specific to the current driver. For
05386 instance: screen drivers will usually interpret them as number of
05387 pixels, whereas printer drivers will usually use mm. This routine, if
05388 used, must be called before initializing PLplot.
05389
05390 Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff)
05391
05392 This function is used in example 31.
05393
05394
05395
05396 SYNOPSIS:
05397
05398 plspage(xp, yp, xleng, yleng, xoff, yoff)
05399
05400 ARGUMENTS:
05401
05402 xp (PLFLT, input) : Number of pixels/inch (DPI), x.
05403
05404 yp (PLFLT, input) : Number of pixels/inch (DPI), y.
05405
05406 xleng (PLINT , input) : Page length, x.
05407
05408 yleng (PLINT, input) : Page length, y.
05409
05410 xoff (PLINT, input) : Page offset, x.
05411
05412 yoff (PLINT, input) : Page offset, y.
05413
05414 """
05415 return _plplotc.plspage(*args)
05416
05417 def plspal0(*args):
05418 """
05419 Set the colors for color table 0 from a cmap0 file
05420
05421 DESCRIPTION:
05422
05423 Set the colors for color table 0 from a cmap0 file
05424
05425 Redacted form: plspal0(filename)
05426
05427 This function is in example 16.
05428
05429
05430
05431 SYNOPSIS:
05432
05433 plspal0(filename)
05434
05435 ARGUMENTS:
05436
05437 filename (const char *, input) : The name of the cmap0 file, or a
05438 empty to string to specify the default cmap0 file.
05439
05440 """
05441 return _plplotc.plspal0(*args)
05442
05443 def plspal1(*args):
05444 """
05445 Set the colors for color table 1 from a cmap1 file
05446
05447 DESCRIPTION:
05448
05449 Set the colors for color table 1 from a cmap1 file
05450
05451 Redacted form: plspal1(filename)
05452
05453 This function is in example 16.
05454
05455
05456
05457 SYNOPSIS:
05458
05459 plspal1(filename)
05460
05461 ARGUMENTS:
05462
05463 filename (const char *, input) : The name of the cmap1 file, or a
05464 empty to string to specify the default cmap1 file.
05465
05466 """
05467 return _plplotc.plspal1(*args)
05468
05469 def plspause(*args):
05470 """
05471 Set the pause (on end-of-page) status
05472
05473 DESCRIPTION:
05474
05475 Set the pause (on end-of-page) status.
05476
05477 Redacted form: plspause(pause)
05478
05479 This function is in examples 14,20.
05480
05481
05482
05483 SYNOPSIS:
05484
05485 plspause(pause)
05486
05487 ARGUMENTS:
05488
05489 pause (PLBOOL, input) : If pause is true there will be a pause on
05490 end-of-page for those drivers which support this. Otherwise there
05491 is no pause.
05492
05493 """
05494 return _plplotc.plspause(*args)
05495
05496 def plsstrm(*args):
05497 """
05498 Set current output stream
05499
05500 DESCRIPTION:
05501
05502 Sets the number of the current output stream. The stream number
05503 defaults to 0 unless changed by this routine. The first use of this
05504 routine must be followed by a call initializing PLplot (e.g. plstar).
05505
05506 Redacted form: plsstrm(strm)
05507
05508 This function is examples 1,14,20.
05509
05510
05511
05512 SYNOPSIS:
05513
05514 plsstrm(strm)
05515
05516 ARGUMENTS:
05517
05518 strm (PLINT, input) : The current stream number.
05519
05520 """
05521 return _plplotc.plsstrm(*args)
05522
05523 def plssub(*args):
05524 """
05525 Set the number of subpages in x and y
05526
05527 DESCRIPTION:
05528
05529 Set the number of subpages in x and y.
05530
05531 Redacted form: plssub(nx, ny)
05532
05533 This function is examples 1,2,14,21,25,27.
05534
05535
05536
05537 SYNOPSIS:
05538
05539 plssub(nx, ny)
05540
05541 ARGUMENTS:
05542
05543 nx (PLINT, input) : Number of windows in x direction (i.e., number
05544 of window columns).
05545
05546 ny (PLINT, input) : Number of windows in y direction (i.e., number
05547 of window rows).
05548
05549 """
05550 return _plplotc.plssub(*args)
05551
05552 def plssym(*args):
05553 """
05554 Set symbol size
05555
05556 DESCRIPTION:
05557
05558 This sets up the size of all subsequent symbols drawn by plpoin and
05559 plsym. The actual height of a symbol is the product of the default
05560 symbol size and a scaling factor as for the character height.
05561
05562 Redacted form: plssym(def, scale)
05563
05564 This function is used in example 29.
05565
05566
05567
05568 SYNOPSIS:
05569
05570 plssym(def, scale)
05571
05572 ARGUMENTS:
05573
05574 def (PLFLT, input) : The default height of a symbol in millimeters,
05575 should be set to zero if the default height is to remain
05576 unchanged.
05577
05578 scale (PLFLT, input) : Scale factor to be applied to default to get
05579 actual symbol height.
05580
05581 """
05582 return _plplotc.plssym(*args)
05583
05584 def plstar(*args):
05585 """
05586 Initialization
05587
05588 DESCRIPTION:
05589
05590 Initializing the plotting package. The program prompts for the device
05591 keyword or number of the desired output device. Hitting a RETURN in
05592 response to the prompt is the same as selecting the first device. If
05593 only one device is enabled when PLplot is installed, plstar will issue
05594 no prompt. The output device is divided into nx by ny subpages, each
05595 of which may be used independently. The subroutine pladv is used to
05596 advance from one subpage to the next.
05597
05598 Redacted form: plstar(nx, ny)
05599
05600 This function is used in example 1.
05601
05602
05603
05604 SYNOPSIS:
05605
05606 plstar(nx, ny)
05607
05608 ARGUMENTS:
05609
05610 nx (PLINT, input) : Number of subpages to divide output page in the
05611 horizontal direction.
05612
05613 ny (PLINT, input) : Number of subpages to divide output page in the
05614 vertical direction.
05615
05616 """
05617 return _plplotc.plstar(*args)
05618
05619 def plstart(*args):
05620 """
05621 Initialization
05622
05623 DESCRIPTION:
05624
05625 Alternative to plstar for initializing the plotting package. The
05626 device name keyword for the desired output device must be supplied as
05627 an argument. The device keywords are the same as those printed out by
05628 plstar. If the requested device is not available, or if the input
05629 string is empty or begins with ``?'', the prompted startup of plstar
05630 is used. This routine also divides the output device into nx by ny
05631 subpages, each of which may be used independently. The subroutine
05632 pladv is used to advance from one subpage to the next.
05633
05634 Redacted form: General: plstart(device, nx, ny)
05635 Perl/PDL: plstart(nx, ny, device)
05636
05637
05638 This function is not used in any examples.
05639
05640
05641
05642 SYNOPSIS:
05643
05644 plstart(device, nx, ny)
05645
05646 ARGUMENTS:
05647
05648 device (const char *, input) : Device name (keyword) of the
05649 required output device. If NULL or if the first character is a
05650 ``?'', the normal (prompted) startup is used.
05651
05652 nx (PLINT, input) : Number of subpages to divide output page in the
05653 horizontal direction.
05654
05655 ny (PLINT, input) : Number of subpages to divide output page in the
05656 vertical direction.
05657
05658 """
05659 return _plplotc.plstart(*args)
05660
05661 def plstransform(*args):
05662 """
05663 Set a global coordinate transform function
05664
05665 DESCRIPTION:
05666
05667 This function can be used to define a coordinate transformation which
05668 affects all elements drawn within the current plot window. The
05669 transformation function is similar to that provided for the plmap and
05670 plmeridians functions. The data parameter may be used to pass extra
05671 data to transform_fun.
05672
05673 Redacted form: General: plstransform(transform_fun, data)
05674
05675
05676 This function is used in example 19.
05677
05678
05679
05680 SYNOPSIS:
05681
05682 plstransform(transform_fun, data)
05683
05684 ARGUMENTS:
05685
05686 transform_fun (void (*) (PLFLT, PLFLT, PLFLT*, PLFLT*, PLPointer) ,
05687 input) : Pointer to a function that defines a transformation
05688 from the input (x, y) coordinate to a new plot world coordiante.
05689
05690 data (PLPointer, input) : Optional extra data for
05691 transform_fun.
05692
05693 """
05694 return _plplotc.plstransform(*args)
05695
05696 def plstring(*args):
05697 return _plplotc.plstring(*args)
05698 plstring = _plplotc.plstring
05699
05700 def plstring3(*args):
05701 return _plplotc.plstring3(*args)
05702 plstring3 = _plplotc.plstring3
05703
05704 def plstripa(*args):
05705 """
05706 Add a point to a stripchart
05707
05708 DESCRIPTION:
05709
05710 Add a point to a given pen of a given stripchart. There is no need for
05711 all pens to have the same number of points or to be equally sampled in
05712 the x coordinate. Allocates memory and rescales as necessary.
05713
05714 Redacted form: plstripa(id, p, x, y)
05715
05716 This function is used in example 17.
05717
05718
05719
05720 SYNOPSIS:
05721
05722 plstripa(id, p, x, y)
05723
05724 ARGUMENTS:
05725
05726 id (PLINT, input) : Identification number (set up in plstripc) of
05727 the stripchart.
05728
05729 p (PLINT, input) : Pen number (ranges from 0 to 3).
05730
05731 x (PLFLT, input) : X coordinate of point to plot.
05732
05733 y (PLFLT, input) : Y coordinate of point to plot.
05734
05735 """
05736 return _plplotc.plstripa(*args)
05737
05738 def plstripc(*args):
05739 """
05740 Create a 4-pen stripchart
05741
05742 DESCRIPTION:
05743
05744 Create a 4-pen stripchart, to be used afterwards by plstripa
05745
05746 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
05747 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
05748 styline, legline, labx, laby, labz)
05749 Perl/PDL: plstripc(xmin, xmax, xjump, ymin, ymax, xlpos,
05750 ylpos, y_ascl, acc, colbox, collab, colline, styline, id, xspec,
05751 ypsec, legline, labx, laby, labtop)
05752
05753
05754 This function is used in example 17.
05755
05756
05757
05758 SYNOPSIS:
05759
05760 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
05761
05762 ARGUMENTS:
05763
05764 id (PLINT *, output) : Identification number of stripchart to use
05765 on plstripa and plstripd.
05766
05767 xspec (char *, input) : X-axis specification as in plbox.
05768
05769 yspec (char *, input) : Y-axis specification as in plbox.
05770
05771 xmin (PLFLT, input) : Initial coordinates of plot box; they will
05772 change as data are added.
05773
05774 xmax (PLFLT, input) : Initial coordinates of plot box; they will
05775 change as data are added.
05776
05777 xjump (PLFLT, input) : When x attains xmax, the length of the plot
05778 is multiplied by the factor (1 +
05779 xjump).
05780
05781 ymin (PLFLT, input) : Initial coordinates of plot box; they will
05782 change as data are added.
05783
05784 ymax (PLFLT, input) : Initial coordinates of plot box; they will
05785 change as data are added.
05786
05787 xlpos (PLFLT, input) : X legend box position (range from 0 to 1).
05788
05789 ylpos (PLFLT, input) : Y legend box position (range from 0 to 1).
05790
05791 y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is
05792 true, otherwise not.
05793
05794 acc (PLBOOL, input) : Accumulate strip plot if acc is true,
05795 otherwise slide display.
05796
05797 colbox (PLINT, input) : Plot box color index (cmap0).
05798
05799 collab (PLINT, input) : Legend color index (cmap0).
05800
05801 colline (PLINT *, input) : Pointer to array with color indices
05802 (cmap0) for the 4 pens.
05803
05804 styline (PLINT *, input) : Pointer to array with line styles for
05805 the 4 pens.
05806
05807 legline (char **, input) : Pointer to character array containing
05808 legends for the 4 pens.
05809
05810 labx (char *, input) : X-axis label.
05811
05812 laby (char *, input) : Y-axis label.
05813
05814 labtop (char *, input) : Plot title.
05815
05816 """
05817 return _plplotc.plstripc(*args)
05818
05819 def plstripd(*args):
05820 """
05821 Deletes and releases memory used by a stripchart
05822
05823 DESCRIPTION:
05824
05825 Deletes and releases memory used by a stripchart.
05826
05827 Redacted form: plstripd(id)
05828
05829 This function is used in example 17.
05830
05831
05832
05833 SYNOPSIS:
05834
05835 plstripd(id)
05836
05837 ARGUMENTS:
05838
05839 id (PLINT, input) : Identification number of stripchart to delete.
05840
05841 """
05842 return _plplotc.plstripd(*args)
05843
05844 def plstyl(*args):
05845 """
05846 Set line style
05847
05848 DESCRIPTION:
05849
05850 This sets up the line style for all lines subsequently drawn. A line
05851 consists of segments in which the pen is alternately down and up. The
05852 lengths of these segments are passed in the arrays mark and space
05853 respectively. The number of mark-space pairs is specified by nels.
05854 In order to return the line style to the default continuous line,
05855 plstyl should be called with nels=0.(see also pllsty)
05856
05857 Redacted form: plstyl(mark, space)
05858
05859 This function is used in examples 1,9,14.
05860
05861
05862
05863 SYNOPSIS:
05864
05865 plstyl(nels, mark, space)
05866
05867 ARGUMENTS:
05868
05869 nels (PLINT, input) : The number of mark and space elements in a
05870 line. Thus a simple broken line can be obtained by setting
05871 nels=1. A continuous line is specified by setting nels=0.
05872
05873 mark (PLINT *, input) : Pointer to array with the lengths of the
05874 segments during which the pen is down, measured in micrometers.
05875
05876 space (PLINT *, input) : Pointer to array with the lengths of the
05877 segments during which the pen is up, measured in micrometers.
05878
05879 """
05880 return _plplotc.plstyl(*args)
05881
05882 def plsvect(*args):
05883 """
05884 Set arrow style for vector plots
05885
05886 DESCRIPTION:
05887
05888 Set the style for the arrow used by plvect to plot vectors.
05889
05890 Redacted form: plsvect(arrowx, arrowy, fill)
05891
05892 This function is used in example 22.
05893
05894
05895
05896 SYNOPSIS:
05897
05898 plsvect(arrowx, arrowy, npts, fill)
05899
05900 ARGUMENTS:
05901
05902 arrowx, arrowy (PLFLT *,input) : Pointers to a pair of arrays
05903 containing the x and y points which make up the arrow. The arrow
05904 is plotted by joining these points to form a polygon. The scaling
05905 assumes that the x and y points in the arrow lie in the range -0.5
05906 <= x,y <= 0.5.
05907
05908 npts (PLINT,input) : Number of points in the arrays arrowx and
05909 arrowy.
05910
05911 fill (PLBOOL,input) : If fill is true then the arrow is closed, if
05912 fill is false then the arrow is open.
05913
05914 """
05915 return _plplotc.plsvect(*args)
05916
05917 def plsvpa(*args):
05918 """
05919 Specify viewport in absolute coordinates
05920
05921 DESCRIPTION:
05922
05923 Alternate routine to plvpor for setting up the viewport. This routine
05924 should be used only if the viewport is required to have a definite
05925 size in millimeters. The routine plgspa is useful for finding out the
05926 size of the current subpage.
05927
05928 Redacted form: plsvpa(xmin, xmax, ymin, ymax)
05929
05930 This function is used in example 10.
05931
05932
05933
05934 SYNOPSIS:
05935
05936 plsvpa(xmin, xmax, ymin, ymax)
05937
05938 ARGUMENTS:
05939
05940 xmin (PLFLT, input) : The distance of the left-hand edge of the
05941 viewport from the left-hand edge of the subpage in millimeters.
05942
05943 xmax (PLFLT, input) : The distance of the right-hand edge of the
05944 viewport from the left-hand edge of the subpage in millimeters.
05945
05946 ymin (PLFLT, input) : The distance of the bottom edge of the
05947 viewport from the bottom edge of the subpage in millimeters.
05948
05949 ymax (PLFLT, input) : The distance of the top edge of the viewport
05950 from the bottom edge of the subpage in millimeters.
05951
05952 """
05953 return _plplotc.plsvpa(*args)
05954
05955 def plsxax(*args):
05956 """
05957 Set x axis parameters
05958
05959 DESCRIPTION:
05960
05961 Sets values of the digmax and digits flags for the x axis. See the
05962 PLplot documentation for more information.
05963
05964 Redacted form: plsxax(digmax, digits)
05965
05966 This function is used in example 31.
05967
05968
05969
05970 SYNOPSIS:
05971
05972 plsxax(digmax, digits)
05973
05974 ARGUMENTS:
05975
05976 digmax (PLINT, input) : Variable to set the maximum number of
05977 digits for the x axis. If nonzero, the printed label will be
05978 switched to a floating point representation when the number of
05979 digits exceeds digmax.
05980
05981 digits (PLINT, input) : Field digits value. Currently, changing
05982 its value here has no effect since it is set only by plbox or
05983 plbox3. However, the user may obtain its value after a call to
05984 either of these functions by calling plgxax.
05985
05986 """
05987 return _plplotc.plsxax(*args)
05988
05989 def plsyax(*args):
05990 """
05991 Set y axis parameters
05992
05993 DESCRIPTION:
05994
05995 Identical to plsxax, except that arguments are flags for y axis. See
05996 the description of plsxax for more detail.
05997
05998 Redacted form: plsyax(digmax, digits)
05999
06000 This function is used in examples 1,14,31.
06001
06002
06003
06004 SYNOPSIS:
06005
06006 plsyax(digmax, digits)
06007
06008 ARGUMENTS:
06009
06010 digmax (PLINT, input) : Variable to set the maximum number of
06011 digits for the y axis. If nonzero, the printed label will be
06012 switched to a floating point representation when the number of
06013 digits exceeds digmax.
06014
06015 digits (PLINT, input) : Field digits value. Currently, changing
06016 its value here has no effect since it is set only by plbox or
06017 plbox3. However, the user may obtain its value after a call to
06018 either of these functions by calling plgyax.
06019
06020 """
06021 return _plplotc.plsyax(*args)
06022
06023 def plsym(*args):
06024 """
06025 Plots a symbol at the specified points
06026
06027 DESCRIPTION:
06028
06029 Marks out a set of n points at positions (
06030 x[i],
06031 y[i]), using the symbol defined by code. The code is interpreted as
06032 an index in the Hershey font tables.
06033
06034 Redacted form: plsym(x, y, code)
06035
06036 This function is used in example 7.
06037
06038
06039
06040 SYNOPSIS:
06041
06042 plsym(n, x, y, code)
06043
06044 ARGUMENTS:
06045
06046 n (PLINT, input) : Number of points to be marked.
06047
06048 x (PLFLT *, input) : Pointer to array with set of x coordinate
06049 values for the points.
06050
06051 y (PLFLT *, input) : Pointer to array with set of y coordinate
06052 values for the points.
06053
06054 code (PLINT, input) : Code number for the symbol to be plotted.
06055
06056 """
06057 return _plplotc.plsym(*args)
06058
06059 def plszax(*args):
06060 """
06061 Set z axis parameters
06062
06063 DESCRIPTION:
06064
06065 Identical to plsxax, except that arguments are flags for z axis. See
06066 the description of plsxax for more detail.
06067
06068 Redacted form: plszax(digmax, digits)
06069
06070 This function is used in example 31.
06071
06072
06073
06074 SYNOPSIS:
06075
06076 plszax(digmax, digits)
06077
06078 ARGUMENTS:
06079
06080 digmax (PLINT, input) : Variable to set the maximum number of
06081 digits for the z axis. If nonzero, the printed label will be
06082 switched to a floating point representation when the number of
06083 digits exceeds digmax.
06084
06085 digits (PLINT, input) : Field digits value. Currently, changing
06086 its value here has no effect since it is set only by plbox or
06087 plbox3. However, the user may obtain its value after a call to
06088 either of these functions by calling plgzax.
06089
06090 """
06091 return _plplotc.plszax(*args)
06092
06093 def pltext():
06094 """
06095 Switch to text screen
06096
06097 DESCRIPTION:
06098
06099 Sets an interactive device to text mode, used in conjunction with
06100 plgra to allow graphics and text to be interspersed. On a device
06101 which supports separate text and graphics windows, this command causes
06102 control to be switched to the text window. This can be useful for
06103 printing diagnostic messages or getting user input, which would
06104 otherwise interfere with the plots. The program must switch back to
06105 the graphics window before issuing plot commands, as the text (or
06106 console) device will probably become quite confused otherwise. If
06107 already in text mode, this command is ignored. It is also ignored on
06108 devices which only support a single window or use a different method
06109 for shifting focus (see also plgra).
06110
06111 Redacted form: pltext()
06112
06113 This function is used in example 1.
06114
06115
06116
06117 SYNOPSIS:
06118
06119 pltext()
06120
06121 """
06122 return _plplotc.pltext()
06123
06124 def pltimefmt(*args):
06125 """
06126 Set format for date / time labels
06127
06128 DESCRIPTION:
06129
06130 Sets the format for date / time labels. To enable date / time format
06131 labels see the options to plbox and plenv.
06132
06133 Redacted form: pltimefmt(fmt)
06134
06135 This function is used in example 29.
06136
06137
06138
06139 SYNOPSIS:
06140
06141 pltimefmt(fmt)
06142
06143 ARGUMENTS:
06144
06145 fmt (const char *, fmt) : This string is passed directly to the
06146 system strftime. See the system documentation for a full list of
06147 conversion specifications for your system. All conversion
06148 specifications take the form of a '%' character followed by
06149 further conversion specification character. All other text is
06150 printed as-is. Common options include: %c: The preferred date and
06151 time representation for the current locale.
06152 %d: The day of the month as a decimal number.
06153 %H: The hour as a decimal number using a 24-hour clock.
06154 %j: The day of the year as a decimal number.
06155 %m: The month as a decimal number.
06156 %M: The minute as a decimal number.
06157 %S: The second as a decimal number.
06158 %y: The year as a decimal number without a century.
06159 %Y: The year as a decimal number including a century.
06160
06161 """
06162 return _plplotc.pltimefmt(*args)
06163
06164 def plvasp(*args):
06165 """
06166 Specify viewport using aspect ratio only
06167
06168 DESCRIPTION:
06169
06170 Sets the viewport so that the ratio of the length of the y axis to
06171 that of the x axis is equal to aspect.
06172
06173 Redacted form: plvasp(aspect)
06174
06175 This function is used in example 13.
06176
06177
06178
06179 SYNOPSIS:
06180
06181 plvasp(aspect)
06182
06183 ARGUMENTS:
06184
06185 aspect (PLFLT, input) : Ratio of length of y axis to length of x
06186 axis.
06187
06188 """
06189 return _plplotc.plvasp(*args)
06190
06191 def plvect(*args):
06192 """
06193 Vector plot
06194
06195 DESCRIPTION:
06196
06197 Draws a vector plot of the vector (
06198 u[
06199 nx][
06200 ny],
06201 v[
06202 nx][
06203 ny]). The scaling factor for the vectors is given by scale. A
06204 transformation routine pointed to by pltr with a pointer pltr_data for
06205 additional data required by the transformation routine is used to map
06206 indices within the array to the world coordinates. The style of the
06207 vector arrow may be set using plsvect.
06208
06209 Redacted form: plvect(u, v, scale, pltr, pltr_data)
06210
06211 This function is used in example 22.
06212
06213
06214
06215 SYNOPSIS:
06216
06217 plvect(u, v, nx, ny, scale, pltr, pltr_data)
06218
06219 ARGUMENTS:
06220
06221 u, v (PLFLT **, input) : Pointers to a pair of vectored
06222 two-dimensional arrays containing the x and y components of the
06223 vector data to be plotted.
06224
06225 nx, ny (PLINT, input) : Physical dimensions of the arrays u and v.
06226
06227 scale (PLFLT, input) : Parameter to control the scaling factor of
06228 the vectors for plotting. If scale = 0 then the scaling factor is
06229 automatically calculated for the data. If scale < 0 then the
06230 scaling factor is automatically calculated for the data and then
06231 multiplied by -
06232 scale. If scale > 0 then the scaling factor is set to scale.
06233
06234 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
06235 Pointer to function that defines transformation between indices
06236 in array z and the world coordinates (C only). Transformation
06237 functions are provided in the PLplot library: pltr0 for identity
06238 mapping, and pltr1 and pltr2 for arbitrary mappings respectively
06239 defined by one- and two-dimensional arrays. In addition,
06240 user-supplied routines for the transformation can be used as well.
06241 Examples of all of these approaches are given in the PLplot
06242 documentation. The transformation function should have the form
06243 given by any of pltr0, pltr1, or pltr2.
06244
06245 pltr_data (PLPointer, input) : Extra parameter to help pass
06246 information to pltr0, pltr1, pltr2, or whatever routine that is
06247 externally supplied.
06248
06249 """
06250 return _plplotc.plvect(*args)
06251
06252 def plvpas(*args):
06253 """
06254 Specify viewport using coordinates and aspect ratio
06255
06256 DESCRIPTION:
06257
06258 Device-independent routine for setting up the viewport. The viewport
06259 is chosen to be the largest with the given aspect ratio that fits
06260 within the specified region (in terms of normalized subpage
06261 coordinates). This routine is functionally equivalent to plvpor when
06262 a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this
06263 routine reserves no extra space at the edges for labels.
06264
06265 Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect)
06266
06267 This function is used in example 9.
06268
06269
06270
06271 SYNOPSIS:
06272
06273 plvpas(xmin, xmax, ymin, ymax, aspect)
06274
06275 ARGUMENTS:
06276
06277 xmin (PLFLT, input) : The normalized subpage coordinate of the
06278 left-hand edge of the viewport.
06279
06280 xmax (PLFLT, input) : The normalized subpage coordinate of the
06281 right-hand edge of the viewport.
06282
06283 ymin (PLFLT, input) : The normalized subpage coordinate of the
06284 bottom edge of the viewport.
06285
06286 ymax (PLFLT, input) : The normalized subpage coordinate of the top
06287 edge of the viewport.
06288
06289 aspect (PLFLT, input) : Ratio of length of y axis to length of x
06290 axis.
06291
06292 """
06293 return _plplotc.plvpas(*args)
06294
06295 def plvpor(*args):
06296 """
06297 Specify viewport using coordinates
06298
06299 DESCRIPTION:
06300
06301 Device-independent routine for setting up the viewport. This defines
06302 the viewport in terms of normalized subpage coordinates which run from
06303 0.0 to 1.0 (left to right and bottom to top) along each edge of the
06304 current subpage. Use the alternate routine plsvpa in order to create
06305 a viewport of a definite size.
06306
06307 Redacted form: plvpor(xmin, xmax, ymin, ymax)
06308
06309 This function is used in examples
06310 2,6-8,10,11,15,16,18,21,23,24,26,27,31.
06311
06312
06313
06314 SYNOPSIS:
06315
06316 plvpor(xmin, xmax, ymin, ymax)
06317
06318 ARGUMENTS:
06319
06320 xmin (PLFLT, input) : The normalized subpage coordinate of the
06321 left-hand edge of the viewport.
06322
06323 xmax (PLFLT, input) : The normalized subpage coordinate of the
06324 right-hand edge of the viewport.
06325
06326 ymin (PLFLT, input) : The normalized subpage coordinate of the
06327 bottom edge of the viewport.
06328
06329 ymax (PLFLT, input) : The normalized subpage coordinate of the top
06330 edge of the viewport.
06331
06332 """
06333 return _plplotc.plvpor(*args)
06334
06335 def plvsta():
06336 """
06337 Select standard viewport
06338
06339 DESCRIPTION:
06340
06341 Sets up a standard viewport, leaving a left-hand margin of seven
06342 character heights, and four character heights around the other three
06343 sides.
06344
06345 Redacted form: plvsta()
06346
06347 This function is used in examples 1,12,14,17,25,29.
06348
06349
06350
06351 SYNOPSIS:
06352
06353 plvsta()
06354
06355 """
06356 return _plplotc.plvsta()
06357
06358 def plw3d(*args):
06359 """
06360 Set up window for 3-d plotting
06361
06362 DESCRIPTION:
06363
06364 Sets up a window for a three-dimensional surface plot within the
06365 currently defined two-dimensional window. The enclosing box for the
06366 surface plot defined by xmin, xmax, ymin, ymax, zmin and zmax in
06367 user-coordinate space is mapped into a box of world coordinate size
06368 basex by basey by height so that xmin maps to -
06369 basex/2, xmax maps to basex/2, ymin maps to -
06370 basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height.
06371 The resulting world-coordinate box is then viewed by an observer at
06372 altitude alt and azimuth az. This routine must be called before
06373 plbox3 or plot3d. For a more complete description of
06374 three-dimensional plotting see the PLplot documentation.
06375
06376 Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
06377 zmin, zmax, alt, az)
06378
06379 This function is examples 8,11,18,21.
06380
06381
06382
06383 SYNOPSIS:
06384
06385 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
06386
06387 ARGUMENTS:
06388
06389 basex (PLFLT, input) : The x coordinate size of the
06390 world-coordinate box.
06391
06392 basey (PLFLT, input) : The y coordinate size of the
06393 world-coordinate box.
06394
06395 height (PLFLT, input) : The z coordinate size of the
06396 world-coordinate box.
06397
06398 xmin (PLFLT, input) : The minimum user x coordinate value.
06399
06400 xmax (PLFLT, input) : The maximum user x coordinate value.
06401
06402 ymin (PLFLT, input) : The minimum user y coordinate value.
06403
06404 ymax (PLFLT, input) : The maximum user y coordinate value.
06405
06406 zmin (PLFLT, input) : The minimum user z coordinate value.
06407
06408 zmax (PLFLT, input) : The maximum user z coordinate value.
06409
06410 alt (PLFLT, input) : The viewing altitude in degrees above the XY
06411 plane.
06412
06413 az (PLFLT, input) : The viewing azimuth in degrees. When az=0, the
06414 observer is looking face onto the ZX plane, and as az is
06415 increased, the observer moves clockwise around the box when viewed
06416 from above the XY plane.
06417
06418 """
06419 return _plplotc.plw3d(*args)
06420
06421 def plwid(*args):
06422 """
06423 Set pen width
06424
06425 DESCRIPTION:
06426
06427 Sets the pen width.
06428
06429 Redacted form: plwid(width)
06430
06431 This function is used in examples 1,2.
06432
06433
06434
06435 SYNOPSIS:
06436
06437 plwid(width)
06438
06439 ARGUMENTS:
06440
06441 width (PLINT, input) : The desired pen width. If width is negative
06442 or the same as the previous value no action is taken. width = 0
06443 should be interpreted as as the minimum valid pen width for the
06444 device. The interpretation of positive width values is also
06445 device dependent.
06446
06447 """
06448 return _plplotc.plwid(*args)
06449
06450 def plwind(*args):
06451 """
06452 Specify world coordinates of viewport boundaries
06453
06454 DESCRIPTION:
06455
06456 Sets up the world coordinates of the edges of the viewport.
06457
06458 Redacted form: plwind(xmin, xmax, ymin, ymax)
06459
06460 This function is used in examples 1,2,4,6-12,14-16,18,21,23-27,29,31.
06461
06462
06463
06464 SYNOPSIS:
06465
06466 plwind(xmin, xmax, ymin, ymax)
06467
06468 ARGUMENTS:
06469
06470 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
06471 of the viewport.
06472
06473 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
06474 of the viewport.
06475
06476 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
06477 the viewport.
06478
06479 ymax (PLFLT, input) : The world y coordinate of the top edge of the
06480 viewport.
06481
06482 """
06483 return _plplotc.plwind(*args)
06484
06485 def plxormod(*args):
06486 """
06487 Enter or leave xor mode
06488
06489 DESCRIPTION:
06490
06491 Enter (when mode is true) or leave (when mode is false) xor mode for
06492 those drivers (e.g., the xwin driver) that support it. Enables
06493 erasing plots by drawing twice the same line, symbol, etc. If driver
06494 is not capable of xor operation it returns a status of false.
06495
06496 Redacted form: plxormod(mode, status)
06497
06498 This function is used in examples 1,20.
06499
06500
06501
06502 SYNOPSIS:
06503
06504 plxormod(mode, status)
06505
06506 ARGUMENTS:
06507
06508 mode (PLBOOL, input) : mode is true means enter xor mode and mode
06509 is false means leave xor mode.
06510
06511 status (PLBOOL *, output) : Pointer to status. Returned modestatus
06512 of true (false) means driver is capable (incapable) of xor mode.
06513
06514 """
06515 return _plplotc.plxormod(*args)
06516
06517 def plmap(*args):
06518 """
06519 Plot continental outline in world coordinates.
06520
06521 DESCRIPTION:
06522
06523 Plots continental outlines in world coordinates. examples/c/x19c
06524 demonstrates how to use this function to create different
06525 projections.
06526
06527 Redacted form: General: plmap(mapform, type, minlong, maxlong,
06528 minlat, maxlat)
06529 F95, Java, Perl/PDL, Python: Not implemented?
06530
06531
06532 This function is used in example 19.
06533
06534
06535
06536 SYNOPSIS:
06537
06538 plmap(mapform, type, minlong, maxlong, minlat, maxlat)
06539
06540 ARGUMENTS:
06541
06542 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
06543 supplied function to transform the coordinate longitudes and
06544 latitudes to a plot coordinate system. By using this transform,
06545 we can change from a longitude, latitude coordinate to a polar
06546 stereographic project, for example. Initially, x[0]..[n-1] are
06547 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
06548 After the call to mapform(), x[] and y[] should be replaced by
06549 the corresponding plot coordinates. If no transform is desired,
06550 mapform can be replaced by NULL.
06551
06552 type (char *, input) : type is a character string. The value of
06553 this parameter determines the type of background. The possible
06554 values are: "globe" -- continental outlines
06555 "usa" -- USA and state boundaries
06556 "cglobe" -- continental outlines and countries
06557 "usaglobe" -- USA, state boundaries and continental outlines
06558
06559
06560 minlong (PLFLT, input) : The value of the longitude on the left
06561 side of the plot. The value of minlong must be less than the
06562 value of maxlong, and the quantity maxlong-minlong must be less
06563 than or equal to 360.
06564
06565 maxlong (PLFLT, input) : The value of the longitude on the right
06566 side of the plot.
06567
06568 minlat (PLFLT, input) : The minimum latitude to be plotted on the
06569 background. One can always use -90.0 as the boundary outside the
06570 plot window will be automatically eliminated. However, the
06571 program will be faster if one can reduce the size of the
06572 background plotted.
06573
06574 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
06575 background. One can always use 90.0 as the boundary outside the
06576 plot window will be automatically eliminated.
06577
06578 """
06579 return _plplotc.plmap(*args)
06580
06581 def plmeridians(*args):
06582 """
06583 Plot latitude and longitude lines.
06584
06585 DESCRIPTION:
06586
06587 Displays latitude and longitude on the current plot. The lines are
06588 plotted in the current color and line style.
06589
06590 Redacted form: General: plmeridians(mapform, dlong, dlat, minlong,
06591 maxlong, minlat, maxlat)
06592 F95, Java, Perl/PDL, Python: Not implemented?
06593
06594
06595 This function is used in example 19.
06596
06597
06598
06599 SYNOPSIS:
06600
06601 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
06602
06603 ARGUMENTS:
06604
06605 mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user
06606 supplied function to transform the coordinate longitudes and
06607 latitudes to a plot coordinate system. By using this transform,
06608 we can change from a longitude, latitude coordinate to a polar
06609 stereographic project, for example. Initially, x[0]..[n-1] are
06610 the longitudes and y[0]..y[n-1] are the corresponding latitudes.
06611 After the call to mapform(), x[] and y[] should be replaced by
06612 the corresponding plot coordinates. If no transform is desired,
06613 mapform can be replaced by NULL.
06614
06615 dlong (PLFLT, input) : The interval in degrees at which the
06616 longitude lines are to be plotted.
06617
06618 dlat (PLFLT, input) : The interval in degrees at which the latitude
06619 lines are to be plotted.
06620
06621 minlong (PLFLT, input) : The value of the longitude on the left
06622 side of the plot. The value of minlong must be less than the
06623 value of maxlong, and the quantity maxlong-minlong must be less
06624 than or equal to 360.
06625
06626 maxlong (PLFLT, input) : The value of the longitude on the right
06627 side of the plot.
06628
06629 minlat (PLFLT, input) : The minimum latitude to be plotted on the
06630 background. One can always use -90.0 as the boundary outside the
06631 plot window will be automatically eliminated. However, the
06632 program will be faster if one can reduce the size of the
06633 background plotted.
06634
06635 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
06636 background. One can always use 90.0 as the boundary outside the
06637 plot window will be automatically eliminated.
06638
06639 """
06640 return _plplotc.plmeridians(*args)
06641
06642 def plimage(*args):
06643 """
06644 Plot a 2D matrix using color map1 with automatic colour adjustment
06645
06646 DESCRIPTION:
06647
06648 Plot a 2D matrix using color palette 1. The color scale is
06649 automatically adjusted to use the maximum and minimum values in idata
06650 as valuemin and valuemax in a call to plimagefr.
06651
06652 Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin,
06653 zmax, Dxmin, Dxmax, Dymin, Dymax)
06654
06655
06656 This function is used in example 20.
06657
06658
06659
06660 SYNOPSIS:
06661
06662 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
06663
06664 ARGUMENTS:
06665
06666 idata (PLFLT**, input) : A 2D array of values (intensities) to
06667 plot. Should have dimensions idata[nx][ny].
06668
06669 nx, ny (PLINT, input) : Dimensions of idata
06670
06671 xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to strecth
06672 the image data to. idata[0][0] corresponds to (xmin, ymin) and
06673 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
06674
06675 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
06676 (inclusive) will be plotted.
06677
06678 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
06679 points whose plot coordinates fall inside the window of (Dxmin,
06680 Dymin) to (Dxmax, Dymax).
06681
06682 """
06683 return _plplotc.plimage(*args)
06684
06685 def plimagefr(*args):
06686 """
06687 Plot a 2D matrix using color map1
06688
06689 DESCRIPTION:
06690
06691 Plot a 2D matrix using color map1.
06692
06693 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax,
06694 zmin, zmax, valuemin, valuemax, pltr, pltr_data)
06695
06696
06697 This function is used in example 20.
06698
06699
06700
06701 SYNOPSIS:
06702
06703 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
06704
06705 ARGUMENTS:
06706
06707 idata (PLFLT**, input) : A 2D array of values (intensities) to
06708 plot. Should have dimensions idata[nx][ny].
06709
06710 nx, ny (PLINT, input) : Dimensions of idata
06711
06712 xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to strecth
06713 the image data to. idata[0][0] corresponds to (xmin, ymin) and
06714 idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
06715
06716 zmin, zmax (PLFLT, input) : Only data between zmin and zmax
06717 (inclusive) will be plotted.
06718
06719 valuemin, valuemax (PLFLT, input) : The minimum and maximum data
06720 values to use for value to color mappings. A datum equal to or
06721 less than valuemin will be plotted with color 0.0, while a datum
06722 equal to or greater than valuemax will be plotted with color 1.0.
06723 Data between valuemin and valuemax map linearly to colors between
06724 0.0 and 1.0.
06725
06726 pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) :
06727 Pointer to function that defines a transformation between the
06728 data in the array idata and world coordinates. An input
06729 coordinate of (0, 0) corresponds to the "top-left" corner of idata
06730 while (nx, ny) corresponds to the "bottom-right" corner of idata.
06731 Some transformation functions are provided in the PLplot library:
06732 pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary
06733 mappings respectively defined by one- and two-dimensional arrays.
06734 In addition, user-supplied routines for the transformation can be
06735 used as well. Examples of all of these approaches are given in
06736 the PLplot documentation. The transformation function should have
06737 the form given by any of pltr0, pltr1, or pltr2.
06738
06739 pltr_data (PLPointer, input) : Extra parameter to help pass
06740 information to pltr0, pltr1, pltr2, or whatever routine is
06741 externally supplied.
06742
06743 """
06744 return _plplotc.plimagefr(*args)
06745
06746 def plClearOpts():
06747 return _plplotc.plClearOpts()
06748 plClearOpts = _plplotc.plClearOpts
06749
06750 def plResetOpts():
06751 return _plplotc.plResetOpts()
06752 plResetOpts = _plplotc.plResetOpts
06753
06754 def plSetUsage(*args):
06755 return _plplotc.plSetUsage(*args)
06756 plSetUsage = _plplotc.plSetUsage
06757
06758 def plOptUsage():
06759 return _plplotc.plOptUsage()
06760 plOptUsage = _plplotc.plOptUsage
06761
06762 def plMinMax2dGrid(*args):
06763 return _plplotc.plMinMax2dGrid(*args)
06764 plMinMax2dGrid = _plplotc.plMinMax2dGrid
06765
06766 def plGetCursor(*args):
06767 return _plplotc.plGetCursor(*args)
06768 plGetCursor = _plplotc.plGetCursor
06769
06770