Detailed Description

Intermediate-level routines for writing frame files.

These routines provide the intermediate-level routines for writing LAL data types to frame files.

Typedefs
typedef LALFrameUFrameH	LALFrameH
	Incomplete type for a frame header structure. 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...

Function Documentation

◆ XLALFrWriteINT2TimeSeries()

int XLALFrWriteINT2TimeSeries	(	const INT2TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a INT2TimeSeries.

Outputs the data contained in a INT2TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:channel_name then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteINT4TimeSeries()

int XLALFrWriteINT4TimeSeries	(	const INT4TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a INT4TimeSeries.

Outputs the data contained in a INT4TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteINT8TimeSeries()

int XLALFrWriteINT8TimeSeries	(	const INT8TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a INT8TimeSeries.

Outputs the data contained in a INT8TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteREAL4TimeSeries()

int XLALFrWriteREAL4TimeSeries	(	const REAL4TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a REAL4TimeSeries.

Outputs the data contained in a REAL4TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteREAL8TimeSeries()

int XLALFrWriteREAL8TimeSeries	(	const REAL8TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a REAL8TimeSeries.

Outputs the data contained in a REAL8TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteCOMPLEX8TimeSeries()

int XLALFrWriteCOMPLEX8TimeSeries	(	const COMPLEX8TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a COMPLEX8TimeSeries.

Outputs the data contained in a COMPLEX8TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteCOMPLEX16TimeSeries()

int XLALFrWriteCOMPLEX16TimeSeries	(	const COMPLEX16TimeSeries *	series,
		int	fnum
	)

Creates a frame file holding the data in a COMPLEX16TimeSeries.

Outputs the data contained in a COMPLEX16TimeSeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteREAL4FrequencySeries()

int XLALFrWriteREAL4FrequencySeries	(	const REAL4FrequencySeries *	series,
		int	fnum,
		int	subtype
	)

Creates a frame file holding the data in a REAL4FrequencySeries.

Outputs the data contained in a REAL4FrequencySeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.
[in]	subtype	The FrProcData subtype of this data.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteREAL8FrequencySeries()

int XLALFrWriteREAL8FrequencySeries	(	const REAL8FrequencySeries *	series,
		int	fnum,
		int	subtype
	)

Creates a frame file holding the data in a REAL8FrequencySeries.

Outputs the data contained in a REAL8FrequencySeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.
[in]	subtype	The FrProcData subtype of this data.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteCOMPLEX8FrequencySeries()

int XLALFrWriteCOMPLEX8FrequencySeries	(	const COMPLEX8FrequencySeries *	series,
		int	fnum,
		int	subtype
	)

Creates a frame file holding the data in a COMPLEX8FrequencySeries.

Outputs the data contained in a COMPLEX8FrequencySeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.
[in]	subtype	The FrProcData subtype of this data.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrWriteCOMPLEX16FrequencySeries()

int XLALFrWriteCOMPLEX16FrequencySeries	(	const COMPLEX16FrequencySeries *	series,
		int	fnum,
		int	subtype
	)

Creates a frame file holding the data in a COMPLEX16FrequencySeries.

Outputs the data contained in a COMPLEX16FrequencySeries to a frame file whose name is derived from the series name. The name of the file conforms to the convention LIGO-T010150. If the name begins with XmYn:description then this routine adds the appropriate detector structures for prefixes Xm and Yn to the frame, and the name of the file will be XmYn-description-<start>-<duration>.gwf. The data is written as a FrProcData structure.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

[in]	series	The series to write to the frame file.
[in]	fnum	The frame number of the frame to write.
[in]	subtype	The FrProcData subtype of this data.

Return values

0	Success.
-1	Failure.

See also: LIGO-T010150 [https://dcc.ligo.org/LIGO-T010150/public]; Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameFree()

void XLALFrameFree ( LALFrameH * frame )

Frees a frame structure.

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

Parameters

frame Pointer to a LALFrameH structure.

Definition at line 405 of file LALFrameIO.c.

◆ XLALFrameNew()

LALFrameH * XLALFrameNew	(	const LIGOTimeGPS *	epoch,
		double	duration,
		const char *	project,
		int	run,
		int	frnum,
		INT8	detectorFlags
	)

Creates a new frame structure.

Creates a new frame structure with a specified start time, duration, project name (i.e., "LIGO"), run serial number, frame serial number within the run, and detectors associated with the data that will be added to the frame. The detectors are specified in a flag field composed of the various detector bits, e.g., ( LAL_LHO_4K_DETECTOR_BIT | LAL_LLO_4K_DETECTOR_BIT ) would attach detector structures to the frame for the LIGO Hanford and Livingston observatories. See Header LALDetectors.h.

Parameters

[in]	epoch	Pointer to a `LIGOTimeGPS` structure containing the start time of this frame.
[in]	duration	Duration of this frame in seconds.
[in]	project	String describing the project associated with this frame.
[in]	run	Run number associated with this frame.
[in]	frnum	Frame number (within the run) associated with this frame.
[in]	detectorFlags	Flag field specifying the detectors to be associated with the frame.

Returns: Pointer to a new frame structure, or NULL if failure.

See also: Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

Definition at line 411 of file LALFrameIO.c.

◆ XLALFrameAddFrHistory()

int XLALFrameAddFrHistory	(	LALFrameH *	frame,
		const char *	name,
		const char *	comment
	)

Adds a history structure to a frame.

Remarks: History records can be added to a frame, e.g., to detail how the data was generated. For example, the program name, version information, etc., can be added to a frame. The name of the history record should match the name of the FrProcData channel that it is associated with.

Parameters

frame	Pointer to a LALFrameH frame structure to which the history will be added.
name	String containing the name of the history record that will be added.
comment	The history comment that will be added.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.9 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

Definition at line 311 of file LALFrameIO.c.

◆ XLALFrameAddFrDetector()

int XLALFrameAddFrDetector	(	LALFrameH *	frame,
		const LALFrDetector *	detector
	)

Adds a detector structure to a frame.

Parameters

frame	Pointer to a LALFrameH frame structure to which the detector will be added.
detector	Pointer to a `LALFrDetector` structure to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

Definition at line 384 of file LALFrameIO.c.

◆ XLALFrameAddINT2TimeSeriesAdcData()

int XLALFrameAddINT2TimeSeriesAdcData	(	LALFrameH *	frame,
		const INT2TimeSeries *	series
	)

Adds an INT2TimeSeries to a frame as a FrAdcData channel.

Remarks: FrAdcData channels contains "raw" interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.4 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT4TimeSeriesAdcData()

int XLALFrameAddINT4TimeSeriesAdcData	(	LALFrameH *	frame,
		const INT4TimeSeries *	series
	)

Adds an INT4TimeSeries to a frame as a FrAdcData channel.

Remarks: FrAdcData channels contains "raw" interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.4 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL4TimeSeriesAdcData()

int XLALFrameAddREAL4TimeSeriesAdcData	(	LALFrameH *	frame,
		const REAL4TimeSeries *	series
	)

Adds an REAL4TimeSeries to a frame as a FrAdcData channel.

Remarks: FrAdcData channels contains "raw" interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.4 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL8TimeSeriesAdcData()

int XLALFrameAddREAL8TimeSeriesAdcData	(	LALFrameH *	frame,
		const REAL8TimeSeries *	series
	)

Adds an REAL8TimeSeries to a frame as a FrAdcData channel.

Remarks: FrAdcData channels contains "raw" interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.4 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT2TimeSeriesSimData()

int XLALFrameAddINT2TimeSeriesSimData	(	LALFrameH *	frame,
		const INT2TimeSeries *	series
	)

Adds an INT2TimeSeries to a frame as a FrSimData channel.

Remarks: FrSimData channels contains simulated interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT4TimeSeriesSimData()

int XLALFrameAddINT4TimeSeriesSimData	(	LALFrameH *	frame,
		const INT4TimeSeries *	series
	)

Adds an INT4TimeSeries to a frame as a FrSimData channel.

Remarks: FrSimData channels contains simulated interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL4TimeSeriesSimData()

int XLALFrameAddREAL4TimeSeriesSimData	(	LALFrameH *	frame,
		const REAL4TimeSeries *	series
	)

Adds an REAL4TimeSeries to a frame as a FrSimData channel.

Remarks: FrSimData channels contains simulated interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL8TimeSeriesSimData()

int XLALFrameAddREAL8TimeSeriesSimData	(	LALFrameH *	frame,
		const REAL8TimeSeries *	series
	)

Adds an REAL8TimeSeries to a frame as a FrSimData channel.

Remarks: FrSimData channels contains simulated interferometer data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT2TimeSeriesProcData()

int XLALFrameAddINT2TimeSeriesProcData	(	LALFrameH *	frame,
		const INT2TimeSeries *	series
	)

Adds an INT2TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT4TimeSeriesProcData()

int XLALFrameAddINT4TimeSeriesProcData	(	LALFrameH *	frame,
		const INT4TimeSeries *	series
	)

Adds an INT4TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddINT8TimeSeriesProcData()

int XLALFrameAddINT8TimeSeriesProcData	(	LALFrameH *	frame,
		const INT8TimeSeries *	series
	)

Adds an INT8TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddUINT2TimeSeriesProcData()

int XLALFrameAddUINT2TimeSeriesProcData	(	LALFrameH *	frame,
		const UINT2TimeSeries *	series
	)

Adds an UINT2TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddUINT4TimeSeriesProcData()

int XLALFrameAddUINT4TimeSeriesProcData	(	LALFrameH *	frame,
		const UINT4TimeSeries *	series
	)

Adds an UINT4TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddUINT8TimeSeriesProcData()

int XLALFrameAddUINT8TimeSeriesProcData	(	LALFrameH *	frame,
		const UINT8TimeSeries *	series
	)

Adds an UINT8TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL4TimeSeriesProcData()

int XLALFrameAddREAL4TimeSeriesProcData	(	LALFrameH *	frame,
		const REAL4TimeSeries *	series
	)

Adds an REAL4TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL8TimeSeriesProcData()

int XLALFrameAddREAL8TimeSeriesProcData	(	LALFrameH *	frame,
		const REAL8TimeSeries *	series
	)

Adds an REAL8TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddCOMPLEX8TimeSeriesProcData()

int XLALFrameAddCOMPLEX8TimeSeriesProcData	(	LALFrameH *	frame,
		const COMPLEX8TimeSeries *	series
	)

Adds an COMPLEX8TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddCOMPLEX16TimeSeriesProcData()

int XLALFrameAddCOMPLEX16TimeSeriesProcData	(	LALFrameH *	frame,
		const COMPLEX16TimeSeries *	series
	)

Adds an COMPLEX16TimeSeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL4FrequencySeriesProcData()

int XLALFrameAddREAL4FrequencySeriesProcData	(	LALFrameH *	frame,
		const REAL4FrequencySeries *	series,
		int	subtype
	)

Adds an REAL4FrequencySeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.
subtype	The FrProcData subtype of this frequency series.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddREAL8FrequencySeriesProcData()

int XLALFrameAddREAL8FrequencySeriesProcData	(	LALFrameH *	frame,
		const REAL8FrequencySeries *	series,
		int	subtype
	)

Adds an REAL8FrequencySeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.
subtype	The FrProcData subtype of this frequency series.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddCOMPLEX8FrequencySeriesProcData()

int XLALFrameAddCOMPLEX8FrequencySeriesProcData	(	LALFrameH *	frame,
		const COMPLEX8FrequencySeries *	series,
		int	subtype
	)

Adds an COMPLEX8FrequencySeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.
subtype	The FrProcData subtype of this frequency series.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameAddCOMPLEX16FrequencySeriesProcData()

int XLALFrameAddCOMPLEX16FrequencySeriesProcData	(	LALFrameH *	frame,
		const COMPLEX16FrequencySeries *	series,
		int	subtype
	)

Adds an COMPLEX16FrequencySeries to a frame as a FrProcData channel.

Remarks: FrProcData channels contains post-processed data.

The subtypes are as follows:

Value	Subtype
0	Unknown / User-Defined
1	Discrete Fourier Transform
2	Amplitude Spectral Density
3	Power Spectral Density
4	Cross Spectral Density
5	Coherence
6	Transfer Function

Parameters

frame	Pointer to a LALFrameH frame structure to which the series will be added.
series	Pointer to the series to add to the frame.
subtype	The FrProcData subtype of this frequency series.

Return values

0	Success.
-1	Failure.

See also: Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

◆ XLALFrameWrite()

int XLALFrameWrite	(	LALFrameH *	frame,
		const char *	fname
	)

Write a LALFrameH frame structure to a frame file.

Parameters

frame	Pointer to the LALFrameH frame structure to be written.
fname	String with the path name of the frame file to create.

Return values

0	Success.
-1	Failure.

Definition at line 603 of file LALFrameIO.c.

Typedef Documentation

◆ LALFrameH

typedef LALFrameUFrameH LALFrameH

Incomplete type for a frame header structure.

This structure contains information about an individual frame. In this interface, these frames are constructed for writing to frame files.

See also: Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130-v1/public].

Definition at line 522 of file LALFrameIO.h.

Detailed Description

Typedefs

Basic Frame Writing Routines

Advanced Frame Writing Routines

Function Documentation

◆ XLALFrWriteINT2TimeSeries()

◆ XLALFrWriteINT4TimeSeries()

◆ XLALFrWriteINT8TimeSeries()

◆ XLALFrWriteREAL4TimeSeries()

◆ XLALFrWriteREAL8TimeSeries()

◆ XLALFrWriteCOMPLEX8TimeSeries()

◆ XLALFrWriteCOMPLEX16TimeSeries()

◆ XLALFrWriteREAL4FrequencySeries()

◆ XLALFrWriteREAL8FrequencySeries()

◆ XLALFrWriteCOMPLEX8FrequencySeries()

◆ XLALFrWriteCOMPLEX16FrequencySeries()

◆ XLALFrameFree()

◆ XLALFrameNew()

◆ XLALFrameAddFrHistory()

◆ XLALFrameAddFrDetector()

◆ XLALFrameAddINT2TimeSeriesAdcData()

◆ XLALFrameAddINT4TimeSeriesAdcData()

◆ XLALFrameAddREAL4TimeSeriesAdcData()

◆ XLALFrameAddREAL8TimeSeriesAdcData()

◆ XLALFrameAddINT2TimeSeriesSimData()

◆ XLALFrameAddINT4TimeSeriesSimData()

◆ XLALFrameAddREAL4TimeSeriesSimData()

◆ XLALFrameAddREAL8TimeSeriesSimData()

◆ XLALFrameAddINT2TimeSeriesProcData()

◆ XLALFrameAddINT4TimeSeriesProcData()

◆ XLALFrameAddINT8TimeSeriesProcData()

◆ XLALFrameAddUINT2TimeSeriesProcData()

◆ XLALFrameAddUINT4TimeSeriesProcData()

◆ XLALFrameAddUINT8TimeSeriesProcData()

◆ XLALFrameAddREAL4TimeSeriesProcData()

◆ XLALFrameAddREAL8TimeSeriesProcData()

◆ XLALFrameAddCOMPLEX8TimeSeriesProcData()

◆ XLALFrameAddCOMPLEX16TimeSeriesProcData()

◆ XLALFrameAddREAL4FrequencySeriesProcData()

◆ XLALFrameAddREAL8FrequencySeriesProcData()

◆ XLALFrameAddCOMPLEX8FrequencySeriesProcData()

◆ XLALFrameAddCOMPLEX16FrequencySeriesProcData()

◆ XLALFrameWrite()

Typedef Documentation

◆ LALFrameH