LIGOtools Package: FrContrib

This package contains software tools based on the Virgo frame library but not included in the core distribution of the library. It includes:

The FrameDataDump utility, which reads a channel from one or more files and outputs the raw time series to a binary file, or as ASCII to the screen or to a file.
The FrChannels and FrGeomDump utilities, which display the channels and detector geometry information (respectively) contained in a frame file.
The FrDiff utility, which compares the contents of two frame files.
The FrTrend utility, which generates trend frames from raw frame files.
The Matlab MEX-file mkframe, which writes a Matlab vector out to a frame file.
The FrFileRanges utility, which reports the time interval(s) covered by frame files in one or more directories specified by the user.
The FrStateFetcher, VirgoStateFetcher, and FrActivityFetcher utilities, which extract state vector information from a list of frame files.
The FrSplit utility, which splits a large file containing multiple frames into many small files, each containing a single frame.
The Matlab functions loadframecache and readframedata, which provide a high-level interface for reading frame data into Matlab. The perl scripts createframecache.pl and convertlalcache.pl can be used to generate a cache file in the format expected by the loadframecache Matlab function. (See below for a link to documentation.)

Authors:

Sam Finn and Keith Thorne (mkframe)
Greg Mendell (FrDiff, FrSplit)
Chris Hawkins (FrameDataDump)
Peter Shawhan (FrChannels, FrGeomDump, FrFileRanges, FrTrend)
Ben Johnson (FrStateFetcher, VirgoStateFetcher, FrActivityFetcher)
Shourov Chatterji and Lindy Blackburn (readframedata and related utilities)

LIGOtools coordinators: Shourov Chatterji, Peter Shawhan

Version v6r24

Release date (as a LIGOtools package): August 3, 2007
History of changes

Frequently Asked Questions related to this package

Notes

Documentation

Typing FrChannels, FrGeomDump, FrFileRanges, FrDiff, or FrSplit without any arguments gives you a summary of the syntax.
There is a web page with FrameDataDump notes and examples. Also, typing FrameDataDump without any arguments gives you a summary of the syntax.
Usage notes for the Matlab readframedata and loadframecache functions may be found here.
Within Matlab, you can get detailed info (function arguments, etc.) about mkframe by typing help mkframe. Or see the source code: mkframe.c.

Distribution files

Normally, you should use the ligotools_update utility to download and install new packages or new versions of existing packages, since it automatically figures out what packages need to be updated. However, if you wish to do so manually, then click on the name of the appropriate distribution file (below) with the right mouse button and choose "Save Link As..." from the popup menu. Note that you must save it on your disk with exactly the same name as it has on this web site. After the file has been downloaded, do:
ligotools_install <file>
where <file> is the file which was downloaded. This procedure will be quicker if the environment variable LIGOTOOLS is set to the main LIGOtools directory.

Source distribution: FrContrib_v6r24_SOURCE.tar.gz (749 kb)
This is known to build properly on Solaris and Linux using gcc; other operating systems or compilers may require some modifications. Also, frextract and frgetvect will be built only if the Matlab mex compiler is present.
Generic binary distribution for Solaris: FrContrib_v6r24_SunOS.tar.gz (1359 kb)
Generic binary distribution for Linux: FrContrib_v6r24_Linux.tar.gz (1374 kb)
32-bit Linux binary distributions for specific versions of Matlab:
Matlab R13, Matlab R14 SP3, Matlab 2006a, Matlab 2006b, Matlab 2007a
64-bit Linux binary distributions for specific versions of Matlab:
Matlab R13, Matlab R14 SP3, Matlab 2006a, Matlab 2006b, Matlab 2007a
Binary distribution for Mac OS X (THIS IS AN OLD VERSION, v6r15): FrContrib_v6r15_Darwin.tar.gz (432 kb)