User's Guide

CORRPLOT

Display correlation residual plots.

Function:

Displays correlation residual plots.

Parameters:

INFILE
Input file. Residual plot (;plt) file produced by EDITCORR. See User Note 1 for information on the format of this file.

TITLE(--)
Plot title. Title string to be centered at the top of the output plot. No title will be created if this value is null.

SCALFACT(100)
Scale Factor. The residuals are multiplied by this value to exaggerate their magnitude on the output plot.

DSPFLG("NO")
Display flag. Displays the labels with each point plotted.
  = YES:       Display point labels
  = NO:        Do not display 
               point labels
PLOTOPT("BOTH")
Plotting option. The residuals are plotted in the direction specified.
  = LINE:      Line residual only
  = SAMPLE:    Sample residual only
  = BOTH:      Both line and sample
PRINT("TERM")
Output destination. The destination of the output plot. See User Notes 2 and 3 for more information.
  = TERM:      Terminal
  = LP:        Line printer
  = Filename:  User supplied filename
PTRTYPE("PS")
Printer type. The type of printer that will generate the plot. PTRTYPE is ignored when PRINT=TERM.
  = ASCII:     ASCII Printer
  = HPLJ:      HP LaserJet II
  = PS:        Postscript
DPI(150)
Printer resolution. Resolution in dots per inch of the printer. This is only used with PTRTYPE=HPLJ.
  = 75:
  = 100:
  = 150:
  = 300:

Examples:

LAS> corrplot infile=resdata title="residual data plot" scalfact=400 print=lp dpi=300
The correlation residuals in file resdata;plt are plotted on a HP LaserJet with a resolution of 300 dots per inch. This printer is specified by the TAE global $PRINTER. The residuals are scaled 400:1 to aid in interpreting the plot.
LAS> corrplot infile=jvcx200 title="jvcx200 results" scalfact=200 print=plot;ps ptrtype=ps
The correlation residuals in file jvcx200;plt are plotted to the postscript file plot;ps. The residuals are scaled 200:1 to aid in interpretting the plot.
LAS> corrplot infile=jvcx201 title="jvcx201 results" plotopt=line dspflg=yes
The correlation residuals in the line direction only from jvcx201;plt are plotted to the user's terminal. Point ID's are included in the plot. See User Note 2.

Description/Algorithm:

CORRPLOT reads a correlation residual file and plots the residual data to a printer, file, or the user's terminal. For each point in the input file, a point name and a vector are plotted indicating the location of the point and the residual error. Postscript and Hewlett-Packard LaserJetII compatible printers are supported. GNUPLOT is used to perform the actual data graphing.

NonFatal Error Messages:

[corrplot-print] Printer not defined, <xxxx> not deleted.
The printer name in the TAE global $PRINTER is not defined. Please consult with your system administrator for valid printer names.
[corrplot-lp] Error printing file, <xxxx> not deleted.
An error occurred when the plot was sent to the printer. If this situation persists, contact your system administrator for assistance.

Fatal Error Messages:

[corrplot-fatal] Fatal error encountered
The error message displayed immediately preceding this message is the specific error that was encountered. Processing is terminated.
[corrplot-fopen] Error opening <xxxx> file
The <xxxx> file cannot be opened. The user doesn't have permission or enough disk space to open the file.
[corrplot-fprintf] Error writing <xxxx> file
An error has occurred writing to a file. This may be the result of bad media and/or not enough disk space.
[corrplot-fscanf] Error reading file
An error has occurred reading the input file. The input data file may have been corrupted. Make sure the number of points specified matches the number of points actually in the file by examining the file with a text editor.

User Notes:

The residual plot file is an ASCII file created by the EDITCORR application. This file is in the following format:
```
    number of points
    name1 samp1 line1 ds1 dl1 actflg
    name2 samp2 line2 ds2 dl2 actflg
    .
    nameN sampN lineN dsN dlN actflg
    Root Mean Squared Error (RMSE)
```
where N is the number of residual points, ds is the sample component of the residual, dl is the line component of the residual, and actflg is 0 for active, 1 for inactive.
If PRINT=TERM the data plot is normally displayed on the user's terminal in ASCII form. However, if the X Window System is being used and the environment variable DISPLAY is defined, a window containing the plot will be created.
The output plot cannot be sent to a printer or file and also be sent to the user's terminal. If another print destination is specified in addition to the terminal, no terminal output is created.
The graphing package GNUPLOT is used to create the residual plots. This program must be in the user's execution path. If this program is not in the path or is not installed, contact the system administrator.
Related routines are EDITCORR and VERIFY.