Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[11484] trunk/bindings/swig-support/swig_documentation.i
|
From: <ai...@us...> - 2011-01-11 23:26:51
|
Revision: 11484
http://plplot.svn.sourceforge.net/plplot/?rev=11484&view=rev
Author: airwin
Date: 2011-01-11 23:26:42 +0000 (Tue, 11 Jan 2011)
Log Message:
-----------
Initial commit of a file generated on Unix by running the
check_swig_documentation target and copying the generated
bindings/swig-support/swig_documentation.i_compare from the build tree
to bindings/swig_support/swig_documentation.i in the source tree.
Further adjustments (if necessary) to this file format can be made by
changing doc/docbook/bin/api2swigdoc.pl (the perl script used by the
check_swig_documentation target), running the check_swig_documentation
target, and copying the build-tree result to the source tree as
indicated above.
Added Paths:
-----------
trunk/bindings/swig-support/swig_documentation.i
Added: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i (rev 0)
+++ trunk/bindings/swig-support/swig_documentation.i 2011-01-11 23:26:42 UTC (rev 11484)
@@ -0,0 +1,6155 @@
+// This file is generated by doc/docbook/src/api2swigdoc.pl from
+// doc/docbook/src/api.xml. Do not modify by hand since this file
+// will be overwritten. Edit doc/docbook/src/api.xml instead.
+
+%feature( "docstring", "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.
+") pl_setcontlabelformat
+
+%feature( "docstring", "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).
+") pl_setcontlabelparam
+
+%feature( "docstring", "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.
+") pladv
+
+%feature( "docstring", "Draw a circular or elliptical arc
+
+DESCRIPTION:
+
+ Draw a possible 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, fill)
+
+
+ This function is used in example 3.
+
+
+
+SYNOPSIS:
+
+plarc(x, y, a, b, angle1, angle2, 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.
+
+ angle2 (PLFLT, input) : Ending angle of the arc.
+
+ fill (PLBOOL, input) : Draw a filled arc.
+") plarc
+
+%feature( "docstring", "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.
+") plaxes
+
+%feature( "docstring", "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).
+") plbin
+
+%feature( "docstring", "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()
+") plbop
+
+%feature( "docstring", "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.
+
+
+ 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.
+") plbox
+
+%feature( "docstring", "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.
+") plbox3
+
+%feature( "docstring", "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.
+") plcalc_world
+
+%feature( "docstring", "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()
+") plclear
+
+%feature( "docstring", "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 yellow3 green4 aquamarine5
+ pink6 wheat7 grey8 brown9 blue10 BlueViolet11 cyan12 turquoise13
+ magenta14 salmon15 white Use plscmap0 to change the entire map0
+ color palette and plscol0 to change an individual color in the
+ map0 color palette.
+") plcol0
+
+%feature( "docstring", "Set color, map1
+
+DESCRIPTION:
+
+ Sets the color for color map1 (see the PLplot documentation).
+
+ Redacted form: plcol1(col1)
+
+ This function is used in example 12.
+
+
+
+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.
+") plcol1
+
+%feature( "docstring", "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.
+") plcont
+
+%feature( "docstring", "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.
+") plcpstrm
+
+%feature( "docstring", "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()
+") plend
+
+%feature( "docstring", "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()
+") plend1
+
+%feature( "docstring", "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.
+") plenv0
+
+%feature( "docstring", "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.
+") plenv
+
+%feature( "docstring", "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()
+") pleop
+
+%feature( "docstring", "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.
+") plerrx
+
+%feature( "docstring", "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.
+") plerry
+
+%feature( "docstring", "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()
+") plfamadv
+
+%feature( "docstring", "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 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.
+") plfill
+
+%feature( "docstring", "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.
+") plfill3
+
+%feature( "docstring", "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()
+") plflush
+
+%feature( "docstring", "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
+") plfont
+
+%feature( "docstring", "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
+") plfontld
+
+%feature( "docstring", "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).
+") plgchr
+
+%feature( "docstring", "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.
+") plgcol0
+
+%feature( "docstring", "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.
+") plgcol0a
+
+%feature( "docstring", " Returns the background color (cmap0[0]) by 8-bit RGB value
+
+DESCRIPTION:
+
+ Returns the background color (cmap0[0]) by 8-bit RGB value.
+
+ Redacted form: plgcolbg(r, g, b)
+
+ This function is used in example 31.
+
+
+
+SYNOPSIS:
+
+plgcolbg(r, g, b)
+
+ARGUMENTS:
+
+ 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.
+") plgcolbg
+
+%feature( "docstring", " Returns the background color (cmap0[0]) by 8-bit RGB value and double alpha value.
+
+DESCRIPTION:
+
+ Returns the background color (cmap0[0]) by 8-bit RGB value and double
+ alpha value.
+
+ This function is used in example 31.
+
+
+
+SYNOPSIS:
+
+plgcolbga(r, g, b, a)
+
+ARGUMENTS:
+
+ 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.
+") plgcolbga
+
+%feature( "docstring", "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.
+") plgcompression
+
+%feature( "docstring", "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.
+") plgdev
+
+%feature( "docstring", "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.
+") plgdidev
+
+%feature( "docstring", "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.
+") plgdiori
+
+%feature( "docstring", "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.
+") plgdiplt
+
+%feature( "docstring", "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.
+") plgfam
+
+%feature( "docstring", "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.
+") plgfci
+
+%feature( "docstring", "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).
+") plgfnam
+
+%feature( "docstring", "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.
+") plgfont
+
+%feature( "docstring", "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.
+") plglevel
+
+%feature( "docstring", "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 example 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.
+") plgpage
+
+%feature( "docstring", "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()
+") plgra
+
+%feature( "docstring", "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.
+") plgradient
+
+%feature( "docstring", "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?
+
+
+ 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.
+") plgriddata
+
+%feature( "docstring", "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 (PLF...
[truncated message content] |
