Menu
▾
▴
plplot-cvs
|
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] |
|
From: <and...@us...> - 2011-01-16 12:17:28
|
Revision: 11493
http://plplot.svn.sourceforge.net/plplot/?rev=11493&view=rev
Author: andrewross
Date: 2011-01-16 12:17:22 +0000 (Sun, 16 Jan 2011)
Log Message:
-----------
Update swig documentation so it is consistent with the current version of the docbook documentation in svn and not with Alan's working copy. Also fixes some formatting errors with the autogenerated swig help.
Modified Paths:
--------------
trunk/bindings/swig-support/swig_documentation.i
Modified: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i 2011-01-13 00:24:13 UTC (rev 11492)
+++ trunk/bindings/swig-support/swig_documentation.i 2011-01-16 12:17:22 UTC (rev 11493)
@@ -597,12 +597,25 @@
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.
+ 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.
")
plcol0;
@@ -2343,16 +2356,18 @@
")
pllab;
-%feature( "docstring", "Create a discrete annotated legend using colored boxes, lines, and/or lines of symbols
+%feature( "docstring", "Create a discrete annotated legend using 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. This is an experimental API that may be subject to further
+ change as we gain more experience with it.) Routine for creating a
+ discrete plot legend with a plotted 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 within the current
+ subpage 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
Redacted form: pllegend(opt, x, y, plot_width, bg_color, opt_array,
text_offset, text_scale, text_spacing, test_justification,
@@ -2366,79 +2381,42 @@
SYNOPSIS:
-pllegend(p_legend_width, p_legend_height, opt, 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)
+pllegend(opt, x, y, plot_width, bg_color, nlegend, opt_array, text_offset, text_scale, text_spacing, test_justification, text_colors, text, box_colors, box_patterns, box_scales, line_colors, line_styles, line_widths, symbol_colors, symbol_scales, symbol_numbers, symbols)
ARGUMENTS:
- p_legend_width (PLFLT *, output) : Pointer to a location which
- contains (after the call) the legend width in normalized viewport
- 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 normalized viewport
- 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
- (possibly internally transformed) nrow > 1 and ncolumn > 1, then
- plot the resulting array of legend entries in row-major order.
- Finally, the combination of the PL_LEGEND_LEFT, PL_LEGEND_RIGHT,
- PL_LEGEND_UPPER, PL_LEGEND_LOWER, PL_LEGEND_INSIDE, and
- PL_LEGEND_OUTSIDE position 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 viewport.
+ legend. If the
+ PL_LEGEND_BACKGROUND bit is set, plot a (semi-transparent) background
+ for the 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.
- x (PLFLT, input) : X offset of the legend position in normalized
- viewport 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 center-left or center-right positions if the
- PL_LEGEND_INSIDE/PL_LEGEND_OUTSIDE bit is set in opt. For the
- center-upper or center-lower cases, the direction of motion is
- toward positive X.
+ x (PLFLT, input) : Normalized sub-page X position of the upper-left
+ corner of the legend.
- y (PLFLT, input) : Y offset of the legend position in normalized
- viewport 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 center-upper or center-lower positions if
- the PL_LEGEND_INSIDE/PL_LEGEND_OUTSIDE bit is set in opt. For the
- center-left or center-right cases, the direction of motion is
- toward positive Y.
+ y (PLFLT, input) : Normalized sub-page Y position of the upper-left
+ corner of the legend.
- plot_width (PLFLT, input) : Horizontal width in normalized viewport
- units of the plot area (where the colored boxes, lines, and/or
- lines of symbols are drawn) of the legend.
+ plot_width (PLFLT, input) : Horizontal width in normalized subpage
+ units of the plot area (where the rectangular boxes, lines, and/or
+ lines of symbols are drawn) of the legend. N.B. The total
+ horizontal width of the legend in normalized subpage coordinates
+ is calculated internally from
+ plot_width,
+ text_offset (see below), and length (calculated internally) of the
+ longest text string.
bg_color (PLINT, input) : The cmap0 index of the background color
- for the legend (PL_LEGEND_BACKGROUND).
+ for the legend (
+ PL_LEGEND_BACKGROUND).
- bb_color (PLINT, input) : 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
+ nlegend (PLINT, input) : Number of legend entries. N.B. The total
vertical height of the legend in normalized subpage coordinates is
- calculated internally from nlegend, text_scale (see below), and
+ calculated internally from
+ nlegend,
+ text_scale (see below), and
text_spacing (see below).
opt_array (const PLINT *, input) : Array of nlegend values of
@@ -2500,11 +2478,6 @@
colored boxes (
PL_LEGEND_COLOR_BOX).
- box_line_widths (const PLINT *, input) : Array of nlegend scales
- (units of fraction of character height) for the height of the
- discrete colored boxes (
- PL_LEGEND_COLOR_BOX).
-
line_colors (const PLINT *, input) : Array of nlegend line colors
(cmap0 indices) (
PL_LEGEND_LINE).
@@ -2528,7 +2501,7 @@
symbols to be drawn across the width of the plotted area (
PL_LEGEND_SYMBOL).
- symbols (const char **, input) : Array of nlegend symbols (plpoin
+ symbols (const PLINT *, input) : Array of nlegend symbols (plpoin
indices) (
PL_LEGEND_SYMBOL).
")
@@ -3114,15 +3087,19 @@
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].
+ 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.
@@ -3237,22 +3214,13 @@
")
plpath;
-%feature( "docstring", "Plot a glyph at the specified points
+%feature( "docstring", "Plots a character at the specified points
DESCRIPTION:
- Plot a glyph at a set of n points at positions (
- x[i],
- y[i]) using the glyph defined by code. This function is 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.
+ Marks a set of n points in x and y using the symbol defined by code.
+ If code is between 32 and 127, the symbol is simply the corresponding
+ printable ASCII character in the default font.
Redacted form: plpoin(x, y, code)
@@ -3266,35 +3234,26 @@
ARGUMENTS:
- n (PLINT, input) : Number of points in the x and y arrays.
+ n (PLINT, input) : Number of points to be marked.
- x (PLFLT *, input) : Pointer to an array with X coordinates of
+ x (PLFLT *, input) : Pointer to array with x coordinates of the
points.
- y (PLFLT *, input) : Pointer to an array with Y coordinates of
+ y (PLFLT *, input) : Pointer to array with y coordinates of the
points.
- code (PLINT, input) : Hershey symbol code corresponding to a glyph
- to be plotted at each of the n points.
+ code (PLINT, input) : Code number for the symbol to be plotted.
")
plpoin;
-%feature( "docstring", "Plot a glyph at the specified 3D points
+%feature( "docstring", " Plots a character at the specified points in 3 space
DESCRIPTION:
- Plot a glyph at a set of n points at positions (
- x[i],
- y[i],
- z[i]) using the glyph defined by code. 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.
+ Marks a set of n points in x, y, and z using the symbol defined by
+ code. If code is between 32 and 127, the symbol is simply the
+ corresponding printable ASCII character in the default font. Setup
+ similar to plline3.
Redacted form: plpoin3(x, y, z, code)
@@ -3308,20 +3267,18 @@
ARGUMENTS:
- n (PLINT, input) : Number of points in the x and y arrays.
+ n (PLINT, input) : Number of points to be marked.
- x (PLFLT *, input) : Pointer to an array with X coordinates of
+ x (PLFLT *, input) : Pointer to array with x coordinates of the
points.
- y (PLFLT *, input) : Pointer to an array with Y coordinates of
+ y (PLFLT *, input) : Pointer to array with y coordinates of the
points.
- z (PLFLT *, input) : Pointer to an array with Z coordinates of
+ z (PLFLT *, input) : Pointer to array with z coordinates of the
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.
+ code (PLINT, input) : Code number for the symbol to be plotted.
")
plpoin3;
@@ -5377,45 +5334,6 @@
")
plstransform;
-%feature( "docstring", "Plot a glyph at the specified points
-
-DESCRIPTION:
-
- Plot glyphs (normally just one of them) at a set of n points at
- positions (
- x[i],
- y[i]) using the glyph defined by string. Supersedes plpoin and plsym
- because many(!) more glyphs are accessible with plstring. The glyph
- is specified with a PLplot user string. 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: plsym(x, y, code)
-
- This function is used in example 7.
-
-
-
-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.
-")
-plstring;
-
%feature( "docstring", "Add a point to a stripchart
DESCRIPTION:
@@ -5856,15 +5774,14 @@
")
plsyax;
-%feature( "docstring", "Plot a glyph at the specified points
+%feature( "docstring", "Plots a symbol at the specified points
DESCRIPTION:
- Plot a glyph at a set of n points at positions (
+ Marks out a set of n points at positions (
x[i],
- y[i]) using the glyph defined by code. The code is interpreted as an
- index in the Hershey font tables. This function is superseded by
- plstring which gives access to many(!) more glyphs.
+ y[i]), using the symbol defined by code. The code is interpreted as
+ an index in the Hershey font tables.
Redacted form: plsym(x, y, code)
@@ -5878,16 +5795,15 @@
ARGUMENTS:
- n (PLINT, input) : Number of points in the x and y arrays.
+ n (PLINT, input) : Number of points to be marked.
- x (PLFLT *, input) : Pointer to an array with X coordinates of
- points.
+ x (PLFLT *, input) : Pointer to array with set of x coordinate
+ values for the points.
- y (PLFLT *, input) : Pointer to an array with Y coordinates of
- points.
+ y (PLFLT *, input) : Pointer to array with set of y coordinate
+ values for the points.
- code (PLINT, input) : Hershey symbol code corresponding to a glyph
- to be plotted at each of the n points.
+ code (PLINT, input) : Code number for the symbol to be plotted.
")
plsym;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-05-02 21:56:19
|
Revision: 12328
http://sourceforge.net/p/plplot/code/12328
Author: airwin
Date: 2013-05-02 21:56:16 +0000 (Thu, 02 May 2013)
Log Message:
-----------
Regenerate swig documentation using the results of the
check_swig_documentation target which regenerates that documentation
based on the latest version of the api.xml DocBook documentation.
Modified Paths:
--------------
trunk/bindings/swig-support/swig_documentation.i
Modified: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i 2013-05-02 21:50:40 UTC (rev 12327)
+++ trunk/bindings/swig-support/swig_documentation.i 2013-05-02 21:56:16 UTC (rev 12328)
@@ -2379,11 +2379,12 @@
coordinate system used for some of the parameters is defined in the
documentation of the position parameter.)
- Redacted form: pllegend(opt, x, y, plot_width, bg_color, opt_array,
- text_offset, text_scale, text_spacing, test_justification,
- text_colors, text, box_colors, box_patterns, box_scales, line_colors,
- line_styles, line_widths, symbol_colors, symbol_scales,
- symbol_numbers, symbols)
+ 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.
@@ -2391,7 +2392,7 @@
SYNOPSIS:
-pllegend(p_legend_width, p_legend_height, position, opt, 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)
+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:
@@ -2408,6 +2409,18 @@
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
@@ -2426,18 +2439,6 @@
PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT or
PL_POSITION_SUBPAGE is set, use PL_POSITION_VIEWPORT.
- 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.
-
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
@@ -2539,9 +2540,8 @@
colored boxes (
PL_LEGEND_COLOR_BOX).
- box_line_widths (const PLINT *, input) : Array of nlegend scales
- (units of fraction of character height) for the height of the
- discrete colored boxes (
+ 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
@@ -2552,7 +2552,7 @@
(plsty indices) (
PL_LEGEND_LINE).
- line_widths (const PLINT *, input) : Array of nlegend line widths (
+ line_widths (const PLFLT *, input) : Array of nlegend line widths (
PL_LEGEND_LINE).
symbol_colors (const PLINT *, input) : Array of nlegend symbol
@@ -4709,14 +4709,15 @@
nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
of shade edge values in clevel).
- fill_width (PLINT, input) : Defines width used by the fill pattern.
+ 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 (PLINT, input) : Defines pen width used for contours
+ 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
@@ -4800,15 +4801,15 @@
sh_color (PLFLT, input) :
- sh_width (PLINT, input) :
+ sh_width (PLFLT, input) :
min_color (PLINT, input) :
- min_width (PLINT, input) :
+ min_width (PLFLT, input) :
max_color (PLINT, input) :
- max_width (PLINT, input) :
+ max_width (PLFLT, input) :
fill (void (*) (PLINT, PLFLT *, PLFLT *), input) :
@@ -4897,14 +4898,14 @@
sh_color (PLFLT, input) : Defines color map index if cmap0 or color
map input value (ranging from 0. to 1.) if cmap1.
- sh_width (PLINT, input) : Defines width used by the fill pattern.
+ sh_width (PLFLT, input) : Defines width used by the fill pattern.
min_color (PLINT, input) : Defines pen color, width used by the
boundary of shaded region. The min values are used for the
shade_min boundary, and the max values are used on the shade_max
boundary. Set color and width to zero for no plotted boundaries.
- min_width (PLINT, input) : Defines pen color, width used by the
+ min_width (PLFLT, input) : Defines pen color, width used by the
boundary of shaded region. The min values are used for the
shade_min boundary, and the max values are used on the shade_max
boundary. Set color and width to zero for no plotted boundaries.
@@ -4914,7 +4915,7 @@
shade_min boundary, and the max values are used on the shade_max
boundary. Set color and width to zero for no plotted boundaries.
- max_width (PLINT, input) : Defines pen color, width used by the
+ max_width (PLFLT, input) : Defines pen color, width used by the
boundary of shaded region. The min values are used for the
shade_min boundary, and the max values are used on the shade_max
boundary. Set color and width to zero for no plotted boundaries.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-09-28 17:18:25
|
Revision: 12540
http://sourceforge.net/p/plplot/code/12540
Author: airwin
Date: 2013-09-28 17:18:21 +0000 (Sat, 28 Sep 2013)
Log Message:
-----------
Regenerate this file to make it consistent with the updated
doc/docbook/src/api.xml. This regeneration is accomplished by running
the check_swig_documentation target and copying the comparison file
generated in the build tree on top of this source-tree file.
Modified Paths:
--------------
trunk/bindings/swig-support/swig_documentation.i
Modified: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i 2013-09-28 16:52:20 UTC (rev 12539)
+++ trunk/bindings/swig-support/swig_documentation.i 2013-09-28 17:18:21 UTC (rev 12540)
@@ -192,12 +192,17 @@
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.
+ o: Use custom labelling function to generate axis label text.
+ The custom labelling function can be defined with the
+ plslabelfunc 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.
+ x: Exactly like \"t\" (including the side effect of the
+ numerical labels for the major ticks) except exclude drawing
+ the major and minor tick marks.
xtick (PLFLT, input) : World coordinate interval between major
@@ -352,14 +357,17 @@
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.
+ o: Use custom labelling function to generate axis label text.
+ The custom labelling function can be defined with the
+ plslabelfunc 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.
+ x: Exactly like \"t\" (including the side effect of the
+ numerical labels for the major ticks) except exclude drawing
+ the major and minor tick marks.
xtick (PLFLT, input) : World coordinate interval between major
@@ -425,9 +433,9 @@
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.
+ o: Use custom labelling function to generate axis label text.
+ The custom labelling function can be defined with the
+ plslabelfunc command.
s: Enables subticks between major ticks, only valid if t is
also specified.
t: Draws major ticks.
@@ -481,9 +489,9 @@
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.
+ o: Use custom labelling function to generate axis label text.
+ The custom labelling function can be defined with the
+ plslabelfunc command.
s: Enables subticks between major ticks, only valid if t is
also specified.
t: Draws major ticks.
@@ -554,10 +562,10 @@
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.
+ window created that fulfills 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;
@@ -654,6 +662,186 @@
")
plcol1;
+%feature( "docstring", "Plot color bar for image, shade or gradient plots
+
+DESCRIPTION:
+
+ Routine for creating a continuous color bar for image, shade, or
+ gradient plots. (See pllegend for similar functionality for creating
+ legends with discrete elements). The arguments of plcolorbar provide
+ control over the location and size of the color bar as well as the
+ location and characteristics of the elements (most of which are
+ optional) within that color bar. The resulting color bar 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: plcolorbar(p_colorbar_width, p_colorbar_height, opt,
+ position, x, y, x_length, y_length, bg_color, bb_color, bb_style,
+ low_cap_color, high_cap_color, cont_color, cont_width, label_opts,
+ labels, axis_opts, ticks, sub_ticks, values)
+
+ This function is used in examples 16 and 33.
+
+
+
+SYNOPSIS:
+
+plcolorbar(p_colorbar_width, p_colorbar_height, opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, n_labels, label_opts, labels, naxes, axis_opts, ticks, sub_ticks, n_values, values)
+
+ARGUMENTS:
+
+ p_colorbar_width (PLFLT *, output) : Pointer to a location which
+ contains (after the call) the labelled and decorated color bar
+ width in adopted coordinates.
+
+ p_colorbar_height (PLFLT *, output) : Pointer to a location which
+ contains (after the call) the labelled and decorated color bar
+ height in adopted coordinates.
+
+ opt (PLINT, input) : opt contains bits controlling the overall
+ color bar. The orientation (direction of the maximum value) of
+ the color bar is specified with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
+ PL_ORIENT_LEFT, or PL_ORIENT_BOTTOM. If none of those bits are
+ specified, the default orientation is toward the top, i.e., a
+ vertical color bar. If the PL_COLORBAR_BACKGROUND bit is set, plot
+ a (semi-transparent) background for the color bar. If the
+ PL_COLORBAR_BOUNDING_BOX bit is set, plot a bounding box for the
+ color bar. The type of color bar must be specified with one of
+ PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT. If
+ more than one of those bits is set only the first one in the above
+ list is honored. The position of the (optional) label/title can be
+ specified with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT, or
+ PL_LABEL_BOTTOM. If no label position bit is set then no label
+ will be drawn. If more than one of this list of bits is specified,
+ only the first one on the list is honored. End-caps for the color
+ bar can added with PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.
+ If a particular color bar cap option is not specified then no cap
+ will be drawn for that end. As a special case for
+ PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be
+ specified. If this option is provided then any tick marks and tick
+ labels will be placed at the breaks between shaded segments. TODO:
+ This should be expanded to support custom placement of tick marks
+ and tick labels at custom value locations for any color bar type.
+
+ position (PLINT, input) : position contains bits which control the
+ overall position of the color bar and the definition of the
+ adopted coordinates used for positions just like what is done for
+ the position argument for pllegend. However, note that the
+ defaults for the position bits (see below) are different than the
+ pllegend case. 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 centers of
+ the 4 sides for both the inside and outside cases) of the color
+ bar relative to the adopted coordinate system. The corner
+ positions are specified by the appropriate combination of two of
+ the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
+ PL_POSITION_BOTTOM bits while the sides are specified by a single
+ value of one of those bits. 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 PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE or
+ PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE. If neither of
+ PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use
+ PL_POSITION_VIEWPORT.
+
+ x (PLFLT, input) : X offset of the color bar position in adopted
+ coordinates from the specified standard position of the color bar.
+ 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 color bar position in adopted
+ coordinates from the specified standard position of the color bar.
+ 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.
+
+ x_length (PLFLT, input) : Length of the body of the color bar in
+ the X direction in adopted coordinates.
+
+ y_length (PLFLT, input) : Length of the body of the color bar in
+ the Y direction in adopted coordinates.
+
+ bg_color (PLINT, input) : The cmap0 color of the background for the
+ color bar (PL_COLORBAR_BACKGROUND).
+
+ bb_color (PLINT, input) : The cmap0 color of the bounding-box line
+ for the color bar (PL_COLORBAR_BOUNDING_BOX).
+
+ bb_style (PLINT, input) : The pllsty style number for the
+ bounding-box line for the color bar (PL_COLORBAR_BACKGROUND).
+
+ low_cap_color (PLFLT, input) : The cmap1 color of the low-end color
+ bar cap, if it is drawn (PL_COLORBAR_CAP_LOW).
+
+ high_cap_color (PLFLT, input) : The cmap1 color of the high-end
+ color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH).
+
+ cont_color (PLINT, input) : The cmap0 contour color for
+ PL_COLORBAR_SHADE plots. This is passed directly to plshades, so
+ it will be interpreted according to the design of plshades.
+
+ cont_width (PLFLT, input) : Contour width for PL_COLORBAR_SHADE
+ plots. This is passed directly to plshades, so it will be
+ interpreted according to the design of plshades.
+
+ n_labels (PLINT, input) : Number of labels to place around the
+ color bar.
+
+ label_opts (const PLINT *, input) : Options for each of
+ n_labels labels.
+
+ labels (const char *const *, input) : n_labels text labels for the
+ color bar. No label is drawn if no label position is specified
+ with one of the PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP,
+ PL_COLORBAR_LABEL_LEFT, or PL_COLORBAR_LABEL_BOTTOM bits in the
+ corresponding label_opts field.
+
+ n_axes (PLINT, input) : Number of axis definitions provided. This
+ value must be greater than 0. It is typically 1 (numerical axis
+ labels are provided for one of the long edges of the color bar),
+ but it can be larger if multiple numerical axis labels for the
+ long edges of the color bar are desired.
+
+ axis_opts (const char *const *, input) : An array of n_axes axis
+ options (interpreted as for plbox) for the color bar's axis
+ definitions.
+
+ ticks (PLFLT *, input) : An array of n_axes values of the spacing
+ of the major tick marks (interpreted as for plbox) for the color
+ bar's axis definitions.
+
+ sub_ticks (PLINT *, input) : An array of n_axes values of the
+ number of subticks (interpreted as for plbox) for the color bar's
+ axis definitions.
+
+ n_values (PLINT, input) : An array containing the number of
+ elements in each of the n_axes rows of the two-dimensional values
+ array.
+
+ values (PLFLT *const *, input) : A two-dimensional array containing
+ the numeric values for the data range represented by the color
+ bar. For a row index of i_axis (where 0 < i_axis < n_axes), the
+ number of elements in the row is specified by n_values[i_axis].
+ For PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT the number of
+ elements is 2, and the corresponding row elements of the values
+ array are the minimum and maximum value represented by the
+ colorbar. For PL_COLORBAR_SHADE, the number and values of the
+ elements of a row of the values array is interpreted the same as
+ the nlevel and clevel arguments of plshades.
+")
+plcolorbar;
+
%feature( "docstring", "Contour plot
DESCRIPTION:
@@ -2267,7 +2455,7 @@
nx, ny (PLINT, input) : Dimensions of idata
- xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to strecth
+ xmin, xmax, ymin, ymax (PLFLT, input) : Plot coordinates to stretch
the image data to. idata[0][0] corresponds to (xmin, ymin) and
idata[nx - 1][ny - 1] corresponds to (xmax, ymax).
@@ -2371,13 +2559,14 @@
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.)
+ line, and/or line of symbols for each annotated legend entry. (See
+ plcolorbar for similar functionality for creating continuous color
+ bars.) 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,
@@ -2386,7 +2575,7 @@
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.
+ This function is used in examples 4, 26, and 33.
@@ -2421,22 +2610,28 @@
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
+ position (PLINT, input) : position contains bits which control 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
+ coordinates used for positions just like what is done for the
+ position argument for plcolorbar. However, note that the defaults
+ for the position bits (see below) are different than the
+ plcolorbar case. 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 centers of
+ the 4 sides for both the inside and outside cases) of the legend
+ relative to the adopted coordinate system. The corner positions
+ are specified by the appropriate combination of two of the
+ PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
+ PL_POSITION_BOTTOM bits while the sides are specified by a single
+ value of one of those bits. 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
@@ -2461,14 +2656,14 @@
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).
+ bg_color (PLINT, input) : The cmap0 color of the background 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_color (PLINT, input) : The cmap0 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).
+ bb_style (PLINT, input) : The pllsty style number for the
+ bounding-box line for the legend (PL_LEGEND_BACKGROUND).
nrow (PLINT, input) : The cmap0 index of the background color for
the legend (PL_LEGEND_BACKGROUND).
@@ -2521,14 +2716,14 @@
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_colors (const PLINT *, input) : Array of nlegend cmap0 text
+ colors.
- text (const char **, input) : Array of nlegend text string
+ text (const char *const *, input) : Array of nlegend text string
annotations.
- box_colors (const PLINT *, input) : Array of nlegend colors (cmap0
- indices) for the discrete colored boxes (
+ box_colors (const PLINT *, input) : Array of nlegend cmap0 colors
+ for the discrete colored boxes (
PL_LEGEND_COLOR_BOX).
box_patterns (const PLINT *, input) : Array of nlegend patterns
@@ -2544,8 +2739,8 @@
widths for the patterns specified by box_patterns (
PL_LEGEND_COLOR_BOX).
- line_colors (const PLINT *, input) : Array of nlegend line colors
- (cmap0 indices) (
+ line_colors (const PLINT *, input) : Array of nlegend cmap0 line
+ colors (
PL_LEGEND_LINE).
line_styles (const PLINT *, input) : Array of nlegend line styles
@@ -2555,8 +2750,8 @@
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) (
+ symbol_colors (const PLINT *, input) : Array of nlegend cmap0
+ symbol colors (
PL_LEGEND_SYMBOL).
symbol_scales (const PLFLT *, input) : Array of nlegend scale
@@ -2567,8 +2762,8 @@
symbols to be drawn across the width of the plotted area (
PL_LEGEND_SYMBOL).
- symbols (const char **, input) : Array of nlegend symbols (plpoin
- indices) (
+ symbols (const char *const *, input) : Array of nlegend symbols
+ (plpoin indices) (
PL_LEGEND_SYMBOL).
")
pllegend;
@@ -2898,7 +3093,7 @@
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.
+ color map 1.
opt=BASE_CONT: A contour plot is drawn at the base XY plane
using parameters
nlevel and
@@ -4971,12 +5166,12 @@
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
+ default labelling, set this to NULL. The labelling 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.
+ value: This is the value along the axis which is being labelled.
label_text: The string representation of the label value.
@@ -5369,7 +5564,7 @@
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
+ string is empty or begins with ``?'', the prompted start up 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.
@@ -5390,7 +5585,7 @@
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.
+ ``?'', the normal (prompted) start up is used.
nx (PLINT, input) : Number of subpages to divide output page in the
horizontal direction.
@@ -5425,7 +5620,7 @@
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.
+ from the input (x, y) coordinate to a new plot world coordinate.
data (PLPointer, input) : Optional extra data for
transform_fun.
@@ -5514,13 +5709,14 @@
")
plstring3;
-%feature( "docstring", "Add a point to a stripchart
+%feature( "docstring", "Add a point to a strip chart
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.
+ Add a point to a given pen of a given strip chart. 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)
@@ -5535,7 +5731,7 @@
ARGUMENTS:
id (PLINT, input) : Identification number (set up in plstripc) of
- the stripchart.
+ the strip chart.
p (PLINT, input) : Pen number (ranges from 0 to 3).
@@ -5545,11 +5741,11 @@
")
plstripa;
-%feature( "docstring", "Create a 4-pen stripchart
+%feature( "docstring", "Create a 4-pen strip chart
DESCRIPTION:
- Create a 4-pen stripchart, to be used afterwards by plstripa
+ Create a 4-pen strip chart, 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,
@@ -5569,7 +5765,7 @@
ARGUMENTS:
- id (PLINT *, output) : Identification number of stripchart to use
+ id (PLINT *, output) : Identification number of strip chart to use
on plstripa and plstripd.
xspec (char *, input) : X-axis specification as in plbox.
@@ -5623,11 +5819,11 @@
")
plstripc;
-%feature( "docstring", "Deletes and releases memory used by a stripchart
+%feature( "docstring", "Deletes and releases memory used by a strip chart
DESCRIPTION:
- Deletes and releases memory used by a stripchart.
+ Deletes and releases memory used by a strip chart.
Redacted form: plstripd(id)
@@ -5641,7 +5837,7 @@
ARGUMENTS:
- id (PLINT, input) : Identification number of stripchart to delete.
+ id (PLINT, input) : Identification number of strip chart to delete.
")
plstripd;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-12-22 00:25:20
|
Revision: 12902
http://sourceforge.net/p/plplot/code/12902
Author: airwin
Date: 2013-12-22 00:25:16 +0000 (Sun, 22 Dec 2013)
Log Message:
-----------
Make bindings/swig-support/swig_documentation.i consistent with
automatically generated version of that file generated from
doc/docbook/src/api.xml using the check_swig_documentation target.
Modified Paths:
--------------
trunk/bindings/swig-support/swig_documentation.i
Modified: trunk/bindings/swig-support/swig_documentation.i
===================================================================
--- trunk/bindings/swig-support/swig_documentation.i 2013-12-22 00:15:08 UTC (rev 12901)
+++ trunk/bindings/swig-support/swig_documentation.i 2013-12-22 00:25:16 UTC (rev 12902)
@@ -3454,7 +3454,7 @@
Redacted form: plpath(n,x1,y1,x2,y2)
- This function is not used in any examples.
+ This function is used in example 22.
@@ -4249,7 +4249,7 @@
Redacted form: plscol0(icol0, r, g, b)
- This function is not used in any examples.
+ This function is used in any example 31.
@@ -4653,7 +4653,7 @@
DESCRIPTION:
Set the escape character for text strings. From C (in contrast to
- Fortran 77, see plsescfortran77) you pass esc as a character. Only
+ Fortran 95, see plsescfortran95) 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
@@ -5610,7 +5610,7 @@
Redacted form: General: plstransform(transform_fun, data)
- This function is used in example 19.
+ This function is used in examples 19 and 22.
@@ -5622,7 +5622,8 @@
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 coordinate.
+ from the input (x, y) coordinate to a new plot world coordinate. A
+ NULL pointer means that no transform is applied.
data (PLPointer, input) : Optional extra data for
transform_fun.
@@ -6045,7 +6046,8 @@
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.
+ <= x,y <= 0.5. If both arrowx and arrowy are NULL then the arrow
+ style will be reset to its default.
npts (PLINT,input) : Number of points in the arrays arrowx and
arrowy.
@@ -6537,8 +6539,8 @@
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
+ width (PLFLT, 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.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X