feafunc.1

来自「speech signal process tools」· 1 代码 · 共 436 行 · 第 1/2 页

\fIcos\fP (cosine),
\fIexp\fP (exponential),
\fIexp10\fP (10 to the given power),
\fIim\fP (imaginary part),
\fIlog\fP (natural logarithm),
\fIlog10\fP (base 10 logarithm),
\fInone\fP (no change\*-the identity function),
\fIre\fP (real part),
\fIrecip\fP (reciprocal),
\fIsgn\fP (signum; for a complex number \fIz\fP off the real axis, the value is
.IR z /| z |),
\fIsin\fP (sine),
\fIsqr\fP (square),
\fIsqrt\fP (square root),
\fItan\fP (tangent).
The case doesn't matter:  upper is not distinguished from lower.
The multiplicative and additive constants in the expression
\fIg*F(element) + d\fP are obtained from the \fB\-g\fP and \fB\-d\fP options.
The default function ("none") does nothing:
it just returns its argument unchanged.
.TP
.BI \-P " param" " \fR[params]\fP"
Specifies the name of the parameter file.
.SH "ESPS PARAMETERS"
.PP
The parameter file does not have to be present,
since all the parameters have default values.
The following parameters are read, if present, from the parameter file:
.TP
.I "add_real \- float"
.IP
This is the value for \fId\fP in the expression \fIg*F(element) + d\fP,  
or the real part of
.I d
if
.I d
is complex.  The default is 0.
This parameter is not read if the \fB\-d\fP option is used. 
.TP
.I "add_imag \- float"
.IP
This is the imaginary part of
.I d
in the expression \fIg*F(element) + d\fP.
The default is 0.  This parameter is not read if the \fB\-d\fP option is used.
.TP
.I "input_field \- string"
.IP
This is the name of the selected data field in \fIinput\fP.
The default is "samples".  A parameter file value (if present) is overridden
by the first use of the \fB\-f\fP option.  
.TP
.I "output_field \- string"
.IP
This is the name of the \fIoutput\fP field in which the the values of
\fIg*F(element) + d\fP are stored.  The default name is that of
\fIinput_field\fP with a suffix that identifies the function \fIF\fP.
A parameter file value (if present) is overridden by the second use of
the \fB\-f\fP option.
.TP
.I "gain_real \- float"
.IP
This is the factor \fIg\fP in the expression \fIg*F(element) + d\fP,
or the real part of
.I g
if
.I g
is complex.  
The default is 1.  This parameter is not read if the \fB\-g\fP option is used.
.TP
.I "gain_imag \- float"
This is the imaginary part of
.I g
in the expression \fIg*F(element) + d\fP.
The default is 0.  This parameter is not read if the \fB\-g\fP option is used.
.TP
.I "start \- integer"
.IP
This is the first record of \fIinput\fP to process.  The default is 1.
It is not read if the \fB\-r\fP option is used.
.TP
.I "nan \- integer"
.IP
This is the number of records to process.  It is not read if the
\fB\-r\fP option is used.  A value of zero means all subsequent
records in the file; this is the default.
.TP
.I "output_type \- string"
.IP
This is the desired data type of \fIoutput_field\fP.  Allowable values
are double, float, long, short, byte (or char), double_cplx, float_cplx,
long_cplx, short_cplx, and byte_cplx (case insensitive).  The
default is the type of \fIinput_field\fP.  A parameter file 
value is not read if the \fB\-t\fP option is used.  
.TP
.I "function_type \- string"
The function \fIF\fP.
Allowable values are
abs, arg, atan, conj, cos, exp, exp10, im, log, log10, none, re, recip,
sgn, sin, sqr, sqrt, and tan (case insensitive).
This parameter is not read if the command-line
option
.B \-F
is specified.  If the option is omitted and if no value is found in
the parameter file, the default used is "none".
See the discussion of the \fB\-F\fP option.
.PP
Remember that command line option values override parameter-file
values.
.SH "ESPS COMMON"
.PP
ESPS Common processing may be disabled by setting the environment variable
USE_ESPS_COMMON to "off".  The default ESPS Common file is .espscom 
in the user's home directory.  This may be overridden by setting
the environment variable ESPSCOM to the desired path.  User feedback of
Common processing is determined by the environment variable ESPS_VERBOSE,
with 0 causing no feedback and increasing levels causing increasingly
detailed feedback.  If ESPS_VERBOSE is not defined, a default value of 3 is
assumed.
.PP
ESPS Common is not processed by 
.I feafunc
if \fIinput\fP is 
standard input.  Otherwise, provided that the Common file is newer 
than the parameter file, and provided that the \fIfilename\fP entry in 
Common matches \fIinput\fP, the Common values for \fIstart\fP and 
\fInan\fP override those that may be present in the parameter file. 
.PP
The following items are written into the ESPS Common file 
provided that \fIoutput\fP is not <stdout>.  
.IP
.I "start \- integer"
.IP
The starting point from the input file.
.sp
.I "nan \- integer"
.IP
The number of points in the selected range.
.sp
.I "prog \- string"
.IP
This is the name of the program 
.RI ( feafunc
in this case).
.sp
.I "filename \- string"
.IP
The name of the input file \fIinput\fP.
.SH ESPS HEADERS
.PP
The \fIoutput\fP header is a new FEA file header.  All generic header
items are copied from the input header to the output header.  The
generic header item \fIstart_time\fP is written with a value computed
by taking the \fIstart_time\fP value from the header of the input file
(or zero, if such a header item doesn't exist) and adding to it the
relative time from the first record in the file to the first record
processed.  The computation of \fIstart_time\fP depends on the 
value of the generic header item \fIrecord_freq\fP in the input file.
If this item is not present, \fIstart_time\fP is just copied from 
the input file to the output.  
.PP
The items \fIstart\fP and \fInan\fP are rewritten (if they already
exist) to contain the starting record number and number of records
processed.  Generic header items are added for the
\fIfunction_type\fP, \fIgain_real\fP, \fIgain_imag\fP, \fIadd_real\fP,
\fIadd_imag\fP, \fIinput_field\fP, and \fIoutput_field\fP.
As usual, the command line
is added as a comment, and the header of \fIinput\fP is added as a
source file to \fIoutput\fP.
.SH "FUTURE CHANGES"
.PP
.SH "SEE ALSO"
.nf
\fIaddfea\fP(1\-\s-1ESPS\s+1), \fIaddgen\fP(1\-\s-1ESPS\s+1),\fIcopysps\fP(1\-\s-1ESPS\s+1), 
\fIcopysd\fP(1\-\s-1ESPS\s+1),\fIclip\fP(1\-\s-1ESPS\s+1),\fIframe\fP(1\-\s-1ESPS\s+1),
\fImergefea\fP(1\-\s-1ESPS\s+1), \fIpwr\fP(1\-\s-1ESPS\s+1), \fIselect\fP(1\-\s-1ESPS\s+1),
\fIarr_func\fP(3\-\s-1ESPS\s+1),\fItype_convert\fP(3\-\s-1ESPS\s+1sp),FEA(5\-\s-1ESPS\s+1)
.fi
.SH "WARNINGS AND DIAGNOSTICS"
.PP
When functions (\fB\-F\fP option) or conversions (\fB\-t\fP option) lead
to undefined or out-of-bounds values, the results vary with the
machine on which \fIfeafunc\fP is run.  If floating-point exceptions
are generated, \fIfeafunc\fP exits with an error message.  On some
machines, such values do not result in exceptions; they are specially
coded (NaN, Infinity, etc.) and can be observed using
\fIpsps\fP(1\-\s-1ESPS\s+1).
.PP
If an unknown option is specified, if
.B \-f
is used more than twice, or if the number of file names is wrong,
.I feafunc
prints a synopsis of command-line usage and exits.
The program exits with an error message if any of the following are true: 
an unknown function name is specified;
.I input
does not exist or is not an ESPS FEA file; 
.I input
is the same as
.I output
(but not "\-");
the \fIinput_field\fP does not exist in
.I input;
the \fIoutput_type\fP is not known or nonnumeric;
a bad range is specified with
.BR \-r .
The program prints a warning and continues if an explicit
.I output_field
(that is, not specified as "\-") already exists in
.I input.
.SH "BUGS"
.PP
None known.  
.SH "AUTHOR"
.PP
Manual page and program by John Shore.  Treatment of complex values
revised and additional functions added by Rod Johnson.