ref.txt

speech signal process tools

     new xwaves command file, consider using a UNIX shell script with
     send_xwaves , instead.

save_add_ops
     SAVE ALL CURRENT CUSTOM OPERATOR DEFINITIONS

     output
          the name of a file into which the add_op and add_waves definitions
          should be written.

     save_add_ops writes a series of add_op commands to the output file that
     may be executed as an xwaves command file to reconstruct the current
     custom-made operator set. The last line in the file is the xwaves
     return command, so the file can be call ed as part of an initialization
     script. All operators created with add_op, add_espsf, add_espsn,
     add_espst and add_waves are saved.

save_keymaps
     SAVE ALL CURRENT KEY-TO-OPERATOR BINDINGS

     output
          the name of a file into which the key bindings should be written.

     save_key_map writes a series of key_map commands to the output file
     that may be executed as an xwaves command file to reconstruct all of
     the current key-to-operator bindings. The last line in the file is the
     xwaves return command, so the file can be call ed as part of an
     initialization script. Note that the operators referred to by the
     key_map command must actually exist at the time the mapping is per
     formed. Thus, the saved operators should be restored before executing
     the key-map save file.

save_menus
     SAVE THE CURRENT DISPLAY WINDOW MENU CONFIGURATION

     output
          the name of a file into which the menu definitions should be
          written.
     menu
          the display window type of the menu that is to be saved.
          Acceptable values are spect, wave and all. If unspecified, all is
          assumed.

     save_menus writes a series of add_waves  commands to the output file
     that may be executed as an xwaves command file to reconstruct the
     current menu configuration that might have been established by a series
     of add_op, add_waves, delete_item and other commands. Note that the
     first line in the output file is a delete_all_items command that clears
     all menus before building those specified in the balance of the file.
     Thus, if the union of multiple save_menus commands is required, the
     first line in all but the first one executed should be deleted. The
     last line in the file is the xwaves return command, so the file can be
     call ed as part of an initialization script.

save_panels
     SAVE ALL AUXILIARY PANEL SPECIFICATIONS

     output
          the name of a file into which the panel configuration information
          should be written.

     save_panels writes a series of make_panel  commands to the output file
     that may be executed as an xwaves command file to reconstruct all of
     the xwaves auxiliary button panels. The last line in the file is the
     xwaves return command, so the file can be call ed as part of an
     initialization script.

send
     SEND A MESSAGE TO THE FUNCTION(S) ATTACHED TO xwaves

     function
          The name of the attachment to receive the message. This should
          correspond to the name used to start the attachment, either via
          one of the main control panel Attach: buttons, or some other
          means. This MUST be the first keyword.
     registry
          The name that the attachment has registered with the X server for
          communications as. In most cases, this is simply the name of the
          program, but it might have been changed to be unique. When an
          attachment registeres with xwaves it sends its registry name.
     op
          a quoted string which is the actual string that is to be sent to
          the attachment, including the command receiver (the program name
          or a display object name) as the first item. The syntax of these
          send commands is the same as that for xwaves commands:

               object command [keyword value] [keyword value] ...


          For details of the available commands, see the manual sections for
          the individual attachments.

     As an example, suppose only the attachment xlabel were attached and you
     wanted to create a new label file attached to the xwaves display object
     named buddy, with a signal named buddy.sd. The following two commands
     would accomplish the same thing:

          send make name buddy signal buddy.sd \
             file buddy.lab color 125
          send function xlabel op xlabel make name buddy \
             signal buddy.sd  file buddy.lab color 125


     If several attachments were active, the second form could still be used
     meaningfully, but the first form could not. The first form is supported
     to retain compatibility with old waves+ scripts and to provide simple
     syntax for simple cases.

set
     ASSIGN VALUES TO GLOBAL SYMBOLS

     <any global variable name>
          arguments to the set command are always symbols and values to be
          assigned to them. Any of the built-in symbols (e.g. those defined
          in the master profile file in $ESPS_BASE/lib/waves/.wave_pro) may
          be assigned values. Refer to the master profile file or to chapter
          27 for a description of the built-in symbols, their meaning and
          their value type. Several assignments may be made per set command.
          The overall length of the set command and its assignment list
          should be limited to 500 characters.

          A feature new to the set command with version 5.0 is its ability
          to CREATE new symbols. Symbol creation uses exactly the same
          syntax as assignment of values to existing symbols:

               set new_symbol <any value>


          where new_symbol is any name you choose that does not conflict
          with existing symbol names and <any value> is a simple quoted
          string type (i.e. any string, either enclosed in quotes or not).
          Note that xwaves doesn't attach any meaning to the new symbol, but
          does provide access to it via the get command and through symbol
          substitution in add_op commands. New symbols may also be defined
          at will in the xwaves profile file.

          The meaning of many of the global variables is changed as of
          xwaves Version 5.0. This is due to the introduction of data
          display window specific attribute setting (see the set command in
          section 26.4.) Most global attributes that might reasonably be
          varied on a window-by-window basis, can now, in fact, be set
          specific to a display window. The ``global'' counterparts, usually
          with the same or similar name, are now used to establish default
          values for the creation of new display windows. Thus, setting
          these globals will usually result in no change in existing display
          windows.
     all
          any non-null string with no embedded spaces. The all symbol
          provides a means for globally setting variables that may now be
          assigned on a window-by-window basis. If all is assigned a value
          (any value), the symbols that are set with the current set command
          will be changed or set in all display windows (existing and
          future). For example, if the command:

               set middle_op blow up time


          were given as shown, the xwaves global would be set as directed,
          but existing display windows would not have their middle button
          operation changed. Any subsequently created display windows would,
          however, assume the new setting for middle_op. On the other hand,
          if the command were given as:

               set all t middle_op blow up time


          Then all existing and future waveform display windows would have
          the new value for middle_op.

setenv
     SET OR CREATE AN ENVIRONMENT VARIABLE

     variable
          The name of an environment variable to be set of created.
     value
          Value of the variable, which is a quoted string.

     This variable definition will be put into xwaves's UNIX environment so
     that any sub processes will inherit the new setting.

shell
     SEND COMMANDS TO A UNIX SHELL

     <any UNIX command line>
          command to be executed as a Bourne shell command under UNIX.

sleep
     SLEEP WHILE BACKGROUND PROCESS OCCURS

     seconds
          number of seconds xwaves is to sleep (0.2 sec resolution).

     When the results of display-setup operations in a xwaves command file
     are to be used (e.g. for screendumps), it may be necessary to issue at
     least a brief sleep command to allow the window system to actually
     execute the plot. This was necessary in xwaves prior to version 5.0,
     but is now rarely needed. When commands are sent to xwaves from
     send_xwaves , process synchronization is automatically taken care of,
     so no sleeps are necessary, unless it is convenient for some human
     factors reason, such as allowing a D/A operation to complete.

----------------------------------------------------------------------------

26.3  Obsolete global commands

The following four commands, listed with their keywords, are now considered
obsolete. They are still implemented in xwaves version 5.0, but may be
eliminated in future releases. Their function has been subsumed by the
add_op command. If you have scripts, etc. that use these commands, you can
see the mapping between them and add_op by simply issuing a save_add_ops
command after you run your script. xwaves will translate your commands to
add_op commands.

add_espsf
     ADD EXTERNAL ESPS-TO-FILE CALL TO xwaves MENUS

     out_ext
     display
     outputs
     name
     op
     command
     menu

add_espst
     ADD EXTERNAL ESPS -TO-TEXT CALL TO xwaves MENUS

     name
     op
     command
     menu

add_espsn
     ADD EXTERNAL ESPS (NO OUTPUT) CALL TO xwaves MENUS

     name
     op
     command
     menu

auto_plot_limits
     SET AUTOMATIC PLOT LIMITS

     This command just sets the xwaves globals plot_max and plot_min to 0.
     Thus, it provides a convenient means of returning to automatic plot
     scaling. It is considered obsolete, since individual control of plot
     scaling on a per-window basis is now available. It is still supported,
     but will probably be dropped in future releases. It is exactly
     equivalent to

          set all t plot_max 0 plot_min 0


----------------------------------------------------------------------------

26.4  xwaves object commands

The following commands and keyword/arguments may be sent to display objects
(as named in the make command). These are referred to variously as object
commands and object commands. The primary thing to keep in mind is that some
display window must already have been created before these can be sent and
that they are sent to a display object, rather than to the distinguished
object waves, the object name for the xwaves program.

Please note the definitions of quoted string and simple quoted string in
chapter 27. These two argument types are used heavily in the command
descriptions below.

activate
     ENABLE/DISABLE PLOTTING OF SELECTED ELEMENTS

     file
          full name of displayed signal (mandatory).
     op
          operation to be performed (set, clear or add; set is default). set
          means to display only those items specified by numbers or
          identifiers, clear means to remove the items (possibly leaving
          others shown), and add means to display the items (in addition to
          those already shown).
     numbers
          a quoted string list of integers: the element numbers to be
          effected.
     identifiers
          a quoted string list of FEA field names (or channel identifiers in
          the case of SIGnal files). Note: numbers or identifiers are
          mutually exclusive keywords.

     Channels that are activated are the channels returned by the display
     window symbol view_channels (see section 27.3). Note that activate may
     also be used to enable or disable traces overlaid on other display
     windows.

align