DESL


DESL Home | Website Outline | Commands | Examples | Download | Contacts

( BR) Details concerning the DESL pubplot command.


(See example(s) of the use of the pubplot command.)
[Jump to the list of available options.]
General description of the pubplot command :

The DESL "pp" function allows the user to generate a PostScript file containing one or more frames of publication-qual graphic output.

Please review the anatomy of a plot for an overview of the main parts of a typical DESL plot.

A complete PostScript plot file can contain an unlimited number of frames. A "frame" is one page. Each frame can contain an unlimited number of plots. A "plot" is a display of information for up to 20 curves. A "curve" is a sequence of information which, in general, will be displayed together, represented by a certain symbol and/or line.
.

(Begin modifications on 052102)

All curves for a particular plot can contain a maximum of 50000 points.

(End modifications on 052102)

The time at which this total of points is established is AFTER

  1. global conditions
  2. file-specific conditions
  3. restrictions based on the "pseq" state eliminations
  4. data averaging has been applied but BEFORE (a) tolerance checks, (b) "voidval" checks, and data clipping occurs.
Plotting progresses from plot to plot until the time when a request for a new frame is implied (by "plotf"). After an advance to a new frame, (page), plotting can continue.

A "blank" box, filled or unfilled, is drawn before a key. A key is drawn before all "text" strings.

All LOCATION arguments which can be specified for "pp" options are in INCHES, unless otherwise stated. The default size of a plot is 10 inches by 10 inches. This size can be affected in many ways.

The "pp" function is unique among DESL functions in that the processing of specified options/argument lists is NOT totally order independent. Except where noted within the definition of specific options, the entry of option/argument lists IS order independent UP TO THE POINT of issuance of the "plot" or "plotf" option. At that time a plot is generated. After a plot is generated the user-specified sequence of options/argument lists is once again referenced until "plot" or "plotf" is encountered. This cycle repeats until the end of the user specifications is reached. Careful attention should always be paid to the current state of the definable plotting parameters.


The list of currently available options for the pubplot command is the following.

Any blinking names enclosed in brackets are required or are in a set of options, one of which must be specified. Any non-blinking names enclosed in brackets are optional or are in a set of options, only one of which can be specified.

In cases where the option name is one of a set each different set number is indicated by a red numeric set number superscript trailing the respectiveright bracket :

[absorigin] [allfrom] [altvars] [annmag] [aorigin] [arrowhead] [auto] [autox] [autoy] [autoz] [avg] [axiscolor] [axisrot] [axlwt] [backward] [blank] [border] [bottominc] [cangle] [cdec] [cdetail] [cfiles] [cfrom] [cfreq] [ckmag] [charalign] [clab] [cldist] [clevels] [clip] [clist] [clwt] [cmax] [cmin] [cntld] [colorkey] [colors] [contour] [copy] [corder] [cpaths] [cports] [crvlwt] [cset] [cside] [csize] [cthresh] [ctol] [curvefile] [curves] [destin] [dfreq] [dorigin] [elsek] [emptyplot] [encaps] [endifk] [endimport] [endloop] [enrich] [eqtol] [errorbarcap] [errorbarlwt] [errorshade] [fglwt] [fgpattern] [figure] [files] [finegrid] [flagmag] [font] [from] [glwt] [grid] [griddelay] [hzero] [ifk] [import] [impascii] [insideout] [integer] [key] [keydrop] [keyfill] [keyframe] [keyjustify] [keylines] [keymarks] [keyscale] [keyshadow] [keysymbsize] [ksqueeze] [keytextcolors] [labfile] [labmag] [land] [landscape] [layout] [limits] [limitx] [limity] [lines] [linescale] [lpattern] [list] [loop] [lwt] [maglevels] [mesh] [mirror] [newkeylines] [newkeysymbols] [nolines] [noop] [nosymbols] [notify] [numclevels] [oldlimits] [oldlimitsx] [oldlimitsy] [origin] [palette] [paper] [pathfile] [paths] [pdump] [plot] [plotf] [plotfile] [plusmag] [polaroff] [polarrot] [prestore] [psave] [pseq] [psort] [ptag] [pubnum] [quick] [reassociate] [reset] [rfigure] [rimport] [rotations] [scale] [screen] [setvoid] [shade] [spsymbols] [splines] [subsfile] [surface] [symbfigs] [symbolfill] [symbols] [symboff] [symbsize] [tabs] [text] [textframe] [textsleep] [translate] [tvspace] [type] [vfile] [vfilen] [voidval] [vzero] [x] [xan] [xaninc] [xaxdec] [xaxis] [xclip] [xcomp] [xdelta] [xexp] [xfactor] [xftic] [xlabel] [xlabinc] [xlen] [xlist] [xloglab] [xmax] [xmin] [xoff] [xoffset] [xtic] [xtol] [xtrapts] [y] [yan] [yaninc] [yaxdec] [yaxis] [yclip] [ycomp] [ydelta] [yexp] [yfactor] [yftic] [ylabel] [ylabinc] [ylaboff] [ylabrot] [ylen] [ylist] [yloglab] [ymax] [ymin] [yoff] [yoffset] [ytic] [ytol] [z] [zaxis] [zcomp] [zdelta] [zlen] [zlist] [zmax] [zmin]

[Top][Bottom][Option list]

( BRabsorigin) (Command :pubplot) Details for the absorigin option.

[General syntax rules for this keyword.]

If this option is specified, ALL x/y locations which would normally reference the CURRENT origin will, instead, reference the lower left corner of the page; ie, the ORIGINAL plot origin.

Example : absorigin

[Top][Bottom][Option list]

( BRallfrom) (Command :pubplot) Details for the allfrom option.

[General syntax rules for this keyword.]

Indicates the default form of the files being read. The default form is "sif".

[Top][Bottom][Option list]

( BRaltvars) (Command :pubplot) Details for the altvars option.

[General syntax rules for this keyword.]

The presence of this option indicates that IF there is an active composite alternate SIF variable name file (as established via the "variables" DESL command) then this composite file will be used to attempt to assign an alternate SIF variable name if a SIF variable would otherwise not be found on the file(s) being processed.

[Top][Bottom][Option list]

( BRannmag) (Command :pubplot) Details for the annmag option.

[General syntax rules for this keyword.]

The numeric argument following "annmag" represents the magnification factor to be applied to any axis tic labels which are to be drawn. If the numeric argument following "annmag" is negative the absolute value of the number is the desired actual point size at which any axis tic annotation will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective annmag value is reset. The default magnification value is 1.

Example : annmag 1.2

[Top][Bottom][Option list]

( BRaorigin) (Command :pubplot) Details for the aorigin option.

[General syntax rules for this keyword.]

If this option is specified, the following two values are the desired angle, in degrees measured counterclockwise from the positive X axis, and distance out on that line from the current plot origin. A new plot origin is established at this new implied position.

Example : aorigin 40 .75

[Top][Bottom][Option list]

( BRarrowhead) (Command :pubplot) Details for the arrowhead option.

[General syntax rules for this keyword.]

If specified, the following value is the relative size of the arrowhead. A value of 1.0 is the default size value.

Example : arrowhead 1.5

[Top][Bottom][Option list]

( BRauto) (Command :pubplot) Details for the auto option.

[General syntax rules for this keyword.]

If specified, indicates that auto scaling should be done for BOTH the x and y axes; ie, is as if both "autox" and "autoy" had been specified. Could also imply a shift of the specified scale limits and possibly a change in the specified "x/ydelta" value. See "autox"/"autoy".

[Top][Bottom][Option list]

( BRautox) (Command :pubplot) Details for the autox option.

[General syntax rules for this keyword.]

If specified, indicates that autoscaling should be done for the x axis. Autoscaling, in this application, means the automatic determination of x-axis minimum and maximum values. Normally, "auto" or "autox" would be specified when NONE of the options "xmin", "xmax", and "xdelta" have been specified; ie, when no other scaling information has been specified. If, however, "auto" or "autox" is specified along with "xmin" and/or "xmax" AND "xdelta" then an automatic shift of the specified "xmin" and "xmax" values and/or a change of the specified value of "xdelta" can occur if the data to be plotted would fall OUTSIDE of the SPECIFIED scale limits. If shifting occurs, the shift increment is the value of "xdelta". Shifting is done BEFORE a change in the specified "xdelta" value is made.

If "autox" or "auto" is specified, the scale extremes WILL be calculated and will override any which could also have been specified via "xmax" and/or "xmin". If the calculated "xmax" and "xmin" values are equal the plot is skipped.

[Top][Bottom][Option list]

( BRautoy) (Command :pubplot) Details for the autoy option.

[General syntax rules for this keyword.]

If specified, indicates that autoscaling should be done for the y axis. Autoscaling, in this application, means the automatic determination of y-axis minimum and maximum values. Normally, "auto" or "autoy" would be specified when NONE of the options "ymin", "ymax", and "ydelta" have been specified; ie, when no other scaling information has been specified. If, however, "auto" or "autoy" is specified along with "ymin" and/or "ymax" AND "ydelta" then an automatic shift of the specified "ymin" and "ymax" values and/or a change of the specified value of "ydelta" can occur if the data to be plotted would fall OUTSIDE of the SPECIFIED scale limits. If shifting occurs, the shift increment is the value of "ydelta". Shifting is done BEFORE a change in the specified "ydelta" value is made.

If "autoy" or "auto" is specified, the scale extremes WILL be calculated and will override any which could also have been specified via "ymax" and/or "ymin". If the calculated "ymax" and "ymin" values are equal the plot is skipped.

[Top][Bottom][Option list]

( BRautoz) (Command :pubplot) Details for the autoz option.

[General syntax rules for this keyword.]

If specified, and the plot is a surface plot, indicates that autoscaling should be done for the z axis. Autoscaling, in this application, means the automatic determination of z-axis minimum and maximum values. Normally, "autoz" would be specified when NONE of the options "zmin", "zmax", and "zdelta" have been specified; ie, when no other scaling information has been specified. If, however, "autoz" is specified along with "zmin" and/or "zmax" AND "zdelta" then an automatic shift of the specified "zmin" and "zmax" values and/or a change of the specified value of "zdelta" can occur if the data to be plotted would fall OUTSIDE of the SPECIFIED scale limits. If shifting occurs, the shift increment is the value of "zdelta". Shifting is done BEFORE a change in the specified "zdelta" value is made.

If "autoz" is specified, the scale extremes WILL be calculated and will override any which could also have been specified via "zmax" and/or "zmin". If the calculated "zmax" and "zmin" values are equal the plot is skipped.

[Top][Bottom][Option list]

( BRavg) (Command :pubplot) Details for the avg option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the number of consecutive points to average before proceeding. The default number of points to average per curve is one; ie, no average done.

Example : avg 1 1 4 2

[Top][Bottom][Option list]

( BRaxiscolor) (Command :pubplot) Details for the axiscolor option.

[General syntax rules for this keyword.]

Specifies the palette color number to be used when drawing any associated axis lines, tic marks, grid lines, and/or axis labels. The default color for these plot attributes is black. The curves' line and symbol colors are not affected by the axiscolor setting. The axis label colors can be independently set via the inline "$K" construct. (See "text".)

Example : axiscolor 3

[Top][Bottom][Option list]

( BRaxisrot) (Command :pubplot) Details for the axisrot option.

[General syntax rules for this keyword.]

If the current plot is of type = "force/pressure" if specified, the following value is the rotation angle in degrees to be applied to the current plot. The angle is measured about the plot's origin and is positive counterclockwise The default "axisrot" angle is 0 : along the positive "x" axis. If the current plot is of type = "polar", AND if the axis code ends in an 8 or 9, the annotation will be rotated by the amount (between -90 and 90 degrees) specified by the following value. If it is desired that axis annotation, axis labels, and the key remain at their unrotated attitudes, the "charalign" option should also be specified.

Example : axisrot 27.3

[Top][Bottom][Option list]

( BRaxlwt) (Command :pubplot) Details for the axlwt option.

[General syntax rules for this keyword.]

If specified, the following value is the "linewidth" in "points" to be used for drawing the axes lines. The default "axlwt" linewidth is 1.

Example : axlwt .65

[Top][Bottom][Option list]

( BRbackward) (Command :pubplot) Details for the backward option.

[General syntax rules for this keyword.]

Indicates that any searching for SIF variables will be done from back to front in the SIF records. The default condition is to search from front to back.

[Top][Bottom][Option list]

( BRblank) (Command :pubplot) Details for the blank option.

[General syntax rules for this keyword.]

If specified, followed by up to 6 values, will draw a filled rectangle on the current page. The first four values are the two x/y location pairs of the lower left corner and upper right corner of the rectangle, respectively. The optional fifth value is the shading factor to be used to fill the rectangle described. This value is used for shading ONLY if a sixth value specifying the color is NOT also specified. A shading factor of 1 is the default and will produce a white-filled box. A shading factor of 0 will produce a black-filled box. A value between 1 and 0 will produce some degree of gray shading. If an optional sixth value is specified it is the palette color number (see "palette") to use to fill the defined rectangle. If this sixth value is specified the fifth shading factor value is ignored for its effect on the degree of shading but is still used to determine whether a frame is to be drawn or not.

A fifth value of 0 to 1 will produce a shaded rectangle without a frame. If the 0-->1 value has had 10 added to it, a black frame will also be drawn at the rectangle's perimeter. Up to 10 blank rectangles can be drawn per plot.

Example : blank 1 1 5 6 .85

[Top][Bottom][Option list]

( BRborder) (Command :pubplot) Details for the border option.

[General syntax rules for this keyword.]

If specified, followed by up to 6 values, will draw a rectangle of desired lineweight on the current page. The first four values are the two x/y location pairs of the lower left corner and upper right corner of the rectangle, respectively. The optional fifth value is the relative line weight of the border line. A value of 1 is the default. A value larger than 1 will produce a bolder border line. The default border line is black. If an optional sixth value is specified it is the palette color number (see "palette") to use when drawing the border line.

Example : border 1 1 5 6 2 12

[Top][Bottom][Option list]

( BRbottominc) (Command :pubplot) Details for the bottominc option.

[General syntax rules for this keyword.]

If specified, the following value is a vertical offset to be applied to text "bottomX" location(s), where "X" is any valid "bottom" suffix. Normally, multi-line "bottomX" text can scroll off the bottom of the page. The value following "bottominc" is an increment, in inches, to be added to whatever the "bottomX" vertical position has been determined to be.

Example : bottominc .5

[Top][Bottom][Option list]

( BRcangle) (Command :pubplot) Details for the cangle option.

[General syntax rules for this keyword.]

If specified for a contour plot, the following value is an angle of curvature, in degrees, beyond which if a contour curve is turning a label will be delayed. The delay will last until the angle of curvature has decreased below the "cangle" angle. The default "cangle" is 10 degrees.

Example : cangle 5

[Top][Bottom][Option list]

( BRcdec) (Command :pubplot) Details for the cdec option.

[General syntax rules for this keyword.]

If specified, the following value indicates the desired maximum number of decimal places to display on contour lines. The default number of decimal places is 3

Example : cdec 4

[Top][Bottom][Option list]

( BRcdetail) (Command :pubplot) Details for the cdetail option.

[General syntax rules for this keyword.]

If specified, the original data to be contoured is enhanced my interpolating for one intermediate point between each of the original points. This usually results in a contour plot which has less of a chance of having crossing contour lines if the order is greater than 1. The default state is to NOT do a detailed contour plot.

[Top][Bottom][Option list]

( BRcfiles) (Command :pubplot) Details for the cfiles option.

[General syntax rules for this keyword.]

Indicates the adjunct SIF or FFSIF files to be used as effective EXTENSIONS to the files named or implied by the "files" option and argument list. There is a 1:1 correspondence between "cfiles" arguments and expressed or implied "files" arguments.

The primary intent of the capability provided via "cfiles" is to allow the inclusion of information which is considered to be CONSTANT; ie, information which would normally be the SAME in ALL SIF DATA records read. An example of this type of data would be pressure port location information.

If specified, and an adjunct file is found and is of a type consistent with the "cfrom" specified or default file type specifier, the contents of the NAMEs record and the FIRST DATA record on the named "cfiles" file is effectively merged into the NAMEs and DATA records, respectively, to result in read SIF records which are as if they had contained the adjunct information originally. Up to 1000 SIF items can be added from an adjunct file.

Example : cfiles add1 add2 Indicates the adjunct files to be used - one per curve, for ADDITIONAL data extraction during plotting. There is a 1:1 correspondence between curves and "cfiles" file names. The primary intent of the capability provided via the "cfiles" is to allow the inclusion of information, along with the read SIF data, which is considered to be CONSTANT; ie, information which would normally be the SAME in ALL SIF records read. An example of this type of data would be pressure port location information.

If specified, and an adjunct file is found and is of a type consistent with the "cfrom" specified or default file type specifier, the contents of the NAMEs record and the FIRST DATA record on the named "cfiles" file is merged into the NAMEs and DATA records, respectively, to result in effective NEW records which are as if they had contained the adjunct information originally. Up to 1000 SIF items can be added from an adjunct file.

Example : cfiles add1 add2

[Top][Bottom][Option list]

( BRcfreq) (Command :pubplot) Details for the cfreq option.

[General syntax rules for this keyword.]

If specified, the following value indicates the type of contour labeling desired. The choices are the following :


cfreq > 0 : labeling IN-LINE if possible OR at END cfreq < 0 : labeling IN-LINE ONCE if possible OR not at all cfreq = 0 : labeling at alternating ENDS of line ONLY

If a positive value follows "cfreq", this value IS the minimum distance, in inches, between contour in-line labels. The actual distance between labels may vary, depending on other label positioning parameters.

The default value of cfreq = 1.

Example : cfreq 0

[Top][Bottom][Option list]

( BRcfrom) (Command :pubplot) Details for the cfrom option.

[General syntax rules for this keyword.]

Indicates, in a 1:1 correspondence with the expressed or implied "files" arguments; ie, in correspondence with the curves, the types of files in the "cfiles" argument list. Allowable types are "sif" and "ffsif". Up to 20 "cfrom" file types can be specified. Strings beginning with "null" are essentially not reset from the default. The default type of file is "sif".

Example : cfrom ffsif sif rep 3 ffsif

[Top][Bottom][Option list]

( BRcharalign) (Command :pubplot) Details for the charalign option.

[General syntax rules for this keyword.]

If specified and the value of plot rotation as specified by the option "axisrot" is non-zero, some of the plot attributes will be affected. Normally, the rotation of the entire plot caused by a non-zero value of axis rotation also encompasses the plot axis label(s), the tic annotation, and the key . If it is desired that all of these attributes NOT be rotated along with the rest of the plot, ie, moved as a result of the rotation but kept at their original horizontal or vertical orientation, then the option "charalign" should be specified. If these attributes are drawn in their original angular attitude with a rotated plot axis, the locations of some of these drawn attributes may need to be slightly corrected for desired aesthetics. (See "xaninc", "yaninc", "xlabinc" and "ylabinc".)

Example : charalign

[Top][Bottom][Option list]

( BRckmag) (Command :pubplot) Details for the ckmag option.

[General syntax rules for this keyword.]

The numeric argument following "ckmag" represents the magnification factor to be applied to any annotation on a "colorkey" color bar which is to be drawn. If the numeric argument following "ckmag" is negative the absolute value of the number is the desired actual point size at which any colorkey annotation will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective ckmag value is reset. The default magnification value is 1.

Example : ckmag 1.2

[Top][Bottom][Option list]

( BRclab) (Command :pubplot) Details for the clab option.

[General syntax rules for this keyword.]

If specified the value following "clab" is the frequency of contour level lines to be labeled. The following indicates the possible values for "clab", where "#" represents an integral value :


# ....... label only the #th contour level lines #+100 ... like # but also label FIRST contour level line #+200 ... like # but also label LAST contour level line #+300 ... like # but also label FIRST and LAST contour level lines

The default value of "clab" is 1, meaning to label ALL contour level lines.

Example : clab 202

[Top][Bottom][Option list]

( BRcldist) (Command :pubplot) Details for the cldist option.

[General syntax rules for this keyword.]

If specified, the following value is the minimum distance in inches a contour label must be away from all other contour labels. Only the first 200 contour labels are checked. The default value for "cldist" is 0.

Example : cldist 1.5

[Top][Bottom][Option list]

( BRclevels) (Command :pubplot) Details for the clevels option.

[General syntax rules for this keyword.]

If specified, the following up to 20 values are the desired contour values for which to draw contour lines.

Example : clevels .4 .6 .8 .85 .9 .95

[Top][Bottom][Option list]

( BRclip) (Command :pubplot) Details for the clip option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates that data clipping for BOTH x and y is to occur if the data to be plotted falls outside of the scale limits specified. If "notify" is "on" and if one or more data point is clipped from the plot, a "c" surrounded by a circle will appear just outside the current plot"s origin. The default state is "clip on". Data which is clipped is treated as though it were never to be plotted; ie, it may NOT be apparent, if "notify" is "off", that any data has been clipped.
.

(Begin modifications on 052111)

A new argument that can follow "clip" is "hide". This argument causes, for all type = "force/pressure" or type = "log" (for x- and/or y-axis), no line or symbol to be drawn outside of the rectilinear scale boundaries. The curves' shapes reflect the data that is outside of the boundaries, however.

(End modifications on 052111)

Example : clip off

[Top][Bottom][Option list]

( BRclist) (Command :pubplot) Details for the clist option.

[General syntax rules for this keyword.]

Used for specification of contour variables. Indicates expressly or implicitly the contour SIF variables to plot per curve. If values are specified, these ARE the variable values to use in plotting; ie, no respective values will be extracted from a SIF file. Up to 20 sets of variables can be specified via the value of the "curve-id" set number.

.

(Begin modifications on 052102)

All specified "clist" sets combined must have no more than 50000 elements.

(End modifications on 052102)

There must be equal numbers of "xlist" and "ylist" and "clist" members for each respective curve-id specified.

The list of contour names/values which follow the curve-id number can include one or more of four special forms of implicit expansion methods : "curve", "thru", "at", and "to/by". If "curve" is used, a "curvefile" MUST be active. (See "curvefile" option.)



Examples:

clist 5 cp11 curve curve1 cp36 clist 3 p101 p104 thru p122 p133 clist 1 13 at 1.22 4 at 1.445 clist 2 1 to 10 by 1 clist 6 2 at 6 11 to 4 by -1 curve c1 cp12 thru cp18

[Top][Bottom][Option list]

( BRclwt) (Command :pubplot) Details for the clwt option.

[General syntax rules for this keyword.]

If specified, the following value is the PostScript "linewidth" in "points" to be used for drawing the contour lines. The default "clwt" linewidth is 0, which implies to the PostScript hardware "the minimum width line which can be drawn".

Example : clwt .75

[Top][Bottom][Option list]

( BRcmax) (Command :pubplot) Details for the cmax option.

[General syntax rules for this keyword.]

If specified and the plot is a contour plot and the contour levels are being generated automatically, the following value represents the maximum DIFFERENCE between the generated contour levels.

Example : cmax .75

[Top][Bottom][Option list]

( BRcmin) (Command :pubplot) Details for the cmin option.

[General syntax rules for this keyword.]

If specified and the plot is a contour plot and the contour levels are being generated automatically, the following value represents the minimum DIFFERENCE between the generated contour levels.

Example : cmin .75

[Top][Bottom][Option list]

( BRcntld) (Command :pubplot) Details for the cntld option.

[General syntax rules for this keyword.]

If specified, a cntl-D character will be inserted as the top line in the PostScript file being produced. This option should be specified BEFORE the first "plot"/"plotf". Some PostScript printers can be left, by the previous job, in a state in which the next job is erroneously handled. The cntl-D will reset these printers. However, the cntl-D will sometimes be unacceptable to a screen previewer.

[Top][Bottom][Option list]

( BRcolorkey) (Command :pubplot) Details for the colorkey option.

[General syntax rules for this keyword.]

If specified, the following arguments control (1) the type of surface plot to be drawn : shading as a function of orientation of the surface facets with respect to the viewpoint (at the user) - type 1, or shading as a function of the local value of the "z" axis variable - type 2, and, if the surface plot is shaded as a function of the local "z" axis variable values, (2) aspects of this type of plot. A surface shaded as a function of orientation will have no color key bar drawn. The color key bar is a rectangular legend which can be used to provide the correspondence between a specific shade and a value of the dependent Z variable.

If the type of surface plot is type 1 (see above) the color of the "inside" facets of the figure will be some shade (depending on facet orientation) of palette color number 1. (See the "palette" option.) The color of the"outside" facets of the surface will be a shade of palette color number 2.

If the type of surface plot is type 2 (see above) the color of the "inside" facets of the figure will be some shade (depending on facet orientation) of palette color number 1. (See the "palette" option.) The color of the "outside" facets of the surface will be a color which is determined by the correspondence between the local facet average value of the "z" dependent variable and the "z" values defined in the "colorkey" z_value-to-color pairing as discussed below.

In general, the syntax for the "colorkey" argument list is the following :



ckcode x y w h ( z c )1 ... ( z c )10

where,

"ckcode"..up to 5-digit code number representing user desires for key style, etc. See below for more discussion.

"x","y"...x and y location values (inches) from current origin to top left corner of color key bar

"w","h"...width and height of color key bar

"z/c".....pairs of z_value - to - color_number values : where, "z" is a dependent variable value and "c" is a "palette" color number. Up to 10 pairs of z_value - to - color pairs can be specified. The values of "z" can be implicit as specified by the use of "min" or "max" instead of an expressed value. Facets to be shaded which have associated "z" values which lie outside the limits of the first and last z_value specified will be shaded but will be shaded with the color which corresponds to the limit which that facet's z_value exceeded. When the range of facet "z" values exceeds the range of "z" values as defined for the color key bar, the color key bar will be drawn with an "R" with a circle around it at the appropriate end(s) in which the value was inadequate to contain the actual data range.

In reference to the "colorkey" argument list general syntax shown above, the definition of the "ckcode" parameters are the following :

ckcode = a 5-digit code : VWXYZ, where each of the single digits V, W, X, Y, and Z is defined as follows :

V .... Schematic 3-D axis display code :

0 ...... Do not display 3-D axis 1 ...... Display 3-D axis

W .... Type of surface plot to draw :

0 ...... Color of surface : f(facet orientation) 1 ...... Color of surface : f(facet "z" values)

Note : The "inside" surface of a surface plot is ALWAYS drawn with the shading as a function of the surface orientation.

X .... Z-axis color key bar annotation display code :

0 ...... no color key bar drawn; no Z-axis 1 ...... color key bar drawn without Z-axis 2 ...... color key bar drawn with Z-axis on bottom/left 3 ...... color key bar drawn with Z-axis on top/right

The "Z-axis" is an annotated line, with tic marks, which indicates the z_value-to-color correspondence.

Y .... color key bar border type code :

0 ...... no border # (1->9) ==> black border; # multiplies .1 for linewidth

Z .... color key bar orientation code :

0 ...... horizontally-oriented color key bar 1 ...... vertically-oriented color key bar

A schematic example of a drawn color key bar follows.
. Horizontally ...

. <-------- w ---------> . color . key origin __ # # # # # # # # . \|__|__|__|__|__|__|__| <-- Z-axis (on top) . o_____________________ . ^ | | . h | | . v |____________________| . < ------- ---------> . \ / . V . color gradation = f(z,r,g,b) [see "z/c" above]

. Vertically ...

. color <- w -> . key origin __ . \ . o_____ __ # . ^ | | | ^ . | | | |_ # | . | | | | | . | | |_ # . h | | | color gradation = f(z,r,g,b) . | | |_ # [see "z/c" above] . | | | | . | | | |_ # | . | | | | | . v |_____| |__ # v . . ^ . | . . Z-axis (on right)

Example : colorkey 11240 2 10 6 3 0 3 8 4

[Top][Bottom][Option list]

( BRcolors) (Command :pubplot) Details for the colors option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the palette color number to use (see "palette") when drawing the respective curve's line and/or symbols or the lines in a contour plot. Color numbers can range from 1 to 50, corresponding to the defined palette colors. Color number 0 corresponds to black. Referenced palette color numbers which are not defined correspond to black. The default colors for lines and symbols are black.

Example : colors 1 32 2 18

[Top][Bottom][Option list]

( BRcontour) (Command :pubplot) Details for the contour option.

[General syntax rules for this keyword.]

If specified this option indicates that the data is to be displayed as a contour plot. This plot display mode requires the "xlist" / "ylist" / "clist" options. The plot "type" can be other than the default type of "force / pressure". If the plot type is "polar", "log", "log-log", "log-normal", or "normal-log" the appropriate conversion of the data will occur before the contour is attempted. The lines drawn in a contour plot at the desired contour levels are of styles which correspond to the line types specified via "lines"; ie, contour level 3 will be drawn with a line style which corresponds to that specified in the third position after "lines".

[Top][Bottom][Option list]

( BRcopy) (Command :pubplot) Details for the copy option.

[General syntax rules for this keyword.]

If specified, the following number is the repeat count for the number of times the "destin" command/script will be executed. The default repeat count is 1.

Example : copy 2

[Top][Bottom][Option list]

( BRcorder) (Command :pubplot) Details for the corder option.

[General syntax rules for this keyword.]

If specified, the following value is the desired order to be used in fitting the contour line data. The allowable values are 1, 2, and 3, implying, respectively, first, second, and third order fitting. The default value of corder = 1.

Example : corder 2

[Top][Bottom][Option list]

( BRcpaths) (Command :pubplot) Details for the cpaths option.

[General syntax rules for this keyword.]

Indicates, in a 1:1 correspondence with the list of files specified, directory locations for the specified "cfiles". These locations supersede the current directory. If a "cfiles" location thus specified is not empty ("null...") a search for the respective file will be made at the indicated location before a search is made at any other alternate locations which have been made effective via a previous execution of the "path" command. By default, all path names are blank. Up to 20 path names can be specified.

Example : cpaths ..\ ..\Main\ sub1\

[Top][Bottom][Option list]

( BRcports) (Command :pubplot) Details for the cports option.

[General syntax rules for this keyword.]

If specified, the following value is the symbol number to be used to mark the positions of the data values used to calculate the contour lines. The default NASA standard symbol sequence is used. (See the "symbols" option.) The default symbol number is 0, meaning no symbol.

Example : cports 22

[Top][Bottom][Option list]

( BRcrvlwt) (Command :pubplot) Details for the crvlwt option.

[General syntax rules for this keyword.]

If specified, in a 1:1 correspondence with the curves to be plotted, the following arguments are the line widths in points. The default line width is the width set by the "lwt" option. If a curve also has an associated symbol the symbol will also be drawn with the specified line width. Up to 20 values of "crvlwt" line widths can be specified.

Example : crvlwt 1 1 5

[Top][Bottom][Option list]

( BRcset) (Command :pubplot) Details for the cset option.

[General syntax rules for this keyword.]

This option is used to specify "file-specific" conditions which, IN ADDITION to any other GLOBAL conditions which ALSO may have been specified, are to be applied to each SIF record processed from the respective SIF file. Just like global conditions, file-specific conditions act to limit the applicability of the DESL function being executed by requiring that ALL applicable "and" conditions be TRUE simultaneously or that at least ONE "or" condition be TRUE.

The item immediately following "cset" is the file sequence number in the "files" list for which the following up-to-20 conditions will be applicable.

Each file-specific 3-item condition, like its global 3-item condition counterpart, is made up of (1) a SIF variable name, (2) a 2-character logical conjunction, and (3) a second SIF variable name or a constant.

Example : cset 3 alpha gt phi mach lt 1.2

Here, the user has indicated that, along with whatever other GLOBAL conditions may have been specified, the pertinent DESL function, for the THIRD file specified or implied by the "files" list, will have its application ALSO limited to records which satisfy BOTH of the two conditions :

"ALPHA gt PHI" "MACH lt 1.2".

All file-specific conditions are implicitly joined by an "and" conjunction; ie, by default, all file-specific conditions would have to be true SIMULTANEOUSLY for the applicable record to be retained.

If one or more file-specific conditions following the file sequence number is to be connected to other file-specific conditions for the same file number by an "or" conjunction, then the 2-character item "or" must immediately follow the file number.

Example : cset 2 or alpha lt 0 alpha gt 4

Here, the user has indicated that, along with whatever other GLOBAL conditions may have been specified, the pertinent DESL function, for the SECOND file specified or implied by the "files" list, will have its application ALSO limited to records in which the value of the SIF variable "alpha" satisfies at least ONE of the conditions :

"ALPHA lt 0" "ALPHA gt 4".

Additionally, if the file number following the "cset" option is negative, the absolute value of this negative file number is used for the actual file number and the associated "and" or "or" condition(s) are NOT used in the traditional sense of filtering the records read but are ONLY used to indicate when READING of the associated file is to STOP. This ability is useful in preventing the reading of a long file when it is known that the data required is relatively near the beginning of the file.

Example : cset -1 or run eq 3 alpha gt 24

Here, the user has indicated that when a record is encountered for which either or both of the two conditions

"RUN = 3" "ALPHA gt 24"

is/are TRUE, reading of the current SIF file should end.

[Top][Bottom][Option list]

( BRcside) (Command :pubplot) Details for the cside option.

[General syntax rules for this keyword.]

If specified, the following value is the "side" of the "rectangular" set of data to be contoured on which to begin the search for contour lines which are NOT completely interior to the data set's physical distribution. The data set to be contoured can be thought of as having "rows" and "columns". These rows and columns are what make up the "rectangular" data set. "cside" values of from 1 to 4 refer to the side of this rectangle. Values of 1, 2, 3, and 4 refer to the top, right, bottom, and left sides. The default value of "cside" is 1.

Example : cside 3

[Top][Bottom][Option list]

( BRcsize) (Command :pubplot) Details for the csize option.

[General syntax rules for this keyword.]

If specified, the following value is the magnification factor to be applied to contour line labels. A value of 0 will cause NO LABELS to be drawn. The default value of "csize" is 1.

Example : csize .4

[Top][Bottom][Option list]

( BRcthresh) (Command :pubplot) Details for the cthresh option.

[General syntax rules for this keyword.]

If specified, the following value is the minimum number of points which will be considered a "contour line". Contour lines with less than this number of points are NOT plotted. The default "cthresh" value is 0.

Example : cthresh 3

[Top][Bottom][Option list]

( BRctol) (Command :pubplot) Details for the ctol option.

[General syntax rules for this keyword.]

If specified, the following value is the TOLERANCE to be checked among successive spline data if drawing spline curve(s) in a non-contour plot OR, if doing a contour plot, is a DISTANCE along a contour line between successive data points. If the value associated with "ctol" is positive, the tolerance is absolute. If the value associated with "ctol" is negative, the tolerance is a percent value. In either case, the magnitude of the value, if it is implied to be a distance, is considered to be positive. If the pertinent data point being plotted is within the tolerance/distan from the preceding data point just plotted, the current data point is NOT plotted.

Example : ctol -5

[Top][Bottom][Option list]

( BRcurvefile) (Command :pubplot) Details for the curvefile option.

[General syntax rules for this keyword.]

If specified names the file in which information is given to adequately define one or more "curves" of pressure or contour data. The "xlist" / "ylist" / "clist" options/argument lists can reference sequences of names/values, not located in the respective argument list proper, via a "curve" name.

If a curvefile is to be used it MUST be specified BEFORE any "xlist" / "ylist" / "clist" which references it. This is an exception to the normal DESL input rule; normally, the order of specification of a particular function's input options and arguments is not important.

Example : ... xlist 1 cp1 cp2 curve cpxx cp19 ...

In the above example, "xlist" information is expected to be in existence ON THE CURRENT "curvefile" in a section contained in the file for "curve cpxx". (See "xlist" / "ylist" / "clist".)

An example of a curvefile is the following :



curve cpxx ylist y101 y103 y112 45.6 y118 thru y124 xlist x101 thru x111 curve pflap1 xlist 1 1.5 1.75 2.01 2.04 2.09 2.13 ylist cp119 thru cp113

Each "curve segment" in the curve file begins with the word "curve" followed by the name of the curve whose x and y (and c, if a contour) information will follow, on separate lines. Following a curve segment's initial line must come sections of lines, each beginning with "xlist" or "ylist"( or "clist"), each on a line by itself. On lines following "xlist" and "ylist" (and "clist") the appropriate names and or values should exist.
.

(Begin modifications on 052102)

Each of these sections can be of any number of lines as long as the maximum of 50000 accumulated data names/values is not exceeded.

(End modifications on 052102)

A curve segment extends until the next "curve" line is encountered.

Note that the structure of the "xlist", "ylist", and "clist" lines in a curve file is slightly DIFFERENT than when the "xlist", "ylist", and "clist" options are encountered in the normal stream of plotting input.

Example : curvefile pcurvs

[Top][Bottom][Option list]

( BRcurves) (Command :pubplot) Details for the curves option.

[General syntax rules for this keyword.]

Indicates the number of curves which is to be plotted or referenced in the current plot. Up to 20 curves can be specified for a plot. If NOT specified, the number of files specified in the "files" argument list IS the number of curves in the current plot.
.

(Begin modifications on 052102)

For ALL curves to be plotted in a single plot, a limit of 50000 plotted points is imposed.

(End modifications on 052102)

Whether the number of curves is set EXPLICITLY by this "curves" option or set IMPLICITLY by the number of "files" specified, the established number of curves remains in effect until EXPLICITLY changed; ie, changed via a new "curves" specification. The number of curves WILL NOT be implicitly changed via "reset *files".

Example : curves 4

[Top][Bottom][Option list]

( BRdestin) (Command :pubplot) Details for the destin option.

[General syntax rules for this keyword.]

If a script is to be executed after the plot function has produced its PostScript file but before the user has once again gotten control via the "DESL>" prompt, then the string following "destin" should contain the name of that script OR, simply, a command to execute.

The string following "destin" must be no longer than 32 characters. If the destin string is longer than 16 characters, the question mark delimiters must be used.

Example : destin ?lpr -Plw PF?

[Top][Bottom][Option list]

( BRdfreq) (Command :pubplot) Details for the dfreq option.

[General syntax rules for this keyword.]

Indicates, per curve, the desired frequency of data record retention from the group of DATA records which would normally have been processed from each SIF file being accessed. For example, if "dfreq" is 4, then ONLY every fourth data record will be processed from those DATA records which passed successfully through any filter(s) and voiding which could have also been imposed.

Example : dfreq 4 1 1 6

[Top][Bottom][Option list]

( BRdorigin) (Command :pubplot) Details for the dorigin option.

[General syntax rules for this keyword.]

If this option is specified, the following two values are the desired x and y origin shifts, respectively, from the current plot origin. A new plot origin is established at this shifted position.

Example : dorigin 1 -.3

[Top][Bottom][Option list]

( BRemptyplot) (Command :pubplot) Details for the emptyplot option.

[General syntax rules for this keyword.]

The "emptyplot" option, followed by "on" or "off", will cause setting or unsetting of the flag to cause a plot to be made even if there is no data which can be plotted. Normally, with "emptyplot" set to "off, if no data can be plotted, no plot is made and an informative message to that effect is issued. If "emptyplot" is "on", however, a plot will be made. The primary purpose of allowing a plot with no data is to establish a "form" or "template" which can be "imported" into a future plot as a starting point, to alleviate spending the required time replotting the axes, grid, etc. The default state of "emptyplot" is "off" : no plot will be made if there is no data to be plotted.

Example : emptyplot on

[Top][Bottom][Option list]

( BRencaps) (Command :pubplot) Details for the encaps option.

[General syntax rules for this keyword.]

If this option is specified and the "screen" option has NOT also been specified the PostScript file which is to be produced will be an Encapsulated PostScript file. If the "screen" option has also been specified the file will NOT be an Encapsulated PostScript file.

Example : encaps

[Top][Bottom][Option list]

( BRendimport) (Command :pubplot) Details for the endimport option.

[General syntax rules for this keyword.]

For existing PostScript files being imported into the current plot, the string following this option is the string which, upon being encountered, will end the import. The special string "eof" will force importing to continue until the EOF is reached. The default string is "showpage". This is the string which should be used if an import of a DESL-gene PostScript file is being done. Care should be exercised when importing through one or more "showpage"s; pagination will occur - possibly at an undesirable time.

Example : endimport eof

[Top][Bottom][Option list]

( BRendloop) (Command :pubplot) Details for the endloop option.

[General syntax rules for this keyword.]

The purpose of this option is to serve as a terminator of the current loop block.

[Top][Bottom][Option list]

( BRenrich) (Command :pubplot) Details for the enrich option.

[General syntax rules for this keyword.]

If specified the following value is the enrichment number to be used for spline interpolation. "Enrichment", here, means how many additional points are to be interpolated for BETWEEN each pair of original points. The higher the enrichment number the smoother the curve but the longer it takes to do the plot. Since there is a limit on the absolute number of spline points in any ONE spline of 500, the maximum value of the enrichment number is a function of the number of existing points in the curve. If an enrichment number is specified which cannot be accommodated, the enrichment number will be reduced until it can be accommodated. The default enrichment number is 5. See "splines". If a contour plot is being attempted, the current enrichment value is used to determine the contour curves.

Example : enrich 15

[Top][Bottom][Option list]

( BReqtol) (Command :pubplot) Details for the eqtol option.

[General syntax rules for this keyword.]

Indicates the tolerance to be applied to any global or file-specific "eq" condition(s) which may have been specified. If the tolerance value specified is positive the value is in the units of the variable being used in the respective condition(s). If the tolerance value is negative the absolute value of the value is a PERCENT difference. The default value of tolerance is 0.

Example : eqtol .5

[Top][Bottom][Option list]

( BRerrorbarcap) (Command :pubplot) Details for the errorbarcap option.

[General syntax rules for this keyword.]

If specified the following value is the length in points of the perpendicular line segment which is added to the end of the error bar lines. (See the "symbols" option discussion.) The default error bar cap length is 0.

Example : errorbarcap 3

[Top][Bottom][Option list]

( BRerrorbarlwt) (Command :pubplot) Details for the errorbarlwt option.

[General syntax rules for this keyword.]

If specified the following value is the width in points of the error bar lines. (See the "symbols" option discussion.) The default error bar line weight is .75.

Example : errorbarlwt 1.2

[Top][Bottom][Option list]

( BRerrorshade) (Command :pubplot) Details for the errorshade option.

[General syntax rules for this keyword.]

If specified the following value is the shading value to be used if a error bar shaded band type curve is drawn. This value should be from 0 to 1, with 0 being black, and 1 being white. The default value is 1.

Example : errorshade .85

[Top][Bottom][Option list]

( BRfglwt) (Command :pubplot) Details for the fglwt option.

[General syntax rules for this keyword.]

If specified, the following value is the "linewidth" in "points" to be used for drawing the fine grid lines. The default "fglwt" linewidth is 0. A line width of "0" means "the minimum" to the PostScript processor.

Example : fglwt .55

[Top][Bottom][Option list]

( BRfgpattern) (Command :pubplot) Details for the fgpattern option.

[General syntax rules for this keyword.]

If specified, one or two values must follow. If only one value is specified the second is assumed to be 0. These two numbers represent the number of "on" and "off" pixels to be repeated as the line pattern for any fine grid lines which may be drawn. If the second value is 0, the number of "off" pixels is 0; ie, the line will be solid. If the number of "on" pixels is 0, a minimum size line (dot) will still be drawn. (This is hardware- and software-depende however.) A recommended pair of arguments is 1 2, especially for higher resolution fine grid density.

Example : fgpattern 1 2

[Top][Bottom][Option list]

( BRfigure) (Command :pubplot) Details for the figure option.

[General syntax rules for this keyword.]

If specified, the following two items are the x and y locations, relative to the absolute origin of the page, of the lower left corner of the figure to be drawn on top of the current plot. The third and fourth items are the names of the "figure file" and figure, respectively, from which to obtain drawing instructions. A figure drawn via "figure" will NOT be affected by any scaling which may already be in effect. Following the name of the figure file to read for drawing commands is an optional scale factor. A value of less than 1 will cause a reduction in size of the drawn figure(s) and figure origin movement relative to the lower left corner of the page.

Following the optional scale factor which can be specified there can be three other values specified. The first is a figure rotation angle, the next is the x center of rotation, and the third is the y center of rotation. The rotation angle is in degrees, positive being in the counterclockwise direction, and the x and y rotation center position is in inches, relative to the lower left corner of the page. If a figure is to be rotated, ONLY explicit x/y pairs should be specified in the figure; ie, no implicit curve-drawing figure specifications ("arc", etc) should be specified. The default rotation angle is 0. The default center of rotation is a x=0., y=0.

All "(r)imports" are done BEFORE all "(r)figures".



****** WARNING ****** If a landscaped plot is imported into a plot which is, itself, landscaped, the imported plot will, in effect, be landscaped again and appear in an upside-down portrait mode. Up to 20 figures can be drawn. *********************

A figure file contains directives which instruct the plotting software as to what and how to draw desired lines and shapes. It is helpful to have PostScript documentation available when setting up a figure file as the primitives are referenced with respect to correct directive syntax. Basically, a figure file :

  1. defines points which are later to be connected by a solid or dashed, visible or invisible line,
  2. defines complete curves via the use of a curve-drawing directive, or
  3. fills closed shapes.

All lengths and positions defined in a figure file are in inches. (See "rfigure" for exception.) All angles are in degrees.

The structure of a figure file must adhere to the following rules :

  1. Blank lines should NOT be included in a figure file.
  2. Any line beginning with an asterisk followed by at least one blank space is considered a comment and is ignored.
  3. All non-comment lines which DO NOT begin with a name are assumed to be lines which define a line by individual x-y pairs, in inches. Lines thus defined are at some future time drawn. Implicit x-y locations can also be specified. Implicit x-y locations are locations derived by extraction of a particular x-y pair from a specific curve being potted. An implicit x-y location is specified via the parenthetical construct :

    ( curve_id point_num offset_dis ) ,

    where "curve_id" is the plot's curve number, "point_num" is the particular plotted data point's sequence number in the list of all data points which are plotted for the curve in question, and "offset_dis" is an optional offset distance. This offset distance is a distance from the implicit x-y location, in the direction of the next x-y location, at which to actually begin drawing the line whose points are currently being defined. The default offset distance is 0. The "point_num" parameter can be specified as a numeric item or symbolicly. The possible symbolic specifications which can be used are : last, middle, last+#, middle+#, last-#, and middle-#. Both "last" and "middle" imply the last and middle plotted point in the specified curve, respectively. The +# and -# suffixes, where "#" represents an integer value, serve to add and subtract, respectively, the specified value (#) to whatever point sequence number was actually implied by the "last" or "middle" symbolic base word. Example : If the curve in question has 19 data points plotted, "last-2" implies the 17th point.

  4. All non-comment lines which DO begin with a name are assumed to be directive lines. Directive lines can ONLY contain one directive per line. A directive is a item followed, possibly, by arguments.

Some of the directives which can be contained in a figure file closely resemble the PostScript primitives they either mimic or match:



  1. figure

    Purpose : To name the figure being defined

    Syntax : figure fig_name where "fig_name" is the name of the figure to be defined immediately below. The definition of the figure continues until another "figure" directive is encountered or the file's EOF is reached.

  2. lw,lineweight

    Purpose : To assign a weight to lines which can be drawn (the default lineweight is .75)

    Syntax : lw lw_value where "lw_value" is the desired lineweight value

  3. arc

    Purpose : To define a circular arc to be drawn NOW with the current line type and weight

    Syntax : arc xcenter ycenter radius ang1 ang2 where the arguments "xcenter,...,ang2" correspond to the 5 arguments which preceed the "arc" PostScript primitive. Gets rewritten in PostScript output file as "xcenter ycenter radius ang1 ang2 arc". See the PostScript documentation for more discussion.

  4. arcto

    Purpose : To define a circular arc to be drawn NOW with the current line type and weight

    Syntax : arcto x0 y0 x1 y1 x2 y2 radius where the arguments "x1,...,radius" correspond to the 5 arguments which precede the "arcto" PostScript primitive. Gets rewritten in PostScript output file as "x0 y0 moveto x1 y1 x2 y2 radius arcto" See the PostScript documentation for more discussion.

  5. curveto

    Purpose : To define a Bessier curve to be drawn NOW with the current line type and weight

    Syntax : curveto x1 y1 x2 y2 x3 y3 where the arguments x1,...,y3 correspond to the 6 arguments which precede the "curveto" PostScript primitive. Gets rewritten in PostScript output file as "x1 y1 x2 y2 x3 y3 curveto". See the PostScript documentation for more discussion. "curveto" should be preceded by at least one point defined by an x-y pair. This point is referred to as "x0 y0" in the PostScript documentation.

  6. ah,arrowhead

    Purpose : To indicate that at the beginning or at the end of the next line to be drawn an arrowhead is to be drawn. If the "ah" comes BEFORE a line is begun the arrowhead will be drawn on the line's beginning. If the "ah" comes AFTER a line is begun the arrowhead will be drawn on the line's end. If a value follows "arrorhead" or "ah" then this value is a scaling factor which temporarily overrides the arrorhead scaling factor which is already in effect.

    Syntax : ah ( # )

  7. fill

    Purpose : To close the current "path" (ie, connect the current point to the first point in the current line), and fill the closed shape with the desired shade of gray or color. The shape's border will be drawn invisibly. The current line is ended when a "fill" is done.

    Syntax : fill shade_factor where "shade_factor" is a value from 0 to 1, 0 corresponding to black and 1 to white. If, however, a color has been specified via the "color" directive, the fill is the desired color, regardless of the specified fill shading factor.

  8. linefill

    Purpose : To close the current "path" (ie, connect the current point to the first point in the current line), and fill the closed shape with the desired shade of gray or color. The shape's border will be visible and drawn with the current lineweight and type. The current line is ended when a "linefill" is done.

    Syntax : linefill shade_factor where "shade_factor" is a value from 0 to 1, 0 corresponding to black and 1 to white. If, however, a color has been specified via the "color" directive, the fill is the desired color, regardless of the specified fill shading factor.

  9. line Purpose : To draw the current "path" with the current lineweight and type. The current line is ended when a "line" is done.

    Syntax : line

  10. dash

    Purpose : To define the desired dash pattern for visible lines which can be drawn. A dash pattern is established by defining a pattern of black then white line segments.

    Syntax : dash num_on (num_off) where "num_on" is a value representing the desired number of pixels to be turned on (ie, black) and the optional argument "num_off" is a value representing the desired number of pixels to be turned off (ie, white).

  11. solid

    Purpose : To make the current line's definition a solid line (rather than possibly a dashed line).

    Syntax : solid

  12. color

    Purpose : To specify the desired red/green/blue color values for drawing and filling. Once a non-black color is specified, the "fill", "linefill", and "line" directives will cause a color line/fill instead of a gray-scale line/fill. If the three color values are 0, black is implied and the gray-scale actions by "fill", "linefill" and "line" are once again used.

    Syntax : color red_value green_value blue_value

  13. text

    Purpose : To draw a particular text string which has been specified via "text" with a positive value for the fifth optional numeric item - as the "text id" value - at the current location with or without increments in x or y distances. The current location is the last specified x/y location specified in the current figure being processed.

    Syntax : text text_id x-dis y-dis where "text_id" is a value associated with the desired text string, x-dis is an optional horizontal offset, and y-dis is an optional vertical offset. The default values for both x-dis and y-dis are 0. (See the "text" option.)

  14. ftext

    Purpose : To draw a particular text string at offsets from the current location as defined in the current figure file.

    Syntax : ftext delta-x delta-y mag text_box rotation ?Text ...? where "delta-x" and "delta-y" are the X and Y offsets, respectively, from the current location, "mag" is the desired text magnification (see "text" option description of magnification), "text_box" is the text border/background code (see "text" option description of text box), "rotation" is the text cc-wise rotation angle (see "text" option description of rotation), "Text ..." is an up to 200-character string.

*** It is important to note that if the x-y pairs are to be *** used as data, as opposed to inches, "rfigure" MUST be *** specified (vs "figure") and specified WITHOUT the X and *** Y first and second positioning parameters.

An example of a figure file is given below


* begin definition of a figure figure fig1 * set the desired dash pattern to 20 black * pixels/10 white pixels dash 20 10 * set the desired line weight to .2 lw .2 * want arrowhead at beginning of next line ah * begin the definition of a line by defining x-y * pairs 1 1 1 3 3 3 * want arrowhead at end of current line ah * draw current line NOW line * define circular line as current line arc 4 5 6 45 90 * draw current line NOW line * ------------------------------------ * begin definition of a new figure figure fig2 * want arrowhead at beginning of next line ah * begin the definition of a line by defining x-y * pairs 2 2 2 8 7 7 * want arrowhead at end of current line ah * draw current line NOW line * define circular line as current line arcto 0 9 0 5 5 5 2.5 * using current line, close figure and fill linefill .90 * ------------------------------------ * begin definition of a new figure figure fig3 * set the desired line weight to .2 lw .2 * begin the definition of a line by defining x-y * pairs - note, one point is implicit 6.6 6.6 ( 1 8 ) 8.6 8.6 * using current line, close figure and fill linefill .7 * begin the definition of a line by defining x-y * pair in inches 3 5 * define curved line as current line curveto 6 10 1 8 6 6 * draw current line NOW line

Example : figure 2 8.4 figfile fig1 .75

[Top][Bottom][Option list]

( BRfiles) (Command :pubplot) Details for the files option.

[General syntax rules for this keyword.]

Indicates the files to be used - one per curve, for data extraction during plotting. If "curves" is NOT also given, the number of files specified IS the number of curves to be plotted in the current plot. If "curves" IS specified, the number of files specified via "files" can be LESS than the number of curves desired. In this case, the list of files is EXTENDED, replicating the last file given, to a number equal to the number of curves to be plotted.

This list of files can be implicitly extended via use of the <list argument which can appear among the specified file names. If one or more of the <list-type arguments are specified, where "list" is a currently defined file name list, the file names contained in the indicated file name list(s) will be included, at their respective point(s) of encounter, in the current file list. The referenced list(s) must have been produced by the "newfiles" and/or "newfilex" argument lists associated with one or more previously executed DESL commands. Each "list" name can be up to 15 characters long. File names can also include the {...} construct. This type specification within a file name implies that the list name given between the curly brackets ( {} ), is to be used to have each of its elements substituted in turn for the { ... }, inclusively, such that an implicit lengthening of the file list is accomplished, up to the maximum number of files allowed. Any time such a {...} usage occurs, all lists mentioned must exist; i.e., must have been previously defined in the current DESL session. Only one {...} construct can be included in a file name. Including more than one such construct will result in unpredictable results.

An example of this type of file name specification is the following :

t43r{runs}.sif

Here, the list "runs" will have its elements used, in turn, in place of the {runs} substring.

.

(Begin modifications on 052102)

Each file name, whether it includes the {...} or not, can be a maximum of 256 characters long. If a file name is more than 16 characters long it must be enclosed in question marks (?) .

(End modifications on 052102)

Example : files run1 thru run7 <flist48

[Top][Bottom][Option list]

( BRfinegrid) (Command :pubplot) Details for the finegrid option.

[General syntax rules for this keyword.]

If this option is specified, a finegrid will be drawn at the minor tic marks. The finegrid line weight is governed by the "fglwt" option.

[Top][Bottom][Option list]

( BRflagmag) (Command :pubplot) Details for the flagmag option.

[General syntax rules for this keyword.]

If specified indicates the magnification factors to be applied to the line segment(s) of the "flags" which can be drawn on symbols. Each flag has one and sometimes two parts. (See "symbols".) The first value following "flagmag" is required and governs the first line segment of the flag, which intersects the figure perimeter. Values greater than 1.0 will increase the length of this first first segment. If the flag has a second segment, joining the first segment at its end and at a right angle, its length is governed by the second optional value following "flagmag". The default second value is 1.0.

Example : flagmag 1 1.5

[Top][Bottom][Option list]

( BRfont) (Command :pubplot) Details for the font option.

[General syntax rules for this keyword.]

If specified, the following value is the default font number to use. The legitimate values for the 2-digit font numbers are the following, where XY is a 2-digit font code, in which X = font, Y = style :



X :
1 ... Times-Roman
2 ... Helvetica
3 ... Helvetica-Narrow
4 ... Symbol  (Style code = 1 or 2 ONLY!  See below.)
5 ... Courier ("Monaco")  (characters "equally" spaced)
6 ... AvantGarde
7 ... Bookman
8 ... Palatino
9 ... NewCenturySchlbk

Y : 1 ... Normal 2 ... Oblique / Italic 3 ... Bold 4 ... Bold-Oblique / Bold-Italic

The default font = Times-Roman (11). After any string is drawn, the current font ALWAYS reverts back to the default font.

Example : font 63

[Top][Bottom][Option list]

( BRfrom) (Command :pubplot) Details for the from option.

[General syntax rules for this keyword.]

Indicates, in a 1:1 correspondence with the expressed or implied "files" arguments; ie, in correspondence with the curves, the types of files in the "files" argument list. Allowable types are "sif" and "ffsif". Up to 20 "from" file types can be specified. Strings beginning with "null" are essentially not reset from the default. The default type of file is "sif".

Example : from ffsif sif rep 3 ffsif

[Top][Bottom][Option list]

( BRglwt) (Command :pubplot) Details for the glwt option.

[General syntax rules for this keyword.]

If specified, the following value is the "linewidth" in "points" to be used for drawing the (coarse) grid lines. The default "glwt" linewidth is .5.

Example : glwt .5

[Top][Bottom][Option list]

( BRgrid) (Command :pubplot) Details for the grid option.

[General syntax rules for this keyword.]

If this option is specified, a grid will be drawn at the major tic marks. The grid line weight is governed by the "glwt" option.

[Top][Bottom][Option list]

( BRgriddelay) (Command :pubplot) Details for the griddelay option.

[General syntax rules for this keyword.]

If this option is specified, the actual drawing of any axes and grid in association with a SURFACE plot in which there are NO rotations can be delayed until after the surface itself is drawn. The default condition is to draw the axes and grid FIRST. A filled surface plot would therefore, in the default case, obscure the axes and grid lines.

Example : griddelay

[Top][Bottom][Option list]

( BRhzero) (Command :pubplot) Details for the hzero option.

[General syntax rules for this keyword.]

If specified, for a non-"polar" type plot, the following value is the y-axis value at which to draw a "heavy" horizontal line which will have the same extent as the x-axis. The default line width for this heavy line is 1 (NOT heavy.) Following the value indicating the y-axis value, a second optional value can be specified indicating the desired line width to be used for the heavy line.

Following the line weight value can be a third item specifying the line type horizontal line to be drawn. The default line type is a solid line (type 1). The possible line types are as indicated in the "lines" documentation.

.

(Begin modifications on 052102)

Following the line type value can be a fourth item specifying the horizontal line color to be drawn. The value specified is a valid palette color number.

(End modifications on 052102)

For a "polar" type plot the implication of "hzero" is dependent on the value of the xaxis or yaxis code specified. A summary of the actions taken for different values of "xaxis" and "yaxis" is as follows, where "NUM1" and "NUM2" are the two values which can follow "hzero" :



"xaxis" specified

heavy radial at angle = NUM1 degrees, weight factor of line is NUM2

"yaxis" specified

heavy circle at NUM1, weight factor of line is NUM2

Example : hzero 0 3

[Top][Bottom][Option list]

( BRimpascii) (Command :pubplot) Details for the impascii option.

[General syntax rules for this keyword.]

If this option is specified the following up to 4 values indicate, for any (r)imported file which is an "ascii" file, the desired default font number, font magnification factor, horizontal expansion value, and vertical expansion value. The default values for these parameters are, respectively, the current font value, the current font magnification factor, 1.0 and 1.0. See "font" for the allowable font numbers. A font magnification value of less than 1 will yield a smaller font. Horizontal and vertical expansion values of less than 1 will compress the display, possibly to the point of overlapping text strings. These last two parameter values will depend on the font being used.

There are additional text formatting control sequences which can be embedded in the ascii text file; see "import".

Example : impascii 22 .5 0.9 1.2

[Top][Bottom][Option list]

( BRimport) (Command :pubplot) Details for the import option.

[General syntax rules for this keyword.]

If specified, the following two items are the x and y locations, relative to the absolute origin of the page, of the lower left corner of the PostScript file to be brought into the current plot. The next item could be the optional string "before", meaning that this import is to be done BEFORE any other part of the plot is drawn.
.

(Begin modifications on 082704)

The next item is the the name of the PostScript or ascii of EPSF (Encapsulated Postscript) file which is to be imported. Only the FIRST "page" of a potentially multi-paged PostScript file should be imported; ie, there should be NO "showpage" in the imported PostScript file.

Following the name of the PostScript file to import is the optional word "ascii" or "epsf", implying that the file being imported is really a regular ascii (text) file or Encapsulated Posatscript file, respectively, and should be converted to a PostScript file or properly included in the Poscript file being generated. Following this optionl argument can be one or two other optional arguments: a scale factor and a rotation angle in degrees counterclockwise If only one value is specified it is assumed to be the scale factor. Since an import is done relative to the lower left cornet of the current page the scaling and roation are also relative to that point.

If an EPSF file is being imported it will always be imported in the "before" mode, whether or not the "before" argument is specified or not. Caution should be used when importing EPSF files, as is the case with regular PostScript files as well, in that if more than one file is being imported the "background" of a later import may obscure some or all of an earlier import; whatever is contained in the EPSF file will be literally overlaid on the existing drawing.

UP to 10 files can be imported.

(End modifications on 082704)

If the file is an ascii file, it will be converted to a PostScript file before being included in the plotted PostScript file being created.

The imported image can be thought of as a transparent sheet overlaid on the current plot. For ascii text files, the text will typically be located at the upper left hand corner of the transparent sheet.

A file imported via "import" will NOT be affected by any scaling which may already be in effect.

The contents of the text fields in an "acsii" file is like that which can be contained in text associated with the "text" option; ie, all of the "dollar-sign-ass type constructs are legal. However, some of these dollar-sign-asso constructs depend on definitions of tabs, etc which should have occurred outside of the ascii file itself.

There are several additional formatting constructs which can be embedded within the ascii file itself. These formatting controls affect the interpretation and display of the ascii text itself as it is ultimately included in the plotting PostScript file being created.

The formatting controls are of the form :

backslash + one or more strings and/or numbers
In particular, the valid forms and their meanings are :

(1) \ verbatim

Individual strings - a string being a blank-delimited sequence of characters - will be positioned in the generated PostScript file at x-y locations as close to the original relative positions which they occupied in the ascii file as possible in order that the overall appearance of the imported ascii file(s) will very similar to their original appearance.



(2) \ normal


Whole lines in the specified ascii file will have their starting locations positioned in the generated PostScript file at x-y locations as close to the original relative positions which they occupied in the ascii file as possible in order that the overall appearance of the imported ascii file(s) will be very similar to their original appearance. "normal" is the default state.

(3) \ font font_value

By default the text in the ascii file will be printed in the PostScript file in the font which is currently active. As has been mentioned previously the dollar-sign type constructs can be used locally (per string) to affect the appearance of the text. However, to affect the default font the "\ font font_value" has to be used, where "font_value" is a legitimate font number. See "font" documentation.

(4) \ oldfont

To change the default font back to what it was before the most previous "\ font font_value" was issued.

(5) \ mag mag_value

By default the text in the ascii file will be printed in the PostScript file in the default font size. As has been mentioned previously the dollar-sign type constructs can be used locally (per string) to affect the appearance of the text. However, to affect the default font size the "\ mag mag_value" has to be used, where "mag_value" is the desired font magnification factor. Values less than 1.0 will reduce the size of the font.

(6) \ oldmag

To change the default font size back to what it was before the most previous "\ mag mag_value" was issued.

Following the name of the PostScript file to be imported is an optional scale factor. A value of less than 1 will cause a reduction in size of the imported image. Following the optional scale factor is an optional rotation angle at which the imported PostScript file will be drawn. This angles is in degrees and a positive angle rotates the figure counterclockwise The rotation axis is always the current plot's origin. All "(r)imports" are done BEFORE all "(r)figures".



****************** WARNING *******************

If a landscaped plot is imported into a plot which is, itself, landscaped, the imported plot will, in effect, be landscaped again and appear in an upside-down portrait mode.

*****************************************************

Example : import 2 8.4 sketch.ps 1.2

[Top][Bottom][Option list]

( BRinsideout) (Command :pubplot) Details for the insideout option.

[General syntax rules for this keyword.]

If specified, and the plot is a "surface" plot, then surface facet "out" and "in" sense are reversed. One side of the surface is defined to be the outside surface and one the inside surface. The side defined to be the outside surface is drawn with potentially multicolored facets whereas the inside surface is is drawn in shades of a single color and always shaded as a function of surface orientation. The original order of data specification for each curve determines, via vector operations, which side is the "outside" side.

Example : insideout

[Top][Bottom][Option list]

( BRinteger) (Command :pubplot) Details for the integer option.

[General syntax rules for this keyword.]

Toggles the ability to convert from real format without decimal places to an equivalent integer format. Following "integer", "on" or "off" must appear. If the "integer" state is "on", it is desired that all values, in key columns and in text lines, be displayed as integers if their associated formats had NO decimal places specified. For example, a value which would have been printed in "f6.0" format, if "integer" has been specified, will be printed, effectively, with an "i6" format.



*************************************************
The "integer" option as of approximately 12/14/94 had
no further meaning.  Whether a value in a key or text
string is displayed in some form of E, F, or G real
format or is displayed in an I format is now controlled
by the ability to now use the "I#" type integer format
specification.
*************************************************

Example : integer on

[Top][Bottom][Option list]

( BRkey) (Command :pubplot) Details for the key option.

[General syntax rules for this keyword.]

Indicates the desire to draw a figure key based on information corresponding to the current plot or the current plot and previous plot(s). The key can be drawn for the current plot or can be delayed until a later time, within the same plotting session. Following the option "key" there must be specified an up to 5-digit key code value which contains information implying exactly how and when to draw the key. (See "kcode definition" below.) Following the key code value, there must be specified an "x" and "y" location, in inches relative to the current origin, for the placement of the "upper left corner" of the key.

Delayed keys must be dealt with within input to pubplot with a knowledge of HOW these keys are treated within the program. A delayed key defines a set of information which is to be plotted at some FUTURE time. Each set of information which could ultimately be included in a drawn key is created as being tied to a certain particular identification (id) number. Up to 1000 sets of delayed key information can be defined in one pubplot session. Delayed key information is saved on a scratch file and is referenced by its id number. Delayed key information sets are stored in the order that they are encountered.

There is nothing to prevent duplicate delayed key id numbers from being defined. This situation could easily arise when using the "loop"/"endloop" construct. Delayed key id numbers are always stored, for reference purposes, as the absolute value of the actual number specified. Therefore, when a delayed key information set is being DEFINED, it does not matter what sign the delayed key id number is; it will be stored as a positive number. However, when a key is to be DRAWN including one or more delayed keys, the sign of each delayed key information set is important. The absolute magnitude of the specified id numbers will be used for attempts at matches with previously-defin delayed key information sets.

The SIGN of each of the specified delayed key id numbers controls the DIRECTION of the search on the scratch file for a delayed key id match. Since delayed keys are stored IN THE ORDER THEY ARE ENCOUNTERED - ie, in chronological order, it is important to make sure that the search for delayed key id matches is conducted in the proper direction. A positive delayed key id number implies a FORWARD chronological search and a negative number implies a backward chronological search.

The next several items are numeric and are key-code dependent. If the key is to be delayed or should be drawn at the current time and include one or more delayed keys, then these items MUST be present. After these key-delay values, the actual desired key variables, whose values (or their string counterparts from a substitution file) are to be included in the column(s) of the key, must be specified. Key column headings are the same as these variable names unless they are translated via the use of a label file. A key can have up to 10 columns and 20 rows BEFORE recombination with delayed keys, and up to 20 columns and 30 rows AFTER recombination with delayed keys.

Color and line type attributes associated with a delayed key are actually assigned at the time when a delayed key is drawn; ie, when it is combined with other keys. The user has the ability to redefine both line patterns per line types and the color palette. If either or both of these are redefined between the time when a key is delayed and the time when a delayed key is drawn the key may not reflect the originally-speci respective attribute(s).

If an "unset" key variable is not found on the SIF file, the string *NF* will show up in the key in place of a value. Also, if "notify" is on, the user will be notified of the fact that the variable was not found.

Following each variable name a real (F, G, or E) or integer (I) format specification can be included. This format will override the default format of g10.3 for the particular variable it follows.

Following this optional real format specification the values which would have been established from SIF file data extraction for a particular key variable or strings which could have been defined via a substitution file can be defined.

If the word "set", followed by one or more values, is encountered the values assigned to the respective variable will be those following the "set" and will be, from that point on, treated as if they had come from the SIF file(s), whether or not the variable was found on the SIF file(s).

If a position in a list of "set" arguments needs to be skipped (ie, NOT explicitly set to a value) then the string "empty" can be used to effectively skip key entries which are NOT being reset.

If the word "setk" is encountered it must be followed by a number indicating how many key rows worth of values or strings are being set. Then, following that number, a sequence of the values and/or up-to-64-charact strings which are to be assigned to the named key variable should be specified.

If a value is specified in the sequence of values and/or strings, that value is assigned to the respective variable and will be, from that point on, treated as if it had come the SIF file, whether or not the variable was actually on the SIF file.

If a string is specified in the sequence of values and/or strings, that string is assigned to the respective variable and will be, from that point on, treated as if it had been defined as a result of a translation via the use of a substitution file. A string specified in a list of "setk" values/strings can be up to 64 characters long. If the string is to contain embedded blanks or be longer than 16 characters the question mark delimiters MUST be used.

If a position in a list of "setk" arguments needs to be skipped (ie, NOT explicitly set to a value or string) then the string "empty" can be used to effectively skip key entries which are NOT being reset.

In general, the syntax for the "key" argument list is the following :

kcode x y (#1 (#2->#11)) { name (fmt)(set V#1 --> V#N) }1 ... { }10 -or- kcode x y (#1 (#2->#11)) { name (fmt)(setk snum V#1/Str#1 --> V#snum/Str#snum ) }1 ... { }10

where,

  1. kcode : 5-digit code value representing user desires for key style, delay items, substitution (see "kcode" definition below)

  2. x/y : x and y location values (inches) from current origin to top left of "key box"

  3. #1, #2,: context-specific delay values (see "kcode" definition below)

  4. name : SIF variable name. Can be blank, as would be specified by "? ?" . Will be the key column heading unless changed via a label file. If all key column headings are blank the vertical space allowed for key headings will be eliminated.

  5. fmt : E, F, or G real format for variable value display

  6. set : delimiter indicating next "N" items are defined values to be put into the respective rows for this particular column. "empty" is allowed, implying no value is being set. A value, represented here as V#1, etc, like its SIF-derived counterpart, can be changed into a string via a substitution file's use. Values set in this way do NOT have to be associated with an EXISTING SIF variable; ie, the variable specified in "name" does NOT have to be on the respective SIF file. Values assigned via "set" will overstore values derived from SIF files.

  7. setk : delimiter indicating next "snum" items are defined values or strings to be put into the respective rows for this particular column. "empty" is allowed, implying no value/string is being set. A string, represented here as Str#1, etc, is analogous to its substitution file-derived counterpart.

  8. V#1,V#2, : Values to assign to a key variable per curve

  9. Str#1, Str#2, : Strings to assign to a key variable per curve

In reference to the key argument list general syntax shown above, the definition of the kcode parameters are the following : kcode = a 5-digit code : VWXYZ, where each of the single digits V, W, X, Y, and Z is defined as follows :

  1. V : key col justification code :

    • 0 : Key column header/body centered

    • 1 : Key column header/body left justified

    • 2 : Key column header/body right justified

    • 3 : Key column header centered, body left justified

    • 4 : Key column header centered, body right justified

  2. W : key recombination code :

Key DELAY INFORMATION as a f(W,Y) (see above) :

W=0, Y=0 : (key NOT being delayed or recombined) W=0, Y=1 : #1 = id value of THIS key; this key to be delayed W=1, Y=2 : #1 = number of delayed keys to MERGE . #2->#n = the key id values to MERGE; CURRENT . key's id value = 0 W=2, Y=2 : #1 = number of delayed keys to STACK . #2->#n = the key id values to STACK; CURRENT . key's id value = 0

An schematic example of a drawn key follows :

------------------------------------------- | hdr1 hdr2 hdrN | | | | (symb1) (line1) ### ### ### | | (symb2) (line2) str str | | (symb3) (line3) ### str ### | | . | | . ... | | . | | (symbM) (lineM) ### ### ### | -------------------------------------------

where ...

hdr : either (1) a SIF variable name or (2) the corresponding translation from the use of a specified "label" file, or (3) a blank, having been specified by ? ?. If all key column headings are blank the vertical space allowed for key headings will be eliminated.

symb : optionally, the desired curve's symbol type

line : optionally, the desired curve's line style

### : a value from the SIF OR a "set"/"setk"-ind hardwired value

str : is a string which has been substituted for a value via the use of a substitution file or has been "setk"-induced

If no lines or symbols are drawn in the key the horizontal space normally allotted to them will be eliminated; ie, the body of the key will be shifted leftward.



Examples :

integer on key 0 .5 5 run f6.0 crm f9.4 config

Here a basic key is to be plotted. It will be composed of 3 columns : the first column will contain the values of "run", in an i6 format, because of "integer on"; the second column will contain the values of "crm" in the f9.4 format; and the third column will contain the values of "config" in the default format of g10.3. Any variable which is NOT found on the respective SIF files, will have its corresponding key entry(s) set to *NF*, indicating the variable was NOT found.

key 00411 .5 5 300 beta set 50 60 config f7.1

Here a key is to be delayed; its id value is 300. The key will be composed of 2 columns : the first column will contain the values of "beta" equal to 50 and 60 for the first and second curves, respectively, in the default format; the second column will contain the values of "config" in the f7.1 format. Since the least significant key-code digit is a 1, if a substitution file is active, it will be searched to find any strings which should be substituted for values of "beta" and "config".

key 02421 2 7 3 200 0 300 mach f7.3

Here a recombined key is to be drawn to include itself (id = 0) and two OTHER previously-delayed keys; the "3" says that "three keys are to be combined". The three key id values which are to be used are, IN THIS ORDER, 200, 0, and 300. The key id value of 0, as usual, implies the CURRENT key. This particular recombined key will be STACKED. The new recombined key will be composed of a number of columns equal to the number of columns in the FIRST key being used in the recombination, that being the number of columns in the key with an id value of 200. Since the least significant digit is a 1, if a substitution file is active, it will be searched to find any strings which should be substituted for values for this key (key id value = 0). Each delayed key is treated independently as far as substitutions are concerned; ie, each key's substitution status is governed by its own key code; ie, governed by the one which was active when it was originally specified. The style of a recombined key is governed by the style code (see "Y" above) at the time of recombination; ie, the style code of keys being delayed is NOT used. If a key to be drawn is, for whatever reason, to be be drawn without both symbols and lines the horizontal space which normally be allotted to either one or both of these is eliminated from the key.

[Top][Bottom][Option list]

( BRkeytextcolors) (Command :pubplot) Details for the keytextcolors option.

[General syntax rules for this keyword.]

If this option is specified, followed by up to 20 values, the values specified indicate the palette color numbers - per curve (key line) - to be used to draw the key body text lines. The default color to be used is whatever the respective "colors" palette color number. (See the "palette" option.) Although the palette color number of 0 is legitimate the "keytextcolors" color number should not be 0. A value of 0 indicates NO changes from the default color.

Example : keytextcolors 0 4 3 0

[Top][Bottom][Option list]

( BRkeydrop) (Command :pubplot) Details for the keydrop option.

[General syntax rules for this keyword.]

If specified, the following values, in a 1:1 correspondence with the number of curves to be plotted, indicate the curves for which to omit an entry in any key to be drawn. A value of 0 causes information associated with a curve to be retained, while a value of 1 causes a curve's information to be omitted. The default value of all "keydrop" flags is 0 (retain key entry).

Example : keydrop 0 0 1 0 0 1

[Top][Bottom][Option list]

( BRkeyfill) (Command :pubplot) Details for the keyfill option.

[General syntax rules for this keyword.]

If specified the following value will be the shading factor to apply to the interior of any box which will be drawn behind a key. A value of 0 is black, and a value of 1 is white. Shades of gray are obtained by specifying a value between 0 and 1. The default shading is 1 (white).

If the value following "keyfill" is negative the absolute value of the number is a palette color number to use for filling the key box.

Example : keyfill .98

[Top][Bottom][Option list]

( BRkeyframe) (Command :pubplot) Details for the keyframe option.

[General syntax rules for this keyword.]

If specified the next four values indicate, respectively, the shift in the x position of the left key border edge, the shift in the x position of the right key border edge, the shift in the y position of the top key border edge and the shift in the y position of the bottom key border edge in points (1 point = 1/72 inch). The default values of the shift are 0.

Example : keyframe 0 0 -2 2

[Top][Bottom][Option list]

( BRkeyjustify) (Command :pubplot) Details for the keyjustify option.

[General syntax rules for this keyword.]

Indicates the code value, per key column, which may override the key body justification set with the "V" part of the key code. See the "key" option. Up to 10 values may be specified - one per key column. The values can be 0, 1, 2, or 3, meaning, respectively, to (1) not change the justification for a key column from that which was set or implied by the "V" part of the key code, (2) left-justify the key body column, (3) center the key body column, or (4) right-justify the key body column.

Example : keyjustify 0 0 2

[Top][Bottom][Option list]

( BRkeylines) (Command :pubplot) Details for the keylines option.

[General syntax rules for this keyword.]

If specified, will cause lines to appear in the key, if they are called for in the plot, WHETHER OR NOT the line types are all the same. The default action is to NOT include any nonsymbol-associ lines in the key if ALL of the line types in the plot are the SAME. The determination of whether or not a line is to be included in a key is done on a per-key basis; ie, BEFORE any future recombination might occur. In the case of a plot with only one curve, if non-zero symbol AND line types have been specified, normally the line will NOT be shown in the key. Here, even though there is only one curve, ALL of the line types are the same. In this case, the use of "keylines" would be required to force the drawing of the line for the single-curve key entry.

Example : keylines

[Top][Bottom][Option list]

( BRkeymarks) (Command :pubplot) Details for the keymarks option.

[General syntax rules for this keyword.]

If specified, the following value (from 0 to 1) indicates that, in a key which contains at least one drawn line, the symbols in all key lines which contain a symbol only will be shifted horizontally by a distance to the right of an amount equal to the length of the line(s) drawn on other key line(s) times the specified "keymarks" value. By default, the "keymarks" value is 0.0, indicating that the symbol is to be drawn at a horizontal position equal to the LEFT end of all lines being drawn in the key. If, for example, the "keymarks" value was specified to be .6, then the symbol(s) would be drawn at a horizontal position corresponding to 60% of the key line lengths.

Example : keymarks .6

[Top][Bottom][Option list]

( BRkeyscale) (Command :pubplot) Details for the keyscale option.

[General syntax rules for this keyword.]

If specified, the following value is a scale factor which will be applied to the key IN ADDITION TO any scaling which may already be in effect for the plot in general. A value less than 1 will cause a reduction in key size. The default magnification value is 1. If the numeric argument following "keyscale" is negative the absolute value of the number is the desired actual point size at which any key characters will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective keyscale value is reset.

Example : keyscale .75

[Top][Bottom][Option list]

( BRkeyshadow) (Command :pubplot) Details for the keyshadow option.

[General syntax rules for this keyword.]

If specified, the following one or two values are the horizontal (1 value specified) or horizontal and vertical offsets (2 values specified), in inches, from the key key box the position of the key shadow, if a key and key shadow are to be drawn. The default horizontal and vertical offset values are .05 and .05 inches.

Example : keyshadow .07 -.07

[Top][Bottom][Option list]

( BRkeysymbsize) (Command :pubplot) Details for the keysymbsize option.

[General syntax rules for this keyword.]

If specified, the following values, in a 1:1 correspondence with the number of curves to be plotted, indicate the additional scaling factor to be applied to each of the key's symbols. The default value of all "keysymbsize" values is 1.

Example : keysymbsize 1 2

[Top][Bottom][Option list]

( BRksqueeze) (Command :pubplot) Details for the ksqueeze option.

[General syntax rules for this keyword.]

If specified, the one or two following values indicate, respectively, the x or x and y key squeezing factors which should be applied to a key. A positive x squeezing factor will affect the horizontal spacing between key columns. A positive y squeezing factor will affect the vertical spacing just between key body lines.

If the value of the x key squeezing factor is negative more of the horizontal space between the lines/symbols and the first key body column will also be affected. If the value of the y key squeezing factor is negative more of the vertical space between the key column headers and the first key body line will also be affected.

Example : ksqueeze .5

[Top][Bottom][Option list]

( BRlabfile) (Command :pubplot) Details for the labfile option.

[General syntax rules for this keyword.]

The string argument following "labfile" represents the name of the desired "label file" to examine to check for matches with (1) key column headers and (2) axis labels. The string translations can contain any of the legitimate font, tabbing and/or subscript/supers notations which are valid for any label. The rules for the syntax of a label file are the following :
  1. All lines are ASCII,
  2. Any line beginning with "* " is a comment and is ignored, (asterisk + one or more blanks)
  3. Blank lines are ignored,
  4. Only 2 items per line per translation : the first up to 16 characters and the second up to 50/64 characters. Any string longer than 16 characters MUST be enclosed in question-mark (?) delimiters. The 50-character limit is imposed for axis labels, the 64-character limit is imposed for all other labels.
  5. Free-field interpretation. Therefore, embedded blanks require the "?" delimiters,
  6. First item is label "corresponding" name; name to be translated must match VERBATIM with this name,
  7. Second item is the name translation string.

An example of such a file is the following :



*
*  Example label file for test xxx
*
cl    C$DL
beta  ?$41b$11, deg?
clalfsq ?C$DL$L$41a$11$U2?

Explanations for the use of the $-type font selectors and subscript/superscript selectors can be found in the "Fonts" section of this document.

[Top][Bottom][Option list]

( BRlabmag) (Command :pubplot) Details for the labmag option.

[General syntax rules for this keyword.]

The numeric argument following "labmag", if positive, represents the magnification factor to be applied to any axis labels which are to be drawn. If the numeric argument following "labmag" is negative the absolute value of the number is the desired actual point size at which any axis labels will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective labmag value is reset. The default magnification value is 1.

Example : labmag .5

[Top][Bottom][Option list]

( BRland) (Command :pubplot) Details for the land option.

[General syntax rules for this keyword.]

The "land" option will cause the plotted frame to be rotated 90 degrees; ie, the image will be drawn on a page that is wider-than-tall, as opposed to being drawn on the default taller-than-wide page ("portrait" mode). This option should be issued ONCE, BEFORE the first occurrence of "plot" or "plotf"; ie, ALL of the plotting to be done should be either landscaped OR portrait.

[Top][Bottom][Option list]

( BRlandscape) (Command :pubplot) Details for the landscape option.

[General syntax rules for this keyword.]

The "landscape" option, followed by "on" or "off", will cause setting or unsetting of the flag to cause the plotted frame to be rotated 90 degrees; ie, the image will be drawn on a page that is wider-than-tall, as opposed to being drawn on a page that is taller-than-wide ("portrait" mode). This option should be issued ONCE, BEFORE the first occurrence of "plot" or "plotf"; ie, ALL of the plotting to be done should be either landscaped OR portrait.

Example : landscape off

[Top][Bottom][Option list]

( BRlayout) (Command :pubplot) Details for the layout option.

[General syntax rules for this keyword.]

The argument list for this option can be used to indicate the relative location on the plotted page where the origin of the current plot is to be located. The SECOND pair of values which follow "layout" are the number of rows and columns into which the current page is to be subdivided, respectively. All rows are the same height and all columns are the same width. The FIRST pair of values which follow "layout" are the specific row and column, respectively, into which the current plot should be inserted. Specifying the plot's origin in this manner will (1) override the origin set specifically via the "origin" or "dorigin" options, (2) effectively set "xlen" and "ylen", and (3) effectively set "xcomp" and "xcomp"; ie, the plot will forced to fit into the row-column area desired. The optional THIRD pair of values which can follow "layout" indicate, respectively, the horizontal and vertical margins in inches to observe in positioning the plot into the selected row-column area. When "layout" is used, "scale" and "translate" should NOT be used as they will alter the basic intent of this option, that being to position plots "neatly" on a full size "page".

Example : layout 2 3 3 3

[Top][Bottom][Option list]

( BRlimits) (Command :pubplot) Details for the limits option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates whether both the x and y data to be plotted, BEFORE any clipping would be done, should be checked for "off scale" values, and, if one or both of the x or y values is off scale, reset it to the appropriate scale limit. The default state is "limits off".

Example : limits on

[Top][Bottom][Option list]

( BRlimitx) (Command :pubplot) Details for the limitx option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates whether the x data to be plotted, BEFORE any clipping would be done, should be checked for "off scale" values, and, if any x values are off scale, reset them to the appropriate scale limit. The default state is "limitx off".

Example : limitx on

[Top][Bottom][Option list]

( BRlimity) (Command :pubplot) Details for the limity option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates whether the y data to be plotted, BEFORE any clipping would be done, should be checked for "off scale" values, and, if any y values are off scale, reset them to the appropriate scale limit. The default state is "limitx off".

Example : limity on

[Top][Bottom][Option list]

( BRlines) (Command :pubplot) Details for the lines option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the line types to draw between data points, whether or not the plotted points are drawn surrounded by symbols. Line types range from 0 to 50. The first 8 line types correspond to the NASA standard line patterns shown below. Line types 9 to 50 are defaulted to a solid line. All line types except type 1 are user-redefinable via the "lpattern" option.


The on/off pixel-pair patterns used to draw the line types 2 through 8 are the following :



type  2  :  8  4
type  3  :  75  4    8  4
type  4  :  33  4    8  4    8  4
type  5  :  33  4    8  4    8  4    8  4
type  6  :  27  4    27  4   8  4
type  7  :  27  4    27  4   8  4    8  4
type  8  :  27  4    27  4   8  4    8  4    8  4


Plotted lines are actually drawn via the use of one of the above line patterns or a user-defined line pattern (see the "lpattern" option) via the use of a particular PostScript line pattern. In either case, if a symbol is also drawn for a particular curve, the distance between the symbols may have an effect on the part of the line pattern which is visible. After each symbol is drawn the curve's line pattern begins at a random position in its cycle. If the distance between symbols is small and the line pattern being drawn has one or more relatively long solid segments in it, the possibility of the pattern beginning somewhere in that long solid segment is high and could cause the apparent situation of the distinguishing section(s) of the line pattern being drawn in a relatively few locations on the curve.

Up to 20 line types can be specified. If 1000 is added to the line type, the corresponding curve entry will be omitted from a key which may be drawn. The line type used to draw the corresponding curve, in this case, is modulo (line_type,1000) There is no default line type. If no line type and no symbol type are specified, no curve will be plotted.

The line types defined will also be used in a 1:1 correspondence to specified contour level values when drawing a contour plot. The "colors" option can be used to cause the lines drawn to be other than the default color of black.

Example : lines 0 1 2 0

[Top][Bottom][Option list]

( BRlinescale) (Command :pubplot) Details for the linescale option.

[General syntax rules for this keyword.]

If this option is specified the following value is a scaling parameter to be used to adjust the lengths as expressed or implied of the solid and blank segments of each line style used. (See the "lines" option.) Normally, as a plot's scale is reduced the lengths of the solid and blank segments of any particular line style are also reduced. To maintain the effective "unscaled" segment lengths a value of "linescale" should be specified which is equal to the reciprocal of the "scale" value. (See the "scale" option.) The default value of "linescale" is 1.0. A value of "linescale" which is greater than 1.0 will increase the lengths of a line's segments.

Example : linescale 4.0

[Top][Bottom][Option list]

( BRlist) (Command :pubplot) Details for the list option.

[General syntax rules for this keyword.]

This is the means whereby "looping" parameters are established. If specified, the item immediately following "list" is the loop variable name. The loop variable "name" can actually be a value. If the loop variable values, established by "list", are to be substituted into an argument list in a place where ONLY a value can exist, the loop variable name MUST be a value. Following the loop variable name is a list of names OR values. These names OR values are the settings that the named loop variable will take on in successive trips through the loop. Up to 100 lists can be specified. The loop variable settings can be values ONLY if it is permissible for the option argument string into which the loop variable settings will be substituted (see "loop") MUST be values or CAN be values OR names. If a loop variable as defined by "list" is a number, the particular number selected to be used should be unique among the argument list(s) into which it will be substituted; ie, ANY matching value will be substituted with the loop variable value.

Example : list loop1 run1 thru run8

Example : list 5000 1 4 7 8 to 12

[Top][Bottom][Option list]

( BRloop) (Command :pubplot) Details for the loop option.

[General syntax rules for this keyword.]

This option indicates the beginning of a repetitive cycling through a block of "pp" input lines is desired. The cycling block is ended with "endloop". Up to a 5-deep nest structure of "loop" blocks is allowed. Up to 20 total loops are allowed. The option "loop" must be followed by one or more "list"- defined "looping" variable names. These are the variables which will have their setting substituted into the appropriate locations in option argument lists in lines within the respective loop block. ONLY arguments which are NOT strictly limited to being values can be specified via a loop parameter name which IS a name (as opposed to a name which looks like a value). Conversely, arguments which MUST be values MUST use loop parameter names which look like values.

The following section of "pp" input is legitimate:



list dumfile run1 run4 thru run7
list 5000 1 to 5
loop dumfile
files dumfile
symbols 5000
( more pp specs ...)
plot
endloop


But, the following section of "pp" input is NOT legitimate:



list dumfile run1 run4 thru run7
list symbindex 1 to 5
loop dumfile
files dumfile
symbols symbindex
( more pp specs ...)
plot
endloop


The second input section is not legitimate because ONLY values MUST follow "symbols". This is why the dummy loop parameter variable name MUST be a name which "looks" like a value.

The number of settings which are specified for the "list"-defined loop variables IS the upper limit on the number of trips which will be taken through the respective loop block. Subsequent loop trips after the first trip use the NEXT loop variable setting as defined by "list".

If all of the loop variables were NOT defined as having the SAME number of elements, the list whose number of elements was the SHORTEST will determine the actual number of loop trips taken. Each of the up-to-20 loop variables which could have been defined are incremented in parallel as cycling through the loop progresses. The settings of all of the "pp" flags/switches (set via default or specific option/ argument-list entries) in effect at the TOP of a loop are in effect at the TOP of EACH CYCLE of the SAME loop - WHETHER OR NOT any "pp" settings were changed WITHIN the loop.

Example :



list loop1 run1 run2 run8 run10
list loop2 0 0 2 4 6
loop loop1 loop2
files loop1 cset 1 alpha gt loop2
x cl y cl auto plotf
endloop


[Top][Bottom][Option list]

( BRlpattern) (Command :pubplot) Details for the lpattern option.

[General syntax rules for this keyword.]

If specified, the following value indicates which of the available line types, 2 to 50, (see "lines"), will be redefined. The values which follow the line type value are specified in PAIRS and indicate, respectively, the number of pixels ON and the number of pixels OFF in the sequence to be repeated to produce the newly-defined line pattern. Up to 5 pairs of values can be specified. The type-1 line pattern (solid line) CANNOT be redefined. See "lines" for a description of the default line patterns.

Example : lpattern 3 10 3 5 3

[Top][Bottom][Option list]

( BRlwt) (Command :pubplot) Details for the lwt option.

[General syntax rules for this keyword.]

If specified, the following value is the PostScript "linewidth" in "points" to be used for drawing each curve's lines, symbols, and other types of lines whose linewidths are NOT specifically governed by another "-lwt" option. The default "lwt" linewidth is .75.

Example : lwt 1.

[Top][Bottom][Option list]

( BRmaglevels) (Command :pubplot) Details for the maglevels option.

[General syntax rules for this keyword.]

If specified, each of the following pair of values indicates the magnification level index and the actual magnification factor which is associated with that magnification level index. Up to 10 magnification levels, 0 through 9, can be defined and referenced by the "$M#" construct. (See the "text" option discussion.) Here, the "#" represents the single digit magnification level number, 0 through 9. Any magnification invoked by the use of the "$M#" construct is in addition to whatever other magnification factor which may already be in effect. If a magnification factor is negative the absolute value of the number is the desired actual point size at which applicable strings will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective maglevel is reset. The default magnification factor for each of the 10 magnification levels is 1.0

Example : maglevels 1 -24 0 1.34 2 1.5

[Top][Bottom][Option list]

( BRmesh) (Command :pubplot) Details for the mesh option.

[General syntax rules for this keyword.]

If specified, the following one or two values indicate, respectively, the frequency or frequency and symbol type (see "symbol") for a grid which will be overlaid on the entire frame being drawn. The frequency value indicates how often, in inches, the symbol will be drawn in both the x and y directions. The default symbol type is a plus sign. A mesh is useful in iterating on the proper layout positions for text and plots in a frame.

Example : mesh 1 2

[Top][Bottom][Option list]

( BRmirror) (Command :pubplot) Details for the mirror option.

[General syntax rules for this keyword.]

If this option is specified for a "polar" type plot the following numeric angular argument (in degrees) is the line about which to flip the data to be plotted. The angular value is measured counterclockwise from the positive x-axis horizontal.

Example : mirror 90

[Top][Bottom][Option list]

( BRnewkeylines) (Command :pubplot) Details for the newkeylines option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the desired line type to be used per curve entry in any key which is to be drawn. These settings OVERRIDE the normal key line types drawn. The default settings for each of these values is -999. If a sparsely populated list of new key line types is specified the intermediate line types MUST either be set to -999 or to the actual line type used in the plotted curve.

Example : newkeylines 1 2

[Top][Bottom][Option list]

( BRnewkeysymbols) (Command :pubplot) Details for the newkeysymbols option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the desired symbol type to be used per curve entry in any key which is to be drawn. These settings OVERRIDE the normal key symbol types drawn. The default settings for each of these values is -999. If a sparsely populated list of new key symbol types is specified the intermediate symbol types MUST either be set to -999 or to the actual symbol type used in the plotted curve.

Example : newkeysymbols 901 2

[Top][Bottom][Option list]

( BRnolines) (Command :pubplot) Details for the nolines option.

[General syntax rules for this keyword.]

Will cause no lines to appear in the key.

Example : nolines

[Top][Bottom][Option list]

( BRnoop) (Command :pubplot) Details for the noop option.

[General syntax rules for this keyword.]

A dummy option which allows one or more GLOBAL conditions to follow. This option has NO OTHER FUNCTION.

[Top][Bottom][Option list]

( BRnosymbols) (Command :pubplot) Details for the nosymbols option.

[General syntax rules for this keyword.]

Will cause no symbols to appear in the key.

Example : nosymbols

[Top][Bottom][Option list]

( BRnotify) (Command :pubplot) Details for the notify option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates that notification of any data "clipping" which may occur will ("on") or will NOT ("off") be indicated on the plot via a "c" surrounded by a circle drawn just outside the plot's origin.

Also, if notify is on, an x or y plot or sort variable which is NOT found on the appropriate SIF file will be reported. The default state is "on".

Example : notify off

[Top][Bottom][Option list]

( BRnumclevels) (Command :pubplot) Details for the numclevels option.

[General syntax rules for this keyword.]

If specified the following value is the default number of contour levels to generate when no "clevels" option and argument list are also specified. The default default number of contour levels is 5.

Example : numclevels 4

[Top][Bottom][Option list]

( BRoldlimits) (Command :pubplot) Details for the oldlimits option.

[General syntax rules for this keyword.]

If this option is specified, the settings WHICH WERE ACTUALLY USED for both of the axes scaling parameters (minimum, maximums, deltas, lengths, and compression factors) for the previous plot will be used again, REGARDLESS of whether or not any of the options which would normally have been used to explicitly set one or more of these parameters is specified or not. This option is not meaningful except for the second through the last plot being done.

Example : oldlimits
.

(Begin modifications on 052405)

[Top][Bottom][Option list]

( BRoldlimitsx) (Command :pubplot) Details for the oldlimitsx option.

[General syntax rules for this keyword.]

If this option is specified, the settings WHICH WERE ACTUALLY USED for the X axis scaling parameters (minimum, maximums, deltas, lengths, and compression factors) for the previous plot will be used again, REGARDLESS of whether or not any of the options which would normally have been used to explicitly set one or more of these parameters is specified or not. This option is not meaningful except for the second through the last plot being done. Only "oldlimitsx" OR "oldlimitsy" should be specified for a particular plot. If both need to be used "oldlimits" must be specified.

Example : oldlimitsx

(End modifications on 052405)

.

(Begin modifications on 052405)

[Top][Bottom][Option list]

( BRoldlimitsy) (Command :pubplot) Details for the oldlimitsy option.

[General syntax rules for this keyword.]

If this option is specified, the settings WHICH WERE ACTUALLY USED for the Y axis scaling parameters (minimum, maximums, deltas, lengths, and compression factors) for the previous plot will be used again, REGARDLESS of whether or not any of the options which would normally have been used to explicitly set one or more of these parameters is specified or not. This option is not meaningful except for the second through the last plot being done. Only "oldlimitsx" OR "oldlimitsy" should be specified for a particular plot. If both need to be used "oldlimits" must be specified.

Example : oldlimitsy

(End modifications on 052405)

[Top][Bottom][Option list]

( BRorigin) (Command :pubplot) Details for the origin option.

[General syntax rules for this keyword.]

If this option is specified, the following two values are the desired x and y locations, respectively, of the plot origin. All locations which can be specified are with respect to the plot origin. The origin itself is with respect to the page's origin (translated or not). Therefore, an origin specification is always absolute and with respect to the same reference.

Example : origin 3 4

[Top][Bottom][Option list]

( BRpalette) (Command :pubplot) Details for the palette option.

[General syntax rules for this keyword.]

If specified this option is followed by up to 50 groups of four values each. The members of each group represent, respectively, the palette color number and the RED, GREEN, and BLUE color values, from 0 to 1.

Example : palette 3 .5 0 .8

Palette color numbers can range from 1 to 50. The color red/green/blue values are combined to form resulting colors. If these three color values are the same, between 0 and 1, the resulting color is some shade of gray : all 0's is black, all 1's is white. All other colors result from some other combinations of these three values. The palette color numbers defined are referenced by then "color", "blank", "border", "keyfill" and "text" options and the "$K" in-line string construct. (See "text".) The default color values for each of the 50 allowable palette colors is 0, 0, and 0, representing the color black.

Example : palette 12 .2 .6 .4 3 .5 0 .8

[Top][Bottom][Option list]

( BRpaper) (Command :pubplot) Details for the paper option.

[General syntax rules for this keyword.]

If the size of the paper on which the plotting is to be done is NOT 8.5 x 11 inches (the default size) this option allows the user to indicate which size paper IS being used. One of the following values must follow the "paper" option : (1) 85110, meaning 8.5 x 11.0 inches, or (2) 85140, meaning 8.5 x 14.0 inches, or (3) 110170, meaning 11.0 x 17.0 inches.

WARNING : Do NOT change the setting for "paper" after the FIRST plot.

Example : paper 110170

[Top][Bottom][Option list]

( BRpathfile) (Command :pubplot) Details for the pathfile option.

[General syntax rules for this keyword.]

If specified, any up-to-16-charact string specified via the "paths" option and argument list can be translated to an up-to-64-charact string. If a specified "paths" string matches a string in the left column in the path file, then the (potentially longer) string in the right column in the same line in the path file is substituted for the original string. The rules for the syntax of a path file are the following :

  1. all lines are ASCII
  2. any line beginning with "* " is a comment and is ignored (asterisk + one or more blanks)
  3. blank lines are ignored
  4. only 2 items per line per translation : the first up to 16 characters and the second up to 64 characters. Any string longer than 16 characters MUST be enclosed in question-mark (?) delimiters.
  5. free-field interpretation, therefore embedded blanks require the "?" delimiters
  6. first item is name to be translated; must match VERBATIM with path name specified or implied via "paths" argument list
  7. second item is the corresponding path name translation

An example of such a file is the following :



*
*  Example path file for test xxx
*
*  item  1 = path to be translated : MUST
*             match VERBATIM with name given
*             specified/implied via "paths"
*
*  item  2 = resulting name translation
*
data56    ? \usr\home2\ people\test56\ ?
up  ?..\?
way-up  ? ..\..\..\ Temp46\?


Example : pathfile pathA

[Top][Bottom][Option list]

( BRpaths) (Command :pubplot) Details for the paths option.

[General syntax rules for this keyword.]

Indicates, in a 1:1 correspondence with the list of files specified, directory locations for the specified files. These locations supersede the current directory. If a file location thus specified is not empty ("null...") a search for the respective file will be made at the indicated location before a search is made at any other alternate locations which have been made effective via a previous execution of the "path" command. By default, all path names are blank. Up to 20 path names can be specified.

Example : paths ..\ ..\Main\ sub1\

[Top][Bottom][Option list]

( BRpdump) (Command :pubplot) Details for the pdump option.

[General syntax rules for this keyword.]

This option allows a report to be generated containing all or some of the current settings of the plotting parameters. If "all" follows "pdump", all of the settings of the plotting parameters are reported. If only certain parameters are to be reported, then the respective option PREFIXED BY AN ASTERISK can be used to imply the desire to report the setting(s) of that parameter. One or more of there asterisk-prefixe options can be specified.

Example : pdump *files *x *symbols

[Top][Bottom][Option list]

( BRplot) (Command :pubplot) Details for the plot option.

[General syntax rules for this keyword.]

This option is a special "action" type option. It does not set any parameter(s) and is NOT "psave"-able. When it is encountered, a plot will be attempted using the CURRENT settings of the plotting parameters. "plot" does NOT change any plot parameter settings.

[Top][Bottom][Option list]

( BRplotf) (Command :pubplot) Details for the plotf option.

[General syntax rules for this keyword.]

This option is a special "action" type option. It does not set any parameter(s) and is NOT "psave"-able. When it is encountered, a plot will be attempted using the CURRENT settings of the plotting parameters. "plotf" does NOT change any plot parameter settings. In addition to the generation of a plot, a page eject is issued after the action caused by "plotf" such that subsequent plotting will be done on a new page.

[Top][Bottom][Option list]

( BRplotfile) (Command :pubplot) Details for the plotfile option.

[General syntax rules for this keyword.]

If specified, the following string will be the name of the file to receive the PostScript plotting instructions. This option/argument should be specified BEFORE the first occurrence of "plot"/"plotf". If the plot file is unnamed at the time of the first "plot"/"plotf" option the default plot file name of DSP# will be generated, where # is a unique numeric suffix.

Example : plotfile PF

[Top][Bottom][Option list]

( BRplusmag) (Command :pubplot) Details for the plusmag option.

[General syntax rules for this keyword.]

If specified, the following value is a scale factor for the plus sign inside symbols numbers 11 --> 20. Default value is 1.0. This option should be specified for the FIRST plot if it is to be done anywhere in the plot; ie, it will be ignored if done AFTER the first plot.

Example : plusmag 2

[Top][Bottom][Option list]

( BRpolaroff) (Command :pubplot) Details for the polaroff option.

[General syntax rules for this keyword.]

If specified, and the plot is being done in a polar axis system, then the following value is the offset from the center at which to begin the plot proper.

Example : polaroff 3

[Top][Bottom][Option list]

( BRpolarrot) (Command :pubplot) Details for the polarrot option.

[General syntax rules for this keyword.]

If specified, and the plot is being done in a polar axis system, then the following value is the rotational offset to be applied to the entire plot - axes and data.

Example : polarrot 90

[Top][Bottom][Option list]

( BRprestore) (Command :pubplot) Details for the prestore option.

[General syntax rules for this keyword.]

If specified, the following item(s) indicate the name of the local set and, optionally, file name from which the named set is to be restored. Set names without following file names imply that the named set was generated in the current "pp" session via a "psave" argument list. When a set is restored via "prestore" all of the plotting parameters" settings formerly established are overstored.

Example : prestore ps1 psfile3

[Top][Bottom][Option list]

( BRpsave) (Command :pubplot) Details for the psave option.

[General syntax rules for this keyword.]

If specified, the following item(s) indicate the name of the local set and, optionally the name of the file, to contain the "set" of input just defined. At any point in the input to "pp", the current state of pp parameter definition can be saved. Later, a similar "prestore" will reinstitute the parameter settings at the time of the named "psave". Sets MUST be referenced by name. If no following FILE name is also given, the set ONLY exists locally in the DESL "pp" session; ie, it is GONE at the end of the current "pp" execution. If a file IS named, then not only is the "psaved" set available locally, but is saved on file, by set name, to be used in another "pp" execution, either in the current DESL session or in another DESL session.

Example : psave ps1 psfile3

[Top][Bottom][Option list]

( BRpseq) (Command :pubplot) Details for the pseq option.

[General syntax rules for this keyword.]

If specified, then one of the following arguments MUST follow: "on", "off", or "once". These arguments indicate, whether or not each SIF file will be rewound after its use. "off" and "once" will cause EACH curve's respective SIF file to be rewound BEFORE the data for that curve is gathered.

If it is known that the data to be extracted for adjacent curves, which use the SAME SIF file, exist sequentially on the SIF file, then a definite I/O speed advantage can be achieved by the use of the "on" argument because the SIF file in question will NOT be rewound before the data for the next curve is searched for.

If the "on" or "once" argument is specified, the FIRST record from a file which FAILS to meet any conditions specified, AFTER at least one record HAS satisfied these same conditions, will cause reading of the file to end. The use of the "once" argument is a good way to speed up file processing when doing pressure plots when ONLY one data point is needed to plot the curve.

If "on" is specified and the last record of the file is processed while not encountering any records which fail the condition(s) for the current curve (file) processing of the next curve (file) will begin with a rewond file.

The default "pseq" state is "off" : read through the entire SIF file and rewind the SIF file after each curve.

Example : pseq on

[Top][Bottom][Option list]

( BRpsort) (Command :pubplot) Details for the psort option.

[General syntax rules for this keyword.]

If specified, the names of up to 20 SIF variables should follow in a 1:1 correspondence with the specified or implied file names; ie, there should be a 1:1 correspondence between the curves and the sorting variable names. The values of these SIF variables will be used to sort the data before plotting. The data which will be sorted is that data which remains after all global and file-specific conditions and "pseq"-implicati have been imposed. If sorting is to be done, respective data are reordered to be strictly algebraically increasing, based on the sorting variable. The default condition is NOT to sort the data before plotting. In the following example, the user has indicated that they want to have the data from the first, second, and fourth files sorted on the SIF variable "alpha" before plotting. If the name "null" is specified, the effect is to NOT sort the data for the respective file (curve). (See the "notify" option.)

Example : psort alpha alpha null alpha

[Top][Bottom][Option list]

( BRptag) (Command :pubplot) Details for the ptag option.

[General syntax rules for this keyword.]

If specified, the following up-to-16 character string will be drawn, as a reference, near the lower left corner of the plot.

Example : ptag ?flap = 20?

[Top][Bottom][Option list]

( BRpubnum) (Command :pubplot) Details for the pubnum option.

[General syntax rules for this keyword.]

If specified the following value represents a factor, relative to an arbitrarily-sele value of .4, which governs the sizes of annotation, length of axis tic marks, various axis-to-annotati and inter-key distances, sizes of symbols and axis label positions which have been determined to produce a page-sized figure of acceptable proportions. Figure scaling can, however, necessitate the need to change these attributes' dimensions. By specifying a value of pubnum LESS than .4, the attributes' dimensions can be proportionately INCREASED. By specifying a value of pubnum GREATER than .4, the attributes dimensions can be proportionately DECREASED.

Example : pubnum .275

[Top][Bottom][Option list]

( BRquick) (Command :pubplot) Details for the quick option.

[General syntax rules for this keyword.]

This option allows the user to imply a group of options and argument lists which could be basic to the production of a plot while desiring to specify only the minimum level of "pp" specifications. The specification of "quick" is effectively the same as specifying the following :



auto reset *symbols
symbols 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
grid plotfile PF scale .5 translate 2 2
layout 1 1 1 1 2 2
emptyplot on


Also, the axis labels will be set to the same as the respective axes variable names.

The location in the "pp" input specifications where "quick" is encountered is important if one or more of the parameters which are set when "quick" is specified are also explicitly set. In this case, the last specification, whether explicitly set or via "quick", will have precedence or will possible extend a list defined earlier. It may be necessary to use the "reset" option to accomplish the desired settings when "quick" is also specified.

Example : quick

[Top][Bottom][Option list]

( BRreassociate) (Command :pubplot) Details for the reassociate option.

[General syntax rules for this keyword.]

This option indicates that the user wishes to change the association of the specified or default option values that normally correspond 1:1 to "files". These options are : symbsize, colors and crvlwt.

Following this option name is either (1) a positive or negative integer, indicating the number of slots within the aforementioned option value lists to shift right or left, respectively, (2) the string "rev" or "reverse", or the number 0, incicating a reversal of the current order of the aforementioned option value lists, or (3) up to 20 values indicating the new order for the existing values of the aforementioned options. Either the number 0 or the string "reverse" implies the reversal of the existing order of these values.

Example : reassociate -3

[Top][Bottom][Option list]

( BRreset) (Command :pubplot) Details for the reset option.

[General syntax rules for this keyword.]

This option allows the user to reinitialize all or some of the settings of the plotting parameters. If "all" follows "reset", all of the settings of the plotting parameters are reinitialized to their default states. If only certain parameters are to reinitialized, then the respective option PREFIXED BY AN ASTERISK can be used to imply the desire to reinitialize the setting(s) of that parameter only. One or more of there asterisk-prefixe options can be specified.

Most "pubplot" plotting parameters are automatically reset when a new value is specified for them. There are SOME parameters, however, which are NOT reset merely by redefining them but actually have their current list ADDED to. These parameters include "files", "x", "y", "lines", "symbols", "splines", and "cset". These parameters should usually be explicitly reset before redefining them.
.

(Begin modifications on 103102)

The settings for "scale" and "plotfile" are NOT reset at "reset all".

(End modifications on 103102)

Example : reset *files *x *symbols

[Top][Bottom][Option list]

( BRrfigure) (Command :pubplot) Details for the rfigure option.

[General syntax rules for this keyword.]

This option/argument string has virtually the same meaning as "figure". The x and y origin location values, however, are optional. If these two x and y values are specified, they are in inches. Positioning and scaling are relative to the current origin and are on top of whatever scaling might be in effect within the plot being drawn, respectively. If the type of plot is NOT "polar", and if the x and y location values are NOT specified, the figure will be drawn with respect to the current plot's axes scaling parameters; ie, the figure will be drawn as if the x and y value pairs to be plotted were data. Also in this case, any specified figure scaling value will be ignored.

In a figure to be drawn in the PLOT'S coordinates; ie, if the x and y positions are NOT specified :

NO curved-line drawing commands should be used; ie, all lines drawn in the figure should be as a result of two or more x/y explicit or implicit pairs having been specified.

Following the optional scale factor which can be specified after the name of the figure being drawn there can be three other values specified. The first is a figure rotation angle, the next is the x center of rotation, and the third is the y center of rotation. The rotation angle is in degrees, positive being in the counterclockwise direction. The x and y rotation center position is either in inches or plotted data units, depending on whether the figure x/y location has been specified (see above). If the center position is in inches it is relative to the origin of the plot. If an "rfigure"-drawn figure is to be rotated, ONLY explicit x/y pairs should be specified in the figure; ie, no implicit curve-drawing figure specifications ("arc", etc) should be specified.

All "(r)imports" are done BEFORE all "(r)figures".

Example : rfigure 5 .4 figure fig1

[Top][Bottom][Option list]

( BRrimport) (Command :pubplot) Details for the rimport option.

[General syntax rules for this keyword.]

This option/argument string has the same meaning as "import" except that positioning and scaling are relative to the current origin and on top of whatever scaling might be in effect within the plot being drawn, respectively. All "(r)imports" are done BEFORE all "(r)figures".

Example : rimport 0 1 sketch.ps

[Top][Bottom][Option list]

( BRrotations) (Command :pubplot) Details for the rotations option.

[General syntax rules for this keyword.]

If specified the order and magnitude of the transformational rotations of the 3-dimensional axis system associated with a surface plot is established. With the right-handed orthogonal system initially oriented such that +X is rightward, +Y is upward, the axes rotation angles serve to reorient the axis system being viewed. The viewpoint and light source for the reoriented system is at infinity on the ORIGINAL positive Z-axis. The arguments which can follow the "rotations" option are in pairs. Up to 20 pairs of arguments can be specified. Each pair of arguments consists of an axis name and an angular value. Each axis name can be "roll", "pitch", or "yaw", which correspond respectively to rotations about the X, Y, and Z axes. The rotation axis-angle pairs are used in the order specified.

Example : rotations roll -30 20 yaw

[Top][Bottom][Option list]

( BRscale) (Command :pubplot) Details for the scale option.

[General syntax rules for this keyword.]

The "scale" option and following argument will cause the resulting PostScript output file to increase ("scale argument > 1.0) or decrease ("scale" argument < 1.0) in size on the page in BOTH x and y directions. Changes in size are with respect to the page's origin, which is, unless translated, near the lower left corner of the page.
.

(Begin modifications on 103102)

Once set at the beginning of the pubplot input, the value of "scale" should NOT be reset.

(End modifications on 103102)

Example : scale .5

[Top][Bottom][Option list]

( BRscreen) (Command :pubplot) Details for the screen option.

[General syntax rules for this keyword.]

If the PostScript plot file produced by "pp" is to be displayed on a video screen, it may be necessary to inform "pp" of this fact so that the proper paging commands can be inserted into the PostScript file when it is produced. Currently, there are two Unix-related screen previewers which are accommodated : "psview" and "pageview". Using the "screen" option should have no effect on the ability to successfully display the PostScript file on a printer. However, some printers have a hardware conflict with the presence of the "%%"-type structural comments lines and standard "%"-type comment lines in the same file. The "%"-type comments can be forced into a PostScript in several ways, none of which the user can defeat. Since Since the "%%"-type lines are forced by the "screen" option, if a hardcopy of a multi-page plot is most desirable then it may be advisable to NOT also include this option in the "pubplot" input. The PC and Unix versions of Ghostview will pay attention to the pagination of multi-page plots if the "pageview" argument is supplied for the "screen" option.

Example : screen pageview

[Top][Bottom][Option list]

( BRsetvoid) (Command :pubplot) Details for the setvoid option.

[General syntax rules for this keyword.]

A option which assigns a value to be used to replace any SIF variable "voided" as a result of a void file condition satisfaction along with a suffix match. The default setvoid value is -39393.

Example : setvoid -888.

[Top][Bottom][Option list]

( BRshade) (Command :pubplot) Details for the shade option.

[General syntax rules for this keyword.]

If specified, and "surface" is also specified, the following two values determine aspects of the appearance of the plot. If the first value is equal to 0 the "surface" plot will be drawn with the wireframe outlines of the facets of the surface but with the facets unshaded. Hidden lines will NOT be deleted. If the first value is less than 0 the surface facets will be drawn WITHOUT the facet outlines being drawn. If the first value is greater than 0 the surface facets will be drawn WITH the facet outlines being drawn. The default first value is 0.

The second value is optional and is used to control the shading intensity of the surface when the shading is a function of surface orientation. The default value is .4. The specified value should be between 0 and 1. The closer the value is to 1, the lighter the shading will be. The actual color of the surface is governed by the "colorkey" option arguments.

Example : shade -1 .5

[Top][Bottom][Option list]

( BRsplines) (Command :pubplot) Details for the splines option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates whether or not to draw spline between data points. The following value(s) indicate whether to draw a spline or not (0 or greater than 0, respectively) and, if a spline is to be drawn, what the enrichment factor will will be. A spline is produced by connecting original and interpolated points. The number of interpolated points is determined by an enrichment factor.

For example, if an enrichment factor is 10 then the curve will appear as though 10-3, or 7, ADDITIONAL points will be interpolated for between each original data point; three of the desired number of new interpolated points are always required for internal calculations.

If a following value = 1, then the default enrichment factor (see "enrich") is used. If a value is greater than 2 this value supersedes the default enrichment for the respective curve. A value of 2 causes NO line to be drawn.

A curve which will be drawn as a spline, can have no more than 200 data points and MUST have at least 3 points. If fewer than three points exist in a curve to be plotted as a spline the spline request will be ignored and a warning message will be issued.

Example : splines 0 1 20 1

[Top][Bottom][Option list]

( BRspsymbols) (Command :pubplot) Details for the spsymbols option.

[General syntax rules for this keyword.]

If specified allows the user to specify regions of a curve in which to change the normal symbol which would be plotted and, instead, plot an alternate symbol.

The general structure of the "spsymbols" argument list is shown below : [ crv newsym x-low x-high y-low y-high ]1 ... [ ]100

where

The first item following the "spsymbols" option must be the curve number on which to possibly draw some alternate symbol type instead of the symbol type which would normally be drawn. Following the curve number should be the symbol number of the alternate symbol which will replace the normal symbol in the designated curve region. The region is defined by the next four values : the lower X (horizontal) bound, the upper X bound, the lower Y (vertical) bound and the upper Y bound. Any data to be plotted from the respective curve with a symbol which falls in this region defined by these bounding values is subject to having its symbol refined. Up to 100 regions of up to 20 curves can be defined by repeating the specification of the six values described above.

Example : spsymbols 2 901 .4 .5 -10 10

[Top][Bottom][Option list]

( BRsubsfile) (Command :pubplot) Details for the subsfile option.

[General syntax rules for this keyword.]

If the option "subsfile" is specified, then the following name is the desired "substitution file" to examine for possible cases wherein a string should be substituted for a value. The expressed or implied values as specified as part of the "text" argument lists via asterisk-delimit sequences, or the values which would be incorporated in a key are checked for possible substituting strings in the substitution file. If a SIF variable name was given in the asterisk-delimit string, then the value is implied and is, as per the "text" option description, an average value.

For either substitution into a "text" string or into a "key", the VALUE to be used for an exact- or range-match in the substitution file is an AVERAGE value for one or more curve's data. In a key, the value used for entry into the substitution file is the average value for the respective curve being described in the key. In a text string, the value used is either the average value for the specified parameter as it exists for ALL data being considered or is the average value of that parameter from some particular specified curve number. (See the "text" option.)

The rules governing structure of a substitution file are the following :

  1. all lines are ASCII
  2. any line beginning with "* " is a comment and is ignored (asterisk + one or more blanks)
  3. blank lines are ignored
  4. free-field interpretation, therefore embedded blanks require the "?" delimiters
  5. Each line containing valid substitution specs MUST contain : in item 1, a SIF variable name to match an asterisk-delimit "title" (SIF) value; in item 2, a value which represents, if item 3 is also a value, the lower bound of a RANGE of values or, if item 3 is a name, the value to match EXACTLY; in item 3, a value which represents the upper bound of a RANGE of of values OR the (beginning of the) string to substitute for the value in question; in item 4, if there are more than 3 items specified, the (remainder of the) string to substitute for the value in question. Long strings (>16 characters) can be achieved by enclosing up to 64 characters with the standard question mark delimiters.
  6. The SIF variable name specified in item 1 WILL be translated to upper case UNLESS the "namecase" status is NOT in "force upper". (See the "namecase" and "status" commands.)

For an exclamation point-delimited SIF variable in a text string, a substitution file WILL NOT be searched EVEN if one is specified.

An example of a substitution file is the following :

*
*  Example substitution file for test ###
*
*  item  1 = name to be match for substitution
*  item  2 = either exact-match value OR
*             LOWER bound of value range
*  item  3 = either the UPPER bound of value range
*             OR the (beginning of the) substitution
*             string
*  item  4 = If value range was specified, the
*             (beginning of the) substitution string
*             If exact match was specified, this item
*             is optional and is a string continuation
*  flds 5-> = Optional string continuation
*
run  2.  ?Blunt body with vertical tail off?
run  3. 7.  ?Blunt body, vertical tails A thru E?
CONFIG  1 ?Config 1 : Ogive with lex ?

Example : subsfile subf1

[Top][Bottom][Option list]

( BRsurface) (Command :pubplot) Details for the surface option.

[General syntax rules for this keyword.]

The presence of this option indicates that the current plot is to be a "three-dimension X-Y-Z orthogonal surface plot. A surface plot is a plot in which data, which can be thought of as logically existing in three dimensions - ie, as a function of two independent X-Y variables - is plotted such that each "side" of the surface is shaded (1) as a function of either the local value of the dependent Z variable or (2) as a function of the angle between the normal to the surface and the line from the local surface to the viewpoint, which is at infinity, perpendicular to the viewplane. Which one of the above is actually done is a function of the "colorkey" settings. A surface plot must have X, Y, and Z data specified by the "x", "y", and "z" or the "xlist", "ylist" and "zlist" options, depending on whether the plot is a "force/moment" or "pressure" plot, respectively.

The colors which are used to shade a surface plot are determined by pointers to the set of colors established by the "palette" argument list. The "inside" surface is always drawn using the FIRST palette color.

The surface facet resolutions in the X and Y directions are governed by the "xtic" and "ytic" option/argument lists, respectively. The light source for a surface plot which is shaded as a function of the facet orientation is at the same position as the viewpoint.

Example : surface

[Top][Bottom][Option list]

( BRsymbfigs) (Command :pubplot) Details for the symbfigs option.

[General syntax rules for this keyword.]

If specified indicates the symbol number(s) to redefine as being drawn, instead of as its default shape, as a shape defined in a named figure on a figure file. (See the "figfile" documentation for a discussion of a figure file.) Only the symbol numbers 1->22 and 901->910, can be redefined. A symbol redefinition remains in effect until explicitly changed again. New symbol shapes can totally replace the default shape or can be drawn in addition to some other default symbol shape.

The general structure of the "symbfigs" argument list is shown below :



[ sym1  sym2  figfile  scl  X-tran  Y-tran  fig ]1 ... [ ]20
where

The first item following the "symbfigs" option must be the symbol number being redefined. Following the symbol number being redefined can be an optional symbol number to draw IN ADDITION TO the new symbol shape. If a symbol is to be also drawn it is drawn BEFORE the figure is drawn. Following these one or two items should be the name of the file which contains one or more "figures". Following the name of the figure file are three values representing the scale factor and an X and a Y translation value. The figure to be drawn instead of the symbol being redefined is normally drawn with the units as defined in the figure drawing commands. Whereas normally the "origin" reference point for a figure is either the lower left corner of the page or the current plot origin the origin of the figure when being used to redefine a symbol shape if the center of the symbol itself - or the data point position. The two X and Y translation values are expressed in inches and allow the user to adjust the position of the figure to be drawn such that the "center" of the figure will be drawn at the data point being plotted. The scale factor specified will be used to scale the figure AFTER it has had its "center" been positionally adjusted. The translation values are in inches. A scale factor less than 1.0 will reduce the size of the figure.

Following the three scale and translation values is the name of the figure to be drawn as the redefined symbol shape. (Again, see the "figure" option for a discussion of the possible contents of a figure.) Up to 20 symbol redefinitions can be specified in one or more sets of this type of 6- or 7-item argument list section.

Example : symbfigs 12 figfile .02 0 10 fig_1

[Top][Bottom][Option list]

( BRsymboff) (Command :pubplot) Details for the symboff option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, for curves which are drawn as "splines", indicates the factor to be applied to the normal distance that a line ends on both sides of a symbol for a curve which displays both lines and symbols. A value of 1. does not change the distance. A value greater than 1. offsets the spline line endings from the symbol. A value less than 1. will cause the spline lines to penetrate the symbols. A value of 0.0 will cause the spline lines to be drawn all the way up to the center of the symbol. The default symboff values are 1. Since DESL draws the default spline line up to the edge of an "effective circle" symbol, this approximation may be fine-tuned for symbols other than actual circles via the "symboff" option and argument list.

Example : symboff 1 1.5 0.

[Top][Bottom][Option list]

( BRsymbolfill) (Command :pubplot) Details for the symbolfill option.

[General syntax rules for this keyword.]

If specified the shading of the interior of the symbols of type 901 through 910 can be set to other than the default of black. Following the "symbolfill" option up to 10 pairs of values can, each, specify (1) the 900-series symbol number to reset the interior shading for and (2) the new shading factor. Shading factors can range from 0 (black) to 1 (white). The default shading for all of the 900-series symbols is 0 (black). If the particular symbol is being drawn in color then a "symbollfill" value of 0 will NOT imply a black-filled symbol but will imply a color-filled symbol.

Example : symbolfill 902 .95 904 .8

[Top][Bottom][Option list]

( BRsymbols) (Command :pubplot) Details for the symbols option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the desired symbol type(s) to be plotted. Symbol types ranging from 1 to 10 correspond to the NASA LaRC standard symbol sequence - shapes of, respectively, a circle, square, diamond, triangle, right triangle, quarter circle to right, semicircle, quarter circle to top, stretched diamond, and house. Symbol types 11 to 20 are the same as types 1 thru 10, respectively, except that they are drawn with a plus sign inside them. Symbol types 21 and 22 correspond to a dot and a plus sign, respectively.

Symbol numbers 1 through 20 can also be drawn with a "flag" protruding from their boundaries. A "flag" is a one- or two-segment line whose first segment is drawn in a radial direction from the symbol's center and whose optional second segment is drawn perpendicular to the first segment, joining the first segment at their ends. The lengths of these two segments are 6 and 4 points, respectively. These "flagged" symbols correspond to the NASA LaRC standard symbol numbers of 101 through 120, 201 through 220, ... , and 801 through 820. The position and type of flag (1 or 2 segments) is governed by the value of the symbol code. Adding 100, 200, 300, or 400 to the symbol codes of from 1 to 20 will imply a one-segment flag is to be drawn on the specified symbol. Adding 500, 600, 700, or 800 to the symbol codes of from 1 to 20 will imply a two-segment flag is to be drawn on the specified symbol. A one-segment flag is a line drawn radially on the outside of the symbol. A two-segment flag is a one-segment flag with a perpendicular segment at its end. The position at which the flag will be drawn is such that the radial line coincident with the flag's first line segment is at 45, 135, 225, or 315 degrees, respectively, as measured in a counter-clockwis direction from the positive X-axis :



.
.              ~ 45 degrees
.
.      Y-axis        /
.         |        /
.         |      /
.         |
.         |   /\ <- "flag" at 45 degrees (symbol +100 or +500)
.        ___/
.       | . | _________ X-axis
.       |___|
.


Adding 900 to the symbol numbers 1 through 10 yields the respective SOLID symbol.

If 1000 is added to the symbol type, the corresponding curve entry will be OMITTED from a key which may be drawn. The symbol type which will be used for the corresponding curve, in this case, is modulo (symb_type,1000)

.

(Begin modifications on 123002)

If 2000 is added to a solid (9xx) symbol type, the symbols drawn will be drawn with a black outline.

(End modifications on 123002)

Symbol numbers of 3x thru 6x, where "x" is 1 to 6, imply that the respective curves to be plotted are to be considered to be "delta", or "error", information. Plots of error type information are defined to be based on some other "baseline" curve also being plotted. The baseline curve must not have a symbol number in the range 31 through 99. The position of an error-type symbol number in the list of all expressed or implied symbol numbers is important. The associated baseline curve can either appear before or after the error-type symbol number. If the symbol number's tens-digit is 3 or 5 then a search is made in the backward direction in the list of symbols. If the symbol number's tens-digit is 4 or 6 then a search is made in the forward direction in the list of symbols.

If the symbol number's tens digit is 3 or 4 the type of plot which is produced is an "error bar" plot; ie, the error data is plotted as a bar or line which extends outward in one or two directions from the baseline data point's symbol. The direction of this type of line is controlled by the symbol number's ones digit : a 1 implies a line to the right, a 2 implies a line upward, a 3 implies a line leftward, and a 4 implies a line downward. A symbol number ones digit value of 5 implies 1 and 3 while a symbol number ones digit value of 6 implies 2 and 4. If the symbol number's ones digit is 5 or 6 the error type data is assumed to be applicable in both of the implied directions equally and will be drawn in such a manner. The length of the line(s) drawn outward from the base line data value is governed by the value of the error data itself.

If the symbol number's tens digit is 5 or 6 the type of plot which is produced is an "shaded error band" plot; ie, the error data is plotted as a shaded band which extends outward in one or two directions from the baseline data point's symbol. The direction of this type of shaded band is controlled by the symbol number's ones digit : a 1 implies a band to the right, a 2 implies a band upward, a 3 implies a band leftward, and a 4 implies a band downward. A symbol number ones digit value of 5 implies 1 and 3 while a symbol number ones digit value of 6 implies 2 and 4. If the symbol number's ones digit is 5 or 6 the error type data is assumed to be applicable in both of the implied directions equally and will be drawn in such a manner. The width of the band(s) drawn outward from the base line data value is governed by the value of the error data itself.

The error bar type symbols can have a perpendicular "cap" drawn at their ends. The length of this cap is controlled by the option "errorbarcap". The width of the error bar lines, including the caps, is controlled by the option "errorbarlwt" or the current color per curve as specified by the "colors" option argument list.

It is important to note a few things :

Both the baseline and the error type curves MUST have the SAME number of data points. If this is NOT the case the error type curve will be skipped. Since it is likely that the baseline data and the associated error type data will vary widely in magnitude it is important to realize that if tolerances and limits (clipping is disallowed for error type curves) are imposed it is possible to create data sets - baseline and error type - which contain a different number of data values. A worse case which could arise is that if tolerances, etc are imposed and, coincidentally, the results are that the two associated baseline and error type curves contain the SAME number of data values it is NOT guaranteed that the associated pairs of data points still logically correspond. The shade of the band is controlled by the option "errorshade" or the current color per curve as specified by the "colors" option argument list.

Up to 20 symbol types can be specified. There is no default symbol type. If no line type and no symbol type are specified, no curve will be plotted. The "colors" option can be used to cause the symbols drawn to be other than the default color of black.

Example : symbols 1 0 0 5

[Top][Bottom][Option list]

( BRsymbsize) (Command :pubplot) Details for the symbsize option.

[General syntax rules for this keyword.]

In a 1:1 correspondence with the curves to be plotted, indicates the magnification factor to be applied to the symbols of the respective curve(s). A value of 1 does not change the symbol size. The default symbsize factors are 1.

Example : symbsize 1 1.5 1

[Top][Bottom][Option list]

( BRtabs) (Command :pubplot) Details for the tabs option.

[General syntax rules for this keyword.]

This option provides the means whereby up to 26 horizontal and vertical tab locations can be explicitly set. The items following the "tabs" option MUST be in either pairs or triplets, each group of items containing (1) a 1-char-tab-name, (2) a location rightward from current plot origin in inches, and (3) an optional location upward from the current plot origin in inches. The distances in inches are before any plot scaling has occurred. The tab names can ONLY be one of the upper case characters A-Z. There are no default tab locations. If a vertical tab location is not specified it remains unset. Tab locations stay set until explicitly or implicitly changed. Tabs can also be set implicitly by any of a variety of $-type prefix control sequences.

Example : tabs A 2.3 T 1.1 6.0 R 5.444 4.0

[Top][Bottom][Option list]

( BRtext) (Command :pubplot) Details for the text option.

[General syntax rules for this keyword.]

If specified, indicates a line of text which can be printed at any location in the current frame. The option "text" is followed by two items which indicate the x and y location of the bottom left corner of the text string. These two items can be explicit values (in inches).

For the x location, the first item can also be one of "center", "centerf", "centerk", "centerpf", or "centerpk". For the y location, the second item can also be one of "top", "topf", "topk", "toppf", "toppk", "bottom", "bottomf", "bottomk", "bottompf", or "bottompk". In these cases the meanings of the prefixes "center", "top", "bottom" are, respectively, position horizontally at the "center" of the plot area in question, position vertically near the top of the plot area in

question, and position vertically near the bottom of the plot area in question. The "plot area" is determined by the string suffix. No suffix implies that the plot area is the entire figure (page). The plot area implied by the suffix "f" is the "figure" AS DRAWN THUS FAR without accounting for the extent of any key which may have also been drawn. The plot area implied by the suffix "k" is the "figure" AS DRAWN THUS FAR accounting for the extent of key(s) which may have also been drawn. The plot area implied by the "pf" suffix is the CURRENT FIGURE ONLY without accounting for the extent of any key which may have also been drawn. The plot area implied by the suffix "pk" is the CURRENT FIGURE ONLY accounting for a key which may have also been drawn.

There are six optional numeric items which may follow the x/y position values/codes. A numeric item can be skipped by entering "null". A skipped numeric argument remains set at its default value.

The first of these six is a text magnification factor. If this numeric argument is positive it represents the text magnification factor to be applied to the current text string. If this numeric argument is negative the absolute value of the number is the desired actual point size at which the current text string will be drawn, regardless of the current plot scaling and "pubnum" settings; ie, the effective text magnification value is recalculated.

The default text magnification value is 1.

The second of these six implies a box and a shading factor if the value is greater than or equal to 0 or a text shadowing effect if the value is negative.

If a box is to be drawn behind the text string, it is drawn before the text itself is drawn. The box can be filled with a shade from white to black and may have a line drawn at its perimeter according to the magnitude of this value. A value of 0 to 1 will produce a shaded box without a frame. The value 0 corresponds to black, and 1 corresponds to white. If the 0-->1 value has 10 added to it, a frame will also be drawn at the box's perimeter.

If text shadowing is to be done, the absolute magnitude of the value specified is a factor representing the fraction of the current font's point size to "white out" around each character. The time at which the white shadow is produced depends on the composition of the string being drawn.

Normally, the dollar sign special character, which is used to signal a change in font style, font size, or character position, is also the point in the overall text string where the characters UP TO THAT POINT are drawn. If a shadow is desired, the order of drawing is (1) white shadow, then (2) text string. The important point here is that a subsequent string of characters has the potential, depending on the width of the white shadow, to obscure some of the previous characters in the same text string.

This type of shadowing has the effect of hiding only the minimum "behind-text" lines, etc, which have been previously drawn.

The third of these six is used to specify a rotation angle for the text string in question. Angles are measured positive counterclockwise with 0 degrees causing the text string to move to the right, horizontally.

The fourth of these six items is a curve number. If the value specified is greater than 0 and less than or equal to the number of curves being plotted in the current plot, any averaging of values to be done in the process of completing one or more asterisk-delimit or exclamation-deli SIF variable replacements in the text string will be an average over the specified curve's data and NOT over all curves in the plot, as is the default situation. The default curve number per text string is 0.

The fifth of these six items is a text id number. If the specified value is positive, the associated text string is implied to be one which can ONLY be caused to appear as a result of a "text"-type construct in a figure file; the text string will NOT be shown at the location specified by the horizontal and vertical expressed or implied positions. (See "rfigure".) The text string will be drawn at the desired horizontal and vertical position. A specified value of 0 has no meaning and is ignored.

The sixth of these six items is a text palette color number. This color number will be used when drawing the text unless preempted by an inline "$K" string construct. The default color for the text string is black.

After the x/y position codes and the up-to six optional items which could follow, the text string itself is entered. The text string is an up-to-200 character, question-mark delimited string. The string is a line of arbitrary text, possibly including SIF variable names. Any legal PostScript "$" controlling sequences (ie, font, level codes, tabs) can be contained in a text string. (See below for more info.)

Also included in this string of characters can be up to 10 asterisk- or exclamation point-delimited constructs of the type :

  1. *file#*, where "file" serves as a option implying that the specified file's name is to be substituted in that position. Here, "#" represents a number indicating which file of the up-to-20 files possibly specified to reference, (example : *file3* implies the name of the expressed or implied file number 3),
  2. *datetag*, where "datetag" serves as a option implying that the current date and time are to be substituted in that position,
  3. * name (fmt) * or ! name (fmt) !, where "name" is a SIF variable and "(fmt)" is an optional real (E, F, or G) or integer (I) format specification, or
  4. * value *, where value is a supplied number.

Example of such strings are the following :



... text 2 6 ? Run = *run f5.0*? ... ... text 4.1 top ?Curve no. 4 from file "*file4*"? ... text center bottom ?AT *datetag*, mach = !mach!?

When the text string is printed this type of asterisk- or exclamation point-delimited string is replaced by a value, which is the value of the variable named within the string. The value of each variable indicated is an average value for the named SIF variable for the data being plotted in ALL of the curves for the current plot, except in the case where a specific curve number has been specified as the fourth value in the "text" argument list after the text "y" location parameter. In this case the averaging is limited to the specified curve.

If the delimiter used is an asterisk (*) and a valid substitution file has been specified via "subsfile" then, for each such expressed or implied value to be printed, a search through the substitution file is made to check for exact matches or range matches for the value of the SIF variable in QUESTION or, if a specific value was given, for ANY variable. If such a match is found, the corresponding string in the substitution file is inserted into the text string in place of the value in question. If, instead of the asterisk (*), the exclamation point (!) is used as a delimiter, no search will be made for a string to substitute for the value in the applicable text string EVEN IF A SUBSTITUTION FILE HAS BEEN SPECIFIED.

Only one variable is allowed per asterisk- or exclamation point-delimited string. If that variable is not found in the SIF file being printed, that delimited string is effectively eliminated from the text string. The values displayed in a text string are either in the current default format or can be printed in an optionally-speci other real format. Following each variable name a real (F, G, or E) or integer (I) format specification can be included.

There are 9 fonts which can be accessed : see "font" for styles.



Example : ...text 3 1 ?The word $12wind$11 has 2 meanings.? ...


Here, the word "wind" will be printed in Times-RomanItali font, whereas the rest of the sentence will be printed in the Times-Roman font. The default font is Times-Roman ($11).

Some characters in each of the fonts cannot be implied by entering their character in a name or title; ie, some characters which a PostScript printer can print are NOT on a keyboard. To print a character which is not on a keyboard, a 3-digit octal number corresponding to that character in the desired font can be entered, PRECEDED BY AN ESCAPING BACKSLASH.

Since the asterisk and/or exclamation point is used in the above-mentioned context for the "text" option/argument list, it should NOT be used for any other purpose in a text string.

Since the characters "*" and "!" are used to imply a substitution, they MUST be specified via the backslash and three-digit octal number if they are included in normal text.

Tables of these correspondences are found in the DESL documentation for all allowable fonts.

The capability to print characters at 3 superscript levels and 3 subscript levels also exists. If a character is preceded by either $N (default), $U, $H, $P, $D, $L, or $B then the size and position of that character, as well as remaining characters in the string in question until changed, will be affected. If a character is preceded by either $H or $P then the position only of that character, as well as remaining characters in the string in question until changed, will be affected.

The following explains the effect of each of these "$" prefixes :



$N ...... default base level, standard size
$U ...... superscript level, smaller size 1
$D ...... subscript level 1, smaller size 1
$L ...... subscript level 2, smaller size 2
$B ...... subscript level 3, smaller size 3
$H ...... higher than $U   , standard size
$P ...... higher than $H   , standard size


An example of a text string with the above text changes is the following :



...text 1 3 ?C$DL$L $41a$11 $U2$N as a function of $41a?

Again, the "$"-prefixed font and vertical placement codes remain in effect until changed or the string containing them ends.

The following explains the effect of other "$" prefixes :



$K## ..... color set, color no. = palette no.
$^c ...... horiz/vert tab set
$Tc ...... horiz tab positioning, left just
$Cc ...... horiz tab positioning, centering
$Vc ...... vert tab positioning
$Ec ...... implies $T and $V tab positioning
$Fc ...... implies $C and $V tab positioning
$M# ...... font size change (in assoc with "maglevels")
$^### .... upward vert delta-positioning
$<### .... leftward horiz delta-positioning
$>### .... rightward horiz delta-positioning
$v### .... downward vert delta-positioning
$S### .... draw symbol number
$s### .... set symbol scale factor
$u ....... mark the beginning of an underlining
$e## ..... underline from "u"-mark to current position
$l## ..... set line type (must follow "$d###" syntax)
$d### .... set length of line to be drawn and draw it.
Must predeed "$l##" syntax.
$w## ..... set "$"-sign-related "line-width"
$xy ...... font control (See "font" option.)


Setting a color can be achieved by inclusion of the "$K#" string, where "#" represents a 2-DIGIT palette color number. A color number of 00 represents the default color which is black. A color setting established via this type string remains in effect until the string ends or until another "$K#" string is encountered in the same string.

Both horizontal and vertical "tab" position setting and use can be achieved by inclusion of the "$^c", $Tc, $Vc and "$Cc" strings, where "c" represents an upper-case letter, A-Z, implying tab setting 0 to 26, respectively.

The "^" character indicates a tab to set. When a tab is set both its horizontal and vertical positions are stored. A "T", "C", "V", "E", or "F" indicates a tab to use, either left-justified horizontally at the tab, centered horizontally about the tab positioned vertically at the tab, left-justified horizontally AND positioned vertically, or centered horizontally AND positioned vertically, respectively. Once set, a tab remains set and referenceable until changed.

A substring which is used to establish a tab position for a centered ("C" or "F") type tab extends to the next tab definition ("T", "C", "E", or "F") or to the end of the string, whichever is encountered first.

A examples of a text string with tabbing control are the following :



...text center top ?Figure 3. $^BThe Effect of sweep?

...text center top ?$TBon yawing moment.?

On-the-fly magnification can be achieved by inclusion of the "$M#" string, where "#" represents a magnification level index, 0 to 9, previously defined by the "maglevels" option and argument list. Any magnification thus invoked is effective until changed and is in addition to any other magnification factor which may already be in effect.

An example of a text string with magnification control is the following :



...maglevels 0 1.5 text center top ?Figure 3. The Effect of $M0sweep? ...

Example positioning of text ANYWHERE on the page is possible via the use of the "$*###" string, where "*" represents one of the directional symbols, <, v, >, or ^ and "###" represents a THREE-DIGIT value, in points (1 point = 1/72 inch). The directional symbols, <, v, >, and ^ move the current position in the leftward, downward, rightward, and upward directions, respectively. For example, $<023 will reset the current position 23 points to the left of where it previously was. Three digits MUST be used for the magnitude of the movement.

A legitimate symbol number can be drawn via the use of the "$S###" construct, where "###" represents a 3-digit symbol number. Attention may need to be paid to the vertical position of the symbol as it will be drawn at the current vertical position. If the symbol number implies an error-bar type symbol it can ONLY be values of 031 through 036. (See "symbol" option discussion.)

A symbol scale factor can be set via the use of the "$s###" construct, where "###" represents a 3-digit value. Here, the three digit number DIVIDED BY 100. yields the symbol magnification factor for any symbol drawn via the "$S" construct.

The width of both the underline line drawn with the "$u" and "$e##" constructs and the standard line drawn with the "$l##" and "$d###" constructs are governed by the value set via the "$w##" construct, where the "##" represents a 2-digit number of points.

Underlining can be achieved by the two-step process begun by the "$u" construct and ended by the "$e##" construct. The "$u" indicates that the current position is to be marked for use by a subsequent "$e##" which will actually cause the underlining to be drawn to the current position where the "$e##" is encountered. The 2-digit number, "##", following the "$e" is a number of points to shift below the current vertical position to move before drawing the solid underline line. The width of the solid line is governed by the "$w##" construct.

A line of any legitimate style can be drawn via the use of the "$d###" and "$l##" constructs. The "$d###" construct defines the length of the line to be drawn. The 3-digit number represented by "###" is the line length and is in points. The "$l##" construct indicates that a line is to be drawn NOW and is to be of the style "##". (See "lines" option.) The width of the solid line is governed by the "$w##" construct. Attention may need to be paid to the vertical position of the line as it will be drawn at the current vertical position..

Example : text center 3.5 .8 ?Cntrd text at y = 3.5?

[Top][Bottom][Option list]

( BRtextframe) (Command :pubplot) Details for the textframe option.

[General syntax rules for this keyword.]

If specified the next four values indicate, respectively, the shift in the x position of the left text border edge, the shift in the x position of the right text border edge, the shift in the y position of the top text border edge and the shift in the y position of the bottom text border edge in points (1 point = 1/72 inch). The default values of the shift are 0.

Example : textframe 0 0 -2 2

[Top][Bottom][Option list]

( BRtextsleep) (Command :pubplot) Details for the textsleep option.

[General syntax rules for this keyword.]

If specified, the following value is the number of "text" lines which will NOT be cleared at the NEXT "reset *text" but will, instead, remain defined. Therefore, the relative ORDER in the argument list of "textsleep" and "reset *text" IS important. If the value specified for "textsleep" is greater than 0 NO text lines will be printed for the current plot. Text lines are numbered sequentially as they are encountered in an argument list. The default number of "textsleep" lines is 0.

Example : textsleep 2

[Top][Bottom][Option list]

( BRtranslate) (Command :pubplot) Details for the translate option.

[General syntax rules for this keyword.]

Inclusion of the "translate" option followed by one or two values will cause the x or x and y origin(s), respectively, of the output "frames" to be shifted by the number of INCHES specified. Any translation done is done with any "scale" scale factor ALREADY applied; therefore, inches translated are scaled FIRST before the translation is really done.

Example : translate 3 4

[Top][Bottom][Option list]

( BRtvspace) (Command :pubplot) Details for the tvspace option.

[General syntax rules for this keyword.]

If specified, indicates a factor to be applied to the normal spacing between lines of text to be printed via the "bottom" type implicit vertical text positioning. The default value of "tvspace" is 1., meaning that the normal spacing is not changed. A value of "tvspace" of less than 1.0 implies a smaller vertical spacing.

Example : tvspace .75

[Top][Bottom][Option list]

( BRtype) (Command :pubplot) Details for the type option.

[General syntax rules for this keyword.]

This option allows the user to indicated what type of plot to produce . The allowable types of plot which can be done are : "force/pressure" (default type), "polar", "log" or "log-log", "log-normal", and "normal-log". In the latter three types of plot the first word of the hyphenated pair applies to the X axis and the second word applies to the Y axis. If the type of plot is "force/pressure" then whether a "force" or "pressure" plot is to be done is determined by the order of the specification of the "x"/"xlist" and "y"/"ylist" options. Specification of "x" or "y" before "xlist" or "ylist" implies that a "force" plot is to be done. The reverse circumstances imply, without the "type" option specified, a "pressure" plot is to be done. If a polar plot is to be done the data should be amenable to being treated as data which has an inherent polar nature; ie, either the x or y variable should be in angular units and the other variable in radial units.

Example : type polar

[Top][Bottom][Option list]

( BRvfile) (Command :pubplot) Details for the vfile option.

[General syntax rules for this keyword.]

Indicates the name of the file containing the lines of (1) condition(s) and/or (2) condition(s) AND a suffix to use to check for (1) SIF records or (2) SIF variables to "void" (or keep, if "keep" is the first non-comment line seen) as each DATA record of each SIF file named in the "files" argument list is processed.

"Voiding" in these two cases means two different things:

(1) If all conditions on the same line are TRUE and a suffix has NOT also been specified, then the entire SIF record which has satisfied the conditions is ignored (or kept if "keep" is the FIRST line of the void file). (2) If all conditions on the same line are TRUE and a suffix HAS been specified as the last item on a void file line, the SIF record is NOT ignored but, rather, the values of up to 200 SIF variables whose names end in the suffix specified are changed to the value associated with the specified or default "setvoid" value. (See the "setvoid" option.)

The structure of a valid void file must adhere to the following rules :

  1. Any line beginning with an asterisk followed by at least one blank space is considered a comment and is ignored.
  2. Blank lines are ignored.
  3. The string "keep" may be encountered as the first non-comment line.
  4. There may be an unlimited number of lines in a void file.
  5. From the point issued until "nulled", abbreviations, which can be included anywhere in the void file within a line containing conditions, can be used as a "shorthand" for any part of a condition. Abbreviations are defined in lines which BEGIN with at least the first 4 characters of the word "abbreviation" and are followed, on the same line, by PAIRS of items : the first in each pair IS the abbreviation and the second in each pair is the string to be substituted for an encountered abbreviation. Up to 1750 abbreviations can be defined. If strings to be substituted for abbreviations contain one of the 2-character logical operators (see below) any blanks which end this string will be ignored; ie, "conditions" should be constructed such that at least one blank will delimit items AFTER any substitutions have been made. Abbreviations can be activated and deactivated or replaced as the void file is processed. If an abbreviation is encountered which is the same as one which has already been defined, the new one replaces the old one unless the string to be substituted for the abbreviation is the string "null". In this case the existing abbreviation is eliminated.
  6. Each line which is not blank, not a comment, not "keep" and does not contain one or more abbreviations can contain up to 20 "conditions" and an optional suffix or it will be ignored.
  7. A "condition" is a three-item group of items which is of the form : name/value logical name/value where, "name/value" represents either a SIF name OR a constant value, and "logical" represents one of the allowable nine 1- or 2-character logical operators : eq, =, lt. <, le, ge, gt, >, or ne. An illegally formed condition will cause the line containing it to be skipped and cause a message to be issued to this effect.
  8. A suffix is any string which will be used to try to match the END of up to 200 SIF names corresponding to values in the pertinent SIF record.

Before the void file is used, by specifying "vfile" rather than "vfilen", and if the DESL session is purely interactive, the user will have the opportunity to edit the void file.

An EXAMPLE of a void file is the following :



*
* a comment line
*
* assign "ple" and "re" abbreviations
*
abbr  ple  ?point  le?  re  ?run  =?
run=10  point  ge  101  point  le  120
re  10  point  ge  153  ple  156  un32
*
* deassign "ple" abbreviation
*
abbr  ple  null
re  12  point  ge  101  point  le  120
*
*


An EXAMPLE of a "keep" file is the following :



* * a comment line * keep * * assign "ple" and "re" abbreviations * abbr ple ?point le? re ?run =? run=10 point ge 101 ple 120 re 12 point ge 101 point le 120 * *

Example : vfile void1

[Top][Bottom][Option list]

( BRvfilen) (Command :pubplot) Details for the vfilen option.

[General syntax rules for this keyword.]

This option has the same meaning as "vfile" except that the user is NOT given the opportunity to edit the void file before it is used.

[Top][Bottom][Option list]

( BRvoidval) (Command :pubplot) Details for the voidval option.

[General syntax rules for this keyword.]

Indicates the variable value (SINGLE following value) or range of values (TWO following values) for which, if a pertinent variable's value is equal or falls within, respectively, will cause that variable TO BE CONSIDERED "void". A "pertinent" variable is the "x"- or "y"-axis variable.

During plotting, "voided" values of either the independent OR dependent variable cause the display of the corresponding PAIR of values to be essentially skipped.

Example : voidval -888

[Top][Bottom][Option list]

( BRvzero) (Command :pubplot) Details for the vzero option.

[General syntax rules for this keyword.]

If specified, for a non-"polar" type plot, the following value is the x-axis value at which to draw a "heavy" vertical line which will have the same extent as the y-axis. The default line width for this heavy line is 1 (NOT heavy.) Following the value indicating the x-axis value, a second optional value can be specified indicating the desired line width to be used for the heavy line.

Following the line weight value can be a third item specifying the line type vertical line to be drawn. The default line type is a solid line (type 1). The possible line types are as indicated in the "lines" documentation.
.

(Begin modifications on 052102)

Following the line type value can be a fourth item specifying the vertical line color to be drawn. The value specified is a valid palette color number.

(End modifications on 052102)

For a "polar" type plot the implication of "vzero" is dependent on the value of the xaxis or yaxis code specified. A summary of the actions taken for different values of "xaxis" and "yaxis" is as follows, where "NUM1" and "NUM2" are the two values which can follow "vzero" :



"xaxis" specified

heavy circle at NUM1, weight factor of line is NUM2

"yaxis" specified

heavy radial at angle = NUM1 degrees, weight factor of line is NUM2

Example : vzero 1 2.5

[Top][Bottom][Option list]

( BRx) (Command :pubplot) Details for the x option.

[General syntax rules for this keyword.]

Indicates the x-axis SIF variables to plot. There is an implicit 1:1 correspondence between the "x" name(s) specified and the list of file name(s) specified or implied via "files". If fewer "x" names are specified than the number of curves to be plotted, the last "x" name specified will be EXTENDED to complete the necessary 1:1 file name correspondence. Specification of "x" before "xlist" or "ylist" implies that a "force" type plot is to be done; ie, each plot produced will contain only one curve per file. Any "x" variable which is NOT found in the respective SIF file causes plotting of the respective curve to be skipped. (See the "notify" option.) Up to 20 x-axis variables can be specified.

Example : x alpw alpw alpha2 alpw

[Top][Bottom][Option list]

( BRxan) (Command :pubplot) Details for the xan option.

[General syntax rules for this keyword.]

If specified, the following value is a code indicating which axis tic annotation strings are NOT to be drawn. 1 indicates the xmin annotation string is to be skipped. 2 indicates the xmax annotation string is to be skipped. 3 indicates the xmin and xmax annotation strings are to be skipped. This feature is useful in eliminating the overwriting of axes annotation strings on plots which appear to be joined.

Example : xan 2

[Top][Bottom][Option list]

( BRxaninc) (Command :pubplot) Details for the xaninc option.

[General syntax rules for this keyword.]

If specified, the following values indicate the horizontal and vertical increments, in inches, in the x-axis major tic annotation positioning. If the plot is NOT a log plot one or two values can follow "xaninc". The first value is the increment in the horizontal positioning of the tic label. If only one value is specified, the vertical axis tic label increment is 0. If two values are specified, the second value is the vertical axis tic label increment. If the plot is a log plot there are two additional allowable values which can be specified. The first is the horizontal log-axis "10 to the x" label position increment. The second is the vertical log-axis "10 to the x" label position increment. Unspecified "10 to the x" label positioning increments are 0.

Example : xaninc .25 -.1

[Top][Bottom][Option list]

( BRxaxdec) (Command :pubplot) Details for the xaxdec option.

[General syntax rules for this keyword.]

If specified, the following value indicates the desired MAXIMUM number of decimal places to display on x-axis tic mark annotation. If the value is specified as a negative number, its absolute value will be the number of decimal places displayed. If the value is greater than 0, then DESL may reduce the number of decimal places. The default number of decimal places is 3.

Example : xaxdec 4

[Top][Bottom][Option list]

( BRxaxis) (Command :pubplot) Details for the xaxis option.

[General syntax rules for this keyword.]

If this option is specified the following coded numeric argument indicates the desired x-axis style to be drawn on the current plot. Unless the axis code is 0, a label will always be drawn if one is defined. The allowable code values which can follow "xaxis" are the following :

Plot Type : "force or pressure", "log" / "log-log" / "log-normal"

code ... meaning

code+1000 ==> Minor tics NOT drawn code+2000 ==> No tics drawn

Plot Type : polar

code ... meaning

For polar plots, "theta" is an angle measured counterclockwise from the positive x-axis horizontal.

In general, specification of a polar plot "xaxis" code will force a conversion of the x/y data to radius/theta or theta/radius data. It IS legitimate to force this conversion at the same time a contour plot is being done.

If both "xaxis" and "yaxis" are set, either explicitly or by default, and the plot is a "polar" plot, the "xaxis" setting will take precedence.

Example : xaxis 33

[Top][Bottom][Option list]

( BRxclip) (Command :pubplot) Details for the xclip option.

[General syntax rules for this keyword.]

If this option is specified the following "on" or "off" string indicates that data clipping for x is to occur if the data to be plotted falls outside of the scale limits specified. If "notify" is "on" and if one or more data points are clipped from the plot, a "c" surrounded by a circle will appear just outside the origin of the current plot. The default state is "xclip on". Data which is clipped is treated as though it were never to be plotted; ie, it may NOT be apparent, if "notify" is "off", that any data has been clipped.

Example : xclip off

[Top][Bottom][Option list]

( BRxcomp) (Command :pubplot) Details for the xcomp option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired x-axis compression factor. The default compression factor is 1.0; ie, no compression. Specification of such a compression factor has the effect of changing the "units per inch" implied or set by "xdelta".

Example can be accomplished by specifying a compression factor greater than 1. The value of "xcomp" is automatically implied and, if specified, overridden if BOTH "xdelta" and "xlen" are specified.

Example : xcomp .75

[Top][Bottom][Option list]

( BRxdelta) (Command :pubplot) Details for the xdelta option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired x-axis scale increment in units per inch. For "inverted" plotting, the maximum("xmax") can be algebraically less than the minimum ("xmin"). For inverted plotting, the "xdelta" value should be negative.

If the plot is to be logarithmic on the x axis, the "xdelta" value serves only, along with the "xmin" and "xmax" options to establish the length of the x axis. A logarithmic plot cannot be drawn inverted.

Example : xdelta 2

[Top][Bottom][Option list]

( BRxexp) (Command :pubplot) Details for the xexp option.

[General syntax rules for this keyword.]

If specified, the following "on" or "off" indicates that scientific notation IS ("on") or IS NOT ("off") allowed in the x-axis annotation. The default state is "off".

Example : xexp on

[Top][Bottom][Option list]

( BRxfactor) (Command :pubplot) Details for the xfactor option.

[General syntax rules for this keyword.]

If this option is specified the following numeric arguments in a 1:1 correspondence with the curves to be plotted are the values by which the "x" component(s) of each curve's data to be plotted will be multiplied by before it is plotted. Up to 20 values can be specified. The default "xfactor" value, per curve, is 1.0. The "xfactor" value is applied BEFORE the "xoff" value, immediately after the data is accessed.

Example : xfactor -1 1 -1

[Top][Bottom][Option list]

( BRxftic) (Command :pubplot) Details for the xftic option.

[General syntax rules for this keyword.]

If this option is specified the x-axis minor tic marks, if they would normally occur, will still occur even if a fine grid is to be drawn.

Example : xftic

[Top][Bottom][Option list]

( BRxlabel) (Command :pubplot) Details for the xlabel option.

[General syntax rules for this keyword.]

Indicates the label to be displayed horizontally below the x-axis. There is no default x-axis label. If a label file is active (see "labfile" option), before the specified x-axis label is drawn, the label file is checked to see if the specified label can be translated to another string. If it can, it will be and the new string translation will appear on the plot. The starting position of the label can be changed via use of the "xlabinc" option. The maximum length of an axis label (before "label file" use) is 16 characters.

Example : xlabel $41a

[Top][Bottom][Option list]

( BRxlabinc) (Command :pubplot) Details for the xlabinc option.

[General syntax rules for this keyword.]

If specified, the following one or two values represent the x OR x and y INCREMENTS in x-axis label starting position in inches. Positive x and y increments move the label to the right and up, respectively.

Example : xlabinc -.2 0

[Top][Bottom][Option list]

( BRxlen) (Command :pubplot) Details for the xlen option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired x-axis scale length. Only 3 out of 4 of "xmin", "xmax", "xdelta", and "xlen" are sufficient to define the scale origin and length. If BOTH "xlen" and "xdelta" are specified, "xcomp" is implied and, if specified, overridden.

Example : xlen 10

[Top][Bottom][Option list]

( BRxlist) (Command :pubplot) Details for the xlist option.

[General syntax rules for this keyword.]

Indicates expressly or implicitly the "x" SIF variables to plot per curve. If values are specified, these ARE the variable values to use in plotting; ie, no respective values will be extracted from a SIF file. Even if ALL "xlist" AND "ylist" entries for a particular curve have been expressly defined with values, a corresponding SIF file must STILL be named or implied.

Up to 20 sets of variables can be specified via the value of the "curve-id" set number.

.

(Begin modifications on 052102)

All specified "xlist" sets combined must have no more than 50000 elements.

(End modifications on 052102)

There must be equal numbers of "xlist" and "ylist" members for each respective curve-id specified.

Specification of "xlist" before either "x" or "y" implies that a "pressure" type plot is to be done; ie, one plot is to be produced for each SIF data record for each file. (See the "notify" option.)

Each plot will contain 1 curve per "set" of "xlist" and "ylist" variables specified from one file at a time. The list of x-axis names/values which follow the curve-id number can include one or more of four special forms of implicit expansion methods : "curve", "thru", "at", and "to/by". If "curve" is used, a "curvefile" MUST be active. (See "curvefile" option.)



Examples:

xlist 5 cp11 curve curve1 cp36 xlist 3 p101 p104 thru p122 p133 xlist 1 13 at 1.22 4 at 1.445 xlist 2 1 to 10 by 1 xlist 6 2 at 6 11 to 4 by -1 curve c1 cp12 thru cp18

[Top][Bottom][Option list]

( BRxloglab) (Command :pubplot) Details for the xloglab option.

[General syntax rules for this keyword.]

If specified the following 2-digit value represents a code indicating, per digit, from the left, (1) how to draw the powers-of-10 axis annotation and (2) the frequency of intermediate tic labeling per log cycle on an logarithmic x-axis.

The tens digit corresponds to (1) above. The values it can legitimately be set to and their meanings are summarized below :



0   Powers-of-10 labels : none
1   Powers-of-10 labels : Large
2   Powers-of-10 labels : Small


The ones digit corresponds to (2) above. The values it can legitimately be set to and their meanings are summarized below :



0   Intermediate labels : none
1   Intermediate labels : 1,2,3,4,5,6,7,8,9,1
2   Intermediate labels : 1,2,4,6,8,1
3   Intermediate labels : 1,3,5,7,9,1
4   Intermediate labels : 1,5,1
5   Intermediate labels : 1,1
6   Intermediate labels : 2,3,4,5,6,7,8,9
7   Intermediate labels : 2,4,6,8
8   Intermediate labels : 3,5,7,9
9   Intermediate labels : 5


Normally the powers-of-10 labeling is drawn "outside" of any intermediate labeling. If no intermediate labeling is to be done the powers-of-10 labeling moves closer to the x axis. The default logarithmic x-axis labeling value is 14.

Example : xloglab 21

[Top][Bottom][Option list]

( BRxmax) (Command :pubplot) Details for the xmax option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired x-axis scale maximum. For "inverted" plotting, the maximum("xmax") can be algebraically less than the minimum ("xmin"). For inverted plotting, the "xdelta" value should be negative. Inverted logarithmic plots are NOT allowed. Also, for logarithmic plotting, the expressed and/or implied minimum and maximum values will determine the number of cycles to draw. Each cycle begins and ends at 1.

Example : xmax 100

[Top][Bottom][Option list]

( BRxmin) (Command :pubplot) Details for the xmin option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired x-axis scale minimum. For "inverted" plotting, the maximum("xmax") can be algebraically less than the minimum ("xmin"). For inverted plotting, the "xdelta" value should be negative. Inverted logarithmic plots are NOT allowed. Also, for logarithmic plotting, the expressed and/or implied minimum and maximum values will determine the number of cycles to draw. Each cycle begins at 1.

Example : xmin -10

[Top][Bottom][Option list]

( BRxoff) (Command :pubplot) Details for the xoff option.

[General syntax rules for this keyword.]

If this option is specified the following numeric arguments, in a 1:1 correspondence with the curves to be plotted, are the values, in the units of the x variable, by which the "x" component(s) of each curve's data to be plotted will be offset before it is plotted. Up to 20 values can be specified. The default "xoff" value, per curve, is 0. The "xfactor" value is applied BEFORE the "xoff" value.

Example : xoff 5

[Top][Bottom][Option list]

( BRxoffset) (Command :pubplot) Details for the xoffset option.

[General syntax rules for this keyword.]

If this option is specified the following one or two numeric arguments, are, respectively, the horizontal and vertical distances in inches, to offset the X axis from its standard position. A positive horizontal distance moves the X axis rightward and positive vertical distance moves the X axis upward. If the vertical distance is not specified it is set to its default value of 0. The default for both axis offset distances is 0.

Example : xoffset -.5 0

[Top][Bottom][Option list]

( BRxtic) (Command :pubplot) Details for the xtic option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired x-axis minor tic increments to be drawn per major tic mark.

The default number of minor tic increments per major tic mark is 2. If the x-axis is logarithmic, the effective value of xtic is halved above 6.0 in each cycle drawn. If the plot is of type "polar", the "xtic" argument will establish the number of radial or concentric fine grid lines to draw. Which it determines is a function of the "xaxis" or "yaxis" code specified.

If the plot is a surface plot the "xtic" argument serves to indicate the desired resolution of the surface in the X direction. Higher "xtic" values result in more surface facets but also greater time required to compute the resultant surface to draw. A combined X and Y maximum for number of surface facets is 15000.

Example : xtic 4

[Top][Bottom][Option list]

( BRxtol) (Command :pubplot) Details for the xtol option.

[General syntax rules for this keyword.]

If specified, the following value is the allowable tolerance between successive "x" data points to be plotted. Values which occur in succession closer than an amount specified via this tolerance option are eliminated from the data to be plotted. If the "xtol" value is positive, it is absolute; ie, its units are the same as those of the x variable. If the value specified is negative, the absolute magnitude of the value is the tolerance IN PERCENT. The default value of "xtol" is 0.

Example : xtol .05

[Top][Bottom][Option list]

( BRxtrapts) (Command :pubplot) Details for the xtrapts option.

[General syntax rules for this keyword.]

If specified, the following value, in "points", is the ADDITIONAL space to be allotted to inter-word blank spacing. This is a means to spread out, by increasing the word gap size, a text string.

Example : xtrapts 8

[Top][Bottom][Option list]

( BRy) (Command :pubplot) Details for the y option.

[General syntax rules for this keyword.]

Indicates the y-axis SIF variables to plot. There is an implicit 1:1 correspondence between the "y" name(s) specified and the list of file name(s) specified or implied via "files". If fewer "y" names are specified than the number of curves to be plotted, the last "y" name specified will be EXTENDED to complete the necessary 1:1 file name correspondence. Specification of "y" before "xlist" or "ylist" implies that a "force" type plot is to be done; ie, each plot produced will contain only one curve per file. Any "y" variable which is NOT found in the respective SIF file causes plotting of the respective curve to be skipped. (See the "notify" option.) Up to 20 y-axis variables can be specified.

Example : y cl cl cl2 cl

[Top][Bottom][Option list]

( BRyan) (Command :pubplot) Details for the yan option.

[General syntax rules for this keyword.]

If specified, the following value is a code indicating which axis tic annotation strings are NOT to be drawn. 1 indicates the ymin annotation string is to be skipped. 2 indicates the ymax annotation string is to be skipped. 3 indicates the ymin and ymax annotation strings are to be skipped. This feature is useful in eliminating the overwriting of axes annotation strings on plots which appear to be joined.

Example : yan 2

[Top][Bottom][Option list]

( BRyaninc) (Command :pubplot) Details for the yaninc option.

[General syntax rules for this keyword.]

If specified, the following values indicate the horizontal and vertical increments, in inches, in the y-axis major tic annotation positioning. If the plot is NOT a log plot one or two values can follow "yaninc". The first value is the increment in the horizontal positioning of the tic label. If only one value is specified, the vertical axis tic label increment is 0. If two values are specified, the second value is the vertical axis tic label increment. If the plot is a log plot there are two additional allowable values which can be specified. The first is the horizontal log-axis "10 to the x" label. The second is the vertical log-axis "10 to the x" label. Unspecified "10 to the x" label positioning increments are 0.

Example : yaninc .25 -.1

[Top][Bottom][Option list]

( BRyaxdec) (Command :pubplot) Details for the yaxdec option.

[General syntax rules for this keyword.]

If specified, the following value indicates the desired MAXIMUM number of decimal places to display on y-axis tic mark annotation. If the value is specified as a negative number, its absolute value will be the number of decimal places displayed. If the value is greater than 0, then DESL may reduce the number of decimal places. The default number of decimal places is 3.

Example : yaxdec 4

[Top][Bottom][Option list]

( BRyaxis) (Command :pubplot) Details for the yaxis option.

[General syntax rules for this keyword.]

If this option is specified the following coded numeric argument indicates the desired y-axis style to be drawn on the current plot. Unless the axis code is 0, a label will always be drawn if one is defined. The allowable code values which can follow "yaxis" are the following :

Plot Type : "force or pressure", "log" / "log-log" / "log-normal"

code meaning

Plot Type : polar

code meaning

For polar plots, "theta" is an angle measured counterclockwise from the positive x-axis horizontal.

In general, specification of a polar plot "yaxis" code will force a conversion of the x/y data to radius/theta or theta/radius data. It IS legitimate to force this conversion at the same time a contour plot is being done.



If both "xaxis" and "yaxis" are set, either explicitly or by
default, and the plot is a "polar" plot, the "xaxis" setting
will take precedence.


Example : yaxis 33

[Top][Bottom][Option list]

( BRyclip) (Command :pubplot) Details for the yclip option.

[General syntax rules for this keyword.]

If this option is specified, the following "on" or "off" string indicates that data clipping for y is to occur if the data to be plotted falls outside of the scale limits specified. If "notify" is "on" and if one or more data points are clipped from the plot, a "c" surrounded by a circle will appear just outside the origin of the current plot. The default state is "yclip on". Data which is clipped is treated as though it were never to be plotted; ie, it may NOT be apparent, if "notify" is "off", that any data has been clipped.

Example : yclip off

[Top][Bottom][Option list]

( BRycomp) (Command :pubplot) Details for the ycomp option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired y-axis compression factor. The default compression factor is 1.0; ie, no compression. Specification of such a compression factor has the effect of changing the "units per inch" implied or set by "ydelta".

Example can be accomplished by specifying a compression factor greater than 1. The value of "ycomp" is automatically implied and, if specified, overridden if BOTH "ydelta" and "ylen" are specified.

Example : ycomp .75

[Top][Bottom][Option list]

( BRydelta) (Command :pubplot) Details for the ydelta option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired y-axis scale increment in units per inch. For "inverted" plotting, the maximum("ymax") can be algebraically less than the minimum ("ymin"). For inverted plotting, the "ydelta" value should be negative.

If the plot is to be logarithmic on the y axis, the "ydelta" value serves only, along with the "ymin" and "ymax" options to establish the length of the y axis. A logarithmic plot cannot be drawn inverted.

Example : ydelta 2

[Top][Bottom][Option list]

( BRyexp) (Command :pubplot) Details for the yexp option.

[General syntax rules for this keyword.]

If specified, the following "on" or "off" indicates that scientific notation IS ("on") or IS NOT ("off") allowed in the y-axis annotation. The default state is "off".

Example : yexp on

[Top][Bottom][Option list]

( BRyfactor) (Command :pubplot) Details for the yfactor option.

[General syntax rules for this keyword.]

If this option is specified the following numeric arguments in a 1:1 correspondence with the curves to be plotted are the values by which the "y" component(s) of each curve's data to be plotted will be multiplied by before it is plotted. Up to 20 values can be specified. The default "yfactor" value, per curve, is 1.0. The "yfactor" value is applied BEFORE the "yoff" value, immediately after the data is accessed.

Example : yfactor -1 1 -1

[Top][Bottom][Option list]

( BRyftic) (Command :pubplot) Details for the yftic option.

[General syntax rules for this keyword.]

If this option is specified the y-axis minor tic marks, if they would normally occur, will still occur even if a fine grid is to be drawn.

Example : yftic

[Top][Bottom][Option list]

( BRylabel) (Command :pubplot) Details for the ylabel option.

[General syntax rules for this keyword.]

Indicates the label to be displayed horizontally to the left of the y-axis. There is no default y-axis label. If a label file is active (see "labfile" option), before the specified y-axis label is drawn, the label file is checked to see if the specified label can be translated to another string. If it can, it will be and the new string translation will appear on the plot. If it desired that the y-axis label be drawn vertically the "ylabrot" option can be used. The starting position of the label can be changed via use of the "ylabinc" option. The maximum length of an axis label (before "label file" use) is 16 characters.

Example : ylabel C$DL

[Top][Bottom][Option list]

( BRylabinc) (Command :pubplot) Details for the ylabinc option.

[General syntax rules for this keyword.]

If specified, the following one or two values represent the x OR x and y INCREMENTS in y-axis label starting position in inches. Positive x and y increments move the label to the right and up, respectively.

Example : ylabinc 0 -.5

[Top][Bottom][Option list]

( BRylaboff) (Command :pubplot) Details for the ylaboff option.

[General syntax rules for this keyword.]

If specified, the following value will be the distance, in inches, from the vertical axis for the initial placement of the y-axis label. The label is left or right justified on this position depending on which side of the plot the axis is on. The normal initial position for the y-axis label is a function of the axis tic annotation widths, and can therefore be variable from plot to plot.

Example : ylaboff .5

[Top][Bottom][Option list]

( BRylabrot) (Command :pubplot) Details for the ylabrot option.

[General syntax rules for this keyword.]

If specified the y-axis label will drawn vertically. The default orientation of this label is horizontal. This option has NO effect if the plot is of a type other than "force/pressure"

[Top][Bottom][Option list]

( BRylen) (Command :pubplot) Details for the ylen option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired y-axis scale length. Only 3 out of 4 of "ymin", "ymax", "ydelta", and "ylen" are sufficient to define the scale origin and length. If BOTH "ylen" and "ydelta" are specified, "ycomp" is implied and, if specified, overridden.

Example : ylen 5

[Top][Bottom][Option list]

( BRylist) (Command :pubplot) Details for the ylist option.

[General syntax rules for this keyword.]

Indicates expressly or implicitly the "y" SIF variables to plot per curve. If values are specified, these ARE the variable values to use in plotting; ie, no respective values will be extracted from a SIF file. Even if ALL "xlist" AND "ylist" entries for a particular curve have been expressly defined with values, a corresponding SIF file must STILL be named or implied. Up to 20 sets of variables can be specified via the value of the "curve-id" set number.

.

(Begin modifications on 052102)

All specified "ylist" sets combined must have no more than 50000 elements.

(End modifications on 052102)

There must be equal numbers of "xlist" and "ylist" members for each respective curve-id specified.

Specification of "ylist" before either "x" or "y" implies that a "pressure" type plot is to be done; ie, one plot is to be produced for each SIF data record for each file. (See the "notify" option.)

Each plot will contain 1 curve per "set" of "xlist" and "ylist" variables specified from one file at a time. The list of y-axis names/values which follow the curve-id number can include one or more of four special forms of implicit expansion methods : "curve", "thru", "at", and "to/by". If "curve" is used, a "curvefile" MUST be active. (See "curvefile" option.)



Examples:

ylist 5 cp11 curve curve1 cp36 ylist 3 p101 p104 thru p122 p133 ylist 1 13 at 1.22 4 at 1.445 ylist 2 1 to 10 by 1 ylist 6 2 at 6 11 to 4 by -1 curve c1 cp12 thru cp18

[Top][Bottom][Option list]

( BRyloglab) (Command :pubplot) Details for the yloglab option.

[General syntax rules for this keyword.]

If specified the following 2-digit value represents a code indicating, per digit, from the left, (1) how to draw the powers-of-10 axis annotation and (2) the frequency of intermediate tic labeling per log cycle on an logarithmic y-axis.

The tens digit corresponds to (1) above. The values it can legitimately be set to and their meanings are summarized below :



0   Powers-of-10 labels : none
1   Powers-of-10 labels : Large
2   Powers-of-10 labels : Small


The ones digit corresponds to (2) above. The values it can legitimately be set to and their meanings are summarized below :



0   Intermediate labels : none
1   Intermediate labels : 1,2,3,4,5,6,7,8,9,1
2   Intermediate labels : 1,2,4,6,8,1
3   Intermediate labels : 1,3,5,7,9,1
4   Intermediate labels : 1,5,1
5   Intermediate labels : 1,1
6   Intermediate labels : 2,3,4,5,6,7,8,9
7   Intermediate labels : 2,4,6,8
8   Intermediate labels : 3,5,7,9
9   Intermediate labels : 5


Normally the powers-of-10 labeling is drawn "outside" of any intermediate labeling. If no intermediate labeling is to be done the powers-of-10 labeling moves closer to the y axis. The default logarithmic y-axis labeling value is 14.

Example : yloglab 21

[Top][Bottom][Option list]

( BRymax) (Command :pubplot) Details for the ymax option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired y-axis scale maximum. For "inverted" plotting, the maximum("ymax") can be algebraically less than the minimum ("ymin"). For inverted plotting, the "ydelta" value should be negative. Inverted logarithmic plots are NOT allowed. Also, for logarithmic plotting, the expressed and/or implied minimum and maximum values will determine the number of cycles to draw. Each cycle begins and ends at 1.

Example : ymax 25

[Top][Bottom][Option list]

( BRymin) (Command :pubplot) Details for the ymin option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired y-axis scale minimum. For "inverted" plotting, the maximum("ymax") can be algebraically less than the minimum ("ymin"). For inverted plotting, the "ydelta" value should be negative. Inverted logarithmic plots are NOT allowed. Also, for logarithmic plotting, the expressed and/or implied minimum and maximum values will determine the number of cycles to draw. Each cycle begins at 1.

Example : ymin 0

[Top][Bottom][Option list]

( BRyoff) (Command :pubplot) Details for the yoff option.

[General syntax rules for this keyword.]

If this option is specified the following numeric arguments, in a 1:1 correspondence with the curves to be plotted, are the values, in the units of the y variable, by which the "y" component(s) of each curve's data to be plotted will be offset before it is plotted. Up to 20 values can be specified. The default "yoff" value, per curve, is 0. The "yfactor" value is applied BEFORE the "yoff" value.

Example : yoff 5

[Top][Bottom][Option list]

( BRyoffset) (Command :pubplot) Details for the yoffset option.

[General syntax rules for this keyword.]

If this option is specified the following one or two numeric arguments, are, respectively, the horizontal and vertical distances in inches, to offset the Y axis from its standard position. A positive horizontal distance moves the Y axis rightward and positive vertical distance moves the Y axis upward. If the vertical distance is not specified it is set to its default value of 0. The default for both axis offset distances is 0.

Example : yoffset -.5 0

[Top][Bottom][Option list]

( BRytic) (Command :pubplot) Details for the ytic option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired y-axis minor tic increments to be drawn per major tic mark. The default number of minor tic increments per major tic mark is 2.

If the y-axis is logarithmic, the effective value of ytic is halved above 6.0 in each cycle drawn. If the plot is of type "polar", the "ytic" argument will establish the number of radial or concentric fine grid lines to draw. Which it determines is a function of the "xaxis" or "yaxis" code specified.

If the plot is a surface plot the "ytic" argument serves to indicate the desired resolution of the surface in the Y direction. Higher "ytic" values result in more surface facets but also greater time required to compute the resultant surface to draw. A combined X and Y maximum for number of surface facets is 15000.

Example : ytic 3

[Top][Bottom][Option list]

( BRytol) (Command :pubplot) Details for the ytol option.

[General syntax rules for this keyword.]

If specified, the following value is the allowable tolerance between successive "y" data points to be plotted. Values which occur in succession closer than an amount specified via this tolerance option are eliminated from the data to be plotted. If the "ytol" value is positive, it is absolute; ie, its units are the same as those of the x variable. If the value specified is negative, the absolute magnitude of the value is the tolerance IN PERCENT. The default value of "ytol" is 0.

Example : ytol -.5

[Top][Bottom][Option list]

( BRz) (Command :pubplot) Details for the z option.

[General syntax rules for this keyword.]

Indicates the z-axis SIF variables to plot when the plot is a "surface" plot. (See the "surface" option.) There is an implicit 1:1 correspondence between the "z" name(s) specified and the list of file name(s) specified or implied via "files". If fewer "z" names are specified than the number of curves to be plotted, the last "z" name specified will be EXTENDED to complete the necessary 1:1 file name correspondence. Any "z" variable which is NOT found in the respective SIF file causes plotting of the respective curve to be skipped. (See the "notify" option.) Up to 20 z-axis variables can be specified.

Example : z cl cl clx

[Top][Bottom][Option list]

( BRzaxis) (Command :pubplot) Details for the zaxis option.

[General syntax rules for this keyword.]

If this option is specified AND if the plot is a "surface" plot (see "surface" option) the following coded numeric argument indicates whether or not to draw the Z-axis. If the following value is other than 0, an axis line will be drawn. The default value for "zaxis" is 0.

Example : zaxis 1

[Top][Bottom][Option list]

( BRzcomp) (Command :pubplot) Details for the zcomp option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired z-axis compression factor. The default compression factor is 1.0; ie, no compression. Specification of such a compression factor has the effect of changing the "units per inch" implied or set by "zdelta".

Example can be accomplished by specifying a compression factor greater than 1. The value of "zcomp" is automatically implied and, if specified, overridden if BOTH "zdelta" and "zlen" are specified.

Example : zcomp .75

[Top][Bottom][Option list]

( BRzdelta) (Command :pubplot) Details for the zdelta option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired z-axis scale increment in units per inch. For "inverted" plotting, the maximum("zmax") can be algebraically less than the minimum ("zmin"). For inverted plotting, the "zdelta" value should be negative.

Example : zdelta 4

[Top][Bottom][Option list]

( BRzlen) (Command :pubplot) Details for the zlen option.

[General syntax rules for this keyword.]

If this option is specified the following numeric argument indicates the desired z-axis scale length. Only 3 out of 4 of "zmin", "zmax", "zdelta", and "zlen" are sufficient to define the scale origin and length. If BOTH "zlen" and "zdelta" are specified, "zcomp" is implied and, if specified, overridden.

Example : zlen 10

[Top][Bottom][Option list]

( BRzlist) (Command :pubplot) Details for the zlist option.

[General syntax rules for this keyword.]

Can be used interchangeably with "clist".

[Top][Bottom][Option list]

( BRzmax) (Command :pubplot) Details for the zmax option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired z-axis scale maximum. For "inverted" plotting, the maximum("zmax") can be algebraically less than the minimum ("zmin"). For inverted plotting, the "zdelta" value should be negative.

Example : zmax 12

[Top][Bottom][Option list]

( BRzmin) (Command :pubplot) Details for the zmin option.

[General syntax rules for this keyword.]

If this option is specified, the following numeric argument indicates the desired z-axis scale minimum. For "inverted" plotting, the maximum("zmax") can be algebraically less than the minimum ("zmin"). For inverted plotting, the "zdelta" value should be negative.

Example : zmin 12

[Top][Bottom][Option list]


DESL Home | Website Outline | Commands | Examples | Download | Contacts




ViGYAN, Inc.


DESL Manager at ViGYAN, Inc.

30 Research Drive
Hampton, VA 23666
Voice: (757) 865-1400
Toll Free: (800) 288-3998
FAX: (757) 865-8177

© 1998 ViGYAN, Inc.