Appendix B Sec9
COMMAND DESCRIPTION
Appendix B Sec9.1
@file_name/qualifier arg1 arg2 arg3 ...
Reads commands from the file file_name until an EOF, blank line, a RETURN command is executed or the file ends, then reverts to the previous command level for input. Default device is SY:. Default extension is '.PPC'. The current command file name is placed in global symbol PPL$COMMAND_FILE.
PPLUS can be started with a command file specified by typing $PPL file_name, where file_name is the command file name. PPLUS will produce no screen output if called from a BATCH file. PPLUS will terminate and not pass control back to the SYS$INPUT file.
The arguments may be any legal string. The arguments arg1,arg2,etc are SET to the local symbols P1, P2, etc. For example:
@command_file your_file "A label" "PLTYPE 2"
The local symbols will be:
P1 = your_file
P2 = A label
P3 = PLTYPE 2
These symbols can then be substituted into the command file.
Qualifiers are (default in parenthesis):
/[NO]ECHO Controls echoing to the file echo.dat during execution. (NOECHO)
/[NO]DEBUG Sets DEBUG mode during execution. In debug mode the commands are written to the echo file after symbol substitution has occurred. (NODEBUG)
/[NO]QUIET Turns off messages to the terminal. (NOQUIET)
/[NO]LOG Echos commands to terminal. (NOLOG)
/[NO]LATCH Causes the current qualifiers to be the new default for all command levels. (NOLATCH)
Appendix B Sec9.2
AUTO,ON/OFF
Turns on and off the automatic copying of plots while at a TEK terminal. Default=OFF
Appendix B Sec9.3
AUTOLAB,ON/OFF
ON (default for BIBO and EPIC data) to get graph labels from data file headers. OFF (default for other data formats) for manual entry of graph labels. Default=OFF
Appendix B Sec9.4
AXATIC,ATICX,ATICY
Sets the number of large tics in auto mode for X and Y axes. Default=5
Appendix B Sec9.5
AXLABP,LABX,LABY
Sets the numeric and character label position for X and Y axes. -1=bottom/left of plot, 0=no label, +1=top/right of plot. Default=-1
Appendix B Sec9.6
Sets the X and Y axes length in inches. XLEN is also used as the length in inches of the time axis. Default=5.5,4.0 The values of xlen and ylen are placed in global symbols PPL$XLEN and PPL$YLEN.
Appendix B Sec9.7
AXLINT,LINTX,LINTY
Sets the label interval for X and Y axes. Labels are only drawn for large tics. Default=2, i.e. every other large tic.
Appendix B Sec9.8
Sets the label height for X and Y axes in inches. Default=0.10 If HGTX or HGTY is negative the numeric axis labels are multiplied by -1 before plotting.
Appendix B Sec9.9
AXNMTC,NMTCX,NMTCY
Sets the number of small tics between large tics for X and Y axes. Default=0
Appendix B Sec9.10
Sets the number of significant digits in labels for auto labelling. Default=2
Appendix B Sec9.11
AXSET,TOP,BOT,LEFT,RIGHT
Sets the flags controlling the plotting of the four axes. If =1 axis is ON, =0 axis is OFF. The default for all axes is ON.
Appendix B Sec9.12
Sets the axis type for X and Y axes. 1 - normal, 2 - log, 3 - inv-log. Type 3 axis draws the top/right axis inverse and the bottom/left normal. Default=1
Appendix B Sec9.13
BAUD,IB
Sets baud rate. Null entry not allowed.
B= Baud rate default=110
Appendix B Sec9.14
Turns on and off the box that is drawn around the entire plotting region. Default is ON.
Appendix B Sec9.15
C
Comment. This command can be used to comment your @ files. No action is done when this command is processed. The C must be followed by at least one blank space.
Appendix B Sec9.16
CLSPLT
Closes the metacode file. Not to be confused with %CLSPLT, which is documented in the Advanced Commands Chapter.
Appendix B Sec9.17
CONPRE,prefix
Sets a prefix string for the numeric contour labels of up to 10 characters. For example, CONPRE,@P2@TR will give labels using pen 2 and triplex roman font. Default = spaces.
Appendix B Sec9.18
CONPST,postfix
As CONPRE but sets up to 10 characters following the contour numeric label. For example, CONPST,cm/sec will give contour labels like "10 cm/sec". Default = spaces.
Appendix B Sec9.19
CONSET,HGT,NSIG,NARC,DASHLN,SPACLN,CAY,NRNG,DSLAB
Note that some of the parameters can be set on the Ferret CONTOUR command with qualifiers. CONTOUR/SIZE, CONTOUR/SIGDIG, and CONTOUR/SPACING are alternative implementations of the PPL CONSET command and have exactly the same effect as issuing PPL CONSET. See the CONTOUR section of Chapter 6 for a description of the CONTOUR qualifiers.
Sets parameters for contouring and placing random data on a grid. Must be issued before the RD command.
HGT = height of contour labels. Default=.08 inches
NSIG = no. of significant digits in contour labels. Default=2
NARC = number of line segments to use to connect contour points. Default=1
DASHLN = dash length of dashes mode. Default=.04 inches
SPACLN = space length of dashes mode. Default=.04 inches
CAY = is the interpolation scheme. If CAY=0.0, Laplacian interpolation is used. The resulting surface tends to have rather sharp peaks and dips at the data points (like a tent with poles pushed up into it). There is no chance of spurious peaks appearing. As CAY is increased, Spline interpolation predominates over the Laplacian, and the surface passes through the data points more smoothly. The possibility of spurious peaks increases with CAY. CAY= infinity is pure Spline interpolation. An over relaxation process in used to perform the interpolation. A value of CAY=5.0 (the default) often gives a good surface.
NRNG = Any grid points farther than NRNG away from the nearest data point will be set to "undefined" (1.0E35). Default=5
DSLAB= nominal distance between labels on a contour line. Default = 5.0 inches. For fine grids, the labels may not show up. Try specifying smaller values for DSLAB.
CONTOUR/qualifier,vcomp,label
Does a contour plot of data in buffer. Label will replace that in the current main label buffer. Label is optional. If either axis is log that index must be equally spaced in log-space (i.e. 10**(xmin+dx)). Contour does not take the log of the coordinate. The contour lines will be plotted with the pen selected for line 1. The label cannot begin with a numeric character, i.e., 95W. You can plot a number by specifying a font, e.g., @SR100 meters.
Vcomp indicates which vector component to contour. Default is 1. Vcomp is to be used when a vector field has been read in. See the VECSET and VECTOR commands.
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw.
Appendix B Sec9.20
Turns on and off the drawing of a solid line through(0,0) on a plot. Optionally can draw vertical and horizontal lines. Draws line through (XOFF,YOFF) when either TRANSXY or LINE command is used to apply a transformation to the data.
ICODE = 0 cross off
= 1 draw through (0,0) (default)
= 2 horizontal line through each YOFF
= 3 vertical line through each XOFF
= 4 horizontal and vertical through each XOFF, YOFF
Appendix B Sec9.21
DATPT,type,mark
Controls the drawing of marks on a contour plot along the x and/or y axis on a grid at the points where the raw ungridded X,Y,Z triplets are located.
type = 0 no points drawn (default)
= 1 points drawn along the x axis
= 2 points drawn along the y axis
= 3 points drawn at each raw input value
mark = 0 use the default mark (default)
= other use the specified mark to denote the location.
The default mark is down arrow for x axis, left arrow for y axis, and pluses for type=3. (also see MARKH)
Appendix B Sec9.22
DEBUG on/off
Turns on and off the debugging mode. In debug mode theinput lines are echoed to the ECHO.DAT file after symbol substitution. Default = off.
Appendix B Sec9.23
DEC symbol
Decrements the value stored in symbol by one. If symbol does not exist it is created and given a value of zero.
Appendix B Sec9.24
Deletes "symbol" from the symbol table.
Appendix B Sec9.25
DFLTFNT,font
Sets the default font used for all labelling. PPLUS initially uses Simplex Roman (SR) as the default font. Fonts are still selectable using the font command @xx, where xx is the two letter font code. NOTE: This command also replaces the string set by the CONPRE command with the selected font. The default font is not saved with MULTPLT.
This command changes the environment and can only be changed back with another DFLTFNT command or using the @CL command.
font = the new default font (no default)
Appendix B Sec9.26
DIR,arg
Prints a listing of files with names or extensions that match "arg".
Appendix B Sec9.27
ECHO,on/off
Turns on/off echoing of PPLUS commands in the echo file ECHO. Default is ON. ECHO is a logical that can be defined prior to entering PPLUS (e.g., DEFINE ECHO echo_file.echo). Default is for echoing to go into the file ECHO.DAT.
Appendix B Sec9.28
ENGLISH
Sets the internal conversion factors to inches. This is the default condition. (see the METRIC command)
Appendix B Sec9.29
Allows the input of X,Y pairs from the terminal. PPLUS prompts the user with 'enter>'. Type END to stop.
Appendix B Sec9.30
Specifies which EPIC variables are to be plotted as x and y when FORMAT,EPIC command has been given. The EPIC/pointer file is named with the RD command, and each call to RD results in reading another EPIC data file as indicated by the EPIC/pointer file. PPLUS can extract axis labels and a plot title from the data file headers. Use FORMAT/CTD,EPIC to tell PPLUS that EPIC CTD data is being read. Use FORMAT,EPIC to tell PPLUS that EPIC time series data is being read. See FORMAT command description for all the EPIC defaults.
x-var = Variable to be plotted as x
y-var = Variable to be plotted as y
EVAR ? displays a list of variables possible for x-var and y-var.
Examples of variables are TIM (time), U (zonal velocity), V (meridional velocity), etc. If you want to plot x=time and y=zonal velocity, the command would be EVAR,TIM,U. If the variable you want to plot is not in this list, you can specify the column number of the variable in the EPIC data file. For example, EPIC current meter data files generally have variables DATE,TIME,U,V,SPEED,DIRECTION. To plot x=time and y=speed, the command would be EVAR,TIM,5. If the x variable is specified by column number, the EVAR argument list must be enclosed in double quotes, (e.g., EVAR,"3,4" will plot the variable in column 3 as x and the variable in column 4 as y).
EVAR (without arguments) will yield a plot with x=date/time and y=the first variable following date/time on the data file for time series data. For CTD data, EVAR (without arguments) will yield a plot with x=variable in column 2 and y=variable in column 1 (usually pressure).
Valid Qualifiers are:
/[NO]OFFSET For time series data. Controls whether PPLUS offsets the time word so that data points are plotted in the center of each time interval. The default is OFFSET, which is appropriate for most EPIC time series. (EPIC time words represent the start of the time interval in most cases, such as average data.) Use /NOOFFSET to force PPLUS to plot data points at the start of each time interval (e.g., this would be appropriate for subsampled data). Default is OFFSET.
/[NO]TIME For time series data. Controls whether PPLUS reads the time word from the time series data file. The default is /NOTIME, which means that the data is evenly spaced in time, making it unnecessary to read the time words. Use /TIME to make PPLUS read the time word for data which is unevenly spaced in time. Default is /NOTIME (unless dt is negative, in which case the default is /TIME).
/[NO]NEXT /NEXT indicates that the next variable is to be read from the same data file. When /NEXT is used, no new data file name will be read from the EPIC file. The variables indicated by the EVAR command will be read from the last data file. This option permits overplotting several variables from the same data file, and can be used with the commands described in the ADVANCED COMMANDS chapter to produce a plot with multiple axes. When /NEXT is used, both x and y variables must be specified with the EVAR command. Default is /NONEXT.
The above qualifiers will also work with the VARS command when EPIC data is being read.
EXIT Causes all output buffers to be flushed and exits the program.
FORMAT/qualifier,frmt
Allows the input of a user supplied format for formatted sequential data files. Null entry is not allowed. The current format is in global symbol PPL$FORMAT.
frmt = a format default=(3F10.2)
|
FREE |
for free form |
|
DSF |
for DSF files |
|
BIBO |
for DSF files without a PPLUS header |
|
EPIC |
for EPIC time series data |
|
UNF |
for UNFORMATTED files. |
Valid qualifier (for EPIC data only) is:
/[NO]CTD Controls whether EPIC data is read as time series data or as CTD data. If the data is EPIC CTD data, then the /CTD switch must be used. Default is /NOCTD.
Appendix B Sec9.31
GET,file_name
Restores options to those in effect at the time SAVE,file_name was called. file_name must be specified.
Appendix B Sec9.32
GRID[,LINEAR]
If the argument LINEAR is omitted (default), normal gridding is used. Otherwise, if LINEAR is included, gridding is done by linear interpolation with the following restrictions on the data:
1. Data must be on a grid. The grid may have irregular spacing.
2. There cannot be gaps in the middle of the grid. Every grid point in the middle of the grid must be specified.
3. The grid may have ragged edges.
Must be issued before the RD command. Note that if the grid is coarser than the data, it is possible that some of the data will not be used in the gridding process. It is best to make the grid as fine as or finer than the data rather than coarser.
Appendix B Sec9.33
HELP,arg
Give access to the VMS help files on topic "arg".
Appendix B Sec9.34
HLABS,n,height
Sets the height in inches of the nth moveable label. The height is reset to the default (specified by the LABSET command) by omitting the height value or clearing the labels with a LABS command. (also see LABS, RLABS, LLABS, LABSET)
Appendix B Sec9.35
HLP,arg
Gives help on the PPLUS topic "arg".
Appendix B Sec9.36
IF expression THEN
The first element of a BLOCK IF statement; the other two elements are ELSE and ENDIF. ELSE and ENDIF are not valid in any other context. expression = argument operator argument
argument = symbol name, number or a string enclosed by quotes
operator = .EQ., .NE., .LT., .GT., .LE. or .GE.
The symbol name can be undefined and its value is then "" (i.e., null string).
Appendix B Sec9.37
INC sym
Increments the value stored in the symbol sym by one. If sym does not exist it is created and given a value of one.
Appendix B Sec9.38
LABS/qualifier,n,X,Y,JST,label
Defines the nth movable label for all plots. When plotting is done, the cross hairs will come on if no X and Y position has been specified. Typing a C will center the label at the cross hairs or typing a R will position the label to the right of the cross hairs. By typing L or F then repositioning the cross hairs and then typing another character a line will be drawn from the first point to the second and the label will be drawn at the second point (if F was specified an arrow will be drawn). Any character other than L, F, R or C will cause the the label to be drawn at the cross hairs. Null entries are not allowed for n or label. A comment will be inserted into the ECHO.DAT file giving the coordinates when cross hairs are used. If n is omitted LABS is reset and all moveable labels are cleared. (also see LABSET, HLABS, RLABS, LLABS)
|
n = |
label number (up to 25 allowed) |
|
X = |
X position of label in user units (optional) |
|
Y = |
Y position of label in user units (must exist if X is present) |
|
JST = |
justification of label. -1 left (default), 0 center, +1 right |
|
label = |
any SYMBEL compatible string |
/[NO]USER determines units of x and y positions. Default is /USER. If /NOUSER units are inches from the ORIGIN. (see the ORIGIN command)
NOTE: Units specified by the /user qualifier are also used in the LLABS command. If your terminal does not have cross hairs, you must specify X and Y.
Appendix B Sec9.39
LABSET,HLAB1,HXLAB,HYLAB,HLABS
Sets character heights for labels. (also see LABS, RLABS, LLABS)
HLAB1 = main label default=.16 inches
HXLAB = x - label default=.12 inches
HYLAB = y - label default=.12 inches
HLABS = movable labels default=.12 inches
Appendix B Sec9.40
Sets the contour levels, the contour line type, the contour line label characteristics and lets the user edit (insert/delete) levels. Any duplicate levels will be deleted, however, each LEV command edits the existing levels and unless requested the levels are not cleared. Maximum number of levels is 500.
arg = () clear levels, number of automatic levels to 10.
arg = (min,max,inc,idig) specifies the contour levels and abel type
min = starting value for levels creation
max = ending value for levels creation (if omitted
only the starting level will be created)
inc = increment used to create levels. (if omitted
only the starting and ending levels will be
created, if 0 the starting and ending levels
are deleted)
idig = 0 through 9 Number of digits after the
decimal point in the label
= -1 contour label plotted as an integer
= -3 no contour label will be drawn
arg = type(min,max,inc,ipen) sets the contour lines specified to "type"
type = DASH sets the line type to dash
= DARK sets the line type to dark (heavy)
= DEL deletes the indicated levels.
= LINE sets the line type to line (normal)
= PEN sets the pen used for a contour line to
"ipen". ipen=0 to use default pen.
For example, "LEV,(),(9,20,1,-1),DASH(8,20,2)" will clear the previous levels and create contours at every integral value from 9 to 20 with the labels drawn as integers, all even valued contours from 8 to 20 will be drawn with dashed lines.
Appendix B Sec9.41
LIMITS,value,comparison,flag
This command sets the testing value and type of test for bad data points. X, y and z are checked and the point will not be plotted if the test is true.
value = test value for the test
comparison = XLE test for x .le. value, default off, 0.0
XEQ test for x .eq. value, default off, 0.0
XGE test for x .ge. value, default on, 1.E35
YLE test for y .le. value, default off, 0.0
YEQ test for y .eq. value, default off, 0.0
YGE test for y .ge. value, default on, 1.E35
ZLE test for z .le. value, default off, 0.0
ZEQ test for z .eq. value, default off, 0.0
ZGE test for z .ge. value, default on, 1.E35
flag = OFF the test is disabled, otherwise the test is enabled.
If your are reading data to be contoured with ZGRID, the limits are checked only after interpolation. If you arE using GRID,LINEAR, limits are checked before and after interpolation.
Appendix B Sec9.42
LINE,n,MARK,TYPE,XOFF,YOFF,DN1,UP1,DN2,UP2
Sets the characteristics for each of the 50 possible X-Y plot lines.
n = line number
MARK = data mark (see list at end of manual, e.g. 1 for x, 3 for +)
TYPE = type of line
0 - line connecting points and no mark at each point
1 - line connecting points and mark at each data point
2 - mark end points only
3 - only mark (no line)
4 - dashes
5 - dashes with mark at end points
XOFF = X offset default=0.0
YOFF = Y offset default=0.0
DN,UP = dash characteristics in inches.
Default TYPE=0 for n=1, TYPE=4 otherwise.
Appendix B Sec9.43
LINFIT,n,XIMIN,XIMAX,XOMIN,XOMAX
A linear least squares fit is performed on the data in line n and the resulting fitting line is placed in the next available line buffer.
Example:
RD,data.fil LINFIT,1
will place the fitting line from the regression of line 1 into buffer 2.
n = line number (no default)
XIMIN = min x value for the regression domain
XIMAX = max x value for the regression domain
XOMIN = min x value for the fitting line (default=XIMIN)
XOMAX = max x value for the fitting line (default=XOMIN)
XIMIN and XIMAX default to the minimum and the maximum of the data. XOMIN and XOMAX default to XIMIN and XIMAX, respectively. An alternate form for the command may be used when TAXIS is ON and TSTART has been set. It is:
LINFIT,n,TIMIN,TIMAX,TOMIN,TOMAX
Where the arguments are the beginning and ending times in Woods Hole format WYYMMDDHHMM, i.e., W8101121800 is 12-JAN-1981 18:00. The arguments have the same meanings and defaults as above.
The following global symbols are defined by LINFIT:
PPL$LF_R2 = regression coefficient squared
PPL$LF_A = constant for fit (y = a + b*x)
PPL$LF_A_STDEV = standard error of A
PPL$LF_B = constant for fit
PPL$LF_B_STDEV = standard error of B
PPL$LF_VAR = total variance
PPL$LF_RES_VAR = residual variance after fit
Appendix B Sec9.44
LIST,IMIN,IMAX,JMIN,JMAX,VCOMP,arg
List on the terminal the appropriate information. Null entry is not allowed if arg is not DATA. IMIN, IMAX, JMIN, JMAX only valid if arg=DATA. Defaults are to print the total plot buffer.
IMIN= min I for CONTOUR , start pt for X-Y
IMAX= max I for CONTOUR , stop pt for X-Y
JMIN= min J for CONTOUR , start line for X-Y
JMAX= max J for CONTOUR , stop line for X-Y
VCOMP= vector component to be listed (VECTOR command)
arg= LEVELS contour levels and weights
CONSET contour information
DATA data currently in buffer
DATPT contour data location before gridding
LABELS prints the labels at the terminal
LABSET LABSET parameters
LINES current LINE and PEN values
LIMITS the current values set/reset by the limits command
PLOT gives plot information and plot file name
READ sequential read information
STATS min and max plus sizes of last read
TAXIS T-axis attributes
TICS Tic sizes and options
TRANSXY X and Y transform values
VECTOR Vector plotting attributes (VECTOR command)
XAXIS X-axis attributes
YAXIS Y-axis attributes
Appendix B Sec9.45
LISTSYM
Lists the symbols currently defined.
Appendix B Sec9.46
Defines the starting position in user units for a line associated with the moveable labels. The end of the line is determined from the LABS command. This command has no effect if the label is to be positioned with the cross-hairs. If the command is issued without coordinates the TYPE is set to none. Fancy has an arrow head at the starting position. (also see LABS, RLABS, HLABS, LABSET)
n = label number less than 11
X = X position of line in user units
Y = Y position of line in user units
TYPE = line type. 0 no line, 1 normal line, 2 fancy line
NOTE: Units of x and y positions are determined by the /USER qualifier in the LABS command.
Appendix B Sec9.47
MARKH,n,SIZE
Sets the mark size used for plotting line number n. The mark size for line 1 is used for the marks in the DATPT command (contouring).
n = line number (no default)
SIZE = size of mark in inches (default= 0.08)
Appendix B Sec9.48
METRIC
Sets the internal conversion factors to millimeters. Default condition is inches.
MULTPLT,NX,NY
Ferret viewports offer more flexibility than MULTPLT, and is the preferred method for drawing multiple panels on the page.
The PPLUS MULTPLT command allows the user to plot several plots together. The individual plots are arranged in rows and columns. The X axis length of each plot in the same column and the Y axis length of each plot in the same row are identical. The axis lengths are specified in rows and columns. The spacings between the rows and columns are also user controlled. If the spacing is zero the plots are placed together without axis labels if appropriate. There are prompts for all additional information needed.
NX = number of columns
NY = number of rows
The prompts will be:
ENTER XLEN FOR COLS 1,2,...,NX
multplt>
ENTER YLEN FOR ROWS 1,2,...,NY
multplt>
ENTER PLOT SPACINGS
LEFT BNDRY TO COL1, COL1 TO COL2,ETC...
multplt>
ROW1 TO ROW2,...,ROW NY TO BOTTOM
multplt>
Axis length and ORIGIN are reset after plotting is finished.
Appendix B Sec9.49
NLINES
Resets the the input buffer so that the next data line read will be line 1. The input buffer is normally reset when a plot is made.
Appendix B Sec9.50
Sets the distance the lower left hand corner of the plotting area is from the lower left corner of the box. The values of xorg and yorg are placed in the global symbols PPL$XORG and PPL$YORG.
XORG = x-distance (in) default=1.4
YORG = y-distance (in) default=1.2
Appendix B Sec9.51
PEN,n,ipen
Sets the pen to be used for line n. ipen should be in the range 1-6, subject to the limitations of the plotting device. On the VERSATEC, pen 2 is thicker than pen 1, pen 3 is thicker than pen 4, etc. The pen selected for line 1 will be used to draw the contour lines. (also see LEV)
n = line number. If n=0 sets the pen used to plot the axes and labels.
ipen = pen number. Default=1
Appendix B Sec9.52
PLOT/qualifiers,label
Does an X-Y plot of data in the plot buffer (all lines). The plot label "label" is optional. The plot label can be blanked with the TITLE command. If either x-axis or y-axis is log PLOT will take the logarithm of the appropriate coordinate as it is plotted. This will not affect the data buffer.
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw.
Appendix B Sec9.53
PLOTV/qualifiers,VANG,INC,label
Does a stick plot for U,V pairs stored in X,Y, respectively. May be used with or without TAXIS option ON.
VANG = rotation angle of vectors default=0.0
INC = plots every inc vector (subsamples)
label = plot label
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw.
Appendix B Sec9.54
PLOTUV/qualifiers,VANG,INC,label
Similar to PLOTV except U and V are in alternate pairs, where X1= count, Y1= U component, X2= count, Y2= V component, etc. NLINES must be set to an even number and first series read will be U second V etc.
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw.
Appendix B Sec9.55
PLTNME,fname
Specifies the file name to be used for plots. File name is available in the global symbol PPL$PLTNME. fname = the file name (default = metafile.plt)
Appendix B Sec9.56
PLTYPE,ICODE
Sets plotting medium. Null entry is not allowed. The binary file is converted into device specific code using a post processor. The plot file name can be specified using the PLTNME command.
ICODE = device code for plotting
-2 = HP and TEK
-1 = HP
0 = Binary file
1 = TEK
2 = TEK and Binary file
3 = GKS (valid on MicroVAX only)
4 = GKS and Binary file (valid on MicroVAX only)
default=1
Appendix B Sec9.57
RD/qualifier,NX,NY,TYPE,n,file_name
Read formatted or unformatted data from a sequential file according to FORMAT and VARS or EVARS. The input file name is available in the global symbol PPL$INPUT_FILE.
NX and NY define the grid on which data will be plotted. If X,Y,Z triplets are being read the grid can be coarser or finer than the input data. Thus, when reading triplets NX, NY of 50, 21 indicates the grid used for contouring will be 50 x 21 and not that the input data is on this grid. When the input data are values of Z only the input grid and the plotting grid must be identical. Maximum number of points for a single read is 100,000 pairs, 200,000 grid points or 50,000 triplets. Default number of points read is the remaining buffer space. File_name may be omitted if previously defined. Null entries are not allowed.
NX = no. of columns on the plotting grid for contouring or
no. of points to read if not contouring. See NY for explanation.
NY = no. of rows if data is on a grid for contouring. Omitted otherwise.
The meaning of NX and NY change depending on whether you're reading data for contouring or not. If you're reading contour data NX is the number of columns and NY is the number of rows.
If the data is not contour data NX is the number of points to be read and NY is not required. The default for NX is the space remaining in the buffer. Reading will stop automatically at the EOF without any error.
TYPE = method by which grid data is to be read (contour data only)
0 by rows (1st subscript varies fastest)
1 by columns (2nd subscript varies fastest)
N = number of data sets to be read (on same file).
file_name = file name. Default device is SY:.
If the file name is explicitly given the file will be read after rewinding the file. If the file name is not given no rewind takes place.
If the data is EPIC, the file name given with the RD command is the name of the EPIC/pointer file for the data file. Otherwise, the file name is the name of the data file itself
Valid qualifier (use only with VECTOR, VECSET, VECKEY commands):
/[NO]VECTOR /VECTOR reads the second component grid using the old xmin,xmax,ymin,ymax. This is done after the first vector component has been read in the usual fashion. See the VECTOR command Default is /NOVECTOR.
If you are reading triplets PPLUS prompts for total number of points to be read in with 'rd>'. If you are readingtriplets or grid data PPLUS will also prompt for xmin,xmax,ymin,ymax. (limits)
Appendix B Sec9.58
RESET
Uses the logical PPL$RESET as the input file to the GET command.
Appendix B Sec9.59
RETURN
Return from current command level to the previous command level. If executed at the top level PPLUS will exit.
Appendix B Sec9.60
RLABS,n,ANG
Specifies the angle to rotate the moveable labels. (The labels defined by the LABS command.)
n = number of the label (no default)
ANG = angle in degrees. Default = 0.0
Appendix B Sec9.61
ROTATE,ON/OFF
Rotates the plot 90 degrees on the screen and plotter.
Default = OFF
Appendix B Sec9.62
RWD,file_name
Rewinds the current data file. File_name may be omitted if previously defined. Files are also rewound by explicitly including the file name in the SKP and RD commands. Rewinds the EPIC pointer file. The input file name is available in the global symbol PPL$INPUT_FILE.
If the data is EPIC, the file name given with the RWD command is the name of the EPIC/pointer file for time series data. Otherwise, the file name is the name of the data file itself
Appendix B Sec9.63
SAVE,file_name
Saves the options currently in effect on file file_name in a binary format. File_name must be specified.
Appendix B Sec9.64
SET sym arg
Creates/modifies the symbol sym and sets it to arg. The argument arg can be either a legal character string, a simple arithmetic expression, or a special function. A simple arithmetic expression is of the form num1 op num2, where op is +, -, * or / (addition, subtraction, multiplication or division) and num1 and num2 are numbers. The numeric values must be separated from the operator op by spaces. The string will be used exactly as it appears if enclosed by double quotes ("). For example:
SET XPOS 4.4 + 2 results in XPOS = 6.200E00
SET A_LABEL "4.4 + 2" results in A_LABEL = 4.4 + 2
The special functions manipulate and reformat character strings. They are:
$EDIT(symbol,argument)
$EXTRACT(start,length,symbol)
$INTEGER(symbol)
$LENGTH(symbol)
$LOCATE(substring,symbol)
$ELEMENT(position,delimiter,symbol)
The general format is SET sym $function(arg1, arg2,...). These functions are described in the SPECIAL FUNCTIONS section
Appendix B Sec9.65
Prints the current value of "symbol".
Appendix B Sec9.66
SIZE,width,height
Sets total plotting size in inches of the plotting region. Null entries are not allowed. The width and height should be about 2 and 1.5 inches greater than the respective axis lengths. The displacement specified by ORIGIN must be considered when values for SIZE and AXLEN are being chosen. The maximum allowed size for Versatec plots (to keep the plot on a single page) is 8 by 10.5. The values of width and height are placed in the global symbols PPL$WIDTH and PPL$HEIGHT.
width = plotting area total width (default = 7.5)
height = plotting area total height (default = 5.625)
Appendix B Sec9.67
SKP,n,file_name
Skip n sequential or unformatted records. File_name may be omitted if previously defined. If the file name is explicitly given the records will be skipped after rewinding the file. If the file name is not given no rewind takes place. The input file name is available in the global symbol PPL$INPUT_FILE.
If the data is EPIC, the file name given with the SKP command is the name of the EPIC/pointer file for time series data. Otherwise, the file name is the name of the data file itself.
Appendix B Sec9.68
SMOOTH,n
Does n laplacian smoothings on contour type data. Null entry is not allowed.
Appendix B Sec9.69
SPAWN
Creates a sub-process and passes control to this process. When finished with the spawned process type LOGOUT to return to PPLUS.
Appendix B Sec9.70
TAXIS/qualifier,DT,arg
Sets the time axis characteristics. The axis length is specified with AXLEN for this style axis. When TAXIS is turned on and BIBO or EPIC formatted data is read, the time series are automatically adjusted properly relative to TMIN. NOTE: DT and TSTART (set with the TIME command) are needed only when BIBO or EPIC data is not being used.
DT = sampling rate in minutes (default=1440 ,ie, daily)
arg = ON/OFF turns TAXIS option on and off (default=OFF)
/[NO]YAXIS if yaxis draw a vertical time axis in place of the yaxis. (NOYAXIS)
Appendix B Sec9.71
TEKNME[,fname]
Stores the Tektronix plot in file fname if specified. Terminal must have NOWRAP to dump the plot back to the screen with the TYPE command. The current Tektronix plot file name is available in global symbol PPL$TEKNME.
Appendix B Sec9.72
Sets the sizes in inches of the small and large tics on the X and Y axis. The tic style may also be set for both axes.
SMX = small X axis tic size default=0.125
LGX = large X axis tic size default=0.25
SMY = small Y axis tic size default=0.125
LGY = large Y axis tic size default=0.25
IX = 1 X tics on the inside
0 X tics on both sides
-1 X tics on the outside (default)
IY = 1 Y tics on the inside
0 Y tics on both sides
-1 Y tics on the outside (default)
Appendix B Sec9.73
TIME,TMIN,TMAX,TSTART
Specifies time axis limits and starting time of time series data. See TAXIS command for restrictions. (Default is auto-scaling for BIBO and EPIC formatted data)
Note: If you read time as a sequence number andspecify DT (set with the TAXIS command) and TSTART, then the TSTART time/date must correspond to a sequence number of 1.
TMIN and DT (see TAXIS command) must be specified before TSTART. TSTART must be re-entered whenever DT is changed.
TMIN = Start date/time of time axis (WHOI format = Wyymmddhhmm)
TMAX = End date/time of time axis
TSTART = Start time of time series data (optional)
Appendix B Sec9.74
Sets the main plot title to "label" without generating a plot. If "label" is omitted the main plot title is cleared. Optionally the size of the title can also be specified.
HLAB = the height of the title in inches. (default = .16 inches)
Appendix B Sec9.75
Sets the type of TEK terminal. Null entry is not allowed. Valid values are: 4010, 4014, 4107, 4115, 4051, 4052 and 4662.
TYPE = model no. of TEK terminal default=4010
Appendix B Sec9.76
TRANSXY,n,XFACT,XOFF,YFACT,YOFF
Lets you define a linear transformation for the X and Y variables in each line, i.e., XT(i)= XFACT*X(i) + XOFF. TRANSXY does not affect the data. The translation is only applied as the data is plotted.
n = line number (no default)
XFACT = multiplicative factor for X (default=1.0)
XOFF = offset for X (default=0.0)
YFACT = multiplicative factor for Y (default=1.0)
YOFF = offset for Y (default=0.0)
The transformation factors are available in the global symbols PPL$XFACT(n), PPL$XOFF(n), PPL$YFACT(n) and PPL$YOFF(n), where "n" is the line number. Initially only the first 10 lines will have these symbols defined.
If the value being scaled is time and TAXIS is on, XOFF or YOFF is in units of DT. Unless DT is changed with the TAXIS command, it will have the default value of 1 day.
Appendix B Sec9.77
TXLABP,n
Specifies time axis label position (-1 for below plot, 0 for no label, or +1 for above plot).
Appendix B Sec9.78
TXLINT,low_int,hi_int
Specifies which time axis tics will be labeled.
Low_int = labeling interval for lowest level of tics (e.g. mon on mon/yr axis)
Hi_int = labeling interval for highest level of tics (e.g. yr on mon/yr axis)
Appendix B Sec9.79
TXLSZE,ht
Specifies height of time axis labels (inches).
Appendix B Sec9.80
Specifies number of small tics between large tics on time axis. If NMTCT is -1 the major divisions are denoted by large tics and the minor divisions by small tics, otherwise they are denoted by thick tics and large tics, respectively.
Appendix B Sec9.81
TXTYPE,type,style
Specifies type and style of time series axis, used to override the automatic choice of time-axis style.
type = MIN axis labeled with HH:MM
second line includes the day, month, year
type = HOUR axis labeled with HH:MM
second line includes the day, month, year
type = DAYS
style = HR (hour,day on 2 lines) (default)
= HRDAY (on 1 line)
type = MON
style = DAY (day,mon on 2 lines) (default)
= DAYMON (day,mon on 1 line)
= DMY (day on one line, Mon Year on second
type = YR (default)
style = MON1 (1-char month)
= MON3 (3-char month) (default)
= MONYR (month,yr on 1 line)
= MULTIYR (label years only)
Appendix B Sec9.82
VARS,NGRP,A1,A2,A3,...,Ai
Defines the location of variables within a record of a sequential data file. If only a single variable is specified and it is either X or Y the other is automatically filled with the data point number. If only Z (gridded data) is given the program expects data to be grid points in one of two formats, by rows or by columns. If X, Y, and Z (triplets) are given the program uses ZGRID to put the data on a evenly spaced grid. See the chapters Getting Started and Data Formats for more information on VARS.
NGRP = no. of groups per record
Aj = 1,2, or 3 The position of Aj in VARS command indicates which variable
is to be read as an x, y or z.
1 = X variable
2 = Y variable
3 = Z variable
i = NVAR no. of variables per group. Default=VARS,1,1,2
(i.e. one group per record, first variable is X, second is Y). If left blank
indicates a number not to be read, but a variable is present and expected by the FORMAT.
Appendix B Sec9.83
VECKEY/qualifier,x,y,ipos,format
VECKEY sets where the scaling key for the vectors is plotted. See VECTOR and VECSET commands.
x = x position of vector key
y = y position of vector key (default is no key at all)
ipos = relative position of key (not implemented)
format = format to draw the numeric part of the key default = (1pg10.3)
Valid qualifiers are:
/[NO]USER determines units of x and y positions. Default is /USER. If /NOUSER units are inches from the ORIGIN. (see the ORIGIN command)
Appendix B Sec9.84
VECSET,length,scale
VECSET sets the scaling for the vectors plotted. See the VECTOR and VECKEY commands.
length = length of standard vector in inches. this is also the length of the scale vector. Default is 0.5.
scale = length of standard vector in user units. This is also the length of the scale vector is user units. Default is the twice the mean length of the vectors.
Appendix B Sec9.85
VECTOR/qual,skipx,skipy,label
VECTOR draws a field of vectors from two component grids. See the VECKEY and VECSET commands.
skipx = plot every skipx column (default is 1)
skipy = plot every skipy row (default is 1)
label = title of plot
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw. '
Note: when making a Ferret plot using VECTOR/OVERLAY/SET_UP uvar, vvar and PPL VECTOR/OVERLAY, the /OVERLAY qualifier on the FERRET VECTOR/SET_UP is essential so that any settings made for aspect ratio, etc, will extend to the overlay vectors as well.
Appendix B Sec9.86
VELVCT,rlenfact,inc
Does a vector plot of u,v pairs located at x,y locations. This plot is done on a two dimensional field (compared to PLOTV and PLOTUV which are one dimensional). To use VELVCT the data must be stored as two lines. Line 1 containing u,v data pairs, and line 2 containing the corresponding x,y location pairs. The lines are loaded with data in the ordinary manner. Default length scaling is set to the minimum inches/user_unit along the x and y axis.
rlenfact = scaling factor for vector length (default = 1.0)
> 0 scale = rlenfact * inches/user_unit on x-axis
< 0 scale = rlenfact * inches/user_unit on y-axis
inc = plots every inc vectors (subsamples)
Example:
xaxis,0,4,1
yaxis,1,8,1
nlines,2
enter
2.2,3.3
5.0,6.0
1.3,2.0
3.0,0.0
0.5,7.3
1.3,4.4
1.1,4.2
end
enter
1,2
3,3
2,2
3,5
2,6
2,7
3,2
end
velvct,-.3,2
reads 7 x,y and u,v pairs storing them as lines then plots every other vector scaled .3 * inches/user_unit on y-axis.
Appendix B Sec9.87
VIEW/qualifiers,ZSCALE,IC,ZMIN,ZMAX,VCOMP,label
Does a 3 dimensional surface plot. Label is optional.
ZSCALE = scale of the z data
default=(YMAX - YMIN)/(ZMAX - ZMIN)
IC = 0 set Xscal = Yscale, =1 no effect. Default=0
ZMIN = set the base of the surface plot to ZMIN.
default: use ZMIN from the data
ZMAX = set the top of the surface plot to ZMAX.
default: use ZMAX from the data
VCOMP = Vector component to use for plotting (see the
VECTOR command). Default is 1.
Valid qualifiers are:
/[NO]WAIT Controls whether PPLUS pauses after plot completion. Pause is signaled by a tone and terminated by typing a character. If an <ESC> is typed PPLUS will return from the current command level to the lowest command level. Default = WAIT.
/[NO]OVERLAY Controls whether PPLUS overlays the plot on the preceeding plot. The default is /NOOVERLAY which causes the plot to be a new plot. The axes and their labels are not redrawn. Moveable labels (LABS command) will redraw.
Best results are normally obtained by using defaults. Using scales does not change the data buffer.
VPOINT,X,Y,Z
Sets the viewpoint coordinates for surface plotting. To create a surface plot use the VIEW command. The viewpoint coordinates are available in the global symbols PPL$VIEW_X, PPL$VIEW_Y and PPL$VIEW_Z. X, Y and Z form a right handed coordinate system with the Z axis up and Y axis into the page.
X = x coordinate of viewpoint
Y = y coordinate of viewpoint
Z = z coordinate of viewpoint
Appendix B Sec9.88
WHILE expression THEN
The first element of a WHILE statement the other element is ENDW. ENDW is not valid in any other context.
expression = argument operator argument
argument = symbol name, number or a string enclosed by quotes
operator = .EQ., .NE., .LT., .GT., .LE. or .GE.
The symbol name can be undefined and its value is then "" (i.e., null string).
Appendix B Sec9.89
WINDOW,ON/OFF
Windows the data to within the axes. Default=ON. Issue "PPL WINDOW OFF" after making a Ferret plot, then subsequent overlays will draw any data that is outside the plot axes outside the plot box.
Appendix B Sec9.90
Sets the x-axis characteristics. If TYPEX is not 1, then XLO and XHI must be the log of the minimum and maximum (must be integral values). XAXIS without arguments resets the auto scaling. Auto scaling does consider LIMITS and does not consider WINDOW,ON.
XLO = axis minimum (beginning of axis)
XHI = axis maximum (end of axis)
XTIC = dx distance between large tics
Appendix B Sec9.91
XFOR,frmt
Sets the format for the x axis label.
frmt = 0 or (a Fortran format specifier) default=0 (auto label)
Starting with Ferret v6.0 there is an option to label with degrees, minutes and optionally, seconds, rather than the default of degrees.decimal_degrees:
XFOR (dm) for degrees,minutes
XFOR (dms) for degrees,minutes,seconds
To create an integer numeric label the format must begin as "(I" or "(i". A latitude or longitude axis can be created by specifying ''LAT''), ''LON''), ''LONE'') or ''LONW'') in the format, where the punctuation surrounding LAT, LATW, etc is two single quotation marks. The single quotes are required because PPLUS symbol substitution will occur with 1 single quote. The hemisphere designation will be inserted. Longitude must be continuous across the dateline with west positive for ''LON'' or ''LONW'', i.e., 135 is 135W and 190 is 170E. For ''LONE'' longitude is continuous across the dateline with east positive, i.e., 135 is 135E and 190 is 170W.
Example:
yes? use coads_climatology
yes? SHADE/L=1/SET sst
yes? PPL XFOR (i5, ''LONW'')
yes? PPL shade
! To label a longitude axis with degrees, minutes use XFOR (DM)
yes? USE my_detailed_data.nc
yes? FILL/SET/x=120:123/y=20:22 var
yes? PPL XFOR (DM)
yes? PPL YFOR (DM)
yes? ppl fill
! or (DMS) may be used to label with seconds as well.
Appendix B Sec9.92
Enters the x-axis label. Label is ignored if TAXIS is on.
Appendix B Sec9.93
YAXIS,YLO,YHI,YTIC
See XAXIS.
Appendix B Sec9.94
See XFOR.
Font tables
Appendix B Sec9.95
YLAB,label
Enters the y-axis label.
Appendix B Sec10
Following are the Character and Symbol fonts available with PPLUS. Choose the font by its 2-letter code, e.g. PLOT/TITLE=@CITemperature for the title "Temperature" in complex itallic. See Embedded String Commands in this appendix for use of the PPLUS fonts.
Tables showing the character fonts
Tables showing the symbol fonts
The symbols used for PLOT/SYMBOL= are shown below. (Click on the image to expand it.) For example, PLOT/symbol=22 yields a *, and PLOT/SYMBOL=35 yields a z.
