7from sys
import version_info
as _swig_python_version_info
9if __package__
or "." in __name__:
10 from .
import _plplotc
15 import builtins
as __builtin__
21 strthis =
"proxy of " + self.this.__repr__()
22 except __builtin__.Exception:
24 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
28 def set_instance_attr(self, name, value):
30 set(self, name, value)
31 elif name ==
"thisown":
33 elif hasattr(self, name)
and isinstance(getattr(type(self), name), property):
34 set(self, name, value)
36 raise AttributeError(
"You cannot add instance attributes to %s" % self)
37 return set_instance_attr
41 def set_class_attr(cls, name, value):
42 if hasattr(cls, name)
and not isinstance(getattr(cls, name), property):
45 raise AttributeError(
"You cannot add class attributes to %s" % cls)
50 """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
52 return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
57 """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
63 return _plplotc.pltr0(x, y)
66 return _plplotc.pltr1(x, y, cgrid)
69 return _plplotc.pltr2(x, y, cgrid)
70PLESC_SET_RGB = _plplotc.PLESC_SET_RGB
71PLESC_ALLOC_NCOL = _plplotc.PLESC_ALLOC_NCOL
72PLESC_SET_LPB = _plplotc.PLESC_SET_LPB
73PLESC_EXPOSE = _plplotc.PLESC_EXPOSE
74PLESC_RESIZE = _plplotc.PLESC_RESIZE
75PLESC_REDRAW = _plplotc.PLESC_REDRAW
76PLESC_TEXT = _plplotc.PLESC_TEXT
77PLESC_GRAPH = _plplotc.PLESC_GRAPH
78PLESC_FILL = _plplotc.PLESC_FILL
79PLESC_DI = _plplotc.PLESC_DI
80PLESC_FLUSH = _plplotc.PLESC_FLUSH
81PLESC_EH = _plplotc.PLESC_EH
82PLESC_GETC = _plplotc.PLESC_GETC
83PLESC_SWIN = _plplotc.PLESC_SWIN
84PLESC_DOUBLEBUFFERING = _plplotc.PLESC_DOUBLEBUFFERING
85PLESC_XORMOD = _plplotc.PLESC_XORMOD
86PLESC_SET_COMPRESSION = _plplotc.PLESC_SET_COMPRESSION
87PLESC_CLEAR = _plplotc.PLESC_CLEAR
88PLESC_DASH = _plplotc.PLESC_DASH
89PLESC_HAS_TEXT = _plplotc.PLESC_HAS_TEXT
90PLESC_IMAGE = _plplotc.PLESC_IMAGE
91PLESC_IMAGEOPS = _plplotc.PLESC_IMAGEOPS
92PLESC_PL2DEVCOL = _plplotc.PLESC_PL2DEVCOL
93PLESC_DEV2PLCOL = _plplotc.PLESC_DEV2PLCOL
94PLESC_SETBGFG = _plplotc.PLESC_SETBGFG
95PLESC_DEVINIT = _plplotc.PLESC_DEVINIT
96PLESC_GETBACKEND = _plplotc.PLESC_GETBACKEND
97PLESC_BEGIN_TEXT = _plplotc.PLESC_BEGIN_TEXT
98PLESC_TEXT_CHAR = _plplotc.PLESC_TEXT_CHAR
99PLESC_CONTROL_CHAR = _plplotc.PLESC_CONTROL_CHAR
100PLESC_END_TEXT = _plplotc.PLESC_END_TEXT
101PLESC_START_RASTERIZE = _plplotc.PLESC_START_RASTERIZE
102PLESC_END_RASTERIZE = _plplotc.PLESC_END_RASTERIZE
103PLESC_ARC = _plplotc.PLESC_ARC
104PLESC_GRADIENT = _plplotc.PLESC_GRADIENT
105PLESC_MODESET = _plplotc.PLESC_MODESET
106PLESC_MODEGET = _plplotc.PLESC_MODEGET
107PLESC_FIXASPECT = _plplotc.PLESC_FIXASPECT
108PLESC_IMPORT_BUFFER = _plplotc.PLESC_IMPORT_BUFFER
109PLESC_APPEND_BUFFER = _plplotc.PLESC_APPEND_BUFFER
110PLESC_FLUSH_REMAINING_BUFFER = _plplotc.PLESC_FLUSH_REMAINING_BUFFER
111PLTEXT_FONTCHANGE = _plplotc.PLTEXT_FONTCHANGE
112PLTEXT_SUPERSCRIPT = _plplotc.PLTEXT_SUPERSCRIPT
113PLTEXT_SUBSCRIPT = _plplotc.PLTEXT_SUBSCRIPT
114PLTEXT_BACKCHAR = _plplotc.PLTEXT_BACKCHAR
115PLTEXT_OVERLINE = _plplotc.PLTEXT_OVERLINE
116PLTEXT_UNDERLINE = _plplotc.PLTEXT_UNDERLINE
117ZEROW2B = _plplotc.ZEROW2B
118ZEROW2D = _plplotc.ZEROW2D
119ONEW2B = _plplotc.ONEW2B
120ONEW2D = _plplotc.ONEW2D
121PLSWIN_DEVICE = _plplotc.PLSWIN_DEVICE
122PLSWIN_WORLD = _plplotc.PLSWIN_WORLD
123PL_X_AXIS = _plplotc.PL_X_AXIS
124PL_Y_AXIS = _plplotc.PL_Y_AXIS
125PL_Z_AXIS = _plplotc.PL_Z_AXIS
126PL_OPT_ENABLED = _plplotc.PL_OPT_ENABLED
127PL_OPT_ARG = _plplotc.PL_OPT_ARG
128PL_OPT_NODELETE = _plplotc.PL_OPT_NODELETE
129PL_OPT_INVISIBLE = _plplotc.PL_OPT_INVISIBLE
130PL_OPT_DISABLED = _plplotc.PL_OPT_DISABLED
131PL_OPT_FUNC = _plplotc.PL_OPT_FUNC
132PL_OPT_BOOL = _plplotc.PL_OPT_BOOL
133PL_OPT_INT = _plplotc.PL_OPT_INT
134PL_OPT_FLOAT = _plplotc.PL_OPT_FLOAT
135PL_OPT_STRING = _plplotc.PL_OPT_STRING
136PL_PARSE_PARTIAL = _plplotc.PL_PARSE_PARTIAL
137PL_PARSE_FULL = _plplotc.PL_PARSE_FULL
138PL_PARSE_QUIET = _plplotc.PL_PARSE_QUIET
139PL_PARSE_NODELETE = _plplotc.PL_PARSE_NODELETE
140PL_PARSE_SHOWALL = _plplotc.PL_PARSE_SHOWALL
141PL_PARSE_OVERRIDE = _plplotc.PL_PARSE_OVERRIDE
142PL_PARSE_NOPROGRAM = _plplotc.PL_PARSE_NOPROGRAM
143PL_PARSE_NODASH = _plplotc.PL_PARSE_NODASH
144PL_PARSE_SKIP = _plplotc.PL_PARSE_SKIP
145PL_FCI_MARK = _plplotc.PL_FCI_MARK
146PL_FCI_IMPOSSIBLE = _plplotc.PL_FCI_IMPOSSIBLE
147PL_FCI_HEXDIGIT_MASK = _plplotc.PL_FCI_HEXDIGIT_MASK
148PL_FCI_HEXPOWER_MASK = _plplotc.PL_FCI_HEXPOWER_MASK
149PL_FCI_HEXPOWER_IMPOSSIBLE = _plplotc.PL_FCI_HEXPOWER_IMPOSSIBLE
150PL_FCI_FAMILY = _plplotc.PL_FCI_FAMILY
151PL_FCI_STYLE = _plplotc.PL_FCI_STYLE
152PL_FCI_WEIGHT = _plplotc.PL_FCI_WEIGHT
153PL_FCI_SANS = _plplotc.PL_FCI_SANS
154PL_FCI_SERIF = _plplotc.PL_FCI_SERIF
155PL_FCI_MONO = _plplotc.PL_FCI_MONO
156PL_FCI_SCRIPT = _plplotc.PL_FCI_SCRIPT
157PL_FCI_SYMBOL = _plplotc.PL_FCI_SYMBOL
158PL_FCI_UPRIGHT = _plplotc.PL_FCI_UPRIGHT
159PL_FCI_ITALIC = _plplotc.PL_FCI_ITALIC
160PL_FCI_OBLIQUE = _plplotc.PL_FCI_OBLIQUE
161PL_FCI_MEDIUM = _plplotc.PL_FCI_MEDIUM
162PL_FCI_BOLD = _plplotc.PL_FCI_BOLD
163PL_MAXKEY = _plplotc.PL_MAXKEY
164PL_MASK_SHIFT = _plplotc.PL_MASK_SHIFT
165PL_MASK_CAPS = _plplotc.PL_MASK_CAPS
166PL_MASK_CONTROL = _plplotc.PL_MASK_CONTROL
167PL_MASK_ALT = _plplotc.PL_MASK_ALT
168PL_MASK_NUM = _plplotc.PL_MASK_NUM
169PL_MASK_ALTGR = _plplotc.PL_MASK_ALTGR
170PL_MASK_WIN = _plplotc.PL_MASK_WIN
171PL_MASK_SCROLL = _plplotc.PL_MASK_SCROLL
172PL_MASK_BUTTON1 = _plplotc.PL_MASK_BUTTON1
173PL_MASK_BUTTON2 = _plplotc.PL_MASK_BUTTON2
174PL_MASK_BUTTON3 = _plplotc.PL_MASK_BUTTON3
175PL_MASK_BUTTON4 = _plplotc.PL_MASK_BUTTON4
176PL_MASK_BUTTON5 = _plplotc.PL_MASK_BUTTON5
177PL_MAXWINDOWS = _plplotc.PL_MAXWINDOWS
178PL_NOTSET = _plplotc.PL_NOTSET
179PL_DEFAULT_NCOL0 = _plplotc.PL_DEFAULT_NCOL0
180PL_DEFAULT_NCOL1 = _plplotc.PL_DEFAULT_NCOL1
181MIN_PLINT_RGB = _plplotc.MIN_PLINT_RGB
182MAX_PLINT_RGB = _plplotc.MAX_PLINT_RGB
183MIN_PLFLT_CMAP1 = _plplotc.MIN_PLFLT_CMAP1
184MAX_PLFLT_CMAP1 = _plplotc.MAX_PLFLT_CMAP1
185MIN_PLFLT_ALPHA = _plplotc.MIN_PLFLT_ALPHA
186MAX_PLFLT_ALPHA = _plplotc.MAX_PLFLT_ALPHA
187PLESC_DOUBLEBUFFERING_ENABLE = _plplotc.PLESC_DOUBLEBUFFERING_ENABLE
188PLESC_DOUBLEBUFFERING_DISABLE = _plplotc.PLESC_DOUBLEBUFFERING_DISABLE
189PLESC_DOUBLEBUFFERING_QUERY = _plplotc.PLESC_DOUBLEBUFFERING_QUERY
190PL_BIN_DEFAULT = _plplotc.PL_BIN_DEFAULT
191PL_BIN_CENTRED = _plplotc.PL_BIN_CENTRED
192PL_BIN_NOEXPAND = _plplotc.PL_BIN_NOEXPAND
193PL_BIN_NOEMPTY = _plplotc.PL_BIN_NOEMPTY
194GRID_CSA = _plplotc.GRID_CSA
195GRID_DTLI = _plplotc.GRID_DTLI
196GRID_NNI = _plplotc.GRID_NNI
197GRID_NNIDW = _plplotc.GRID_NNIDW
198GRID_NNLI = _plplotc.GRID_NNLI
199GRID_NNAIDW = _plplotc.GRID_NNAIDW
200PL_HIST_DEFAULT = _plplotc.PL_HIST_DEFAULT
201PL_HIST_NOSCALING = _plplotc.PL_HIST_NOSCALING
202PL_HIST_IGNORE_OUTLIERS = _plplotc.PL_HIST_IGNORE_OUTLIERS
203PL_HIST_NOEXPAND = _plplotc.PL_HIST_NOEXPAND
204PL_HIST_NOEMPTY = _plplotc.PL_HIST_NOEMPTY
205PL_POSITION_NULL = _plplotc.PL_POSITION_NULL
206PL_POSITION_LEFT = _plplotc.PL_POSITION_LEFT
207PL_POSITION_RIGHT = _plplotc.PL_POSITION_RIGHT
208PL_POSITION_TOP = _plplotc.PL_POSITION_TOP
209PL_POSITION_BOTTOM = _plplotc.PL_POSITION_BOTTOM
210PL_POSITION_INSIDE = _plplotc.PL_POSITION_INSIDE
211PL_POSITION_OUTSIDE = _plplotc.PL_POSITION_OUTSIDE
212PL_POSITION_VIEWPORT = _plplotc.PL_POSITION_VIEWPORT
213PL_POSITION_SUBPAGE = _plplotc.PL_POSITION_SUBPAGE
214PL_LEGEND_NULL = _plplotc.PL_LEGEND_NULL
215PL_LEGEND_NONE = _plplotc.PL_LEGEND_NONE
216PL_LEGEND_COLOR_BOX = _plplotc.PL_LEGEND_COLOR_BOX
217PL_LEGEND_LINE = _plplotc.PL_LEGEND_LINE
218PL_LEGEND_SYMBOL = _plplotc.PL_LEGEND_SYMBOL
219PL_LEGEND_TEXT_LEFT = _plplotc.PL_LEGEND_TEXT_LEFT
220PL_LEGEND_BACKGROUND = _plplotc.PL_LEGEND_BACKGROUND
221PL_LEGEND_BOUNDING_BOX = _plplotc.PL_LEGEND_BOUNDING_BOX
222PL_LEGEND_ROW_MAJOR = _plplotc.PL_LEGEND_ROW_MAJOR
223PL_COLORBAR_NULL = _plplotc.PL_COLORBAR_NULL
224PL_COLORBAR_LABEL_LEFT = _plplotc.PL_COLORBAR_LABEL_LEFT
225PL_COLORBAR_LABEL_RIGHT = _plplotc.PL_COLORBAR_LABEL_RIGHT
226PL_COLORBAR_LABEL_TOP = _plplotc.PL_COLORBAR_LABEL_TOP
227PL_COLORBAR_LABEL_BOTTOM = _plplotc.PL_COLORBAR_LABEL_BOTTOM
228PL_COLORBAR_IMAGE = _plplotc.PL_COLORBAR_IMAGE
229PL_COLORBAR_SHADE = _plplotc.PL_COLORBAR_SHADE
230PL_COLORBAR_GRADIENT = _plplotc.PL_COLORBAR_GRADIENT
231PL_COLORBAR_CAP_NONE = _plplotc.PL_COLORBAR_CAP_NONE
232PL_COLORBAR_CAP_LOW = _plplotc.PL_COLORBAR_CAP_LOW
233PL_COLORBAR_CAP_HIGH = _plplotc.PL_COLORBAR_CAP_HIGH
234PL_COLORBAR_SHADE_LABEL = _plplotc.PL_COLORBAR_SHADE_LABEL
235PL_COLORBAR_ORIENT_RIGHT = _plplotc.PL_COLORBAR_ORIENT_RIGHT
236PL_COLORBAR_ORIENT_TOP = _plplotc.PL_COLORBAR_ORIENT_TOP
237PL_COLORBAR_ORIENT_LEFT = _plplotc.PL_COLORBAR_ORIENT_LEFT
238PL_COLORBAR_ORIENT_BOTTOM = _plplotc.PL_COLORBAR_ORIENT_BOTTOM
239PL_COLORBAR_BACKGROUND = _plplotc.PL_COLORBAR_BACKGROUND
240PL_COLORBAR_BOUNDING_BOX = _plplotc.PL_COLORBAR_BOUNDING_BOX
241PL_DRAWMODE_UNKNOWN = _plplotc.PL_DRAWMODE_UNKNOWN
242PL_DRAWMODE_DEFAULT = _plplotc.PL_DRAWMODE_DEFAULT
243PL_DRAWMODE_REPLACE = _plplotc.PL_DRAWMODE_REPLACE
244PL_DRAWMODE_XOR = _plplotc.PL_DRAWMODE_XOR
245DRAW_LINEX = _plplotc.DRAW_LINEX
246DRAW_LINEY = _plplotc.DRAW_LINEY
247DRAW_LINEXY = _plplotc.DRAW_LINEXY
248MAG_COLOR = _plplotc.MAG_COLOR
249BASE_CONT = _plplotc.BASE_CONT
250TOP_CONT = _plplotc.TOP_CONT
251SURF_CONT = _plplotc.SURF_CONT
252DRAW_SIDES = _plplotc.DRAW_SIDES
253FACETED = _plplotc.FACETED
256 thisown = property(
lambda x: x.this.own(),
lambda x, v: x.this.own(v), doc=
"The membership flag")
257 __repr__ = _swig_repr
258 type = property(_plplotc.PLGraphicsIn_type_get, _plplotc.PLGraphicsIn_type_set)
259 state = property(_plplotc.PLGraphicsIn_state_get, _plplotc.PLGraphicsIn_state_set)
260 keysym = property(_plplotc.PLGraphicsIn_keysym_get, _plplotc.PLGraphicsIn_keysym_set)
261 button = property(_plplotc.PLGraphicsIn_button_get, _plplotc.PLGraphicsIn_button_set)
262 subwindow = property(_plplotc.PLGraphicsIn_subwindow_get, _plplotc.PLGraphicsIn_subwindow_set)
263 string = property(_plplotc.PLGraphicsIn_string_get, _plplotc.PLGraphicsIn_string_set)
264 pX = property(_plplotc.PLGraphicsIn_pX_get, _plplotc.PLGraphicsIn_pX_set)
265 pY = property(_plplotc.PLGraphicsIn_pY_get, _plplotc.PLGraphicsIn_pY_set)
266 dX = property(_plplotc.PLGraphicsIn_dX_get, _plplotc.PLGraphicsIn_dX_set)
267 dY = property(_plplotc.PLGraphicsIn_dY_get, _plplotc.PLGraphicsIn_dY_set)
268 wX = property(_plplotc.PLGraphicsIn_wX_get, _plplotc.PLGraphicsIn_wX_set)
269 wY = property(_plplotc.PLGraphicsIn_wY_get, _plplotc.PLGraphicsIn_wY_set)
272 _plplotc.PLGraphicsIn_swiginit(self, _plplotc.new_PLGraphicsIn())
273 __swig_destroy__ = _plplotc.delete_PLGraphicsIn
276_plplotc.PLGraphicsIn_swigregister(PLGraphicsIn)
279 return _plplotc.plsxwin(window_id)
283 Set format of numerical label for contours
287 Set format of numerical label
for contours.
291 This function
is used example 9.
301 lexp (PLINT, input) : If the contour numerical label
is greater
302 than 10^(lexp)
or less than 10^(-lexp), then the exponential
303 format
is used. Default value of lexp
is 4.
305 sigdig (PLINT, input) : Number of significant digits. Default
309 return _plplotc.pl_setcontlabelformat(lexp, sigdig)
313 Set parameters of contour labelling other than format of numerical label
317 Set parameters of contour labelling other than those handled by
318 pl_setcontlabelformat.
322 This function is used
in example 9.
332 offset (PLFLT, input) : Offset of label
from contour line (
if set
333 to 0.0, labels are printed on the lines). Default value
is 0.006.
335 size (PLFLT, input) : Font height
for contour labels (normalized).
336 Default value
is 0.3.
338 spacing (PLFLT, input) : Spacing parameter
for contour labels.
339 Default value
is 0.1.
341 active (PLINT, input) : Activate labels. Set to 1
if you want
342 contour labels on. Default
is off (0).
345 return _plplotc.pl_setcontlabelparam(offset, size, spacing, active)
349 Advance the (sub-)page
353 Advances to the next subpage if sub=0, performing a page advance
if
354 there are no remaining subpages on the current page. If subpages
355 aren
't being used, pladv(0) will always advance the page. If page>0,
356 PLplot switches to the specified subpage. Note that this allows you
357 to overwrite a plot on the specified subpage; if this
is not what you
358 intended, use pleop followed by plbop to first advance the page. This
359 routine
is called automatically (
with page=0) by plenv, but
if plenv
360 is not used, pladv must be called after initializing PLplot but before
361 defining the viewport.
363 Redacted form:
pladv(page)
365 This function
is used
in examples 1, 2, 4, 6-12, 14-18, 20, 21, 23-27,
376 page (PLINT, input) : Specifies the subpage number (starting
from 1
377 in the top left corner
and increasing along the rows) to which to
378 advance. Set to zero to advance to the next subpage (
or to the
379 next page
if subpages are
not being used).
382 return _plplotc.pladv(page)
384def plarc(x, y, a, b, angle1, angle2, rotate, fill):
386 Draw a circular or elliptical arc
390 Draw a possibly filled arc centered at x, y
with semimajor axis a
and
391 semiminor axis b, starting at angle1
and ending at angle2.
393 Redacted form: General:
plarc(x, y, a, b, angle1, angle2, rotate,
397 This function
is used
in examples 3
and 27.
403 plarc(x, y, a, b, angle1, angle2, rotate, fill)
407 x (PLFLT, input) : X coordinate of arc center.
409 y (PLFLT, input) : Y coordinate of arc center.
411 a (PLFLT, input) : Length of the semimajor axis of the arc.
413 b (PLFLT, input) : Length of the semiminor axis of the arc.
415 angle1 (PLFLT, input) : Starting angle of the arc relative to the
418 angle2 (PLFLT, input) : Ending angle of the arc relative to the
421 rotate (PLFLT, input) : Angle of the semimajor axis relative to the
424 fill (PLBOOL, input) : Draw a filled arc.
427 return _plplotc.plarc(x, y, a, b, angle1, angle2, rotate, fill)
429def plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub):
431 Draw a box with axes, etc.
with arbitrary origin
435 Draws a box around the currently defined viewport
with arbitrary
436 world-coordinate origin specified by x0
and y0
and labels it
with
437 world coordinate values appropriate to the window. Thus plaxes should
438 only be called after defining both viewport
and window. The ascii
439 character strings xopt
and yopt specify how the box should be drawn
as
440 described below. If ticks
and/
or subticks are to be drawn
for a
441 particular axis, the tick intervals
and number of subintervals may be
442 specified explicitly,
or they may be defaulted by setting the
443 appropriate arguments to zero.
445 Redacted form: General:
plaxes(x0, y0, xopt, xtick, nxsub, yopt,
449 This function
is not used
in any examples.
455 plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
459 x0 (PLFLT, input) : World X coordinate of origin.
461 y0 (PLFLT, input) : World Y coordinate of origin.
463 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
464 options
for the x axis. The string can include any combination of
465 the following letters (upper
or lower case)
in any order: a: Draws
466 axis, X-axis
is horizontal line (y=0),
and Y-axis
is vertical line
468 b: Draws bottom (X)
or left (Y) edge of frame.
469 c: Draws top (X)
or right (Y) edge of frame.
470 d: Plot labels
as date / time. Values are assumed to be
471 seconds since the epoch (
as used by gmtime).
472 f: Always use fixed point numeric labels.
473 g: Draws a grid at the major tick interval.
474 h: Draws a grid at the minor tick interval.
475 i: Inverts tick marks, so they are drawn outwards, rather than
477 l: Labels axis logarithmically. This only affects the labels,
478 not the data,
and so it
is necessary to compute the logarithms
479 of data points before passing them to any of the drawing
481 m: Writes numeric labels at major tick intervals
in the
482 unconventional location (above box
for X, right of box
for Y).
483 n: Writes numeric labels at major tick intervals
in the
484 conventional location (below box
for X, left of box
for Y).
485 o: Use custom labelling function to generate axis label text.
486 The custom labelling function can be defined
with the
487 plslabelfunc command.
488 s: Enables subticks between major ticks, only valid
if t
is
490 t: Draws major ticks.
491 u: Exactly like
"b" except don
't draw edge line.
492 w: Exactly like "c" except don
't draw edge line.
493 x: Exactly like "t" (including the side effect of the
494 numerical labels
for the major ticks)
except exclude drawing
495 the major
and minor tick marks.
498 xtick (PLFLT, input) : World coordinate interval between major
499 ticks on the x axis. If it
is set to zero, PLplot automatically
500 generates a suitable tick interval.
502 nxsub (PLINT, input) : Number of subintervals between major x axis
503 ticks
for minor ticks. If it
is set to zero, PLplot automatically
504 generates a suitable minor tick interval.
506 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
507 options
for the y axis. The string can include any combination of
508 the letters defined above
for xopt,
and in addition may contain:
509 v: Write numeric labels
for the y axis parallel to the base of the
510 graph, rather than parallel to the axis.
513 ytick (PLFLT, input) : World coordinate interval between major
514 ticks on the y axis. If it
is set to zero, PLplot automatically
515 generates a suitable tick interval.
517 nysub (PLINT, input) : Number of subintervals between major y axis
518 ticks
for minor ticks. If it
is set to zero, PLplot automatically
519 generates a suitable minor tick interval.
522 return _plplotc.plaxes(x0, y0, xopt, xtick, nxsub, yopt, ytick, nysub)
526 Plot a histogram from binned data
530 Plots a histogram consisting of nbin bins. The value associated
with
531 the i
'th bin is placed in x[i], and the number of points in the bin is
532 placed in y[i]. For proper operation, the values
in x[i] must form a
533 strictly increasing sequence. By default, x[i]
is the left-hand edge
534 of the i
'th bin. If opt=PL_BIN_CENTRED is used, the bin boundaries are
535 placed midway between the values in the x vector. Also see plhist
for
536 drawing histograms
from unbinned data.
538 Redacted form: General:
plbin(x, y, opt)
539 Python:
plbin(nbin, x, y, opt)
542 This function
is not used
in any examples.
548 plbin(nbin, x, y, opt)
552 nbin (PLINT, input) : Number of bins (i.e., number of values
in x
555 x (PLFLT_VECTOR, input) : A vector containing values associated
556 with bins. These must form a strictly increasing sequence.
558 y (PLFLT_VECTOR, input) : A vector containing a number which
is
559 proportional to the number of points
in each bin. This
is a PLFLT
560 (instead of PLINT) vector so
as to allow histograms of
563 opt (PLINT, input) : Is a combination of several flags:
564 opt=PL_BIN_DEFAULT: The x represent the lower bin boundaries, the
565 outer bins are expanded to fill up the entire x-axis
and bins of
566 zero height are simply drawn.
567 opt=PL_BIN_CENTRED|...: The bin boundaries are to be midway
568 between the x values. If the values
in x are equally spaced,
569 the values are the center values of the bins.
570 opt=PL_BIN_NOEXPAND|...: The outer bins are drawn
with equal
571 size
as the ones inside.
572 opt=PL_BIN_NOEMPTY|...: Bins
with zero height are
not drawn
573 (there
is a gap
for such bins).
576 return _plplotc.plbin(n, ArrayCk, center)
580 Calculate broken-down time from continuous time
for the current stream
584 Calculate broken-down time; year, month, day, hour, min, sec;
from
585 continuous time, ctime
for the current stream. This function
is the
588 The PLplot definition of broken-down time
is a calendar time that
589 completely ignores all time zone offsets, i.e., it
is the user
's
590 responsibility to apply those offsets (if so desired) before using the
591 PLplot time API. By default broken-down time
is defined using the
592 proleptic Gregorian calendar without the insertion of leap seconds
and
593 continuous time
is defined
as the number of seconds since the Unix
594 epoch of 1970-01-01T00:00:00Z. However, other definitions of
595 broken-down
and continuous time are possible, see plconfigtime.
597 Redacted form: General:
plbtime(year, month, day, hour, min, sec,
601 This function
is used
in example 29.
607 plbtime(year, month, day, hour, min, sec, ctime)
611 year (PLINT_NC_SCALAR, output) : Returned value of years
with
612 positive values corresponding to CE (i.e., 1 = 1 CE, etc.)
and
613 non-negative values corresponding to BCE (e.g., 0 = 1 BCE, -1 = 2
616 month (PLINT_NC_SCALAR, output) : Returned value of month within
617 the year
in the range
from 0 (January) to 11 (December).
619 day (PLINT_NC_SCALAR, output) : Returned value of day within the
620 month
in the range
from 1 to 31.
622 hour (PLINT_NC_SCALAR, output) : Returned value of hour within the
623 day
in the range
from 0 to 23.
625 min (PLINT_NC_SCALAR, output) : Returned value of minute within the
626 hour
in the range
from 0 to 59
628 sec (PLFLT_NC_SCALAR, output) : Returned value of second within the
629 minute
in range
from 0. to 60.
631 ctime (PLFLT, input) : Continuous time
from which the broken-down
635 return _plplotc.plbtime(ctime)
643 Begins a new page. For a file driver, the output file is opened
if
644 necessary. Advancing the page via pleop
and plbop
is useful when a
645 page
break is desired at a particular point when plotting to subpages.
646 Another use
for pleop
and plbop
is when plotting pages to different
647 files, since you can manually set the file name by calling plsfnam
648 after the call to pleop. (In fact some drivers may only support a
649 single page per file, making this a necessity.) One way to handle
650 this case automatically
is to page advance via pladv, but enable
651 familying (see plsfam)
with a small limit on the file size so that a
652 new family member file will be created on each page
break.
654 Redacted form:
plbop()
656 This function
is used
in examples 2
and 20.
665 return _plplotc.plbop()
667def plbox(xopt, xtick, nxsub, yopt, ytick, nysub):
669 Draw a box with axes, etc
673 Draws a box around the currently defined viewport,
and labels it
with
674 world coordinate values appropriate to the window. Thus plbox should
675 only be called after defining both viewport
and window. The ascii
676 character strings xopt
and yopt specify how the box should be drawn
as
677 described below. If ticks
and/
or subticks are to be drawn
for a
678 particular axis, the tick intervals
and number of subintervals may be
679 specified explicitly,
or they may be defaulted by setting the
680 appropriate arguments to zero.
682 Redacted form: General:
plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
685 This function
is used
in examples 1, 2, 4, 6, 6-12, 14-18, 21, 23-26,
692 plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
696 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
697 options
for the x axis. The string can include any combination of
698 the following letters (upper
or lower case)
in any order: a: Draws
699 axis, X-axis
is horizontal line (y=0),
and Y-axis
is vertical line
701 b: Draws bottom (X)
or left (Y) edge of frame.
702 c: Draws top (X)
or right (Y) edge of frame.
703 d: Plot labels
as date / time. Values are assumed to be
704 seconds since the epoch (
as used by gmtime).
705 f: Always use fixed point numeric labels.
706 g: Draws a grid at the major tick interval.
707 h: Draws a grid at the minor tick interval.
708 i: Inverts tick marks, so they are drawn outwards, rather than
710 l: Labels axis logarithmically. This only affects the labels,
711 not the data,
and so it
is necessary to compute the logarithms
712 of data points before passing them to any of the drawing
714 m: Writes numeric labels at major tick intervals
in the
715 unconventional location (above box
for X, right of box
for Y).
716 n: Writes numeric labels at major tick intervals
in the
717 conventional location (below box
for X, left of box
for Y).
718 o: Use custom labelling function to generate axis label text.
719 The custom labelling function can be defined
with the
720 plslabelfunc command.
721 s: Enables subticks between major ticks, only valid
if t
is
723 t: Draws major ticks.
724 u: Exactly like
"b" except don
't draw edge line.
725 w: Exactly like "c" except don
't draw edge line.
726 x: Exactly like "t" (including the side effect of the
727 numerical labels
for the major ticks)
except exclude drawing
728 the major
and minor tick marks.
731 xtick (PLFLT, input) : World coordinate interval between major
732 ticks on the x axis. If it
is set to zero, PLplot automatically
733 generates a suitable tick interval.
735 nxsub (PLINT, input) : Number of subintervals between major x axis
736 ticks
for minor ticks. If it
is set to zero, PLplot automatically
737 generates a suitable minor tick interval.
739 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
740 options
for the y axis. The string can include any combination of
741 the letters defined above
for xopt,
and in addition may contain:
742 v: Write numeric labels
for the y axis parallel to the base of the
743 graph, rather than parallel to the axis.
746 ytick (PLFLT, input) : World coordinate interval between major
747 ticks on the y axis. If it
is set to zero, PLplot automatically
748 generates a suitable tick interval.
750 nysub (PLINT, input) : Number of subintervals between major y axis
751 ticks
for minor ticks. If it
is set to zero, PLplot automatically
752 generates a suitable minor tick interval.
755 return _plplotc.plbox(xopt, xtick, nxsub, yopt, ytick, nysub)
757def plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz):
759 Draw a box with axes, etc,
in 3-d
763 Draws axes, numeric
and text labels
for a three-dimensional surface
764 plot. For a more complete description of three-dimensional plotting
765 see the PLplot documentation.
767 Redacted form: General:
plbox3(xopt, xlabel, xtick, nxsub, yopt,
768 ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
771 This function
is used
in examples 8, 11, 18,
and 21.
777 plbox3(xopt, xlabel, xtick, nxsub, yopt, ylabel, ytick, nysub, zopt, zlabel, ztick, nzsub)
781 xopt (PLCHAR_VECTOR, input) : An ascii character string specifying
782 options
for the x axis. The string can include any combination of
783 the following letters (upper
or lower case)
in any order: b: Draws
784 axis at base, at height z=
785 zmin where zmin
is defined by call to plw3d. This character must be
786 specified
in order to use any of the other options.
787 d: Plot labels
as date / time. Values are assumed to be
788 seconds since the epoch (
as used by gmtime).
789 f: Always use fixed point numeric labels.
790 i: Inverts tick marks, so they are drawn downwards, rather
792 l: Labels axis logarithmically. This only affects the labels,
793 not the data,
and so it
is necessary to compute the logarithms
794 of data points before passing them to any of the drawing
796 n: Writes numeric labels at major tick intervals.
797 o: Use custom labelling function to generate axis label text.
798 The custom labelling function can be defined
with the
799 plslabelfunc command.
800 s: Enables subticks between major ticks, only valid
if t
is
802 t: Draws major ticks.
803 u: If this
is specified, the text label
for the axis
is
804 written under the axis.
807 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
808 the text label
for the x axis. It
is only drawn
if u
is in the
811 xtick (PLFLT, input) : World coordinate interval between major
812 ticks on the x axis. If it
is set to zero, PLplot automatically
813 generates a suitable tick interval.
815 nxsub (PLINT, input) : Number of subintervals between major x axis
816 ticks
for minor ticks. If it
is set to zero, PLplot automatically
817 generates a suitable minor tick interval.
819 yopt (PLCHAR_VECTOR, input) : An ascii character string specifying
820 options
for the y axis. The string
is interpreted
in the same way
823 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
824 the text label
for the y axis. It
is only drawn
if u
is in the
827 ytick (PLFLT, input) : World coordinate interval between major
828 ticks on the y axis. If it
is set to zero, PLplot automatically
829 generates a suitable tick interval.
831 nysub (PLINT, input) : Number of subintervals between major y axis
832 ticks
for minor ticks. If it
is set to zero, PLplot automatically
833 generates a suitable minor tick interval.
835 zopt (PLCHAR_VECTOR, input) : An ascii character string specifying
836 options
for the z axis. The string can include any combination of
837 the following letters (upper
or lower case)
in any order: b: Draws
838 z axis to the left of the surface plot.
839 c: Draws z axis to the right of the surface plot.
840 d: Draws grid lines parallel to the x-y plane behind the
841 figure. These lines are
not drawn until after plot3d
or
842 plmesh are called because of the need
for hidden line removal.
843 e: Plot labels
as date / time. Values are assumed to be
844 seconds since the epoch (
as used by gmtime). Note this
845 suboption
is interpreted the same
as the d suboption
for xopt
846 and yopt, but it has to be identified
as e
for zopt since d
847 has already been used
for the different purpose above.
848 f: Always use fixed point numeric labels.
849 i: Inverts tick marks, so they are drawn away
from the center.
850 l: Labels axis logarithmically. This only affects the labels,
851 not the data,
and so it
is necessary to compute the logarithms
852 of data points before passing them to any of the drawing
854 m: Writes numeric labels at major tick intervals on the
856 n: Writes numeric labels at major tick intervals on the
858 o: Use custom labelling function to generate axis label text.
859 The custom labelling function can be defined
with the
860 plslabelfunc command.
861 s: Enables subticks between major ticks, only valid
if t
is
863 t: Draws major ticks.
864 u: If this
is specified, the text label
is written beside the
866 v: If this
is specified, the text label
is written beside the
870 zlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
871 the text label
for the z axis. It
is only drawn
if u
or v are
in
874 ztick (PLFLT, input) : World coordinate interval between major
875 ticks on the z axis. If it
is set to zero, PLplot automatically
876 generates a suitable tick interval.
878 nzsub (PLINT, input) : Number of subintervals between major z axis
879 ticks
for minor ticks. If it
is set to zero, PLplot automatically
880 generates a suitable minor tick interval.
883 return _plplotc.plbox3(xopt, xlabel, xtick, nsubx, yopt, ylabel, ytick, nsuby, zopt, zlabel, ztick, nsubz)
887 Calculate world coordinates and corresponding window index
from relative device coordinates
891 Calculate world coordinates, wx
and wy,
and corresponding window index
892 from relative device coordinates, rx
and ry.
894 Redacted form: General:
plcalc_world(rx, ry, wx, wy, window)
897 This function
is used
in example 31.
907 rx (PLFLT, input) : Input relative device coordinate (0.0-1.0)
for
910 ry (PLFLT, input) : Input relative device coordinate (0.0-1.0)
for
913 wx (PLFLT_NC_SCALAR, output) : Returned value of the x world
914 coordinate corresponding to the relative device coordinates rx
and
917 wy (PLFLT_NC_SCALAR, output) : Returned value of the y world
918 coordinate corresponding to the relative device coordinates rx
and
921 window (PLINT_NC_SCALAR, output) : Returned value of the last
922 defined window index that corresponds to the input relative device
923 coordinates (
and the returned world coordinates). To give some
924 background on the window index,
for each page the initial window
925 index
is set to zero,
and each time plwind
is called within the
926 page, world
and device coordinates are stored
for the window
and
927 the window index
is incremented. Thus,
for a simple page layout
928 with non-overlapping viewports
and one window per viewport, window
929 corresponds to the viewport index (
in the order which the
930 viewport/windows were created) of the only viewport/window
931 corresponding to rx
and ry. However,
for more complicated layouts
932 with potentially overlapping viewports
and possibly more than one
933 window (set of world coordinates) per viewport, window
and the
934 corresponding output world coordinates corresponds to the last
935 window created that fulfills the criterion that the relative
936 device coordinates are inside it. Finally,
in all cases where the
937 input relative device coordinates are
not inside any
938 viewport/window, then the returned value of the last defined
939 window index
is set to -1.
942 return _plplotc.plcalc_world(rx, ry)
946 Clear current (sub)page
950 Clears the current page, effectively erasing everything that have been
951 drawn. This command only works with interactive drivers;
if the
952 driver does
not support this, the page
is filled
with the background
953 color
in use. If the current page
is divided into subpages, only the
954 current subpage
is erased. The nth subpage can be selected
with
957 Redacted form: General:
plclear()
960 This function
is not used
in any examples.
969 return _plplotc.plclear()
977 Sets the color index for cmap0 (see the PLplot documentation).
979 Redacted form:
plcol0(icol0)
981 This function
is used
in examples 1-9, 11-16, 18-27,
and 29.
991 icol0 (PLINT, input) : Integer representing the color. The
992 defaults at present are (these may change):
993 0 black (default background)
994 1 red (default foreground)
1010 Use plscmap0 to change the entire cmap0 color palette
and plscol0 to
1011 change an individual color
in the cmap0 color palette.
1014 return _plplotc.plcol0(icol0)
1022 Sets the color for cmap1 (see the PLplot documentation).
1024 Redacted form:
plcol1(col1)
1026 This function
is used
in examples 12
and 21.
1036 col1 (PLFLT, input) : This value must be
in the range (0.0-1.0)
and
1037 is mapped to color using the continuous cmap1 palette which by
1038 default ranges
from blue to the background color to red. The
1039 cmap1 palette can also be straightforwardly changed by the user
1040 with plscmap1
or plscmap1l.
1043 return _plplotc.plcol1(col1)
1045def plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec):
1047 Configure the transformation between continuous and broken-down time
for the current stream
1051 Configure the transformation between continuous
and broken-down time
1052 for the current stream. This transformation
is used by both plbtime
1055 Redacted form: General:
plconfigtime(scale, offset1, offset2,
1056 ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1059 This function
is used
in example 29.
1065 plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1069 scale (PLFLT, input) : The number of days per continuous time unit.
1070 As a special case,
if
1071 scale
is 0., then all other arguments are ignored,
and the result (the
1072 default used by PLplot)
is the equivalent of a call to
1073 plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.).
1074 That
is,
for this special case broken-down time
is calculated
with
1075 the proleptic Gregorian calendar
with no leap seconds inserted,
1076 and the continuous time
is defined
as the number of seconds since
1077 the Unix epoch of 1970-01-01T00:00:00Z.
1079 offset1 (PLFLT, input) : If
1080 ifbtime_offset
is true, the parameters
1082 offset2 are completely ignored. Otherwise, the sum of these parameters
1083 (
with units
in days) specify the epoch of the continuous time
1084 relative to the MJD epoch corresponding to the Gregorian calendar
1085 date of 1858-11-17T00:00:00Z
or JD = 2400000.5. Two PLFLT numbers
1086 are used to specify the origin to allow users (by specifying
1087 offset1
as an integer that can be exactly represented by a
1088 floating-point variable
and specifying
1089 offset2
as a number
in the range
from 0. to 1) the chance to minimize
1090 the numerical errors of the continuous time representation.
1092 offset2 (PLFLT, input) : See documentation of
1095 ccontrol (PLINT, input) : ccontrol contains bits controlling the
1096 transformation. If the 0x1 bit
is set, then the proleptic Julian
1097 calendar
is used
for broken-down time rather than the proleptic
1098 Gregorian calendar. If the 0x2 bit
is set, then leap seconds that
1099 have been historically used to define UTC are inserted into the
1100 broken-down time. Other possibilities
for additional control bits
1101 for ccontrol exist such
as making the historical time corrections
1102 in the broken-down time corresponding to ET (ephemeris time)
or
1103 making the (slightly non-constant) corrections
from international
1104 atomic time (TAI) to what astronomers define
as terrestrial time
1105 (TT). But those additional possibilities have
not been
1106 implemented yet
in the qsastime library (one of the PLplot utility
1109 ifbtime_offset (PLBOOL, input) : ifbtime_offset controls how the
1110 epoch of the continuous time scale
is specified by the user. If
1111 ifbtime_offset
is false, then
1113 offset2 are used to specify the epoch,
and the following broken-down
1114 time parameters are completely ignored. If
1115 ifbtime_offset
is true, then
1117 offset2 are completely ignored,
and the following broken-down time
1118 parameters are used to specify the epoch.
1120 year (PLINT, input) : Year of epoch.
1122 month (PLINT, input) : Month of epoch
in range
from 0 (January) to
1125 day (PLINT, input) : Day of epoch
in range
from 1 to 31.
1127 hour (PLINT, input) : Hour of epoch
in range
from 0 to 23
1129 min (PLINT, input) : Minute of epoch
in range
from 0 to 59.
1131 sec (PLFLT, input) : Second of epoch
in range
from 0. to 60.
1134 return _plplotc.plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)
1142 Draws a contour plot of the data in f[
1144 ny], using the nlevel contour levels specified by clevel. Only the
1145 region of the matrix
from kx to lx
and from ky to ly
is plotted out
1146 where all these index ranges are interpreted
as one-based
for
1147 historical reasons. A transformation routine pointed to by pltr
with
1148 a generic pointer pltr_data
for additional data required by the
1149 transformation routine
is used to map indices within the matrix to the
1152 Redacted form:
plcont(f, kx, lx, ky, ly, clevel, pltr, pltr_data)
1153 where (see above discussion) the pltr, pltr_data callback arguments
1154 are sometimes replaced by a tr vector
with 6 elements; xg
and yg
1155 vectors;
or xg
and yg matrices.
1157 This function
is used
in examples 9, 14, 16,
and 22.
1163 plcont(f, nx, ny, kx, lx, ky, ly, clevel, nlevel, pltr, pltr_data)
1167 f (PLFLT_MATRIX, input) : A matrix containing data to be contoured.
1169 nx, ny (PLINT, input) : The dimensions of the matrix f.
1171 kx, lx (PLINT, input) : Range of x indices to consider where 0 <=
1172 kx-1 < lx-1 < nx. Values of kx
and lx are one-based rather than
1173 zero-based
for historical backwards-compatibility reasons.
1175 ky, ly (PLINT, input) : Range of y indices to consider where 0 <=
1176 ky-1 < ly-1 < ny. Values of ky
and ly are one-based rather than
1177 zero-based
for historical backwards-compatibility reasons.
1179 clevel (PLFLT_VECTOR, input) : A vector specifying the levels at
1180 which to draw contours.
1182 nlevel (PLINT, input) : Number of contour levels to draw.
1184 pltr (PLTRANSFORM_callback, input) : A callback function that
1185 defines the transformation between the zero-based indices of the
1186 matrix f
and the world coordinates.For the C case, transformation
1187 functions are provided
in the PLplot library: pltr0
for the
1188 identity mapping,
and pltr1
and pltr2
for arbitrary mappings
1189 respectively defined by vectors
and matrices. In addition, C
1190 callback routines
for the transformation can be supplied by the
1191 user such
as the mypltr function
in examples/c/x09c.c which
1192 provides a general linear transformation between index coordinates
1193 and world coordinates.For languages other than C you should
1194 consult the PLplot documentation
for the details concerning how
1195 PLTRANSFORM_callback arguments are interfaced. However,
in
1196 general, a particular pattern of callback-associated arguments
1197 such
as a tr vector
with 6 elements; xg
and yg vectors;
or xg
and
1198 yg matrices are respectively interfaced to a linear-transformation
1199 routine similar to the above mypltr function; pltr1;
and pltr2.
1200 Furthermore, some of our more sophisticated bindings (see, e.g.,
1201 the PLplot documentation) support native language callbacks
for
1202 handling index to world-coordinate transformations. Examples of
1203 these various approaches are given
in examples/<language>x09*,
1204 examples/<language>x16*, examples/<language>x20*,
1205 examples/<language>x21*,
and examples/<language>x22*,
for all our
1206 supported languages.
1208 pltr_data (PLPointer, input) : Extra parameter to help
pass
1209 information to pltr0, pltr1, pltr2,
or whatever callback routine
1210 that
is externally supplied.
1213 return _plplotc.plcont(*args)
1217 Calculate continuous time from broken-down time
for the current stream
1221 Calculate continuous time, ctime,
from broken-down time
for the
1222 current stream. The broken-down
1223 time
is specified by the following parameters: year, month, day, hour,
1224 min,
and sec. This function
is the inverse of plbtime.
1226 The PLplot definition of broken-down time
is a calendar time that
1227 completely ignores all time zone offsets, i.e., it
is the user
's
1228 responsibility to apply those offsets (if so desired) before using the
1229 PLplot time API. By default broken-down time
is defined using the
1230 proleptic Gregorian calendar without the insertion of leap seconds
and
1231 continuous time
is defined
as the number of seconds since the Unix
1232 epoch of 1970-01-01T00:00:00Z. However, other definitions of
1233 broken-down
and continuous time are possible, see plconfigtime which
1234 specifies that transformation
for the current stream.
1236 Redacted form: General:
plctime(year, month, day, hour, min, sec,
1240 This function
is used
in example 29.
1246 plctime(year, month, day, hour, min, sec, ctime)
1250 year (PLINT, input) : Input year.
1252 month (PLINT, input) : Input month
in range
from 0 (January) to 11
1255 day (PLINT, input) : Input day
in range
from 1 to 31.
1257 hour (PLINT, input) : Input hour
in range
from 0 to 23
1259 min (PLINT, input) : Input minute
in range
from 0 to 59.
1261 sec (PLFLT, input) : Input second
in range
from 0. to 60.
1263 ctime (PLFLT_NC_SCALAR, output) : Returned value of the continuous
1264 time calculated
from the broken-down time specified by the
1265 previous parameters.
1268 return _plplotc.plctime(year, month, day, hour, min, sec)
1272 Copy state parameters from the reference stream to the current stream
1276 Copies state parameters
from the reference stream to the current
1277 stream. Tell driver interface to map device coordinates unless flags
1280 This function
is used
for making save files of selected plots (e.g.
1281 from the TK driver). After initializing, you can get a copy of the
1282 current plot to the specified device by switching to this stream
and
1283 issuing a plcpstrm
and a plreplot,
with calls to plbop
and pleop
as
1284 appropriate. The plot buffer must have previously been enabled (done
1285 automatically by some display drivers, such
as X).
1287 Redacted form:
plcpstrm(iplsr, flags)
1289 This function
is used
in example 1,20.
1299 iplsr (PLINT, input) : Number of reference stream.
1301 flags (PLBOOL, input) : If flags
is set to true the device
1302 coordinates are
not copied
from the reference to current stream.
1305 return _plplotc.plcpstrm(iplsr, flags)
1309 End plotting session
1313 Ends a plotting session, tidies up all the output files, switches
1314 interactive devices back into text mode and frees up any memory that
1315 was allocated. Must be called before end of program.
1317 By default, PLplot
's interactive devices (Xwin, TK, etc.) go into a
1318 wait state after a call to plend or other functions which trigger the
1319 end of a plot page. To avoid this, use the plspause function.
1321 Redacted form:
plend()
1323 This function
is used
in all of the examples.
1332 return _plplotc.plend()
1336 End plotting session for current stream
1340 Ends a plotting session
for the current output stream only. See
1341 plsstrm
for more info.
1345 This function
is used
in examples 1
and 20.
1354 return _plplotc.plend1()
1356def plenv(xmin, xmax, ymin, ymax, just, axis):
1358 Set up standard window and draw box
1362 Sets up plotter environment
for simple graphs by calling pladv
and
1363 setting up viewport
and window to sensible default values. plenv
1364 leaves a standard margin (left-hand margin of eight character heights,
1365 and a margin around the other three sides of five character heights)
1366 around most graphs
for axis labels
and a title. When these defaults
1367 are
not suitable, use the individual routines plvpas, plvpor,
or
1368 plvasp
for setting up the viewport, plwind
for defining the window,
1369 and plbox
for drawing the box.
1371 Redacted form:
plenv(xmin, xmax, ymin, ymax, just, axis)
1373 This function
is used
in example 1,3,9,13,14,19-22,29.
1379 plenv(xmin, xmax, ymin, ymax, just, axis)
1383 xmin (PLFLT, input) : Value of x at left-hand edge of window (
in
1386 xmax (PLFLT, input) : Value of x at right-hand edge of window (
in
1389 ymin (PLFLT, input) : Value of y at bottom edge of window (
in world
1392 ymax (PLFLT, input) : Value of y at top edge of window (
in world
1395 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1396 scales will
not be set, the user must set up the scale before
1397 calling plenv using plsvpa, plvasp
or other.
1398 0: the x
and y axes are scaled independently to use
as much of
1399 the screen
as possible.
1400 1: the scales of the x
and y axes are made equal.
1401 2: the axis of the x
and y axes are made equal,
and the plot
1405 axis (PLINT, input) : Controls drawing of the box around the plot:
1406 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1408 0: draw box, ticks,
and numeric tick labels.
1409 1: also draw coordinate axes at x=0
and y=0.
1410 2: also draw a grid at major tick positions
in both
1412 3: also draw a grid at minor tick positions
in both
1414 10: same
as 0
except logarithmic x tick marks. (The x data
1415 have to be converted to logarithms separately.)
1416 11: same
as 1
except logarithmic x tick marks. (The x data
1417 have to be converted to logarithms separately.)
1418 12: same
as 2
except logarithmic x tick marks. (The x data
1419 have to be converted to logarithms separately.)
1420 13: same
as 3
except logarithmic x tick marks. (The x data
1421 have to be converted to logarithms separately.)
1422 20: same
as 0
except logarithmic y tick marks. (The y data
1423 have to be converted to logarithms separately.)
1424 21: same
as 1
except logarithmic y tick marks. (The y data
1425 have to be converted to logarithms separately.)
1426 22: same
as 2
except logarithmic y tick marks. (The y data
1427 have to be converted to logarithms separately.)
1428 23: same
as 3
except logarithmic y tick marks. (The y data
1429 have to be converted to logarithms separately.)
1430 30: same
as 0
except logarithmic x
and y tick marks. (The x
1431 and y data have to be converted to logarithms separately.)
1432 31: same
as 1
except logarithmic x
and y tick marks. (The x
1433 and y data have to be converted to logarithms separately.)
1434 32: same
as 2
except logarithmic x
and y tick marks. (The x
1435 and y data have to be converted to logarithms separately.)
1436 33: same
as 3
except logarithmic x
and y tick marks. (The x
1437 and y data have to be converted to logarithms separately.)
1438 40: same
as 0
except date / time x labels.
1439 41: same
as 1
except date / time x labels.
1440 42: same
as 2
except date / time x labels.
1441 43: same
as 3
except date / time x labels.
1442 50: same
as 0
except date / time y labels.
1443 51: same
as 1
except date / time y labels.
1444 52: same
as 2
except date / time y labels.
1445 53: same
as 3
except date / time y labels.
1446 60: same
as 0
except date / time x
and y labels.
1447 61: same
as 1
except date / time x
and y labels.
1448 62: same
as 2
except date / time x
and y labels.
1449 63: same
as 3
except date / time x
and y labels.
1450 70: same
as 0
except custom x
and y labels.
1451 71: same
as 1
except custom x
and y labels.
1452 72: same
as 2
except custom x
and y labels.
1453 73: same
as 3
except custom x
and y labels.
1456 return _plplotc.plenv(xmin, xmax, ymin, ymax, just, axis)
1458def plenv0(xmin, xmax, ymin, ymax, just, axis):
1460 Same as plenv but
if in multiplot mode does
not advance the subpage, instead clears it
1464 Sets up plotter environment
for simple graphs by calling pladv
and
1465 setting up viewport
and window to sensible default values. plenv0
1466 leaves a standard margin (left-hand margin of eight character heights,
1467 and a margin around the other three sides of five character heights)
1468 around most graphs
for axis labels
and a title. When these defaults
1469 are
not suitable, use the individual routines plvpas, plvpor,
or
1470 plvasp
for setting up the viewport, plwind
for defining the window,
1471 and plbox
for drawing the box.
1473 Redacted form:
plenv0(xmin, xmax, ymin, ymax, just, axis)
1475 This function
is used
in example 21.
1481 plenv0(xmin, xmax, ymin, ymax, just, axis)
1485 xmin (PLFLT, input) : Value of x at left-hand edge of window (
in
1488 xmax (PLFLT, input) : Value of x at right-hand edge of window (
in
1491 ymin (PLFLT, input) : Value of y at bottom edge of window (
in world
1494 ymax (PLFLT, input) : Value of y at top edge of window (
in world
1497 just (PLINT, input) : Controls how the axes will be scaled: -1: the
1498 scales will
not be set, the user must set up the scale before
1499 calling plenv0 using plsvpa, plvasp
or other.
1500 0: the x
and y axes are scaled independently to use
as much of
1501 the screen
as possible.
1502 1: the scales of the x
and y axes are made equal.
1503 2: the axis of the x
and y axes are made equal,
and the plot
1507 axis (PLINT, input) : Controls drawing of the box around the plot:
1508 -2: draw no box, no tick marks, no numeric tick labels, no axes.
1510 0: draw box, ticks,
and numeric tick labels.
1511 1: also draw coordinate axes at x=0
and y=0.
1512 2: also draw a grid at major tick positions
in both
1514 3: also draw a grid at minor tick positions
in both
1516 10: same
as 0
except logarithmic x tick marks. (The x data
1517 have to be converted to logarithms separately.)
1518 11: same
as 1
except logarithmic x tick marks. (The x data
1519 have to be converted to logarithms separately.)
1520 12: same
as 2
except logarithmic x tick marks. (The x data
1521 have to be converted to logarithms separately.)
1522 13: same
as 3
except logarithmic x tick marks. (The x data
1523 have to be converted to logarithms separately.)
1524 20: same
as 0
except logarithmic y tick marks. (The y data
1525 have to be converted to logarithms separately.)
1526 21: same
as 1
except logarithmic y tick marks. (The y data
1527 have to be converted to logarithms separately.)
1528 22: same
as 2
except logarithmic y tick marks. (The y data
1529 have to be converted to logarithms separately.)
1530 23: same
as 3
except logarithmic y tick marks. (The y data
1531 have to be converted to logarithms separately.)
1532 30: same
as 0
except logarithmic x
and y tick marks. (The x
1533 and y data have to be converted to logarithms separately.)
1534 31: same
as 1
except logarithmic x
and y tick marks. (The x
1535 and y data have to be converted to logarithms separately.)
1536 32: same
as 2
except logarithmic x
and y tick marks. (The x
1537 and y data have to be converted to logarithms separately.)
1538 33: same
as 3
except logarithmic x
and y tick marks. (The x
1539 and y data have to be converted to logarithms separately.)
1540 40: same
as 0
except date / time x labels.
1541 41: same
as 1
except date / time x labels.
1542 42: same
as 2
except date / time x labels.
1543 43: same
as 3
except date / time x labels.
1544 50: same
as 0
except date / time y labels.
1545 51: same
as 1
except date / time y labels.
1546 52: same
as 2
except date / time y labels.
1547 53: same
as 3
except date / time y labels.
1548 60: same
as 0
except date / time x
and y labels.
1549 61: same
as 1
except date / time x
and y labels.
1550 62: same
as 2
except date / time x
and y labels.
1551 63: same
as 3
except date / time x
and y labels.
1552 70: same
as 0
except custom x
and y labels.
1553 71: same
as 1
except custom x
and y labels.
1554 72: same
as 2
except custom x
and y labels.
1555 73: same
as 3
except custom x
and y labels.
1558 return _plplotc.plenv0(xmin, xmax, ymin, ymax, just, axis)
1566 Clears the graphics screen of an interactive device, or ejects a page
1567 on a plotter. See plbop
for more information.
1569 Redacted form:
pleop()
1571 This function
is used
in example 2,14.
1580 return _plplotc.pleop()
1584 Draw error bars in x direction
1588 Draws a set of n error bars
in x direction, the i
'th error bar
1589 extending from xmin[i] to xmax[i] at y coordinate y[i]. The terminals
1590 of the error bars are of length equal to the minor tick length
1591 (settable using plsmin).
1593 Redacted form: General:
plerrx(xmin, ymax, y)
1596 This function
is used
in example 29.
1606 n (PLINT, input) : Number of error bars to draw.
1608 xmin (PLFLT_VECTOR, input) : A vector containing the x coordinates
1609 of the left-hand endpoints of the error bars.
1611 xmax (PLFLT_VECTOR, input) : A vector containing the x coordinates
1612 of the right-hand endpoints of the error bars.
1614 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1618 return _plplotc.plerrx(n, arg2, arg3)
1622 Draw error bars in the y direction
1626 Draws a set of n error bars
in the y direction, the i
'th error bar
1627 extending from ymin[i] to ymax[i] at x coordinate x[i]. The terminals
1628 of the error bars are of length equal to the minor tick length
1629 (settable using plsmin).
1631 Redacted form: General:
plerry(x, ymin, ymax)
1634 This function
is used
in example 29.
1644 n (PLINT, input) : Number of error bars to draw.
1646 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1649 ymin (PLFLT_VECTOR, input) : A vector containing the y coordinates
1650 of the lower endpoints of the error bars.
1652 ymax (PLFLT_VECTOR, input) : A vector containing the y coordinates
1653 of the upper endpoints of the error bars.
1656 return _plplotc.plerry(n, arg2, arg3)
1660 Advance to the next family file on the next new page
1664 Advance to the next family file on the next new page.
1668 This function is not used
in any examples.
1677 return _plplotc.plfamadv()
1685 Fills the polygon defined by the n points (
1687 y[i]) using the pattern defined by plpsty or plpat. The default fill
1688 style
is a solid fill. The routine will automatically close the
1689 polygon between the last
and first vertices. If multiple closed
1690 polygons are passed
in x
and y then plfill will fill
in between them.
1692 Redacted form:
plfill(x,y)
1694 This function
is used
in examples 12, 13, 15, 16, 21, 24,
and 25.
1704 n (PLINT, input) : Number of vertices
in polygon.
1706 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1709 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1713 return _plplotc.plfill(n, ArrayCk)
1717 Draw filled polygon in 3D
1721 Fills the 3D polygon defined by the n points
in the x, y,
and z
1722 vectors using the pattern defined by plpsty
or plpat. The routine
1723 will automatically close the polygon between the last
and first
1724 vertices. If multiple closed polygons are passed
in x, y,
and z then
1725 plfill3 will fill
in between them.
1727 Redacted form: General:
plfill3(x, y, z)
1730 This function
is used
in example 15.
1740 n (PLINT, input) : Number of vertices
in polygon.
1742 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1745 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1748 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
1752 return _plplotc.plfill3(n, arg2, arg3)
1756 Draw linear gradient inside polygon
1760 Draw a linear gradient using cmap1 inside the polygon defined by the n
1763 y[i]). Interpretation of the polygon is the same
as for plfill. The
1764 polygon coordinates
and the gradient angle are all expressed
in world
1765 coordinates. The angle
from the x axis
for both the rotated
1766 coordinate system
and the gradient vector
is specified by angle. The
1767 magnitude of the gradient vector
is the difference between the maximum
1768 and minimum values of x
for the vertices
in the rotated coordinate
1769 system. The origin of the gradient vector can be interpreted
as being
1770 anywhere on the line corresponding to the minimum x value
for the
1771 vertices
in the rotated coordinate system. The distance along the
1772 gradient vector
is linearly transformed to the independent variable of
1773 color map 1 which ranges
from 0. at the tail of the gradient vector to
1774 1. at the head of the gradient vector. What
is drawn
is the RGBA
1775 color corresponding to the independent variable of cmap1. For more
1776 information about cmap1 (see the PLplot documentation).
1780 This function
is used
in examples 25
and 30.
1790 n (PLINT, input) : Number of vertices
in polygon.
1792 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
1795 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
1798 angle (PLFLT, input) : Angle (degrees) of gradient vector
from x
1802 return _plplotc.plgradient(n, ArrayCk, angle)
1806 Flushes the output stream
1810 Flushes the output stream. Use sparingly, if at all.
1814 This function
is used
in examples 1
and 14.
1823 return _plplotc.plflush()
1831 Sets the font used for subsequent text
and symbols. For devices that
1832 still use Hershey fonts this routine has no effect unless the Hershey
1833 fonts
with extended character set are loaded (see plfontld). For
1834 unicode-aware devices that use system fonts instead of Hershey fonts,
1835 this routine calls the plsfci routine
with argument set up
1836 appropriately
for the various cases below. However, this method of
1837 specifying the font
for unicode-aware devices
is deprecated,
and the
1838 much more flexible method of calling plsfont directly
is recommended
1839 instead (where plsfont provides a user-friendly interface to plsfci),
1841 Redacted form:
plfont(ifont)
1843 This function
is used
in examples 1, 2, 4, 7, 13, 24,
and 26.
1853 ifont (PLINT, input) : Specifies the font: 1: Sans serif font
1854 (simplest
and fastest)
1860 return _plplotc.plfont(ifont)
1868 Loads the Hershey fonts used for text
and symbols. This routine may
1869 be called before
or after initializing PLplot. If
not explicitly
1870 called before PLplot initialization, then by default that
1871 initialization loads Hershey fonts
with the extended character set.
1872 This routine only has a practical effect
for devices that still use
1873 Hershey fonts (
as opposed to modern devices that use unicode-aware
1874 system fonts instead of Hershey fonts).
1878 This function
is used
in examples 1
and 7.
1888 fnt (PLINT, input) : Specifies the type of Hershey fonts to load.
1889 A zero value specifies Hershey fonts
with the standard character
1890 set
and a non-zero value (the default assumed
if plfontld
is never
1891 called) specifies Hershey fonts
with the extended character set.
1894 return _plplotc.plfontld(fnt)
1898 Get character default height and current (scaled) height
1902 Get character default height
and current (scaled) height.
1904 Redacted form:
plgchr(p_def, p_ht)
1906 This function
is used
in example 23.
1916 p_def (PLFLT_NC_SCALAR, output) : Returned value of the default
1917 character height (mm).
1919 p_ht (PLFLT_NC_SCALAR, output) : Returned value of the scaled
1920 character height (mm).
1923 return _plplotc.plgchr()
1927 Returns 8-bit RGB values for given color index
from cmap0
1931 Returns 8-bit RGB values (0-255)
for given color
from cmap0 (see the
1932 PLplot documentation). Values are negative
if an invalid color id
is
1935 Redacted form:
plgcol0(icol0, r, g, b)
1937 This function
is used
in example 2.
1947 icol0 (PLINT, input) : Index of desired cmap0 color.
1949 r (PLINT_NC_SCALAR, output) : Returned value of the 8-bit red
1952 g (PLINT_NC_SCALAR, output) : Returned value of the 8-bit green
1955 b (PLINT_NC_SCALAR, output) : Returned value of the 8-bit blue
1959 return _plplotc.plgcol0(icol0)
1963 Returns 8-bit RGB values and PLFLT alpha transparency value
for given color index
from cmap0
1967 Returns 8-bit RGB values (0-255)
and PLFLT alpha transparency value
1968 (0.0-1.0)
for given color
from cmap0 (see the PLplot documentation).
1969 Values are negative
if an invalid color id
is given.
1971 Redacted form: plgcola(r, g, b)
1973 This function
is used
in example 30.
1983 icol0 (PLINT, input) : Index of desired cmap0 color.
1985 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
1986 in the range
from 0 to 255.
1988 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
1989 in the range
from 0 to 255.
1991 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
1992 in the range
from 0 to 255.
1994 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
1995 transparency
in the range
from (0.0-1.0).
1998 return _plplotc.plgcol0a(icol0)
2002 Returns the background color (cmap0[0]) by 8-bit RGB value
2006 Returns the background color (cmap0[0]) by 8-bit RGB value.
2010 This function is used
in example 31.
2020 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2021 in the range
from 0 to 255.
2023 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2024 in the range
from 0 to 255.
2026 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2027 in the range
from 0 to 255.
2030 return _plplotc.plgcolbg()
2034 Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT alpha transparency value
2038 Returns the background color (cmap0[0]) by 8-bit RGB value
and PLFLT
2039 alpha transparency value.
2041 This function
is used
in example 31.
2051 r (PLINT_NC_SCALAR, output) : Returned value of the red intensity
2052 in the range
from 0 to 255.
2054 g (PLINT_NC_SCALAR, output) : Returned value of the green intensity
2055 in the range
from 0 to 255.
2057 b (PLINT_NC_SCALAR, output) : Returned value of the blue intensity
2058 in the range
from 0 to 255.
2060 alpha (PLFLT_NC_SCALAR, output) : Returned value of the alpha
2061 transparency
in the range (0.0-1.0).
2064 return _plplotc.plgcolbga()
2068 Get the current device-compression setting
2072 Get the current device-compression setting. This parameter is only
2073 used
for drivers that provide compression.
2077 This function
is used
in example 31.
2087 compression (PLINT_NC_SCALAR, output) : Returned value of the
2088 compression setting
for the current device.
2091 return _plplotc.plgcompression()
2095 Get the current device (keyword) name
2099 Get the current device (keyword) name. Note: you must have allocated
2100 space for this (80 characters
is safe).
2102 Redacted form:
plgdev(p_dev)
2104 This function
is used
in example 14.
2114 p_dev (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2115 (
with preallocated length of 80 characters
or more) containing the
2116 device (keyword) name.
2119 return _plplotc.plgdev()
2123 Get parameters that define current device-space window
2127 Get relative margin width, aspect ratio, and relative justification
2128 that define current device-space window. If plsdidev has
not been
2129 called the default values pointed to by p_mar, p_aspect, p_jx,
and
2132 Redacted form:
plgdidev(p_mar, p_aspect, p_jx, p_jy)
2134 This function
is used
in example 31.
2140 plgdidev(p_mar, p_aspect, p_jx, p_jy)
2144 p_mar (PLFLT_NC_SCALAR, output) : Returned value of the relative
2147 p_aspect (PLFLT_NC_SCALAR, output) : Returned value of the aspect
2150 p_jx (PLFLT_NC_SCALAR, output) : Returned value of the relative
2153 p_jy (PLFLT_NC_SCALAR, output) : Returned value of the relative
2157 return _plplotc.plgdidev()
2161 Get plot orientation
2165 Get plot orientation parameter which is multiplied by 90 degrees to
2166 obtain the angle of rotation. Note, arbitrary rotation parameters
2167 such
as 0.2 (corresponding to 18 degrees) are possible, but the usual
2168 values
for the rotation parameter are 0., 1., 2.,
and 3. corresponding
2169 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
2170 (seascape mode),
and 270 degrees (upside-down mode). If plsdiori has
2171 not been called the default value pointed to by p_rot will be 0.
2175 This function
is not used
in any examples.
2185 p_rot (PLFLT_NC_SCALAR, output) : Returned value of the orientation
2189 return _plplotc.plgdiori()
2193 Get parameters that define current plot-space window
2197 Get relative minima and maxima that define current plot-space window.
2198 If plsdiplt has
not been called the default values pointed to by
2199 p_xmin, p_ymin, p_xmax,
and p_ymax will be 0., 0., 1.,
and 1.
2201 Redacted form:
plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2203 This function
is used
in example 31.
2209 plgdiplt(p_xmin, p_ymin, p_xmax, p_ymax)
2213 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2216 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the relative
2219 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2222 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the relative
2226 return _plplotc.plgdiplt()
2230 Get family file parameters
2234 Gets information about current family file, if familying
is enabled.
2235 See the PLplot documentation
for more information.
2237 Redacted form:
plgfam(p_fam, p_num, p_bmax)
2239 This function
is used
in examples 14
and 31.
2245 plgfam(p_fam, p_num, p_bmax)
2249 p_fam (PLINT_NC_SCALAR, output) : Returned value of the current
2250 family flag value. If nonzero, familying
is enabled
for the
2253 p_num (PLINT_NC_SCALAR, output) : Returned value of the current
2256 p_bmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2257 file size (
in bytes)
for a family file.
2260 return _plplotc.plgfam()
2264 Get FCI (font characterization integer)
2268 Gets information about the current font using the FCI approach. See
2269 the PLplot documentation for more information.
2271 Redacted form:
plgfci(p_fci)
2273 This function
is used
in example 23.
2283 p_fci (PLUNICODE_NC_SCALAR, output) : Returned value of the current
2287 return _plplotc.plgfci()
2291 Get output file name
2295 Gets the current output file name, if applicable.
2299 This function
is used
in example 31.
2309 fnam (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2310 (
with preallocated length of 80 characters
or more) containing the
2314 return _plplotc.plgfnam()
2318 Get family, style and weight of the current font
2322 Gets information about current font. See the PLplot documentation
for
2323 more information on font selection.
2325 Redacted form:
plgfont(p_family, p_style, p_weight)
2327 This function
is used
in example 23.
2333 plgfont(p_family, p_style, p_weight)
2337 p_family (PLINT_NC_SCALAR, output) : Returned value of the current
2338 font family. The available values are given by the PL_FCI_*
2339 constants
in plplot.h. Current options are PL_FCI_SANS,
2340 PL_FCI_SERIF, PL_FCI_MONO, PL_FCI_SCRIPT
and PL_FCI_SYMBOL. If
2341 p_family
is NULL then the font family
is not returned.
2343 p_style (PLINT_NC_SCALAR, output) : Returned value of the current
2344 font style. The available values are given by the PL_FCI_*
2345 constants
in plplot.h. Current options are PL_FCI_UPRIGHT,
2346 PL_FCI_ITALIC
and PL_FCI_OBLIQUE. If p_style
is NULL then the font
2347 style
is not returned.
2349 p_weight (PLINT_NC_SCALAR, output) : Returned value of the current
2350 font weight. The available values are given by the PL_FCI_*
2351 constants
in plplot.h. Current options are PL_FCI_MEDIUM
and
2352 PL_FCI_BOLD. If p_weight
is NULL then the font weight
is not
2356 return _plplotc.plgfont()
2360 Get the (current) run level
2364 Get the (current) run level. Valid settings are: 0, uninitialized
2367 3, world coordinates defined
2372 This function is used
in example 31.
2382 p_level (PLINT_NC_SCALAR, output) : Returned value of the run
2386 return _plplotc.plglevel()
2394 Gets the current page configuration. The length and offset values are
2395 expressed
in units that are specific to the current driver. For
2396 instance: screen drivers will usually interpret them
as number of
2397 pixels, whereas printer drivers will usually use mm.
2399 Redacted form:
plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2401 This function
is used
in examples 14
and 31.
2407 plgpage(p_xp, p_yp, p_xleng, p_yleng, p_xoff, p_yoff)
2411 p_xp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2412 pixels/inch (DPI)
in x.
2414 p_yp (PLFLT_NC_SCALAR, output) : Returned value of the number of
2415 pixels/inch (DPI)
in y.
2417 p_xleng (PLINT_NC_SCALAR, output) : Returned value of the x page
2420 p_yleng (PLINT_NC_SCALAR, output) : Returned value of the y page
2423 p_xoff (PLINT_NC_SCALAR, output) : Returned value of the x page
2426 p_yoff (PLINT_NC_SCALAR, output) : Returned value of the y page
2430 return _plplotc.plgpage()
2434 Switch to graphics screen
2438 Sets an interactive device to graphics mode, used in conjunction
with
2439 pltext to allow graphics
and text to be interspersed. On a device
2440 which supports separate text
and graphics windows, this command causes
2441 control to be switched to the graphics window. If already
in graphics
2442 mode, this command
is ignored. It
is also ignored on devices which
2443 only support a single window
or use a different method
for shifting
2444 focus. See also pltext.
2446 Redacted form:
plgra()
2448 This function
is used
in example 1.
2457 return _plplotc.plgra()
2461 Grid data from irregularly sampled data
2465 Real world data
is frequently irregularly sampled, but PLplot 3D plots
2466 require data organized
as a grid, i.e.,
with x sample point values
2467 independent of y coordinate
and vice versa. This function takes
2468 irregularly sampled data
from the x[npts], y[npts],
and z[npts]
2469 vectors; reads the desired grid location
from the input vectors
2470 xg[nptsx]
and yg[nptsy];
and returns the interpolated result on that
2471 grid using the output matrix zg[nptsx][nptsy]. The algorithm used to
2472 interpolate the data to the grid
is specified
with the argument type
2473 which can have one parameter specified
in argument data.
2475 Redacted form: General:
plgriddata(x, y, z, xg, yg, zg, type, data)
2476 Python: zg=
plgriddata(x, y, z, xg, yg, type, data)
2479 This function
is used
in example 21.
2485 plgriddata(x, y, z, npts, xg, nptsx, yg, nptsy, zg, type, data)
2489 x (PLFLT_VECTOR, input) : The input x vector.
2491 y (PLFLT_VECTOR, input) : The input y vector.
2493 z (PLFLT_VECTOR, input) : The input z vector. Each triple x[i],
2494 y[i], z[i] represents one data sample coordinate.
2496 npts (PLINT, input) : The number of data samples
in the x, y
and z
2499 xg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2500 in the x direction. Usually xg has nptsx equally spaced values
2501 from the minimum to the maximum values of the x input vector.
2503 nptsx (PLINT, input) : The number of points
in the xg vector.
2505 yg (PLFLT_VECTOR, input) : A vector that specifies the grid spacing
2506 in the y direction. Similar to the xg parameter.
2508 nptsy (PLINT, input) : The number of points
in the yg vector.
2510 zg (PLFLT_NC_MATRIX, output) : The matrix of interpolated results
2511 where data lies
in the grid specified by xg
and yg. Therefore the
2512 zg matrix must be dimensioned
2516 type (PLINT, input) : The type of grid interpolation algorithm to
2517 use, which can be: GRID_CSA: Bivariate Cubic Spline approximation
2518 GRID_DTLI: Delaunay Triangulation Linear Interpolation
2519 GRID_NNI: Natural Neighbors Interpolation
2520 GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
2521 GRID_NNLI: Nearest Neighbors Linear Interpolation
2522 GRID_NNAIDW: Nearest Neighbors Around Inverse Distance
2524 For details of the algorithms read the source file plgridd.c.
2526 data (PLFLT, input) : Some gridding algorithms require extra data,
2527 which can be specified through this argument. Currently,
for
2528 algorithm: GRID_NNIDW, data specifies the number of neighbors to
2529 use, the lower the value, the noisier (more local) the
2531 GRID_NNLI, data specifies what a thin triangle
is,
in the
2532 range [1. .. 2.]. High values enable the usage of very thin
2533 triangles
for interpolation, possibly resulting
in error
in
2535 GRID_NNI, only weights greater than data will be accepted. If
2536 0, all weights will be accepted.
2539 return _plplotc.plgriddata(Array, arg2, arg3, ArrayX, ArrayY, type, data)
2543 Get current subpage parameters
2547 Gets the size of the current subpage in millimeters measured
from the
2548 bottom left hand corner of the output device page
or screen. Can be
2549 used
in conjunction
with plsvpa
for setting the size of a viewport
in
2550 absolute coordinates (millimeters).
2552 Redacted form:
plgspa(xmin, xmax, ymin, ymax)
2554 This function
is used
in example 23.
2560 plgspa(xmin, xmax, ymin, ymax)
2564 xmin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2565 the left hand edge of the subpage
in millimeters.
2567 xmax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2568 the right hand edge of the subpage
in millimeters.
2570 ymin (PLFLT_NC_SCALAR, output) : Returned value of the position of
2571 the bottom edge of the subpage
in millimeters.
2573 ymax (PLFLT_NC_SCALAR, output) : Returned value of the position of
2574 the top edge of the subpage
in millimeters.
2577 return _plplotc.plgspa()
2581 Get current stream number
2585 Gets the number of the current output stream. See also plsstrm.
2587 Redacted form: plgstrm(p_strm)
2589 This function is used
in example 1,20.
2599 p_strm (PLINT_NC_SCALAR, output) : Returned value of the current
2603 return _plplotc.plgstrm()
2607 Get the current library version number
2611 Get the current library version number. Note: you must have allocated
2612 space for this (80 characters
is safe).
2614 Redacted form:
plgver(p_ver)
2616 This function
is used
in example 1.
2626 p_ver (PLCHAR_NC_VECTOR, output) : Returned ascii character string
2627 (
with preallocated length of 80 characters
or more) containing the
2628 PLplot version number.
2631 return _plplotc.plgver()
2635 Get viewport limits in normalized device coordinates
2639 Get viewport limits
in normalized device coordinates.
2641 Redacted form: General:
plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2644 This function
is used
in example 31.
2650 plgvpd(p_xmin, p_xmax, p_ymin, p_ymax)
2654 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2655 viewport limit of the normalized device coordinate
in x.
2657 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2658 viewport limit of the normalized device coordinate
in x.
2660 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2661 viewport limit of the normalized device coordinate
in y.
2663 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2664 viewport limit of the normalized device coordinate
in y.
2667 return _plplotc.plgvpd()
2671 Get viewport limits in world coordinates
2675 Get viewport limits
in world coordinates.
2677 Redacted form: General:
plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2680 This function
is used
in example 31.
2686 plgvpw(p_xmin, p_xmax, p_ymin, p_ymax)
2690 p_xmin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2691 viewport limit of the world coordinate
in x.
2693 p_xmax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2694 viewport limit of the world coordinate
in x.
2696 p_ymin (PLFLT_NC_SCALAR, output) : Returned value of the lower
2697 viewport limit of the world coordinate
in y.
2699 p_ymax (PLFLT_NC_SCALAR, output) : Returned value of the upper
2700 viewport limit of the world coordinate
in y.
2703 return _plplotc.plgvpw()
2707 Get x axis parameters
2711 Returns current values of the p_digmax and p_digits flags
for the x
2712 axis. p_digits
is updated after the plot
is drawn, so this routine
2713 should only be called after the call to plbox (
or plbox3)
is complete.
2714 See the PLplot documentation
for more information.
2716 Redacted form:
plgxax(p_digmax, p_digits)
2718 This function
is used
in example 31.
2724 plgxax(p_digmax, p_digits)
2728 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2729 number of digits
for the x axis. If nonzero, the printed label
2730 has been switched to a floating-point representation when the
2731 number of digits exceeds this value.
2733 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2734 number of digits
for the numeric labels (x axis)
from the last
2738 return _plplotc.plgxax()
2742 Get y axis parameters
2746 Identical to plgxax, except that arguments are flags
for y axis. See
2747 the description of plgxax
for more detail.
2749 Redacted form:
plgyax(p_digmax, p_digits)
2751 This function
is used
in example 31.
2757 plgyax(p_digmax, p_digits)
2761 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2762 number of digits
for the y axis. If nonzero, the printed label
2763 has been switched to a floating-point representation when the
2764 number of digits exceeds this value.
2766 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2767 number of digits
for the numeric labels (y axis)
from the last
2771 return _plplotc.plgyax()
2775 Get z axis parameters
2779 Identical to plgxax, except that arguments are flags
for z axis. See
2780 the description of plgxax
for more detail.
2782 Redacted form:
plgzax(p_digmax, p_digits)
2784 This function
is used
in example 31.
2790 plgzax(p_digmax, p_digits)
2794 p_digmax (PLINT_NC_SCALAR, output) : Returned value of the maximum
2795 number of digits
for the z axis. If nonzero, the printed label
2796 has been switched to a floating-point representation when the
2797 number of digits exceeds this value.
2799 p_digits (PLINT_NC_SCALAR, output) : Returned value of the actual
2800 number of digits
for the numeric labels (z axis)
from the last
2804 return _plplotc.plgzax()
2808 Plot a histogram from unbinned data
2812 Plots a histogram
from n data points stored
in the data vector. This
2813 routine bins the data into nbin bins equally spaced between datmin
and
2814 datmax,
and calls plbin to draw the resulting histogram. Parameter
2815 opt allows, among other things, the histogram either to be plotted
in
2816 an existing window
or causes plhist to call plenv
with suitable limits
2817 before plotting the histogram.
2819 Redacted form:
plhist(data, datmin, datmax, nbin, opt)
2821 This function
is used
in example 5.
2827 plhist(n, data, datmin, datmax, nbin, opt)
2831 n (PLINT, input) : Number of data points.
2833 data (PLFLT_VECTOR, input) : A vector containing the values of the
2836 datmin (PLFLT, input) : Left-hand edge of lowest-valued bin.
2838 datmax (PLFLT, input) : Right-hand edge of highest-valued bin.
2840 nbin (PLINT, input) : Number of (equal-sized) bins into which to
2841 divide the interval xmin to xmax.
2843 opt (PLINT, input) : Is a combination of several flags:
2844 opt=PL_HIST_DEFAULT: The axes are automatically rescaled to fit
2845 the histogram data, the outer bins are expanded to fill up the
2846 entire x-axis, data outside the given extremes are assigned to the
2847 outer bins
and bins of zero height are simply drawn.
2848 opt=PL_HIST_NOSCALING|...: The existing axes are
not rescaled
2849 to fit the histogram data, without this flag, plenv
is called
2850 to set the world coordinates.
2851 opt=PL_HIST_IGNORE_OUTLIERS|...: Data outside the given
2852 extremes are
not taken into account. This option should
2853 probably be combined
with opt=PL_HIST_NOEXPAND|..., so
as to
2854 properly present the data.
2855 opt=PL_HIST_NOEXPAND|...: The outer bins are drawn
with equal
2856 size
as the ones inside.
2857 opt=PL_HIST_NOEMPTY|...: Bins
with zero height are
not drawn
2858 (there
is a gap
for such bins).
2861 return _plplotc.plhist(n, datmin, datmax, nbin, oldwin)
2865 Convert HLS color to RGB
2869 Convert HLS color coordinates to RGB.
2871 Redacted form: General: plhlsrgb(h, l, s, p_r, p_g, p_b)
2874 This function is used
in example 2.
2884 h (PLFLT, input) : Hue
in degrees (0.0-360.0) on the color
2887 l (PLFLT, input) : Lightness expressed
as a fraction (0.0-1.0) of
2888 the axis of the color cylinder.
2890 s (PLFLT, input) : Saturation expressed
as a fraction (0.0-1.0) of
2891 the radius of the color cylinder.
2893 p_r (PLFLT_NC_SCALAR, output) : Returned value of the red intensity
2894 (0.0-1.0) of the color.
2896 p_g (PLFLT_NC_SCALAR, output) : Returned value of the green
2897 intensity (0.0-1.0) of the color.
2899 p_b (PLFLT_NC_SCALAR, output) : Returned value of the blue
2900 intensity (0.0-1.0) of the color.
2903 return _plplotc.plhlsrgb(h, l, s)
2911 Initializing the plotting package. The program prompts for the device
2912 keyword
or number of the desired output device. Hitting a RETURN
in
2913 response to the prompt
is the same
as selecting the first device.
2914 plinit will issue no prompt
if either the device was specified
2915 previously (via command line flag, the plsetopt function,
or the
2916 plsdev function),
or if only one device
is enabled when PLplot
is
2917 installed. If subpages have been specified, the output device
is
2918 divided into nx by ny subpages, each of which may be used
2919 independently. If plinit
is called again during a program, the
2920 previously opened file will be closed. The subroutine pladv
is used
2921 to advance
from one subpage to the next.
2925 This function
is used
in all of the examples.
2934 return _plplotc.plinit()
2938 Draw a line between two points
2948 Redacted form: pljoin(x1,y1,x2,y2)
2950 This function is used
in examples 3
and 14.
2960 x1 (PLFLT, input) : x coordinate of first point.
2962 y1 (PLFLT, input) : y coordinate of first point.
2964 x2 (PLFLT, input) : x coordinate of second point.
2966 y2 (PLFLT, input) : y coordinate of second point.
2969 return _plplotc.pljoin(x1, y1, x2, y2)
2973 Simple routine to write labels
2977 Routine for writing simple labels. Use plmtex
for more complex labels.
2979 Redacted form:
pllab(xlabel, ylabel, tlabel)
2981 This function
is used
in examples 1, 5, 9, 12, 14-16, 20-22,
and 29.
2987 pllab(xlabel, ylabel, tlabel)
2991 xlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2992 the label
for the x axis.
2994 ylabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2995 the label
for the y axis.
2997 tlabel (PLCHAR_VECTOR, input) : A UTF-8 character string specifying
2998 the title of the plot.
3001 return _plplotc.pllab(xlabel, ylabel, tlabel)
3003def pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28):
3005 Plot legend using discretely annotated filled boxes, lines, and/
or lines of symbols
3009 Routine
for creating a discrete plot legend
with a plotted filled box,
3010 line,
and/
or line of symbols
for each annotated legend entry. (See
3011 plcolorbar
for similar functionality
for creating continuous color
3012 bars.) The arguments of pllegend provide control over the location
3013 and size of the legend
as well
as the location
and characteristics of
3014 the elements (most of which are optional) within that legend. The
3015 resulting legend
is clipped at the boundaries of the current subpage.
3016 (N.B. the adopted coordinate system used
for some of the parameters
is
3017 defined
in the documentation of the position parameter.)
3019 Redacted form:
pllegend(p_legend_width, p_legend_height, opt,
3020 position, x, y, plot_width, bg_color, bb_color, bb_style, nrow,
3021 ncolumn, opt_array, text_offset, text_scale, text_spacing,
3022 test_justification, text_colors, text, box_colors, box_patterns,
3023 box_scales, box_line_widths, line_colors, line_styles, line_widths,
3024 symbol_colors, symbol_scales, symbol_numbers, symbols)
3026 This function
is used
in examples 4, 26,
and 33.
3032 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)
3036 p_legend_width (PLFLT_NC_SCALAR, output) : Returned value of the
3037 legend width
in adopted coordinates. This quantity
is calculated
3038 from plot_width, text_offset, ncolumn (possibly modified inside
3039 the routine depending on nlegend
and nrow),
and the length
3040 (calculated internally) of the longest text string.
3042 p_legend_height (PLFLT_NC_SCALAR, output) : Returned value of the
3043 legend height
in adopted coordinates. This quantity
is calculated
3044 from text_scale, text_spacing,
and nrow (possibly modified inside
3045 the routine depending on nlegend
and nrow).
3047 opt (PLINT, input) : opt contains bits controlling the overall
3048 legend. If the PL_LEGEND_TEXT_LEFT bit
is set, put the text area
3049 on the left of the legend
and the plotted area on the right.
3050 Otherwise, put the text area on the right of the legend
and the
3051 plotted area on the left. If the PL_LEGEND_BACKGROUND bit
is set,
3052 plot a (semitransparent) background
for the legend. If the
3053 PL_LEGEND_BOUNDING_BOX bit
is set, plot a bounding box
for the
3054 legend. If the PL_LEGEND_ROW_MAJOR bit
is set
and (both of the
3055 possibly internally transformed) nrow > 1
and ncolumn > 1, then
3056 plot the resulting array of legend entries
in row-major order.
3057 Otherwise, plot the legend entries
in column-major order.
3059 position (PLINT, input) : position contains bits which control the
3060 overall position of the legend
and the definition of the adopted
3061 coordinates used
for positions just like what
is done
for the
3062 position argument
for plcolorbar. However, note that the defaults
3063 for the position bits (see below) are different than the
3064 plcolorbar case. The combination of the PL_POSITION_LEFT,
3065 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3066 PL_POSITION_INSIDE,
and PL_POSITION_OUTSIDE bits specifies one of
3067 the 16 possible standard positions (the 4 corners
and centers of
3068 the 4 sides
for both the inside
and outside cases) of the legend
3069 relative to the adopted coordinate system. The corner positions
3070 are specified by the appropriate combination of two of the
3071 PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP,
and
3072 PL_POSITION_BOTTOM bits
while the sides are specified by a single
3073 value of one of those bits. The adopted coordinates are
3074 normalized viewport coordinates
if the PL_POSITION_VIEWPORT bit
is
3075 set
or normalized subpage coordinates
if the PL_POSITION_SUBPAGE
3076 bit
is set. Default position bits: If none of PL_POSITION_LEFT,
3077 PL_POSITION_RIGHT, PL_POSITION_TOP,
or PL_POSITION_BOTTOM are set,
3078 then use the combination of PL_POSITION_RIGHT
and PL_POSITION_TOP.
3079 If neither of PL_POSITION_INSIDE
or PL_POSITION_OUTSIDE
is set,
3080 use PL_POSITION_INSIDE. If neither of PL_POSITION_VIEWPORT
or
3081 PL_POSITION_SUBPAGE
is set, use PL_POSITION_VIEWPORT.
3083 x (PLFLT, input) : X offset of the legend position
in adopted
3084 coordinates
from the specified standard position of the legend.
3085 For positive x, the direction of motion away
from the standard
3086 position
is inward/outward
from the standard corner positions
or
3087 standard left
or right positions
if the
3088 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit
is set
in position.
3089 For the standard top
or bottom positions, the direction of motion
3090 is toward positive X.
3092 y (PLFLT, input) : Y offset of the legend position
in adopted
3093 coordinates
from the specified standard position of the legend.
3094 For positive y, the direction of motion away
from the standard
3095 position
is inward/outward
from the standard corner positions
or
3096 standard top
or bottom positions
if the
3097 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit
is set
in position. For
3098 the standard left
or right positions, the direction of motion
is
3101 plot_width (PLFLT, input) : Horizontal width
in adopted coordinates
3102 of the plot area (where the colored boxes, lines,
and/
or lines of
3103 symbols are drawn) of the legend.
3105 bg_color (PLINT, input) : The cmap0 color of the background
for the
3106 legend (PL_LEGEND_BACKGROUND).
3108 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3109 for the legend (PL_LEGEND_BOUNDING_BOX).
3111 bb_style (PLINT, input) : The pllsty style number
for the
3112 bounding-box line
for the legend (PL_LEGEND_BACKGROUND).
3114 nrow (PLINT, input) : The number of rows
in the matrix used to
3116 nlegend legend entries. For internal transformations of
3117 nrow, see further remarks under
3120 ncolumn (PLINT, input) : The number of columns
in the matrix used
3122 nlegend legend entries. For internal transformations of
3123 ncolumn, see further remarks under
3126 nlegend (PLINT, input) : Number of legend entries. The above
3128 ncolumn values are transformed internally to be consistent
with
3131 ncolumn
is non-positive it
is replaced by 1. If the resulting product
3134 ncolumn
is less than
3135 nlegend, the smaller of the two (
or
3138 ncolumn)
is increased so the product
is >=
3139 nlegend. Thus,
for example, the common
3141 ncolumn = 0 case
is transformed internally to
3144 ncolumn = 1; i.e., the usual case of a legend rendered
as a single
3147 opt_array (PLINT_VECTOR, input) : A vector of
3148 nlegend values of options to control each individual plotted area
3149 corresponding to a legend entry. If the
3150 PL_LEGEND_NONE bit
is set, then nothing
is plotted
in the plotted
3152 PL_LEGEND_COLOR_BOX,
3153 PL_LEGEND_LINE,
and/
or
3154 PL_LEGEND_SYMBOL bits are set, the area corresponding to a legend
3155 entry
is plotted
with a colored box; a line;
and/
or a line of
3158 text_offset (PLFLT, input) : Offset of the text area
from the plot
3159 area
in units of character width.
3161 text_scale (PLFLT, input) : Character height scale
for text
3164 text_spacing (PLFLT, input) : Vertical spacing
in units of the
3165 character height
from one legend entry to the next.
3167 text_justification (PLFLT, input) : Justification parameter used
3168 for text justification. The most common values of
3169 text_justification are 0., 0.5,
or 1. corresponding to a text that
3170 is left justified, centred,
or right justified within the text
3171 area, but other values are allowed
as well.
3173 text_colors (PLINT_VECTOR, input) : A vector containing
3174 nlegend cmap0 text colors.
3176 text (PLCHAR_MATRIX, input) : A vector of
3177 nlegend UTF-8 character strings containing the legend annotations.
3179 box_colors (PLINT_VECTOR, input) : A vector containing
3180 nlegend cmap0 colors
for the discrete colored boxes (
3181 PL_LEGEND_COLOR_BOX).
3183 box_patterns (PLINT_VECTOR, input) : A vector containing
3184 nlegend patterns (plpsty indices)
for the discrete colored boxes (
3185 PL_LEGEND_COLOR_BOX).
3187 box_scales (PLFLT_VECTOR, input) : A vector containing
3188 nlegend scales (units of fraction of character height)
for the height
3189 of the discrete colored boxes (
3190 PL_LEGEND_COLOR_BOX).
3192 box_line_widths (PLFLT_VECTOR, input) : A vector containing
3193 nlegend line widths
for the patterns specified by box_patterns (
3194 PL_LEGEND_COLOR_BOX).
3196 line_colors (PLINT_VECTOR, input) : A vector containing
3197 nlegend cmap0 line colors (
3200 line_styles (PLINT_VECTOR, input) : A vector containing
3201 nlegend line styles (plsty indices) (
3204 line_widths (PLFLT_VECTOR, input) : A vector containing
3205 nlegend line widths (
3208 symbol_colors (PLINT_VECTOR, input) : A vector containing
3209 nlegend cmap0 symbol colors (
3212 symbol_scales (PLFLT_VECTOR, input) : A vector containing
3213 nlegend scale values
for the symbol height (
3216 symbol_numbers (PLINT_VECTOR, input) : A vector containing
3217 nlegend numbers of symbols to be drawn across the width of the plotted
3221 symbols (PLCHAR_MATRIX, input) : A vector of
3222 nlegend UTF-8 character strings containing the legend symbols. (
3226 return _plplotc.pllegend(opt, position, x, y, plot_width, bg_color, bb_color, bb_style, nrow, ncolumn, n, text_offset, text_scale, text_spacing, text_justification, arg16, arg17, arg18, arg19, arg20, arg21, arg22, arg23, arg24, arg25, arg26, arg27, arg28)
3228def plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk):
3230 Plot color bar for image, shade
or gradient plots
3234 Routine
for creating a continuous color bar
for image, shade,
or
3235 gradient plots. (See pllegend
for similar functionality
for creating
3236 legends
with discrete elements). The arguments of plcolorbar provide
3237 control over the location
and size of the color bar
as well
as the
3238 location
and characteristics of the elements (most of which are
3239 optional) within that color bar. The resulting color bar
is clipped
3240 at the boundaries of the current subpage. (N.B. the adopted coordinate
3241 system used
for some of the parameters
is defined
in the documentation
3242 of the position parameter.)
3244 Redacted form:
plcolorbar(p_colorbar_width, p_colorbar_height, opt,
3245 position, x, y, x_length, y_length, bg_color, bb_color, bb_style,
3246 low_cap_color, high_cap_color, cont_color, cont_width, label_opts,
3247 labels, axis_opts, ticks, sub_ticks, values)
3249 This function
is used
in examples 16
and 33.
3255 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)
3259 p_colorbar_width (PLFLT_NC_SCALAR, output) : Returned value of the
3260 labelled
and decorated color bar width
in adopted coordinates.
3262 p_colorbar_height (PLFLT_NC_SCALAR, output) : Returned value of the
3263 labelled
and decorated color bar height
in adopted coordinates.
3265 opt (PLINT, input) : opt contains bits controlling the overall
3266 color bar. The orientation (direction of the maximum value) of
3267 the color bar
is specified
with PL_ORIENT_RIGHT, PL_ORIENT_TOP,
3268 PL_ORIENT_LEFT,
or PL_ORIENT_BOTTOM. If none of these bits are
3269 specified, the default orientation
is toward the top
if the
3270 colorbar
is placed on the left
or right of the viewport
or toward
3271 the right
if the colorbar
is placed on the top
or bottom of the
3272 viewport. If the PL_COLORBAR_BACKGROUND bit
is set, plot a
3273 (semitransparent) background
for the color bar. If the
3274 PL_COLORBAR_BOUNDING_BOX bit
is set, plot a bounding box
for the
3275 color bar. The type of color bar must be specified
with one of
3276 PL_COLORBAR_IMAGE, PL_COLORBAR_SHADE,
or PL_COLORBAR_GRADIENT. If
3277 more than one of those bits
is set only the first one
in the above
3278 list
is honored. The position of the (optional) label/title can be
3279 specified
with PL_LABEL_RIGHT, PL_LABEL_TOP, PL_LABEL_LEFT,
or
3280 PL_LABEL_BOTTOM. If no label position bit
is set then no label
3281 will be drawn. If more than one of this list of bits
is specified,
3282 only the first one on the list
is honored. End-caps
for the color
3283 bar can added
with PL_COLORBAR_CAP_LOW
and PL_COLORBAR_CAP_HIGH.
3284 If a particular color bar cap option
is not specified then no cap
3285 will be drawn
for that end. As a special case
for
3286 PL_COLORBAR_SHADE, the option PL_COLORBAR_SHADE_LABEL can be
3287 specified. If this option
is provided then any tick marks
and tick
3288 labels will be placed at the breaks between shaded segments. TODO:
3289 This should be expanded to support custom placement of tick marks
3290 and tick labels at custom value locations
for any color bar type.
3292 position (PLINT, input) : position contains bits which control the
3293 overall position of the color bar
and the definition of the
3294 adopted coordinates used
for positions just like what
is done
for
3295 the position argument
for pllegend. However, note that the
3296 defaults
for the position bits (see below) are different than the
3297 pllegend case. The combination of the PL_POSITION_LEFT,
3298 PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
3299 PL_POSITION_INSIDE,
and PL_POSITION_OUTSIDE bits specifies one of
3300 the 16 possible standard positions (the 4 corners
and centers of
3301 the 4 sides
for both the inside
and outside cases) of the color
3302 bar relative to the adopted coordinate system. The corner
3303 positions are specified by the appropriate combination of two of
3304 the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP,
and
3305 PL_POSITION_BOTTOM bits
while the sides are specified by a single
3306 value of one of those bits. The adopted coordinates are
3307 normalized viewport coordinates
if the PL_POSITION_VIEWPORT bit
is
3308 set
or normalized subpage coordinates
if the PL_POSITION_SUBPAGE
3309 bit
is set. Default position bits: If none of PL_POSITION_LEFT,
3310 PL_POSITION_RIGHT, PL_POSITION_TOP,
or PL_POSITION_BOTTOM are set,
3311 then use PL_POSITION_RIGHT. If neither of PL_POSITION_INSIDE
or
3312 PL_POSITION_OUTSIDE
is set, use PL_POSITION_OUTSIDE. If neither of
3313 PL_POSITION_VIEWPORT
or PL_POSITION_SUBPAGE
is set, use
3314 PL_POSITION_VIEWPORT.
3316 x (PLFLT, input) : X offset of the color bar position
in adopted
3317 coordinates
from the specified standard position of the color bar.
3318 For positive x, the direction of motion away
from the standard
3319 position
is inward/outward
from the standard corner positions
or
3320 standard left
or right positions
if the
3321 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit
is set
in position.
3322 For the standard top
or bottom positions, the direction of motion
3323 is toward positive X.
3325 y (PLFLT, input) : Y offset of the color bar position
in adopted
3326 coordinates
from the specified standard position of the color bar.
3327 For positive y, the direction of motion away
from the standard
3328 position
is inward/outward
from the standard corner positions
or
3329 standard top
or bottom positions
if the
3330 PL_POSITION_INSIDE/PL_POSITION_OUTSIDE bit
is set
in position.
3331 For the standard left
or right positions, the direction of motion
3332 is toward positive Y.
3334 x_length (PLFLT, input) : Length of the body of the color bar
in
3335 the X direction
in adopted coordinates.
3337 y_length (PLFLT, input) : Length of the body of the color bar
in
3338 the Y direction
in adopted coordinates.
3340 bg_color (PLINT, input) : The cmap0 color of the background
for the
3341 color bar (PL_COLORBAR_BACKGROUND).
3343 bb_color (PLINT, input) : The cmap0 color of the bounding-box line
3344 for the color bar (PL_COLORBAR_BOUNDING_BOX).
3346 bb_style (PLINT, input) : The pllsty style number
for the
3347 bounding-box line
for the color bar (PL_COLORBAR_BACKGROUND).
3349 low_cap_color (PLFLT, input) : The cmap1 color of the low-end color
3350 bar cap,
if it
is drawn (PL_COLORBAR_CAP_LOW).
3352 high_cap_color (PLFLT, input) : The cmap1 color of the high-end
3353 color bar cap,
if it
is drawn (PL_COLORBAR_CAP_HIGH).
3355 cont_color (PLINT, input) : The cmap0 contour color
for
3356 PL_COLORBAR_SHADE plots. This
is passed directly to plshades, so
3357 it will be interpreted according to the design of plshades.
3359 cont_width (PLFLT, input) : Contour width
for PL_COLORBAR_SHADE
3360 plots. This
is passed directly to plshades, so it will be
3361 interpreted according to the design of plshades.
3363 n_labels (PLINT, input) : Number of labels to place around the
3366 label_opts (PLINT_VECTOR, input) : A vector of options
for each of
3369 labels (PLCHAR_MATRIX, input) : A vector of
3370 n_labels UTF-8 character strings containing the labels
for the color
3371 bar. Ignored
if no label position
is specified
with one of the
3372 PL_COLORBAR_LABEL_RIGHT, PL_COLORBAR_LABEL_TOP,
3373 PL_COLORBAR_LABEL_LEFT,
or PL_COLORBAR_LABEL_BOTTOM bits
in the
3374 corresponding label_opts field.
3376 n_axes (PLINT, input) : Number of axis definitions provided. This
3377 value must be greater than 0. It
is typically 1 (numerical axis
3378 labels are provided
for one of the long edges of the color bar),
3379 but it can be larger
if multiple numerical axis labels
for the
3380 long edges of the color bar are desired.
3382 axis_opts (PLCHAR_MATRIX, input) : A vector of
3383 n_axes ascii character strings containing options (interpreted
as for
3384 plbox)
for the color bar
's axis definitions.
3386 ticks (PLFLT_VECTOR, input) : A vector of n_axes values of the
3387 spacing of the major tick marks (interpreted as for plbox)
for the
3388 color bar
's axis definitions.
3390 sub_ticks (PLINT_VECTOR, input) : A vector of n_axes values of the
3391 number of subticks (interpreted as for plbox)
for the color bar
's
3394 n_values (PLINT_VECTOR, input) : A vector containing the number of
3395 elements in each of the n_axes rows of the values matrix.
3397 values (PLFLT_MATRIX, input) : A matrix containing the numeric
3398 values
for the data range represented by the color bar. For a row
3399 index of i_axis (where 0 < i_axis < n_axes), the number of
3400 elements
in the row
is specified by n_values[i_axis]. For
3401 PL_COLORBAR_IMAGE
and PL_COLORBAR_GRADIENT the number of elements
3402 is 2,
and the corresponding row elements of the values matrix are
3403 the minimum
and maximum value represented by the colorbar. For
3404 PL_COLORBAR_SHADE, the number
and values of the elements of a row
3405 of the values matrix
is interpreted the same
as the nlevel
and
3406 clevel arguments of plshades.
3409 return _plplotc.plcolorbar(opt, position, x, y, x_length, y_length, bg_color, bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, arg14, arg15, arg16, arg17, arg18, ArrayN, MatrixCk)
3413 Sets the 3D position of the light source
3417 Sets the 3D position of the light source for use
with plsurf3d
and
3422 This function
is used
in example 8.
3432 x (PLFLT, input) : X-coordinate of the light source.
3434 y (PLFLT, input) : Y-coordinate of the light source.
3436 z (PLFLT, input) : Z-coordinate of the light source.
3439 return _plplotc.pllightsource(x, y, z)
3447 Draws line defined by n points in x
and y.
3449 Redacted form:
plline(x, y)
3451 This function
is used
in examples 1, 3, 4, 9, 12-14, 16, 18, 20, 22,
3462 n (PLINT, input) : Number of points defining line.
3464 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3467 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3471 return _plplotc.plline(n, ArrayCk)
3475 Draw a line in 3 space
3479 Draws line
in 3 space defined by n points
in x, y,
and z. You must
3480 first set up the viewport, the 2d viewing window (
in world
3481 coordinates),
and the 3d normalized coordinate box. See x18c.c
for
3484 Redacted form:
plline3(x, y, z)
3486 This function
is used
in example 18.
3496 n (PLINT, input) : Number of points defining line.
3498 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
3501 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
3504 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
3508 return _plplotc.plline3(n, arg2, arg3)
3516 This sets the line style according to one of eight predefined patterns
3519 Redacted form: pllsty(lin)
3521 This function is used
in examples 9, 12, 22,
and 25.
3531 lin (PLINT, input) : Integer value between 1
and 8. Line style 1
is
3532 a continuous line, line style 2
is a line
with short dashes
and
3533 gaps, line style 3
is a line
with long dashes
and gaps, line style
3534 4 has long dashes
and short gaps
and so on.
3537 return _plplotc.pllsty(lin)
3545 Plots a surface mesh within the environment set up by plw3d. The
3546 surface is defined by the matrix z[
3548 ny] , the point z[i][j] being the value of the function at (
3550 y[j]). Note that the points
in vectors x
and y do
not need to be
3551 equally spaced, but must be stored
in ascending order. The parameter
3552 opt controls the way
in which the surface
is displayed. For further
3553 details see the PLplot documentation.
3555 Redacted form:
plmesh(x, y, z, opt)
3557 This function
is used
in example 11.
3563 plmesh(x, y, z, nx, ny, opt)
3567 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3568 which the function
is evaluated.
3570 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3571 which the function
is evaluated.
3573 z (PLFLT_MATRIX, input) : A matrix containing function values to
3574 plot. Should have dimensions of
3578 nx (PLINT, input) : Number of x values at which function has been
3581 ny (PLINT, input) : Number of y values at which function has been
3584 opt (PLINT, input) : Determines the way
in which the surface
is
3585 represented: opt=DRAW_LINEX : Lines are drawn showing z
as a
3586 function of x
for each value of y[j] .
3587 opt=DRAW_LINEY : Lines are drawn showing z
as a function of y
3588 for each value of x[i] .
3589 opt=DRAW_LINEXY : Network of lines
is drawn connecting points
3590 at which function
is defined.
3593 return _plplotc.plmesh(ArrayX, ArrayY, MatrixCk, opt)
3597 Magnitude colored plot surface mesh with contour
3601 A more powerful form of plmesh: the surface mesh can be colored
3602 accordingly to the current z value being plotted, a contour plot can
3603 be drawn at the base XY plane,
and a curtain can be drawn between the
3604 plotted function border
and the base XY plane.
3606 Redacted form:
plmeshc(x, y, z, opt, clevel)
3608 This function
is used
in example 11.
3614 plmeshc(x, y, z, nx, ny, opt, clevel, nlevel)
3618 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3619 which the function
is evaluated.
3621 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3622 which the function
is evaluated.
3624 z (PLFLT_MATRIX, input) : A matrix containing function values to
3625 plot. Should have dimensions of
3629 nx (PLINT, input) : Number of x values at which function
is
3632 ny (PLINT, input) : Number of y values at which function
is
3635 opt (PLINT, input) : Determines the way
in which the surface
is
3636 represented. To specify more than one option just add the options,
3637 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3638 showing z
as a function of x
for each value of y[j] .
3639 opt=DRAW_LINEY : Lines are drawn showing z
as a function of y
3640 for each value of x[i] .
3641 opt=DRAW_LINEXY : Network of lines
is drawn connecting points
3642 at which function
is defined.
3643 opt=MAG_COLOR : Each line
in the mesh
is colored according to
3644 the z value being plotted. The color
is used
from the current
3646 opt=BASE_CONT : A contour plot
is drawn at the base XY plane
3650 opt=DRAW_SIDES : draws a curtain between the base XY plane
and
3651 the borders of the plotted function.
3654 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3657 nlevel (PLINT, input) : Number of elements
in the clevel vector.
3660 return _plplotc.plmeshc(ArrayX, ArrayY, MatrixCk, opt, Array)
3664 Creates a new stream and makes it the default
3668 Creates a new stream
and makes it the default. Differs
from using
3669 plsstrm,
in that a free stream number
is found,
and returned.
3670 Unfortunately, I have to start at stream 1
and work upward, since
3671 stream 0
is preallocated. One of the big flaws
in the PLplot API
is
3672 that no initial, library-opening call
is required. So stream 0 must
3673 be preallocated,
and there
is no simple way of determining whether it
3674 is already
in use
or not.
3678 This function
is used
in examples 1
and 20.
3688 p_strm (PLINT_NC_SCALAR, output) : Returned value of the stream
3689 number of the created stream.
3692 return _plplotc.plmkstrm()
3696 Write text relative to viewport boundaries
3700 Writes text at a specified position relative to the viewport
3701 boundaries. Text may be written inside or outside the viewport, but
3702 is clipped at the subpage boundaries. The reference point of a string
3703 lies along a line passing through the string at half the height of a
3704 capital letter. The position of the reference point along this line
3705 is determined by just,
and the position of the reference point
3706 relative to the viewport
is set by disp
and pos.
3708 Redacted form: General:
plmtex(side, disp, pos, just, text)
3711 This function
is used
in examples 3, 4, 6-8, 11, 12, 14, 18, 23,
and
3718 plmtex(side, disp, pos, just, text)
3722 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3723 the side of the viewport along which the text
is to be written.
3724 The string must be one of: b: Bottom of viewport, text written
3726 bv: Bottom of viewport, text written at right angles to edge.
3727 l: Left of viewport, text written parallel to edge.
3728 lv: Left of viewport, text written at right angles to edge.
3729 r: Right of viewport, text written parallel to edge.
3730 rv: Right of viewport, text written at right angles to edge.
3731 t: Top of viewport, text written parallel to edge.
3732 tv: Top of viewport, text written at right angles to edge.
3735 disp (PLFLT, input) : Position of the reference point of string,
3736 measured outwards
from the specified viewport edge
in units of the
3737 current character height. Use negative disp to write within the
3740 pos (PLFLT, input) : Position of the reference point of string
3741 along the specified edge, expressed
as a fraction of the length of
3744 just (PLFLT, input) : Specifies the position of the string relative
3745 to its reference point. If just=0. , the reference point
is at
3746 the left
and if just=1. , it
is at the right of the string. Other
3747 values of just give intermediate justifications.
3749 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3753 return _plplotc.plmtex(side, disp, pos, just, text)
3757 Write text relative to viewport boundaries in 3D plots
3761 Writes text at a specified position relative to the viewport
3762 boundaries. Text may be written inside
or outside the viewport, but
3763 is clipped at the subpage boundaries. The reference point of a string
3764 lies along a line passing through the string at half the height of a
3765 capital letter. The position of the reference point along this line
3766 is determined by just,
and the position of the reference point
3767 relative to the viewport
is set by disp
and pos.
3769 Redacted form:
plmtex3(side, disp, pos, just, text)
3771 This function
is used
in example 28.
3777 plmtex3(side, disp, pos, just, text)
3781 side (PLCHAR_VECTOR, input) : An ascii character string specifying
3782 the side of the viewport along which the text
is to be written.
3783 The string should contain one
or more of the following characters:
3784 [xyz][ps][v]. Only one label
is drawn at a time, i.e. xyp will
3785 only label the X axis,
not both the X
and Y axes. x: Label the X
3787 y: Label the Y axis.
3788 z: Label the Z axis.
3789 p: Label the primary axis. For Z this
is the leftmost Z axis.
3790 For X it
is the axis that starts at y-min. For Y it
is the
3791 axis that starts at x-min.
3792 s: Label the secondary axis.
3793 v: Draw the text perpendicular to the axis.
3796 disp (PLFLT, input) : Position of the reference point of string,
3797 measured outwards
from the specified viewport edge
in units of the
3798 current character height. Use negative disp to write within the
3801 pos (PLFLT, input) : Position of the reference point of string
3802 along the specified edge, expressed
as a fraction of the length of
3805 just (PLFLT, input) : Specifies the position of the string relative
3806 to its reference point. If just=0. , the reference point
is at
3807 the left
and if just=1. , it
is at the right of the string. Other
3808 values of just give intermediate justifications.
3810 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
3814 return _plplotc.plmtex3(side, disp, pos, just, text)
3816def plot3d(ArrayX, ArrayY, MatrixCk, opt, side):
3818 Plot 3-d surface plot
3822 Plots a three-dimensional surface plot within the environment set up
3823 by plw3d. The surface is defined by the matrix z[
3825 ny] , the point z[i][j] being the value of the function at (
3827 y[j]). Note that the points
in vectors x
and y do
not need to be
3828 equally spaced, but must be stored
in ascending order. The parameter
3829 opt controls the way
in which the surface
is displayed. For further
3830 details see the PLplot documentation. The only difference between
3831 plmesh
and plot3d
is that plmesh draws the bottom side of the surface,
3832 while plot3d only draws the surface
as viewed
from the top.
3834 Redacted form:
plot3d(x, y, z, opt, side)
3836 This function
is used
in examples 11
and 21.
3842 plot3d(x, y, z, nx, ny, opt, side)
3846 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3847 which the function
is evaluated.
3849 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3850 which the function
is evaluated.
3852 z (PLFLT_MATRIX, input) : A matrix containing function values to
3853 plot. Should have dimensions of
3857 nx (PLINT, input) : Number of x values at which function
is
3860 ny (PLINT, input) : Number of y values at which function
is
3863 opt (PLINT, input) : Determines the way
in which the surface
is
3864 represented: opt=DRAW_LINEX : Lines are drawn showing z
as a
3865 function of x
for each value of y[j] .
3866 opt=DRAW_LINEY : Lines are drawn showing z
as a function of y
3867 for each value of x[i] .
3868 opt=DRAW_LINEXY : Network of lines
is drawn connecting points
3869 at which function
is defined.
3872 side (PLBOOL, input) : Flag to indicate whether
or not ``sides
''
3873 should be draw on the figure. If side
is true sides are drawn,
3874 otherwise no sides are drawn.
3877 return _plplotc.plot3d(ArrayX, ArrayY, MatrixCk, opt, side)
3881 Magnitude colored plot surface with contour
3885 Aside
from dropping the
3886 side functionality this
is a more powerful form of plot3d: the surface
3887 mesh can be colored accordingly to the current z value being plotted,
3888 a contour plot can be drawn at the base XY plane,
and a curtain can be
3889 drawn between the plotted function border
and the base XY plane. The
3890 arguments are identical to those of plmeshc. The only difference
3891 between plmeshc
and plot3dc
is that plmeshc draws the bottom side of
3892 the surface,
while plot3dc only draws the surface
as viewed
from the
3895 Redacted form: General:
plot3dc(x, y, z, opt, clevel)
3898 This function
is used
in example 21.
3904 plot3dc(x, y, z, nx, ny, opt, clevel, nlevel)
3908 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3909 which the function
is evaluated.
3911 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3912 which the function
is evaluated.
3914 z (PLFLT_MATRIX, input) : A matrix containing function values to
3915 plot. Should have dimensions of
3919 nx (PLINT, input) : Number of x values at which function
is
3922 ny (PLINT, input) : Number of y values at which function
is
3925 opt (PLINT, input) : Determines the way
in which the surface
is
3926 represented. To specify more than one option just add the options,
3927 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
3928 showing z
as a function of x
for each value of y[j] .
3929 opt=DRAW_LINEY : Lines are drawn showing z
as a function of y
3930 for each value of x[i] .
3931 opt=DRAW_LINEXY : Network of lines
is drawn connecting points
3932 at which function
is defined.
3933 opt=MAG_COLOR : Each line
in the mesh
is colored according to
3934 the z value being plotted. The color
is used
from the current
3936 opt=BASE_CONT : A contour plot
is drawn at the base XY plane
3940 opt=DRAW_SIDES : draws a curtain between the base XY plane
and
3941 the borders of the plotted function.
3944 clevel (PLFLT_VECTOR, input) : A vector containing the contour
3947 nlevel (PLINT, input) : Number of elements
in the clevel vector.
3950 return _plplotc.plot3dc(ArrayX, ArrayY, MatrixCk, opt, Array)
3952def plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
3954 Magnitude colored plot surface with contour
for z[x][y]
with y index limits
3958 When the implementation
is completed this variant of plot3dc (see that
3959 function
's documentation for more details) should be suitable for the
3960 case where the area of the x, y coordinate grid where z is defined can
3961 be non-rectangular. The implementation
is incomplete so the last 4
3962 parameters of plot3dcl; indexxmin, indexxmax, indexymin,
and
3963 indexymax; are currently ignored
and the functionality
is otherwise
3964 identical to that of plot3dc.
3966 Redacted form: General:
plot3dcl(x, y, z, opt, clevel, indexxmin,
3967 indexymin, indexymax)
3970 This function
is not used
in any example.
3976 plot3dcl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
3980 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
3981 which the function
is evaluated.
3983 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
3984 which the function
is evaluated.
3986 z (PLFLT_MATRIX, input) : A matrix containing function values to
3987 plot. Should have dimensions of
3991 nx (PLINT, input) : Number of x values at which the function
is
3994 ny (PLINT, input) : Number of y values at which the function
is
3997 opt (PLINT, input) : Determines the way
in which the surface
is
3998 represented. To specify more than one option just add the options,
3999 e.g. DRAW_LINEXY + MAG_COLOR opt=DRAW_LINEX : Lines are drawn
4000 showing z
as a function of x
for each value of y[j] .
4001 opt=DRAW_LINEY : Lines are drawn showing z
as a function of y
4002 for each value of x[i] .
4003 opt=DRAW_LINEXY : Network of lines
is drawn connecting points
4004 at which function
is defined.
4005 opt=MAG_COLOR : Each line
in the mesh
is colored according to
4006 the z value being plotted. The color
is used
from the current
4008 opt=BASE_CONT : A contour plot
is drawn at the base XY plane
4012 opt=DRAW_SIDES : draws a curtain between the base XY plane
and
4013 the borders of the plotted function.
4016 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4019 nlevel (PLINT, input) : Number of elements
in the clevel vector.
4021 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4022 corresponds to the first x index where z
is defined.
4024 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4025 which corresponds (by convention) to one more than the last x
4026 index value where z
is defined.
4028 indexymin (PLINT_VECTOR, input) : A vector containing y index
4029 values which all must be ≥ 0. These values are the first y index
4030 where z
is defined
for a particular x index
in the range
from
4031 indexxmin to indexxmax - 1. The dimension of indexymin
is
4034 indexymax (PLINT_VECTOR, input) : A vector containing y index
4035 values which all must be ≤ ny. These values correspond (by
4036 convention) to one more than the last y index where z
is defined
4037 for a particular x index
in the range
from indexxmin to indexxmax
4038 - 1. The dimension of indexymax
is indexxmax.
4041 return _plplotc.plot3dcl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4045 Plot shaded 3-d surface plot
4049 Plots a three-dimensional shaded surface plot within the environment
4050 set up by plw3d. The surface is defined by the two-dimensional matrix
4053 ny], the point z[i][j] being the value of the function at (
4055 y[j]). Note that the points
in vectors x
and y do
not need to be
4056 equally spaced, but must be stored
in ascending order. For further
4057 details see the PLplot documentation.
4059 Redacted form:
plsurf3d(x, y, z, opt, clevel)
4061 This function
is not used
in any examples.
4067 plsurf3d(x, y, z, nx, ny, opt, clevel, nlevel)
4071 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4072 which the function
is evaluated.
4074 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4075 which the function
is evaluated.
4077 z (PLFLT_MATRIX, input) : A matrix containing function values to
4078 plot. Should have dimensions of
4082 nx (PLINT, input) : Number of x values at which function
is
4085 ny (PLINT, input) : Number of y values at which function
is
4088 opt (PLINT, input) : Determines the way
in which the surface
is
4089 represented. To specify more than one option just add the options,
4090 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines
is drawn
4091 connecting points at which function
is defined.
4092 opt=BASE_CONT : A contour plot
is drawn at the base XY plane
4096 opt=SURF_CONT : A contour plot
is drawn at the surface plane
4100 opt=DRAW_SIDES : draws a curtain between the base XY plane
and
4101 the borders of the plotted function.
4102 opt=MAG_COLOR : the surface
is colored according to the value
4103 of Z;
if MAG_COLOR
is not used, then the surface
is colored
4104 according to the intensity of the reflected light
in the
4105 surface
from a light source whose position
is set using
4109 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4112 nlevel (PLINT, input) : Number of elements
in the clevel vector.
4115 return _plplotc.plsurf3d(ArrayX, ArrayY, MatrixCk, opt, Array)
4117def plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk):
4119 Plot shaded 3-d surface plot for z[x][y]
with y index limits
4123 This variant of plsurf3d (see that function
's documentation for more
4124 details) should be suitable for the case where the area of the x, y
4125 coordinate grid where z
is defined can be non-rectangular. The limits
4126 of that grid are provided by the parameters indexxmin, indexxmax,
4127 indexymin,
and indexymax.
4129 Redacted form:
plsurf3dl(x, y, z, opt, clevel, indexxmin, indexymin,
4132 This function
is used
in example 8.
4138 plsurf3dl(x, y, z, nx, ny, opt, clevel, nlevel, indexxmin, indexxmax, indexymin, indexymax)
4142 x (PLFLT_VECTOR, input) : A vector containing the x coordinates at
4143 which the function
is evaluated.
4145 y (PLFLT_VECTOR, input) : A vector containing the y coordinates at
4146 which the function
is evaluated.
4148 z (PLFLT_MATRIX, input) : A matrix containing function values to
4149 plot. Should have dimensions of
4153 nx (PLINT, input) : Number of x values at which function
is
4156 ny (PLINT, input) : Number of y values at which function
is
4159 opt (PLINT, input) : Determines the way
in which the surface
is
4160 represented. To specify more than one option just add the options,
4161 e.g. FACETED + SURF_CONT opt=FACETED : Network of lines
is drawn
4162 connecting points at which function
is defined.
4163 opt=BASE_CONT : A contour plot
is drawn at the base XY plane
4167 opt=SURF_CONT : A contour plot
is drawn at the surface plane
4171 opt=DRAW_SIDES : draws a curtain between the base XY plane
and
4172 the borders of the plotted function.
4173 opt=MAG_COLOR : the surface
is colored according to the value
4174 of Z;
if MAG_COLOR
is not used, then the surface
is colored
4175 according to the intensity of the reflected light
in the
4176 surface
from a light source whose position
is set using
4180 clevel (PLFLT_VECTOR, input) : A vector containing the contour
4183 nlevel (PLINT, input) : Number of elements
in the clevel vector.
4185 indexxmin (PLINT, input) : The index value (which must be ≥ 0) that
4186 corresponds to the first x index where z
is defined.
4188 indexxmax (PLINT, input) : The index value (which must be ≤ nx)
4189 which corresponds (by convention) to one more than the last x
4190 index value where z
is defined.
4192 indexymin (PLINT_VECTOR, input) : A vector containing the y index
4193 values which all must be ≥ 0. These values are the first y index
4194 where z
is defined
for a particular x index
in the range
from
4195 indexxmin to indexxmax - 1. The dimension of indexymin
is
4198 indexymax (PLINT_VECTOR, input) : A vector containing the y index
4199 values which all must be ≤ ny. These values correspond (by
4200 convention) to one more than the last y index where z
is defined
4201 for a particular x index
in the range
from indexxmin to indexxmax
4202 - 1. The dimension of indexymax
is indexxmax.
4205 return _plplotc.plsurf3dl(ArrayX, ArrayY, MatrixCk, opt, arg5, ixstart, arg7, ArrayCk)
4209 Parse command-line arguments
4213 Parse command-line arguments.
4215 plparseopts removes all recognized flags (decreasing argc
4216 accordingly), so that invalid input may be readily detected. It can
4217 also be used to process user command line flags. The user can merge
4218 an option table of type PLOptionTable into the internal option table
4219 info structure using plMergeOpts. Or, the user can specify that ONLY
4220 the external table(s) be parsed by calling plClearOpts before
4223 The default action taken by plparseopts is as follows:
4224 Returns
with an error
if an unrecognized option
or badly formed
4225 option-value pair are encountered.
4226 Returns immediately (
return code 0) when the first non-option command
4227 line argument
is found.
4228 Returns
with the
return code of the option handler,
if one was called.
4230 Deletes command line arguments
from argv list
as they are found,
and
4231 decrements argc accordingly.
4232 Does
not show
"invisible" options
in usage
or help messages.
4233 Assumes the program name
is contained
in argv[0].
4235 These behaviors may be controlled through the
4241 This function
is used
in all of the examples.
4251 p_argc (int *, input/output) : Number of arguments.
4253 argv (PLCHAR_NC_MATRIX, input/output) : A vector of character
4254 strings containing *p_argc command-line arguments.
4256 mode (PLINT, input) : Parsing mode
with the following
4257 possibilities: PL_PARSE_FULL (1) -- Full parsing of command line
4258 and all error messages enabled, including program exit when an
4259 error occurs. Anything on the command line that isn
't recognized
4260 as a valid option
or option argument
is flagged
as an error.
4261 PL_PARSE_QUIET (2) -- Turns off all output
except in the case
4263 PL_PARSE_NODELETE (4) -- Turns off deletion of processed
4265 PL_PARSE_SHOWALL (8) -- Show invisible options
4266 PL_PARSE_NOPROGRAM (32) -- Specified
if argv[0]
is NOT a
4267 pointer to the program name.
4268 PL_PARSE_NODASH (64) -- Set
if leading dash
is NOT required.
4269 PL_PARSE_SKIP (128) -- Set to quietly skip over any
4270 unrecognized arguments.
4273 return _plplotc.plparseopts(p_argc, mode)
4277 Set area line fill pattern
4281 Sets the area line fill pattern to be used, e.g., for calls to plfill.
4282 The pattern consists of 1
or 2 sets of parallel lines
with specified
4283 inclinations
and spacings. The arguments to this routine are the
4284 number of sets to use (1
or 2) followed by two vectors (
with 1
or 2
4285 elements) specifying the inclinations
in tenths of a degree
and the
4286 spacing
in micrometers. (See also plpsty)
4288 Redacted form: General:
plpat(inc, del)
4291 This function
is used
in example 15.
4297 plpat(nlin, inc, del)
4301 nlin (PLINT, input) : Number of sets of lines making up the
4302 pattern, either 1
or 2.
4304 inc (PLINT_VECTOR, input) : A vector containing nlin values of the
4305 inclination
in tenths of a degree. (Should be between -900
and
4308 del (PLINT_VECTOR, input) : A vector containing nlin values of the
4309 spacing
in micrometers between the lines making up the pattern.
4312 return _plplotc.plpat(n, ArrayCk)
4316 Draw a line between two points, accounting for coordinate transforms
4324 y2) . If a
global coordinate transform
is defined then the line
is
4325 broken
in to n segments to approximate the path. If no transform
is
4326 defined then this simply acts like a call to pljoin.
4328 Redacted form:
plpath(n,x1,y1,x2,y2)
4330 This function
is used
in example 22.
4336 plpath(n, x1, y1, x2, y2)
4340 n (PLINT, input) : number of points to use to approximate the path.
4342 x1 (PLFLT, input) : x coordinate of first point.
4344 y1 (PLFLT, input) : y coordinate of first point.
4346 x2 (PLFLT, input) : x coordinate of second point.
4348 y2 (PLFLT, input) : y coordinate of second point.
4351 return _plplotc.plpath(n, x1, y1, x2, y2)
4355 Plot a glyph at the specified points
4359 Plot a glyph at the specified points. (This function is largely
4360 superseded by plstring which gives access to many[!] more glyphs.)
4361 code=-1 means
try to just draw a point. Right now it
's just a move
4362 and a draw at the same place. Not ideal, since a sufficiently
4363 intelligent output device may optimize it away,
or there may be faster
4364 ways of doing it. This
is OK
for now, though,
and offers a 4X speedup
4365 over drawing a Hershey font
"point" (which
is actually diamond shaped
4366 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4367 useful (but small subset) of Hershey symbols
is plotted. If 32 <=
4368 code <= 127 the corresponding printable ASCII character
is plotted.
4370 Redacted form:
plpoin(x, y, code)
4372 This function
is used
in examples 1, 6, 14,
and 29.
4382 n (PLINT, input) : Number of points
in the x
and y vectors.
4384 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4387 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4390 code (PLINT, input) : Hershey symbol code (
in "ascii-indexed" form
4391 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4392 each of the n points.
4395 return _plplotc.plpoin(n, ArrayCk, code)
4399 Plot a glyph at the specified 3D points
4403 Plot a glyph at the specified 3D points. (This function is largely
4404 superseded by plstring3 which gives access to many[!] more glyphs.)
4405 Set up the call to this function similar to what
is done
for plline3.
4406 code=-1 means
try to just draw a point. Right now it
's just a move
4407 and a draw at the same place. Not ideal, since a sufficiently
4408 intelligent output device may optimize it away,
or there may be faster
4409 ways of doing it. This
is OK
for now, though,
and offers a 4X speedup
4410 over drawing a Hershey font
"point" (which
is actually diamond shaped
4411 and therefore takes 4 strokes to draw). If 0 < code < 32, then a
4412 useful (but small subset) of Hershey symbols
is plotted. If 32 <=
4413 code <= 127 the corresponding printable ASCII character
is plotted.
4415 Redacted form:
plpoin3(x, y, z, code)
4417 This function
is not used
in any example.
4427 n (PLINT, input) : Number of points
in the x
and y vectors.
4429 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
4432 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
4435 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
4438 code (PLINT, input) : Hershey symbol code (
in "ascii-indexed" form
4439 with -1 <= code <= 127) corresponding to a glyph to be plotted at
4440 each of the n points.
4443 return _plplotc.plpoin3(n, arg2, arg3, code)
4447 Draw a polygon in 3 space
4451 Draws a polygon
in 3 space defined by n points
in x, y,
and z. Setup
4452 like plline3, but differs
from that function
in that plpoly3 attempts
4453 to determine
if the polygon
is viewable depending on the order of the
4454 points within the vector
and the value of ifcc. If the back of
4455 polygon
is facing the viewer, then it isn
't drawn. If this isn't what
4456 you want, then use plline3 instead.
4458 The points are assumed to be
in a plane,
and the directionality of the
4459 plane
is determined
from the first three points. Additional points do
4460 not have to lie on the plane defined by the first three, but
if they
4461 do
not, then the determination of visibility obviously can
't be 100%
4462 accurate... So if you
're 3 space polygons are too far from planar,
4463 consider breaking them into smaller polygons. 3 points define a plane
4466 Bugs: If one of the first two segments is of zero length,
or if they
4467 are co-linear, the calculation of visibility has a 50/50 chance of
4468 being correct. Avoid such situations :-). See x18c.c
for an example
4469 of this problem. (Search
for 20.1).
4471 Redacted form:
plpoly3(x, y, z, code)
4473 This function
is used
in example 18.
4479 plpoly3(n, x, y, z, draw, ifcc)
4483 n (PLINT, input) : Number of points defining line.
4485 x (PLFLT_VECTOR, input) : A vector containing
4486 n x coordinates of points.
4488 y (PLFLT_VECTOR, input) : A vector containing
4489 n y coordinates of points.
4491 z (PLFLT_VECTOR, input) : A vector containing
4492 n z coordinates of points.
4494 draw (PLBOOL_VECTOR, input) : A vector containing
4495 n-1 Boolean values which control drawing the segments of the polygon.
4496 If draw[i]
is true, then the polygon segment
from index [i] to
4497 [i+1]
is drawn, otherwise,
not.
4499 ifcc (PLBOOL, input) : If ifcc
is true the directionality of the
4500 polygon
is determined by assuming the points are laid out
in a
4501 counter-clockwise order. Otherwise, the directionality of the
4502 polygon
is determined by assuming the points are laid out
in a
4506 return _plplotc.plpoly3(n, arg2, arg3, ArrayCkMinus1, flag)
4510 Set precision in numeric labels
4514 Sets the number of places after the decimal point
in numeric labels.
4516 Redacted form:
plprec(setp, prec)
4518 This function
is used
in example 29.
4528 setp (PLINT, input) : If setp
is equal to 0 then PLplot
4529 automatically determines the number of places to use after the
4530 decimal point
in numeric labels (like those used to label axes).
4531 If setp
is 1 then prec sets the number of places.
4533 prec (PLINT, input) : The number of characters to draw after the
4534 decimal point
in numeric labels.
4537 return _plplotc.plprec(setp, prec)
4541 Select area fill pattern
4546 patt is zero
or less use either a hardware solid fill
if the drivers
4547 have that capability (virtually all do)
or fall back to a software
4548 emulation of a solid fill using the eighth area line fill pattern. If
4550 patt <= 8, then select one of eight predefined area line fill patterns
4551 to use (see plpat
if you desire other patterns).
4553 Redacted form:
plpsty(patt)
4555 This function
is used
in examples 12, 13, 15, 16,
and 25.
4565 patt (PLINT, input) : The desired pattern index. If
4566 patt
is zero
or less, then a solid fill
is (normally, see qualifiers
4568 patt
in the range
from 1 to 8
and assuming the driver has
not supplied
4569 line fill capability itself (most deliberately do
not so that line
4570 fill patterns look identical
for those drivers), the patterns
4571 consist of (1) horizontal lines, (2) vertical lines, (3) lines at
4572 45 degrees, (4) lines at -45 degrees, (5) lines at 30 degrees, (6)
4573 lines at -30 degrees, (7) both vertical
and horizontal lines,
and
4574 (8) lines at both 45 degrees
and -45 degrees.
4577 return _plplotc.plpsty(patt)
4581 Write text inside the viewport
4585 Writes text at a specified position and inclination within the
4586 viewport. Text
is clipped at the viewport boundaries. The reference
4587 point of a string lies along a line passing through the string at half
4588 the height of a capital letter. The position of the reference point
4589 along this line
is determined by just, the reference point
is placed
4590 at world coordinates (
4592 y) within the viewport. The inclination of the string
is specified
4593 in terms of differences of world coordinates making it easy to write
4594 text parallel to a line
in a graph.
4596 Redacted form:
plptex(x, y, dx, dy, just, text)
4598 This function
is used
in example 2-4,10,12-14,20,23,24,26.
4604 plptex(x, y, dx, dy, just, text)
4608 x (PLFLT, input) : x coordinate of reference point of string.
4610 y (PLFLT, input) : y coordinate of reference point of string.
4612 dx (PLFLT, input) : Together
with dy, this specifies the
4613 inclination of the string. The baseline of the string
is parallel
4622 dy (PLFLT, input) : Together
with dx, this specifies the
4623 inclination of the string.
4625 just (PLFLT, input) : Specifies the position of the string relative
4626 to its reference point. If just=0. , the reference point
is at
4627 the left
and if just=1. , it
is at the right of the string. Other
4628 values of just give intermediate justifications.
4630 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4634 return _plplotc.plptex(x, y, dx, dy, just, text)
4636def plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text):
4638 Write text inside the viewport of a 3D plot
4642 Writes text at a specified position and inclination
and with a
4643 specified shear within the viewport. Text
is clipped at the viewport
4644 boundaries. The reference point of a string lies along a line passing
4645 through the string at half the height of a capital letter. The
4646 position of the reference point along this line
is determined by just,
4647 and the reference point
is placed at world coordinates (
4650 wz) within the viewport. The inclination
and shear of the string
is
4651 specified
in terms of differences of world coordinates making it easy
4652 to write text parallel to a line
in a graph.
4654 Redacted form:
plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4656 This function
is used
in example 28.
4662 plptex3(wx, wy, wz, dx, dy, dz, sx, sy, sz, just, text)
4666 wx (PLFLT, input) : x world coordinate of reference point of
4669 wy (PLFLT, input) : y world coordinate of reference point of
4672 wz (PLFLT, input) : z world coordinate of reference point of
4675 dx (PLFLT, input) : Together
with dy
and
4676 dz , this specifies the inclination of the string. The baseline of
4677 the string
is parallel to a line joining (
4688 dy (PLFLT, input) : Together
with dx
and
4689 dz, this specifies the inclination of the string.
4691 dz (PLFLT, input) : Together
with dx
and
4692 dy, this specifies the inclination of the string.
4694 sx (PLFLT, input) : Together
with sy
and
4695 sz , this specifies the shear of the string. The string
is sheared so
4696 that the characters are vertically parallel to a line joining (
4707 sz = 0.) then the text
is not sheared.
4709 sy (PLFLT, input) : Together
with sx
and
4710 sz, this specifies shear of the string.
4712 sz (PLFLT, input) : Together
with sx
and
4713 sy, this specifies shear of the string.
4715 just (PLFLT, input) : Specifies the position of the string relative
4716 to its reference point. If just=0. , the reference point
is at
4717 the left
and if just=1. , it
is at the right of the string. Other
4718 values of just give intermediate justifications.
4720 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be
4724 return _plplotc.plptex3(x, y, z, dx, dy, dz, sx, sy, sz, just, text)
4728 Random number generator returning a real random number in the range [0,1]
4732 Random number generator returning a real random number
in the range
4733 [0,1]. The generator
is based on the Mersenne Twister. Most languages
4734 / compilers provide their own random number generator,
and so this
is
4735 provided purely
for convenience
and to give a consistent random number
4736 generator across all languages supported by PLplot. This
is
4737 particularly useful
for comparing results
from the test suite of
4742 This function
is used
in examples 17
and 21.
4751 return _plplotc.plrandd()
4755 Replays contents of plot buffer to current device/file
4759 Replays contents of plot buffer to current device/file.
4763 This function is used
in example 1,20.
4772 return _plplotc.plreplot()
4776 Convert RGB color to HLS
4780 Convert RGB color coordinates to HLS
4782 Redacted form: General: plrgbhls(r, g, b, p_h, p_l, p_s)
4785 This function is used
in example 2.
4795 r (PLFLT, input) : Red intensity (0.0-1.0) of the color.
4797 g (PLFLT, input) : Green intensity (0.0-1.0) of the color.
4799 b (PLFLT, input) : Blue intensity (0.0-1.0) of the color.
4801 p_h (PLFLT_NC_SCALAR, output) : Returned value of the hue
in
4802 degrees (0.0-360.0) on the color cylinder.
4804 p_l (PLFLT_NC_SCALAR, output) : Returned value of the lightness
4805 expressed
as a fraction (0.0-1.0) of the axis of the color
4808 p_s (PLFLT_NC_SCALAR, output) : Returned value of the saturation
4809 expressed
as a fraction (0.0-1.0) of the radius of the color
4813 return _plplotc.plrgbhls(r, g, b)
4821 This sets up the size of all subsequent characters drawn. The actual
4822 height of a character is the product of the default character size
and
4825 Redacted form:
plschr(
def, scale)
4827 This function
is used
in examples 2, 13, 23,
and 24.
4837 def (PLFLT, input) : The default height of a character
in
4838 millimeters, should be set to zero
if the default height
is to
4839 remain unchanged. For rasterized drivers the dx
and dy values
4840 specified
in plspage are used to convert
from mm to pixels (note
4841 the different unit systems used). This dpi aware scaling
is not
4842 implemented
for all drivers yet.
4844 scale (PLFLT, input) : Scale factor to be applied to default to get
4845 actual character height.
4848 return _plplotc.plschr(_def, scale)
4852 Set cmap0 colors by 8-bit RGB values
4856 Set cmap0 colors using 8-bit RGB values (see the PLplot
4857 documentation). This sets the entire color map -- only as many colors
4858 as specified will be allocated.
4862 This function
is used
in examples 2
and 24.
4872 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4873 integers (0-255) representing the degree of red
in the color.
4875 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4876 integers (0-255) representing the degree of green
in the color.
4878 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4879 integers (0-255) representing the degree of blue
in the color.
4881 ncol0 (PLINT, input) : Number of items
in the r, g,
and b vectors.
4884 return _plplotc.plscmap0(Array, arg2, arg3)
4888 Set cmap0 colors by 8-bit RGB values and PLFLT alpha transparency value
4892 Set cmap0 colors using 8-bit RGB values (see the PLplot documentation)
4893 and PLFLT alpha transparency value. This sets the entire color map --
4894 only
as many colors
as specified will be allocated.
4896 Redacted form:
plscmap0a(r, g, b, alpha)
4898 This function
is used
in examples 30.
4908 r (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4909 integers (0-255) representing the degree of red
in the color.
4911 g (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4912 integers (0-255) representing the degree of green
in the color.
4914 b (PLINT_VECTOR, input) : A vector containing unsigned 8-bit
4915 integers (0-255) representing the degree of blue
in the color.
4917 alpha (PLFLT_VECTOR, input) : A vector containing values (0.0-1.0)
4918 representing the alpha transparency of the color.
4920 ncol0 (PLINT, input) : Number of items
in the r, g, b,
and alpha
4924 return _plplotc.plscmap0a(Array, arg2, arg3, arg4)
4928 Set number of colors in cmap0
4932 Set number of colors
in cmap0 (see the PLplot documentation). Allocate
4933 (
or reallocate) cmap0,
and fill
with default values
for those colors
4934 not previously allocated. The first 16 default colors are given
in
4935 the plcol0 documentation. For larger indices the default color
is
4938 The drivers are
not guaranteed to support more than 16 colors.
4942 This function
is used
in examples 15, 16,
and 24.
4952 ncol0 (PLINT, input) : Number of colors that will be allocated
in
4953 the cmap0 palette. If this number
is zero
or less, then the value
4954 from the previous call to plscmap0n
is used
and if there
is no
4955 previous call, then a default value
is used.
4958 return _plplotc.plscmap0n(ncol0)
4962 Set opaque RGB cmap1 colors values
4966 Set opaque cmap1 colors (see the PLplot documentation) using RGB
4967 vector values. This function also sets the number of cmap1 colors.
4968 N.B. Continuous cmap1 colors are indexed with a floating-point index
4969 in the range
from 0.0-1.0 which
is linearly transformed (e.g., by
4970 plcol1) to an integer index of these RGB vectors
in the range
from 0
4972 ncol1-1. So
in order
for this continuous color model to work
4973 properly, it
is the responsibility of the user of plscmap1 to insure
4974 that these RGB vectors are continuous functions of their integer
4979 This function
is used
in example 31.
4989 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
4990 8-bit integers
in the range
from 0-255) the degree of red
in the
4991 color
as a continuous function of the integer index of the vector.
4993 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
4994 8-bit integers
in the range
from 0-255) the degree of green
in the
4995 color
as a continuous function of the integer index of the vector.
4997 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
4998 8-bit integers
in the range
from 0-255) the degree of blue
in the
4999 color
as a continuous function of the integer index of the vector.
5001 ncol1 (PLINT, input) : Number of items
in the r, g,
and b vectors.
5004 return _plplotc.plscmap1(Array, arg2, arg3)
5008 Set semitransparent cmap1 RGBA colors.
5012 Set semitransparent cmap1 colors (see the PLplot documentation) using
5013 RGBA vector values. This function also sets the number of cmap1
5014 colors. N.B. Continuous cmap1 colors are indexed with a
5015 floating-point index
in the range
from 0.0-1.0 which
is linearly
5016 transformed (e.g., by plcol1) to an integer index of these RGBA
5017 vectors
in the range
from 0 to
5018 ncol1-1. So
in order
for this continuous color model to work
5019 properly, it
is the responsibility of the user of plscmap1 to insure
5020 that these RGBA vectors are continuous functions of their integer
5023 Redacted form:
plscmap1a(r, g, b, alpha)
5025 This function
is used
in example 31.
5035 r (PLINT_VECTOR, input) : A vector that represents (using unsigned
5036 8-bit integers
in the range
from 0-255) the degree of red
in the
5037 color
as a continuous function of the integer index of the vector.
5039 g (PLINT_VECTOR, input) : A vector that represents (using unsigned
5040 8-bit integers
in the range
from 0-255) the degree of green
in the
5041 color
as a continuous function of the integer index of the vector.
5043 b (PLINT_VECTOR, input) : A vector that represents (using unsigned
5044 8-bit integers
in the range
from 0-255) the degree of blue
in the
5045 color
as a continuous function of the integer index of the vector.
5047 alpha (PLFLT_VECTOR, input) : A vector that represents (using PLFLT
5048 values
in the range
from 0.0-1.0 where 0.0 corresponds to
5049 completely transparent
and 1.0 corresponds to completely opaque)
5050 the alpha transparency of the color
as a continuous function of
5051 the integer index of the vector.
5053 ncol1 (PLINT, input) : Number of items
in the r, g, b,
and alpha
5057 return _plplotc.plscmap1a(Array, arg2, arg3, arg4)
5059def plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null):
5061 Set cmap1 colors using a piece-wise linear relationship
5065 Set cmap1 colors using a piece-wise linear relationship between the
5066 cmap1 intensity index (0.0-1.0) and position
in HLS
or RGB color space
5067 (see the PLplot documentation). May be called at any time.
5069 The idea here
is to specify a number of control points that define the
5070 mapping between input cmap1 intensity indices
and HLS
or RGB. Between
5071 these points, linear interpolation
is used which gives a smooth
5072 variation of color
with intensity index. Any number of control points
5073 may be specified, located at arbitrary positions, although typically 2
5074 - 4 are enough. Another way of stating this
is that we are traversing
5075 a given number of lines through HLS
or RGB space
as we move through
5076 cmap1 intensity indices. The control points at the minimum
and
5077 maximum position (0
and 1) must always be specified. By adding more
5078 control points you can get more variation. One good technique
for
5079 plotting functions that vary about some expected average
is to use an
5080 additional 2 control points
in the center (position ~= 0.5) that are
5081 the same lightness
as the background (typically white
for paper
5082 output, black
for crt),
and same hue
as the boundary control points.
5083 This allows the highs
and lows to be very easily distinguished.
5085 Each control point must specify the cmap1 intensity index
and the
5086 associated three coordinates
in HLS
or RGB space. The first point
5087 must correspond to position = 0,
and the last to position = 1.
5089 If RGB colors are provided then the interpolation takes place
in RGB
5090 space
and is trivial. However
if HLS colors are provided then, because
5091 of the circular nature of the color wheel
for the hue coordinate, the
5092 interpolation could be performed
in either direction around the color
5093 wheel. The default behaviour
is for the hue to be linearly
5094 interpolated ignoring this circular property of hue. So
for example,
5095 the hues 0 (red)
and 240 (blue) will get interpolated via yellow,
5096 green
and cyan. If instead you wish to interpolate the other way
5097 around the color wheel you have two options. You may provide hues
5098 outside the range [0, 360), so by using a hue of -120
for blue
or 360
5099 for red the interpolation will proceed via magenta. Alternatively you
5100 can utilise the alt_hue_path variable to reverse the direction of
5101 interpolation
if you need to provide hues within the [0-360) range.
5103 Examples of interpolation Huealt_hue_pathcolor scheme[120
5104 240]falsegreen-cyan-blue[240 120]falseblue-cyan-green[120
5105 -120]falsegreen-yellow-red-magenta-blue[240
5106 480]falseblue-magenta-red-yellow-green[120
5107 240]truegreen-yellow-red-magenta-blue[240
5108 120]trueblue-magenta-red-yellow-green
5110 Bounds on coordinatesRGBR[0, 1]magnitudeRGBG[0, 1]magnitudeRGBB[0,
5111 1]magnitudeHLShue[0, 360]degreesHLSlightness[0,
5112 1]magnitudeHLSsaturation[0, 1]magnitude
5114 Redacted form:
plscmap1l(itype, intensity, coord1, coord2, coord3,
5117 This function
is used
in examples 8, 11, 12, 15, 20,
and 21.
5123 plscmap1l(itype, npts, intensity, coord1, coord2, coord3, alt_hue_path)
5127 itype (PLBOOL, input) : true: RGB, false: HLS.
5129 npts (PLINT, input) : number of control points
5131 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5132 intensity index (0.0-1.0)
in ascending order
for each control
5135 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5136 coordinate (H
or R)
for each control point.
5138 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5139 coordinate (L
or G)
for each control point.
5141 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5142 coordinate (S
or B)
for each control point.
5144 alt_hue_path (PLBOOL_VECTOR, input) : A vector (
with
5145 npts - 1 elements), each containing either true to use the reversed
5146 HLS interpolation
or false to use the regular HLS interpolation.
5147 (alt_hue_path[i] refers to the interpolation interval between the
5148 i
and i + 1 control points). This parameter
is not used
for RGB
5153 return _plplotc.plscmap1l(itype, n, arg3, arg4, arg5, ArrayCkMinus1Null)
5155def plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null):
5157 Set cmap1 colors and alpha transparency using a piece-wise linear relationship
5161 This
is a variant of plscmap1l that supports alpha channel
5162 transparency. It sets cmap1 colors using a piece-wise linear
5163 relationship between cmap1 intensity index (0.0-1.0)
and position
in
5164 HLS
or RGB color space (see the PLplot documentation)
with alpha
5165 transparency value (0.0-1.0). It may be called at any time.
5167 Redacted form:
plscmap1la(itype, intensity, coord1, coord2, coord3,
5168 alpha, alt_hue_path)
5170 This function
is used
in example 30.
5176 plscmap1la(itype, npts, intensity, coord1, coord2, coord3, alpha, alt_hue_path)
5180 itype (PLBOOL, input) : true: RGB, false: HLS.
5182 npts (PLINT, input) : number of control points.
5184 intensity (PLFLT_VECTOR, input) : A vector containing the cmap1
5185 intensity index (0.0-1.0)
in ascending order
for each control
5188 coord1 (PLFLT_VECTOR, input) : A vector containing the first
5189 coordinate (H
or R)
for each control point.
5191 coord2 (PLFLT_VECTOR, input) : A vector containing the second
5192 coordinate (L
or G)
for each control point.
5194 coord3 (PLFLT_VECTOR, input) : A vector containing the third
5195 coordinate (S
or B)
for each control point.
5197 alpha (PLFLT_VECTOR, input) : A vector containing the alpha
5198 transparency value (0.0-1.0)
for each control point.
5200 alt_hue_path (PLBOOL_VECTOR, input) : A vector (
with
5201 npts - 1 elements) containing the alternative interpolation method
5202 Boolean value
for each control point interval. (alt_hue_path[i]
5203 refers to the interpolation interval between the i
and i + 1
5207 return _plplotc.plscmap1la(itype, n, arg3, arg4, arg5, arg6, ArrayCkMinus1Null)
5211 Set number of colors in cmap1
5215 Set number of colors
in cmap1, (re-)allocate cmap1,
and set default
5216 values
if this
is the first allocation (see the PLplot documentation).
5220 This function
is used
in examples 8, 11, 20,
and 21.
5230 ncol1 (PLINT, input) : Number of colors that will be allocated
in
5231 the cmap1 palette. If this number
is zero
or less, then the value
5232 from the previous call to plscmap1n
is used
and if there
is no
5233 previous call, then a default value
is used.
5236 return _plplotc.plscmap1n(ncol1)
5240 Set the cmap1 argument range for continuous color plots
5244 Set the cmap1 argument range
for continuous color plots that
5245 corresponds to the range of data values. The maximum range
5246 corresponding to the entire cmap1 palette
is 0.0-1.0,
and the smaller
5247 the cmap1 argument range that
is specified
with this routine, the
5248 smaller the subset of the cmap1 color palette that
is used to
5249 represent the continuous data being plotted. If
5250 min_color
is greater than
5252 max_color
is greater than 1.0
or
5253 min_color
is less than 0.0 then no change
is made to the cmap1
5254 argument range. (Use plgcmap1_range to get the cmap1 argument range.)
5258 This function
is currently used
in example 33.
5268 min_color (PLFLT, input) : The minimum cmap1 argument. If less
5269 than 0.0, then 0.0
is used instead.
5271 max_color (PLFLT, input) : The maximum cmap1 argument. If greater
5272 than 1.0, then 1.0
is used instead.
5275 return _plplotc.plscmap1_range(min_color, max_color)
5279 Get the cmap1 argument range for continuous color plots
5283 Get the cmap1 argument range
for continuous color plots. (Use
5284 plscmap1_range to set the cmap1 argument range.)
5288 This function
is currently
not used
in any example.
5298 min_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5299 minimum cmap1 argument.
5301 max_color (PLFLT_NC_SCALAR, output) : Returned value of the current
5302 maximum cmap1 argument.
5305 return _plplotc.plgcmap1_range()
5309 Set 8-bit RGB values for given cmap0 color index
5313 Set 8-bit RGB values
for given cmap0 (see the PLplot documentation)
5314 index. Overwrites the previous color value
for the given index
and,
5315 thus, does
not result
in any additional allocation of space
for
5318 Redacted form:
plscol0(icol0, r, g, b)
5320 This function
is used
in any example 31.
5330 icol0 (PLINT, input) : Color index. Must be less than the maximum
5331 number of colors (which
is set by default, by plscmap0n,
or even
5334 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5335 degree of red
in the color.
5337 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5338 degree of green
in the color.
5340 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5341 degree of blue
in the color.
5344 return _plplotc.plscol0(icol0, r, g, b)
5348 Set 8-bit RGB values and PLFLT alpha transparency value
for given cmap0 color index
5352 Set 8-bit RGB value
and PLFLT alpha transparency value
for given cmap0
5353 (see the PLplot documentation) index. Overwrites the previous color
5354 value
for the given index
and, thus, does
not result
in any additional
5355 allocation of space
for colors.
5357 This function
is used
in example 30.
5367 icol0 (PLINT, input) : Color index. Must be less than the maximum
5368 number of colors (which
is set by default, by plscmap0n,
or even
5371 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5372 degree of red
in the color.
5374 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5375 degree of green
in the color.
5377 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5378 degree of blue
in the color.
5380 alpha (PLFLT, input) : Value of the alpha transparency
in the range
5384 return _plplotc.plscol0a(icol0, r, g, b, a)
5388 Set the background color by 8-bit RGB value
5392 Set the background color (color 0 in cmap0) by 8-bit RGB value (see
5393 the PLplot documentation).
5397 This function
is used
in examples 15
and 31.
5407 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5408 degree of red
in the color.
5410 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5411 degree of green
in the color.
5413 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5414 degree of blue
in the color.
5417 return _plplotc.plscolbg(r, g, b)
5421 Set the background color by 8-bit RGB value and PLFLT alpha transparency value.
5425 Set the background color (color 0
in cmap0) by 8-bit RGB value
and
5426 PLFLT alpha transparency value (see the PLplot documentation).
5428 This function
is used
in example 31.
5438 r (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5439 degree of red
in the color.
5441 g (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5442 degree of green
in the color.
5444 b (PLINT, input) : Unsigned 8-bit integer (0-255) representing the
5445 degree of blue
in the color.
5447 alpha (PLFLT, input) : Value of the alpha transparency
in the range
5451 return _plplotc.plscolbga(r, g, b, a)
5455 Used to globally turn color output on/off
5459 Used to globally turn color output on/off for those drivers/devices
5464 This function
is used
in example 31.
5474 color (PLINT, input) : Color flag (Boolean). If zero, color
is
5475 turned off. If non-zero, color
is turned on.
5478 return _plplotc.plscolor(color)
5482 Set device-compression level
5486 Set device-compression level. Only used for drivers that provide
5487 compression. This function,
if used, should be invoked before a call
5492 This function
is used
in example 31.
5502 compression (PLINT, input) : The desired compression level. This
is
5503 a device-dependent value. Currently only the jpeg
and png devices
5504 use these values. For jpeg value
is the jpeg quality which should
5505 normally be
in the range 0-95. Higher values denote higher quality
5506 and hence larger image sizes. For png values are
in the range -1
5507 to 99. Values of 0-9 are taken
as the compression level
for zlib.
5508 A value of -1 denotes the default zlib compression level. Values
5509 in the range 10-99 are divided by 10
and then used
as the zlib
5510 compression level. Higher compression levels correspond to greater
5511 compression
and small file sizes at the expense of more
5515 return _plplotc.plscompression(compression)
5519 Set the device (keyword) name
5523 Set the device (keyword) name.
5525 Redacted form: plsdev(devname)
5527 This function is used
in examples 1, 14,
and 20.
5537 devname (PLCHAR_VECTOR, input) : An ascii character string
5538 containing the device name keyword of the required output device.
5540 devname
is NULL
or if the first character of the string
is a ``?
'',
5541 the normal (prompted) start up
is used.
5544 return _plplotc.plsdev(devname)
5548 Set parameters that define current device-space window
5552 Set relative margin width, aspect ratio, and relative justification
5553 that define current device-space window. If you want to just use the
5554 previous value
for any of these, just
pass in the magic value
5555 PL_NOTSET. It
is unlikely that one should ever need to change the
5556 aspect ratio but it
's in there for completeness. If plsdidev is not
5557 called the default values of mar, jx, and jy are all 0. aspect
is set
5558 to a device-specific value.
5560 Redacted form:
plsdidev(mar, aspect, jx, jy)
5562 This function
is used
in example 31.
5572 mar (PLFLT, input) : Relative margin width.
5574 aspect (PLFLT, input) : Aspect ratio.
5576 jx (PLFLT, input) : Relative justification
in x. Value must lie
in
5577 the range -0.5 to 0.5.
5579 jy (PLFLT, input) : Relative justification
in y. Value must lie
in
5580 the range -0.5 to 0.5.
5583 return _plplotc.plsdidev(mar, aspect, jx, jy)
5585def plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm):
5587 Set up transformation from metafile coordinates
5591 Set up transformation
from metafile coordinates. The size of the plot
5592 is scaled so
as to preserve aspect ratio. This isn
't intended to be a
5593 general-purpose facility just yet (not sure why the user would need
5596 Redacted form:
plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm,
5599 This function
is not used
in any examples.
5605 plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5609 dimxmin (PLINT, input) : NEEDS DOCUMENTATION
5611 dimxmax (PLINT, input) : NEEDS DOCUMENTATION
5613 dimymin (PLINT, input) : NEEDS DOCUMENTATION
5615 dimymax (PLINT, input) : NEEDS DOCUMENTATION
5617 dimxpmm (PLFLT, input) : NEEDS DOCUMENTATION
5619 dimypmm (PLFLT, input) : NEEDS DOCUMENTATION
5622 return _plplotc.plsdimap(dimxmin, dimxmax, dimymin, dimymax, dimxpmm, dimypmm)
5626 Set plot orientation
5630 Set plot orientation parameter which is multiplied by 90 degrees to
5631 obtain the angle of rotation. Note, arbitrary rotation parameters
5632 such
as 0.2 (corresponding to 18 degrees) are possible, but the usual
5633 values
for the rotation parameter are 0., 1., 2.,
and 3. corresponding
5634 to 0 degrees (landscape mode), 90 degrees (portrait mode), 180 degrees
5635 (seascape mode),
and 270 degrees (upside-down mode). If plsdiori
is
5636 not called the default value of rot
is 0.
5638 N.B. aspect ratio
is unaffected by calls to plsdiori. So you will
5639 probably want to change the aspect ratio to a value suitable
for the
5640 plot orientation using a call to plsdidev
or the command-line options
5641 -a
or -freeaspect. For more documentation of those options see the
5642 PLplot documentation. Such command-line options can be set internally
5643 using plsetopt
or set directly using the command line
and parsed using
5644 a call to plparseopts.
5648 This function
is not used
in any examples.
5658 rot (PLFLT, input) : Plot orientation parameter.
5661 return _plplotc.plsdiori(rot)
5665 Set parameters that define current plot-space window
5669 Set relative minima and maxima that define the current plot-space
5670 window. If plsdiplt
is not called the default values of xmin, ymin,
5671 xmax,
and ymax are 0., 0., 1.,
and 1.
5673 Redacted form:
plsdiplt(xmin, ymin, xmax, ymax)
5675 This function
is used
in example 31.
5685 xmin (PLFLT, input) : Relative minimum
in x.
5687 ymin (PLFLT, input) : Relative minimum
in y.
5689 xmax (PLFLT, input) : Relative maximum
in x.
5691 ymax (PLFLT, input) : Relative maximum
in y.
5694 return _plplotc.plsdiplt(xmin, ymin, xmax, ymax)
5698 Set parameters incrementally (zoom mode) that define current plot-space window
5702 Set relative minima and maxima incrementally (zoom mode) that define
5703 the current plot-space window. This function has the same effect
as
5704 plsdiplt
if that function has
not been previously called. Otherwise,
5705 this function implements zoom mode using the transformation min_used =
5706 old_min + old_length*min
and max_used = old_min + old_length*max
for
5707 each axis. For example,
if min = 0.05
and max = 0.95
for each axis,
5708 repeated calls to plsdiplz will zoom
in by 10 per cent
for each call.
5710 Redacted form:
plsdiplz(xmin, ymin, xmax, ymax)
5712 This function
is used
in example 31.
5722 xmin (PLFLT, input) : Relative (incremental) minimum
in x.
5724 ymin (PLFLT, input) : Relative (incremental) minimum
in y.
5726 xmax (PLFLT, input) : Relative (incremental) maximum
in x.
5728 ymax (PLFLT, input) : Relative (incremental) maximum
in y.
5731 return _plplotc.plsdiplz(xmin, ymin, xmax, ymax)
5735 Set seed for internal random number generator.
5739 Set the seed
for the internal random number generator. See plrandd
for
5742 Redacted form:
plseed(seed)
5744 This function
is used
in example 21.
5754 seed (unsigned int, input) : Seed
for random number generator.
5757 return _plplotc.plseed(s)
5761 Set the escape character for text strings
5765 Set the escape character
for text strings. From C (
in contrast to
5766 Fortran, see plsescfortran) you
pass esc
as a character. Only selected
5767 characters are allowed to prevent the user
from shooting himself
in
5768 the foot (For example, a \ isn
't allowed since it conflicts with C's
5769 use of backslash
as a character escape). Here are the allowed escape
5770 characters
and their corresponding decimal ASCII values: !, ASCII 33
5781 Redacted form: General:
plsesc(esc)
5784 This function
is used
in example 29.
5794 esc (char, input) : Escape character.
5797 return _plplotc.plsesc(esc)
5801 Set any command-line option
5805 Set any command-line option internally from a program before it
5806 invokes plinit. opt
is the name of the command-line option
and optarg
5807 is the corresponding command-line option argument.
5809 This function returns 0 on success.
5811 Redacted form:
plsetopt(opt, optarg)
5813 This function
is used
in example 14.
5823 opt (PLCHAR_VECTOR, input) : An ascii character string containing
5824 the command-line option.
5826 optarg (PLCHAR_VECTOR, input) : An ascii character string
5827 containing the argument of the command-line option.
5830 return _plplotc.plsetopt(opt, optarg)
5834 Set family file parameters
5838 Sets variables dealing with output file familying. Does nothing
if
5839 familying
not supported by the driver. This routine,
if used, must be
5840 called before initializing PLplot. See the PLplot documentation
for
5843 Redacted form:
plsfam(fam, num, bmax)
5845 This function
is used
in examples 14
and 31.
5855 fam (PLINT, input) : Family flag (Boolean). If nonzero, familying
5858 num (PLINT, input) : Current family file number.
5860 bmax (PLINT, input) : Maximum file size (
in bytes)
for a family
5864 return _plplotc.plsfam(fam, num, bmax)
5868 Set FCI (font characterization integer)
5872 Sets font characteristics to be used at the start of the next string
5873 using the FCI approach. See the PLplot documentation for more
5874 information. Note, plsfont (which calls plsfci internally) provides a
5875 more user-friendly API
for setting the font characterisitics.
5877 Redacted form: General:
plsfci(fci)
5880 This function
is used
in example 23.
5890 fci (PLUNICODE, input) : PLUNICODE (unsigned 32-bit integer) value
5894 return _plplotc.plsfci(fci)
5898 Set output file name
5902 Sets the current output file name, if applicable. If the file name
5903 has
not been specified
and is required by the driver, the user will be
5904 prompted
for it. If using the X-windows output driver, this sets the
5905 display name. This routine,
if used, must be called before
5906 initializing PLplot.
5910 This function
is used
in examples 1
and 20.
5920 fnam (PLCHAR_VECTOR, input) : An ascii character string containing
5924 return _plplotc.plsfnam(fnam)
5928 Set family, style and weight of the current font
5932 Sets the current font. See the PLplot documentation
for more
5933 information on font selection.
5935 Redacted form:
plsfont(family, style, weight)
5937 This function
is used
in example 23.
5943 plsfont(family, style, weight)
5947 family (PLINT, input) : Font family to select
for the current font.
5948 The available values are given by the PL_FCI_* constants
in
5949 plplot.h. Current options are PL_FCI_SANS, PL_FCI_SERIF,
5950 PL_FCI_MONO, PL_FCI_SCRIPT
and PL_FCI_SYMBOL. A negative value
5951 signifies that the font family should
not be altered.
5953 style (PLINT, input) : Font style to select
for the current font.
5954 The available values are given by the PL_FCI_* constants
in
5955 plplot.h. Current options are PL_FCI_UPRIGHT, PL_FCI_ITALIC
and
5956 PL_FCI_OBLIQUE. A negative value signifies that the font style
5957 should
not be altered.
5959 weight (PLINT, input) : Font weight to select
for the current font.
5960 The available values are given by the PL_FCI_* constants
in
5961 plplot.h. Current options are PL_FCI_MEDIUM
and PL_FCI_BOLD. A
5962 negative value signifies that the font weight should
not be
5966 return _plplotc.plsfont(family, style, weight)
5970 Shade regions on the basis of value
5974 Shade regions on the basis of value. This is the high-level routine
5975 for making continuous color shaded plots
with cmap1
while plshade
5976 should be used to plot individual shaded regions using either cmap0
or
5977 cmap1. examples/;<language>/x16* shows how to use plshades
for each of
5978 our supported languages.
5980 Redacted form: General:
plshades(a, defined, xmin, xmax, ymin, ymax,
5981 clevel, fill_width, cont_color, cont_width, fill, rectangular, pltr,
5985 This function
is used
in examples 16, 21,
and 22.
5991 plshades(a, nx, ny, defined, xmin, xmax, ymin, ymax, clevel, nlevel, fill_width, cont_color, cont_width, fill, rectangular, pltr, pltr_data)
5995 a (PLFLT_MATRIX, input) : A matrix containing function values to
5996 plot. Should have dimensions of
6000 nx (PLINT, input) : First dimension of matrix
"a".
6002 ny (PLINT, input) : Second dimension of matrix
"a".
6004 defined (PLDEFINED_callback, input) : Callback function specifying
6005 the region that should be plotted
in the shade plot. This
6006 function accepts x
and y coordinates
as input arguments
and must
6007 return 1
if the point
is to be included
in the shade plot
and 0
6008 otherwise. If you want to plot the entire shade plot (the usual
6009 case), this argument should be set to NULL.
6011 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6012 pltr below
for how these arguments are used (only
for the special case
6013 when the callback function
6014 pltr
is not supplied).
6016 clevel (PLFLT_VECTOR, input) : A vector containing the data levels
6017 corresponding to the edges of each shaded region that will be
6018 plotted by this function. To work properly the levels should be
6021 nlevel (PLINT, input) : Number of shades plus 1 (i.e., the number
6022 of shade edge values
in clevel).
6024 fill_width (PLFLT, input) : Defines the line width used by the fill
6027 cont_color (PLINT, input) : Defines cmap0 pen color used
for
6028 contours defining edges of shaded regions. The pen color
is only
6029 temporary set
for the contour drawing. Set this value to zero
or
6030 less
if no shade edge contours are wanted.
6032 cont_width (PLFLT, input) : Defines line width used
for contours
6033 defining edges of shaded regions. This value may
not be honored
6034 by all drivers. The pen width
is only temporary set
for the
6035 contour drawing. Set this value to zero
or less
if no shade edge
6036 contours are wanted.
6038 fill (PLFILL_callback, input) : Callback routine used to fill the
6039 region. Use plfill
for this purpose.
6041 rectangular (PLBOOL, input) : Set rectangular to true
if rectangles
6042 map to rectangles after coordinate transformation
with pltrl.
6043 Otherwise, set rectangular to false. If rectangular
is set to
6044 true, plshade tries to save time by filling large rectangles.
6045 This optimization fails
if the coordinate transformation distorts
6046 the shape of rectangles. For example a plot
in polar coordinates
6047 has to have rectangular set to false.
6049 pltr (PLTRANSFORM_callback, input) : A callback function that
6050 defines the transformation between the zero-based indices of the
6051 matrix a
and world coordinates. If
6052 pltr
is not supplied (e.g.,
is set to NULL
in the C case), then the x
6053 indices of a are mapped to the range
6055 xmax
and the y indices of a are mapped to the range
6057 ymax.For the C case, transformation functions are provided
in the
6058 PLplot library: pltr0
for the identity mapping,
and pltr1
and
6059 pltr2
for arbitrary mappings respectively defined by vectors
and
6060 matrices. In addition, C callback routines
for the transformation
6061 can be supplied by the user such
as the mypltr function
in
6062 examples/c/x09c.c which provides a general linear transformation
6063 between index coordinates
and world coordinates.For languages
6064 other than C you should consult the PLplot documentation
for the
6065 details concerning how PLTRANSFORM_callback arguments are
6066 interfaced. However,
in general, a particular pattern of
6067 callback-associated arguments such
as a tr vector
with 6 elements;
6068 xg
and yg vectors;
or xg
and yg matrices are respectively
6069 interfaced to a linear-transformation routine similar to the above
6070 mypltr function; pltr1;
and pltr2. Furthermore, some of our more
6071 sophisticated bindings (see, e.g., the PLplot documentation)
6072 support native language callbacks
for handling index to
6073 world-coordinate transformations. Examples of these various
6074 approaches are given
in examples/<language>x09*,
6075 examples/<language>x16*, examples/<language>x20*,
6076 examples/<language>x21*,
and examples/<language>x22*,
for all our
6077 supported languages.
6079 pltr_data (PLPointer, input) : Extra parameter to help
pass
6080 information to pltr0, pltr1, pltr2,
or whatever routine that
is
6081 externally supplied.
6084 return _plplotc.plshades(*args)
6088 Shade individual region on the basis of value
6092 Shade individual region on the basis of value. Use plshades if you
6093 want to shade a number of contiguous regions using continuous colors.
6094 In particular the edge contours are treated properly
in plshades. If
6095 you attempt to do contiguous regions
with plshade the contours at the
6096 edge of the shade are partially obliterated by subsequent plots of
6097 contiguous shaded regions.
6099 Redacted form: General:
plshade(a, defined, xmin, xmax, ymin, ymax,
6100 shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color,
6101 min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
6104 This function
is used
in example 15.
6110 plshade(a, nx, ny, defined, xmin, xmax, ymin, ymax, shade_min, shade_max, sh_cmap, sh_color, sh_width, min_color, min_width, max_color, max_width, fill, rectangular, pltr, pltr_data)
6114 a (PLFLT_MATRIX, input) : A matrix containing function values to
6115 plot. Should have dimensions of
6119 nx (PLINT, input) : First dimension of the matrix
"a".
6121 ny (PLINT, input) : Second dimension of the matrix
"a".
6123 defined (PLDEFINED_callback, input) : Callback function specifying
6124 the region that should be plotted
in the shade plot. This
6125 function accepts x
and y coordinates
as input arguments
and must
6126 return 1
if the point
is to be included
in the shade plot
and 0
6127 otherwise. If you want to plot the entire shade plot (the usual
6128 case), this argument should be set to NULL.
6130 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
6131 pltr below
for how these arguments are used (only
for the special case
6132 when the callback function
6133 pltr
is not supplied).
6135 shade_min (PLFLT, input) : Defines the lower end of the interval to
6136 be shaded. If shade_max <= shade_min, plshade does nothing.
6138 shade_max (PLFLT, input) : Defines the upper end of the interval to
6139 be shaded. If shade_max <= shade_min, plshade does nothing.
6141 sh_cmap (PLINT, input) : Defines color map. If sh_cmap=0, then
6142 sh_color
is interpreted
as a cmap0 (integer) index. If sh_cmap=1,
6143 then sh_color
is interpreted
as a cmap1 argument
in the range
6146 sh_color (PLFLT, input) : Defines color map index
with integer
6147 value
if cmap0
or value
in range (0.0-1.0)
if cmap1.
6149 sh_width (PLFLT, input) : Defines width used by the fill pattern.
6151 min_color (PLINT, input) : Defines pen color, width used by the
6152 boundary of shaded region. The min values are used
for the
6153 shade_min boundary,
and the max values are used on the shade_max
6154 boundary. Set color
and width to zero
for no plotted boundaries.
6156 min_width (PLFLT, input) : Defines pen color, width used by the
6157 boundary of shaded region. The min values are used
for the
6158 shade_min boundary,
and the max values are used on the shade_max
6159 boundary. Set color
and width to zero
for no plotted boundaries.
6161 max_color (PLINT, input) : Defines pen color, width used by the
6162 boundary of shaded region. The min values are used
for the
6163 shade_min boundary,
and the max values are used on the shade_max
6164 boundary. Set color
and width to zero
for no plotted boundaries.
6166 max_width (PLFLT, input) : Defines pen color, width used by the
6167 boundary of shaded region. The min values are used
for the
6168 shade_min boundary,
and the max values are used on the shade_max
6169 boundary. Set color
and width to zero
for no plotted boundaries.
6171 fill (PLFILL_callback, input) : Routine used to fill the region.
6172 Use plfill. Future version of PLplot may have other fill
6175 rectangular (PLBOOL, input) : Set rectangular to true
if rectangles
6176 map to rectangles after coordinate transformation
with pltrl.
6177 Otherwise, set rectangular to false. If rectangular
is set to
6178 true, plshade tries to save time by filling large rectangles.
6179 This optimization fails
if the coordinate transformation distorts
6180 the shape of rectangles. For example a plot
in polar coordinates
6181 has to have rectangular set to false.
6183 pltr (PLTRANSFORM_callback, input) : A callback function that
6184 defines the transformation between the zero-based indices of the
6185 matrix a
and world coordinates. If
6186 pltr
is not supplied (e.g.,
is set to NULL
in the C case), then the x
6187 indices of a are mapped to the range
6189 xmax
and the y indices of a are mapped to the range
6191 ymax.For the C case, transformation functions are provided
in the
6192 PLplot library: pltr0
for the identity mapping,
and pltr1
and
6193 pltr2
for arbitrary mappings respectively defined by vectors
and
6194 matrices. In addition, C callback routines
for the transformation
6195 can be supplied by the user such
as the mypltr function
in
6196 examples/c/x09c.c which provides a general linear transformation
6197 between index coordinates
and world coordinates.For languages
6198 other than C you should consult the PLplot documentation
for the
6199 details concerning how PLTRANSFORM_callback arguments are
6200 interfaced. However,
in general, a particular pattern of
6201 callback-associated arguments such
as a tr vector
with 6 elements;
6202 xg
and yg vectors;
or xg
and yg matrices are respectively
6203 interfaced to a linear-transformation routine similar to the above
6204 mypltr function; pltr1;
and pltr2. Furthermore, some of our more
6205 sophisticated bindings (see, e.g., the PLplot documentation)
6206 support native language callbacks
for handling index to
6207 world-coordinate transformations. Examples of these various
6208 approaches are given
in examples/<language>x09*,
6209 examples/<language>x16*, examples/<language>x20*,
6210 examples/<language>x21*,
and examples/<language>x22*,
for all our
6211 supported languages.
6213 pltr_data (PLPointer, input) : Extra parameter to help
pass
6214 information to pltr0, pltr1, pltr2,
or whatever routine that
is
6215 externally supplied.
6218 return _plplotc.plshade(*args)
6222 Assign a function to use for generating custom axis labels
6226 This function allows a user to provide their own function to provide
6227 axis label text. The user function
is given the numeric value
for a
6228 point on an axis
and returns a string label to correspond
with that
6229 value. Custom axis labels can be enabled by passing appropriate
6230 arguments to plenv, plbox, plbox3
and similar functions.
6232 This function
is used
in example 19.
6242 label_func (PLLABEL_FUNC_callback, input) : This
is the custom
6243 label function. In order to reset to the default labelling, set
6244 this to NULL. The labelling function parameters are,
in order:
6245 axis: This indicates which axis a label
is being requested
for.
6246 The value will be one of PL_X_AXIS, PL_Y_AXIS
or PL_Z_AXIS.
6248 value: This
is the value along the axis which
is being labelled.
6250 label_text: The string representation of the label value.
6252 length: The maximum length
in characters allowed
for label_text.
6255 label_data (PLPointer, input) : This parameter may be used to
pass
6256 data to the label_func function.
6259 return _plplotc.plslabelfunc(lf, data)
6263 Set length of major ticks
6267 This sets up the length of the major ticks. The actual length is the
6268 product of the default length
and a scaling factor
as for character
6271 Redacted form:
plsmaj(
def, scale)
6273 This function
is used
in example 29.
6283 def (PLFLT, input) : The default length of a major tick
in
6284 millimeters, should be set to zero
if the default length
is to
6287 scale (PLFLT, input) : Scale factor to be applied to default to get
6291 return _plplotc.plsmaj(_def, scale)
6295 Set the memory area to be plotted (RGB)
6299 Set the memory area to be plotted (with the mem
or memcairo driver)
as
6300 the dev member of the stream structure. Also set the number of pixels
6301 in the memory passed
in
6302 plotmem, which
is a block of memory
6304 maxx by 3 bytes long, say: 480 x 640 x 3 (Y, X, RGB)
6306 This memory will have to be freed by the user!
6308 Redacted form:
plsmem(maxx, maxy, plotmem)
6310 This function
is not used
in any examples.
6316 plsmem(maxx, maxy, plotmem)
6320 maxx (PLINT, input) : Size of memory area
in the X coordinate.
6322 maxy (PLINT, input) : Size of memory area
in the Y coordinate.
6324 plotmem (PLPointer, input) : Pointer to the beginning of a
6325 user-supplied writeable memory area.
6328 return _plplotc.plsmem(maxx, maxy, plotmem)
6332 Set the memory area to be plotted (RGBA)
6336 Set the memory area to be plotted (with the memcairo driver)
as the
6337 dev member of the stream structure. Also set the number of pixels
in
6338 the memory passed
in
6339 plotmem, which
is a block of memory
6341 maxx by 4 bytes long, say: 480 x 640 x 4 (Y, X, RGBA)
6343 This memory will have to be freed by the user!
6345 Redacted form:
plsmema(maxx, maxy, plotmem)
6347 This function
is not used
in any examples.
6357 maxx (PLINT, input) : Size of memory area
in the X coordinate.
6359 maxy (PLINT, input) : Size of memory area
in the Y coordinate.
6361 plotmem (PLPointer, input) : Pointer to the beginning of a
6362 user-supplied writeable memory area.
6365 return _plplotc.plsmema(maxx, maxy, plotmem)
6369 Set length of minor ticks
6373 This sets up the length of the minor ticks and the length of the
6374 terminals on error bars. The actual length
is the product of the
6375 default length
and a scaling factor
as for character height.
6377 Redacted form:
plsmin(
def, scale)
6379 This function
is used
in example 29.
6389 def (PLFLT, input) : The default length of a minor tick
in
6390 millimeters, should be set to zero
if the default length
is to
6393 scale (PLFLT, input) : Scale factor to be applied to default to get
6397 return _plplotc.plsmin(_def, scale)
6405 Set integer plot orientation parameter. This function is identical to
6406 plsdiori
except for the type of the argument,
and should be used
in
6407 the same way. See the documentation of plsdiori
for details.
6409 Redacted form:
plsori(ori)
6411 This function
is used
in example 3.
6421 ori (PLINT, input) : Orientation value (0
for landscape, 1
for
6422 portrait, etc.) The value
is multiplied by 90 degrees to get the
6426 return _plplotc.plsori(ori)
6434 Sets the page configuration (optional). If an individual parameter is
6435 zero then that parameter value
is not updated. Not all parameters are
6436 recognized by all drivers
and the interpretation
is device-dependent.
6437 The X-window driver uses the length
and offset parameters to determine
6438 the window size
and location. The length
and offset values are
6439 expressed
in units that are specific to the current driver. For
6440 instance: screen drivers will usually interpret them
as number of
6441 pixels, whereas printer drivers will usually use mm.
6443 This routine,
if used, must be called before initializing PLplot. It
6444 may be called at later times
for interactive drivers to change only
6445 the dpi
for subsequent redraws which you can force via a call to
6446 plreplot. If this function
is not called then the page size defaults
6447 to landscape A4
for drivers which use real world page sizes
and 744
6448 pixels wide by 538 pixels high
for raster drivers. The default value
6449 for dx
and dy
is 90 pixels per inch
for raster drivers.
6453 Redacted form:
plspage(xp, yp, xleng, yleng, xoff, yoff)
6455 This function
is used
in examples 14
and 31.
6461 plspage(xp, yp, xleng, yleng, xoff, yoff)
6465 xp (PLFLT, input) : Number of pixels per inch (DPI), x. Used only
6466 by raster drivers, ignored by drivers which use
"real world" units
6469 yp (PLFLT, input) : Number of pixels per inch (DPI), y. Used only
6470 by raster drivers, ignored by drivers which use
"real world" units
6473 xleng (PLINT, input) : Page length, x.
6475 yleng (PLINT, input) : Page length, y.
6477 xoff (PLINT, input) : Page offset, x.
6479 yoff (PLINT, input) : Page offset, y.
6482 return _plplotc.plspage(xp, yp, xleng, yleng, xoff, yoff)
6486 Set the cmap0 palette using the specified cmap0*.pal format file
6490 Set the cmap0 palette using the specified cmap0*.pal format file.
6492 Redacted form: plspal0(filename)
6494 This function is in example 16.
6504 filename (PLCHAR_VECTOR, input) : An ascii character string
6505 containing the name of the cmap0*.pal file. If this string
is
6506 empty, use the default cmap0*.pal file.
6509 return _plplotc.plspal0(filename)
6513 Set the cmap1 palette using the specified cmap1*.pal format file
6517 Set the cmap1 palette using the specified cmap1*.pal format file.
6519 Redacted form: plspal1(filename, interpolate)
6521 This function is used
in example 16.
6527 plspal1(filename, interpolate)
6531 filename (PLCHAR_VECTOR, input) : An ascii character string
6532 containing the name of the cmap1*.pal file. If this string
is
6533 empty, use the default cmap1*.pal file.
6535 interpolate (PLBOOL, input) : If this parameter
is true, the
6536 columns containing the intensity index, r, g, b, alpha
and
6537 alt_hue_path
in the cmap1*.pal file are used to set the cmap1
6538 palette
with a call to plscmap1la. (The cmap1*.pal header contains
6539 a flag which controls whether the r, g, b data sent to plscmap1la
6540 are interpreted
as HLS
or RGB.) If this parameter
is false, the
6541 intensity index
and alt_hue_path columns are ignored
and the r, g,
6542 b (interpreted
as RGB),
and alpha columns of the cmap1*.pal file
6543 are used instead to set the cmap1 palette directly
with a call to
6547 return _plplotc.plspal1(filename, interpolate)
6551 Set the pause (on end-of-page) status
6555 Set the pause (on end-of-page) status.
6559 This function is in examples 14,20.
6569 pause (PLBOOL, input) : If pause
is true there will be a pause on
6570 end-of-page
for those drivers which support this. Otherwise there
6574 return _plplotc.plspause(pause)
6578 Set current output stream
6582 Sets the number of the current output stream. The stream number
6583 defaults to 0 unless changed by this routine. The first use of this
6584 routine must be followed by a call initializing PLplot (e.g. plstar).
6588 This function is examples 1,14,20.
6598 strm (PLINT, input) : The current stream number.
6601 return _plplotc.plsstrm(strm)
6605 Set the number of subpages in x
and y
6609 Set the number of subpages
in x
and y.
6611 Redacted form:
plssub(nx, ny)
6613 This function
is examples 1,2,14,21,25,27.
6623 nx (PLINT, input) : Number of windows
in x direction (i.e., number
6626 ny (PLINT, input) : Number of windows
in y direction (i.e., number
6630 return _plplotc.plssub(nx, ny)
6638 This sets up the size of all subsequent symbols drawn by plpoin and
6639 plsym. The actual height of a symbol
is the product of the default
6640 symbol size
and a scaling factor
as for the character height.
6642 Redacted form:
plssym(
def, scale)
6644 This function
is used
in example 29.
6654 def (PLFLT, input) : The default height of a symbol
in millimeters,
6655 should be set to zero
if the default height
is to remain
6658 scale (PLFLT, input) : Scale factor to be applied to default to get
6659 actual symbol height.
6662 return _plplotc.plssym(_def, scale)
6670 Initializing the plotting package. The program prompts for the device
6671 keyword
or number of the desired output device. Hitting a RETURN
in
6672 response to the prompt
is the same
as selecting the first device. If
6673 only one device
is enabled when PLplot
is installed, plstar will issue
6674 no prompt. The output device
is divided into nx by ny subpages, each
6675 of which may be used independently. The subroutine pladv
is used to
6676 advance
from one subpage to the next.
6678 Redacted form:
plstar(nx, ny)
6680 This function
is used
in example 1.
6690 nx (PLINT, input) : Number of subpages to divide output page
in the
6693 ny (PLINT, input) : Number of subpages to divide output page
in the
6697 return _plplotc.plstar(nx, ny)
6705 Alternative to plstar for initializing the plotting package. The
6706 device name keyword
for the desired output device must be supplied
as
6707 an argument. These keywords are the same
as those printed out by
6708 plstar. If the requested device
is not available,
or if the input
6709 string
is empty
or begins
with ``?
'', the prompted start up of plstar
6710 is used. This routine also divides the output device page into nx by
6711 ny subpages, each of which may be used independently. The subroutine
6712 pladv
is used to advance
from one subpage to the next.
6714 Redacted form: General:
plstart(devname, nx, ny)
6717 This function
is not used
in any examples.
6727 devname (PLCHAR_VECTOR, input) : An ascii character string
6728 containing the device name keyword of the required output device.
6730 devname
is NULL
or if the first character of the string
is a ``?
'',
6731 the normal (prompted) start up
is used.
6733 nx (PLINT, input) : Number of subpages to divide output page
in the
6736 ny (PLINT, input) : Number of subpages to divide output page
in the
6740 return _plplotc.plstart(devname, nx, ny)
6744 Set a global coordinate transform function
6748 This function can be used to define a coordinate transformation which
6749 affects all elements drawn within the current plot window. The
6750 coordinate_transform callback function
is similar to that provided
for
6751 the plmap
and plmeridians functions. The coordinate_transform_data
6752 parameter may be used to
pass extra data to coordinate_transform.
6754 Redacted form: General:
plstransform(coordinate_transform,
6755 coordinate_transform_data)
6758 This function
is used
in examples 19
and 22.
6764 plstransform(coordinate_transform, coordinate_transform_data)
6768 coordinate_transform (PLTRANSFORM_callback, input) : A callback
6769 function that defines the transformation
from the input (x, y)
6770 world coordinates to new PLplot world coordinates. If
6771 coordinate_transform
is not supplied (e.g.,
is set to NULL
in the C
6772 case), then no transform
is applied.
6774 coordinate_transform_data (PLPointer, input) : Optional extra data
6776 coordinate_transform.
6779 return _plplotc.plstransform(*args)
6783 Plot a glyph at the specified points
6787 Plot a glyph at the specified points. (Supersedes plpoin and plsym
6788 because many[!] more glyphs are accessible
with plstring.) The glyph
6789 is specified
with a PLplot user string. Note that the user string
is
6790 not actually limited to one glyph so it
is possible (but
not normally
6791 useful) to plot more than one glyph at the specified points
with this
6792 function. As
with plmtex
and plptex, the user string can contain FCI
6793 escapes to determine the font, UTF-8 code to determine the glyph
or
6794 else PLplot escapes
for Hershey
or unicode text to determine the
6797 Redacted form:
plstring(x, y, string)
6799 This function
is used
in examples 4, 21
and 26.
6809 n (PLINT, input) : Number of points
in the x
and y vectors.
6811 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6814 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6817 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6818 the glyph(s) to be plotted at each of the n points.
6821 return _plplotc.plstring(n, ArrayCk, string)
6825 Plot a glyph at the specified 3D points
6829 Plot a glyph at the specified 3D points. (Supersedes plpoin3 because
6830 many[!] more glyphs are accessible with plstring3.) Set up the call to
6831 this function similar to what
is done
for plline3. The glyph
is
6832 specified
with a PLplot user string. Note that the user string
is not
6833 actually limited to one glyph so it
is possible (but
not normally
6834 useful) to plot more than one glyph at the specified points
with this
6835 function. As
with plmtex
and plptex, the user string can contain FCI
6836 escapes to determine the font, UTF-8 code to determine the glyph
or
6837 else PLplot escapes
for Hershey
or unicode text to determine the
6840 Redacted form:
plstring3(x, y, z, string)
6842 This function
is used
in example 18.
6852 n (PLINT, input) : Number of points
in the x, y,
and z vectors.
6854 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
6857 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
6860 z (PLFLT_VECTOR, input) : A vector containing the z coordinates of
6863 string (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6864 the glyph(s) to be plotted at each of the n points. points.
6867 return _plplotc.plstring3(n, arg2, arg3, string)
6871 Add a point to a strip chart
6875 Add a point to a given pen of a given strip chart. There is no need
6876 for all pens to have the same number of points
or to be equally
6877 sampled
in the x coordinate. Allocates memory
and rescales
as
6880 Redacted form:
plstripa(id, pen, x, y)
6882 This function
is used
in example 17.
6892 id (PLINT, input) : Identification number of the strip chart (set
6895 pen (PLINT, input) : Pen number (ranges
from 0 to 3).
6897 x (PLFLT, input) : X coordinate of point to plot.
6899 y (PLFLT, input) : Y coordinate of point to plot.
6902 return _plplotc.plstripa(id, pen, x, y)
6904def plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop):
6906 Create a 4-pen strip chart
6910 Create a 4-pen strip chart, to be used afterwards by plstripa
6912 Redacted form: General: plstripc(id, xspec, yspec, xmin, xmax, xjump,
6913 ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline,
6914 styline, legline, labx, laby, labz)
6917 This function is used
in example 17.
6923 plstripc(id, xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, colline, styline, legline[], labx, laby, labtop)
6927 id (PLINT_NC_SCALAR, output) : Returned value of the identification
6928 number of the strip chart to use on plstripa
and plstripd.
6930 xspec (PLCHAR_VECTOR, input) : An ascii character string containing
6931 the x-axis specification
as in plbox.
6933 yspec (PLCHAR_VECTOR, input) : An ascii character string containing
6934 the y-axis specification
as in plbox.
6936 xmin (PLFLT, input) : Initial coordinates of plot box; they will
6937 change
as data are added.
6939 xmax (PLFLT, input) : Initial coordinates of plot box; they will
6940 change
as data are added.
6942 xjump (PLFLT, input) : When x attains xmax, the length of the plot
6943 is multiplied by the factor (1 +
6946 ymin (PLFLT, input) : Initial coordinates of plot box; they will
6947 change
as data are added.
6949 ymax (PLFLT, input) : Initial coordinates of plot box; they will
6950 change
as data are added.
6952 xlpos (PLFLT, input) : X legend box position (range
from 0 to 1).
6954 ylpos (PLFLT, input) : Y legend box position (range
from 0 to 1).
6956 y_ascl (PLBOOL, input) : Autoscale y between x jumps
if y_ascl
is
6957 true, otherwise
not.
6959 acc (PLBOOL, input) : Accumulate strip plot
if acc
is true,
6960 otherwise slide display.
6962 colbox (PLINT, input) : Plot box color index (cmap0).
6964 collab (PLINT, input) : Legend color index (cmap0).
6966 colline (PLINT_VECTOR, input) : A vector containing the cmap0 color
6967 indices
for the 4 pens.
6969 styline (PLINT_VECTOR, input) : A vector containing the line style
6970 indices
for the 4 pens.
6972 legline (PLCHAR_MATRIX, input) : A vector of UTF-8 character
6973 strings containing legends
for the 4 pens.
6975 labx (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6976 the label
for the x axis.
6978 laby (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6979 the label
for the y axis.
6981 labtop (PLCHAR_VECTOR, input) : A UTF-8 character string containing
6985 return _plplotc.plstripc(xspec, yspec, xmin, xmax, xjump, ymin, ymax, xlpos, ylpos, y_ascl, acc, colbox, collab, Array, ArrayCk, legline, labx, laby, labtop)
6989 Deletes and releases memory used by a strip chart
6993 Deletes
and releases memory used by a strip chart.
6997 This function
is used
in example 17.
7007 id (PLINT, input) : Identification number of strip chart to delete.
7010 return _plplotc.plstripd(id)
7018 This sets up the line style for all lines subsequently drawn. A line
7019 consists of segments
in which the pen
is alternately down
and up. The
7020 lengths of these segments are passed
in the vectors mark
and space
7021 respectively. The number of mark-space pairs
is specified by nms. In
7022 order to
return the line style to the default continuous line, plstyl
7023 should be called
with nms =0 .(see also pllsty)
7025 Redacted form:
plstyl(mark, space)
7027 This function
is used
in examples 1, 9,
and 14.
7037 nms (PLINT, input) : The number of mark
and space elements
in a
7038 line. Thus a simple broken line can be obtained by setting nms=1
7039 . A continuous line
is specified by setting nms=0 .
7041 mark (PLINT_VECTOR, input) : A vector containing the lengths of the
7042 segments during which the pen
is down, measured
in micrometers.
7044 space (PLINT_VECTOR, input) : A vector containing the lengths of
7045 the segments during which the pen
is up, measured
in micrometers.
7048 return _plplotc.plstyl(n, ArrayCk)
7052 Set arrow style for vector plots
7056 Set the style
for the arrow used by plvect to plot vectors.
7058 Redacted form:
plsvect(arrowx, arrowy, fill)
7060 This function
is used
in example 22.
7066 plsvect(arrowx, arrowy, npts, fill)
7070 arrowx, arrowy (PLFLT_VECTOR, input) : A pair of vectors containing
7071 the x
and y points which make up the arrow. The arrow
is plotted
7072 by joining these points to form a polygon. The scaling assumes
7073 that the x
and y points
in the arrow lie
in the range -0.5 <= x,y
7074 <= 0.5. If both arrowx
and arrowy are NULL then the arrow style
7075 will be reset to its default.
7077 npts (PLINT, input) : Number of points
in the vectors arrowx
and
7080 fill (PLBOOL, input) : If fill
is true then the arrow
is closed,
if
7081 fill
is false then the arrow
is open.
7084 return _plplotc.plsvect(ArrayNull, ArrayCkNull, deffalse)
7088 Specify viewport in absolute coordinates
7092 Alternate routine to plvpor
for setting up the viewport. This routine
7093 should be used only
if the viewport
is required to have a definite
7094 size
in millimeters. The routine plgspa
is useful
for finding out the
7095 size of the current subpage.
7097 Redacted form:
plsvpa(xmin, xmax, ymin, ymax)
7099 This function
is used
in example 10.
7105 plsvpa(xmin, xmax, ymin, ymax)
7109 xmin (PLFLT, input) : The distance of the left-hand edge of the
7110 viewport
from the left-hand edge of the subpage
in millimeters.
7112 xmax (PLFLT, input) : The distance of the right-hand edge of the
7113 viewport
from the left-hand edge of the subpage
in millimeters.
7115 ymin (PLFLT, input) : The distance of the bottom edge of the
7116 viewport
from the bottom edge of the subpage
in millimeters.
7118 ymax (PLFLT, input) : The distance of the top edge of the viewport
7119 from the bottom edge of the subpage
in millimeters.
7122 return _plplotc.plsvpa(xmin, xmax, ymin, ymax)
7126 Set x axis parameters
7130 Sets values of the digmax and digits flags
for the x axis. See the
7131 PLplot documentation
for more information.
7133 Redacted form:
plsxax(digmax, digits)
7135 This function
is used
in example 31.
7145 digmax (PLINT, input) : Variable to set the maximum number of
7146 digits
for the x axis. If nonzero, the printed label will be
7147 switched to a floating-point representation when the number of
7148 digits exceeds digmax.
7150 digits (PLINT, input) : Field digits value. Currently, changing
7151 its value here has no effect since it
is set only by plbox
or
7152 plbox3. However, the user may obtain its value after a call to
7153 either of these functions by calling plgxax.
7156 return _plplotc.plsxax(digmax, digits)
7160 Set y axis parameters
7164 Identical to plsxax, except that arguments are flags
for y axis. See
7165 the description of plsxax
for more detail.
7167 Redacted form:
plsyax(digmax, digits)
7169 This function
is used
in examples 1, 14,
and 31.
7179 digmax (PLINT, input) : Variable to set the maximum number of
7180 digits
for the y axis. If nonzero, the printed label will be
7181 switched to a floating-point representation when the number of
7182 digits exceeds digmax.
7184 digits (PLINT, input) : Field digits value. Currently, changing
7185 its value here has no effect since it
is set only by plbox
or
7186 plbox3. However, the user may obtain its value after a call to
7187 either of these functions by calling plgyax.
7190 return _plplotc.plsyax(digmax, digits)
7194 Plot a glyph at the specified points
7198 Plot a glyph at the specified points. (This function is largely
7199 superseded by plstring which gives access to many[!] more glyphs.)
7201 Redacted form:
plsym(x, y, code)
7203 This function
is used
in example 7.
7209 plsym(n, x, y, code)
7213 n (PLINT, input) : Number of points
in the x
and y vectors.
7215 x (PLFLT_VECTOR, input) : A vector containing the x coordinates of
7218 y (PLFLT_VECTOR, input) : A vector containing the y coordinates of
7221 code (PLINT, input) : Hershey symbol code corresponding to a glyph
7222 to be plotted at each of the n points.
7225 return _plplotc.plsym(n, ArrayCk, code)
7229 Set z axis parameters
7233 Identical to plsxax, except that arguments are flags
for z axis. See
7234 the description of plsxax
for more detail.
7236 Redacted form:
plszax(digmax, digits)
7238 This function
is used
in example 31.
7248 digmax (PLINT, input) : Variable to set the maximum number of
7249 digits
for the z axis. If nonzero, the printed label will be
7250 switched to a floating-point representation when the number of
7251 digits exceeds digmax.
7253 digits (PLINT, input) : Field digits value. Currently, changing
7254 its value here has no effect since it
is set only by plbox
or
7255 plbox3. However, the user may obtain its value after a call to
7256 either of these functions by calling plgzax.
7259 return _plplotc.plszax(digmax, digits)
7263 Switch to text screen
7267 Sets an interactive device to text mode, used in conjunction
with
7268 plgra to allow graphics
and text to be interspersed. On a device
7269 which supports separate text
and graphics windows, this command causes
7270 control to be switched to the text window. This can be useful
for
7271 printing diagnostic messages
or getting user input, which would
7272 otherwise interfere
with the plots. The program must switch back to
7273 the graphics window before issuing plot commands,
as the text (
or
7274 console) device will probably become quite confused otherwise. If
7275 already
in text mode, this command
is ignored. It
is also ignored on
7276 devices which only support a single window
or use a different method
7277 for shifting focus (see also plgra).
7281 This function
is used
in example 1.
7290 return _plplotc.pltext()
7294 Set format for date / time labels
7298 Sets the format
for date / time labels. To enable date / time format
7299 labels see the options to plbox, plbox3,
and plenv.
7303 This function
is used
in example 29.
7313 fmt (PLCHAR_VECTOR, input) : An ascii character string which
is
7314 interpreted similarly to the format specifier of typical system
7315 strftime routines
except that PLplot ignores locale
and also
7316 supplies some useful extensions
in the context of plotting. All
7317 text
in the string
is printed
as-
is other than conversion
7318 specifications which take the form of a
'%' character followed by
7319 further conversion specification character. The conversion
7320 specifications which are similar to those provided by system
7321 strftime routines are the following: %a: The abbreviated (English)
7323 %A: The full (English) weekday name.
7324 %b: The abbreviated (English) month name.
7325 %B: The full (English) month name.
7326 %c: Equivalent to %a %b %d %T %Y (non-ISO).
7327 %C: The century number (year/100)
as a 2-digit integer.
7328 %d: The day of the month
as a decimal number (range 01 to 31).
7329 %D: Equivalent to %m/%d/%y (non-ISO).
7330 %e: Like %d, but a leading zero
is replaced by a space.
7331 %F: Equivalent to %Y-%m-%d (the ISO 8601 date format).
7332 %h: Equivalent to %b.
7333 %H: The hour
as a decimal number using a 24-hour clock (range
7335 %I: The hour
as a decimal number using a 12-hour clock (range
7337 %j: The day of the year
as a decimal number (range 001 to
7339 %k: The hour (24-hour clock)
as a decimal number (range 0 to
7340 23); single digits are preceded by a blank. (See also %H.)
7341 %l: The hour (12-hour clock)
as a decimal number (range 1 to
7342 12); single digits are preceded by a blank. (See also %I.)
7343 %m: The month
as a decimal number (range 01 to 12).
7344 %M: The minute
as a decimal number (range 00 to 59).
7345 %n: A newline character.
7346 %p: Either
"AM" or "PM" according to the given time value.
7347 Noon
is treated
as "PM" and midnight
as "AM".
7348 %r: Equivalent to %I:%M:%S %p.
7349 %R: The time
in 24-hour notation (%H:%M). For a version
7350 including the seconds, see %T below.
7351 %s: The number of seconds since the Epoch, 1970-01-01 00:00:00
7353 %S: The second
as a decimal number (range 00 to 60). (The
7354 range
is up to 60 to allow
for occasional leap seconds.)
7355 %t: A tab character.
7356 %T: The time
in 24-hour notation (%H:%M:%S).
7357 %u: The day of the week
as a decimal, range 1 to 7, Monday
7358 being 1. See also %w.
7359 %U: The week number of the current year
as a decimal number,
7360 range 00 to 53, starting
with the first Sunday
as the first
7361 day of week 01. See also %V
and %W.
7362 %v: Equivalent to %e-%b-%Y.
7363 %V: The ISO 8601 week number of the current year
as a decimal
7364 number, range 01 to 53, where week 1
is the first week that
7365 has at least 4 days
in the new year. See also %U
and %W.
7366 %w: The day of the week
as a decimal, range 0 to 6, Sunday
7367 being 0. See also %u.
7368 %W: The week number of the current year
as a decimal number,
7369 range 00 to 53, starting
with the first Monday
as the first
7371 %x: Equivalent to %a %b %d %Y.
7372 %X: Equivalent to %T.
7373 %y: The year
as a decimal number without a century (range 00
7375 %Y: The year
as a decimal number including a century.
7376 %z: The UTC time-zone string =
"+0000".
7377 %Z: The UTC time-zone abbreviation =
"UTC".
7378 %+: The UTC date
and time
in default format of the Unix date
7379 command which
is equivalent to %a %b %d %T %Z %Y.
7380 %%: A literal
"%" character.
7381 The conversion specifications which are extensions to those normally
7382 provided by system strftime routines are the following: %(0-9):
7383 The fractional part of the seconds field (including leading
7384 decimal point) to the specified accuracy. Thus %S%3 would give
7385 seconds to millisecond accuracy (00.000).
7386 %.: The fractional part of the seconds field (including
7387 leading decimal point) to the maximum available accuracy. Thus
7388 %S%. would give seconds
with fractional part up to 9 decimal
7389 places
if available.
7392 return _plplotc.pltimefmt(fmt)
7396 Specify viewport using aspect ratio only
7400 Selects the largest viewport with the given aspect ratio within the
7401 subpage that leaves a standard margin (left-hand margin of eight
7402 character heights,
and a margin around the other three sides of five
7405 Redacted form:
plvasp(aspect)
7407 This function
is used
in example 13.
7417 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7418 axis of resulting viewport.
7421 return _plplotc.plvasp(aspect)
7429 Draws a plot of vector data contained in the matrices (
7435 ny]) . The scaling factor
for the vectors
is given by scale. A
7436 transformation routine pointed to by pltr
with a pointer pltr_data
for
7437 additional data required by the transformation routine to map indices
7438 within the matrices to the world coordinates. The style of the vector
7439 arrow may be set using plsvect.
7441 Redacted form:
plvect(u, v, scale, pltr, pltr_data) where (see above
7442 discussion) the pltr, pltr_data callback arguments are sometimes
7443 replaced by a tr vector
with 6 elements,
or xg
and yg array arguments
7444 with either one
or two dimensions.
7446 This function
is used
in example 22.
7452 plvect(u, v, nx, ny, scale, pltr, pltr_data)
7456 u, v (PLFLT_MATRIX, input) : A pair of matrices containing the x
7457 and y components of the vector data to be plotted.
7459 nx, ny (PLINT, input) : Dimensions of the matrices u
and v.
7461 scale (PLFLT, input) : Parameter to control the scaling factor of
7462 the vectors
for plotting. If scale = 0 then the scaling factor
is
7463 automatically calculated
for the data. If scale < 0 then the
7464 scaling factor
is automatically calculated
for the data
and then
7466 scale. If scale > 0 then the scaling factor
is set to scale.
7468 pltr (PLTRANSFORM_callback, input) : A callback function that
7469 defines the transformation between the zero-based indices of the
7470 matrices u
and v
and world coordinates.For the C case,
7471 transformation functions are provided
in the PLplot library: pltr0
7472 for the identity mapping,
and pltr1
and pltr2
for arbitrary
7473 mappings respectively defined by vectors
and matrices. In
7474 addition, C callback routines
for the transformation can be
7475 supplied by the user such
as the mypltr function
in
7476 examples/c/x09c.c which provides a general linear transformation
7477 between index coordinates
and world coordinates.For languages
7478 other than C you should consult the PLplot documentation
for the
7479 details concerning how PLTRANSFORM_callback arguments are
7480 interfaced. However,
in general, a particular pattern of
7481 callback-associated arguments such
as a tr vector
with 6 elements;
7482 xg
and yg vectors;
or xg
and yg matrices are respectively
7483 interfaced to a linear-transformation routine similar to the above
7484 mypltr function; pltr1;
and pltr2. Furthermore, some of our more
7485 sophisticated bindings (see, e.g., the PLplot documentation)
7486 support native language callbacks
for handling index to
7487 world-coordinate transformations. Examples of these various
7488 approaches are given
in examples/<language>x09*,
7489 examples/<language>x16*, examples/<language>x20*,
7490 examples/<language>x21*,
and examples/<language>x22*,
for all our
7491 supported languages.
7493 pltr_data (PLPointer, input) : Extra parameter to help
pass
7494 information to pltr0, pltr1, pltr2,
or whatever callback routine
7495 that
is externally supplied.
7498 return _plplotc.plvect(*args)
7502 Specify viewport using coordinates and aspect ratio
7506 Device-independent routine
for setting up the viewport. The viewport
7507 is chosen to be the largest
with the given aspect ratio that fits
7508 within the specified region (
in terms of normalized subpage
7509 coordinates). This routine
is functionally equivalent to plvpor when
7510 a ``natural
'' aspect ratio (0.0)
is chosen. Unlike plvasp, this
7511 routine reserves no extra space at the edges
for labels.
7513 Redacted form:
plvpas(xmin, xmax, ymin, ymax, aspect)
7515 This function
is used
in example 9.
7521 plvpas(xmin, xmax, ymin, ymax, aspect)
7525 xmin (PLFLT, input) : The normalized subpage coordinate of the
7526 left-hand edge of the viewport.
7528 xmax (PLFLT, input) : The normalized subpage coordinate of the
7529 right-hand edge of the viewport.
7531 ymin (PLFLT, input) : The normalized subpage coordinate of the
7532 bottom edge of the viewport.
7534 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7535 edge of the viewport.
7537 aspect (PLFLT, input) : Ratio of length of y axis to length of x
7541 return _plplotc.plvpas(xmin, xmax, ymin, ymax, aspect)
7545 Specify viewport using normalized subpage coordinates
7549 Device-independent routine for setting up the viewport. This defines
7550 the viewport
in terms of normalized subpage coordinates which run
from
7551 0.0 to 1.0 (left to right
and bottom to top) along each edge of the
7552 current subpage. Use the alternate routine plsvpa
in order to create
7553 a viewport of a definite size.
7555 Redacted form:
plvpor(xmin, xmax, ymin, ymax)
7557 This function
is used
in examples 2, 6-8, 10, 11, 15, 16, 18, 21, 23,
7564 plvpor(xmin, xmax, ymin, ymax)
7568 xmin (PLFLT, input) : The normalized subpage coordinate of the
7569 left-hand edge of the viewport.
7571 xmax (PLFLT, input) : The normalized subpage coordinate of the
7572 right-hand edge of the viewport.
7574 ymin (PLFLT, input) : The normalized subpage coordinate of the
7575 bottom edge of the viewport.
7577 ymax (PLFLT, input) : The normalized subpage coordinate of the top
7578 edge of the viewport.
7581 return _plplotc.plvpor(xmin, xmax, ymin, ymax)
7585 Select standard viewport
7589 Selects the largest viewport within the subpage that leaves a standard
7590 margin (left-hand margin of eight character heights, and a margin
7591 around the other three sides of five character heights).
7595 This function
is used
in examples 1, 12, 14, 17, 25,
and 29.
7604 return _plplotc.plvsta()
7606def plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az):
7608 Configure the transformations required for projecting a 3D surface on a 2D window
7612 Configure the transformations required
for projecting a 3D surface on
7613 an existing 2D window. Those transformations (see the PLplot
7614 documentation) are done to a rectangular cuboid enclosing the 3D
7615 surface which has its limits expressed
in 3D world coordinates
and
7616 also normalized 3D coordinates (used
for interpreting the altitude
and
7617 azimuth of the viewing angle). The transformations consist of the
7618 linear transform
from 3D world coordinates to normalized 3D
7619 coordinates,
and the 3D rotation of normalized coordinates required to
7620 align the pole of the new 3D coordinate system
with the viewing
7621 direction specified by altitude
and azimuth so that x
and y of the
7622 surface elements
in that transformed coordinate system are the
7623 projection of the 3D surface
with given viewing direction on the 2D
7626 The enclosing rectangular cuboid
for the surface plot
is defined by
7627 xmin, xmax, ymin, ymax, zmin
and zmax
in 3D world coordinates. It
is
7628 mapped into the same rectangular cuboid
with normalized 3D coordinate
7629 sizes of basex by basey by height so that xmin maps to -
7630 basex/2, xmax maps to basex/2, ymin maps to -
7631 basey/2, ymax maps to basey/2, zmin maps to 0
and zmax maps to height.
7632 The resulting rectangular cuboid
in normalized coordinates
is then
7633 viewed by an observer at altitude alt
and azimuth az. This routine
7634 must be called before plbox3
or any of the 3D surface plotting
7635 routines; plmesh, plmeshc, plot3d, plot3dc, plot3dcl, plsurf3d,
7636 plsurf3dl
or plfill3.
7638 Redacted form:
plw3d(basex, basey, height, xmin, xmax, ymin, ymax,
7639 zmin, zmax, alt, az)
7641 This function
is examples 8, 11, 18,
and 21.
7647 plw3d(basex, basey, height, xmin, xmax, ymin, ymax, zmin, zmax, alt, az)
7651 basex (PLFLT, input) : The normalized x coordinate size of the
7654 basey (PLFLT, input) : The normalized y coordinate size of the
7657 height (PLFLT, input) : The normalized z coordinate size of the
7660 xmin (PLFLT, input) : The minimum x world coordinate of the
7663 xmax (PLFLT, input) : The maximum x world coordinate of the
7666 ymin (PLFLT, input) : The minimum y world coordinate of the
7669 ymax (PLFLT, input) : The maximum y world coordinate of the
7672 zmin (PLFLT, input) : The minimum z world coordinate of the
7675 zmax (PLFLT, input) : The maximum z world coordinate of the
7678 alt (PLFLT, input) : The viewing altitude
in degrees above the xy
7679 plane of the rectangular cuboid
in normalized coordinates.
7681 az (PLFLT, input) : The viewing azimuth
in degrees of the
7682 rectangular cuboid
in normalized coordinates. When az=0, the
7683 observer
is looking face onto the zx plane of the rectangular
7684 cuboid
in normalized coordinates,
and as az
is increased, the
7685 observer moves clockwise around that cuboid when viewed
from above
7689 return _plplotc.plw3d(basex, basey, height, xmin0, xmax0, ymin0, ymax0, zmin0, zmax0, alt, az)
7701 This function is used
in examples 1
and 2.
7711 width (PLFLT, input) : The desired pen width. If width
is negative
7712 or the same
as the previous value no action
is taken. width = 0.
7713 should be interpreted
as as the minimum valid pen width
for the
7714 device. The interpretation of positive width values
is also
7718 return _plplotc.plwidth(width)
7726 Specify the window, i.e., the world coordinates of the edges of the
7729 Redacted form: plwind(xmin, xmax, ymin, ymax)
7731 This function is used
in examples 1, 2, 4, 6-12, 14-16, 18, 21, 23-27,
7738 plwind(xmin, xmax, ymin, ymax)
7742 xmin (PLFLT, input) : The world x coordinate of the left-hand edge
7745 xmax (PLFLT, input) : The world x coordinate of the right-hand edge
7748 ymin (PLFLT, input) : The world y coordinate of the bottom edge of
7751 ymax (PLFLT, input) : The world y coordinate of the top edge of the
7755 return _plplotc.plwind(xmin, xmax, ymin, ymax)
7759 Enter or leave xor mode
7763 Enter (when mode
is true)
or leave (when mode
is false) xor mode
for
7764 those drivers (e.g., the xwin driver) that support it. Enables
7765 erasing plots by drawing twice the same line, symbol, etc. If driver
7766 is not capable of xor operation it returns a status of false.
7768 Redacted form:
plxormod(mode, status)
7770 This function
is used
in examples 1
and 20.
7780 mode (PLBOOL, input) : mode
is true means enter xor mode
and mode
7781 is false means leave xor mode.
7783 status (PLBOOL_NC_SCALAR, output) : Returned value of the status.
7784 modestatus of true (false) means driver
is capable (incapable) of
7788 return _plplotc.plxormod(mode)
7790def plmap(mapform, type, minx, maxx, miny, maxy):
7792 Plot continental outline or shapefile data
in world coordinates
7796 Plots continental outlines
or shapefile data
in world coordinates. A
7797 demonstration of how to use this function to create different
7798 projections can be found
in examples/c/x19c. PLplot
is provided
with
7799 basic coastal outlines
and USA state borders. To use the map
7800 functionality PLplot must be compiled
with the shapelib library.
7801 Shapefiles have become a popular standard
for geographical data
and
7802 data
in this format can be easily found
from a number of online
7803 sources. Shapefile data
is actually provided
as three
or more files
7804 with the same filename, but different extensions. The .shp
and .shx
7805 files are required
for plotting Shapefile data
with PLplot.
7807 PLplot currently supports the point, multipoint, polyline
and polygon
7808 objects within shapefiles. However holes
in polygons are
not
7809 supported. When plmap
is used the type of object
is derived
from the
7810 shapefile,
if you wish to override the type then use one of the other
7811 plmap variants. The built
in maps have line data only.
7813 Redacted form:
plmap(mapform, name, minx, maxx, miny, maxy)
7815 This function
is used
in example 19.
7821 plmap(mapform, name, minx, maxx, miny, maxy)
7825 mapform (PLMAPFORM_callback, input) : A user supplied function to
7826 transform the original map data coordinates to a new coordinate
7827 system. The PLplot-supplied map data
is provided
as latitudes
and
7828 longitudes; other Shapefile data may be provided
in other
7829 coordinate systems
as can be found
in their .prj plain text files.
7830 For example, by using this transform we can change
from a
7831 longitude, latitude coordinate to a polar stereographic
7832 projection. Initially, x[0]..[n-1] are the original x coordinates
7833 (longitudes
for the PLplot-supplied data)
and y[0]..y[n-1] are the
7834 corresponding y coordinates (latitudes
for the PLplot supplied
7835 data). After the call to
mapform(), x[]
and y[] should be
7836 replaced by the corresponding plot coordinates. If no transform
is
7837 desired, mapform can be replaced by NULL.
7839 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7840 the type of map plotted. This
is either one of the PLplot built-
in
7841 maps
or the file name of a set of Shapefile files without the file
7842 extensions. For the PLplot built-
in maps the possible values are:
7843 "globe" -- continental outlines
7844 "usa" -- USA
and state boundaries
7845 "cglobe" -- continental outlines
and countries
7846 "usaglobe" -- USA, state boundaries
and continental outlines
7849 minx (PLFLT, input) : The minimum x value of map elements to be
7850 drawn. The units must match the shapefile (built
in maps are
7851 degrees lat/lon). Objects
in the file which do
not encroach on the
7852 box defined by minx, maxx, miny, maxy will
not be rendered. But
7853 note this
is simply an optimisation,
not a clipping so
for objects
7854 with some points inside the box
and some points outside the box
7855 all the points will be rendered. These parameters also define
7856 latitude
and longitude wrapping
for shapefiles using these units.
7857 Longitude points will be wrapped by integer multiples of 360
7858 degrees to place them
in the box. This allows the same data to be
7859 used on plots
from -180-180
or 0-360 longitude ranges. In fact
if
7860 you plot
from -180-540 you will get two cycles of data drawn. The
7861 value of minx must be less than the value of maxx. Passing
in a
7862 nan, max/-max floating point number
or +/-infinity will case the
7863 bounding box
from the shapefile to be used.
7865 maxx (PLFLT, input) : The maximum x value of map elements to be
7868 miny (PLFLT, input) : The minimum y value of map elements to be
7871 maxy (PLFLT, input) : The maximum y value of map elements to be
7875 return _plplotc.plmap(mapform, type, minx, maxx, miny, maxy)
7877def plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull):
7879 Plot all or a subset of Shapefile data using lines
in world coordinates
7883 Plot all
or a subset of Shapefile data using lines
in world
7884 coordinates. Our 19th standard example demonstrates how to use this
7885 function. This function plots data
from a Shapefile using lines
as in
7886 plmap, however it also has the option of also only drawing specified
7887 elements
from the Shapefile. The vector of indices of the required
7888 elements are passed
as a function argument. The Shapefile data should
7889 include a metadata file (extension.dbf) listing all items within the
7890 Shapefile. This file can be opened by most popular spreadsheet
7891 programs
and can be used to decide which indices to
pass to this
7894 Redacted form:
plmapline(mapform, name, minx, maxx, miny, maxy,
7897 This function
is used
in example 19.
7903 plmapline(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
7907 mapform (PLMAPFORM_callback, input) : A user supplied function to
7908 transform the coordinates given
in the shapefile into a plot
7909 coordinate system. By using this transform, we can change
from a
7910 longitude, latitude coordinate to a polar stereographic project,
7911 for example. Initially, x[0]..[n-1] are the longitudes
and
7912 y[0]..y[n-1] are the corresponding latitudes. After the call to
7913 mapform(), x[]
and y[] should be replaced by the corresponding
7914 plot coordinates. If no transform
is desired, mapform can be
7917 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7918 the file name of a set of Shapefile files without the file
7921 minx (PLFLT, input) : The minimum x value to be plotted. This must
7922 be
in the same units
as used by the Shapefile. You could use a
7923 very large negative number to plot everything, but you can improve
7924 performance by limiting the area drawn. The units must match those
7925 of the Shapefile projection, which may be
for example longitude
or
7926 distance. The value of minx must be less than the value of maxx.
7928 maxx (PLFLT, input) : The maximum x value to be plotted. You could
7929 use a very large number to plot everything, but you can improve
7930 performance by limiting the area drawn.
7932 miny (PLFLT, input) : The minimum y value to be plotted. This must
7933 be
in the same units
as used by the Shapefile. You could use a
7934 very large negative number to plot everything, but you can improve
7935 performance by limiting the area drawn. The units must match those
7936 of the Shapefile projection, which may be
for example latitude
or
7937 distance. The value of miny must be less than the value of maxy.
7939 maxy (PLFLT, input) : The maximum y value to be plotted. You could
7940 use a very large number to plot everything, but you can improve
7941 performance by limiting the area drawn.
7943 plotentries (PLINT_VECTOR, input) : A vector containing the
7944 zero-based indices of the Shapefile elements which will be drawn.
7946 plotentries to NULL will plot all elements of the Shapefile.
7948 nplotentries (PLINT, input) : The number of items
in
7949 plotentries. Ignored
if
7950 plotentries
is NULL.
7953 return _plplotc.plmapline(mapform, type, minx, maxx, miny, maxy, ArrayNull)
7955def plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull):
7957 Plot all or a subset of Shapefile data using strings
or points
in world coordinates
7961 As per plmapline, however the items are plotted
as strings
or points
7962 in the same way
as plstring.
7964 Redacted form:
plmapstring(mapform, name, string, minx, maxx, miny,
7967 This function
is not used
in any examples.
7973 plmapstring(mapform, name, string, minx, maxx, miny, maxy, plotentries, nplotentries)
7977 mapform (PLMAPFORM_callback, input) : A user supplied function to
7978 transform the coordinates given
in the shapefile into a plot
7979 coordinate system. By using this transform, we can change
from a
7980 longitude, latitude coordinate to a polar stereographic project,
7981 for example. Initially, x[0]..[n-1] are the longitudes
and
7982 y[0]..y[n-1] are the corresponding latitudes. After the call to
7983 mapform(), x[]
and y[] should be replaced by the corresponding
7984 plot coordinates. If no transform
is desired, mapform can be
7987 name (PLCHAR_VECTOR, input) : An ascii character string specifying
7988 the file name of a set of Shapefile files without the file
7991 string (PLCHAR_VECTOR, input) : A UTF-8 character string to be
7994 minx (PLFLT, input) : The minimum x value to be plotted. This must
7995 be
in the same units
as used by the Shapefile. You could use a
7996 very large negative number to plot everything, but you can improve
7997 performance by limiting the area drawn. The units must match those
7998 of the Shapefile projection, which may be
for example longitude
or
7999 distance. The value of minx must be less than the value of maxx.
8001 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8002 use a very large number to plot everything, but you can improve
8003 performance by limiting the area drawn.
8005 miny (PLFLT, input) : The minimum y value to be plotted. This must
8006 be
in the same units
as used by the Shapefile. You could use a
8007 very large negative number to plot everything, but you can improve
8008 performance by limiting the area drawn. The units must match those
8009 of the Shapefile projection, which may be
for example latitude
or
8010 distance. The value of miny must be less than the value of maxy.
8012 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8013 use a very large number to plot everything, but you can improve
8014 performance by limiting the area drawn.
8016 plotentries (PLINT_VECTOR, input) : A vector containing the
8017 zero-based indices of the Shapefile elements which will be drawn.
8019 plotentries to NULL will plot all elements of the Shapefile.
8021 nplotentries (PLINT, input) : The number of items
in
8022 plotentries. Ignored
if
8023 plotentries
is NULL.
8026 return _plplotc.plmapstring(mapform, type, string, minx, maxx, miny, maxy, ArrayNull)
8028def plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry):
8030 Draw text at points defined by Shapefile data in world coordinates
8034 As per plmapline, however the items are plotted
as text
in the same
8037 Redacted form:
plmaptex(mapform, name, dx, dy, just, text, minx, maxx,
8038 miny, maxy, plotentry)
8040 This function
is used
in example 19.
8046 plmaptex(mapform, name, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8050 mapform (PLMAPFORM_callback, input) : A user supplied function to
8051 transform the coordinates given
in the shapefile into a plot
8052 coordinate system. By using this transform, we can change
from a
8053 longitude, latitude coordinate to a polar stereographic project,
8054 for example. Initially, x[0]..[n-1] are the longitudes
and
8055 y[0]..y[n-1] are the corresponding latitudes. After the call to
8056 mapform(), x[]
and y[] should be replaced by the corresponding
8057 plot coordinates. If no transform
is desired, mapform can be
8060 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8061 the file name of a set of Shapefile files without the file
8064 dx (PLFLT, input) : Used to define the slope of the texts which
is
8067 dy (PLFLT, input) : Used to define the slope of the texts which
is
8070 just (PLFLT, input) : Set the justification of the text. The value
8071 given will be the fraction of the distance along the string that
8072 sits at the given point. 0.0 gives left aligned text, 0.5 gives
8073 centralized text
and 1.0 gives right aligned text.
8075 text (PLCHAR_VECTOR, input) : A UTF-8 character string to be drawn.
8077 minx (PLFLT, input) : The minimum x value to be plotted. This must
8078 be
in the same units
as used by the Shapefile. You could use a
8079 very large negative number to plot everything, but you can improve
8080 performance by limiting the area drawn. The units must match those
8081 of the Shapefile projection, which may be
for example longitude
or
8082 distance. The value of minx must be less than the value of maxx.
8084 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8085 use a very large number to plot everything, but you can improve
8086 performance by limiting the area drawn.
8088 miny (PLFLT, input) : The minimum y value to be plotted. This must
8089 be
in the same units
as used by the Shapefile. You could use a
8090 very large negative number to plot everything, but you can improve
8091 performance by limiting the area drawn. The units must match those
8092 of the Shapefile projection, which may be
for example latitude
or
8093 distance. The value of miny must be less than the value of maxy.
8095 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8096 use a very large number to plot everything, but you can improve
8097 performance by limiting the area drawn.
8099 plotentry (PLINT, input) : An integer indicating which text string
8100 of the Shapefile (zero indexed) will be drawn.
8103 return _plplotc.plmaptex(mapform, type, dx, dy, just, text, minx, maxx, miny, maxy, plotentry)
8105def plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull):
8107 Plot all or a subset of Shapefile data, filling the polygons
8111 As per plmapline, however the items are filled
in the same way
as
8114 Redacted form:
plmapfill(mapform, name, minx, maxx, miny, maxy,
8117 This function
is used
in example 19.
8123 plmapfill(mapform, name, minx, maxx, miny, maxy, plotentries, nplotentries)
8127 mapform (PLMAPFORM_callback, input) : A user supplied function to
8128 transform the coordinates given
in the shapefile into a plot
8129 coordinate system. By using this transform, we can change
from a
8130 longitude, latitude coordinate to a polar stereographic project,
8131 for example. Initially, x[0]..[n-1] are the longitudes
and
8132 y[0]..y[n-1] are the corresponding latitudes. After the call to
8133 mapform(), x[]
and y[] should be replaced by the corresponding
8134 plot coordinates. If no transform
is desired, mapform can be
8137 name (PLCHAR_VECTOR, input) : An ascii character string specifying
8138 the file name of a set of Shapefile files without the file
8141 minx (PLFLT, input) : The minimum x value to be plotted. This must
8142 be
in the same units
as used by the Shapefile. You could use a
8143 very large negative number to plot everything, but you can improve
8144 performance by limiting the area drawn. The units must match those
8145 of the Shapefile projection, which may be
for example longitude
or
8146 distance. The value of minx must be less than the value of maxx.
8148 maxx (PLFLT, input) : The maximum x value to be plotted. You could
8149 use a very large number to plot everything, but you can improve
8150 performance by limiting the area drawn.
8152 miny (PLFLT, input) : The minimum y value to be plotted. This must
8153 be
in the same units
as used by the Shapefile. You could use a
8154 very large negative number to plot everything, but you can improve
8155 performance by limiting the area drawn. The units must match those
8156 of the Shapefile projection, which may be
for example latitude
or
8157 distance. The value of miny must be less than the value of maxy.
8159 maxy (PLFLT, input) : The maximum y value to be plotted. You could
8160 use a very large number to plot everything, but you can improve
8161 performance by limiting the area drawn.
8163 plotentries (PLINT_VECTOR, input) : A vector containing the
8164 zero-based indices of the Shapefile elements which will be drawn.
8166 plotentries to NULL will plot all elements of the Shapefile.
8168 nplotentries (PLINT, input) : The number of items
in
8169 plotentries. Ignored
if
8170 plotentries
is NULL.
8173 return _plplotc.plmapfill(mapform, type, minx, maxx, miny, maxy, ArrayNull)
8175def plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat):
8177 Plot latitude and longitude lines
8181 Displays latitude
and longitude on the current plot. The lines are
8182 plotted
in the current color
and line style.
8184 Redacted form:
plmeridians(mapform, dlong, dlat, minlong, maxlong,
8187 This function
is used
in example 19.
8193 plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8197 mapform (PLMAPFORM_callback, input) : A user supplied function to
8198 transform the coordinate longitudes
and latitudes to a plot
8199 coordinate system. By using this transform, we can change
from a
8200 longitude, latitude coordinate to a polar stereographic project,
8201 for example. Initially, x[0]..[n-1] are the longitudes
and
8202 y[0]..y[n-1] are the corresponding latitudes. After the call to
8203 mapform(), x[]
and y[] should be replaced by the corresponding
8204 plot coordinates. If no transform
is desired, mapform can be
8207 dlong (PLFLT, input) : The interval
in degrees at which the
8208 longitude lines are to be plotted.
8210 dlat (PLFLT, input) : The interval
in degrees at which the latitude
8211 lines are to be plotted.
8213 minlong (PLFLT, input) : The value of the longitude on the left
8214 side of the plot. The value of minlong must be less than the value
8215 of maxlong,
and the quantity maxlong-minlong must be less than
or
8218 maxlong (PLFLT, input) : The value of the longitude on the right
8221 minlat (PLFLT, input) : The minimum latitude to be plotted on the
8222 background. One can always use -90.0
as the boundary outside the
8223 plot window will be automatically eliminated. However, the
8224 program will be faster
if one can reduce the size of the
8227 maxlat (PLFLT, input) : The maximum latitudes to be plotted on the
8228 background. One can always use 90.0
as the boundary outside the
8229 plot window will be automatically eliminated.
8232 return _plplotc.plmeridians(mapform, dlong, dlat, minlong, maxlong, minlat, maxlat)
8234def plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax):
8236 Plot a 2D matrix using cmap1 with automatic color adjustment
8240 Plot a 2D matrix using the cmap1 palette. The color scale
is
8241 automatically adjusted to use the maximum
and minimum values
in idata
8242 as valuemin
and valuemax
in a call to plimagefr.
8244 Redacted form: General:
plimage(idata, xmin, xmax, ymin, ymax, zmin,
8245 zmax, Dxmin, Dxmax, Dymin, Dymax)
8248 This function
is used
in example 20.
8254 plimage(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8258 idata (PLFLT_MATRIX, input) : A matrix containing function values
8259 to plot. Should have dimensions of
8263 nx, ny (PLINT, input) : Dimensions of idata
8265 xmin, xmax, ymin, ymax (PLFLT, input) : The x
and y index ranges
8266 are linearly transformed to these world coordinate ranges such
8267 that idata[0][0] corresponds to (xmin, ymin)
and idata[nx - 1][ny
8268 - 1] corresponds to (xmax, ymax).
8270 zmin, zmax (PLFLT, input) : Only data between zmin
and zmax
8271 (inclusive) will be plotted.
8273 Dxmin, Dxmax, Dymin, Dymax (PLFLT, input) : Plot only the window of
8274 points whose plot coordinates fall inside the window of (Dxmin,
8275 Dymin) to (Dxmax, Dymax).
8278 return _plplotc.plimage(Matrix, xmin, xmax, ymin, ymax, zmin, zmax, Dxmin, Dxmax, Dymin, Dymax)
8282 Plot a 2D matrix using cmap1
8286 Plot a 2D matrix using cmap1.
8288 Redacted form: General: plimagefr(idata, xmin, xmax, ymin, ymax, zmin,
8289 zmax, valuemin, valuemax, pltr, pltr_data)
8292 This function is used
in example 20.
8298 plimagefr(idata, nx, ny, xmin, xmax, ymin, ymax, zmin, zmax, valuemin, valuemax, pltr, pltr_data)
8302 idata (PLFLT_MATRIX, input) : A matrix of values (intensities) to
8303 plot. Should have dimensions of
8307 nx, ny (PLINT, input) : Dimensions of idata
8309 xmin, xmax, ymin, ymax (PLFLT, input) : See the discussion of
8310 pltr below
for how these arguments are used (only
for the special case
8311 when the callback function
8312 pltr
is not supplied).
8314 zmin, zmax (PLFLT, input) : Only data between zmin
and zmax
8315 (inclusive) will be plotted.
8317 valuemin, valuemax (PLFLT, input) : The minimum
and maximum data
8318 values to use
for value to color mappings. A datum equal to
or
8319 less than valuemin will be plotted
with color 0.0,
while a datum
8320 equal to
or greater than valuemax will be plotted
with color 1.0.
8321 Data between valuemin
and valuemax map linearly to colors
in the
8324 pltr (PLTRANSFORM_callback, input) : A callback function that
8325 defines the transformation between the zero-based indices of the
8326 matrix idata
and world coordinates. If
8327 pltr
is not supplied (e.g.,
is set to NULL
in the C case), then the x
8328 indices of idata are mapped to the range
8330 xmax
and the y indices of idata are mapped to the range
8332 ymax.For the C case, transformation functions are provided
in the
8333 PLplot library: pltr0
for the identity mapping,
and pltr1
and
8334 pltr2
for arbitrary mappings respectively defined by vectors
and
8335 matrices. In addition, C callback routines
for the transformation
8336 can be supplied by the user such
as the mypltr function
in
8337 examples/c/x09c.c which provides a general linear transformation
8338 between index coordinates
and world coordinates.For languages
8339 other than C you should consult the PLplot documentation
for the
8340 details concerning how PLTRANSFORM_callback arguments are
8341 interfaced. However,
in general, a particular pattern of
8342 callback-associated arguments such
as a tr vector
with 6 elements;
8343 xg
and yg vectors;
or xg
and yg matrices are respectively
8344 interfaced to a linear-transformation routine similar to the above
8345 mypltr function; pltr1;
and pltr2. Furthermore, some of our more
8346 sophisticated bindings (see, e.g., the PLplot documentation)
8347 support native language callbacks
for handling index to
8348 world-coordinate transformations. Examples of these various
8349 approaches are given
in examples/<language>x09*,
8350 examples/<language>x16*, examples/<language>x20*,
8351 examples/<language>x21*,
and examples/<language>x22*,
for all our
8352 supported languages.
8354 pltr_data (PLPointer, input) : Extra parameter to help
pass
8355 information to pltr0, pltr1, pltr2,
or whatever routine
is
8356 externally supplied.
8359 return _plplotc.plimagefr(*args)
8362 return _plplotc.plClearOpts()
8365 return _plplotc.plResetOpts()
8368 return _plplotc.plSetUsage(program_string, usage_string)
8371 return _plplotc.plOptUsage()
8374 return _plplotc.plMinMax2dGrid(Matrix)
8378 Wait for graphics input event
and translate to world coordinates.
8382 Wait
for graphics input event
and translate to world coordinates.
8383 Returns 0
if no translation to world coordinates
is possible.
8385 This function returns 1 on success
and 0
if no translation to world
8386 coordinates
is possible.
8390 This function
is used
in examples 1
and 20.
8400 gin (PLGraphicsIn *, output) : Pointer to PLGraphicsIn structure
8401 which will contain the output. The structure
is not allocated by
8402 the routine
and must exist before the function
is called.
8405 return _plplotc.plGetCursor(gin)
_swig_add_metaclass(metaclass)
plSetUsage(program_string, usage_string)
_swig_setattr_nondynamic_instance_variable(set)
_swig_setattr_nondynamic_class_variable(set)
#define pl_setcontlabelformat
#define pl_setcontlabelparam
void mapform(PLINT n, PLFLT *x, PLFLT *y)