waves+.help

speech signal process tools

This help file contains a brief introduction to waves+ operations and
a list of waves+ global parameters and commands.  For more information, 
see the full waves+ man page.  To do so, run "eman waves+" in a
shelltool window or, if you are using X Windows, click on the "waves+ 
manual" button in the control panel.

WAVES+ STARTUP
==============

Waves+ starts up with the following steps: 

(1) It checks to see if any optional DSP board is installed (by trying
to open /dev/dsp32).  If a board is found, waves+ will use it for
spectrograms and speech output, and all FEA_SD files will be read in
as SHORTs.  If no board is found, waves+ will use external ESPS
programs for spectrogram computation and speech output, and it will
not transform the type of FEA_SD files.  

(2) It reads global parameter settings from a startup file.  The file
is (in order of precedence) (a) whatever is specified by the -w
option; (b) the file .wave_pro in your home directory; or (c)
$ESPS_BASE/lib/waves/.wave_pro.  Any file specified by -w or in the
profile is searched for on the path "$HOME:$ESPS_BASE/lib/waves/.wave_pro".
The search path used can be overriden by setting the unix environment variable
WAVES_PROFILE_PATH before starting xwaves+.

(3) It processes whatever signal or command files may be listed on the
command line.

WAVES+ CONTROL PANEL
====================

The values of panel items ending with a colon may be modified by left
mousing (to activate the item) followed by text or numeric input.  Use
<delete> to delete the previous character entered and <CTRL-u> to
remove the entire line.  Any new or changed value must be "entered"
(while activated) by hitting the return key.  The "PAUSE", "CONTINUE,"
"QUIT!," "HELP!", and "waves+ manual" items perform the corresponding
functions immediately when moused.  Here are brief explanations of the
panel items.  For details, see the man page.


 INPUTfile:  
     The relative or absolute pathname of a signal to be
      displayed.  A search path ".:$ESPS_BASE/lib/waves/files" 
      is used, but can be overriden with the environment variable 
      WAVES_INPUT_PATH.  Multiple views on a given file may be 
      established by entering the same file name several times.  
      Files with ESPS headers, SIGnal headers, and no headers are 
      handled. 

 OUTPUTfile:
      Base name of files to be created by the "save
      segment in file" function.  NO CHECK IS MADE FOR
      OVERWRITING EXISTING FILES! A list of all files
      generated during a given run of waves+ may be browsed
      by right mousing the OUTPUTfile item.  

 OBJECT name:
     The name by which to refer to a display ensemble.  All
     data views in an ensemble have their time cursors and
     markers synchronized and are treated as a unit during
     interaction and in other respects.  If a new object
     name is specified, subsequently generated data views
     become part of a logically distinct ensemble of signals
     and displays.

  COMMAND(or @file):
     A direct command to the xwaves+ program or to an object
     displayed by xwaves+, or the pathname of a text file
     (preceded by the "@" character) containing commands.
     This item may be changed at any time (even in the middle 
     of execution of a command file).  The default search path
     ".:$ESPS_BASE/lib/waves/commands" is used for command files,
     but can be overriden with the environment variable 
     WAVES_COMMAND_PATH.

  PAUSE
     Mousing this item while a command file is running causes the 
     command file to suspend execution, much as though a "pause" 
     command had been encountered in the file.

  CONTINUE
     Mousing this item causes waves+ to resume reading from
     a command file after encountering a "pause" in that file (or
     after the PAUSE button has been moused). 

  Attach:
     The name of a function to attach to waves+.  If the
     function is in ESPS/bin it may be referred to simply by
     its basename.  Otherwise, its full pathname must be specified.

  Overlay name:
     The relative or absolute name of a SIGnal formant-bandwidth 
     file or any ESPS FEA file.  Each element of each FEA field is 
     overlayed with a separate track labelled with the field name 
     and element number.  By default, the overlay takes place on 
     the most recently read or computed spectrogram display.  

  HELP
     Mousing this item displays this file. 

  QUIT
     Mousing this item causes waves+ to clean up (saving files), 
     return the license, and exit.  

WAVES+ GLOBALS 
==============

The waves+ global parameters can all be initialized at startup from
the .wave_pro file in your home directory.  To change them after 
waves+ starts, enter

          set <global name> <global value>

in the space after the "COMMAND(or @file):" prompt in the control
panel, or enter the name of a command file containing a sequence of 
"set" commands.  Here is a list of the current globals, with brief 
descriptions.  For details, see the man page. 

  bg_color
       background color for window frames (6 digits; 2
       each for red, green, blue) (see also fg_color)

  colormap
       file name of an RGB color map (see "COLORMAPS"
       below)

  command_step
       Allows the user to single-step through command
       files.  

  ctlwin_x
       x coordinate of upper left of control window

  ctlwin_y
       y coordinate of upper left of control window

  debug_level
       > 0 causes debug messages to be printed.  

  def_header
       filename of a header for use with headerless
       data; the default startup profile
       ($ESPS_BASE/lib/waves/.wave_pro) sets this to
       $ESPS_BASE/lib/waves/files/def_head.feasd, which
       is an ESPS FEA_SD header for single-channel,
       SHORT, sampled-data, with sampling rate 8000 Hz.
       A default SIGnal header is in
       $ESPS_BASE/lib/waves/files/def_head.sig.  The
       default search path used for default header file
       names is ".:$ESPS_BASE/lib/waves/files"; this
       can be overriden by setting the unix environment
       variable WAVES_INPUT_PATH before starting
       waves+. If the environment variable DEF_HEADER is
       defined when waves+ starts up, its value takes 
       precedence over def_header.  Thus, if you want
       def_header to change for different input files while
       waves+ is running, then DEF_HEADER should not be defined.

  do_color
       0 or 1 to enable B&W or color operation; This
       global is set automatically on startup prior to
       reading the startup profile. 

  dsp32_wait
       Specifies the number of attempts (at one second
       intervals) that waves+ will make to use an
       installed DSP32 board before giving up. 

  edit_ganged
       1 to edit all signals in object, 0 for just one

  fea_sd_special
       1 to treat ESPS FEA_SD files as a special case,
       0 to treat in standard FEA manner.  If
       fea_sd_special == 1, the sampled data from ESPS
       FEA_SD files are read in as SHORTs (regardless
       of their external representation). 

  fg_color
       foreground color for window frames (6 digits; 2
       each for red, green, blue) (see also bg_color)

  first_x
       x coordinate of upper left of first window created

  first_y
       y coordinate of upper left of first window created

  funcname
       an attached function (like "label" or "spectrum")

  f0_min
       minimum frequency to display for F0 files

  f0_plot_specs
       plotting method and optional ASCII symbol to use.  

  f0_range
       range in Hz to display for F0 files

  f0_size
       fraction of canvas for plotting F0 for F0 files

  image_clip
       This is used by the digital halftone algorithm
       when spectrograms are displayed on a monochrome
       monitor.  Values between MAX and (MAX -image_clip) 
	    are displayed in black. 

  image_range

       Everything below (MAX - image_clip - image_range) 
       is shown in white for spectrograms on monochrome monitor

  inputname
       default pathname to appear at "INPUT file" prompt

  invert_dither
       If set to non-zero, this causes digital-halftone images
       to appear with black and white pixels reversed ("inverse video").  

  line_type
       plotting algorithm to use for plotting generic vector signals.  

  left_op
       text corresponding to desired left button operation.

  max_buff_size
       determines a limit on the number of bytes of
       storage that waves+ will attempt to allocate for
       in-memory data storage for any one signal.

  middle_op
       text string corresponding to desired middle button op

  min_spec_height
       minimum height in pixels of spectrogram windows

  min_spec_width
       minimum width in pixels of spectrogram windows

  nb_spect_params
       file with parameters for "narrowband" spectrograms 
	    (see also wb_spect_params)

  objectname
       default name to appear at "OBJECT name" prompt

  options
       hexidecimal magic number (see "OPTIONS" below)