plotsd.1

speech signal process tools

.\"@(#)plotsd.1	1.6 12/17/86
.TH PLOTSD 1-SPS 12/17/86
.ds ]W "\fI\s+4\ze\h'0.05'e\s-4\v'-0.4m'\fP\(*p\v'0.4m'\ Entropic Processing, Inc.
.SH NAME
plotsd - plot sampled data
.SH SYNOPSIS
.B plotsd
[
.BI \-{ps} " range"
] [
.BI \-y " range"
] [
.BI \-Y " range"
] [
.BI \-m " maxpnts"
]
.br
[
.BI \-t " text"
]
.I file
.SH DESCRIPTION
.PP
.I plotsd
plots a portion of an SPS sampled data file 
.I file.  
Actually, it generates
commands that are suitable for 
.IR plotas "(1) or"
.IR stou "(1)."
If the \fB\-p\fP option is omitted, then the \fIrange\fP is computed
from the parameter and common files, otherwise the the entire contents
of 
.I file 
is used as the default range.  
.PP
.I Plotsd
finds the maximum and  minimum values in the specified range 
and computes appropriate scales for the 
.I x\-
and 
.IR y\- axes.
These automatic values can be overriden by the 
.B \-y
or
.B \-Y 
options.  
.PP
When 
.IR stou "(1) and"
.IR mcd (1)
are used to plot on the Masscomp screen (see EXAMPLES, below), the plots
will take a long time if every point is plotted.  For this reason, 
.I plotsd
plots a maximum of approximately 3000 points across the range 
specified by the user (intermediate points are skipped).  This behavior
can be changed by means of the 
.B \-m 
option.   
.PP
.I Plotsd
will run faster if the 
.B \-Y
option is used, especially in the case of large files.  
.SH OPTIONS
.PP
The following options are supported:
.TP
.BI \-p " first:last"
.TP
.BI \-p " first:+incr
Determines the range of points to be plotted.  In the first form, a
pair of unsigned integers gives the first and last points of the range.  
If 
.I first
is omitted, 1 is used.  If 
.I last 
is omitted, the last point in the file is used.  The second form is
equivalent to the first with 
.I "last = first + incr".
.TP
.BI \-s " range"
Select a range of points to be plotted in seconds. For compatibility with
DSC LISTEN, the beginning of the file is 0.
.TP
.BI \-y " low:high"
Specifies approximate lower and upper limits for the 
.IR y- axis.
The values are adjusted by 
.I plotsd
in an attempt to make an esthetically pleasing plot.  
.TP
.BI \-Y " low:high"
Specifies exact lower and upper limits for the 
.IR y- axis.
.TP
.BI \-m " maxpnts\fR [3000]\fP"
Specifies that 
.I plotsd
plot up to an approximate maximum of 
.I maxpnts 
points.  If the total number of points in the 
.I range
exceeds 
.I maxpnts,
points are skipped evenly throughout.  
.TP
.BI \-t " text"
A line of text to be printed below the plot.  
Up to ten
.B \-t
options may be specified; they are printed as text lines in order below the
plot.
.SH EXAMPLES
.TP
.BI "plotsd " <options> " | stou | mcd"
plots on the Masscomp display.
.TP
.BI "plotsd " <options> " | plotas | tpen | ipr -Ltektronix"
plots on the Imagen
.TP
.BI "plotsd " <options> " | stou | tek | ipr -Ltektronix"
also plots on the Imagen, but a scaling factor may need to be 
specified for tek. 
.TP
.BI "plotsd " <options> " | plotas | tpen"
plots on a Tektronix terminal
.TP
.BI "plotsd " <options> " | stou | tek"
also plots on a Tektronix terminal. 	
.SH "SPS COMMON"
The following items are read from the SPS Common file.  The values for
start and nan are not used if a range is specified on the command line or
if the input file is not the same file identified in the
Common file by the "filename" symbol. 
.IP
.I "start - integer"
.IP
This is the starting point in the sampled data file to begin
plotting. If it is zero, the beginning of the file is used.
.sp
.I "nan - integer"
.IP
This is the number of points (starting at 
.IR start )
to plot.
If it is zero, the entire file is used as the default.  
.sp
.I "filename - string"
.IP
This is the name of the file to be displayed if \fIfile\fP is omitted
from the command line.
.PP
The following items are written into the SPS Common file:
.IP
.I "start - integer"
.IP
The left point in the range selected.
.sp
.I "nan - integer"
.IP
The number of points in the selected range.
.sp
.I "beginplot - integer"
.IP
The origin of the graph (x-coordinate).
.sp
.I "endplot - integer"
.IP
The end point of the graph (x-coordinate).
.sp
.I "prog - string"
.IP
This is the name of the program (\fIplotsd\fP in this case).
.sp
.I "filename - string"
.IP
This is the name of the file to be displayed.
The program terminates if \fIfilename\fP does not exist when \fIfile\fP
is not specified on the command line.
.SH "SPS HEADERS"
.PP
.I Plotsd
reads the following fields from the SD file header:
.I common.type,
.I common.ndrec,
.SH DIAGNOSTICS
.PP
.I Plotsd
complains if there is no such file, or if the file is not a sampled data file.
.SH EXPECTED CHANGES
.PP
Many more options may be added.
.SH SEE ALSO
.IR plotpit (1\-SPS), 
.IR plotsdm (1\-SPS), 
.IR plotsdi (1\-SPS), 
.IR mlplot (1\-SPS), 
.IR genplot (1\-SPS), 
.IR stou "(1),\ " 
.IR plotas "(1),\ "
.IR mcd "(1),\ "
.IR tek "(1).\ "
.SH AUTHOR
.PP
.nf
Joseph T. Buck, Entropic Processing, Inc.
Adapted from a program by Shankar Narayan.
Converted by Rod Johnson to read new SPS format.
Modified for SPS Common by Ajaipal S. Virdy.
Modified for -y, -Y, and -m by John Shore
Manual page revised by John Shore
.fi