fastGlitch documentation


fastGlitch is a DMT monitor that simply produces time series plots of filtered data channels.
fastGlitch [-conf file.conf] [-batch | -nobatch] [-save | -nosave] [-boxes | -lines | -noboxes] [-infile "*.gwf"] [-debug n]
fastGlitch is currently in the LIGO MIT CVS repository:
http://ligo.mit.edu/cgi-bin/cvsweb.cgi/fastGlitch/
Alternatively you can use the tarball here:
http://ligo.mit.edu/~sballmer/fastGlitch/tarball/
It requires previous installation of
  1. gds software package (uses EventTool and DMT functionality)
    see http://www.ligo-wa.caltech.edu/gds/
  2. ligotools software package (uses the tcl script tconvert)
    see http://www.ldas-sw.ligo.caltech.edu/ligotools/
  3. ROOT (the ligotools ROOT works)
  4. ImageMagick (the utility convert is used to store plots in different formats)
    only needed for saving in png, gif, jpg
    see ftp://ftp.imagemagick.org/pub/ImageMagick/
You need to set the evironment variables for gds, ligotools and root.
Please refer to the example bash script below. It assumes the following
base insall direcories:

  • gds
/ligo/dmthome/gds
  • LIGOTOOLS 
/ligo/ligotools
  • ROOTSYS
the LIGOTOOLS ROOT version
Example bash script:
# Setup LIGOTOOLS
eval   `/ligo/ligotools/bin/use_ligotools`

# Setup ROOT (the LIGOTOOLS root)
export ROOTSYS=${LIGOTOOLS}/packages/root/active/root/
export LD_LIBRARY_PATH=${ROOTSYS}/lib:${LD_LIBRARY_PATH}
export PATH=${ROOTSYS}/bin:${PATH}

# Setup gds
export GDSBUILD="framecpp,fast"
export DMTHOME=/ligo/dmthome
export DMTVERSION=gds
export DMTINSTALL=${DMTHOME}/${DMTVERSION}
export PATH=${DMTINSTALL}/bin:${DMTINSTALL}/script:${PATH}
export LD_LIBRARY_PATH=./lib:${DMTINSTALL}/lib:${LD_LIBRARY_PATH}
With those variables set you should be able to build fastGlitch. Just type
make
I successfully compiled fastGlitch on RedHat Linux 8 (with gcc 2-95.3 and make 3.79.1)  and
on Solaris 2.8 (with gcc 2-95.3 and make 3.8).
Synopsis:
fastGlitch [-conf file.conf] [-batch | -nobatch] [-save | -nosave] [-infile "*.gwf"] [-debug n]
Options:
-conf file.conf
specify a configuration file (file.conf).
fastGlitch.conf is used if this option is not specified
-batch
-nobatch
enable / disable batch mode batch mode
The batch mode is disabled by default.
-save
-nosave
-save causes fastGlitch to automatically save all plots
The default is -nosave.
-boxes
-lines
-noboxes
To mark triggers draw boxes (height proportional
to trigger power) or horizontal line or nothing.
-infile "*.gwf"
Allows specifying the frame location.
DMTINPUT is used if -infile is omitted.
-debug n
Print debug message for debug level <=n.

The options -batch, -nobatch, -save, -nosave can also be specified in the configuration file.
The command line options are used if they contradict with the confguration file options.
-infile and -debug are options of the base class DatEnv.
Here is an example configuration file:

#######################################################################
# fastGlitch Command line options (use one line per option)
#######################################################################
# DatEnv options are not supported here,
# i.e. -infile, -debug, etc.have to be specified on the command line
# available options: -batch, -nobatch, -save, -nosave, -boxes, -lines, -noboxes
-batch
-save
-lines

#######################################################################
# fastGlitch parameters (one line per parameter, except for Channels)
#######################################################################
# available parameters:
# Time, Stride, OverlayTriggers,
# GraphicsPrefix, GraphicsFormat, Channels
Time            = myfile.xml
# Time            = 727549933 
# Time            = Jan 25 2003 17:12:00 UTC
# Time            = now - 3600
Stride          = 10
TimeOffset      = 3
OverlayTriggers = MyOverlay.xml
GraphicsPrefix  = out/fastGlitch-
GraphicsFormat  = eps
PlayAudioChannel= -1
Channels = 5
L1:LSC-AS_Q      butter('HighPass',4,150.0)
L1:LSC-AS_Q      butter('HighPass',4,30.0)
L1:LSC-AS_I      butter('HighPass',4,30.0)
L1:LSC-AS_DC     nofilter
L1:ASC-QPDX_DC   nofilter

Comments:
Parameters
Remarks
Time = myfile.xml

or Time = 727549933
or Time = Jan 25 2003 17:12:00 UTC
or Time = now - 3600
Specify the time of the trigger to look at.
If an xml file is specified, fastGlitch loops over all triggers in this file.
The time can be specified in different formats.
(tconvert is used to get a time out of this string.)
Stride = 10
Span of the x axis in seconds. 0 is on the left side.
TimeOffset = 5
Position of the trigger in the window (i.e. its x coordinate)
OverlayTriggers = MyOverlay.xml
Allows specifying a 2nd trigger file. Boxes are drawn around each trigger.
GraphicsPrefix  = out/fastGlitch-
Define the graphics prefix for the automatic save option.
GraphicsFormat  = eps,pdf,png,gif,jpg
The plot will be saved in all graphics formats specified here.
Note that an eps file is allways created.
The ImageMagick utility convert is used to convert plots to png, gif and jpg.
epstopdf is used to get pdf files.
If eps is not specified the initial eps file is removed again.
PlayAudioChannel= #
Play channel # on speaker (#=0..N-1); use -1 for playing no channel.
Note:
This feature is not yet fully supported.
By default it is disabled to avoid unforseen compliation problems.
To enable uncomment the line ' // #define _USE_FASTAUDIO_' in fastGlich.hh
Channels = 5
L1:LSC-AS_Q      butter('HighPass',4,150.0)
L1:LSC-AS_Q      butter('HighPass',4,30.0)
L1:LSC-AS_I      butter('HighPass',4,30.0)
L1:LSC-AS_DC     nofilter
L1:ASC-QPDX_DC   nofilter
Specify the number of channels, their names as well as the filters.
The gds FilterDesign class is used to parse the filter string.


Last modified: Feb 25 2003,    Stefan Ballmer, LIGO MIT sballmer@ligo.mit.edu