From penn@physics.syr.edu Mon Feb 11 09:33:20 2002
Date: Fri, 01 Feb 2002 12:38:13 -0500
From: Steve Penn <penn@physics.syr.edu>
To: Keith Riles <keithr@tenaya.physics.lsa.umich.edu>,
     Albert Lazzarini <lazz@ligo.caltech.edu>
Subject: Documentation for XBic

Keith & Albert,

The x-bicoherence monitor can be found in my home directory on SAND,
DELRONDE, & DECATUR.  Please request other machines on which you would like
the code.

The directions for using the present version is listed below.  I am working
on a new version which fixes a few bugs including:
 - the --help option does not work on some Unix boxes
 - the optimized windowing option is SLOW  (it is default off for now)
 
The new version also includes a few new features including:
 - user settable freq limits, resolution, and averaging.
 - I need to make the optimized windowing much faster.


To run XBic you must have set the DMT setup variables (ie. DMTINPUT, etc).
Look in my .tcshrc file if you need help.

To run XBic cd to my directory and enter:

> ./XBic <1-3 channels> <options>

For example:
------------
      
> ./XBic H0:PEM-LVEA_SEISX <options>

calculates the Bicoherence of channel,  H0:PEM-LVEA_SEISX. And,

> ./XBic H0:PEM-LVEA_SEISX H0:PEM-LVEA_SEISY H0:PEM-LVEA_SEISZ <options>

 calculates the cross-bicoherence of the three channels listed.  If the
 channels are of different rates, they are decimated down to the
 slowest rate.




Below is my text help document.  The various option are listed there.



=======================  TEXT HELP FILE =================================



    XBic -- X-Bicoherence Monitor -- Steve Penn

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

  XBic -- a standalone program to display the cross-bicoherence for 1-3 LIGO
         data channels. This program uses both the ROOT and DMT libraries.

  USAGE:
  ------
      XBic <1-3 channels> <options>

      For example:
      ------------
      XBic H0:PEM-LVEA_SEISX <options>

      calculates the Bicoherence of channel,  H0:PEM-LVEA_SEISX. And,

      XBic H0:PEM-LVEA_SEISX H0:PEM-LVEA_SEISY H0:PEM-LVEA_SEISZ <options>

       calculates the cross-bicohere of the three channels listed.  If the
      channels are of different rates, they are decimated down to the
      slowest rate.

  COMMAND LINE OPTIONS:
  ---------------------
    -direct ==> direct Bispectrum method (indirect = default)
    -indirect ==> indirect Bispectrum method (indirect = default)
            direct = 2D FFT of the bicumulant
            indirect = product of 1D FFT's
    -log ==> plot using log scale (default)
    -lin ==> plot using linear scale
    -dbg ==> flag to have program issue debugging messages
    -bispec ==> calculate bispectrum
    -noplot ==> flag to disable plotting
    -eps ==> write an eps file of the plot
    -xml ==> enables the xml options
    -MaxFrame # ==> # of frames to process before quitting
    -dec ==> decimate frequency of the slowest channel, ie. frequency
binning
    -wdw ==> use 2D Rao-Gabr optimal windowing to form Bispectrum
        
    --help ==>  print help screen and quit

 
  REQUEST:
  --------
      This code is still beta.  PLEASE send any suggestions, comments,
          questions, or bug notices to me at penn@phy.syr.edu