Detailed Description

Intermediate-level routines for reading frame files.

These routines provide the intermediate-level routines for reading from frame files and converting the contents to LAL data types.

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

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...

Function Documentation

◆ XLALFrFileClose()

int XLALFrFileClose ( LALFrFile * frfile )

Close a frame file described by a LALFrFile structure.

Note: This routine is a no-op if passed a NULL pointer.

Parameters

frfile Pointer to the LALFrFile structure

Return values

0	Successfully closed the file and freed memory.

Definition at line 54 of file LALFrameIO.c.

◆ XLALFrFileOpenURL()

LALFrFile * XLALFrFileOpenURL ( const char * url )

Open frame file for reading and return a LALFrFile structure.

Note: Only "file:" protocol is supported in URLs.

Parameters

url	URL of the frame file to be opened.

Returns: Pointer to a LALFrFile structure that can be used to read the frame file, or NULL if the URL could not be opened.

Definition at line 70 of file LALFrameIO.c.

◆ XLALFrFileCksumValid()

int XLALFrFileCksumValid ( LALFrFile * frfile )

Use checksum to determine if a frame file is valid.

Parameters

frfile Pointer to a LALFrFile structure associated with a frame file.

Returns: Logical value indicating if the frame file checksum is correct.

Return values

1	The frame file is valid.
0	The frame file has an incorrect checksum or an error occurred.

Definition at line 205 of file LALFrameIO.c.

◆ XLALFrFileQueryNFrame()

size_t XLALFrFileQueryNFrame ( const LALFrFile * frfile )

Query a frame file for the number of frames contained in the file.

Parameters

frfile Pointer to a LALFrFile structure associated with a frame file.

Returns: Then number of frame structures contained.

Return values

(size_t)(-1) Failure.

Definition at line 130 of file LALFrameIO.c.

◆ XLALFrFileQueryGTime()

LIGOTimeGPS * XLALFrFileQueryGTime	(	LIGOTimeGPS *	start,
		const LALFrFile *	frfile,
		size_t	pos
	)

Query a frame file for the start time of a particular frame.

Parameters

[out]	start	Pointer to a `LIGOTimeGPS` structure containing the start time.
[in]	frfile	Pointer to a LALFrFile structure associated with a frame file.
[in]	pos	The index of the frame in the frame file.

Returns: The pointer to the LIGOTimeGPS parameter start, with its values set to the start GPS time of the specified frame.

Definition at line 135 of file LALFrameIO.c.

◆ XLALFrFileQueryDt()

double XLALFrFileQueryDt	(	const LALFrFile *	frfile,
		size_t	pos
	)

Query a frame file for the duration of a particular frame.

Parameters

[in]	frfile	Pointer to a LALFrFile structure associated with a frame file.
[in]	pos	The index of the frame in the frame file.

Returns: The duration of the frame file in seconds.

Return values

LAL_REAL8_FAIL_NAN Failure.

Definition at line 143 of file LALFrameIO.c.

◆ XLALFrFileQueryChanType()

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.

Parameters

[in]	frfile	Pointer to a LALFrFile structure associated with a frame file.
[in]	chname	String containing the name of the channel.
[in]	pos	The index of the frame in the frame file.

Returns: The LALTYPECODE value of the data type of the channel.

Return values

LAL_CHAR_TYPE_CODE	Channel is an array of type char.
LAL_I2_TYPE_CODE	Channel is an array of type int16_t.
LAL_I4_TYPE_CODE	Channel is an array of type int32_t.
LAL_I8_TYPE_CODE	Channel is an array of type int64_t.
LAL_UCHAR_TYPE_CODE	Channel is an array of type unsigned char.
LAL_U2_TYPE_CODE	Channel is an array of type uint16_t.
LAL_U4_TYPE_CODE	Channel is an array of type uint32_t.
LAL_U8_TYPE_CODE	Channel is an array of type uint64_t.
LAL_S_TYPE_CODE	Channel is an array of type float.
LAL_D_TYPE_CODE	Channel is an array of type double.
LAL_C_TYPE_CODE	Channel is an array of type float complex.
LAL_Z_TYPE_CODE	Channel is an array of type double complex.
-1	Failure.

Definition at line 148 of file LALFrameIO.c.

◆ XLALFrFileQueryChanVectorLength()

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.

Parameters

[in]	frfile	Pointer to a LALFrFile structure associated with a frame file.
[in]	chname	String containing the name of the channel.
[in]	pos	The index of the frame in the frame file.

Returns: The length of the data vector of the channel in the specified frame.

Return values

(size_t)(-1) Failure.

Definition at line 192 of file LALFrameIO.c.

◆ XLALFrFileReadINT2TimeSeriesMetadata()

INT2TimeSeries * XLALFrFileReadINT2TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT2TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadINT4TimeSeriesMetadata()

INT4TimeSeries * XLALFrFileReadINT4TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT4TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadINT8TimeSeriesMetadata()

INT8TimeSeries * XLALFrFileReadINT8TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT8TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadUINT2TimeSeriesMetadata()

UINT2TimeSeries * XLALFrFileReadUINT2TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT2TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadUINT4TimeSeriesMetadata()

UINT4TimeSeries * XLALFrFileReadUINT4TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT4TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadUINT8TimeSeriesMetadata()

UINT8TimeSeries * XLALFrFileReadUINT8TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT8TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadREAL4TimeSeriesMetadata()

REAL4TimeSeries * XLALFrFileReadREAL4TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL4TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadREAL8TimeSeriesMetadata()

REAL8TimeSeries * XLALFrFileReadREAL8TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL8TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX8TimeSeriesMetadata()

COMPLEX8TimeSeries * XLALFrFileReadCOMPLEX8TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX8TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX16TimeSeriesMetadata()

COMPLEX16TimeSeries * XLALFrFileReadCOMPLEX16TimeSeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX16TimeSeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadREAL4FrequencySeriesMetadata()

REAL4FrequencySeries * XLALFrFileReadREAL4FrequencySeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL4FrequencySeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadREAL8FrequencySeriesMetadata()

REAL8FrequencySeries * XLALFrFileReadREAL8FrequencySeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL8FrequencySeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX8FrequencySeriesMetadata()

COMPLEX8FrequencySeries * XLALFrFileReadCOMPLEX8FrequencySeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX8FrequencySeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX16FrequencySeriesMetadata()

COMPLEX16FrequencySeries * XLALFrFileReadCOMPLEX16FrequencySeriesMetadata	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Acquires metadata about a specified channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX16FrequencySeries containing the correct channel name, sample units, epoch, and sampling interval. No data is actually read by this routine, and the length of the data vector is set to 0.

Return values

NULL Failure.

◆ XLALFrFileReadINT2TimeSeries()

INT2TimeSeries * XLALFrFileReadINT2TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT2TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadINT4TimeSeries()

INT4TimeSeries * XLALFrFileReadINT4TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT4TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadINT8TimeSeries()

INT8TimeSeries * XLALFrFileReadINT8TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated INT8TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadUINT2TimeSeries()

UINT2TimeSeries * XLALFrFileReadUINT2TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT2TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadUINT4TimeSeries()

UINT4TimeSeries * XLALFrFileReadUINT4TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT4TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadUINT8TimeSeries()

UINT8TimeSeries * XLALFrFileReadUINT8TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated UINT8TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadREAL4TimeSeries()

REAL4TimeSeries * XLALFrFileReadREAL4TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL4TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadREAL8TimeSeries()

REAL8TimeSeries * XLALFrFileReadREAL8TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL8TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX8TimeSeries()

COMPLEX8TimeSeries * XLALFrFileReadCOMPLEX8TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX8TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX16TimeSeries()

COMPLEX16TimeSeries * XLALFrFileReadCOMPLEX16TimeSeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX16TimeSeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadREAL4FrequencySeries()

REAL4FrequencySeries * XLALFrFileReadREAL4FrequencySeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL4FrequencySeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadREAL8FrequencySeries()

REAL8FrequencySeries * XLALFrFileReadREAL8FrequencySeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated REAL8FrequencySeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX8FrequencySeries()

COMPLEX8FrequencySeries * XLALFrFileReadCOMPLEX8FrequencySeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX8FrequencySeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

◆ XLALFrFileReadCOMPLEX16FrequencySeries()

COMPLEX16FrequencySeries * XLALFrFileReadCOMPLEX16FrequencySeries	(	LALFrFile *	frfile,
		const char *	chname,
		size_t	pos
	)

Reads data from a channel in a frame.

Parameters

frfile	Pointer to a LALFrFile structure associated with a frame file.
chname	String containing the name of the channel.
pos	The index of the frame in the frame file.

Returns: A pointer to a newly allocated COMPLEX8FrequencySeries containing the data from the specified channel in the specified frame.

Return values

NULL Failure.

Typedef Documentation

◆ LALFrFile

typedef struct tagLALFrFile LALFrFile

Incomplete type for a frame file structure.

This structure contains the information used for reading from a frame file.

Definition at line 64 of file LALFrameIO.h.

Detailed Description

Typedefs

Frame File Open/Close/Checksum Routines

Routines to Query Frame File Contents

Routines to Read Channel Metadata

Routines to Read Channel Data

Function Documentation

◆ XLALFrFileClose()

◆ XLALFrFileOpenURL()

◆ XLALFrFileCksumValid()

◆ XLALFrFileQueryNFrame()

◆ XLALFrFileQueryGTime()

◆ XLALFrFileQueryDt()

◆ XLALFrFileQueryChanType()

◆ XLALFrFileQueryChanVectorLength()

◆ XLALFrFileReadINT2TimeSeriesMetadata()

◆ XLALFrFileReadINT4TimeSeriesMetadata()

◆ XLALFrFileReadINT8TimeSeriesMetadata()

◆ XLALFrFileReadUINT2TimeSeriesMetadata()

◆ XLALFrFileReadUINT4TimeSeriesMetadata()

◆ XLALFrFileReadUINT8TimeSeriesMetadata()

◆ XLALFrFileReadREAL4TimeSeriesMetadata()

◆ XLALFrFileReadREAL8TimeSeriesMetadata()

◆ XLALFrFileReadCOMPLEX8TimeSeriesMetadata()

◆ XLALFrFileReadCOMPLEX16TimeSeriesMetadata()

◆ XLALFrFileReadREAL4FrequencySeriesMetadata()

◆ XLALFrFileReadREAL8FrequencySeriesMetadata()

◆ XLALFrFileReadCOMPLEX8FrequencySeriesMetadata()

◆ XLALFrFileReadCOMPLEX16FrequencySeriesMetadata()

◆ XLALFrFileReadINT2TimeSeries()

◆ XLALFrFileReadINT4TimeSeries()

◆ XLALFrFileReadINT8TimeSeries()

◆ XLALFrFileReadUINT2TimeSeries()

◆ XLALFrFileReadUINT4TimeSeries()

◆ XLALFrFileReadUINT8TimeSeries()

◆ XLALFrFileReadREAL4TimeSeries()

◆ XLALFrFileReadREAL8TimeSeries()

◆ XLALFrFileReadCOMPLEX8TimeSeries()

◆ XLALFrFileReadCOMPLEX16TimeSeries()

◆ XLALFrFileReadREAL4FrequencySeries()

◆ XLALFrFileReadREAL8FrequencySeries()

◆ XLALFrFileReadCOMPLEX8FrequencySeries()

◆ XLALFrFileReadCOMPLEX16FrequencySeries()

Typedef Documentation

◆ LALFrFile