testsd.1

speech signal process tools

.\" @(#)testsd.1	1.3 4/2/87 EPI
.TH TESTSD 1\-SPS 4/2/87
.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"
testsd - make SD file with sine wave, pulses, Gaussian noise, or from ASCII data
.SH "SYNOPSIS"
.B testsd
[
.BI \-x " debug_level"
] [
.BI \-f " frequency"
] [
.BI \-l " level"
] [
.BI \-r " sampling_rate"
] [
.BI \-{ps} " length"
] [
.BI \-T " type"
] [
.BI \-a " asciifile"
] [
.BI \-S " seed"
] [
.B \-i
] 
.I "sdfile"
.SH "DESCRIPTION"
.PP
.I Testsd
produces test sampled data and puts it into the SD file 
file1.  If "\-" is supplied in place of 
.I sdfile,
then standard output is used.  The test data can be either a sine 
wave, a pulse train, Gaussian noise, or the data specified in an input
ASCII file 
.I asciifile.  
If "\-" is supplied in place of
.I asciifile,
then standard input is used.  
.SH OPTIONS
.PP
The following options are supported:
.TP
.BI \-x " debug_level \fR[0]\fP"
If 
.I debug_level
is positive,
.I testsd
prints debugging messages and other information on the standard error
output.  The messages proliferate as the  
.I debug_level
increases.  If
.I debug_level
is 0, no messages are printed.  Only levels 0 and 1 are supported.   
.TP
.BI \-f " frequency \fR[500]\fP"
Selects the frequency in the case of sine waves.  In the case of a 
pulse train, the frequency is the reciprocal of the pulse repetition 
interval.  The default is 500 Hz.  This option is ignored if 
.B \-a
is specified.  
.TP
.BI \-l " level \fR[500]\fP"
Selects the power level of the test data.  For Gaussian noise, 
.I level
is the RMS amplitude (standard deviation).  For pulse trains and sine waves,
.I level
is the amplitude of the pulses.  This option is ignored if 
.B \-a
is specified. 
.TP
.BR \-r " [8000]"
Selects the sampling rate.  The default is 8000 Hz.  
.TP 
.BI \-p " length \fR[8000]\fP"
Specifies that 
.I sdfile
contain 
.I length 
points.   This option is 
not allowed if 
.B \-a 
is specified.  
.TP
.BI \-s " length"
Specifies that 
.I sdfile
contain 
.I length
seconds of sampled data.   This option is 
not allowed if 
.B \-a 
is specified.  
.TP
.BI \-T " type \fR[sine]\fP"
Specifies the type of test data.  Possible values are "sine" (for a
sine wave), "gauss" (for Gaussian noise), and "pulses" (for a pulse
train).  If a pulse train is specified, positive pulses will be 
spaced equally through
.I sdfile, 
starting at record 1 and with spacing equal to reciprocal of the 
.I frequency, 
(rounded to the closest sample).  This option is 
not allowed if 
.B \-a 
is specified.  
.TP
.BI \-a " asciifile"
Specifies that the sampled data is to be taken from the input ASCII
file 
.I asciifile.  
Numbers in 
.I ascciifile
may be integer or real, with numbers separated by white space or 
new lines.  
.TP
.BI \-S " seed \fR[1234567]\fP"
Specifies the starting seed for the random number generator (relevant
if Gaussian noise is being generated).
.TP
.BI \-i
Specifies that the data type in 
.I sdfile
is a short.  Otherwise, the data type is float.  
.SH "SPS PARAMETERS"
.PP
The SPS parameter file is not read by 
.I testsd.  
.SH "SPS COMMON"
.PP
If the output is not to standard output, then
.I testsd
writes the following values into SPS Common: 
.RS 5
\fI
.nf
filename = sdfile
prog = \fR"testsd"\fP
start = \fR1\fP
nan = \fR<total number of points generated>\fP
.fi
\fR
.RE
.SH SPS HEADERS
.PP
In addition to the usual header values for SD files, 
.I testsd
writes the following values:
.RS 5
\fI
.nf
hd.sd\->equip = \fRNONE\fP
hd.sd\->max_value = \fR<value derived from test data>\fP
hd.sd\->scale = \fR0\fP
hd.sd\-dc_rem = \fR0\fP
hd.sd\->nchan = \fR1\fP
hd.sd\->sf = frequency
hd.sd\->src_sf = \fR0\fP
.fi
\fP
.RE
.PP
.I Testsd
also writes the generic header item "test_type", which identifies
the type of test data (SINE, GAUSS, PULSE, or ASCII).  
If the type is GAUSS, then 
.I testsd
also writes the random number seed to the generic header item "seed".  
.SH "FUTURE CHANGES"
.PP
Additional types of test data will be generated.  
.SH "SEE ALSO"
.PP
SPS (5-SPS), SD (5-SPS), addsd (1-SPS), atoarrayf (3-SPS).  
.SH "WARNINGS AND DIAGNOSTICS"
.PP
.I Testsd
will exit with appropriate messages if 
.B \-p
and
.B \-s
are both used, if 
.B \-f
is used with 
.BR \-T gauss,
if 
.B \-a 
is used with 
.B \-T,
and if 
.B \-a 
is used with either 
.B \-p
or
.B \-s.
.SH "BUGS"
.PP
None known.  
.SH "REFERENCES"
.PP
.SH "AUTHOR"
.PP
Manual page by John Shore; program by John Shore.