# Earthworm Module:
Sgram Setup and Commands

(last revised 18 October, 1999)

### How To Set It Up

The first task is to set up a directory as a holding tank for the GIF image and .html files to reside while they are waiting to be dispatched to the webserver(s). I have found it useful to set up a directory and sub-directory of form .../gifs/sgram/. This provides the opportunity for other subdirectories of /gifs/ for other image creating modules. If you are going to display a logo on your helicorder gifs, put a copy of the logo.gif in this directory. If you are using a Perl Script on the webserver(s) to generate your html display, you need do nothing further. If you are relying on sgram to create and ship your .html wrapper and you want to customize it for your site, you may need to add files indexa.html and indexb.html as custom prolog and epilog for the index.html which is shipped.

Examples of a Perl Script, indexa.html and indexb.html are included.

### Setting Up Earthworm to Run Sgram.

1. Make sure that your earthworm.d file contains a module id for sgram. It should be MOD_SGRAM.
2. Insert an entry for sgram in your startstop_sol.d file.
3. Now comes the fun part; setting up the configuration files.

       ************************************************************************
       #
       # This is the spectrogram parameter file. This module gets data gulps
       # from the waveserver(s), and computes spectrograms

       #  Basic Earthworm setup:
       #
       LogSwitch    1              # 0 to completely turn off disk log file
       MyModuleId   MOD_SGRAM      # module id for this instance of report
       RingName     HYPO_RING      # ring to get input from
       HeartBeatInt 15             # seconds between heartbeats

       >>>>
       >>>> The first four config variables are standard earthworm.
       >>>>
       >>>> We need to talk to the transport ring so that StartStop
       >>>> can terminate this process.
       >>>>

       wsTimeout 12 # time limit (secs) for any one interaction with a wave server.

       >>>>
       >>>> We need to know a reasonable time limit for getting
       >>>> a response from any wave server.
       >>>>

       # List of wave servers (ip port comment) to contact to retrieve trace data.
        WaveServer aaa.bbb.ccc.ddd  17121      "wsv2 - ad1"
        WaveServer eee.fff.ggg.hhh  18004      "wsv2 - ad2"

       >>>>
       >>>> This is the list of waveservers to try.  If the requested
       >>>> data for a given SCN is on more than one waveserver, the
       >>>> first listed will be preferentially used.  If a request
       >>>> fails (gap in the data, broken connection) the alternate
       >>>> server(s) will be tried.  The comment field is optional;
       >>>> it makes error messages a bit more helpful.  The maximum
       >>>> number of waveservers is specified by MAX_WAVESERVERS in
       >>>> sgram.h.
       >>>>

       # List of target computers/directories to place output.
       #       UserName  IP Address            Directory
       Target myname@webservera:/home/www/waveforms/sgram/
       Target myname@webserverb:/home/www/waveforms/sgram/

       >>>>
       >>>> Here we specify the complete location of our web pages.
       >>>> When setting up a directory structure on your webserver,
       >>>> I would recommend a directory dedicated to GIF displays.
       >>>> with a sub-directory dedicated to spectrogram displays.
       >>>> The usual stuff about making sure that all your .hosts
       >>>> and .rhosts tables are in order applies.  The maximum
       >>>> number of targets is specified by MAX_TARGETS in sgram.h.
       >>>>

       # Filename prefix on target computer.  This is useful for identifying
       # files for automated deletion via crontab.
       Prefix nc

       >>>>
       >>>> For each SCN/date, a (sometimes large) GIF file and an (optional) .html
       >>>> wrapper are created.  Unless there is some mechanism in place
       >>>> to blow away out-of-date files, the webserver will eventually
       >>>> drown in old files.  To fix this problem, these two types of
       >>>> file are assigned a prefix to readily identify them as volatile
       >>>> and a crontab process is used to blow them away. e.g.
       >>>> 15 1 * * 0-6 find /home/ehzweb/waveforms/sgram -name nc\* -mtime +7 -exec rm {} \;
       >>>> will remove files starting with nc which are older than 7 days.
       >>>>

       # Directory in which to store the temporary .gif, .link and .html files.
       GifDir   /home/www/gifs/sgram/

       >>>>
       >>>> This is the directory on your local machine which is used to
       >>>> store the working versions of the GIF and .html files.
       >>>> For each SCN, there may also be a SCN.hist file which keeps
       >>>> track of which dates are available for display.
       >>>> This is used to construct the optional index.html file.
       >>>> If SaveDrifts (see below under optional commands) is set,
       >>>> a file SCN.drft is created for each SCN.  Each time a new
       >>>> spectrogram hour is started, the min and max spectral
       >>>> values for the previous hour of data are recorded.
       >>>>

       # Plot Parameters - sorry it's so complex, but that's the price of versatility
               # The following is designed such that each SCN creates it's own
               # spectrogram display; one per HoursPerPlot hours of data.
       # S                  Site
       # C                  Component
       # N                  Network

       >>>>
       >>>> These are the SCN identifiers as they appear in the
       >>>> waveserver menu.
       >>>>

       # 04 HoursPerPlot    Total number of hours per gif image

       >>>>
       >>>> I have been using 24 hours per image for overviews and
       >>>> 2 hours per image for detailed spectrograms.
       >>>>

       # 05 Plot Previous   On startup, retrieve and plot n previous hours from tank.

       >>>>
       >>>> This lets you fill in those little gaps left by system crashes,
       >>>> power outages, silly mistakes, etc.  I usually leave this
       >>>> set to 1 so that gaps get filled automatically if something
       >>>> bad happens and statmgr has to restart sgram.  This will only
       >>>> let you fill in past data from the current plot (i.e. <=HoursPerPlot).
       >>>> If you need past plots use sgram2, the offline
       >>>> spectrogram gif generator.  [when&if I finish it]
       >>>>

       # 06 Local Time Diff UTC - Local.  e.g. -7 -> PDT; -8 -> PST
       # 07 Local Time Zone Three character time zone name.
       # 08 Show UTC        UTC will be shown on one of the time axes.
       # 09 Use Local       The pages will start relative to local time rather than UTC time.

       >>>>
       >>>> These variables govern how the time axes are displayed on
       >>>> your plot and whether the plot starts at 00:00 UTC or local.
       >>>>

       # 10 XSize           Overall x-size of plot in inches

       >>>>
       >>>> This lets you tailor the width of your display.
       >>>> Setting this > 100 will imply pixels
       >>>>

       # 11 Pixels/Line     Vertical pixels per line of trace displayed

       >>>>
       >>>> I use 1 for the 24 hour displays and 4 or 5 for the 2 hour displays
       >>>>

       # 12 Minutes/Line    Number of minutes per line of trace displayed

       >>>>
       >>>> I use 1 minute/line
       >>>>
       >>>> The product of Minute/Line, Pixels/Line, and HoursPerPlot determines
       >>>> the overall y-size of the plot in pixels.
       >>>>

       # 13 Seconds/Gulp    Number of seconds per fft

       >>>>
       >>>> I use 60 second ffts
       >>>>

       # 14 Freq Max        Maximum frequency

       # 15 Freq Mute       Hz to mute at low end

       >>>>
       >>>> Some stations produce a lot of very low frequency energy which
       >>>> is not of interest.  This variable applies a mute at the low end.
       >>>>

       # 16 nbw             Display scaling. 1:linear, 2:log [neg for greyscale]

       # 17 amax            Clipping amplitude applied to spectrum [0 for none]

       >>>>
       >>>> The spectral amplitude is expressed as spectral colors ranging from
       >>>> blue (low values) to red (high values).  If amax is 0, each time a
       >>>> spectrum is calculated (a single horizontal line on the plot), its
       >>>> maximum value is determined and assigned to the highest (red) color.
       >>>> Each line will have a different relationship between spectral amplitude
       >>>> and color, although the maximum will always be red and the minimum
       >>>> will always be blue.  To make a spectrogram for which the colors
       >>>> are meaningful and consistent we need to establish a constant relationship
       >>>> between spectral amplitude and the color spectrum.  To do this, we assign
       >>>> a spectral amplitude of 0 to blue and assert a spectral amplitude value
       >>>> (amax) to be assigned to red.  Any higher values will be plotted as red.
       >>>> The assignment of amax is largely a matter of taste, but you can get
       >>>> a start by setting the option SaveDrifts to log the values being calculated.
       >>>> As a rule of thumb, low values of amax will make spectrograms sensitive
       >>>> to the background noise levels; high values will be senstive to larger events.
       >>>>

       # 18 scale           A scaling factor for the wiggle-line trace.

       >>>>
       >>>> A data trace is plotted along the right-hand time axis for comparison
       >>>> with the spectrogram.  The scaling factor for the amplitude of this
       >>>> trace is arbitrarily assigned.  Make a plot and use the above scaling factor
       >>>> to adjust the amplitude to taste.
       >>>>

       # Comment            A comment for the top of the display.
       #
       #     S    C   N  04 05 06  07  08 09 10   11  12 13 14 15    16  17       18   Comment
       #

        Plot MCM  VHZ NC 24 2  -7  PDT 1  0  600  1   1  60 10 0.2   2   40000    1.0 "Convict Moraine"
        Plot MCS  VHZ NC 24 2  -7  PDT 1  0  350  1   1  60 10 0.0   1   30000    1.0 "Casa Diablo Hot Springs"
        Plot MDP  VHZ NC 24 2  -7  PDT 1  0  350  1   1  60 10 0.0   2   30000    1.0 "Devil's Postpile"
        Plot MDP  DLI NC 24 2  -7  PDT 1  0  350  1   1  60 10 0.0   2   30000    1.0 "Devil's Postpile"

           # *** Optional Commands ***

        Days2Save     7    # Number of days to display on web page; default=7

       >>>>
       >>>> This variable governs how many dates are retained in the SCN.hist
       >>>> file in your local gifs directory.
       >>>>

        UpdateInt    10    # Number of minutes between updates; default=2

       >>>>
       >>>> Each UpdateInt minutes, sgram wakes up and updates all its files.
       >>>>

        RetryCount    2    # Number of attempts to get a trace from server; default=2

       >>>>
       >>>> If you can't get it in two trys, there is probably something
       >>>> seriously wrong.  Nonetheless, there may be reasons to try some more.
       >>>>

        Logo    smusgs.gif # Name of logo in GifDir to be plotted on each image

       >>>>
       >>>> If a Logo is specified, the appropriate gif file should be
       >>>> placed in the /GIFs/sgram/ directory so the program can
       >>>> find it.  If specified the Logo will be appear in the upper
       >>>> left corner of each SCN/date spectrogram plot.
       >>>>

       # We accept a command "SaveDrifts" which logs drifts to GIF directory.
         SaveDrifts

       >>>>
       >>>> If SaveDrifts is set, a file SCN.drft is created for each SCN.
       >>>> Each time a new spectrogram line is started, the mean, rms,
       >>>> min and max values for the first minute of data are recorded.
       >>>>

       # We accept a command "Make_HTML" to construct and ship index.html file.
         Make_HTML

       >>>>
       >>>> If Make_HTML is set, an index.html file is created.  This file is
       >>>> shipped to the target webserver(s) via rcp.
       >>>>

       # We accept a command "BuildOnRestart" to totally rebuild images on restart.
         BuildOnRestart

       >>>>
       >>>> During the process of tuning the displays this option is useful.
       >>>> For production, this should be disabled.
       >>>>

       # We accept a command "Debug" which turns on a bunch of log messages
       # Debug
       # WSDebug
       ****************************************************************************************

   ### Customizing the .html wrapper.

   The .html wrapper for the primary web page (index.html) has provision for customization to reflect the identity and flavor of an individual earthworm site. If you do nothing, a generic wrapper is constructed. You may, however, control the top part of the index page and the bottom of the index page by placing the .html code you want in files named indexa.html and indexb.html respectively in the GIFs/sgram/ directory. The module will attempt to open and read indexa.html for the top of the page; if it can't find the file, it generates a generic beginning for the index.html file. It then pastes in links to the spectrogram GIF images. Finally, it looks for indexb.html to finish off the page. If there is no indexb.html, it provides a generic ending.

   ### Known Bug!

   The library functions which handle the process of reading an existing .gif file, modifying it, and writing it back out are not good at detecting damaged files. Sometimes, if sgram stops or is halted in mid-stream, we are left with a damaged .gif file. Upon restart, the process will crash and burn without error messages when an attempt to read this file is made. There are two solutions; 1) use the BuildOnRestart option above to force overwriting of the file or 2) go to the gif directory and delete the offending spectrogram .gif file.
   Module Index | Sgram Overview