READFRAMEDATA

READFRAMEDATA is a high level Matlab command for reading data from
frame formatted files.  It makes use of the lower level FRGETVECT
function that is provided with FrameL library.

READFRAMEDATA requires a specially formatted cache file in order to
locate frame data.  Such a cache file can be generated using the
CREATEFRAMECACHE.pl script, or by converting from other frame cache
file format using CONVERTLALCACHE.pl, CONVERTFFLCACHE.pl, and
CONVERTLDASCACHE.pl.  The prefered solution, however, is to use the
framecache files provided at each QScan installation in the directory
~qonline/q/framecaches/.

It is then simple to read frame data into Matlab by first loading in
the framecache file and then calling READFRAMEDATA with the desired
frame type, channel name, start time, and stop time.  For example,
the following commands load 16 seconds of S5 version 3 h(t) data
from the H1 detector starting at GPS time 870000000.

frameCache = ...
    loadframecache('/archive/home/qonline/q/framecaches/S5.txt');
[data, sampleFrequency, time] = ...
    readframedata(frameCache, 'H1:LSC-STRAIN', 'H1_RDS_C03_L2', ...
                  870000000, 870000016);

For more information, type "help readframedata" or "help
loadframecache", at the Matlab prompt, or "./createframecache.pl" by
itself at your shell prompt.

Shourov K. Chatterji
shourov@ligo.mit.edu
2007-Aug-02

$Id: readframedata_README.html,v 1.3 2007/08/02 12:48:17 shourov Exp $