relish Manual
Jump to:
NAME
relish - Responses Evaluated by Listing Information in
Seed Headers.
SYNOPSIS
relish.itk
DESCRIPTION
relish
(v3.2) sets up a simple graphical user interface (or GUI)
to the evalresp (v3.2.2)
program. This interface allows the user to interactively enter the
command line inputs to the evalresp program and, at the
same time, allows the resulting response curves to be plotted using
a pair of Blt graph widgets. The user can plot the amplitude response,
phase response, or both, and the resulting graphs can be saved to
Postscript files. In addition, the relish GUI provides a simple mechanism
that traps the output from evalresp in a "relish log"
window whose contents can be cleared, printed (utilizing the UNIX
enscript utility) or saved to the file "relish.logfile".
USAGE
When the user types "relish.itk" in a standard X-window, two
Incr-Tk mega-widgets appear on the screen. The first is the relish
widget - a dialog widget that allows the user to enter the command
line information for running evalresp (Station,
Channel, Year, Julian Day, etc.). The second is the relish-log widget
- a scrolled listbox that is used to capture the output from evalresp
as a log, which can then be cleared, printed, or saved. The relish
widget is itself divided into four sub-panels:
The "Required EVALRESP Inputs" section of the relish widget contains
all of the inputs that the user is required to enter in order to
run evalresp. The required inputs to evalresp
consist of the following arguments:
- the "Station" for which to calculate a response. As with evalresp,
"glob-style" expressions can be used to represent the station
code (eg. "A*" for all stations that begin with "A"), but quotes
are not needed in these strings, since they are added by relish
before the call to evalresp is made. Actually, this
field is not strictly required by relish (although
it is a required input to evalresp). If this field
is not filled by the user, a default value of "*" is passed to
evalresp as the value of the station specifier. This
pattern will match any station.
- the "Channel" for which to calculate a response. As with the
"Station", "glob-style" expressions can be used to represent the
channel (e.g. "BH?" for all of the broad band, high gain channels
at a given station). As with the "Station" (above), quotes are
not needed in such expressions, since they are added by relish
before the call to evalresp is made. Also, this field
is not strictly required by relish (although it is
a required input to evalresp). As with the "Station",
if no value is assigned to this field by the user, it will be
filled with a "*" before the call to evalresp is
made.
- the "Year" for the response (selects which effective time to
use in calculating the response)
- the "Julian Day" for the response (selects which effective
time to use in calculating the response)
- the "Minimum Frequency" for the response
-
- the "Maximum Frequency" for the response
- the "Number of Frequencies" for the response
The next section contains the "Optional EVALRESP inputs", many of
which have default values. They are:
- the "Network" for which responses are to be calculated. As
with the "Station List" and "Channel List", a glob-style patterns
are allowed. The user should be aware, however, that the "Network"
values provided by rdseed
(v4.1) are restricted to two letters or less. If this field is
not specified, responses will be calculated for all matching station-channel
pairs, regardless of their network affiliation.
- the "Time" for which responses are to be calculated. This field
can be used to restrict the "effective time" for which the response
should be calculated in the case that there has been more than
one response determined for a given station-channel-network on
the same day. It should have the form "HR:MM:SS.#####", although
the number of decimal points in the seconds specification can
be less.
- the "Filename" which should be searched for matching responses
(see discussion in the evalresp
man page on how this argument is used to determine which responses
files should be used to search for matching responses).
- the "Start Stage" and "Stop Stage" for response evaluation.
If these fields are filled in by the user, then they will be used
to construct a response for a range of stages from the RESP file.
The "Start Stage" can be specified without the "Stop Stage", in
which case a single stage from the RESP file will be used to calculate
the response. See the "-stage" option in the evalresp
man page for a further discussion of this feature.
- three popup menus that can be used to set the "Units", "Frequency
Spacing" and "Response Type", respectively. Appropriate default
values are set for these three inputs to evalresp.
Clicking on a popup-menu with the left button will cause the menu
to be displayed, clicking on a popup-menu with the right button
will cause the next item in the menu to be selected (this is the
default binding for all of the menus used in the relish
GUI). See the evalresp man
pages for a description of the options available for each
of these inputs. The strings that are contained in the menus will
be translated into appropriate evalresp inputs (eg.
"Amplitude/Phase" for the response type will cause "-type ap"
to be added to the command line of the call to evalresp).
- a pushbutton that can be used to toggle the "verbose" output
of evalresp on and off. Pushing the button will cause
the "verbose" flag to be included in the command line of the call
to evalresp (i.e. the "-v" flag will be set). This
output (as well as any error output) will appear in the relish
log widget, where the user can scroll through it, save the output
to a file, or even print the output.
The third section contains the "Plot Controls" for the plots that
can be made of amplitude response, phase response, or both. At the
present time, this section contains a popup-menu that can be used
to decide the type of plot that should be made (Amplitude/Phase, Amplitude
Only, or Phase Only). These controls may be expanded in the future
to allow the user to specify axis limits, colors, etc. for the plots.
The relish GUI is completed by the specification
of four pushbuttons that represent "actions" that can be taken by
the user:
- The user can use the parameters that have been specified by
the inputs in the GUI and "Run Evalresp". This will cause evalresp
to begin executing, with its output being redirected to the "Relish
Log" window. The output response files will be created in the
directory that the GUI was started in (assuming that the user
can create files there).
- The user can choose to "Plot" reponses. This will bring up
a window containing the response curves that the user requested
(based on the input from the main relish window).
Once the plots are generated, there are three options available
if both amplitude and phase plots have been requested by the user.
The user can print the phase, print the amplitude, or quit. If
either of the first two options are chosen, then files with names
like "tmp*.ps" are created in the directory where the relish
GUI was started (here the "*" represents a time stamp that is
constructed from the current system time). If the user chooses
to "Quit", then control is returned to the main relish
window.
- The user can choose to "Quit". If this option is chosen, then
the relish session ends.
- The user can request "Help". At the present time, this feature
is not implemented, although it is hoped that such on line help
will be available in future releases of the relish
GUI.
SYSTEM REQUIREMENTS
To run this package properly, two easily accessible extensions
are needed (in addition to compiled versions of rdseed
(v4.1 or later) and evalresp v3.2.2). First, the Incr-Tcl/Tk
package must be installed on the system that is running the relish
(v3.1) program. The Incr-Widgets package that is included with the
relish
distribution is utilized to construct the relish
mega-widget. This package recently underwent a major revision, so
we have utilized the "latest" versions of the Incr-Tcl/Tk package
(v2.0). Second, the Blt (v2.0) extension to the Incr-Tcl/Tk (v2.0)
package must be installed. This extension provides the graph widget
that is used by the relish GUI to plot the response
curves. Both of these extensions are available via anonymous ftp
on the internet. Care must be exercised to make sure the version
numbers of these extensions are current since the latest revisions
that have been made to the Incr-Tcl/Tk package and to the Blt extension
are incompatible with previous releases. In addition, there is a
certain amount of work involved in integrating the Blt package with
the Incr-Tcl/Tk package - Blt must get its own namespace, so the
Tcl_AppInit routine that is distributed with the Blt package must
be modified slightly. To try to make this procedure as simple as
possible for users, a current version of these packages are available
for anonymous
ftp at the IRIS DMC (dmc.iris.washington.edu) in the "pub/pickup"
subdirectory (the file is called "itcl2.0.tar.gz"). Installation
instructions are included with these packages.
SEE ALSO
rdseed (v4.12), evalresp(v3.2.2),
itk (v2.0), BLT (v2.0)
[Return to top]
version 1997/09/22
|