xwaves.help

speech signal process tools

            operations such as scrolling through the signal
            will be faster than they would be otherwise,
            since xwaves+ will not have to reread data
            repeatedly from a disk file.  Smaller values of
            the limit may be necessary to prevent xwaves+
            from failing by running out of memory.

       middle_op
            text string corresponding to desired middle but-
            ton operation for waveform menus.  must be one
            of:
                               play between marks
                               up/down move
                               blow up time
                               blow up; function
                               repeat previous
              Note: left_op or middle_op must be the last
              keywords on a command line (only a newline
              should follow their arguments).

       min_spec_height
            minimum height in pixels of spectrogram windows;
            if there are more spectral values per record
            than min_spec_height, the initial window size is
            set at one pixel per spectral value up to a
            pre-defined maximum.

       min_spec_width
            minimum width in pixels of spectrogram windows;
            regardless of window width, spectrograms are
            painted as one record per pixel column.

       nb_spect_params
            file with parameters for "narrowband" spectro-
            grams (see also wb_spect_params).  The default
            search path used is
            ".:$ESPS_BASE/lib/waves/files"; this can be
            overriden by setting the unix environment vari-
            able WAVES_INPUT_PATH before starting xwaves+.

       objectname
            default name to appear at "OBJECT name" prompt

       options
            hexadecimal magic number; this is an expedient
            for setting various one-bit flags in xwaves+ to
            control debug printouts, data editing and
            display features.  The various functions are
            enabled by the following bits in (hexadecimal)
            options argument:


              0x01 Sets up a special (KLUGE) mode to permit
                   B&W plots suitable for screendump and
                   xeroxing [clear].

              0x04 When editing data (overlaid on spectro-
                   grams, or on time-series plots) the view
                   is always redrawn upon release of the
                   left button following an edit operation.
                   Otherwise the display is only redrawn by
                   explicitly selecting the "redisplay" item
                   in the view's frame menu [set].

              0x08 Disables the saving of spectrogram frag-
                   ments during editing operations [set]

                       release of the
              0x10 Enables immediate writeout of edited data upon
                   left button when editing has been per-
                   formed, provided that the file size is
                   the same as the buffer size [set].
                   (warning: if you clear this, or if you
                   operate on large files, there's a bug
                   that can prevent writing out of edited
                   data even on exit if the input file name
                   has an ".ed" in it).

              0x40 Enables various unpleasant debug prin-
                   touts [clear].

       output_dir
            The name of a writable directory to used for all
            xwaves+ output files.  If output_dir is not
            defined, output files are written in the same
            directory as whatever file they were derived
            from (or in the current working directory if
            there is no source file).  Do not define this
            global unless you want it used, and make sure
            that the named directory exists and is writable.
            If output_dir is defined, all output files from
            xwaves+, xspectrum, and xlabel will go into this
            directory (including edited files, saved file
            segments, spectrogram output files, outputs from
            add_espsf, etc.).  It is OK to include environ-
            ment variables in the path.  In the case of
            external function calls (spectrogram calls via
            sgram_prog, D/A calls via play_prog, as well as
            calls produced by add_espsf, etc.), output_dir
            can be overriden by the value of remote_path or
            remote_output_path.  To "unset" output_dir (so
            that none is used,

              set output_dir ""

       outputname
            default pathname to appear at "OUTPUTfile"
            prompt

       overlayname
            pathname to file which can be overlaid on a
            spectrogram (Note that simply "set"ting this
            name or the three preceding ones does NOT impli-
            citly execute any associated functions; e.g.,
            setting a default inputname does not cause
            xwaves+ to read in the file).

       play_prog
            The name of the D/A play program to use when the
            DSP board is not present or disabled (use_dsp32
            == 0).  The default is "play".  Play_prog can
            have blanks in it, so it can include the specif-
            ication of standard options.  See the discussion
            in "RUNNING ESPS PROGRAMS FROM xwaves+". (see
            also sgram_prog)

       plot_max

       plot_min
            The globals plot_max and plot_min provide a lim-
            ited means of overriding the automatic vertical
            scaling of plot data.  If they are zero (the
            default), for each trace xwaves+ finds the max
            and min in the entire buffer, and scales the
            plot so that the max and min appear at the top
            and bottom of the window (or window region, if
            there are multiple traces).  If plot_max
            (plot_min) is non-zero, xwaves+ will scale every
            new or refreshed plot so that the top (bottom)
            of the window or region corresponds to the fixed
            value.  Values outside of the range are simply
            clipped by the top of the bottom of the display
            window (extending into the scrollbar).  (That
            is, the plots for multiple traces are not lim-
            ited to a region of the window as they are in
            the case of auto-scaling.  Yes, it can get very
            ugly!  Use with care!  Note that the command
            auto_plot_limits provides a convenient means for
            resetting both values to zero.  Note that a 
            different approach to plot scaling is to attach
            the ESPS program \fIclip\fP to the menu via add_espsf, 
            which makes it easy to re-display a segment at full 
            amplitude.  

       readout_bar_height
            height in pixels of the readout bar, which con-
            tains (under X Windows) various digital
            readouts.  The bar is located below the title
            bar and above the scrollbar.  Under Sunview, the
            readout bar is not used, since the readouts are
            inserted into the title bar.

       ref_size
            initial size of the display buffer (seconds)

       ref_start
            default starting time for file display (sec)

       ref_step
            page step size for "page ahead/back" (seconds)

       remote_path
            If this string is defined (and not overriden by
            either remote_input_path or remote_output_path
            as described below), it is prefixed to the
            basename of all input and output file names in
            external calls (play operations, spectrogram
            operations, operations from add_espsX).  This is
            useful for operation in an NFS directory with
            rsh.  If remote_path is defined, it overrides
            output_dir in the case of external calls. See
            the discussion in "RUNNING ESPS PROGRAMS FROM
            xwaves+".

       remote_input_path
            If if remote_input_path is defined, it is pre-
            fixed to the basename of all input file names in
            external calls.  It overrides any definition of
            remote_path.

       remote_output_path
            If remote_output_path is defined, it is prefixed
            to the basename of all output file names in
            external calls.  It overrides definitions of
            remote_path and output_dir

       reticle_grid
            determines whether (1) or not (0) the reticle is
            displayed on spectrogram displays.

       socket_port
            This is the INET domain socket port number to be
            used when xwaves+ is operating as a display
            server (as the result of the -s option or the
            enable_server command).  If set, socket_port
            overrides the WAVES_PORT environment variable or
            the value given by the -p option.

       scrollbar_height
            height of the scrollbar in new windows (pixels)

       scroll_ganged
            1 to scroll all signals in object, 0 for just
            one (see also zoom_ganged)

       sgram_prog
            The name of the spectrogram program to use when
            the DSP board is not present or disabled.  The
            default is "sgram".  Sgram_prog can have blanks
            in it, so it can include the specification of
            standard options.  The default is nil.  See the
            discussion in "RUNNING ESPS PROGRAMS FROM
            xwaves+". (see also play_prog)

       show_labels
            1 to display FEA field names at the left of the
            corresponding parameter track in waveform win-
            dows, 0 to inhibit the display of names.

       show_vals
            1 to display numerical values at the left of
            every parameter track in waveform windows, 0 to
            inhibit the display of values.  The values
            displayed are the parameter values at the cur-
            sor, and they change dynamically as the cursor
            is moved.  If there are a large number of FEA
            fields being displayed, the constant update of
            the parameter values can be time consuming.

       spec_middle_op
            middle_op text string corresponding to desired
            middle button operation for spectrogram menus.
            must be one of:
                               up/down move
                               move contour
                               modify intensity
                               play between marks
                               repeat previous
              Note: spec_left_op or spec_middle_op must be
              the last keywords on a command line (only a
              newline should follow their arguments).

       spec_left_op
            text corresponding to desired left button opera-
            tion for spectrogram menus; must be one of:
                               up/down move
                               move closest
                               mark formants
                               repeat previous

       spect_interp
            1 to cause linear interpolation in rescaled
            spectrogram displays; 0 to disable interpolation
            so that each discreet value is shown as a uni-
            form rectangle; if data are interpolated then
            the range of the interpolated data computed
            together is determined by spect_rescale_scope.

       h_spect_rescale
            1 to cause horizontal rescaling of spectrogram
            displays; 0 to cause fixed displays with 1-pixel
            per data record.

       v_spect_rescale
            1 to cause vertical rescaling of spectrogram
            displays; 0 to cause fixed displays with 1-pixel
            per data record.

       spect_rescale_scope
            determines whether horizontal rescaling of
            interpolated data is computed for the entire
            xwaves+ buffer (value is "buffer") or for just
            the current window width (value is "view").
            Rescaling for the entire buffer can be quite
            slow if the ratio of the current view to the
            entire buffer is large, but has the advantage
            that horizontal scrolling is very fast once the
            new image is computed (since it is stored).
            Rescaling just the current view is faster (and
            is the default), but has the disadvantage that
            the rescaling tapes place every time the
            viewpoint is moved (i.e., scrolling is slower).
            In later releases, this global will also affect
            the rescaling of non-interpolated data.

       temp_path
            determines the directory in which xwaves+ will
            write temporary files (e.g., files generated by
            external ESPS calls that result from xwaves+
            commands add_espsf or add_espst).  The default
            for temp_path is "." (i.e., current working
            directory).

       use_dsp32
            1 to use dsp board, 0 to ignore dsp board; this
            is normally set by xwaves+ on startup depending
            on whether or not the board is detected.

       verbose
            Values > 0 cause various feedback messages to be
            printed.  When verbose > 0, xwaves+ prints a
            startup message indicating the identity of the
            .wave_pro file that was read, and it prints
            copies of the shell command lines used to invoke
            external ESPS functions as well as all shell
            commands that result from calling the xwaves+
            command "shell".  When the shell commands have
            completed, a completion message is printed.
            Unrecognized xwaves+ commands are reported as
            such (for verbose > 0).  When verbose > 1,
            xwaves+ prints detailed feedback about command
            parsing.  The default value of verbose is 1.

       wave_height
            height of new waveform windows

       wave_width
            width of new waveform windows

       wb_spect_params
            file with parameters for "wideband" spectrograms