addsd.1

speech signal process tools

.\" @(#)addsd.1	1.1 6/27/86
.TH ADDSD 1\-SPS 6/27/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"
addsd - add SPS sampled data files with scaling
.SH "SYNOPSIS"
.B addsd
[
.BI \-x " debug_level"
] [
.BI \-f " range"
] [
.BI \-s " scale"
] [
.BI \-i
] [
.BI \-t
] 
.I "file1 file2 file3"
.SH "DESCRIPTION"
.PP
.I Addsd
takes sampled date from 
.I file1,
adds it sample-by-sample to the sampled data in 
.I file2,
possibly scaling the data in 
.I file2 
first, and outputs the results as an SPS SD file
.I file3.
If there are not enough records in 
.I file2, 
and if the
.B \-t
option is not used, 
.I addsd
reuses 
.I file2,
starting with its first record.  
.PP
Both
.I file1
and
.I file2
must be SPS SD files, and they must have the same sampling 
frequency; otherwise
.I addsd
exits with an error message.  If "\-" is supplied in place of 
.I file1,
then standard input is used.  If "\-" is supplied in place of 
.I file3,
standard output is used.  In a typical application, 
.I file1
is the "signal",
.I file2
is the "noise", and
.I file3 
is the "signal + noise".  The data type for 
.I file3
is the same as that in
.I file1.  
.SH OPTIONS
.PP
The following options are supported:
.TP
.BI \-x " debug_level"
If 
.I debug_level
is positive,
.I addsd
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.  The default is 0.  Levels up through 2
are supported currently.  
.TP
.BI \-f " range"
Selects a subrange of records from 
.I file1
using the format 
.I start\-end
or
.IR start:end .
Either 
.I start
or 
.I end
may be omitted, in which case the omitted parameter defaults respectively
to the start or end of 
.I file1.  
The first record in 
.I file1
is considered to be frame 1, regardless of its position relative to any
original source file.  The default range is the entire input file
.I file1.  
The selected subrange from 
.I file1
is then added to the (possibly scaled) data from the 
.I file2,
starting with the first record of 
.I file2.
If the subrange does not exist in
.I "file1, addsd"
exits with an error message.  
.TP
.BI \-s " scale"
Causes 
.I addsd
to multiply the data in 
.I file2
by 
.I scale
before adding it to the data in 
.I file1.  
The format for 
.I scale 
is either integer or floating point.  
.TP
.BI \-i
Inhibits warning messages that normally are generated if the 
contents of 
.I file2
are used more than once.  
.TP
.BI \-t
Truncates the processing if there are not enough records in 
.I file2.
In this case, 
.I file3
will contain as many records as there are in 
.I file2
or, if the 
.B \-f
option is used, as many records as in the intersection of 
.I range
and the full range of 
.I file2.  
.SH "SPS PARAMETERS"
.PP
The SPS parameter file is not read by 
.I addsd.  
.SH SPS HEADERS
.PP
.I Addsd 
reads the following values from the input SD files:
all SPS file headers: 
.RS 5
\fI
.nf
common.type
common.ndrec
common.tag
hd.sd\->sf
hd.sd\->src_sf
.fi
\fP
.RE
.PP
The following items in the header of the output file 
.I file3
are set as appropriate:
.RS 5
\fI
.nf
common.type
common.ndrec
\fP
.fi
.RE
.PP
The following items are copied from the header of 
.I file1
to the header of 
.I file3:
.RS 5
\fI
.nf
variable.comment
variable.refer
hd.sd\->sf
hd.sd\->src_sf
.fi
\fP
.RE
.PP
The value of hd.sd\->equip is set to NONE.  
If the 
.B \-s
option is used, the value of hd.sd\->scale is set to 
the value of 
.I scale.  
If the values of 
.I hd.sd\->max_value 
from both
.I file1
and
.I file2
are non-zero, the value of 
.I hd.sd\->max_value 
in 
.I file3
is set to the value from 
.I file1
plus 
.I scale
times the value from 
.I file2;
otherwise, the value of 
.I hd.sd\->max_value 
in 
.I file3
is set to zero.  
.SH "FUTURE CHANGES"
.PP
The value of
.I hd.sd\->max_value
in 
.I file3
will correspond to the actual maximum value,
.I not
the value of 
.I hd.sd\->max_value
in 
.I file1
plus 
.I scale
times the value of
.I hd.sd\->max_value
in 
.I file2.
.SH "SEE ALSO"
.PP
SPS (5-SPS), SD (5-SPS), record (1-SPS), copysd (1-SPS) 
.SH "WARNINGS"
.PP
If there are not enough records in 
.I file2
\- i.e., if 
.I addsd
has to start over at the beginning of 
.I file2,
\- a warning message is printed.  This warning is inhibited 
by the
.B \-i
option, and does not apply if
.B \-t
is used.  
.SH "BUGS"
.PP
None known.
.SH "AUTHOR"
.PP
Ajaipal S. Virdy