LALFrameIO.h File Reference

Prototypes
Frame File Open/Close/Checksum Routines
int	XLALFrFileClose (LALFrFile *frfile)
	Close a frame file described by a LALFrFile structure. More...
LALFrFile *	XLALFrFileOpenURL (const char *url)
	Open frame file for reading and return a LALFrFile structure. More...
int	XLALFrFileCksumValid (LALFrFile *frfile)
	Use checksum to determine if a frame file is valid. More...
Routines to Query Frame File Contents
size_t	XLALFrFileQueryNFrame (const LALFrFile *frfile)
	Query a frame file for the number of frames contained in the file. More...
LIGOTimeGPS *	XLALFrFileQueryGTime (LIGOTimeGPS *start, const LALFrFile *frfile, size_t pos)
	Query a frame file for the start time of a particular frame. More...
double	XLALFrFileQueryDt (const LALFrFile *frfile, size_t pos)
	Query a frame file for the duration of a particular frame. More...
LALTYPECODE	XLALFrFileQueryChanType (const LALFrFile *frfile, const char *chname, size_t pos)
	Query a frame file for the data type of a channel in a frame. More...
size_t	XLALFrFileQueryChanVectorLength (const LALFrFile *frfile, const char *chname, size_t pos)
	Query a frame file for the number of data points in a channel in a frame. More...
Routines to Read Channel Metadata
INT2TimeSeries *	XLALFrFileReadINT2TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
INT4TimeSeries *	XLALFrFileReadINT4TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
INT8TimeSeries *	XLALFrFileReadINT8TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
UINT2TimeSeries *	XLALFrFileReadUINT2TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
UINT4TimeSeries *	XLALFrFileReadUINT4TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
UINT8TimeSeries *	XLALFrFileReadUINT8TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
REAL4TimeSeries *	XLALFrFileReadREAL4TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
REAL8TimeSeries *	XLALFrFileReadREAL8TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
COMPLEX8TimeSeries *	XLALFrFileReadCOMPLEX8TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
COMPLEX16TimeSeries *	XLALFrFileReadCOMPLEX16TimeSeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
REAL4FrequencySeries *	XLALFrFileReadREAL4FrequencySeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
REAL8FrequencySeries *	XLALFrFileReadREAL8FrequencySeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
COMPLEX8FrequencySeries *	XLALFrFileReadCOMPLEX8FrequencySeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
COMPLEX16FrequencySeries *	XLALFrFileReadCOMPLEX16FrequencySeriesMetadata (LALFrFile *frfile, const char *chname, size_t pos)
	Acquires metadata about a specified channel in a frame. More...
Routines to Read Channel Data
INT2TimeSeries *	XLALFrFileReadINT2TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
INT4TimeSeries *	XLALFrFileReadINT4TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
INT8TimeSeries *	XLALFrFileReadINT8TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
UINT2TimeSeries *	XLALFrFileReadUINT2TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
UINT4TimeSeries *	XLALFrFileReadUINT4TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
UINT8TimeSeries *	XLALFrFileReadUINT8TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
REAL4TimeSeries *	XLALFrFileReadREAL4TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
REAL8TimeSeries *	XLALFrFileReadREAL8TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
COMPLEX8TimeSeries *	XLALFrFileReadCOMPLEX8TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
COMPLEX16TimeSeries *	XLALFrFileReadCOMPLEX16TimeSeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
REAL4FrequencySeries *	XLALFrFileReadREAL4FrequencySeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
REAL8FrequencySeries *	XLALFrFileReadREAL8FrequencySeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
COMPLEX8FrequencySeries *	XLALFrFileReadCOMPLEX8FrequencySeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
COMPLEX16FrequencySeries *	XLALFrFileReadCOMPLEX16FrequencySeries (LALFrFile *frfile, const char *chname, size_t pos)
	Reads data from a channel in a frame. More...
Basic Frame Writing Routines
These routines can be used to directly output series data to a frame file.
int	XLALFrWriteINT2TimeSeries (const INT2TimeSeries *series, int fnum)
	Creates a frame file holding the data in a INT2TimeSeries. More...
int	XLALFrWriteINT4TimeSeries (const INT4TimeSeries *series, int fnum)
	Creates a frame file holding the data in a INT4TimeSeries. More...
int	XLALFrWriteINT8TimeSeries (const INT8TimeSeries *series, int fnum)
	Creates a frame file holding the data in a INT8TimeSeries. More...
int	XLALFrWriteREAL4TimeSeries (const REAL4TimeSeries *series, int fnum)
	Creates a frame file holding the data in a REAL4TimeSeries. More...
int	XLALFrWriteREAL8TimeSeries (const REAL8TimeSeries *series, int fnum)
	Creates a frame file holding the data in a REAL8TimeSeries. More...
int	XLALFrWriteCOMPLEX8TimeSeries (const COMPLEX8TimeSeries *series, int fnum)
	Creates a frame file holding the data in a COMPLEX8TimeSeries. More...
int	XLALFrWriteCOMPLEX16TimeSeries (const COMPLEX16TimeSeries *series, int fnum)
	Creates a frame file holding the data in a COMPLEX16TimeSeries. More...
int	XLALFrWriteREAL4FrequencySeries (const REAL4FrequencySeries *series, int fnum, int subtype)
	Creates a frame file holding the data in a REAL4FrequencySeries. More...
int	XLALFrWriteREAL8FrequencySeries (const REAL8FrequencySeries *series, int fnum, int subtype)
	Creates a frame file holding the data in a REAL8FrequencySeries. More...
int	XLALFrWriteCOMPLEX8FrequencySeries (const COMPLEX8FrequencySeries *series, int fnum, int subtype)
	Creates a frame file holding the data in a COMPLEX8FrequencySeries. More...
int	XLALFrWriteCOMPLEX16FrequencySeries (const COMPLEX16FrequencySeries *series, int fnum, int subtype)
	Creates a frame file holding the data in a COMPLEX16FrequencySeries. More...
Advanced Frame Writing Routines
Routines allowing for more control of the data written to a frame file. These routines allow the user to add specific components to a LALFrameH structure, which represents a single frame. Various channels of and other data types can be added to the LALFrameH structure, and then the frame can be written to a frame file.
void	XLALFrameFree (LALFrameH *frame)
	Frees a frame structure. More...
LALFrameH *	XLALFrameNew (const LIGOTimeGPS *epoch, double duration, const char *project, int run, int frnum, INT8 detectorFlags)
	Creates a new frame structure. More...
int	XLALFrameAddFrHistory (LALFrameH *frame, const char *name, const char *comment)
	Adds a history structure to a frame. More...
int	XLALFrameAddFrDetector (LALFrameH *frame, const LALFrDetector *detector)
	Adds a detector structure to a frame. More...
int	XLALFrameAddINT2TimeSeriesAdcData (LALFrameH *frame, const INT2TimeSeries *series)
	Adds an INT2TimeSeries to a frame as a FrAdcData channel. More...
int	XLALFrameAddINT4TimeSeriesAdcData (LALFrameH *frame, const INT4TimeSeries *series)
	Adds an INT4TimeSeries to a frame as a FrAdcData channel. More...
int	XLALFrameAddREAL4TimeSeriesAdcData (LALFrameH *frame, const REAL4TimeSeries *series)
	Adds an REAL4TimeSeries to a frame as a FrAdcData channel. More...
int	XLALFrameAddREAL8TimeSeriesAdcData (LALFrameH *frame, const REAL8TimeSeries *series)
	Adds an REAL8TimeSeries to a frame as a FrAdcData channel. More...
int	XLALFrameAddINT2TimeSeriesSimData (LALFrameH *frame, const INT2TimeSeries *series)
	Adds an INT2TimeSeries to a frame as a FrSimData channel. More...
int	XLALFrameAddINT4TimeSeriesSimData (LALFrameH *frame, const INT4TimeSeries *series)
	Adds an INT4TimeSeries to a frame as a FrSimData channel. More...
int	XLALFrameAddREAL4TimeSeriesSimData (LALFrameH *frame, const REAL4TimeSeries *series)
	Adds an REAL4TimeSeries to a frame as a FrSimData channel. More...
int	XLALFrameAddREAL8TimeSeriesSimData (LALFrameH *frame, const REAL8TimeSeries *series)
	Adds an REAL8TimeSeries to a frame as a FrSimData channel. More...
int	XLALFrameAddINT2TimeSeriesProcData (LALFrameH *frame, const INT2TimeSeries *series)
	Adds an INT2TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddINT4TimeSeriesProcData (LALFrameH *frame, const INT4TimeSeries *series)
	Adds an INT4TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddINT8TimeSeriesProcData (LALFrameH *frame, const INT8TimeSeries *series)
	Adds an INT8TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddUINT2TimeSeriesProcData (LALFrameH *frame, const UINT2TimeSeries *series)
	Adds an UINT2TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddUINT4TimeSeriesProcData (LALFrameH *frame, const UINT4TimeSeries *series)
	Adds an UINT4TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddUINT8TimeSeriesProcData (LALFrameH *frame, const UINT8TimeSeries *series)
	Adds an UINT8TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddREAL4TimeSeriesProcData (LALFrameH *frame, const REAL4TimeSeries *series)
	Adds an REAL4TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddREAL8TimeSeriesProcData (LALFrameH *frame, const REAL8TimeSeries *series)
	Adds an REAL8TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddCOMPLEX8TimeSeriesProcData (LALFrameH *frame, const COMPLEX8TimeSeries *series)
	Adds an COMPLEX8TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddCOMPLEX16TimeSeriesProcData (LALFrameH *frame, const COMPLEX16TimeSeries *series)
	Adds an COMPLEX16TimeSeries to a frame as a FrProcData channel. More...
int	XLALFrameAddREAL4FrequencySeriesProcData (LALFrameH *frame, const REAL4FrequencySeries *series, int subtype)
	Adds an REAL4FrequencySeries to a frame as a FrProcData channel. More...
int	XLALFrameAddREAL8FrequencySeriesProcData (LALFrameH *frame, const REAL8FrequencySeries *series, int subtype)
	Adds an REAL8FrequencySeries to a frame as a FrProcData channel. More...
int	XLALFrameAddCOMPLEX8FrequencySeriesProcData (LALFrameH *frame, const COMPLEX8FrequencySeries *series, int subtype)
	Adds an COMPLEX8FrequencySeries to a frame as a FrProcData channel. More...
int	XLALFrameAddCOMPLEX16FrequencySeriesProcData (LALFrameH *frame, const COMPLEX16FrequencySeries *series, int subtype)
	Adds an COMPLEX16FrequencySeries to a frame as a FrProcData channel. More...
int	XLALFrameWrite (LALFrameH *frame, const char *fname)
	Write a LALFrameH frame structure to a frame file. More...

Go to the source code of this file.

Typedefs
typedef struct tagLALFrFile	LALFrFile
	Incomplete type for a frame file structure. More...
typedef LALFrameUFrameH	LALFrameH
	Incomplete type for a frame header structure. More...