cat

speech signal process tools

PWR(1-ESPS)                                 ENTROPIC RESEARCH LAB



NNNNAAAAMMMMEEEE
     pwr - computes power of sampled data in FEA records

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     ppppwwwwrrrr [ ----llll ] [ ----PPPP _p_a_r_a_m_s ] [ ----ffff _s_d__f_i_e_l_d [ ----ffff _p_o_w_e_r__f_i_e_l_d ]] [
     ----rrrr _r_a_n_g_e ] [ ----xxxx _d_e_b_u_g__l_e_v_e_l ] _i_n_p_u_t _o_u_t_p_u_t

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     _P_w_r accepts a FEA file _i_n_p_u_t containing  a  vector  sampled-
     data  field  in  each  record  (there may be other fields as
     well).  It produces a FEA file _o_u_t_p_u_t with records  contain-
     ing  the  raw  power  (or log raw power) of the sampled-data
     field from that record.  Each field of sampled data  may  be
     thought  of  as  a  separate frame of data, such as might be
     produced by _f_r_a_m_e (1-ESPS).  The default name for  the  sam-
     pled data field in _i_n_p_u_t is _s_d, and the default name for the
     power field in _o_u_t_p_u_t is _r_a_w__p_o_w_e_r (_l_o_g__p_o_w_e_r if  ----llll  option
     used).  Both  defaults  can  be  changed  by means of the ----ffff
     option.  If _i_n_p_u_t is "-", standard input  is  used  for  the
     input  file.   If  _o_u_t_p_u_t is "-", standard input is used for
     the output file.

     The power is computed by summing the squares of the  sampled
     data  values  and  dividing  by  the number of points in the
     frame.  If _i_n_p_u_t is not a segment-labelled FEA file (see FEA
     (5 - ESPS)),  the frame is considered to comprise all of the
     points in the sampled data field, so the frame length  is  a
     constant  set  to  the size of the sampled data field (which
     can be determined  from  the  file  header).   If  _i_n_p_u_t  is
     segment-labelled,  the  size  of  the  sampled data field is
     really a maximum size, and the frame size for  a  particular
     record  is  given by the _s_e_g_m_e_n_t__l_e_n_g_t_h field (this field is
     always  present  in  segment-labelled  files).   Thus,   for
     segment-labelled  files,  the frame from any input record is
     the first _s_e_g_m_e_n_t__l_e_n_g_t_h points of the sampled data field.

     If the ----llll is used, the (base 10) log of  the  raw  power  is
     stored  in  the output file instead of the raw power itself.
     To avoid computational overflow,  logs  are  not  taken  for
     power  values  less  than 10/DBL_MAX; in these cases the log
     power stored is log10(10/DBL_MAX),  which  is  approximately
     -307.55.

OOOOPPPPTTTTIIIIOOOONNNNSSSS
     The following options are supported:

     ----llll    Specifies that the log (base 10) of the raw  power  be
          computed  instead  of the raw power.  If this option is
          used, the default name for the output  power  field  is
          _l_o_g__p_o_w_e_r; this name can be changed via the ----ffff option.

     ----PPPP _p_a_r_a_m [params]



        Copyright Entropic Research Laboratory, Inc. 1G1        1






PWR(1-ESPS)                                 ENTROPIC RESEARCH LAB



          Specifies the name of the parameter file.

     ----rrrr _s_t_a_r_t::::_l_a_s_t [1:(last in file)]

     ----rrrr _s_t_a_r_t::::++++_n_a_n
          In the first form, a pair of unsigned  integers  speci-
          fies  the  range  of  records  to be processed.  Either
          _s_t_a_r_t or _l_a_s_t may be omitted; then the default value is
          used.  If _l_a_s_t = _s_t_a_r_t + _n_a_n, the second form (with the
          plus sign) specifies the same range as the first.   The
          ---- rrrr  overrides  the  values  of  _s_t_a_r_t and _n_a_n from the
          parameter file.

     ----ffff _f_i_e_l_d__n_a_m_e
          If this option is used once, it specifies the  name  of
          the  sampled data field in _i_n_p_u_t.  If it is used twice,
          the second time it specifies  the  name  of  the  power
          field  in  _o_u_t_p_u_t.   The default names for these fields
          are "sd"  and  "raw_power",  respectively.  If  the  ----llll
          option is used, the default name for the power field is
          "log_power".

EEEESSSSPPPPSSSS PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
     The parameter file does not have to be  present,  since  all
     the  parameters  have default values.  The following parame-
     ters are read, if present, from the parameter file:

          _s_d__f_i_e_l_d__n_a_m_e - _s_t_r_i_n_g

          This is the name of the sampled data  field  in  _i_n_p_u_t.
          The  default  is  "sd".   A  paramter  file  value  (if
          present) is overidden by  the  first  use  of  the  ---- ffff
          option.

          _p_o_w_e_r__f_i_e_l_d__n_a_m_e - _s_t_r_i_n_g

          This is the name of the raw power field in _o_u_t_p_u_t.  The
          default  is  "raw_power".   A  parameter file value (if
          present) is overidden by the  second  use  of  the  ---- ffff
          option.

          _p_o_w_e_r__f_u_n_c_t_i_o_n - _s_t_r_i_n_g

          This is the function to apply to value of the raw power
          before  storing  in  the  output  file.  The default is
          "none", which means that the output file is to  contain
          the  raw  power value.  The only other recognized value
          is "log", which means that the output file is  to  con-
          tain the log of the raw power.

          _s_t_a_r_t - _i_n_t_e_g_e_r




        Copyright Entropic Research Laboratory, Inc. 2G2        2






PWR(1-ESPS)                                 ENTROPIC RESEARCH LAB



          This is the first record  of  _i_n_p_u_t  to  process.   The
          default is 1.  It is not read if the ----rrrr option is used.

          _n_a_n - _i_n_t_e_g_e_r

          This is the number of records to process.   It  is  not
          read  if  the ----rrrr option is used.  A value of zero means
          all  subsequent  records  in  the  file;  this  is  the
          default.

     Remember that command line option values override  parameter
     file values.

EEEESSSSPPPPSSSS CCCCOOOOMMMMMMMMOOOONNNN
     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  overidden by setting the environment variable
     ESPSCOM to the desired path.  User feedback of  Common  pro-
     cessing   is   determined   by   the   environment  variable
     ESPS_VERBOSE, with 0 causing no feedback and increasing lev-
     els causing increasingly detailed feedback.  If ESPS_VERBOSE
     is not defined, a default value of 3 is assumed.

     ESPS Common is not processed by _p_w_r  if  _i_n_p_u_t  is  standard
     input.   Otherwise,  provided  that the Common file is newer
     than the parameter file,  and  provided  that  the  _f_i_l_e_n_a_m_e
     entry  in  Common matches _i_n_p_u_t, the Common values for _s_t_a_r_t
     and _n_a_n override those that may be present in the  parameter
     file.

     The following items are written into the  ESPS  Common  file
     provided that _o_u_t_p_u_t is not <stdout>.

          _s_t_a_r_t - _i_n_t_e_g_e_r

          The starting record from the input file.

          _n_a_n - _i_n_t_e_g_e_r

          The number of records in the selected range.

          _p_r_o_g - _s_t_r_i_n_g

          This is the name of the program (_p_w_r in this case).

          _f_i_l_e_n_a_m_e - _s_t_r_i_n_g

          The name of the input file _i_n_p_u_t.

EEEESSSSPPPPSSSS HHHHEEEEAAAADDDDEEEERRRRSSSS




        Copyright Entropic Research Laboratory, Inc. 3G3        3






PWR(1-ESPS)                                 ENTROPIC RESEARCH LAB



     The _o_u_t_p_u_t header is a new FEA file header.  If the  generic
     header item _s_r_c__s_f exists in the input file, it is copied to
     the output file.  The items _s_t_a_r_t and  _n_a_n  are  written  to
     contain  the  starting  record  number and number of records
     processed.

     The size of the input sampled data field is written  to  the
     generic _f_r_m_l_e_n.

     The generic header item _s_t_a_r_t__t_i_m_e is written in the  output
     file.    The   value  written  is  computed  by  taking  the
     _s_t_a_r_t__t_i_m_e value from the header of the input file (or zero,
     if such a header item doesn't exist), adding to it the rela-
     tive time from the first record in the  file  to  the  first
     record processed, and adding a displacement corresponding to
     half of _f_r_m_l_e_n.  The computation of  _s_t_a_r_t__t_i_m_e  depends  on
     the  value  of  the  generic header item _s_r_c__s_f in the input
     file (which is assumed to be the sampling rate of the actual
     data   in  each  field).   If  this  item  is  not  present,
     _s_t_a_r_t__t_i_m_e is just copied from the input file to the  output
     file.

     As usual, the command line is added as  a  comment  and  the
     header  of  _i_n_p_u_t  is  added  as  a  source  file to _o_u_t_p_u_t.
     Another comment gives the name of the field added by _p_w_r.

FFFFUUUUTTTTUUUURRRREEEE CCCCHHHHAAAANNNNGGGGEEEESSSS
     Control over the type of the output power field.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     _f_r_a_m_e (1-ESPS), FEA (5-ESPS), _f_e_a__s_t_a_t_s (1-ESPS),
     _s_t_a_t_s (1-ESPS)

WWWWAAAARRRRNNNNIIIINNNNGGGGSSSS AAAANNNNDDDD DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
     _p_w_r will exit with an error message if any of the  following
     are  true:  _i_n_p_u_t does not exist or is not an ESPS FEA file;
     the sampled-data field does not exist in  _i_n_p_u_t;  the  power
     field already exists in _i_n_p_u_t.

BBBBUUUUGGGGSSSS
     None known.

AAAAUUUUTTTTHHHHOOOORRRR
     Manual page by John Shore.  Program by Rodney Johnson.











        Copyright Entropic Research Laboratory, Inc. 4G4        4