Index of /~shourov/q/qscan/code/qscan/src

Q Transform Toolbox
Version 3.0 2007-Jan-21

This toolbox contains the following functions for searching for transient
events in gravitational-wave data.

The following top level matlab functions and shell scripts are provided

QPIPELINE         Continuously search for bursts in time series data
QSCAN             Study multiple channels during an interesting event
QEVENT            Apply network consistency tests to an interesting event
QTUNE             Benchmark performance for a variety of simulated signals

The following top level matlab function is also provided for reference

QEXAMPLE          Example application of q transform related functions

The following functions comprise the code base for the Q transform.

QTILE             Find time, frequency, and Q tiling for the Q transform
QRESAMPLE         Resample time series data at a common sample frequency
QCONDITION        High pass filter and whiten time series data
QSCANCONDITION    Modified conditioning function for use by qscan
QTRANSFORM        Project data onto bases of constant Q windowed sinusoids
QCOLLOCATE        Coherent Q transform and null sum for collocated detectors
QTHRESHOLD        Identify statistically significant Q transform tiles
QSELECT           Identify statistically significant non-overlapping tiles
QCOINCIDE         Compare triggers for coincidence or vetoing
QWRITETRIGGERS    Output Q pipeline trigger properties to a file
QPARAMETERIZE     Estimate the signal parameters of an interesting event

The following functions are provided for visulation of Q transform results

QTIMESERIES       Display time series data for Q transform analysis
QSPECTROGRAM      Display time-frequency Q transform spectrograms
QEVENTGRAM        Display statistically significant time-frequency events
QSKYMAP           Display likelihood and consistency maps of the sky

The following functions are provided for simulating data

QSIMULATENOISE    Produce simulated gravitational wave detector noise
QSIMULATEBURST    Inject simulated gravitational wave bursts into data

The following functions are provided for reading frame data

QREADDATA         Read multiple channels of data from frame files
READFRAMEDATA     Extract a single channel of data from frame files
LOADFRAMECACHE    Load cache of frame file location information
FRGETVECT         Extract a single channel from a single frame file

The following Perl scripts are provided for use with READFRAMEDATA.

CREATEFRAMECACHE  Create frame cache file for a specified directory
CONVERTLALCACHE   Convert LAL formated frame cache to READFRAMEDATA format

The following shell scripts have been provided for support.

QSETUP            Sets up the necessary environment for Q transform tools
BUILD             Compile top level functions into stand alone executables
QCONTEXT          Query detector status and data quality for use by qscan
QUPDATE           Update existing qscan reports with new context information
QCONFIGURE        Automatically generate qscan configuration file

The following resource files are provided.

QSTYLE            Cascading style sheet for html based qscan reports

The following functions are provided for one-sided frequency domain data.

QFFT              One-sided Fourier transform of time domain data
QIFFT             Inverse Fourier transform one-sided frequency domain data

The following signal processing function is provided to support conditioning.

SOSFILTFILT       Zero phase filtering with second-order sections

Modified versions of the following Matlab toolbox functions are also
provided.  They have been modified to permit compilation.

SOSFILT           Apply IIR filter specified by second-order sections
SOSFILTMEX        Apply IIR filter specified by second-order sections
ZP2SOS            Convert zero-pole-gain model to second-order sections

The private subdirectory contains modified copies of numerous figure
plotting functions.  They have also been modified to permit compilation.

Shourov K. Chatterji
shourov@ligo.caltech.edu

Leo C. Stein
lstein@ligo.mit.edu

$Id: README.html,v 1.2 2007/01/22 01:26:42 shourov Exp $