PLplot
5.9.9
|
Classes | |
class | _object |
class | PLGraphicsIn |
Variables | |
tuple | _plplotc = swig_import_helper() |
int | _newclass = 0 |
pltr0 = _plplotc.pltr0 | |
pltr1 = _plplotc.pltr1 | |
pltr2 = _plplotc.pltr2 | |
PLESC_SET_RGB = _plplotc.PLESC_SET_RGB | |
PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL | |
PLESC_SET_LPB = _plplotc.PLESC_SET_LPB | |
PLESC_EXPOSE = _plplotc.PLESC_EXPOSE | |
PLESC_RESIZE = _plplotc.PLESC_RESIZE | |
PLESC_REDRAW = _plplotc.PLESC_REDRAW | |
PLESC_TEXT = _plplotc.PLESC_TEXT | |
PLESC_GRAPH = _plplotc.PLESC_GRAPH | |
PLESC_FILL = _plplotc.PLESC_FILL | |
PLESC_DI = _plplotc.PLESC_DI | |
PLESC_FLUSH = _plplotc.PLESC_FLUSH | |
PLESC_EH = _plplotc.PLESC_EH | |
PLESC_GETC = _plplotc.PLESC_GETC | |
PLESC_SWIN = _plplotc.PLESC_SWIN | |
PLESC_PLFLTBUFFERING = _plplotc.PLESC_PLFLTBUFFERING | |
PLESC_XORMOD = _plplotc.PLESC_XORMOD | |
PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION | |
PLESC_CLEAR = _plplotc.PLESC_CLEAR | |
PLESC_DASH = _plplotc.PLESC_DASH | |
PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT | |
PLESC_IMAGE = _plplotc.PLESC_IMAGE | |
PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS | |
DRAW_LINEX = _plplotc.DRAW_LINEX | |
DRAW_LINEY = _plplotc.DRAW_LINEY | |
DRAW_LINEXY = _plplotc.DRAW_LINEXY | |
MAG_COLOR = _plplotc.MAG_COLOR | |
BASE_CONT = _plplotc.BASE_CONT | |
TOP_CONT = _plplotc.TOP_CONT | |
SURF_CONT = _plplotc.SURF_CONT | |
DRAW_SIDES = _plplotc.DRAW_SIDES | |
FACETED = _plplotc.FACETED | |
MESH = _plplotc.MESH | |
PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT | |
PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED | |
PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND | |
PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY | |
PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT | |
PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING | |
PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS | |
PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND | |
PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY | |
PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT | |
PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT | |
PL_POSITION_TOP = _plplotc.PL_POSITION_TOP | |
PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM | |
PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE | |
PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE | |
PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT | |
PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE | |
PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE | |
PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX | |
PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE | |
PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL | |
PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT | |
PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND | |
PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX | |
PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR | |
PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT | |
PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT | |
PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP | |
PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM | |
PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE | |
PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE | |
PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT | |
PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE | |
PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW | |
PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH | |
PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL | |
PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT | |
PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP | |
PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT | |
PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM | |
PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND | |
PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX | |
PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE | |
PLSWIN_WORLD = _plplotc.PLSWIN_WORLD | |
PL_X_AXIS = _plplotc.PL_X_AXIS | |
PL_Y_AXIS = _plplotc.PL_Y_AXIS | |
PL_Z_AXIS = _plplotc.PL_Z_AXIS | |
PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED | |
PL_OPT_ARG = _plplotc.PL_OPT_ARG | |
PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE | |
PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE | |
PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED | |
PL_OPT_FUNC = _plplotc.PL_OPT_FUNC | |
PL_OPT_BOOL = _plplotc.PL_OPT_BOOL | |
PL_OPT_INT = _plplotc.PL_OPT_INT | |
PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT | |
PL_OPT_STRING = _plplotc.PL_OPT_STRING | |
PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL | |
PL_PARSE_FULL = _plplotc.PL_PARSE_FULL | |
PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET | |
PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE | |
PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL | |
PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE | |
PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM | |
PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH | |
PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP | |
PL_FCI_MARK = _plplotc.PL_FCI_MARK | |
PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE | |
PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK | |
PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK | |
PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE | |
PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY | |
PL_FCI_STYLE = _plplotc.PL_FCI_STYLE | |
PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT | |
PL_FCI_SANS = _plplotc.PL_FCI_SANS | |
PL_FCI_SERIF = _plplotc.PL_FCI_SERIF | |
PL_FCI_MONO = _plplotc.PL_FCI_MONO | |
PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT | |
PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL | |
PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT | |
PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC | |
PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE | |
PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM | |
PL_FCI_BOLD = _plplotc.PL_FCI_BOLD | |
PL_MAXKEY = _plplotc.PL_MAXKEY | |
PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister | |
PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS | |
PL_NOTSET = _plplotc.PL_NOTSET | |
PLESPLFLTBUFFERING_ENABLE = _plplotc.PLESPLFLTBUFFERING_ENABLE | |
PLESPLFLTBUFFERING_DISABLE = _plplotc.PLESPLFLTBUFFERING_DISABLE | |
PLESPLFLTBUFFERING_QUERY = _plplotc.PLESPLFLTBUFFERING_QUERY | |
GRID_CSA = _plplotc.GRID_CSA | |
GRID_DTLI = _plplotc.GRID_DTLI | |
GRID_NNI = _plplotc.GRID_NNI | |
GRID_NNIDW = _plplotc.GRID_NNIDW | |
GRID_NNLI = _plplotc.GRID_NNLI | |
GRID_NNAIDW = _plplotc.GRID_NNAIDW | |
plsxwin = _plplotc.plsxwin | |
plbtime = _plplotc.plbtime | |
plconfigtime = _plplotc.plconfigtime | |
plctime = _plplotc.plctime | |
plcolorbar = _plplotc.plcolorbar | |
plot3dcl = _plplotc.plot3dcl | |
plsurf3dl = _plplotc.plsurf3dl | |
plscmap1_range = _plplotc.plscmap1_range | |
plgcmap1_range = _plplotc.plgcmap1_range | |
plClearOpts = _plplotc.plClearOpts | |
plResetOpts = _plplotc.plResetOpts | |
plSetUsage = _plplotc.plSetUsage | |
plOptUsage = _plplotc.plOptUsage | |
plMinMax2dGrid = _plplotc.plMinMax2dGrid | |
plGetCursor = _plplotc.plGetCursor | |
|
private |
Definition at line 53 of file plplotc.py.
|
private |
Definition at line 59 of file plplotc.py.
|
private |
Definition at line 50 of file plplotc.py.
|
private |
Definition at line 37 of file plplotc.py.
def plplotc.pl_setcontlabelformat | ( | args | ) |
Set format of numerical label for contours DESCRIPTION: Set format of numerical label for contours. Redacted form: pl_setcontlabelformat(lexp, sigdig) This function is used example 9. SYNOPSIS: pl_setcontlabelformat(lexp, sigdig) ARGUMENTS: lexp (PLINT, input) : If the contour numerical label is greater than 10^(lexp) or less than 10^(-lexp), then the exponential format is used. Default value of lexp is 4. sigdig (PLINT, input) : Number of significant digits. Default value is 2.
Definition at line 268 of file plplotc.py.
def plplotc.pl_setcontlabelparam | ( | args | ) |
Set parameters of contour labelling other than format of numerical label DESCRIPTION: Set parameters of contour labelling other than those handled by pl_setcontlabelformat. Redacted form: pl_setcontlabelparam(offset, size, spacing, active) This function is used in example 9. SYNOPSIS: pl_setcontlabelparam(offset, size, spacing, active) ARGUMENTS: offset (PLFLT, input) : Offset of label from contour line (if set to 0.0, labels are printed on the lines). Default value is 0.006. size (PLFLT, input) : Font height for contour labels (normalized). Default value is 0.3. spacing (PLFLT, input) : Spacing parameter for contour labels. Default value is 0.1. active (PLINT, input) : Activate labels. Set to 1 if you want contour labels on. Default is off (0).
Definition at line 298 of file plplotc.py.
def plplotc.pladv | ( | args | ) |
Advance the (sub-)page DESCRIPTION: Advances to the next subpage if sub=0, performing a page advance if there are no remaining subpages on the current page. If subpages aren't being used, pladv(0) will always advance the page. If sub>0, PLplot switches to the specified subpage. Note that this allows you to overwrite a plot on the specified subpage; if this is not what you intended, use pleop followed by plbop to first advance the page. This routine is called automatically (with sub=0) by plenv, but if plenv is not used, pladv must be called after initializing PLplot but before defining the viewport. Redacted form: pladv(sub) This function is used in examples 1,2,4,6-12,14-18,20,21,23-27,29,31. SYNOPSIS: pladv(sub) ARGUMENTS: sub (PLINT, input) : Specifies the subpage number (starting from 1 in the top left corner and increasing along the rows) to which to advance. Set to zero to advance to the next subpage.
Definition at line 334 of file plplotc.py.
def plplotc.plarc | ( | args | ) |
Draw a circular or elliptical arc DESCRIPTION: Draw a possibly filled arc centered at x, y with semimajor axis a and semiminor axis b, starting at angle1 and ending at angle2. Redacted form: General: plarc(x, y, a, b, angle1, angle2, rotate, fill) This function is used in examples 3 and 27. SYNOPSIS: plarc(x, y, a, b, angle1, angle2, rotate, fill) ARGUMENTS: x (PLFLT, input) : X coordinate of arc center. y (PLFLT, input) : Y coordinate of arc center. a (PLFLT, input) : Length of the semimajor axis of the arc. b (PLFLT, input) : Length of the semiminor axis of the arc. angle1 (PLFLT, input) : Starting angle of the arc relative to the semimajor axis. angle2 (PLFLT, input) : Ending angle of the arc relative to the semimajor axis. rotate (PLFLT, input) : Angle of the semimajor axis relative to the X-axis. fill (PLBOOL, input) : Draw a filled arc.
Definition at line 369 of file plplotc.py.
def plplotc.plaxes | ( | args | ) |
Draw a box with axes, etc. with arbitrary origin DESCRIPTION: Draws a box around the currently defined viewport with arbitrary world-coordinate origin specified by x0 and y0 and labels it with world coordinate values appropriate to the window. Thus plaxes should only be called after defining both viewport and window. The character strings xopt and yopt specify how the box should be drawn as described below. If ticks and/or subticks are to be drawn for a particular axis, the tick intervals and number of subintervals may be specified explicitly, or they may be defaulted by setting the appropriate arguments to zero. Redacted form: General: plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub) Perl/PDL: plaxes(x0, y0, xtick, nxsub, ytick, nysub, xopt, yopt) This function is not used in any examples. SYNOPSIS: plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub) ARGUMENTS: x0 (PLFLT, input) : World X coordinate of origin. y0 (PLFLT, input) : World Y coordinate of origin. xopt (const char *, input) : Pointer to character string specifying options for horizontal axis. The string can include any combination of the following letters (upper or lower case) in any order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis is vertical line (x=0). b: Draws bottom (X) or left (Y) edge of frame. c: Draws top (X) or right (Y) edge of frame. d: Plot labels as date / time. Values are assumed to be seconds since the epoch (as used by gmtime). f: Always use fixed point numeric labels. g: Draws a grid at the major tick interval. h: Draws a grid at the minor tick interval. i: Inverts tick marks, so they are drawn outwards, rather than inwards. l: Labels axis logarithmically. This only affects the labels, not the data, and so it is necessary to compute the logarithms of data points before passing them to any of the drawing routines. m: Writes numeric labels at major tick intervals in the unconventional location (above box for X, right of box for Y). n: Writes numeric labels at major tick intervals in the conventional location (below box for X, left of box for Y). o: Use custom labeling function to generate axis label text. The custom labeling function can be defined with the plslabelfuncplslabelfunc; command. s: Enables subticks between major ticks, only valid if t is also specified. t: Draws major ticks. xtick (PLFLT, input) : World coordinate interval between major ticks on the x axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nxsub (PLINT, input) : Number of subintervals between major x axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval. yopt (const char *, input) : Pointer to character string specifying options for vertical axis. The string can include any combination of the letters defined above for xopt, and in addition may contain: v: Write numeric labels for vertical axis parallel to the base of the graph, rather than parallel to the axis. ytick (PLFLT, input) : World coordinate interval between major ticks on the y axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nysub (PLINT, input) : Number of subintervals between major y axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval.
Definition at line 414 of file plplotc.py.
def plplotc.plbin | ( | args | ) |
Plot a histogram from binned data DESCRIPTION: Plots a histogram consisting of nbin bins. The value associated with the i'th bin is placed in x[i], and the number of points in the bin is placed in y[i]. For proper operation, the values in x[i] must form a strictly increasing sequence. By default, x[i] is the left-hand edge of the i'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are placed midway between the values in the x array. Also see plhist for drawing histograms from unbinned data. Redacted form: General: plbin(x, y, opt) Perl/PDL: plbin(nbin, x, y, opt) Python: plbin(nbin, x, y, opt) This function is not used in any examples. SYNOPSIS: plbin(nbin, x, y, opt) ARGUMENTS: nbin (PLINT, input) : Number of bins (i.e., number of values in x and y arrays.) x (PLFLT *, input) : Pointer to array containing values associated with bins. These must form a strictly increasing sequence. y (PLFLT *, input) : Pointer to array containing number of points in bin. This is a PLFLT (instead of PLINT) array so as to allow histograms of probabilities, etc. opt (PLINT, input) : Is a combination of several flags: opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the outer bins are expanded to fill up the entire x-axis and bins of zero height are simply drawn. opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway between the x values. If the values in x are equally spaced, the values are the center values of the bins. opt=PL_BIN_NOEXPAND|...: The outer bins are drawn with equal size as the ones inside. opt=PL_BIN_NOEMPTY|...: Bins with zero height are not drawn (there is a gap for such bins).
Definition at line 506 of file plplotc.py.
def plplotc.plbop | ( | ) |
Begin a new page DESCRIPTION: Begins a new page. For a file driver, the output file is opened if necessary. Advancing the page via pleop and plbop is useful when a page break is desired at a particular point when plotting to subpages. Another use for pleop and plbop is when plotting pages to different files, since you can manually set the file name by calling plsfnam after the call to pleop. (In fact some drivers may only support a single page per file, making this a necessity.) One way to handle this case automatically is to page advance via pladv, but enable familying (see plsfam) with a small limit on the file size so that a new family member file will be created on each page break. Redacted form: plbop() This function is used in examples 2,20. SYNOPSIS: plbop()
Definition at line 564 of file plplotc.py.
def plplotc.plbox | ( | args | ) |
Draw a box with axes, etc DESCRIPTION: Draws a box around the currently defined viewport, and labels it with world coordinate values appropriate to the window. Thus plbox should only be called after defining both viewport and window. The character strings xopt and yopt specify how the box should be drawn as described below. If ticks and/or subticks are to be drawn for a particular axis, the tick intervals and number of subintervals may be specified explicitly, or they may be defaulted by setting the appropriate arguments to zero. Redacted form: General: plbox(xopt, xtick, nxsub, yopt, ytick, nysub) Perl/PDL: plbox(xtick, nxsub, ytick, nysub, xopt, yopt) This function is used in examples 1,2,4,6,6-12,14-18,21,23-26,29. SYNOPSIS: plbox(xopt, xtick, nxsub, yopt, ytick, nysub) ARGUMENTS: xopt (const char *, input) : Pointer to character string specifying options for horizontal axis. The string can include any combination of the following letters (upper or lower case) in any order: a: Draws axis, X-axis is horizontal line (y=0), and Y-axis is vertical line (x=0). b: Draws bottom (X) or left (Y) edge of frame. c: Draws top (X) or right (Y) edge of frame. d: Plot labels as date / time. Values are assumed to be seconds since the epoch (as used by gmtime). f: Always use fixed point numeric labels. g: Draws a grid at the major tick interval. h: Draws a grid at the minor tick interval. i: Inverts tick marks, so they are drawn outwards, rather than inwards. l: Labels axis logarithmically. This only affects the labels, not the data, and so it is necessary to compute the logarithms of data points before passing them to any of the drawing routines. m: Writes numeric labels at major tick intervals in the unconventional location (above box for X, right of box for Y). n: Writes numeric labels at major tick intervals in the conventional location (below box for X, left of box for Y). o: Use custom labeling function to generate axis label text. The custom labeling function can be defined with the plslabelfuncplslabelfunc; command. s: Enables subticks between major ticks, only valid if t is also specified. t: Draws major ticks. u: Exactly like "b" except don't draw edge line. w: Exactly like "c" except don't draw edge line. xtick (PLFLT, input) : World coordinate interval between major ticks on the x axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nxsub (PLINT, input) : Number of subintervals between major x axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval. yopt (const char *, input) : Pointer to character string specifying options for vertical axis. The string can include any combination of the letters defined above for xopt, and in addition may contain: v: Write numeric labels for vertical axis parallel to the base of the graph, rather than parallel to the axis. ytick (PLFLT, input) : World coordinate interval between major ticks on the y axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nysub (PLINT, input) : Number of subintervals between major y axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval.
Definition at line 594 of file plplotc.py.
def plplotc.plbox3 | ( | args | ) |
Draw a box with axes, etc, in 3-d DESCRIPTION: Draws axes, numeric and text labels for a three-dimensional surface plot. For a more complete description of three-dimensional plotting see the PLplot documentation. Redacted form: General: plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub) Perl/PDL: plbox3(xtick, nxsub, ytick, nysub, ztick, nzsub, xopt, xlabel, yopt, ylabel, zopt, zlabel) This function is used in examples 8,11,18,21. SYNOPSIS: plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub) ARGUMENTS: xopt (const char *, input) : Pointer to character string specifying options for the x axis. The string can include any combination of the following letters (upper or lower case) in any order: b: Draws axis at base, at height z= zmin where zmin is defined by call to plw3d. This character must be specified in order to use any of the other options. f: Always use fixed point numeric labels. i: Inverts tick marks, so they are drawn downwards, rather than upwards. l: Labels axis logarithmically. This only affects the labels, not the data, and so it is necessary to compute the logarithms of data points before passing them to any of the drawing routines. n: Writes numeric labels at major tick intervals. o: Use custom labeling function to generate axis label text. The custom labeling function can be defined with the plslabelfuncplslabelfunc; command. s: Enables subticks between major ticks, only valid if t is also specified. t: Draws major ticks. u: If this is specified, the text label for the axis is written under the axis. xlabel (const char *, input) : Pointer to character string specifying text label for the x axis. It is only drawn if u is in the xopt string. xtick (PLFLT, input) : World coordinate interval between major ticks on the x axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nxsub (PLINT, input) : Number of subintervals between major x axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval. yopt (const char *, input) : Pointer to character string specifying options for the y axis. The string is interpreted in the same way as xopt. ylabel (const char *, input) : Pointer to character string specifying text label for the y axis. It is only drawn if u is in the yopt string. ytick (PLFLT, input) : World coordinate interval between major ticks on the y axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nysub (PLINT, input) : Number of subintervals between major y axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval. zopt (const char *, input) : Pointer to character string specifying options for the z axis. The string can include any combination of the following letters (upper or lower case) in any order: b: Draws z axis to the left of the surface plot. c: Draws z axis to the right of the surface plot. d: Draws grid lines parallel to the x-y plane behind the figure. These lines are not drawn until after plot3d or plmesh are called because of the need for hidden line removal. f: Always use fixed point numeric labels. i: Inverts tick marks, so they are drawn away from the center. l: Labels axis logarithmically. This only affects the labels, not the data, and so it is necessary to compute the logarithms of data points before passing them to any of the drawing routines. m: Writes numeric labels at major tick intervals on the right-hand vertical axis. n: Writes numeric labels at major tick intervals on the left-hand vertical axis. o: Use custom labeling function to generate axis label text. The custom labeling function can be defined with the plslabelfuncplslabelfunc; command. s: Enables subticks between major ticks, only valid if t is also specified. t: Draws major ticks. u: If this is specified, the text label is written beside the left-hand axis. v: If this is specified, the text label is written beside the right-hand axis. zlabel (const char *, input) : Pointer to character string specifying text label for the z axis. It is only drawn if u or v are in the zopt string. ztick (PLFLT, input) : World coordinate interval between major ticks on the z axis. If it is set to zero, PLplot automatically generates a suitable tick interval. nzsub (PLINT, input) : Number of subintervals between major z axis ticks for minor ticks. If it is set to zero, PLplot automatically generates a suitable minor tick interval.
Definition at line 681 of file plplotc.py.
def plplotc.plbtime | ( | args | ) |
Definition at line 560 of file plplotc.py.
def plplotc.plcalc_world | ( | args | ) |
Calculate world coordinates and corresponding window index from relative device coordinates DESCRIPTION: Calculate world coordinates, wx and wy, and corresponding window index from relative device coordinates, rx and ry. Redacted form: General: plcalc_world(rx, ry, wx, wy, window) Perl/PDL: Not available? This function is used in example 31. SYNOPSIS: plcalc_world(rx, ry, wx, wy, window) ARGUMENTS: rx (PLFLT, input) : Input relative device coordinate (ranging from 0. to 1.) for the x coordinate. ry (PLFLT, input) : Input relative device coordinate (ranging from 0. to 1.) for the y coordinate. wx (PLFLT *, output) : Pointer to the returned world coordinate for x corresponding to the relative device coordinates rx and ry. wy (PLFLT *, output) : Pointer to the returned world coordinate for y corresponding to the relative device coordinates rx and ry. window (PLINT *, output) : Pointer to the returned last defined window index that corresponds to the input relative device coordinates (and the returned world coordinates). To give some background on the window index, for each page the initial window index is set to zero, and each time plwind is called within the page, world and device coordinates are stored for the window and the window index is incremented. Thus, for a simple page layout with non-overlapping viewports and one window per viewport, window corresponds to the viewport index (in the order which the viewport/windows were created) of the only viewport/window corresponding to rx and ry. However, for more complicated layouts with potentially overlapping viewports and possibly more than one window (set of world coordinates) per viewport, window and the corresponding output world coordinates corresponds to the last window created that fulfils the criterion that the relative device coordinates are inside it. Finally, in all cases where the input relative device coordinates are not inside any viewport/window, then window is set to -1.
Definition at line 804 of file plplotc.py.
def plplotc.plclear | ( | ) |
Clear current (sub)page DESCRIPTION: Clears the current page, effectively erasing everything that have been drawn. This command only works with interactive drivers; if the driver does not support this, the page is filled with the background color in use. If the current page is divided into subpages, only the current subpage is erased. The nth subpage can be selected with pladv(n). Redacted form: General: plclear() Perl/PDL: Not available? This function is not used in any examples. SYNOPSIS: plclear()
Definition at line 861 of file plplotc.py.
def plplotc.plClearOpts | ( | void | ) |
Clear internal option table info structure.
Definition at line 6940 of file plplotc.py.
def plplotc.plcol0 | ( | args | ) |
Set color, map0 DESCRIPTION: Sets the color for color map0 (see the PLplot documentation). Redacted form: plcol0(color) This function is used in examples 1-9,11-16,18-27,29. SYNOPSIS: plcol0(color) ARGUMENTS: color (PLINT, input) : Integer representing the color. The defaults at present are (these may change): 0 black (default background) 1 red (default foreground) 2 yellow 3 green 4 aquamarine 5 pink 6 wheat 7 grey 8 brown 9 blue 10 BlueViolet 11 cyan 12 turquoise 13 magenta 14 salmon 15 white Use plscmap0 to change the entire map0 color palette and plscol0 to change an individual color in the map0 color palette.
Definition at line 889 of file plplotc.py.
def plplotc.plcol1 | ( | args | ) |
Set color, map1 DESCRIPTION: Sets the color for color map1 (see the PLplot documentation). Redacted form: plcol1(col1) This function is used in examples 12 and 21. SYNOPSIS: plcol1(col1) ARGUMENTS: col1 (PLFLT, input) : This value must be in the range from 0. to 1. and is mapped to color using the continuous map1 color palette which by default ranges from blue to the background color to red. The map1 palette can also be straightforwardly changed by the user with plscmap1 or plscmap1l.
Definition at line 934 of file plplotc.py.
def plplotc.plcolorbar | ( | args | ) |
Definition at line 2936 of file plplotc.py.
def plplotc.plconfigtime | ( | args | ) |
Definition at line 963 of file plplotc.py.
def plplotc.plcont | ( | args | ) |
Contour plot DESCRIPTION: Draws a contour plot of the data in z[ nx][ ny], using the nlevel contour levels specified by clevel. Only the region of the array from kx to lx and from ky to ly is plotted out. A transformation routine pointed to by pltr with a pointer pltr_data for additional data required by the transformation routine is used to map indices within the array to the world coordinates. See the following discussion of the arguments and the PLplot documentation for more information. Redacted form: [PLEASE UPDATE! ONLY PERL INFO IS LIKELY CORRECT!] F95: plcont(z, kx, lx, ky, ly, clevel, tr?) or plcont(z, kx, lx, ky, ly, clevel, xgrid, ygrid) Java: pls.cont(z, kx, lx, ky, ly, clevel, xgrid, ygrid) Perl/PDL: plcont(z, kx, lx, ky, ly, clevel, pltr, pltr_data) Python: plcont2(z, kx, lx, ky, ly, clevel) This function is used in examples 9,14,16,22. SYNOPSIS: plcont(z, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data) ARGUMENTS: z (PLFLT **, input) : Pointer to a vectored two-dimensional array containing data to be contoured. nx, ny (PLINT, input) : Physical dimensions of array z. kx, lx (PLINT, input) : Range of x indices to consider. ky, ly (PLINT, input) : Range of y indices to consider. clevel (PLFLT *, input) : Pointer to array specifying levels at which to draw contours. nlevel (PLINT, input) : Number of contour levels to draw. pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) : Pointer to function that defines transformation between indices in array z and the world coordinates (C only). Transformation functions are provided in the PLplot library: pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary mappings respectively defined by one- and two-dimensional arrays. In addition, user-supplied routines for the transformation can be used as well. Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of pltr0, pltr1, or pltr2. Note that unlike plshades and similar PLplot functions which have a pltr argument, plcont requires that a transformation function be provided in the C interface. Leaving pltr NULL will result in an error. pltr_data (PLPointer, input) : Extra parameter to help pass information to pltr0, pltr1, pltr2, or whatever routine that is externally supplied.
Definition at line 967 of file plplotc.py.
def plplotc.plcpstrm | ( | args | ) |
Copy state parameters from the reference stream to the current stream DESCRIPTION: Copies state parameters from the reference stream to the current stream. Tell driver interface to map device coordinates unless flags == 1. This function is used for making save files of selected plots (e.g. from the TK driver). After initializing, you can get a copy of the current plot to the specified device by switching to this stream and issuing a plcpstrm and a plreplot, with calls to plbop and pleop as appropriate. The plot buffer must have previously been enabled (done automatically by some display drivers, such as X). Redacted form: plcpstrm(iplsr, flags) This function is used in example 1,20. SYNOPSIS: plcpstrm(iplsr, flags) ARGUMENTS: iplsr (PLINT, input) : Number of reference stream. flags (PLBOOL, input) : If flags is set to true the device coordinates are not copied from the reference to current stream.
Definition at line 1040 of file plplotc.py.
def plplotc.plctime | ( | args | ) |
Definition at line 1036 of file plplotc.py.
def plplotc.plend | ( | ) |
End plotting session DESCRIPTION: Ends a plotting session, tidies up all the output files, switches interactive devices back into text mode and frees up any memory that was allocated. Must be called before end of program. By default, PLplot's interactive devices (Xwin, TK, etc.) go into a wait state after a call to plend or other functions which trigger the end of a plot page. To avoid this, use the plspause function. Redacted form: plend() This function is used in all of the examples. SYNOPSIS: plend()
Definition at line 1077 of file plplotc.py.
def plplotc.plend1 | ( | ) |
End plotting session for current stream DESCRIPTION: Ends a plotting session for the current output stream only. See plsstrm for more info. Redacted form: plend1() This function is used in examples 1,20. SYNOPSIS: plend1()
Definition at line 1104 of file plplotc.py.
def plplotc.plenv | ( | args | ) |
Set up standard window and draw box DESCRIPTION: Sets up plotter environment for simple graphs by calling pladv and setting up viewport and window to sensible default values. plenv leaves enough room around most graphs for axis labels and a title. When these defaults are not suitable, use the individual routines plvpas, plvpor, or plvasp for setting up the viewport, plwind for defining the window, and plbox for drawing the box. Redacted form: plenv(xmin, xmax, ymin, ymax, just, axis) This function is used in example 1,3,9,13,14,19-22,29. SYNOPSIS: plenv(xmin, xmax, ymin, ymax, just, axis) ARGUMENTS: xmin (PLFLT, input) : Value of x at left-hand edge of window (in world coordinates). xmax (PLFLT, input) : Value of x at right-hand edge of window (in world coordinates). ymin (PLFLT, input) : Value of y at bottom edge of window (in world coordinates). ymax (PLFLT, input) : Value of y at top edge of window (in world coordinates). just (PLINT, input) : Controls how the axes will be scaled: -1: the scales will not be set, the user must set up the scale before calling plenv using plsvpa, plvasp or other. 0: the x and y axes are scaled independently to use as much of the screen as possible. 1: the scales of the x and y axes are made equal. 2: the axis of the x and y axes are made equal, and the plot box will be square. axis (PLINT, input) : Controls drawing of the box around the plot: -2: draw no box, no tick marks, no numeric tick labels, no axes. -1: draw box only. 0: draw box, ticks, and numeric tick labels. 1: also draw coordinate axes at x=0 and y=0. 2: also draw a grid at major tick positions in both coordinates. 3: also draw a grid at minor tick positions in both coordinates. 10: same as 0 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 11: same as 1 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 12: same as 2 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 13: same as 3 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 20: same as 0 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 21: same as 1 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 22: same as 2 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 23: same as 3 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 30: same as 0 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 31: same as 1 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 32: same as 2 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 33: same as 3 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 40: same as 0 except date / time x labels. 41: same as 1 except date / time x labels. 42: same as 2 except date / time x labels. 43: same as 3 except date / time x labels. 50: same as 0 except date / time y labels. 51: same as 1 except date / time y labels. 52: same as 2 except date / time y labels. 53: same as 3 except date / time y labels. 60: same as 0 except date / time x and y labels. 61: same as 1 except date / time x and y labels. 62: same as 2 except date / time x and y labels. 63: same as 3 except date / time x and y labels. 70: same as 0 except custom x and y labels. 71: same as 1 except custom x and y labels. 72: same as 2 except custom x and y labels. 73: same as 3 except custom x and y labels.
Definition at line 1126 of file plplotc.py.
def plplotc.plenv0 | ( | args | ) |
Same as plenv but if in multiplot mode does not advance the subpage, instead clears it. DESCRIPTION: Sets up plotter environment for simple graphs by calling pladv and setting up viewport and window to sensible default values. plenv0 leaves enough room around most graphs for axis labels and a title. When these defaults are not suitable, use the individual routines plvpas, plvpor, or plvasp for setting up the viewport, plwind for defining the window, and plbox for drawing the box. Redacted form: plenv0(xmin, xmax, ymin, ymax, just, axis) This function is used in example 21. SYNOPSIS: plenv0(xmin, xmax, ymin, ymax, just, axis) ARGUMENTS: xmin (PLFLT, input) : Value of x at left-hand edge of window (in world coordinates). xmax (PLFLT, input) : Value of x at right-hand edge of window (in world coordinates). ymin (PLFLT, input) : Value of y at bottom edge of window (in world coordinates). ymax (PLFLT, input) : Value of y at top edge of window (in world coordinates). just (PLINT, input) : Controls how the axes will be scaled: -1: the scales will not be set, the user must set up the scale before calling plenv0 using plsvpa, plvasp or other. 0: the x and y axes are scaled independently to use as much of the screen as possible. 1: the scales of the x and y axes are made equal. 2: the axis of the x and y axes are made equal, and the plot box will be square. axis (PLINT, input) : Controls drawing of the box around the plot: -2: draw no box, no tick marks, no numeric tick labels, no axes. -1: draw box only. 0: draw box, ticks, and numeric tick labels. 1: also draw coordinate axes at x=0 and y=0. 2: also draw a grid at major tick positions in both coordinates. 3: also draw a grid at minor tick positions in both coordinates. 10: same as 0 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 11: same as 1 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 12: same as 2 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 13: same as 3 except logarithmic x tick marks. (The x data have to be converted to logarithms separately.) 20: same as 0 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 21: same as 1 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 22: same as 2 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 23: same as 3 except logarithmic y tick marks. (The y data have to be converted to logarithms separately.) 30: same as 0 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 31: same as 1 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 32: same as 2 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 33: same as 3 except logarithmic x and y tick marks. (The x and y data have to be converted to logarithms separately.) 40: same as 0 except date / time x labels. 41: same as 1 except date / time x labels. 42: same as 2 except date / time x labels. 43: same as 3 except date / time x labels. 50: same as 0 except date / time y labels. 51: same as 1 except date / time y labels. 52: same as 2 except date / time y labels. 53: same as 3 except date / time y labels. 60: same as 0 except date / time x and y labels. 61: same as 1 except date / time x and y labels. 62: same as 2 except date / time x and y labels. 63: same as 3 except date / time x and y labels. 70: same as 0 except custom x and y labels. 71: same as 1 except custom x and y labels. 72: same as 2 except custom x and y labels. 73: same as 3 except custom x and y labels.
Definition at line 1226 of file plplotc.py.
def plplotc.pleop | ( | ) |
Eject current page DESCRIPTION: Clears the graphics screen of an interactive device, or ejects a page on a plotter. See plbop for more information. Redacted form: pleop() This function is used in example 2,14. SYNOPSIS: pleop()
Definition at line 1326 of file plplotc.py.
def plplotc.plerrx | ( | args | ) |
Draw x error bar DESCRIPTION: Draws a set of n horizontal error bars, the i'th error bar extending from xmin[i] to xmax[i] at y coordinate y[i]. The terminals of the error bar are of length equal to the minor tick length (settable using plsmin). Redacted form: General: plerrx(xmin, ymax, y) Perl/PDL: plerrx(n, xmin, xmax, y) This function is used in example 29. SYNOPSIS: plerrx(n, xmin, xmax, y) ARGUMENTS: n (PLINT, input) : Number of error bars to draw. xmin (PLFLT *, input) : Pointer to array with x coordinates of left-hand endpoint of error bars. xmax (PLFLT *, input) : Pointer to array with x coordinates of right-hand endpoint of error bars. y (PLFLT *, input) : Pointer to array with y coordinates of error bar.
Definition at line 1348 of file plplotc.py.
def plplotc.plerry | ( | args | ) |
Draw y error bar DESCRIPTION: Draws a set of n vertical error bars, the i'th error bar extending from ymin[i] to ymax[i] at x coordinate x[i]. The terminals of the error bar are of length equal to the minor tick length (settable using plsmin). Redacted form: General: plerry(x, ymin, ymax) Perl/PDL: plerry(n, x, ymin, ymax) This function is used in example 29. SYNOPSIS: plerry(n, x, ymin, ymax) ARGUMENTS: n (PLINT, input) : Number of error bars to draw. x (PLFLT *, input) : Pointer to array with x coordinates of error bars. ymin (PLFLT *, input) : Pointer to array with y coordinates of lower endpoint of error bars. ymax (PLFLT *, input) : Pointer to array with y coordinate of upper endpoint of error bar.
Definition at line 1387 of file plplotc.py.
def plplotc.plfamadv | ( | ) |
Advance to the next family file on the next new page DESCRIPTION: Advance to the next family file on the next new page. Redacted form: plfamadv() This function is not used in any examples. SYNOPSIS: plfamadv()
Definition at line 1426 of file plplotc.py.
def plplotc.plfill | ( | args | ) |
Draw filled polygon DESCRIPTION: Fills the polygon defined by the n points ( x[i], y[i]) using the pattern defined by plpsty or plpat. The default fill style is a solid fill. The routine will automatically close the polygon between the last and first vertices. If multiple closed polygons are passed in x and y then plfill will fill in between them. Redacted form: plfill(x,y) This function is used in examples 12,13,15,16,21,24,25. SYNOPSIS: plfill(n, x, y) ARGUMENTS: n (PLINT, input) : Number of vertices in polygon. x (PLFLT *, input) : Pointer to array with x coordinates of vertices. y (PLFLT *, input) : Pointer to array with y coordinates of vertices.
Definition at line 1447 of file plplotc.py.
def plplotc.plfill3 | ( | args | ) |
Draw filled polygon in 3D DESCRIPTION: Fills the 3D polygon defined by the n points in the x, y, and z arrays using the pattern defined by plpsty or plpat. The routine will automatically close the polygon between the last and first vertices. If multiple closed polygons are passed in x, y, and z then plfill3 will fill in between them. Redacted form: General: plfill3(x, y, z) Perl/PDL: plfill3(n, x, y, z) This function is used in example 15. SYNOPSIS: plfill3(n, x, y, z) ARGUMENTS: n (PLINT, input) : Number of vertices in polygon. x (PLFLT *, input) : Pointer to array with x coordinates of vertices. y (PLFLT *, input) : Pointer to array with y coordinates of vertices. z (PLFLT *, input) : Pointer to array with z coordinates of vertices.
Definition at line 1483 of file plplotc.py.
def plplotc.plflush | ( | ) |
Flushes the output stream DESCRIPTION: Flushes the output stream. Use sparingly, if at all. Redacted form: plflush() This function is used in examples 1,14. SYNOPSIS: plflush()
Definition at line 1573 of file plplotc.py.
def plplotc.plfont | ( | args | ) |
Set character font DESCRIPTION: Sets the default character font for subsequent character drawing. Also affects symbols produced by plpoin. This routine has no effect unless the extended character set is loaded (see plfontld). Redacted form: plfont(font) This function is used in examples 1,2,4,7,13,24,26. SYNOPSIS: plfont(font) ARGUMENTS: font (PLINT, input) : Specifies the font: 1: Normal font (simplest and fastest) 2: Roman font 3: Italic font 4: Script font
Definition at line 1594 of file plplotc.py.
def plplotc.plfontld | ( | args | ) |
Load character font DESCRIPTION: Sets the character set to use for subsequent character drawing. May be called before initializing PLplot. Redacted form: plfontld(set) This function is used in examples 1,7. SYNOPSIS: plfontld(set) ARGUMENTS: set (PLINT, input) : Specifies the character set to load: 0: Standard character set 1: Extended character set
Definition at line 1625 of file plplotc.py.
def plplotc.plgchr | ( | ) |
Get character default height and current (scaled) height DESCRIPTION: Get character default height and current (scaled) height. Redacted form: plgchr(p_def, p_ht) This function is used in example 23. SYNOPSIS: plgchr(p_def, p_ht) ARGUMENTS: p_def (PLFLT *, output) : Pointer to default character height (mm). p_ht (PLFLT *, output) : Pointer to current (scaled) character height (mm).
Definition at line 1653 of file plplotc.py.
def plplotc.plgcmap1_range | ( | ) |
Definition at line 4433 of file plplotc.py.
def plplotc.plgcol0 | ( | args | ) |
Returns 8-bit RGB values for given color from color map0 DESCRIPTION: Returns 8-bit RGB values (0-255) for given color from color map0 (see the PLplot documentation). Values are negative if an invalid color id is given. Redacted form: plgcol0(icol0, r, g, b) This function is used in example 2. SYNOPSIS: plgcol0(icol0, r, g, b) ARGUMENTS: icol0 (PLINT, input) : Index of desired cmap0 color. r (PLINT *, output) : Pointer to 8-bit red value. g (PLINT *, output) : Pointer to 8-bit green value. b (PLINT *, output) : Pointer to 8-bit blue value.
Definition at line 1681 of file plplotc.py.
def plplotc.plgcol0a | ( | args | ) |
Returns 8-bit RGB values and double alpha value for given color from color map0. DESCRIPTION: Returns 8-bit RGB values (0-255) and double alpha value (0.0 - 1.0) for given color from color map0 (see the PLplot documentation). Values are negative if an invalid color id is given. This function is used in example 30. SYNOPSIS: plgcol0a(icol0, r, g, b, a) ARGUMENTS: icol0 (PLINT, input) : Index of desired cmap0 color. r (PLINT *, output) : Pointer to 8-bit red value. g (PLINT *, output) : Pointer to 8-bit green value. b (PLINT *, output) : Pointer to 8-bit blue value. a (PLFLT *, output) : Pointer to PLFLT alpha value.
Definition at line 1714 of file plplotc.py.
def plplotc.plgcolbg | ( | ) |
Returns the background color (cmap0[0]) by 8-bit RGB value ESCRIPTION: Returns the background color (cmap0[0]) by 8-bit RGB value. Redacted form: plgcolbg(r, g, b) This function is used in example 31. YNOPSIS: lgcolbg(r, g, b) RGUMENTS: r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of blue in the color.
Definition at line 1747 of file plplotc.py.
def plplotc.plgcolbga | ( | ) |
Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha value. ESCRIPTION: Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha value. This function is used in example 31. YNOPSIS: lgcolbga(r, g, b, a) RGUMENTS: r (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT *, output) : Pointer to an unsigned 8-bit integer (0-255) representing the degree of blue in the color. a (PLFLT *, output) : Pointer to PLFLT alpha value.
Definition at line 1779 of file plplotc.py.
def plplotc.plgcompression | ( | ) |
Get the current device-compression setting DESCRIPTION: Get the current device-compression setting. This parameter is only used for drivers that provide compression. Redacted form: plgcompression(compression) This function is used in example 31. SYNOPSIS: plgcompression(compression) ARGUMENTS: compression (PLINT *, output) : Pointer to a variable to be filled with the current device-compression setting.
Definition at line 1812 of file plplotc.py.
def plplotc.plgdev | ( | ) |
Get the current device (keyword) name DESCRIPTION: Get the current device (keyword) name. Note: you must have allocated space for this (80 characters is safe). Redacted form: plgdev(p_dev) This function is used in example 14. SYNOPSIS: plgdev(p_dev) ARGUMENTS: p_dev (char *, output) : Pointer to device (keyword) name string.
Definition at line 1839 of file plplotc.py.
def plplotc.plgdidev | ( | ) |
Get parameters that define current device-space window DESCRIPTION: Get relative margin width, aspect ratio, and relative justification that define current device-space window. If plsdidev has not been called the default values pointed to by p_mar, p_aspect, p_jx, and p_jy will all be 0. Redacted form: plgdidev(p_mar, p_aspect, p_jx, p_jy) This function is used in example 31. SYNOPSIS: plgdidev(p_mar, p_aspect, p_jx, p_jy) ARGUMENTS: p_mar (PLFLT *, output) : Pointer to relative margin width. p_aspect (PLFLT *, output) : Pointer to aspect ratio. p_jx (PLFLT *, output) : Pointer to relative justification in x. p_jy (PLFLT *, output) : Pointer to relative justification in y.
Definition at line 1865 of file plplotc.py.
def plplotc.plgdiori | ( | ) |
Get plot orientation DESCRIPTION: Get plot orientation parameter which is multiplied by 90 degrees to obtain the angle of rotation. Note, arbitrary rotation parameters such as 0.2 (corresponding to 18 degrees) are possible, but the usual values for the rotation parameter are 0., 1., 2., and 3. corresponding to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees (seascape mode), and 270 degrees (upside-down mode). If plsdiori has not been called the default value pointed to by p_rot will be 0. Redacted form: plgdiori(p_rot) This function is not used in any examples. SYNOPSIS: plgdiori(p_rot) ARGUMENTS: p_rot (PLFLT *, output) : Pointer to orientation parameter.
Definition at line 1899 of file plplotc.py.
def plplotc.plgdiplt | ( | ) |
Get parameters that define current plot-space window DESCRIPTION: Get relative minima and maxima that define current plot-space window. If plsdiplt has not been called the default values pointed to by p_xmin, p_ymin, p_xmax, and p_ymax will be 0., 0., 1., and 1. Redacted form: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax) This function is used in example 31. SYNOPSIS: plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax) ARGUMENTS: p_xmin (PLFLT *, output) : Pointer to relative minimum in x. p_ymin (PLFLT *, output) : Pointer to relative minimum in y. p_xmax (PLFLT *, output) : Pointer to relative maximum in x. p_ymax (PLFLT *, output) : Pointer to relative maximum in y.
Definition at line 1930 of file plplotc.py.
def plplotc.plGetCursor | ( | args | ) |
Definition at line 6960 of file plplotc.py.
def plplotc.plgfam | ( | ) |
Get family file parameters DESCRIPTION: Gets information about current family file, if familying is enabled. See the PLplot documentation for more information. Redacted form: plgfam(fam, num, bmax) This function is used in examples 14,31. SYNOPSIS: plgfam(fam, num, bmax) ARGUMENTS: fam (PLINT *, output) : Pointer to variable with the Boolean family flag value. If nonzero, familying is enabled. num (PLINT *, output) : Pointer to variable with the current family file number. bmax (PLINT *, output) : Pointer to variable with the maximum file size (in bytes) for a family file.
Definition at line 1963 of file plplotc.py.
def plplotc.plgfci | ( | ) |
Get FCI (font characterization integer) DESCRIPTION: Gets information about the current font using the FCI approach. See the PLplot documentation for more information. Redacted form: plgfci(fci) This function is used in example 23. SYNOPSIS: plgfci(fci) ARGUMENTS: fci (PLUNICODE *, output) : Pointer to PLUNICODE (unsigned 32-bit integer) variable which is updated with current FCI value.
Definition at line 1996 of file plplotc.py.
def plplotc.plgfnam | ( | ) |
Get output file name DESCRIPTION: Gets the current output file name, if applicable. Redacted form: plgfnam(fnam) This function is used in example 31. SYNOPSIS: plgfnam(fnam) ARGUMENTS: fnam (char *, output) : Pointer to file name string (a preallocated string of 80 characters or more).
Definition at line 2023 of file plplotc.py.
def plplotc.plgfont | ( | ) |
Get family, style and weight of the current font DESCRIPTION: Gets information about current font. See the PLplot documentation for more information on font selection. Redacted form: plgfont(p_family, p_style, p_weight) This function is used in example 23. SYNOPSIS: plgfont(p_family, p_style, p_weight) ARGUMENTS: p_family (PLINT *, output) : Pointer to variable with the current font family. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. If p_family is NULL then the font family is not returned. p_style (PLINT *, output) : Pointer to variable with the current font style. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and PL_FCI_OBLIQUE. If p_style is NULL then the font style is not returned. p_weight (PLINT *, output) : Pointer to variable with the current font weight. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. If p_weight is NULL then the font weight is not returned.
Definition at line 2049 of file plplotc.py.
def plplotc.plglevel | ( | ) |
Get the (current) run level DESCRIPTION: Get the (current) run level. Valid settings are: 0, uninitialized 1, initialized 2, viewport defined 3, world coordinates defined Redacted form: plglevel(p_level) This function is used in example 31. SYNOPSIS: plglevel(p_level) ARGUMENTS: p_level (PLINT *, output) : Pointer to the run level.
Definition at line 2091 of file plplotc.py.
def plplotc.plgpage | ( | ) |
Get page parameters DESCRIPTION: Gets the current page configuration. The length and offset values are expressed in units that are specific to the current driver. For instance: screen drivers will usually interpret them as number of pixels, whereas printer drivers will usually use mm. Redacted form: plgpage(xp, yp, xleng, yleng, xoff, yoff) This function is used in examples 14 and 31. SYNOPSIS: plgpage(xp, yp, xleng, yleng, xoff, yoff) ARGUMENTS: xp (PLFLT *, output) : Pointer to number of pixels/inch (DPI), x. yp (PLFLT *, output) : Pointer to number of pixels/inch (DPI) in y. xleng (PLINT *, output) : Pointer to x page length value. yleng (PLINT *, output) : Pointer to y page length value. xoff (PLINT *, output) : Pointer to x page offset. yoff (PLINT *, output) : Pointer to y page offset.
Definition at line 2120 of file plplotc.py.
def plplotc.plgra | ( | ) |
Switch to graphics screen DESCRIPTION: Sets an interactive device to graphics mode, used in conjunction with pltext to allow graphics and text to be interspersed. On a device which supports separate text and graphics windows, this command causes control to be switched to the graphics window. If already in graphics mode, this command is ignored. It is also ignored on devices which only support a single window or use a different method for shifting focus. See also pltext. Redacted form: plgra() This function is used in example 1. SYNOPSIS: plgra()
Definition at line 2158 of file plplotc.py.
def plplotc.plgradient | ( | args | ) |
Draw linear gradient inside polygon DESCRIPTION: Draw a linear gradient using colour map 1 inside the polygon defined by the n points ( x[i], y[i]). Interpretation of the polygon is the same as for plfill. The polygon coordinates and the gradient angle are all expressed in world coordinates. The angle from the x axis for both the rotated coordinate system and the gradient vector is specified by angle. The magnitude of the gradient vector is the difference between the maximum and minimum values of x for the vertices in the rotated coordinate system. The origin of the gradient vector can be interpreted as being anywhere on the line corresponding to the minimum x value for the vertices in the rotated coordinate system. The distance along the gradient vector is linearly transformed to the independent variable of colour map 1 which ranges from 0. at the tail of the gradient vector to 1. at the head of the gradient vector. What is drawn is the RGBA colour corresponding to the independent variable of colour map 1. For more information about colour map 1 (see the PLplot documentation). Redacted form: plgradient(x,y,angle) This function is used in examples 25,30. SYNOPSIS: plgradient(n, x, y, angle) ARGUMENTS: n (PLINT, input) : Number of vertices in polygon. x (PLFLT *, input) : Pointer to array with x coordinates of vertices. y (PLFLT *, input) : Pointer to array with y coordinates of vertices. angle (PLFLT, input) : Angle (degrees) of gradient vector from x axis.
Definition at line 1523 of file plplotc.py.
def plplotc.plgriddata | ( | args | ) |
Grid data from irregularly sampled data DESCRIPTION: Real world data is frequently irregularly sampled, but all PLplot 3D plots require data placed in a uniform grid. This function takes irregularly sampled data from three input arrays x[npts], y[npts], and z[npts], reads the desired grid location from input arrays xg[nptsx] and yg[nptsy], and returns the gridded data into output array zg[nptsx][nptsy]. The algorithm used to grid the data is specified with the argument type which can have one parameter specified in argument data. Redacted form: General: plgriddata(x, y, z, xg, yg, zg, type, data) Perl/PDL: Not available? Python: zg=plgriddata(x, y, z, xg, yg, type, data) This function is used in example 21. SYNOPSIS: plggriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data) ARGUMENTS: x (PLFLT *, input) : The input x array. y (PLFLT *, input) : The input y array. z (PLFLT *, input) : The input z array. Each triple x[i], y[i], z[i] represents one data sample coordinate. npts (PLINT, input) : The number of data samples in the x, y and z arrays. xg (PLFLT *, input) : The input array that specifies the grid spacing in the x direction. Usually xg has nptsx equally spaced values from the minimum to the maximum values of the x input array. nptsx (PLINT, input) : The number of points in the xg array. yg (PLFLT *, input) : The input array that specifies the grid spacing in the y direction. Similar to the xg parameter. nptsy (PLINT, input) : The number of points in the yg array. zg (PLFLT **, output) : The output array, where data lies in the regular grid specified by xg and yg. the zg array must exist or be allocated by the user prior to the call, and must have dimension zg[nptsx][nptsy]. type (PLINT, input) : The type of gridding algorithm to use, which can be: GRID_CSA: Bivariate Cubic Spline approximation GRID_DTLI: Delaunay Triangulation Linear Interpolation GRID_NNI: Natural Neighbors Interpolation GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted GRID_NNLI: Nearest Neighbors Linear Interpolation GRID_NNAIDW: Nearest Neighbors Around Inverse Distance Weighted For details of the algorithms read the source file plgridd.c. data (PLFLT, input) : Some gridding algorithms require extra data, which can be specified through this argument. Currently, for algorithm: GRID_NNIDW, data specifies the number of neighbors to use, the lower the value, the noisier (more local) the approximation is. GRID_NNLI, data specifies what a thin triangle is, in the range [1. .. 2.]. High values enable the usage of very thin triangles for interpolation, possibly resulting in error in the approximation. GRID_NNI, only weights greater than data will be accepted. If 0, all weights will be accepted.
Definition at line 2185 of file plplotc.py.
def plplotc.plgspa | ( | ) |
Get current subpage parameters DESCRIPTION: Gets the size of the current subpage in millimeters measured from the bottom left hand corner of the output device page or screen. Can be used in conjunction with plsvpa for setting the size of a viewport in absolute coordinates (millimeters). Redacted form: plgspa(xmin, xmax, ymin, ymax) This function is used in example 23. SYNOPSIS: plgspa(xmin, xmax, ymin, ymax) ARGUMENTS: xmin (PLFLT *, output) : Pointer to variable with position of left hand edge of subpage in millimeters. xmax (PLFLT *, output) : Pointer to variable with position of right hand edge of subpage in millimeters. ymin (PLFLT *, output) : Pointer to variable with position of bottom edge of subpage in millimeters. ymax (PLFLT *, output) : Pointer to variable with position of top edge of subpage in millimeters.
Definition at line 2267 of file plplotc.py.
def plplotc.plgstrm | ( | ) |
Get current stream number DESCRIPTION: Gets the number of the current output stream. See also plsstrm. Redacted form: plgstrm(strm) This function is used in example 1,20. SYNOPSIS: plgstrm(strm) ARGUMENTS: strm (PLINT *, output) : Pointer to current stream value.
Definition at line 2305 of file plplotc.py.
def plplotc.plgver | ( | ) |
Get the current library version number DESCRIPTION: Get the current library version number. Note: you must have allocated space for this (80 characters is safe). Redacted form: plgver(p_ver) This function is used in example 1. SYNOPSIS: plgver(p_ver) ARGUMENTS: p_ver (char *, output) : Pointer to the current library version number.
Definition at line 2330 of file plplotc.py.
def plplotc.plgvpd | ( | ) |
Get viewport limits in normalized device coordinates DESCRIPTION: Get viewport limits in normalized device coordinates. Redacted form: General: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax) Perl/PDL: Not available? This function is used in example 31. SYNOPSIS: plgvpd(p_xmin, p_xmax, p_ymin, p_ymax) ARGUMENTS: p_xmin (PLFLT *, output) : Lower viewport limit of the normalized device coordinate in x. p_xmax (PLFLT *, output) : Upper viewport limit of the normalized device coordinate in x. p_ymin (PLFLT *, output) : Lower viewport limit of the normalized device coordinate in y. p_ymax (PLFLT *, output) : Upper viewport limit of the normalized device coordinate in y.
Definition at line 2357 of file plplotc.py.
def plplotc.plgvpw | ( | ) |
Get viewport limits in world coordinates DESCRIPTION: Get viewport limits in world coordinates. Redacted form: General: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax) Perl/PDL: Not available? This function is used in example 31. SYNOPSIS: plgvpw(p_xmin, p_xmax, p_ymin, p_ymax) ARGUMENTS: p_xmin (PLFLT *, output) : Lower viewport limit of the world coordinate in x. p_xmax (PLFLT *, output) : Upper viewport limit of the world coordinate in x. p_ymin (PLFLT *, output) : Lower viewport limit of the world coordinate in y. p_ymax (PLFLT *, output) : Upper viewport limit of the world coordinate in y.
Definition at line 2394 of file plplotc.py.
def plplotc.plgxax | ( | ) |
Get x axis parameters DESCRIPTION: Returns current values of the digmax and digits flags for the x axis. digits is updated after the plot is drawn, so this routine should only be called after the call to plbox (or plbox3) is complete. See the PLplot documentation for more information. Redacted form: plgxax(digmax, digits) This function is used in example 31. SYNOPSIS: plgxax(digmax, digits) ARGUMENTS: digmax (PLINT *, output) : Pointer to variable with the maximum number of digits for the x axis. If nonzero, the printed label has been switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT *, output) : Pointer to variable with the actual number of digits for the numeric labels (x axis) from the last plot.
Definition at line 2431 of file plplotc.py.
def plplotc.plgyax | ( | ) |
Get y axis parameters DESCRIPTION: Identical to plgxax, except that arguments are flags for y axis. See the description of plgxax for more detail. Redacted form: plgyax(digmax, digits) This function is used in example 31. SYNOPSIS: plgyax(digmax, digits) ARGUMENTS: digmax (PLINT *, output) : Pointer to variable with the maximum number of digits for the y axis. If nonzero, the printed label has been switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT *, output) : Pointer to variable with the actual number of digits for the numeric labels (y axis) from the last plot.
Definition at line 2466 of file plplotc.py.
def plplotc.plgzax | ( | ) |
Get z axis parameters DESCRIPTION: Identical to plgxax, except that arguments are flags for z axis. See the description of plgxax for more detail. Redacted form: plgzax(digmax, digits) This function is used in example 31. SYNOPSIS: plgzax(digmax, digits) ARGUMENTS: digmax (PLINT *, output) : Pointer to variable with the maximum number of digits for the z axis. If nonzero, the printed label has been switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT *, output) : Pointer to variable with the actual number of digits for the numeric labels (z axis) from the last plot.
Definition at line 2499 of file plplotc.py.
def plplotc.plhist | ( | args | ) |
Plot a histogram from unbinned data DESCRIPTION: Plots a histogram from n data points stored in the array data. This routine bins the data into nbin bins equally spaced between datmin and datmax, and calls plbin to draw the resulting histogram. Parameter opt allows, among other things, the histogram either to be plotted in an existing window or causes plhist to call plenv with suitable limits before plotting the histogram. Redacted form: plhist(data, datmin, datmax, nbin, opt) This function is used in example 5. SYNOPSIS: plhist(n, data, datmin, datmax, nbin, opt) ARGUMENTS: n (PLINT, input) : Number of data points. data (PLFLT *, input) : Pointer to array with values of the n data points. datmin (PLFLT, input) : Left-hand edge of lowest-valued bin. datmax (PLFLT, input) : Right-hand edge of highest-valued bin. nbin (PLINT, input) : Number of (equal-sized) bins into which to divide the interval xmin to xmax. opt (PLINT, input) : Is a combination of several flags: opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit the histogram data, the outer bins are expanded to fill up the entire x-axis, data outside the given extremes are assigned to the outer bins and bins of zero height are simply drawn. opt=PL_HIST_NOSCALING|...: The existing axes are not rescaled to fit the histogram data, without this flag, plenv is called to set the world coordinates. opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given extremes are not taken into account. This option should probably be combined with opt=PL_HIST_NOEXPAND|..., so as to properly present the data. opt=PL_HIST_NOEXPAND|...: The outer bins are drawn with equal size as the ones inside. opt=PL_HIST_NOEMPTY|...: Bins with zero height are not drawn (there is a gap for such bins).
Definition at line 2532 of file plplotc.py.
def plplotc.plhlsrgb | ( | args | ) |
Convert HLS color to RGB DESCRIPTION: Convert HLS color coordinates to RGB. Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b) Perl/PDL: Not available? Implemented as plhls? This function is used in example 2. SYNOPSIS: plhlsrgb(h, l, s, p_r, p_g, p_b) ARGUMENTS: h (PLFLT, input) : Hue, in degrees on the colour cone (0.0-360.0) l (PLFLT, input) : Lightness, expressed as a fraction of the axis of the colour cone (0.0-1.0) s (PLFLT, input) : Saturation, expressed as a fraction of the radius of the colour cone (0.0-1.0) p_r (PLFLT *, output) : Pointer to red intensity (0.0-1.0) of the colour p_g (PLFLT *, output) : Pointer to green intensity (0.0-1.0) of the colour p_b (PLFLT *, output) : Pointer to blue intensity (0.0-1.0) of the colour
Definition at line 2589 of file plplotc.py.
def plplotc.plimage | ( | args | ) |
Plot a 2D matrix using color map1 with automatic colour adjustment DESCRIPTION: Plot a 2D matrix using color palette 1. The color scale is automatically adjusted to use the maximum and minimum values in idata as valuemin and valuemax in a call to plimagefr. Redacted form: General: plimage(idata, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax) This function is used in example 20. SYNOPSIS: plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax) ARGUMENTS: idata (PLFLT**, input) : A 2D array of values (intensities) to plot. Should have dimensions idata[nx][ny]. nx, ny (PLINT, input) : Dimensions of idata xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to strecth the image data to. idata[0][0] corresponds to (xmin, ymin) and idata[nx - 1][ny - 1] corresponds to (xmax, ymax). zmin, zmax (PLFLT, input) : Only data between zmin and zmax (inclusive) will be plotted. Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of points whose plot coordinates fall inside the window of (Dxmin, Dymin) to (Dxmax, Dymax).
Definition at line 6836 of file plplotc.py.
def plplotc.plimagefr | ( | args | ) |
Plot a 2D matrix using color map1 DESCRIPTION: Plot a 2D matrix using color map1. Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data) This function is used in example 20. SYNOPSIS: plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data) ARGUMENTS: idata (PLFLT**, input) : A 2D array of values (intensities) to plot. Should have dimensions idata[nx][ny]. nx, ny (PLINT, input) : Dimensions of idata xmin, xmax, ymin, ymax (PLFLT, input) : Stretch image data to these Plot coordinates. idata[0][0] corresponds to (xmin, ymin) and idata[nx - 1][ny - 1] corresponds to (xmax, ymax). zmin, zmax (PLFLT, input) : Only data between zmin and zmax (inclusive) will be plotted. valuemin, valuemax (PLFLT, input) : The minimum and maximum data values to use for value to color mappings. A datum equal to or less than valuemin will be plotted with color 0.0, while a datum equal to or greater than valuemax will be plotted with color 1.0. Data between valuemin and valuemax map linearly to colors between 0.0 and 1.0. pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) : Pointer to function that defines a transformation between the data in the array idata and world coordinates. An input coordinate of (0, 0) corresponds to the "top-left" corner of idata while (nx, ny) corresponds to the "bottom-right" corner of idata. Some transformation functions are provided in the PLplot library: pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary mappings respectively defined by one- and two-dimensional arrays. In addition, user-supplied routines for the transformation can be used as well. Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of pltr0, pltr1, or pltr2. pltr_data (PLPointer, input) : Extra parameter to help pass information to pltr0, pltr1, pltr2, or whatever routine is externally supplied.
Definition at line 6879 of file plplotc.py.
def plplotc.plinit | ( | ) |
Initialize PLplot DESCRIPTION: Initializing the plotting package. The program prompts for the device keyword or number of the desired output device. Hitting a RETURN in response to the prompt is the same as selecting the first device. plinit will issue no prompt if either the device was specified previously (via command line flag, the plsetopt function, or the plsdev function), or if only one device is enabled when PLplot is installed. If subpages have been specified, the output device is divided into nx by ny subpages, each of which may be used independently. If plinit is called again during a program, the previously opened file will be closed. The subroutine pladv is used to advance from one subpage to the next. Redacted form: plinit() This function is used in all of the examples. SYNOPSIS: plinit()
Definition at line 2631 of file plplotc.py.
def plplotc.pljoin | ( | args | ) |
Draw a line between two points DESCRIPTION: Joins the point ( x1, y1) to ( x2, y2). Redacted form: pljoin(x1,y1,x2,y2) This function is used in examples 3,14. SYNOPSIS: pljoin(x1, y1, x2, y2) ARGUMENTS: x1 (PLFLT, input) : x coordinate of first point. y1 (PLFLT, input) : y coordinate of first point. x2 (PLFLT, input) : x coordinate of second point. y2 (PLFLT, input) : y coordinate of second point.
Definition at line 2662 of file plplotc.py.
def plplotc.pllab | ( | args | ) |
Simple routine to write labels DESCRIPTION: Routine for writing simple labels. Use plmtex for more complex labels. Redacted form: pllab(xlabel, ylabel, tlabel) This function is used in examples 1,5,9,12,14-16,20-22,29. SYNOPSIS: pllab(xlabel, ylabel, tlabel) ARGUMENTS: xlabel (const char *, input) : Label for horizontal axis. ylabel (const char *, input) : Label for vertical axis. tlabel (const char *, input) : Title of graph.
Definition at line 2697 of file plplotc.py.
def plplotc.pllegend | ( | args | ) |
Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols DESCRIPTION: Routine for creating a discrete plot legend with a plotted filled box, line, and/or line of symbols for each annotated legend entry. The arguments of pllegend provide control over the location and size of the legend as well as the location and characteristics of the elements (most of which are optional) within that legend. The resulting legend is clipped at the boundaries of the current subpage. (N.B. the adopted coordinate system used for some of the parameters is defined in the documentation of the position parameter.) Redacted form: pllegend(p_legend_width, p_legend_height, opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, 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) This function is used in examples 4 and 26. SYNOPSIS: 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) ARGUMENTS: p_legend_width (PLFLT *, output) : Pointer to a location which contains (after the call) the legend width in adopted coordinates. This quantity is calculated from plot_width, text_offset, ncolumn (possibly modified inside the routine depending on nlegend and nrow), and the length (calculated internally) of the longest text string. p_legend_height (PLFLT *, output) : Pointer to a location which contains (after the call) the legend height in adopted coordinates. This quantity is calculated from text_scale, text_spacing, and nrow (possibly modified inside the routine depending on nlegend and nrow). opt (PLINT, input) : opt contains bits controlling the overall legend. If the PL_LEGEND_TEXT_LEFT bit is set, put the text area on the left of the legend and the plotted area on the right. Otherwise, put the text area on the right of the legend and the plotted area on the left. If the PL_LEGEND_BACKGROUND bit is set, plot a (semi-transparent) background for the legend. If the PL_LEGEND_BOUNDING_BOX bit is set, plot a bounding box for the legend. If the PL_LEGEND_ROW_MAJOR bit is set and (both of the possibly internally transformed) nrow > 1 and ncolumn > 1, then plot the resulting array of legend entries in row-major order. Otherwise, plot the legend entries in column-major order. position (PLINT, input) : position contains bits controlling the overall position of the legend and the definition of the adopted coordinates used for positions. The combination of the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM, PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of the 16 possible standard positions (the 4 corners and 4 side centers for both the inside and outside cases) of the legend relative to the adopted coordinate system. The adopted coordinates are normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is set or normalized subpage coordinates if the PL_POSITION_SUBPAGE bit is set. Default position bits: If none of PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set, then use the combination of PL_POSITION_RIGHT and PL_POSITION_TOP. If neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set, use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT. x (PLFLT, input) : X offset of the legend position in adopted coordinates from the specified standard position of the legend. For positive x, the direction of motion away from the standard position is inward/outward from the standard corner positions or standard left or right positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. For the standard top or bottom positions, the direction of motion is toward positive X. y (PLFLT, input) : Y offset of the legend position in adopted coordinates from the specified standard position of the legend. For positive y, the direction of motion away from the standard position is inward/outward from the standard corner positions or standard top or bottom positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit is set in position. For the standard left or right positions, the direction of motion is toward positive Y. plot_width (PLFLT, input) : Horizontal width in adopted coordinates of the plot area (where the colored boxes, lines, and/or lines of symbols are drawn) of the legend. bg_color (PLINT, input) : The cmap0 index of the background color for the legend (PL_LEGEND_BACKGROUND). bb_color (PLINT, input) : The cmap0 index of the color of the bounding-box line for the legend (PL_LEGEND_BOUNDING_BOX). bb_style (PLINT, input) : The cmap0 index of the background color for the legend (PL_LEGEND_BACKGROUND). nrow (PLINT, input) : The cmap0 index of the background color for the legend (PL_LEGEND_BACKGROUND). ncolumn (PLINT, input) : The cmap0 index of the background color for the legend (PL_LEGEND_BACKGROUND). nlegend (PLINT, input) : Number of legend entries. N.B. The total vertical height of the legend in adopted coordinates is calculated internally from nlegend, text_scale (see below), and text_spacing (see below). opt_array (const PLINT *, input) : Array of nlegend values of options to control each individual plotted area corresponding to a legend entry. If the PL_LEGEND_NONE bit is set, then nothing is plotted in the plotted area. If the PL_LEGEND_COLOR_BOX, PL_LEGEND_LINE, and/or PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend entry is plotted with a colored box; a line; and/or a line of symbols. text_offset (PLFLT, input) : Offset of the text area from the plot area in units of character width. N.B. The total horizontal width of the legend in adopted coordinates is calculated internally from plot_width (see above), text_offset, and length (calculated internally) of the longest text string. text_scale (PLFLT, input) : Character height scale for text annotations. N.B. The total vertical height of the legend in adopted coordinates is calculated internally from nlegend (see above), text_scale, and text_spacing (see below). text_spacing (PLFLT, input) : Vertical spacing in units of the character height from one legend entry to the next. N.B. The total vertical height of the legend in adopted coordinates is calculated internally from nlegend (see above), text_scale (see above), and text_spacing. text_justification (PLFLT, input) : Justification parameter used for text justification. The most common values of text_justification are 0., 0.5, or 1. corresponding to a text that is left justified, centred, or right justified within the text area, but other values are allowed as well. text_colors (const PLINT *, input) : Array of nlegend text colors (cmap0 indices). text (const char **, input) : Array of nlegend text string annotations. box_colors (const PLINT *, input) : Array of nlegend colors (cmap0 indices) for the discrete colored boxes ( PL_LEGEND_COLOR_BOX). box_patterns (const PLINT *, input) : Array of nlegend patterns (plpsty indices) for the discrete colored boxes ( PL_LEGEND_COLOR_BOX). box_scales (const PLFLT *, input) : Array of nlegend scales (units of fraction of character height) for the height of the discrete colored boxes ( PL_LEGEND_COLOR_BOX). box_line_widths (const PLFLT *, input) : Array of nlegend line widths for the patterns specified by box_patterns ( PL_LEGEND_COLOR_BOX). line_colors (const PLINT *, input) : Array of nlegend line colors (cmap0 indices) ( PL_LEGEND_LINE). line_styles (const PLINT *, input) : Array of nlegend line styles (plsty indices) ( PL_LEGEND_LINE). line_widths (const PLFLT *, input) : Array of nlegend line widths ( PL_LEGEND_LINE). symbol_colors (const PLINT *, input) : Array of nlegend symbol colors (cmap0 indices) ( PL_LEGEND_SYMBOL). symbol_scales (const PLFLT *, input) : Array of nlegend scale values for the symbol height ( PL_LEGEND_SYMBOL). symbol_numbers (const PLINT *, input) : Array of nlegend numbers of symbols to be drawn across the width of the plotted area ( PL_LEGEND_SYMBOL). symbols (const char **, input) : Array of nlegend symbols (plpoin indices) ( PL_LEGEND_SYMBOL).
Definition at line 2726 of file plplotc.py.
def plplotc.pllightsource | ( | args | ) |
Sets the 3D position of the light source DESCRIPTION: Sets the 3D position of the light source for use with plsurf3d. Redacted form: pllightsource(x, y, z) This function is used in example 8. SYNOPSIS: pllightsource(x, y, z) ARGUMENTS: x (PLFLT, input) : X-coordinate of the light source. y (PLFLT, input) : Y-coordinate of the light source. z (PLFLT, input) : Z-coordinate of the light source.
Definition at line 2940 of file plplotc.py.
def plplotc.plline | ( | args | ) |
Draw a line DESCRIPTION: Draws line defined by n points in x and y. Redacted form: plline(x, y) This function is used in examples 1,3,4,9,12-14,16,18,20,22,25-27,29. SYNOPSIS: plline(n, x, y) ARGUMENTS: n (PLINT, input) : Number of points defining line. x (PLFLT *, input) : Pointer to array with x coordinates of points. y (PLFLT *, input) : Pointer to array with y coordinates of points.
Definition at line 2969 of file plplotc.py.
def plplotc.plline3 | ( | args | ) |
Draw a line in 3 space DESCRIPTION: Draws line in 3 space defined by n points in x, y, and z. You must first set up the viewport, the 2d viewing window (in world coordinates), and the 3d normalized coordinate box. See x18c.c for more info. Redacted form: plline3(x, y, z) This function is used in example 18. SYNOPSIS: plline3(n, x, y, z) ARGUMENTS: n (PLINT, input) : Number of points defining line. x (PLFLT *, input) : Pointer to array with x coordinates of points. y (PLFLT *, input) : Pointer to array with y coordinates of points. z (PLFLT *, input) : Pointer to array with z coordinates of points.
Definition at line 2998 of file plplotc.py.
def plplotc.pllsty | ( | args | ) |
Select line style DESCRIPTION: This sets the line style according to one of eight predefined patterns (also see plstyl). Redacted form: pllsty(n) This function is used in examples 9,12,22,25. SYNOPSIS: pllsty(n) ARGUMENTS: n (PLINT, input) : Integer value between 1 and 8. Line style 1 is a continuous line, line style 2 is a line with short dashes and gaps, line style 3 is a line with long dashes and gaps, line style 4 has long dashes and short gaps and so on.
Definition at line 3032 of file plplotc.py.
def plplotc.plmap | ( | args | ) |
Plot continental outline in world coordinates. DESCRIPTION: Plots continental outlines in world coordinates. examples/c/x19c demonstrates how to use this function to create different projections. Redacted form: General: plmap(mapform, type, minlong, maxlong, minlat, maxlat) F95, Java, Perl/PDL, Python: Not implemented? This function is used in example 19. SYNOPSIS: plmap(mapform, type, minlong, maxlong, minlat, maxlat) ARGUMENTS: mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user supplied function to transform the coordinate longitudes and latitudes to a plot coordinate system. By using this transform, we can change from a longitude, latitude coordinate to a polar stereographic project, for example. Initially, x[0]..[n-1] are the longitudes and y[0]..y[n-1] are the corresponding latitudes. After the call to mapform(), x[] and y[] should be replaced by the corresponding plot coordinates. If no transform is desired, mapform can be replaced by NULL. type (char *, input) : type is a character string. The value of this parameter determines the type of background. The possible values are: "globe" -- continental outlines "usa" -- USA and state boundaries "cglobe" -- continental outlines and countries "usaglobe" -- USA, state boundaries and continental outlines minlong (PLFLT, input) : The value of the longitude on the left side of the plot. The value of minlong must be less than the value of maxlong, and the quantity maxlong-minlong must be less than or equal to 360. maxlong (PLFLT, input) : The value of the longitude on the right side of the plot. minlat (PLFLT, input) : The minimum latitude to be plotted on the background. One can always use -90.0 as the boundary outside the plot window will be automatically eliminated. However, the program will be faster if one can reduce the size of the background plotted. maxlat (PLFLT, input) : The maximum latitudes to be plotted on the background. One can always use 90.0 as the boundary outside the plot window will be automatically eliminated.
Definition at line 6711 of file plplotc.py.
def plplotc.plmeridians | ( | args | ) |
Plot latitude and longitude lines. DESCRIPTION: Displays latitude and longitude on the current plot. The lines are plotted in the current color and line style. Redacted form: General: plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat) F95, Java, Perl/PDL, Python: Not implemented? This function is used in example 19. SYNOPSIS: plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat) ARGUMENTS: mapform (void (*) (PLINT, PLFLT *, PLFLT *), input) : A user supplied function to transform the coordinate longitudes and latitudes to a plot coordinate system. By using this transform, we can change from a longitude, latitude coordinate to a polar stereographic project, for example. Initially, x[0]..[n-1] are the longitudes and y[0]..y[n-1] are the corresponding latitudes. After the call to mapform(), x[] and y[] should be replaced by the corresponding plot coordinates. If no transform is desired, mapform can be replaced by NULL. dlong (PLFLT, input) : The interval in degrees at which the longitude lines are to be plotted. dlat (PLFLT, input) : The interval in degrees at which the latitude lines are to be plotted. minlong (PLFLT, input) : The value of the longitude on the left side of the plot. The value of minlong must be less than the value of maxlong, and the quantity maxlong-minlong must be less than or equal to 360. maxlong (PLFLT, input) : The value of the longitude on the right side of the plot. minlat (PLFLT, input) : The minimum latitude to be plotted on the background. One can always use -90.0 as the boundary outside the plot window will be automatically eliminated. However, the program will be faster if one can reduce the size of the background plotted. maxlat (PLFLT, input) : The maximum latitudes to be plotted on the background. One can always use 90.0 as the boundary outside the plot window will be automatically eliminated.
Definition at line 6775 of file plplotc.py.
def plplotc.plmesh | ( | args | ) |
Plot surface mesh DESCRIPTION: Plots a surface mesh within the environment set up by plw3d. The surface is defined by the two-dimensional array z[ nx][ ny], the point z[i][j] being the value of the function at ( x[i], y[j]). Note that the points in arrays x and y do not need to be equally spaced, but must be stored in ascending order. The parameter opt controls the way in which the surface is displayed. For further details see the PLplot documentation. Redacted form: plmesh(x, y, z, opt) This function is used in example 11. SYNOPSIS: plmesh(x, y, z, nx, ny, opt) ARGUMENTS: x (PLFLT *, input) : Pointer to set of x coordinate values at which the function is evaluated. y (PLFLT *, input) : Pointer to set of y coordinate values at which the function is evaluated. z (PLFLT **, input) : Pointer to a vectored two-dimensional array with set of function values. nx (PLINT, input) : Number of x values at which function is evaluated. ny (PLINT, input) : Number of y values at which function is evaluated. opt (PLINT, input) : Determines the way in which the surface is represented: opt=DRAW_LINEX: Lines are drawn showing z as a function of x for each value of y[j]. opt=DRAW_LINEY: Lines are drawn showing z as a function of y for each value of x[i]. opt=DRAW_LINEXY: Network of lines is drawn connecting points at which function is defined.
Definition at line 3061 of file plplotc.py.
def plplotc.plmeshc | ( | args | ) |
Magnitude colored plot surface mesh with contour. DESCRIPTION: Identical to plmesh but with extra functionalities: the surface mesh can be colored accordingly to the current z value being plotted, a contour plot can be drawn at the base XY plane, and a curtain can be drawn between the plotted function border and the base XY plane. Redacted form: plmeshc(x, y, z, opt, clevel) This function is used in example 11. SYNOPSIS: plmeshc(x, y, z, nx, ny, opt, clevel, nlevel) ARGUMENTS: x (PLFLT *, input) : Pointer to set of x coordinate values at which the function is evaluated. y (PLFLT *, input) : Pointer to set of y coordinate values at which the function is evaluated. z (PLFLT **, input) : Pointer to a vectored two-dimensional array with set of function values. nx (PLINT, input) : Number of x values at which function is evaluated. ny (PLINT, input) : Number of y values at which function is evaluated. opt (PLINT, input) : Determines the way in which the surface is represented. To specify more than one option just add the options, e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX: Lines are drawn showing z as a function of x for each value of y[j]. opt=DRAW_LINEY: Lines are drawn showing z as a function of y for each value of x[i]. opt=DRAW_LINEXY: Network of lines is drawn connecting points at which function is defined. opt=MAG_COLOR: Each line in the mesh is colored according to the z value being plotted. The color is used from the current colormap 1. opt=BASE_CONT: A contour plot is drawn at the base XY plane using parameters nlevel and clevel. opt=DRAW_SIDES: draws a curtain between the base XY plane and the borders of the plotted function. clevel (PLFLT *, input) : Pointer to the array that defines the contour level spacing. nlevel (PLINT, input) : Number of elements in the clevel array.
Definition at line 3115 of file plplotc.py.
def plplotc.plMinMax2dGrid | ( | args | ) |
Definition at line 6956 of file plplotc.py.
def plplotc.plmkstrm | ( | ) |
Creates a new stream and makes it the default DESCRIPTION: Creates a new stream and makes it the default. Differs from using plsstrm, in that a free stream number is found, and returned. Unfortunately, I have to start at stream 1 and work upward, since stream 0 is preallocated. One of the big flaws in the PLplot API is that no initial, library-opening call is required. So stream 0 must be preallocated, and there is no simple way of determining whether it is already in use or not. Redacted form: plmkstrm(p_strm) This function is used in examples 1,20. SYNOPSIS: plmkstrm(p_strm) ARGUMENTS: p_strm (PLINT *, output) : Pointer to stream number of the created stream.
Definition at line 3180 of file plplotc.py.
def plplotc.plmtex | ( | args | ) |
Write text relative to viewport boundaries DESCRIPTION: Writes text at a specified position relative to the viewport boundaries. Text may be written inside or outside the viewport, but is clipped at the subpage boundaries. The reference point of a string lies along a line passing through the string at half the height of a capital letter. The position of the reference point along this line is determined by just, and the position of the reference point relative to the viewport is set by disp and pos. Redacted form: General: plmtex(side, disp, pos, just, text) Perl/PDL: plmtex(disp, pos, just, side, text) This function is used in examples 3,4,6-8,11,12,14,18,23,26. SYNOPSIS: plmtex(side, disp, pos, just, text) ARGUMENTS: side (const char *, input) : Specifies the side of the viewport along which the text is to be written. The string must be one of: b: Bottom of viewport, text written parallel to edge. bv: Bottom of viewport, text written at right angles to edge. l: Left of viewport, text written parallel to edge. lv: Left of viewport, text written at right angles to edge. r: Right of viewport, text written parallel to edge. rv: Right of viewport, text written at right angles to edge. t: Top of viewport, text written parallel to edge. tv: Top of viewport, text written at right angles to edge. disp (PLFLT, input) : Position of the reference point of string, measured outwards from the specified viewport edge in units of the current character height. Use negative disp to write within the viewport. pos (PLFLT, input) : Position of the reference point of string along the specified edge, expressed as a fraction of the length of the edge. just (PLFLT, input) : Specifies the position of the string relative to its reference point. If just=0., the reference point is at the left and if just=1., it is at the right of the string. Other values of just give intermediate justifications. text (const char *, input) : The string to be written out.
Definition at line 3212 of file plplotc.py.
def plplotc.plmtex3 | ( | args | ) |
Write text relative to viewport boundaries in 3D plots. DESCRIPTION: Writes text at a specified position relative to the viewport boundaries. Text may be written inside or outside the viewport, but is clipped at the subpage boundaries. The reference point of a string lies along a line passing through the string at half the height of a capital letter. The position of the reference point along this line is determined by just, and the position of the reference point relative to the viewport is set by disp and pos. Redacted form: plmtex3(side, disp, pos, just, text) This function is used in example 28. SYNOPSIS: plmtex3(side, disp, pos, just, text) ARGUMENTS: side (const char *, input) : Specifies the side of the viewport along which the text is to be written. The string should contain one or more of the following characters: [xyz][ps][v]. Only one label is drawn at a time, i.e. xyp will only label the X axis, not both the X and Y axes. x: Label the X axis. y: Label the Y axis. z: Label the Z axis. p: Label the primary axis. For Z this is the leftmost Z axis. For X it is the axis that starts at y-min. For Y it is the axis that starts at x-min. s: Label the secondary axis. v: Draw the text perpendicular to the axis. disp (PLFLT, input) : Position of the reference point of string, measured outwards from the specified viewport edge in units of the current character height. Use negative disp to write within the viewport. pos (PLFLT, input) : Position of the reference point of string along the specified edge, expressed as a fraction of the length of the edge. just (PLFLT, input) : Specifies the position of the string relative to its reference point. If just=0., the reference point is at the left and if just=1., it is at the right of the string. Other values of just give intermediate justifications. text (const char *, input) : The string to be written out.
Definition at line 3271 of file plplotc.py.
def plplotc.plOptUsage | ( | void | ) |
Print usage & syntax message.
Definition at line 6952 of file plplotc.py.
def plplotc.plot3d | ( | args | ) |
Plot 3-d surface plot DESCRIPTION: Plots a three dimensional surface plot within the environment set up by plw3d. The surface is defined by the two-dimensional array z[ nx][ ny], the point z[i][j] being the value of the function at ( x[i], y[j]). Note that the points in arrays x and y do not need to be equally spaced, but must be stored in ascending order. The parameter opt controls the way in which the surface is displayed. For further details see the PLplot documentation. The only difference between plmesh and plot3d is that plmesh draws the bottom side of the surface, while plot3d only draws the surface as viewed from the top. Redacted form: plot3d(x, y, z, opt, side) This function is used in examples 11,21. SYNOPSIS: plot3d(x, y, z, nx, ny, opt, side) ARGUMENTS: x (PLFLT *, input) : Pointer to set of x coordinate values at which the function is evaluated. y (PLFLT *, input) : Pointer to set of y coordinate values at which the function is evaluated. z (PLFLT **, input) : Pointer to a vectored two-dimensional array with set of function values. nx (PLINT, input) : Number of x values at which function is evaluated. ny (PLINT, input) : Number of y values at which function is evaluated. opt (PLINT, input) : Determines the way in which the surface is represented: opt=DRAW_LINEX: Lines are drawn showing z as a function of x for each value of y[j]. opt=DRAW_LINEY: Lines are drawn showing z as a function of y for each value of x[i]. opt=DRAW_LINEXY: Network of lines is drawn connecting points at which function is defined. side (PLBOOL, input) : Flag to indicate whether or not ``sides'' should be draw on the figure. If side is true sides are drawn, otherwise no sides are drawn.
Definition at line 3330 of file plplotc.py.
def plplotc.plot3dc | ( | args | ) |
Magnitude colored plot surface with contour. DESCRIPTION: Identical to plot3d but with extra functionalities: the surface mesh can be colored accordingly to the current z value being plotted, a contour plot can be drawn at the base XY plane, and a curtain can be drawn between the plotted function border and the base XY plane. The arguments are identical to plmeshc. The only difference between plmeshc and plot3dc is that plmeshc draws the bottom side of the surface, while plot3dc only draws the surface as viewed from the top. Redacted form: General: plot3dc(x, y, z, opt, clevel) Perl/PDL: Not available? This function is used in example 21. SYNOPSIS: plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
Definition at line 3391 of file plplotc.py.
def plplotc.plot3dcl | ( | args | ) |
Definition at line 3420 of file plplotc.py.
def plplotc.plparseopts | ( | args | ) |
Parse command-line arguments DESCRIPTION: Parse command-line arguments. plparseopts removes all recognized flags (decreasing argc accordingly), so that invalid input may be readily detected. It can also be used to process user command line flags. The user can merge an option table of type PLOptionTable into the internal option table info structure using plMergeOpts. Or, the user can specify that ONLY the external table(s) be parsed by calling plClearOpts before plMergeOpts. The default action taken by plparseopts is as follows: Returns with an error if an unrecognized option or badly formed option-value pair are encountered. Returns immediately (return code 0) when the first non-option command line argument is found. Returns with the return code of the option handler, if one was called. Deletes command line arguments from argv list as they are found, and decrements argc accordingly. Does not show "invisible" options in usage or help messages. Assumes the program name is contained in argv[0]. These behaviors may be controlled through the mode argument. Redacted form: General: plparseopts(argv, mode) Perl/PDL: Not available? This function is used in all of the examples. SYNOPSIS: int plparseopts(p_argc, argv, mode) ARGUMENTS: p_argc (int *, input) : pointer to number of arguments. argv (char **, input) : Pointer to character array containing *p_argc command-line arguments. mode (PLINT, input) : Parsing mode with the following possibilities: PL_PARSE_FULL (1) -- Full parsing of command line and all error messages enabled, including program exit when an error occurs. Anything on the command line that isn't recognized as a valid option or option argument is flagged as an error. PL_PARSE_QUIET (2) -- Turns off all output except in the case of errors. PL_PARSE_NODELETE (4) -- Turns off deletion of processed arguments. PL_PARSE_SHOWALL (8) -- Show invisible options PL_PARSE_NOPROGRAM (32) -- Specified if argv[0] is NOT a pointer to the program name. PL_PARSE_NODASH (64) -- Set if leading dash is NOT required. PL_PARSE_SKIP (128) -- Set to quietly skip over any unrecognized arguments.
Definition at line 3500 of file plplotc.py.
def plplotc.plpat | ( | args | ) |
Set area fill pattern DESCRIPTION: Sets the area fill pattern. The pattern consists of 1 or 2 sets of parallel lines with specified inclinations and spacings. The arguments to this routine are the number of sets to use (1 or 2) followed by two pointers to integer arrays (of 1 or 2 elements) specifying the inclinations in tenths of a degree and the spacing in micrometers. (also see plpsty) Redacted form: General: plpat(inc, del) Perl/PDL: plpat(nlin, inc, del) This function is used in example 15. SYNOPSIS: plpat(nlin, inc, del) ARGUMENTS: nlin (PLINT, input) : Number of sets of lines making up the pattern, either 1 or 2. inc (PLINT *, input) : Pointer to array with nlin elements. Specifies the line inclination in tenths of a degree. (Should be between -900 and 900). del (PLINT *, input) : Pointer to array with nlin elements. Specifies the spacing in micrometers between the lines making up the pattern.
Definition at line 3569 of file plplotc.py.
def plplotc.plpoin | ( | args | ) |
Plot a glyph at the specified points DESCRIPTION: Plot a glyph at the specified points. (This function is largely superseded by plstring which gives access to many[!] more glyphs.) code=-1 means try to just draw a point. Right now it's just a move and a draw at the same place. Not ideal, since a sufficiently intelligent output device may optimize it away, or there may be faster ways of doing it. This is OK for now, though, and offers a 4X speedup over drawing a Hershey font "point" (which is actually diamond shaped and therefore takes 4 strokes to draw). If 0 < code < 32, then a useful (but small subset) of Hershey symbols is plotted. If 32 <= code <= 127 the corresponding printable ASCII character is plotted. Redacted form: plpoin(x, y, code) This function is used in examples 1,6,14,29. SYNOPSIS: plpoin(n, x, y, code) ARGUMENTS: n (PLINT, input) : Number of points in the x and y arrays. x (PLFLT *, input) : Pointer to an array with X coordinates of points. y (PLFLT *, input) : Pointer to an array with Y coordinates of points. code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form with -1 <= code <= 127) corresponding to a glyph to be plotted at each of the n points.
Definition at line 3610 of file plplotc.py.
def plplotc.plpoin3 | ( | args | ) |
Plot a glyph at the specified 3D points DESCRIPTION: Plot a glyph at the specified 3D points. (This function is largely superseded by plstring3 which gives access to many[!] more glyphs.) Set up the call to this function similar to what is done for plline3. code=-1 means try to just draw a point. Right now it's just a move and a draw at the same place. Not ideal, since a sufficiently intelligent output device may optimize it away, or there may be faster ways of doing it. This is OK for now, though, and offers a 4X speedup over drawing a Hershey font "point" (which is actually diamond shaped and therefore takes 4 strokes to draw). If 0 < code < 32, then a useful (but small subset) of Hershey symbols is plotted. If 32 <= code <= 127 the corresponding printable ASCII character is plotted. Redacted form: plpoin3(x, y, z, code) This function is not used in any example. SYNOPSIS: plpoin3(n, x, y, z, code) ARGUMENTS: n (PLINT, input) : Number of points in the x and y arrays. x (PLFLT *, input) : Pointer to an array with X coordinates of points. y (PLFLT *, input) : Pointer to an array with Y coordinates of points. z (PLFLT *, input) : Pointer to an array with Z coordinates of points. code (PLINT, input) : Hershey symbol code (in "ascii-indexed" form with -1 <= code <= 127) corresponding to a glyph to be plotted at each of the n points.
Definition at line 3654 of file plplotc.py.
def plplotc.plpoly3 | ( | args | ) |
Draw a polygon in 3 space DESCRIPTION: Draws a polygon in 3 space defined by n points in x, y, and z. Setup like plline3, but differs from that function in that plpoly3 attempts to determine if the polygon is viewable depending on the order of the points within the arrays and the value of ifcc. If the back of polygon is facing the viewer, then it isn't drawn. If this isn't what you want, then use plline3 instead. The points are assumed to be in a plane, and the directionality of the plane is determined from the first three points. Additional points do not have to lie on the plane defined by the first three, but if they do not, then the determination of visibility obviously can't be 100% accurate... So if you're 3 space polygons are too far from planar, consider breaking them into smaller polygons. 3 points define a plane :-). Bugs: If one of the first two segments is of zero length, or if they are co-linear, the calculation of visibility has a 50/50 chance of being correct. Avoid such situations :-). See x18c.c for an example of this problem. (Search for 20.1). Redacted form: plpoly3(x, y, z, code) This function is used in example 18. SYNOPSIS: plpoly3(n, x, y, z, draw, ifcc) ARGUMENTS: n (PLINT, input) : Number of points defining line. x (PLFLT *, input) : Pointer to array with x coordinates of points. y (PLFLT *, input) : Pointer to array with y coordinates of points. z (PLFLT *, input) : Pointer to array with z coordinates of points. draw (PLBOOL *, input) : Pointer to array which controls drawing the segments of the polygon. If draw[i] is true, then the polygon segment from index [i] to [i+1] is drawn, otherwise, not. ifcc (PLBOOL, input) : If ifcc is true the directionality of the polygon is determined by assuming the points are laid out in a counter-clockwise order. Otherwise, the directionality of the polygon is determined by assuming the points are laid out in a clockwise order.
Definition at line 3702 of file plplotc.py.
def plplotc.plprec | ( | args | ) |
Set precision in numeric labels DESCRIPTION: Sets the number of places after the decimal point in numeric labels. Redacted form: plprec(set, prec) This function is used in example 29. SYNOPSIS: plprec(set, prec) ARGUMENTS: set (PLINT, input) : If set is equal to 0 then PLplot automatically determines the number of places to use after the decimal point in numeric labels (like those used to label axes). If set is 1 then prec sets the number of places. prec (PLINT, input) : The number of characters to draw after the decimal point in numeric labels.
Definition at line 3761 of file plplotc.py.
def plplotc.plpsty | ( | args | ) |
Select area fill pattern DESCRIPTION: Select one of eight predefined area fill patterns to use (also see plpat). Setting the fill style to 0 gives a solid fill. Redacted form: plpsty(n) This function is used in examples 12,13,15,16,25. SYNOPSIS: plpsty(n) ARGUMENTS: n (PLINT, input) : The desired pattern. Pattern 1 consists of horizontal lines, pattern 2 consists of vertical lines, pattern 3 consists of lines at 45 degrees angle (upward), and so on.
Definition at line 3792 of file plplotc.py.
def plplotc.plptex | ( | args | ) |
Write text inside the viewport DESCRIPTION: Writes text at a specified position and inclination within the viewport. Text is clipped at the viewport boundaries. The reference point of a string lies along a line passing through the string at half the height of a capital letter. The position of the reference point along this line is determined by just, the reference point is placed at world coordinates ( x, y) within the viewport. The inclination of the string is specified in terms of differences of world coordinates making it easy to write text parallel to a line in a graph. Redacted form: plptex(x, y, dx, dy, just, text) This function is used in example 2-4,10,12-14,20,23,24,26. SYNOPSIS: plptex(x, y, dx, dy, just, text) ARGUMENTS: x (PLFLT, input) : x coordinate of reference point of string. y (PLFLT, input) : y coordinate of reference point of string. dx (PLFLT, input) : Together with dy, this specifies the inclination of the string. The baseline of the string is parallel to a line joining ( x, y) to ( x+ dx, y+ dy). dy (PLFLT, input) : Together with dx, this specifies the inclination of the string. just (PLFLT, input) : Specifies the position of the string relative to its reference point. If just=0., the reference point is at the left and if just=1., it is at the right of the string. Other values of just give intermediate justifications. text (const char *, input) : The string to be written out.
Definition at line 3820 of file plplotc.py.
def plplotc.plptex3 | ( | args | ) |
Write text inside the viewport of a 3D plot. DESCRIPTION: Writes text at a specified position and inclination and with a specified shear within the viewport. Text is clipped at the viewport boundaries. The reference point of a string lies along a line passing through the string at half the height of a capital letter. The position of the reference point along this line is determined by just, and the reference point is placed at world coordinates ( x, y, z) within the viewport. The inclination and shear of the string is specified in terms of differences of world coordinates making it easy to write text parallel to a line in a graph. Redacted form: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text) This function is used in example 28. SYNOPSIS: plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text) ARGUMENTS: x (PLFLT, input) : x coordinate of reference point of string. y (PLFLT, input) : y coordinate of reference point of string. z (PLFLT, input) : z coordinate of reference point of string. dx (PLFLT, input) : Together with dy and dz, this specifies the inclination of the string. The baseline of the string is parallel to a line joining ( x, y, z) to ( x+ dx, y+ dy, z+ dz). dy (PLFLT, input) : Together with dx and dz, this specifies the inclination of the string. dz (PLFLT, input) : Together with dx and dy, this specifies the inclination of the string. sx (PLFLT, input) : Together with sy and sz, this specifies the shear of the string. The string is sheared so that the characters are vertically parallel to a line joining ( x, y, z) to ( x+ sx, y+ sy, z+ sz). If sx = sy = sz = 0.) then the text is not sheared. sy (PLFLT, input) : Together with sx and sz, this specifies shear of the string. sz (PLFLT, input) : Together with sx and sy, this specifies shear of the string. just (PLFLT, input) : Specifies the position of the string relative to its reference point. If just=0., the reference point is at the left and if just=1., it is at the right of the string. Other values of just give intermediate justifications. text (const char *, input) : The string to be written out.
Definition at line 3876 of file plplotc.py.
def plplotc.plrandd | ( | ) |
Random number generator returning a real random number in the range [0,1]. DESCRIPTION: Random number generator returning a real random number in the range [0,1]. The generator is based on the Mersenne Twister. Most languages / compilers provide their own random number generator, and so this is provided purely for convenience and to give a consistent random number generator across all languages supported by PLplot. This is particularly useful for comparing results from the test suite of examples. Redacted form: plrandd() This function is used in examples 17,21. SYNOPSIS: plrandd()
Definition at line 3962 of file plplotc.py.
def plplotc.plreplot | ( | ) |
Replays contents of plot buffer to current device/file DESCRIPTION: Replays contents of plot buffer to current device/file. Redacted form: plreplot() This function is used in example 1,20. SYNOPSIS: plreplot()
Definition at line 3989 of file plplotc.py.
def plplotc.plResetOpts | ( | void | ) |
Reset internal option table info structure.
Definition at line 6944 of file plplotc.py.
def plplotc.plrgbhls | ( | args | ) |
Convert RGB color to HLS DESCRIPTION: Convert RGB color coordinates to HLS Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s) Perl/PDL: Not available? Implemented as plrgb/plrgb1? This function is used in example 2. SYNOPSIS: plrgbhls(r, g, b, p_h, p_l, p_s) ARGUMENTS: r (PLFLT, input) : Red intensity (0.0-1.0) of the colour g (PLFLT, input) : Green intensity (0.0-1.0) of the colour b (PLFLT, input) : Blue intensity (0.0-1.0) of the colour p_h (PLFLT *, output) : Pointer to hue, in degrees on the colour cone (0.0-360.0) p_l (PLFLT *, output) : Pointer to lightness, expressed as a fraction of the axis of the colour cone (0.0-1.0) p_s (PLFLT *, output) : Pointer to saturation, expressed as a fraction of the radius of the colour cone (0.0-1.0)
Definition at line 4010 of file plplotc.py.
def plplotc.plschr | ( | args | ) |
Set character size DESCRIPTION: This sets up the size of all subsequent characters drawn. The actual height of a character is the product of the default character size and a scaling factor. Redacted form: plschr(def, scale) This function is used in example 2,13,23,24. SYNOPSIS: plschr(def, scale) ARGUMENTS: def (PLFLT, input) : The default height of a character in millimeters, should be set to zero if the default height is to remain unchanged. scale (PLFLT, input) : Scale factor to be applied to default to get actual character height.
Definition at line 4050 of file plplotc.py.
def plplotc.plscmap0 | ( | args | ) |
Set color map0 colors by 8-bit RGB values DESCRIPTION: Set color map0 colors using 8-bit RGB values (see the PLplot documentation). This sets the entire color map -- only as many colors as specified will be allocated. Redacted form: plscmap0(r, g, b, ncol0) This function is used in examples 2,24. SYNOPSIS: plscmap0(r, g, b, ncol0) ARGUMENTS: r (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of red in the color. g (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of green in the color. b (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of blue in the color. ncol0 (PLINT, input) : Number of items in the r, g, and b arrays.
Definition at line 4082 of file plplotc.py.
def plplotc.plscmap0a | ( | args | ) |
Set color map0 colors by 8-bit RGB values and double alpha value. DESCRIPTION: Set color map0 colors using 8-bit RGB values (see the PLplot documentation) and floating point alpha value. This sets the entire color map -- only as many colors as specified will be allocated. This function is used in examples 30. SYNOPSIS: plscmap0a(r, g, b, a, ncol0) ARGUMENTS: r (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of red in the color. g (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of green in the color. b (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of blue in the color. a (PLFLT *, input) : Pointer to array with set of PLFLT values (0.0 - 1.0) representing the transparency of the color. ncol0 (PLINT, input) : Number of items in the r, g, b, and a arrays.
Definition at line 4118 of file plplotc.py.
def plplotc.plscmap0n | ( | args | ) |
Set number of colors in color map0 DESCRIPTION: Set number of colors in color map0 (see the PLplot documentation). Allocate (or reallocate) color map0, and fill with default values for those colors not previously allocated. The first 16 default colors are given in the plcol0 documentation. For larger indices the default color is red. The drivers are not guaranteed to support more than 16 colors. Redacted form: plscmap0n(ncol0) This function is used in examples 15,16,24. SYNOPSIS: plscmap0n(ncol0) ARGUMENTS: ncol0 (PLINT, input) : Number of colors that will be allocated in the map0 palette. If this number is zero or less, then the value from the previous call to plscmap0n is used and if there is no previous call, then a default value is used.
Definition at line 4156 of file plplotc.py.
def plplotc.plscmap1 | ( | args | ) |
Set color map1 colors using 8-bit RGB values DESCRIPTION: Set color map1 colors using 8-bit RGB values (see the PLplot documentation). This also sets the number of colors. Redacted form: plscmap1(r, g, b, ncol1) This function is used in example 31. SYNOPSIS: plscmap1(r, g, b, ncol1) ARGUMENTS: r (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of red in the color. g (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of green in the color. b (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of blue in the color. ncol1 (PLINT, input) : Number of items in the r, g, and b arrays.
Definition at line 4190 of file plplotc.py.
def plplotc.plscmap1_range | ( | args | ) |
Definition at line 4429 of file plplotc.py.
def plplotc.plscmap1a | ( | args | ) |
Set color map1 colors using 8-bit RGB values and double alpha values. DESCRIPTION: Set color map1 colors using 8-bit RGB values (see the PLplot documentation) and double alpha values. This also sets the number of colors. This function is used in example 31. SYNOPSIS: plscmap1a(r, g, b, a, ncol1) ARGUMENTS: r (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of red in the color. g (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of green in the color. b (PLINT *, input) : Pointer to array with set of unsigned 8-bit integers (0-255) representing the degree of blue in the color. a (PLFLT *, input) : Pointer to array with set of double values (0.0-1.0) representing the alpha value of the color. ncol1 (PLINT, input) : Number of items in the r, g, b, and a arrays.
Definition at line 4225 of file plplotc.py.
def plplotc.plscmap1l | ( | args | ) |
Set color map1 colors using a piece-wise linear relationship DESCRIPTION: Set color map1 colors using a piece-wise linear relationship between position in the color map (from 0 to 1) and position in HLS or RGB color space (see the PLplot documentation). May be called at any time. The idea here is to specify a number of control points that define the mapping between palette 1 input positions (intensities) and HLS (or RGB). Between these points, linear interpolation is used which gives a smooth variation of color with input position. Any number of control points may be specified, located at arbitrary positions, although typically 2 - 4 are enough. Another way of stating this is that we are traversing a given number of lines through HLS (or RGB) space as we move through color map1 entries. The control points at the minimum and maximum position (0 and 1) must always be specified. By adding more control points you can get more variation. One good technique for plotting functions that vary about some expected average is to use an additional 2 control points in the center (position ~= 0.5) that are the same lightness as the background (typically white for paper output, black for crt), and same hue as the boundary control points. This allows the highs and lows to be very easily distinguished. Each control point must specify the position in color map1 as well as three coordinates in HLS or RGB space. The first point must correspond to position = 0, and the last to position = 1. The default behaviour is for the hue to be linearly interpolated between the control points. Since the hue lies in the range [0, 360] this corresponds to interpolation around the "front" of the color wheel (red<->green<->blue<->red). If alt_hue_path[i] is true, then an alternative interpolation is used between control points i and i+1. If hue[i+1]-hue[i] > 0 then interpolation is between hue[i] and hue[i+1] - 360, otherwise between hue[i] and hue[i+1] + 360. You can consider this as interpolation around the "back" or "reverse" of the color wheel. Specifying alt_hue_path=NULL is equivalent to setting alt_hue_path[] = false for every control point. Examples of interpolation Huealt_hue_pathcolor scheme[120 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120 240]truegreen-yellow-red-magenta-blue[240 120]trueblue-magenta-red-yellow-green Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0, 1]magnitudeHLShue[0, 360]degreesHLSlightness[0, 1]magnitudeHLSsaturation[0, 1]magnitude Redacted form: plscmap1l(itype, pos, coord1, coord2, coord3, alt_hue_path) This function is used in examples 8,11,12,15,20,21. SYNOPSIS: plscmap1l(itype, npts, pos, coord1, coord2, coord3, alt_hue_path) ARGUMENTS: itype (PLBOOL, input) : true: RGB, false: HLS. npts (PLINT, input) : number of control points pos (PLFLT *, input) : position for each control point (between 0.0 and 1.0, in ascending order) coord1 (PLFLT *, input) : first coordinate (H or R) for each control point coord2 (PLFLT *, input) : second coordinate (L or G) for each control point coord3 (PLFLT *, input) : third coordinate (S or B) for each control point alt_hue_path (PLBOOL: *, input) : alternative interpolation method flag for each control point. (alt_hue_path[i] refers to the interpolation interval between the i and i + 1 control points).
Definition at line 4263 of file plplotc.py.
def plplotc.plscmap1la | ( | args | ) |
Set color map1 colors using a piece-wise linear relationship DESCRIPTION: This is a version of plscmap1l that supports alpha transparency. It sets color map1 colors using a piece-wise linear relationship between position in the color map (from 0 to 1) and position in HLS or RGB color space (see the PLplot documentation) with alpha value (0.0 - 1.0). It may be called at any time. This function is used in example 30. SYNOPSIS: plscmap1la(itype, npts, pos, coord1, coord2, coord3, coord4, alt_hue_path) ARGUMENTS: itype (PLBOOL, input) : true: RGB, false: HLS. npts (PLINT, input) : number of control points pos (PLFLT *, input) : position for each control point (between 0.0 and 1.0, in ascending order) coord1 (PLFLT *, input) : first coordinate (H or R) for each control point coord2 (PLFLT *, input) : second coordinate (L or G) for each control point coord3 (PLFLT *, input) : third coordinate (S or B) for each control point coord4 (PLFLT *, input) : fourth coordinate, the alpha value for each control point alt_hue_path (PLBOOL: *, input) : alternative interpolation method flag for each control point. (alt_hue_path[i] refers to the interpolation interval between the i and i + 1 control points).
Definition at line 4351 of file plplotc.py.
def plplotc.plscmap1n | ( | args | ) |
Set number of colors in color map1 DESCRIPTION: Set number of colors in color map1, (re-)allocate color map1, and set default values if this is the first allocation (see the PLplot documentation). Redacted form: plscmap1n(ncol1) This function is used in examples 8,11,20,21. SYNOPSIS: plscmap1n(ncol1) ARGUMENTS: ncol1 (PLINT, input) : Number of colors that will be allocated in the map1 palette. If this number is zero or less, then the value from the previous call to plscmap1n is used and if there is no previous call, then a default value is used.
Definition at line 4399 of file plplotc.py.
def plplotc.plscol0 | ( | args | ) |
Set a given color from color map0 by 8 bit RGB value ESCRIPTION: Set a given color by 8-bit RGB value for color map0 (see the PLplot documentation). Overwrites the previous color value for the given index and, thus, does not result in any additional allocation of space for colors. Redacted form: plscol0(icol0, r, g, b) This function is not used in any examples. YNOPSIS: lscol0(icol0, r, g, b) RGUMENTS: icol0 (PLINT, input) : Color index. Must be less than the maximum number of colors (which is set by default, by plscmap0n, or even by plscmap0). r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of blue in the color.
Definition at line 4437 of file plplotc.py.
def plplotc.plscol0a | ( | args | ) |
Set a given color from color map0 by 8 bit RGB value and double alpha value. ESCRIPTION: Set a given color by 8-bit RGB value and double alpha value for color map0 (see the PLplot documentation). Overwrites the previous color value for the given index and, thus, does not result in any additional allocation of space for colors. This function is used in example 30. YNOPSIS: lscol0a(icol0, r, g, b, a) RGUMENTS: icol0 (PLINT, input) : Color index. Must be less than the maximum number of colors (which is set by default, by plscmap0n, or even by plscmap0). r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of blue in the color. a (PLFLT, input) : double value (0.0-1.0) representing the alpha value of the color.
Definition at line 4476 of file plplotc.py.
def plplotc.plscolbg | ( | args | ) |
Set the background color by 8-bit RGB value DESCRIPTION: Set the background color (color 0 in color map 0) by 8-bit RGB value (see the PLplot documentation). Redacted form: plscolbg(r, g, b) This function is used in examples 15,31. SYNOPSIS: plscolbg(r, g, b) ARGUMENTS: r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of blue in the color.
Definition at line 4516 of file plplotc.py.
def plplotc.plscolbga | ( | args | ) |
Set the background color by 8-bit RGB value and double alpha value. DESCRIPTION: Set the background color (color 0 in color map 0) by 8-bit RGB value (see the PLplot documentation) and double alpha value. This function is used in example 31. SYNOPSIS: plscolbga(r, g, b, a) ARGUMENTS: r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of red in the color. g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of green in the color. b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the degree of blue in the color. a (PLFLT, input) : double value (0.0-1.0) representing the alpha value of the color.
Definition at line 4549 of file plplotc.py.
def plplotc.plscolor | ( | args | ) |
Used to globally turn color output on/off DESCRIPTION: Used to globally turn color output on/off for those drivers/devices that support it. Redacted form: plscolor(color) This function is used in example 31. SYNOPSIS: plscolor(color) ARGUMENTS: color (PLINT, input) : Color flag (Boolean). If zero, color is turned off. If non-zero, color is turned on.
Definition at line 4583 of file plplotc.py.
def plplotc.plscompression | ( | args | ) |
Set device-compression level DESCRIPTION: Set device-compression level. Only used for drivers that provide compression. This function, if used, should be invoked before a call to plinit. Redacted form: plscompression(compression) This function is used in example 31. SYNOPSIS: plscompression(compression) ARGUMENTS: compression (PLINT, input) : The desired compression level. This is a device-dependent value. Currently only the jpeg and png devices use these values. For jpeg value is the jpeg quality which should normally be in the range 0-95. Higher values denote higher quality and hence larger image sizes. For png values are in the range -1 to 99. Values of 0-9 are taken as the compression level for zlib. A value of -1 denotes the default zlib compression level. Values in the range 10-99 are divided by 10 and then used as the zlib compression level. Higher compression levels correspond to greater compression and small file sizes at the expense of more computation.
Definition at line 4610 of file plplotc.py.
def plplotc.plsdev | ( | args | ) |
Set the device (keyword) name DESCRIPTION: Set the device (keyword) name. Redacted form: plsdev(devname) This function is used in examples 1,14,20. SYNOPSIS: plsdev(devname) ARGUMENTS: devname (const char *, input) : Pointer to device (keyword) name string.
Definition at line 4647 of file plplotc.py.
def plplotc.plsdidev | ( | args | ) |
Set parameters that define current device-space window DESCRIPTION: Set relative margin width, aspect ratio, and relative justification that define current device-space window. If you want to just use the previous value for any of these, just pass in the magic value PL_NOTSET. It is unlikely that one should ever need to change the aspect ratio but it's in there for completeness. If plsdidev is not called the default values of mar, jx, and jy are all 0. aspect is set to a device-specific value. Redacted form: plsdidev(mar, aspect, jx, jy) This function is used in example 31. SYNOPSIS: plsdidev(mar, aspect, jx, jy) ARGUMENTS: mar (PLFLT, input) : Relative margin width. aspect (PLFLT, input) : Aspect ratio. jx (PLFLT, input) : Relative justification in x. Value must lie in the range -0.5 to 0.5. jy (PLFLT, input) : Relative justification in y. Value must lie in the range -0.5 to 0.5.
Definition at line 4673 of file plplotc.py.
def plplotc.plsdimap | ( | args | ) |
Set up transformation from metafile coordinates DESCRIPTION: Set up transformation from metafile coordinates. The size of the plot is scaled so as to preserve aspect ratio. This isn't intended to be a general-purpose facility just yet (not sure why the user would need it, for one). Redacted form: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm) This function is not used in any examples. SYNOPSIS: plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm) ARGUMENTS: dimxmin (PLINT, input) : NEEDS DOCUMENTATION dimxmax (PLINT, input) : NEEDS DOCUMENTATION dimymin (PLINT, input) : NEEDS DOCUMENTATION dimymax (PLINT, input) : NEEDS DOCUMENTATION dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
Definition at line 4712 of file plplotc.py.
def plplotc.plsdiori | ( | args | ) |
Set plot orientation DESCRIPTION: Set plot orientation parameter which is multiplied by 90 degrees to obtain the angle of rotation. Note, arbitrary rotation parameters such as 0.2 (corresponding to 18 degrees) are possible, but the usual values for the rotation parameter are 0., 1., 2., and 3. corresponding to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees (seascape mode), and 270 degrees (upside-down mode). If plsdiori is not called the default value of rot is 0. N.B. aspect ratio is unaffected by calls to plsdiori. So you will probably want to change the aspect ratio to a value suitable for the plot orientation using a call to plsdidev or the command-line options -a or -freeaspect. For more documentation of those options see the PLplot documentation. Such command-line options can be set internally using plsetopt or set directly using the command line and parsed using a call to plparseopts. Redacted form: plsdiori(rot) This function is not used in any examples. SYNOPSIS: plsdiori(rot) ARGUMENTS: rot (PLFLT, input) : Plot orientation parameter.
Definition at line 4751 of file plplotc.py.
def plplotc.plsdiplt | ( | args | ) |
Set parameters that define current plot-space window DESCRIPTION: Set relative minima and maxima that define the current plot-space window. If plsdiplt is not called the default values of xmin, ymin, xmax, and ymax are 0., 0., 1., and 1. Redacted form: plsdiplt(xmin, ymin, xmax, ymax) This function is used in example 31. SYNOPSIS: plsdiplt(xmin, ymin, xmax, ymax) ARGUMENTS: xmin (PLFLT, input) : Relative minimum in x. ymin (PLFLT, input) : Relative minimum in y. xmax (PLFLT, input) : Relative maximum in x. ymax (PLFLT, input) : Relative maximum in y.
Definition at line 4790 of file plplotc.py.
def plplotc.plsdiplz | ( | args | ) |
Set parameters incrementally (zoom mode) that define current plot-space window DESCRIPTION: Set relative minima and maxima incrementally (zoom mode) that define the current plot-space window. This function has the same effect as plsdiplt if that function has not been previously called. Otherwise, this function implements zoom mode using the transformation min_used = old_min + old_length*min and max_used = old_min + old_length*max for each axis. For example, if min = 0.05 and max = 0.95 for each axis, repeated calls to plsdiplz will zoom in by 10 per cent for each call. Redacted form: plsdiplz(xmin, ymin, xmax, ymax) This function is used in example 31. SYNOPSIS: plsdiplz(xmin, ymin, xmax, ymax) ARGUMENTS: xmin (PLFLT, input) : Relative (incremental) minimum in x. ymin (PLFLT, input) : Relative (incremental) minimum in y. xmax (PLFLT, input) : Relative (incremental) maximum in x. ymax (PLFLT, input) : Relative (incremental) maximum in y.
Definition at line 4823 of file plplotc.py.
def plplotc.plseed | ( | args | ) |
Set seed for internal random number generator. DESCRIPTION: Set the seed for the internal random number generator. See plrandd for further details. Redacted form: plseed(seed) This function is used in example 21. SYNOPSIS: plseed(seed) ARGUMENTS: seed (unsigned int, input) : Seed for random number generator.
Definition at line 4860 of file plplotc.py.
def plplotc.plsesc | ( | args | ) |
Set the escape character for text strings DESCRIPTION: Set the escape character for text strings. From C (in contrast to Fortran 77, see plsescfortran77) you pass esc as a character. Only selected characters are allowed to prevent the user from shooting himself in the foot (For example, a \ isn't allowed since it conflicts with C's use of backslash as a character escape). Here are the allowed escape characters and their corresponding decimal ASCII values: !, ASCII 33 #, ASCII 35 $, ASCII 36 %, ASCII 37 &, ASCII 38 *, ASCII 42 @, ASCII 64 ^, ASCII 94 ~, ASCII 126 Redacted form: General: plsesc(esc) Perl/PDL: Not available? This function is used in example 29. SYNOPSIS: plsesc(esc) ARGUMENTS: esc (char, input) : Escape character.
Definition at line 4886 of file plplotc.py.
def plplotc.plsetopt | ( | args | ) |
Set any command-line option DESCRIPTION: Set any command-line option internally from a program before it invokes plinit. opt is the name of the command-line option and optarg is the corresponding command-line option argument. This function returns 0 on success. Redacted form: plsetopt(opt, optarg) This function is used in example 14. SYNOPSIS: int plsetopt(opt, optarg) ARGUMENTS: opt (const char *, input) : Pointer to string containing the command-line option. optarg (const char *, input) : Pointer to string containing the argument of the command-line option.
Definition at line 4928 of file plplotc.py.
def plplotc.plSetUsage | ( | args | ) |
Definition at line 6948 of file plplotc.py.
def plplotc.plsfam | ( | args | ) |
Set family file parameters DESCRIPTION: Sets variables dealing with output file familying. Does nothing if familying not supported by the driver. This routine, if used, must be called before initializing PLplot. See the PLplot documentation for more information. Redacted form: plsfam(fam, num, bmax) This function is used in examples 14,31. SYNOPSIS: plsfam(fam, num, bmax) ARGUMENTS: fam (PLINT, input) : Family flag (Boolean). If nonzero, familying is enabled. num (PLINT, input) : Current family file number. bmax (PLINT, input) : Maximum file size (in bytes) for a family file.
Definition at line 4961 of file plplotc.py.
def plplotc.plsfci | ( | args | ) |
Set FCI (font characterization integer) DESCRIPTION: Sets font characteristics to be used at the start of the next string using the FCI approach. See the PLplot documentation for more information. Redacted form: General: plsfci(fci) Perl/PDL: Not available? This function is used in example 23. SYNOPSIS: plsfci(fci) ARGUMENTS: fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value of FCI.
Definition at line 4995 of file plplotc.py.
def plplotc.plsfnam | ( | args | ) |
Set output file name DESCRIPTION: Sets the current output file name, if applicable. If the file name has not been specified and is required by the driver, the user will be prompted for it. If using the X-windows output driver, this sets the display name. This routine, if used, must be called before initializing PLplot. Redacted form: plsfnam(fnam) This function is used in examples 1,20. SYNOPSIS: plsfnam(fnam) ARGUMENTS: fnam (const char *, input) : Pointer to file name string.
Definition at line 5025 of file plplotc.py.
def plplotc.plsfont | ( | args | ) |
Set family, style and weight of the current font DESCRIPTION: Sets the current font. See the PLplot documentation for more information on font selection. Redacted form: plsfont(family, style, weight) This function is used in example 23. SYNOPSIS: plsfont(family, style, weight) ARGUMENTS: family (PLINT, input) : Font family to select for the current font. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT and PL_FCI_SYMBOL. A negative value signifies that the font family should not be altered. style (PLINT, input) : Font style to select for the current font. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC and PL_FCI_OBLIQUE. A negative value signifies that the font style should not be altered. weight (PLINT, input) : Font weight to select for the current font. The available values are given by the PL_FCI_* constants in plplot.h. Current options are PL_FCI_MEDIUM and PL_FCI_BOLD. A negative value signifies that the font weight should not be altered.
Definition at line 5054 of file plplotc.py.
def plplotc.plshade | ( | args | ) |
Shade individual region on the basis of value ESCRIPTION: Shade individual region on the basis of value. Use plshades if you want to shade a number of regions using continuous colors. plshade is identical to plshade1 except for the type of the first parameter. See plshade1 for further discussion. Redacted form: General: plshade(a, 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) Perl/PDL: Not available? This function is used in example 15. YNOPSIS: 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) RGUMENTS: a (PLFLT **, input) : nx (PLINT, input) : ny (PLINT, input) : defined (PLINT (*) (PLFLT, PLFLT), input) : xmin (PLFLT, input) : xmax (PLFLT, input) : ymin (PLFLT, input) : ymax (PLFLT, input) : shade_min (PLFLT, input) : shade_max (PLFLT, input) : sh_cmap (PLINT, input) : sh_color (PLFLT, input) : sh_width (PLFLT, input) : min_color (PLINT, input) : min_width (PLFLT, input) : max_color (PLINT, input) : max_width (PLFLT, input) : fill (void (*) (PLINT, PLFLT *, PLFLT *), input) : rectangular (PLBOOL, input) : pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) : pltr_data (PLPointer, input) :
Definition at line 5208 of file plplotc.py.
def plplotc.plshades | ( | args | ) |
Shade regions on the basis of value DESCRIPTION: Shade regions on the basis of value. This is the high-level routine for making continuous color shaded plots with cmap1 while plshade (or plshade1) are used for individual shaded regions using either cmap0 or cmap1. examples/c/x16c.c shows a number of examples for using this function. See the following discussion of the arguments and the PLplot documentation for more information. Redacted form: General: plshades(a, defined, xmin, xmax, ymin, ymax, clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data) Perl/PDL: plshades(a, xmin, xmax, ymin, ymax, clevel, fill_width, cont_color, cont_width, fill, rectangular, defined, pltr, pltr_data) This function is used in examples 16,21. SYNOPSIS: plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data) ARGUMENTS: a (PLFLT **, input) : Contains ** pointer to array to be plotted. The array must have been declared as PLFLT a[nx][ny]. nx (PLINT, input) : First dimension of array "a". ny (PLINT, input) : Second dimension of array "a". defined (PLINT (*) (PLFLT, PLFLT), input) : User function specifying regions excluded from the shading plot. This function accepts x and y coordinates as input arguments and must return 0 if the point is in the excluded region or 1 otherwise. This argument can be NULL if all the values are valid. xmin (PLFLT, input) : Defines the "grid" coordinates. The data a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so on. xmax (PLFLT, input) : Defines the "grid" coordinates. The data a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so on. ymin (PLFLT, input) : Defines the "grid" coordinates. The data a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so on. ymax (PLFLT, input) : Defines the "grid" coordinates. The data a[0][0] has a position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin) and so on. clevel (PLFLT *, input) : Pointer to array containing the data levels corresponding to the edges of each shaded region that will be plotted by this function. To work properly the levels should be monotonic. nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number of shade edge values in clevel). fill_width (PLFLT, input) : Defines line width used by the fill pattern. cont_color (PLINT, input) : Defines pen color used for contours defining edges of shaded regions. The pen color is only temporary set for the contour drawing. Set this value to zero or less if no shade edge contours are wanted. cont_width (PLFLT, input) : Defines line width used for contours defining edges of shaded regions. This value may not be honored by all drivers. The pen width is only temporary set for the contour drawing. Set this value to zero or less if no shade edge contours are wanted. fill (void (*) (PLINT, PLFLT *, PLFLT *), input) : Routine used to fill the region. Use plfill. Future version of PLplot may have other fill routines. rectangular (PLBOOL, input) : Set rectangular to true if rectangles map to rectangles after coordinate transformation with pltrl. Otherwise, set rectangular to false. If rectangular is set to true, plshade tries to save time by filling large rectangles. This optimization fails if the coordinate transformation distorts the shape of rectangles. For example a plot in polar coordinates has to have rectangular set to false. pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) : Pointer to function that defines transformation between indices in array z and the world coordinates (C only). Transformation functions are provided in the PLplot library: pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary mappings respectively defined by one- and two-dimensional arrays. In addition, user-supplied routines for the transformation can be used as well. Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of pltr0, pltr1, or pltr2. pltr_data (PLPointer, input) : Extra parameter to help pass information to pltr0, pltr1, pltr2, or whatever routine that is externally supplied.
Definition at line 5096 of file plplotc.py.
def plplotc.plslabelfunc | ( | args | ) |
Assign a function to use for generating custom axis labels DESCRIPTION: This function allows a user to provide their own function to provide axis label text. The user function is given the numeric value for a point on an axis and returns a string label to correspond with that value. Custom axis labels can be enabled by passing appropriate arguments to plenv, plbox, plbox3 and similar functions. This function is used in example 19. SYNOPSIS: plslabelfunc(label_func, label_data) ARGUMENTS: label_func (void (*) (PLINT, PLFLT, char *, PLINT, void *), input) : This is the custom label function. In order to reset to the default labeling, set this to NULL. The labeling function parameters are, in order: axis: This indicates which axis a label is being requested for. The value will be one of PL_X_AXIS, PL_Y_AXIS or PL_Z_AXIS. value: This is the value along the axis which is being labeled. label_text: The string representation of the label value. length: The maximum length in characters allowed for label_text. label_data (void *, input) : This parameter may be used to pass data to the label_func function.
Definition at line 5280 of file plplotc.py.
def plplotc.plsmaj | ( | args | ) |
Set length of major ticks DESCRIPTION: This sets up the length of the major ticks. The actual length is the product of the default length and a scaling factor as for character height. Redacted form: plsmaj(def, scale) This function is used in example 29. SYNOPSIS: plsmaj(def, scale) ARGUMENTS: def (PLFLT, input) : The default length of a major tick in millimeters, should be set to zero if the default length is to remain unchanged. scale (PLFLT, input) : Scale factor to be applied to default to get actual tick length.
Definition at line 5322 of file plplotc.py.
def plplotc.plsmem | ( | args | ) |
Set the memory area to be plotted (RGB) DESCRIPTION: Set the memory area to be plotted (with the mem or memcairo driver) as the dev member of the stream structure. Also set the number of pixels in the memory passed in plotmem, which is a block of memory maxy by maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB) This memory will have to be freed by the user! Redacted form: plsmem(maxx, maxy, plotmem) This function is not used in any examples. SYNOPSIS: plsmem(maxx, maxy, plotmem) ARGUMENTS: maxx (PLINT, input) : Size of memory area in the X coordinate. maxy (PLINT, input) : Size of memory area in the Y coordinate. plotmem (void *, input) : Pointer to the beginning of the user-supplied memory area.
Definition at line 5354 of file plplotc.py.
def plplotc.plsmema | ( | args | ) |
Set the memory area to be plotted (RGBA) DESCRIPTION: Set the memory area to be plotted (with the memcairo driver) as the dev member of the stream structure. Also set the number of pixels in the memory passed in plotmem, which is a block of memory maxy by maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA) This memory will have to be freed by the user! Redacted form: plsmema(maxx, maxy, plotmem) This function is not used in any examples. SYNOPSIS: plsmema(maxx, maxy, plotmem) ARGUMENTS: maxx (PLINT, input) : Size of memory area in the X coordinate. maxy (PLINT, input) : Size of memory area in the Y coordinate. plotmem (void *, input) : Pointer to the beginning of the user-supplied memory area.
Definition at line 5391 of file plplotc.py.
def plplotc.plsmin | ( | args | ) |
Set length of minor ticks DESCRIPTION: This sets up the length of the minor ticks and the length of the terminals on error bars. The actual length is the product of the default length and a scaling factor as for character height. Redacted form: plsmin(def, scale) This function is used in example 29. SYNOPSIS: plsmin(def, scale) ARGUMENTS: def (PLFLT, input) : The default length of a minor tick in millimeters, should be set to zero if the default length is to remain unchanged. scale (PLFLT, input) : Scale factor to be applied to default to get actual tick length.
Definition at line 5428 of file plplotc.py.
def plplotc.plsori | ( | args | ) |
Set orientation DESCRIPTION: Set integer plot orientation parameter. This function is identical to plsdiori except for the type of the argument, and should be used in the same way. See the PLplot documentation for details. Redacted form: plsori(ori) This function is used in example 3. SYNOPSIS: plsori(ori) ARGUMENTS: ori (PLINT, input) : Orientation value (0 for landscape, 1 for portrait, etc.) The value is multiplied by 90 degrees to get the angle.
Definition at line 5460 of file plplotc.py.
def plplotc.plspage | ( | args | ) |
Set page parameters DESCRIPTION: Sets the page configuration (optional). If an individual parameter is zero then that parameter value is not updated. Not all parameters are recognized by all drivers and the interpretation is device-dependent. The X-window driver uses the length and offset parameters to determine the window size and location. The length and offset values are expressed in units that are specific to the current driver. For instance: screen drivers will usually interpret them as number of pixels, whereas printer drivers will usually use mm. This routine, if used, must be called before initializing PLplot. Redacted form: plspage(xp, yp, xleng, yleng, xoff, yoff) This function is used in examples 14 and 31. SYNOPSIS: plspage(xp, yp, xleng, yleng, xoff, yoff) ARGUMENTS: xp (PLFLT, input) : Number of pixels/inch (DPI), x. yp (PLFLT, input) : Number of pixels/inch (DPI), y. xleng (PLINT , input) : Page length, x. yleng (PLINT, input) : Page length, y. xoff (PLINT, input) : Page offset, x. yoff (PLINT, input) : Page offset, y.
Definition at line 5489 of file plplotc.py.
def plplotc.plspal0 | ( | args | ) |
Set the colors for color table 0 from a cmap0 file DESCRIPTION: Set the colors for color table 0 from a cmap0 file Redacted form: plspal0(filename) This function is in example 16. SYNOPSIS: plspal0(filename) ARGUMENTS: filename (const char *, input) : The name of the cmap0 file, or a empty to string to specify the default cmap0 file.
Definition at line 5532 of file plplotc.py.
def plplotc.plspal1 | ( | args | ) |
Set the colors for color table 1 from a cmap1 file DESCRIPTION: Set the colors for color table 1 from a cmap1 file Redacted form: plspal1(filename) This function is in example 16. SYNOPSIS: plspal1(filename) ARGUMENTS: filename (const char *, input) : The name of the cmap1 file, or a empty to string to specify the default cmap1 file.
Definition at line 5558 of file plplotc.py.
def plplotc.plspause | ( | args | ) |
Set the pause (on end-of-page) status DESCRIPTION: Set the pause (on end-of-page) status. Redacted form: plspause(pause) This function is in examples 14,20. SYNOPSIS: plspause(pause) ARGUMENTS: pause (PLBOOL, input) : If pause is true there will be a pause on end-of-page for those drivers which support this. Otherwise there is no pause.
Definition at line 5584 of file plplotc.py.
def plplotc.plsstrm | ( | args | ) |
Set current output stream DESCRIPTION: Sets the number of the current output stream. The stream number defaults to 0 unless changed by this routine. The first use of this routine must be followed by a call initializing PLplot (e.g. plstar). Redacted form: plsstrm(strm) This function is examples 1,14,20. SYNOPSIS: plsstrm(strm) ARGUMENTS: strm (PLINT, input) : The current stream number.
Definition at line 5611 of file plplotc.py.
def plplotc.plssub | ( | args | ) |
Set the number of subpages in x and y DESCRIPTION: Set the number of subpages in x and y. Redacted form: plssub(nx, ny) This function is examples 1,2,14,21,25,27. SYNOPSIS: plssub(nx, ny) ARGUMENTS: nx (PLINT, input) : Number of windows in x direction (i.e., number of window columns). ny (PLINT, input) : Number of windows in y direction (i.e., number of window rows).
Definition at line 5638 of file plplotc.py.
def plplotc.plssym | ( | args | ) |
Set symbol size DESCRIPTION: This sets up the size of all subsequent symbols drawn by plpoin and plsym. The actual height of a symbol is the product of the default symbol size and a scaling factor as for the character height. Redacted form: plssym(def, scale) This function is used in example 29. SYNOPSIS: plssym(def, scale) ARGUMENTS: def (PLFLT, input) : The default height of a symbol in millimeters, should be set to zero if the default height is to remain unchanged. scale (PLFLT, input) : Scale factor to be applied to default to get actual symbol height.
Definition at line 5667 of file plplotc.py.
def plplotc.plstar | ( | args | ) |
Initialization DESCRIPTION: Initializing the plotting package. The program prompts for the device keyword or number of the desired output device. Hitting a RETURN in response to the prompt is the same as selecting the first device. If only one device is enabled when PLplot is installed, plstar will issue no prompt. The output device is divided into nx by ny subpages, each of which may be used independently. The subroutine pladv is used to advance from one subpage to the next. Redacted form: plstar(nx, ny) This function is used in example 1. SYNOPSIS: plstar(nx, ny) ARGUMENTS: nx (PLINT, input) : Number of subpages to divide output page in the horizontal direction. ny (PLINT, input) : Number of subpages to divide output page in the vertical direction.
Definition at line 5699 of file plplotc.py.
def plplotc.plstart | ( | args | ) |
Initialization DESCRIPTION: Alternative to plstar for initializing the plotting package. The device name keyword for the desired output device must be supplied as an argument. The device keywords are the same as those printed out by plstar. If the requested device is not available, or if the input string is empty or begins with ``?'', the prompted startup of plstar is used. This routine also divides the output device into nx by ny subpages, each of which may be used independently. The subroutine pladv is used to advance from one subpage to the next. Redacted form: General: plstart(device, nx, ny) Perl/PDL: plstart(nx, ny, device) This function is not used in any examples. SYNOPSIS: plstart(device, nx, ny) ARGUMENTS: device (const char *, input) : Device name (keyword) of the required output device. If NULL or if the first character is a ``?'', the normal (prompted) startup is used. nx (PLINT, input) : Number of subpages to divide output page in the horizontal direction. ny (PLINT, input) : Number of subpages to divide output page in the vertical direction.
Definition at line 5734 of file plplotc.py.
def plplotc.plstransform | ( | args | ) |
Set a global coordinate transform function DESCRIPTION: This function can be used to define a coordinate transformation which affects all elements drawn within the current plot window. The transformation function is similar to that provided for the plmap and plmeridians functions. The data parameter may be used to pass extra data to transform_fun. Redacted form: General: plstransform(transform_fun, data) This function is used in example 19. SYNOPSIS: plstransform(transform_fun, data) ARGUMENTS: transform_fun (void (*) (PLFLT, PLFLT, PLFLT*, PLFLT*, PLPointer) , input) : Pointer to a function that defines a transformation from the input (x, y) coordinate to a new plot world coordiante. data (PLPointer, input) : Optional extra data for transform_fun.
Definition at line 5776 of file plplotc.py.
def plplotc.plstring | ( | args | ) |
Plot a glyph at the specified points DESCRIPTION: Plot a glyph at the specified points. (Supersedes plpoin and plsym because many[!] more glyphs are accessible with plstring.) The glyph is specified with a PLplot user string. Note that the user string is not actually limited to one glyph so it is possible (but not normally useful) to plot more than one glyph at the specified points with this function. As with plmtex and plptex, the user string can contain FCI escapes to determine the font, UTF-8 code to determine the glyph or else PLplot escapes for Hershey or unicode text to determine the glyph. Redacted form: plstring(x, y, string) This function is used in examples 4, 21 and 26. SYNOPSIS: plstring(n, x, y, string) ARGUMENTS: n (PLINT, input) : Number of points in the x and y arrays. x (PLFLT *, input) : Pointer to an array with X coordinates of points. y (PLFLT *, input) : Pointer to an array with Y coordinates of points. string (const char *, input) : PLplot user string corresponding to the glyph to be plotted at each of the n points.
Definition at line 5811 of file plplotc.py.
def plplotc.plstring3 | ( | args | ) |
Plot a glyph at the specified 3D points DESCRIPTION: Plot a glyph at the specified 3D points. (Supersedes plpoin3 because many[!] more glyphs are accessible with plstring3.) Set up the call to this function similar to what is done for plline3. The glyph is specified with a PLplot user string. Note that the user string is not actually limited to one glyph so it is possible (but not normally useful) to plot more than one glyph at the specified points with this function. As with plmtex and plptex, the user string can contain FCI escapes to determine the font, UTF-8 code to determine the glyph or else PLplot escapes for Hershey or unicode text to determine the glyph. Redacted form: plstring3(x, y, z, string) This function is used in example 18. SYNOPSIS: plstring3(n, x, y, z, string) ARGUMENTS: n (PLINT, input) : Number of points in the x, y, and z arrays. x (PLFLT *, input) : Pointer to an array with X coordinates of points. y (PLFLT *, input) : Pointer to an array with Y coordinates of points. z (PLFLT *, input) : Pointer to an array with Z coordinates of points. string (const char *, input) : PLplot user string corresponding to the glyph to be plotted at each of the n points.
Definition at line 5853 of file plplotc.py.
def plplotc.plstripa | ( | args | ) |
Add a point to a stripchart DESCRIPTION: Add a point to a given pen of a given stripchart. There is no need for all pens to have the same number of points or to be equally sampled in the x coordinate. Allocates memory and rescales as necessary. Redacted form: plstripa(id, p, x, y) This function is used in example 17. SYNOPSIS: plstripa(id, p, x, y) ARGUMENTS: id (PLINT, input) : Identification number (set up in plstripc) of the stripchart. p (PLINT, input) : Pen number (ranges from 0 to 3). x (PLFLT, input) : X coordinate of point to plot. y (PLFLT, input) : Y coordinate of point to plot.
Definition at line 5899 of file plplotc.py.
def plplotc.plstripc | ( | args | ) |
Create a 4-pen stripchart DESCRIPTION: Create a 4-pen stripchart, to be used afterwards by plstripa Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline, labx, laby, labz) Perl/PDL: plstripc(xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, id, xspec, ypsec, legline, labx, laby, labtop) This function is used in example 17. SYNOPSIS: plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop) ARGUMENTS: id (PLINT *, output) : Identification number of stripchart to use on plstripa and plstripd. xspec (char *, input) : X-axis specification as in plbox. yspec (char *, input) : Y-axis specification as in plbox. xmin (PLFLT, input) : Initial coordinates of plot box; they will change as data are added. xmax (PLFLT, input) : Initial coordinates of plot box; they will change as data are added. xjump (PLFLT, input) : When x attains xmax, the length of the plot is multiplied by the factor (1 + xjump). ymin (PLFLT, input) : Initial coordinates of plot box; they will change as data are added. ymax (PLFLT, input) : Initial coordinates of plot box; they will change as data are added. xlpos (PLFLT, input) : X legend box position (range from 0 to 1). ylpos (PLFLT, input) : Y legend box position (range from 0 to 1). y_ascl (PLBOOL, input) : Autoscale y between x jumps if y_ascl is true, otherwise not. acc (PLBOOL, input) : Accumulate strip plot if acc is true, otherwise slide display. colbox (PLINT, input) : Plot box color index (cmap0). collab (PLINT, input) : Legend color index (cmap0). colline (PLINT *, input) : Pointer to array with color indices (cmap0) for the 4 pens. styline (PLINT *, input) : Pointer to array with line styles for the 4 pens. legline (char **, input) : Pointer to character array containing legends for the 4 pens. labx (char *, input) : X-axis label. laby (char *, input) : Y-axis label. labtop (char *, input) : Plot title.
Definition at line 5933 of file plplotc.py.
def plplotc.plstripd | ( | args | ) |
Deletes and releases memory used by a stripchart DESCRIPTION: Deletes and releases memory used by a stripchart. Redacted form: plstripd(id) This function is used in example 17. SYNOPSIS: plstripd(id) ARGUMENTS: id (PLINT, input) : Identification number of stripchart to delete.
Definition at line 6014 of file plplotc.py.
def plplotc.plstyl | ( | args | ) |
Set line style DESCRIPTION: This sets up the line style for all lines subsequently drawn. A line consists of segments in which the pen is alternately down and up. The lengths of these segments are passed in the arrays mark and space respectively. The number of mark-space pairs is specified by nels. In order to return the line style to the default continuous line, plstyl should be called with nels=0.(see also pllsty) Redacted form: plstyl(mark, space) This function is used in examples 1,9,14. SYNOPSIS: plstyl(nels, mark, space) ARGUMENTS: nels (PLINT, input) : The number of mark and space elements in a line. Thus a simple broken line can be obtained by setting nels=1. A continuous line is specified by setting nels=0. mark (PLINT *, input) : Pointer to array with the lengths of the segments during which the pen is down, measured in micrometers. space (PLINT *, input) : Pointer to array with the lengths of the segments during which the pen is up, measured in micrometers.
Definition at line 6039 of file plplotc.py.
def plplotc.plsurf3d | ( | args | ) |
Plot shaded 3-d surface plot DESCRIPTION: Plots a three dimensional shaded surface plot within the environment set up by plw3d. The surface is defined by the two-dimensional array z[ nx][ ny], the point z[i][j] being the value of the function at ( x[i], y[j]). Note that the points in arrays x and y do not need to be equally spaced, but must be stored in ascending order. For further details see the PLplot documentation. Redacted form: plsurf3d(x, y, z, opt, clevel) This function is not used in any examples. SYNOPSIS: plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel) ARGUMENTS: x (PLFLT *, input) : Pointer to set of x coordinate values at which the function is evaluated. y (PLFLT *, input) : Pointer to set of y coordinate values at which the function is evaluated. z (PLFLT **, input) : Pointer to a vectored two-dimensional array with set of function values. nx (PLINT, input) : Number of x values at which function is evaluated. ny (PLINT, input) : Number of y values at which function is evaluated. opt (PLINT, input) : Determines the way in which the surface is represented. To specify more than one option just add the options, e.g. FACETED + SURF_CONT opt=FACETED: Network of lines is drawn connecting points at which function is defined. opt=BASE_CONT: A contour plot is drawn at the base XY plane using parameters nlevel and clevel. opt=SURF_CONT: A contour plot is drawn at the surface plane using parameters nlevel and clevel. opt=DRAW_SIDES: draws a curtain between the base XY plane and the borders of the plotted function. opt=MAG_COLOR: the surface is colored according to the value of Z; if MAG_COLOR is not used, then the default the surface is colored according to the intensity of the reflected light in the surface from a light source whose position is set using pllightsource. clevel (PLFLT *, input) : Pointer to the array that defines the contour level spacing. nlevel (PLINT, input) : Number of elements in the clevel array.
Definition at line 3424 of file plplotc.py.
def plplotc.plsurf3dl | ( | args | ) |
Definition at line 3496 of file plplotc.py.
def plplotc.plsvect | ( | args | ) |
Set arrow style for vector plots DESCRIPTION: Set the style for the arrow used by plvect to plot vectors. Redacted form: plsvect(arrowx, arrowy, fill) This function is used in example 22. SYNOPSIS: plsvect(arrowx, arrowy, npts, fill) ARGUMENTS: arrowx, arrowy (PLFLT *,input) : Pointers to a pair of arrays containing the x and y points which make up the arrow. The arrow is plotted by joining these points to form a polygon. The scaling assumes that the x and y points in the arrow lie in the range -0.5 <= x,y <= 0.5. npts (PLINT,input) : Number of points in the arrays arrowx and arrowy. fill (PLBOOL,input) : If fill is true then the arrow is closed, if fill is false then the arrow is open.
Definition at line 6077 of file plplotc.py.
def plplotc.plsvpa | ( | args | ) |
Specify viewport in absolute coordinates DESCRIPTION: Alternate routine to plvpor for setting up the viewport. This routine should be used only if the viewport is required to have a definite size in millimeters. The routine plgspa is useful for finding out the size of the current subpage. Redacted form: plsvpa(xmin, xmax, ymin, ymax) This function is used in example 10. SYNOPSIS: plsvpa(xmin, xmax, ymin, ymax) ARGUMENTS: xmin (PLFLT, input) : The distance of the left-hand edge of the viewport from the left-hand edge of the subpage in millimeters. xmax (PLFLT, input) : The distance of the right-hand edge of the viewport from the left-hand edge of the subpage in millimeters. ymin (PLFLT, input) : The distance of the bottom edge of the viewport from the bottom edge of the subpage in millimeters. ymax (PLFLT, input) : The distance of the top edge of the viewport from the bottom edge of the subpage in millimeters.
Definition at line 6112 of file plplotc.py.
def plplotc.plsxax | ( | args | ) |
Set x axis parameters DESCRIPTION: Sets values of the digmax and digits flags for the x axis. See the PLplot documentation for more information. Redacted form: plsxax(digmax, digits) This function is used in example 31. SYNOPSIS: plsxax(digmax, digits) ARGUMENTS: digmax (PLINT, input) : Variable to set the maximum number of digits for the x axis. If nonzero, the printed label will be switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT, input) : Field digits value. Currently, changing its value here has no effect since it is set only by plbox or plbox3. However, the user may obtain its value after a call to either of these functions by calling plgxax.
Definition at line 6150 of file plplotc.py.
def plplotc.plsxwin | ( | args | ) |
Definition at line 264 of file plplotc.py.
def plplotc.plsyax | ( | args | ) |
Set y axis parameters DESCRIPTION: Identical to plsxax, except that arguments are flags for y axis. See the description of plsxax for more detail. Redacted form: plsyax(digmax, digits) This function is used in examples 1,14,31. SYNOPSIS: plsyax(digmax, digits) ARGUMENTS: digmax (PLINT, input) : Variable to set the maximum number of digits for the y axis. If nonzero, the printed label will be switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT, input) : Field digits value. Currently, changing its value here has no effect since it is set only by plbox or plbox3. However, the user may obtain its value after a call to either of these functions by calling plgyax.
Definition at line 6184 of file plplotc.py.
def plplotc.plsym | ( | args | ) |
Plot a glyph at the specified points DESCRIPTION: Plot a glyph at the specified points. (This function is largely superseded by plstring which gives access to many[!] more glyphs.) Redacted form: plsym(x, y, code) This function is used in example 7. SYNOPSIS: plsym(n, x, y, code) ARGUMENTS: n (PLINT, input) : Number of points in the x and y arrays. x (PLFLT *, input) : Pointer to an array with X coordinates of points. y (PLFLT *, input) : Pointer to an array with Y coordinates of points. code (PLINT, input) : Hershey symbol code corresponding to a glyph to be plotted at each of the n points.
Definition at line 6218 of file plplotc.py.
def plplotc.plszax | ( | args | ) |
Set z axis parameters DESCRIPTION: Identical to plsxax, except that arguments are flags for z axis. See the description of plsxax for more detail. Redacted form: plszax(digmax, digits) This function is used in example 31. SYNOPSIS: plszax(digmax, digits) ARGUMENTS: digmax (PLINT, input) : Variable to set the maximum number of digits for the z axis. If nonzero, the printed label will be switched to a floating point representation when the number of digits exceeds digmax. digits (PLINT, input) : Field digits value. Currently, changing its value here has no effect since it is set only by plbox or plbox3. However, the user may obtain its value after a call to either of these functions by calling plgzax.
Definition at line 6253 of file plplotc.py.
def plplotc.pltext | ( | ) |
Switch to text screen DESCRIPTION: Sets an interactive device to text mode, used in conjunction with plgra to allow graphics and text to be interspersed. On a device which supports separate text and graphics windows, this command causes control to be switched to the text window. This can be useful for printing diagnostic messages or getting user input, which would otherwise interfere with the plots. The program must switch back to the graphics window before issuing plot commands, as the text (or console) device will probably become quite confused otherwise. If already in text mode, this command is ignored. It is also ignored on devices which only support a single window or use a different method for shifting focus (see also plgra). Redacted form: pltext() This function is used in example 1. SYNOPSIS: pltext()
Definition at line 6287 of file plplotc.py.
def plplotc.pltimefmt | ( | args | ) |
Set format for date / time labels DESCRIPTION: Sets the format for date / time labels. To enable date / time format labels see the options to plbox and plenv. Redacted form: pltimefmt(fmt) This function is used in example 29. SYNOPSIS: pltimefmt(fmt) ARGUMENTS: fmt (const char *, fmt) : This string is passed directly to the system strftime. See the system documentation for a full list of conversion specifications for your system. All conversion specifications take the form of a '%' character followed by further conversion specification character. All other text is printed as-is. Common options include: %c: The preferred date and time representation for the current locale. %d: The day of the month as a decimal number. %H: The hour as a decimal number using a 24-hour clock. %j: The day of the year as a decimal number. %m: The month as a decimal number. %M: The minute as a decimal number. %S: The second as a decimal number. %y: The year as a decimal number without a century. %Y: The year as a decimal number including a century.
Definition at line 6318 of file plplotc.py.
def plplotc.pltr0 | ( | args | ) |
Definition at line 73 of file plplotc.py.
def plplotc.pltr1 | ( | args | ) |
Definition at line 77 of file plplotc.py.
def plplotc.pltr2 | ( | args | ) |
Definition at line 81 of file plplotc.py.
def plplotc.plvasp | ( | args | ) |
Specify viewport using aspect ratio only DESCRIPTION: Sets the viewport so that the ratio of the length of the y axis to that of the x axis is equal to aspect. Redacted form: plvasp(aspect) This function is used in example 13. SYNOPSIS: plvasp(aspect) ARGUMENTS: aspect (PLFLT, input) : Ratio of length of y axis to length of x axis.
Definition at line 6358 of file plplotc.py.
def plplotc.plvect | ( | args | ) |
Vector plot DESCRIPTION: Draws a vector plot of the vector ( u[ nx][ ny], v[ nx][ ny]). The scaling factor for the vectors is given by scale. A transformation routine pointed to by pltr with a pointer pltr_data for additional data required by the transformation routine is used to map indices within the array to the world coordinates. The style of the vector arrow may be set using plsvect. Redacted form: plvect(u, v, scale, pltr, pltr_data) This function is used in example 22. SYNOPSIS: plvect(u, v, nx, ny, scale, pltr, pltr_data) ARGUMENTS: u, v (PLFLT **, input) : Pointers to a pair of vectored two-dimensional arrays containing the x and y components of the vector data to be plotted. nx, ny (PLINT, input) : Physical dimensions of the arrays u and v. scale (PLFLT, input) : Parameter to control the scaling factor of the vectors for plotting. If scale = 0 then the scaling factor is automatically calculated for the data. If scale < 0 then the scaling factor is automatically calculated for the data and then multiplied by - scale. If scale > 0 then the scaling factor is set to scale. pltr (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) : Pointer to function that defines transformation between indices in array z and the world coordinates (C only). Transformation functions are provided in the PLplot library: pltr0 for identity mapping, and pltr1 and pltr2 for arbitrary mappings respectively defined by one- and two-dimensional arrays. In addition, user-supplied routines for the transformation can be used as well. Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of pltr0, pltr1, or pltr2. pltr_data (PLPointer, input) : Extra parameter to help pass information to pltr0, pltr1, pltr2, or whatever routine that is externally supplied.
Definition at line 6385 of file plplotc.py.
def plplotc.plvpas | ( | args | ) |
Specify viewport using coordinates and aspect ratio DESCRIPTION: Device-independent routine for setting up the viewport. The viewport is chosen to be the largest with the given aspect ratio that fits within the specified region (in terms of normalized subpage coordinates). This routine is functionally equivalent to plvpor when a ``natural'' aspect ratio (0.0) is chosen. Unlike plvasp, this routine reserves no extra space at the edges for labels. Redacted form: plvpas(xmin, xmax, ymin, ymax, aspect) This function is used in example 9. SYNOPSIS: plvpas(xmin, xmax, ymin, ymax, aspect) ARGUMENTS: xmin (PLFLT, input) : The normalized subpage coordinate of the left-hand edge of the viewport. xmax (PLFLT, input) : The normalized subpage coordinate of the right-hand edge of the viewport. ymin (PLFLT, input) : The normalized subpage coordinate of the bottom edge of the viewport. ymax (PLFLT, input) : The normalized subpage coordinate of the top edge of the viewport. aspect (PLFLT, input) : Ratio of length of y axis to length of x axis.
Definition at line 6446 of file plplotc.py.
def plplotc.plvpor | ( | args | ) |
Specify viewport using coordinates DESCRIPTION: Device-independent routine for setting up the viewport. This defines the viewport in terms of normalized subpage coordinates which run from 0.0 to 1.0 (left to right and bottom to top) along each edge of the current subpage. Use the alternate routine plsvpa in order to create a viewport of a definite size. Redacted form: plvpor(xmin, xmax, ymin, ymax) This function is used in examples 2,6-8,10,11,15,16,18,21,23,24,26,27,31. SYNOPSIS: plvpor(xmin, xmax, ymin, ymax) ARGUMENTS: xmin (PLFLT, input) : The normalized subpage coordinate of the left-hand edge of the viewport. xmax (PLFLT, input) : The normalized subpage coordinate of the right-hand edge of the viewport. ymin (PLFLT, input) : The normalized subpage coordinate of the bottom edge of the viewport. ymax (PLFLT, input) : The normalized subpage coordinate of the top edge of the viewport.
Definition at line 6489 of file plplotc.py.
def plplotc.plvsta | ( | ) |
Select standard viewport DESCRIPTION: Sets up a standard viewport, leaving a left-hand margin of seven character heights, and four character heights around the other three sides. Redacted form: plvsta() This function is used in examples 1,12,14,17,25,29. SYNOPSIS: plvsta()
Definition at line 6529 of file plplotc.py.
def plplotc.plw3d | ( | args | ) |
Set up window for 3-d plotting DESCRIPTION: Sets up a window for a three-dimensional surface plot within the currently defined two-dimensional window. The enclosing box for the surface plot defined by xmin, xmax, ymin, ymax, zmin and zmax in user-coordinate space is mapped into a box of world coordinate size basex by basey by height so that xmin maps to - basex/2, xmax maps to basex/2, ymin maps to - basey/2, ymax maps to basey/2, zmin maps to 0 and zmax maps to height. The resulting world-coordinate box is then viewed by an observer at altitude alt and azimuth az. This routine must be called before plbox3 or plot3d. For a more complete description of three-dimensional plotting see the PLplot documentation. Redacted form: plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az) This function is examples 8,11,18,21. SYNOPSIS: plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az) ARGUMENTS: basex (PLFLT, input) : The x coordinate size of the world-coordinate box. basey (PLFLT, input) : The y coordinate size of the world-coordinate box. height (PLFLT, input) : The z coordinate size of the world-coordinate box. xmin (PLFLT, input) : The minimum user x coordinate value. xmax (PLFLT, input) : The maximum user x coordinate value. ymin (PLFLT, input) : The minimum user y coordinate value. ymax (PLFLT, input) : The maximum user y coordinate value. zmin (PLFLT, input) : The minimum user z coordinate value. zmax (PLFLT, input) : The maximum user z coordinate value. alt (PLFLT, input) : The viewing altitude in degrees above the XY plane. az (PLFLT, input) : The viewing azimuth in degrees. When az=0, the observer is looking face onto the ZX plane, and as az is increased, the observer moves clockwise around the box when viewed from above the XY plane.
Definition at line 6552 of file plplotc.py.
def plplotc.plwidth | ( | args | ) |
Set pen width DESCRIPTION: Sets the pen width. Redacted form: plwidth(width) This function is used in examples 1,2. SYNOPSIS: plwidth(width) ARGUMENTS: width (PLINT, input) : The desired pen width. If width is negative or the same as the previous value no action is taken. width = 0 should be interpreted as as the minimum valid pen width for the device. The interpretation of positive width values is also device dependent.
Definition at line 6615 of file plplotc.py.
def plplotc.plwind | ( | args | ) |
Specify world coordinates of viewport boundaries DESCRIPTION: Sets up the world coordinates of the edges of the viewport. Redacted form: plwind(xmin, xmax, ymin, ymax) This function is used in examples 1,2,4,6-12,14-16,18,21,23-27,29,31. SYNOPSIS: plwind(xmin, xmax, ymin, ymax) ARGUMENTS: xmin (PLFLT, input) : The world x coordinate of the left-hand edge of the viewport. xmax (PLFLT, input) : The world x coordinate of the right-hand edge of the viewport. ymin (PLFLT, input) : The world y coordinate of the bottom edge of the viewport. ymax (PLFLT, input) : The world y coordinate of the top edge of the viewport.
Definition at line 6644 of file plplotc.py.
def plplotc.plxormod | ( | args | ) |
Enter or leave xor mode DESCRIPTION: Enter (when mode is true) or leave (when mode is false) xor mode for those drivers (e.g., the xwin driver) that support it. Enables erasing plots by drawing twice the same line, symbol, etc. If driver is not capable of xor operation it returns a status of false. Redacted form: plxormod(mode, status) This function is used in examples 1,20. SYNOPSIS: plxormod(mode, status) ARGUMENTS: mode (PLBOOL, input) : mode is true means enter xor mode and mode is false means leave xor mode. status (PLBOOL *, output) : Pointer to status. Returned modestatus of true (false) means driver is capable (incapable) of xor mode.
Definition at line 6679 of file plplotc.py.
def plplotc.swig_import_helper | ( | ) |
Definition at line 13 of file plplotc.py.
int plplotc._newclass = 0 |
Definition at line 69 of file plplotc.py.
tuple plplotc._plplotc = swig_import_helper() |
Definition at line 28 of file plplotc.py.
plplotc.BASE_CONT = _plplotc.BASE_CONT |
Definition at line 110 of file plplotc.py.
plplotc.DRAW_LINEX = _plplotc.DRAW_LINEX |
Definition at line 106 of file plplotc.py.
plplotc.DRAW_LINEXY = _plplotc.DRAW_LINEXY |
Definition at line 108 of file plplotc.py.
plplotc.DRAW_LINEY = _plplotc.DRAW_LINEY |
Definition at line 107 of file plplotc.py.
plplotc.DRAW_SIDES = _plplotc.DRAW_SIDES |
Definition at line 113 of file plplotc.py.
plplotc.FACETED = _plplotc.FACETED |
Definition at line 114 of file plplotc.py.
plplotc.GRID_CSA = _plplotc.GRID_CSA |
Definition at line 257 of file plplotc.py.
plplotc.GRID_DTLI = _plplotc.GRID_DTLI |
Definition at line 258 of file plplotc.py.
plplotc.GRID_NNAIDW = _plplotc.GRID_NNAIDW |
Definition at line 262 of file plplotc.py.
plplotc.GRID_NNI = _plplotc.GRID_NNI |
Definition at line 259 of file plplotc.py.
plplotc.GRID_NNIDW = _plplotc.GRID_NNIDW |
Definition at line 260 of file plplotc.py.
plplotc.GRID_NNLI = _plplotc.GRID_NNLI |
Definition at line 261 of file plplotc.py.
plplotc.MAG_COLOR = _plplotc.MAG_COLOR |
Definition at line 109 of file plplotc.py.
plplotc.MESH = _plplotc.MESH |
Definition at line 115 of file plplotc.py.
plplotc.PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED |
Definition at line 117 of file plplotc.py.
plplotc.PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT |
Definition at line 116 of file plplotc.py.
plplotc.PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY |
Definition at line 119 of file plplotc.py.
plplotc.PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND |
Definition at line 118 of file plplotc.py.
plplotc.PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND |
Definition at line 156 of file plplotc.py.
plplotc.PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX |
Definition at line 157 of file plplotc.py.
plplotc.PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH |
Definition at line 150 of file plplotc.py.
plplotc.PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW |
Definition at line 149 of file plplotc.py.
plplotc.PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE |
Definition at line 148 of file plplotc.py.
plplotc.PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT |
Definition at line 147 of file plplotc.py.
plplotc.PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE |
Definition at line 145 of file plplotc.py.
plplotc.PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM |
Definition at line 144 of file plplotc.py.
plplotc.PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT |
Definition at line 141 of file plplotc.py.
plplotc.PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT |
Definition at line 142 of file plplotc.py.
plplotc.PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP |
Definition at line 143 of file plplotc.py.
plplotc.PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM |
Definition at line 155 of file plplotc.py.
plplotc.PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT |
Definition at line 154 of file plplotc.py.
plplotc.PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT |
Definition at line 152 of file plplotc.py.
plplotc.PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP |
Definition at line 153 of file plplotc.py.
plplotc.PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE |
Definition at line 146 of file plplotc.py.
plplotc.PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL |
Definition at line 151 of file plplotc.py.
plplotc.PL_FCI_BOLD = _plplotc.PL_FCI_BOLD |
Definition at line 199 of file plplotc.py.
plplotc.PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY |
Definition at line 187 of file plplotc.py.
plplotc.PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK |
Definition at line 184 of file plplotc.py.
plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE |
Definition at line 186 of file plplotc.py.
plplotc.PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK |
Definition at line 185 of file plplotc.py.
plplotc.PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE |
Definition at line 183 of file plplotc.py.
plplotc.PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC |
Definition at line 196 of file plplotc.py.
plplotc.PL_FCI_MARK = _plplotc.PL_FCI_MARK |
Definition at line 182 of file plplotc.py.
plplotc.PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM |
Definition at line 198 of file plplotc.py.
plplotc.PL_FCI_MONO = _plplotc.PL_FCI_MONO |
Definition at line 192 of file plplotc.py.
plplotc.PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE |
Definition at line 197 of file plplotc.py.
plplotc.PL_FCI_SANS = _plplotc.PL_FCI_SANS |
Definition at line 190 of file plplotc.py.
plplotc.PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT |
Definition at line 193 of file plplotc.py.
plplotc.PL_FCI_SERIF = _plplotc.PL_FCI_SERIF |
Definition at line 191 of file plplotc.py.
plplotc.PL_FCI_STYLE = _plplotc.PL_FCI_STYLE |
Definition at line 188 of file plplotc.py.
plplotc.PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL |
Definition at line 194 of file plplotc.py.
plplotc.PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT |
Definition at line 195 of file plplotc.py.
plplotc.PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT |
Definition at line 189 of file plplotc.py.
plplotc.PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT |
Definition at line 120 of file plplotc.py.
plplotc.PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS |
Definition at line 122 of file plplotc.py.
plplotc.PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY |
Definition at line 124 of file plplotc.py.
plplotc.PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND |
Definition at line 123 of file plplotc.py.
plplotc.PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING |
Definition at line 121 of file plplotc.py.
plplotc.PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND |
Definition at line 138 of file plplotc.py.
plplotc.PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX |
Definition at line 139 of file plplotc.py.
plplotc.PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX |
Definition at line 134 of file plplotc.py.
plplotc.PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE |
Definition at line 135 of file plplotc.py.
plplotc.PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE |
Definition at line 133 of file plplotc.py.
plplotc.PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR |
Definition at line 140 of file plplotc.py.
plplotc.PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL |
Definition at line 136 of file plplotc.py.
plplotc.PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT |
Definition at line 137 of file plplotc.py.
plplotc.PL_MAXKEY = _plplotc.PL_MAXKEY |
Definition at line 200 of file plplotc.py.
plplotc.PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS |
Definition at line 252 of file plplotc.py.
plplotc.PL_NOTSET = _plplotc.PL_NOTSET |
Definition at line 253 of file plplotc.py.
plplotc.PL_OPT_ARG = _plplotc.PL_OPT_ARG |
Definition at line 164 of file plplotc.py.
plplotc.PL_OPT_BOOL = _plplotc.PL_OPT_BOOL |
Definition at line 169 of file plplotc.py.
plplotc.PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED |
Definition at line 167 of file plplotc.py.
plplotc.PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED |
Definition at line 163 of file plplotc.py.
plplotc.PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT |
Definition at line 171 of file plplotc.py.
plplotc.PL_OPT_FUNC = _plplotc.PL_OPT_FUNC |
Definition at line 168 of file plplotc.py.
plplotc.PL_OPT_INT = _plplotc.PL_OPT_INT |
Definition at line 170 of file plplotc.py.
plplotc.PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE |
Definition at line 166 of file plplotc.py.
plplotc.PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE |
Definition at line 165 of file plplotc.py.
plplotc.PL_OPT_STRING = _plplotc.PL_OPT_STRING |
Definition at line 172 of file plplotc.py.
plplotc.PL_PARSE_FULL = _plplotc.PL_PARSE_FULL |
Definition at line 174 of file plplotc.py.
plplotc.PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH |
Definition at line 180 of file plplotc.py.
plplotc.PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE |
Definition at line 176 of file plplotc.py.
plplotc.PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM |
Definition at line 179 of file plplotc.py.
plplotc.PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE |
Definition at line 178 of file plplotc.py.
plplotc.PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL |
Definition at line 173 of file plplotc.py.
plplotc.PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET |
Definition at line 175 of file plplotc.py.
plplotc.PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL |
Definition at line 177 of file plplotc.py.
plplotc.PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP |
Definition at line 181 of file plplotc.py.
plplotc.PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM |
Definition at line 128 of file plplotc.py.
plplotc.PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE |
Definition at line 129 of file plplotc.py.
plplotc.PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT |
Definition at line 125 of file plplotc.py.
plplotc.PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE |
Definition at line 130 of file plplotc.py.
plplotc.PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT |
Definition at line 126 of file plplotc.py.
plplotc.PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE |
Definition at line 132 of file plplotc.py.
plplotc.PL_POSITION_TOP = _plplotc.PL_POSITION_TOP |
Definition at line 127 of file plplotc.py.
plplotc.PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT |
Definition at line 131 of file plplotc.py.
plplotc.PL_X_AXIS = _plplotc.PL_X_AXIS |
Definition at line 160 of file plplotc.py.
plplotc.PL_Y_AXIS = _plplotc.PL_Y_AXIS |
Definition at line 161 of file plplotc.py.
plplotc.PL_Z_AXIS = _plplotc.PL_Z_AXIS |
Definition at line 162 of file plplotc.py.
plplotc.plbtime = _plplotc.plbtime |
Definition at line 562 of file plplotc.py.
plplotc.plClearOpts = _plplotc.plClearOpts |
Definition at line 6942 of file plplotc.py.
plplotc.plcolorbar = _plplotc.plcolorbar |
Definition at line 2938 of file plplotc.py.
plplotc.plconfigtime = _plplotc.plconfigtime |
Definition at line 965 of file plplotc.py.
plplotc.plctime = _plplotc.plctime |
Definition at line 1038 of file plplotc.py.
plplotc.PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL |
Definition at line 85 of file plplotc.py.
plplotc.PLESC_CLEAR = _plplotc.PLESC_CLEAR |
Definition at line 101 of file plplotc.py.
plplotc.PLESC_DASH = _plplotc.PLESC_DASH |
Definition at line 102 of file plplotc.py.
plplotc.PLESC_DI = _plplotc.PLESC_DI |
Definition at line 93 of file plplotc.py.
plplotc.PLESC_EH = _plplotc.PLESC_EH |
Definition at line 95 of file plplotc.py.
plplotc.PLESC_EXPOSE = _plplotc.PLESC_EXPOSE |
Definition at line 87 of file plplotc.py.
plplotc.PLESC_FILL = _plplotc.PLESC_FILL |
Definition at line 92 of file plplotc.py.
plplotc.PLESC_FLUSH = _plplotc.PLESC_FLUSH |
Definition at line 94 of file plplotc.py.
plplotc.PLESC_GETC = _plplotc.PLESC_GETC |
Definition at line 96 of file plplotc.py.
plplotc.PLESC_GRAPH = _plplotc.PLESC_GRAPH |
Definition at line 91 of file plplotc.py.
plplotc.PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT |
Definition at line 103 of file plplotc.py.
plplotc.PLESC_IMAGE = _plplotc.PLESC_IMAGE |
Definition at line 104 of file plplotc.py.
plplotc.PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS |
Definition at line 105 of file plplotc.py.
plplotc.PLESC_PLFLTBUFFERING = _plplotc.PLESC_PLFLTBUFFERING |
Definition at line 98 of file plplotc.py.
plplotc.PLESC_REDRAW = _plplotc.PLESC_REDRAW |
Definition at line 89 of file plplotc.py.
plplotc.PLESC_RESIZE = _plplotc.PLESC_RESIZE |
Definition at line 88 of file plplotc.py.
plplotc.PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION |
Definition at line 100 of file plplotc.py.
plplotc.PLESC_SET_LPB = _plplotc.PLESC_SET_LPB |
Definition at line 86 of file plplotc.py.
plplotc.PLESC_SET_RGB = _plplotc.PLESC_SET_RGB |
Definition at line 84 of file plplotc.py.
plplotc.PLESC_SWIN = _plplotc.PLESC_SWIN |
Definition at line 97 of file plplotc.py.
plplotc.PLESC_TEXT = _plplotc.PLESC_TEXT |
Definition at line 90 of file plplotc.py.
plplotc.PLESC_XORMOD = _plplotc.PLESC_XORMOD |
Definition at line 99 of file plplotc.py.
plplotc.PLESPLFLTBUFFERING_DISABLE = _plplotc.PLESPLFLTBUFFERING_DISABLE |
Definition at line 255 of file plplotc.py.
plplotc.PLESPLFLTBUFFERING_ENABLE = _plplotc.PLESPLFLTBUFFERING_ENABLE |
Definition at line 254 of file plplotc.py.
plplotc.PLESPLFLTBUFFERING_QUERY = _plplotc.PLESPLFLTBUFFERING_QUERY |
Definition at line 256 of file plplotc.py.
plplotc.plgcmap1_range = _plplotc.plgcmap1_range |
Definition at line 4435 of file plplotc.py.
plplotc.plGetCursor = _plplotc.plGetCursor |
Definition at line 6962 of file plplotc.py.
plplotc.PLGraphicsIn_swigregister = _plplotc.PLGraphicsIn_swigregister |
Definition at line 249 of file plplotc.py.
plplotc.plMinMax2dGrid = _plplotc.plMinMax2dGrid |
Definition at line 6958 of file plplotc.py.
plplotc.plOptUsage = _plplotc.plOptUsage |
Definition at line 6954 of file plplotc.py.
plplotc.plot3dcl = _plplotc.plot3dcl |
Definition at line 3422 of file plplotc.py.
plplotc.plResetOpts = _plplotc.plResetOpts |
Definition at line 6946 of file plplotc.py.
plplotc.plscmap1_range = _plplotc.plscmap1_range |
Definition at line 4431 of file plplotc.py.
plplotc.plSetUsage = _plplotc.plSetUsage |
Definition at line 6950 of file plplotc.py.
plplotc.plsurf3dl = _plplotc.plsurf3dl |
Definition at line 3498 of file plplotc.py.
plplotc.PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE |
Definition at line 158 of file plplotc.py.
plplotc.PLSWIN_WORLD = _plplotc.PLSWIN_WORLD |
Definition at line 159 of file plplotc.py.
plplotc.plsxwin = _plplotc.plsxwin |
Definition at line 266 of file plplotc.py.
plplotc.pltr0 = _plplotc.pltr0 |
Definition at line 75 of file plplotc.py.
plplotc.pltr1 = _plplotc.pltr1 |
Definition at line 79 of file plplotc.py.
plplotc.pltr2 = _plplotc.pltr2 |
Definition at line 83 of file plplotc.py.
plplotc.SURF_CONT = _plplotc.SURF_CONT |
Definition at line 112 of file plplotc.py.
plplotc.TOP_CONT = _plplotc.TOP_CONT |
Definition at line 111 of file plplotc.py.