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