Detailed Description

Provides routines for reading data from a LALFrStream.

The routines described below perform either random-access or sequential reading of time-series or frequency-series data from LALFrStream streams.

Prototypes
int	XLALFrStreamGetVectorLength (const char chname, LALFrStream stream)
	Returns the number of data points in channel `chname` in the current frame in frame stream `stream`. More...

LALTYPECODE	XLALFrStreamGetTimeSeriesType (const char chname, LALFrStream stream)
	Returns the type code for the data type of channel `chname` in the current frame in frame stream `stream`. More...

Random-Access Time Series Reading Routines
These routines allow the user to read channel data for a specified period of time. The following is an example of how to read 16 seconds of REAL8 data from channel `STRAIN` beginning at GPS time 123456789 from frame files in the current directory. #include <lal/LALFrStream.h> ... const char dirname = "."; const char pattern = ".gwf"; const char chname = "STRAIN"; LALFrStream stream; REAL8TimeSeries series; LIGOTimeGPS start = { 123456789 }; REAL8 duration = 16.0; ... stream = XLALFrStreamOpen(dirname, pattern); series = XLALFrStreamInputREAL8TimeSeries(stream, chname, &start, duration, 0); REAL8 double REAL8 XLALFrStreamOpen LALFrStream * XLALFrStreamOpen(const char dirname, const char pattern) Opens a LALFrStream for specified frame files. Definition: LALFrStream.c:253 XLALFrStreamInputREAL8TimeSeries REAL8TimeSeries * XLALFrStreamInputREAL8TimeSeries(LALFrStream stream, const char channel, const LIGOTimeGPS start, REAL8 duration, size_t lengthlimit) Reads a time series channel from a LALFrStream stream with a specified start time and duration,... Definition:* LALFrStreamRead.c:423 LALFrStream This structure details the state of the frame stream. Definition: LALFrStream.h:95 LIGOTimeGPS REAL8TimeSeries Note that the XLALFrStreamInputREAL8TimeSeries() will convert channel data of a different datatype to REAL8 data (so, for example, if the data stored in the frame file is REAL4 data, then it is cast as REAL8 data). If this behaviour is not wanted, use XLALFrStreamReadREAL8TimeSeries() instead.
REAL8TimeSeries *	XLALFrStreamInputREAL8TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, double duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration, and performs any needed type conversion. More...

COMPLEX16TimeSeries *	XLALFrStreamInputCOMPLEX16TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, double duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration, and performs any needed type conversion. More...

INT2TimeSeries *	XLALFrStreamReadINT2TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

INT4TimeSeries *	XLALFrStreamReadINT4TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

INT8TimeSeries *	XLALFrStreamReadINT8TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

REAL8TimeSeries *	XLALFrStreamReadREAL8TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

UINT2TimeSeries *	XLALFrStreamReadUINT2TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

UINT4TimeSeries *	XLALFrStreamReadUINT4TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

UINT8TimeSeries *	XLALFrStreamReadUINT8TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

REAL4TimeSeries *	XLALFrStreamReadREAL4TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

COMPLEX8TimeSeries *	XLALFrStreamReadCOMPLEX8TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

COMPLEX16TimeSeries *	XLALFrStreamReadCOMPLEX16TimeSeries (LALFrStream stream, const char chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
	Reads a time series channel from a `LALFrStream` stream with a specified start time and duration. More...

Random-Access Frequency Series Reading Routines
These routines allow the user to read channel data for a specified period of time. The following is an example of how to read a frequency series REAL8 data from channel `STRAIN_PSD` beginning at GPS time 123456789 from frame files in the current directory. #include <lal/LALFrStream.h> ... const char dirname = "."; const char pattern = ".gwf"; const char chname = "STRAIN_PSD"; LALFrStream stream; REAL8FrequencySeries series; LIGOTimeGPS start = { 123456789 }; ... stream = XLALFrStreamOpen(dirname, pattern); series = XLALFrStreamInputREAL8FrequencySeries(stream, chname, &start); ... XLALFrStreamInputREAL8FrequencySeries REAL8FrequencySeries * XLALFrStreamInputREAL8FrequencySeries(LALFrStream stream, const char chname, const LIGOTimeGPS epoch) Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed... Definition:* LALFrStreamRead.c:666 REAL8FrequencySeries Note that the XLALFrStreamInputREAL8FrequencySeries() will convert channel data of a different datatype to REAL8 data (so, for example, if the data stored in the frame file is REAL4 data, then it is cast as REAL8 data). If this behaviour is not wanted, use XLALFrStreamReadREAL8Frequencyeries() instead.
REAL8FrequencySeries *	XLALFrStreamInputREAL8FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch, and performs any needed type conversion. More...

COMPLEX16FrequencySeries *	XLALFrStreamInputCOMPLEX16FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch, and performs any needed type conversion. More...

REAL4FrequencySeries *	XLALFrStreamReadREAL4FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch. More...

REAL8FrequencySeries *	XLALFrStreamReadREAL8FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch. More...

COMPLEX8FrequencySeries *	XLALFrStreamReadCOMPLEX8FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch. More...

COMPLEX16FrequencySeries *	XLALFrStreamReadCOMPLEX16FrequencySeries (LALFrStream stream, const char chname, const LIGOTimeGPS *epoch)
	Reads a time series channel from a `LALFrStream` stream with a specified epoch. More...

Sequential Time Series Reading Routines
These routines are useful for reading sequential blocks of data from a `LALFrStream` stream. The following is an example of how to read REAL8 data from channel `STRAIN` in 1 second blocks starting at the beginning of a stream from frame files in the current directory. #include <lal/TimeSeries.h> #include <lal/LALFrStream.h> ... const char dirname = "."; const char pattern = ".gwf"; const char chname = "STRAIN"; LIGOTimeGPS epoch = LIGOTIMEGPSZERO; // value is unimportant LALFrStream stream; REAL8TimeSeries series; REAL8 duration = 1.0; ... stream = XLALFrStreamOpen(dirname, pattern); // initial values of metadata other than the name are not important series = XLALCreateREAL8TimeSeries(chname, &epoch, 0.0, 0.0, &lalDimensionlessUnit, 0); // update series metadata, particularly the sample rate deltaT XLALFrStreamGetREAL8TimeSeriesMetadata(series, stream); // allocate the required amount of data to the series series = XLALResizeREAL8TimeSeries(series, 0, duration / series->deltaT); // read data from stream one second at a time while (! XLALFrStreamEnd(stream)) { // get the next second of data XLALFrStreamGetREAL8TimeSeries(series, stream); ... } ... LIGOTIMEGPSZERO #define LIGOTIMEGPSZERO XLALFrStreamEnd int XLALFrStreamEnd(LALFrStream stream) Checks to see if a LALFrStream is at the end of the stream. Definition:* LALFrStream.c:368 XLALFrStreamGetREAL8TimeSeriesMetadata int XLALFrStreamGetREAL8TimeSeriesMetadata(REAL8TimeSeries series, LALFrStream stream) XLALFrStreamGetREAL8TimeSeries int XLALFrStreamGetREAL8TimeSeries(REAL8TimeSeries series, LALFrStream stream) XLALResizeREAL8TimeSeries REAL8TimeSeries * XLALResizeREAL8TimeSeries(REAL8TimeSeries series, int first, size_t length) XLALCreateREAL8TimeSeries REAL8TimeSeries XLALCreateREAL8TimeSeries(const CHAR name, const LIGOTimeGPS epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length) lalDimensionlessUnit const LALUnit lalDimensionlessUnit REAL8TimeSeries::deltaT REAL8 deltaT epoch enum @1 epoch
int	XLALFrStreamGetINT2TimeSeries (INT2TimeSeries series, LALFrStream stream)
	Reads time series data from the current position in a `LALFrStream` stream. More...

int	XLALFrStreamGetINT4TimeSeries (INT4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetINT8TimeSeries (INT8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT2TimeSeries (UINT2TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT4TimeSeries (UINT4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT8TimeSeries (UINT8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetREAL4TimeSeries (REAL4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetREAL8TimeSeries (REAL8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX8TimeSeries (COMPLEX8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX16TimeSeries (COMPLEX16TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetINT2TimeSeriesMetadata (INT2TimeSeries series, LALFrStream stream)
	Reads time series metadata from the current position in a `LALFrStream` stream. More...

int	XLALFrStreamGetINT4TimeSeriesMetadata (INT4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetINT8TimeSeriesMetadata (INT8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT2TimeSeriesMetadata (UINT2TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT4TimeSeriesMetadata (UINT4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetUINT8TimeSeriesMetadata (UINT8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetREAL4TimeSeriesMetadata (REAL4TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetREAL8TimeSeriesMetadata (REAL8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX8TimeSeriesMetadata (COMPLEX8TimeSeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX16TimeSeriesMetadata (COMPLEX16TimeSeries series, LALFrStream stream)

Sequential Frequency Series Reading Routines
These routines are useful for reading sequential blocks of data from a `LALFrStream` stream. The following is an example of how to read REAL8 data from channel `STRAIN_PSD` in from each frame starting at the beginning of a stream from frame files in the current directory. #include <stdio.h> #include <lal/Sequence.h> #include <lal/LALFrStream.h> ... const char dirname = "."; const char pattern = ".gwf"; const char chname = "STRAIN_PSD"; LALFrStream stream; UINT4 length; ... stream = XLALFrStreamOpen(dirname, pattern); // read frequency series from each frame in stream sequentially while (! XLALFrStreamEnd(stream)) { REAL8FrequencySeries series; snprintf(series.name, sizeof(series.name), "%s", chname); XLALFrStreamGetREAL8FrequencySeries(&series, stream); XLALFrStreamNext(stream); ... XLALDestroyREAL8Sequence(&series.data); } ... UINT4 uint32_t UINT4 XLALFrStreamNext int XLALFrStreamNext(LALFrStream stream) Advance a LALFrStream stream to the beginning of the next frame. Definition: LALFrStream.c:437 XLALFrStreamGetREAL8FrequencySeries int XLALFrStreamGetREAL8FrequencySeries(REAL8FrequencySeries series, LALFrStream stream) XLALDestroyREAL8Sequence void XLALDestroyREAL8Sequence(REAL8Sequence sequence) REAL8FrequencySeries::data REAL8Sequence data REAL8FrequencySeries::name CHAR name[LALNameLength]
int	XLALFrStreamGetREAL4FrequencySeries (REAL4FrequencySeries series, LALFrStream stream)
	Reads frequency series data from the current frame in a `LALFrStream` stream. More...

int	XLALFrStreamGetREAL8FrequencySeries (REAL8FrequencySeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries series, LALFrStream stream)

int	XLALFrStreamGetCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries series, LALFrStream stream)

Function Documentation

◆ XLALFrStreamGetVectorLength()

int XLALFrStreamGetVectorLength	(	const char *	chname,
		LALFrStream *	stream
	)

Returns the number of data points in channel chname in the current frame in frame stream stream.

Parameters

chname	String containing the name of the channel.
stream	Pointer to a `LALFrStream` structure.

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

Return values

-1 Failure.

Definition at line 46 of file LALFrStreamRead.c.

◆ XLALFrStreamGetTimeSeriesType()

LALTYPECODE XLALFrStreamGetTimeSeriesType	(	const char *	chname,
		LALFrStream *	stream
	)

Returns the type code for the data type of channel chname in the current frame in frame stream stream.

Parameters

chname	String containing the name of the channel.
stream	Pointer to a `LALFrStream` structure.

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 71 of file LALFrStreamRead.c.

◆ XLALFrStreamInputREAL8TimeSeries()

REAL8TimeSeries * XLALFrStreamInputREAL8TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		double	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration, and performs any needed type conversion.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration. If the channel being read is not REAL8, the data is converted to type REAL8.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new REAL8TimeSeries containing the specified data.

Return values

NULL Failure.

Definition at line 423 of file LALFrStreamRead.c.

◆ XLALFrStreamInputCOMPLEX16TimeSeries()

COMPLEX16TimeSeries * XLALFrStreamInputCOMPLEX16TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		double	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration, and performs any needed type conversion.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration. If the channel being read is not COMPLEX16, the data is converted to type COMPLEX16.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new COMPLEX16TimeSeries containing the specified data.

Return values

NULL Failure.

Definition at line 499 of file LALFrStreamRead.c.

◆ XLALFrStreamInputREAL8FrequencySeries()

REAL8FrequencySeries * XLALFrStreamInputREAL8FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed type conversion.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch. If the channel being read is not REAL8, the data is converted to type REAL8.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new REAL8FrequencySeries containing the specified data.

Return values

NULL Failure.

Definition at line 666 of file LALFrStreamRead.c.

◆ XLALFrStreamInputCOMPLEX16FrequencySeries()

COMPLEX16FrequencySeries * XLALFrStreamInputCOMPLEX16FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed type conversion.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch. If the channel being read is not COMPLEX16, the data is converted to type COMPLEX16.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new COMPLEX16FrequencySeries containing the specified data.

Return values

NULL Failure.

Definition at line 712 of file LALFrStreamRead.c.

◆ XLALFrStreamReadINT2TimeSeries()

INT2TimeSeries * XLALFrStreamReadINT2TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new INT2TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadINT4TimeSeries()

INT4TimeSeries * XLALFrStreamReadINT4TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new INT4TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadINT8TimeSeries()

INT8TimeSeries * XLALFrStreamReadINT8TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new INT8TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadREAL8TimeSeries()

REAL8TimeSeries * XLALFrStreamReadREAL8TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new REAL8TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadUINT2TimeSeries()

UINT2TimeSeries * XLALFrStreamReadUINT2TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new UINT2TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadUINT4TimeSeries()

UINT4TimeSeries * XLALFrStreamReadUINT4TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new UINT4TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadUINT8TimeSeries()

UINT8TimeSeries * XLALFrStreamReadUINT8TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new UINT8TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadREAL4TimeSeries()

REAL4TimeSeries * XLALFrStreamReadREAL4TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new REAL4TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadCOMPLEX8TimeSeries()

COMPLEX8TimeSeries * XLALFrStreamReadCOMPLEX8TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new COMPLEX8TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadCOMPLEX16TimeSeries()

COMPLEX16TimeSeries * XLALFrStreamReadCOMPLEX16TimeSeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	start,
		REAL8	duration,
		size_t	lengthlimit
	)

Reads a time series channel from a LALFrStream stream with a specified start time and duration.

This routine reads data from a specified channel from a LALFrStream beginning at a specified point in time and lasting a specified duration. If there is a gap in the data, this routine skips to the next contiguous set of data of the required duration.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
start	Pointer to a LIGOTimeGPS structure specifying the start time.
duration	The duration of the data to read, in seconds.
lengthlimit	The maximum number of points to read or 0 for unlimited.

Returns: Pointer to a new COMPLEX16TimeSeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadREAL4FrequencySeries()

REAL4FrequencySeries * XLALFrStreamReadREAL4FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new REAL4FrequencySeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadREAL8FrequencySeries()

REAL8FrequencySeries * XLALFrStreamReadREAL8FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new REAL8FrequencySeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadCOMPLEX8FrequencySeries()

COMPLEX8FrequencySeries * XLALFrStreamReadCOMPLEX8FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new COMPLEX8FrequencySeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamReadCOMPLEX16FrequencySeries()

COMPLEX16FrequencySeries * XLALFrStreamReadCOMPLEX16FrequencySeries	(	LALFrStream *	stream,
		const char *	chname,
		const LIGOTimeGPS *	epoch
	)

Reads a time series channel from a LALFrStream stream with a specified epoch.

This routine reads data from a specified channel from a LALFrStream contained in a frame spanning the specified epoch.

Parameters

stream	Pointer to the `LALFrStream` stream.
chname	String with the channel name to read.
epoch	Pointer to a LIGOTimeGPS structure specifying epoch.

Returns: Pointer to a new COMPLEX16FrequencySeries containing the specified data.

Return values

NULL Failure.

◆ XLALFrStreamGetINT2TimeSeries()

int XLALFrStreamGetINT2TimeSeries	(	INT2TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetINT4TimeSeries()

int XLALFrStreamGetINT4TimeSeries	(	INT4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetINT8TimeSeries()

int XLALFrStreamGetINT8TimeSeries	(	INT8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetUINT2TimeSeries()

int XLALFrStreamGetUINT2TimeSeries	(	UINT2TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetUINT4TimeSeries()

int XLALFrStreamGetUINT4TimeSeries	(	UINT4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetUINT8TimeSeries()

int XLALFrStreamGetUINT8TimeSeries	(	UINT8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetREAL4TimeSeries()

int XLALFrStreamGetREAL4TimeSeries	(	REAL4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetREAL8TimeSeries()

int XLALFrStreamGetREAL8TimeSeries	(	REAL8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetCOMPLEX8TimeSeries()

int XLALFrStreamGetCOMPLEX8TimeSeries	(	COMPLEX8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetCOMPLEX16TimeSeries()

int XLALFrStreamGetCOMPLEX16TimeSeries	(	COMPLEX16TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series data from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with data read from stream. The channel name of the data to be read is given by stream->name and the amount of data to be read is given by stream->data->length. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. If stream->data is NULL or stream->data->length is 0, only the metadata is read; otherwise stream->data->data is populated with the channel data. The data begins at the current position of the stream, but if a gap is encountered, the stream skips forward until a gap-less stretch of data that is long enough is found. If this happens, the LAL_FR_STREAM_GAP flag is set on the LALFrStreamState state of the stream.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Read error or end of stream encountered.

◆ XLALFrStreamGetINT2TimeSeriesMetadata()

int XLALFrStreamGetINT2TimeSeriesMetadata	(	INT2TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetINT4TimeSeriesMetadata()

int XLALFrStreamGetINT4TimeSeriesMetadata	(	INT4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetINT8TimeSeriesMetadata()

int XLALFrStreamGetINT8TimeSeriesMetadata	(	INT8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetUINT2TimeSeriesMetadata()

int XLALFrStreamGetUINT2TimeSeriesMetadata	(	UINT2TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetUINT4TimeSeriesMetadata()

int XLALFrStreamGetUINT4TimeSeriesMetadata	(	UINT4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetUINT8TimeSeriesMetadata()

int XLALFrStreamGetUINT8TimeSeriesMetadata	(	UINT8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetREAL4TimeSeriesMetadata()

int XLALFrStreamGetREAL4TimeSeriesMetadata	(	REAL4TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetREAL8TimeSeriesMetadata()

int XLALFrStreamGetREAL8TimeSeriesMetadata	(	REAL8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetCOMPLEX8TimeSeriesMetadata()

int XLALFrStreamGetCOMPLEX8TimeSeriesMetadata	(	COMPLEX8TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetCOMPLEX16TimeSeriesMetadata()

int XLALFrStreamGetCOMPLEX16TimeSeriesMetadata	(	COMPLEX16TimeSeries *	series,
		LALFrStream *	stream
	)

Reads time series metadata from the current position in a LALFrStream stream.

This routine is provided a time series series that will be populated with metadata read from stream. The metadata is associated with the channel whose name is specified by by stream->name. The remaining metadata quantities in stream are populated: stream->epoch, stream->deltaT, stream->sampleUnits. No data is actually read by this routine.

Parameters

[in,out]	series	Pointer to the time series containing the name of the channel to be read and an allocated sequence of the length of data to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetREAL4FrequencySeries()

int XLALFrStreamGetREAL4FrequencySeries	(	REAL4FrequencySeries *	series,
		LALFrStream *	stream
	)

Reads frequency series data from the current frame in a LALFrStream stream.

This routine is provided a frequency series series that will be populated with data read from the current frame in stream. The channel name of the data to read is given by series->name. The metadata contained in series is over-written with the metadata of the named frequency series in stream, and series->data will be allocated and set to the frequency series data contained in the frame.

Attention: series->data is over-written by this routine; it should be unallocated prior to calling this routine.

Parameters

[in,out]	series	Pointer to the frequency series containing the name of the channel to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetREAL8FrequencySeries()

int XLALFrStreamGetREAL8FrequencySeries	(	REAL8FrequencySeries *	series,
		LALFrStream *	stream
	)

Reads frequency series data from the current frame in a LALFrStream stream.

This routine is provided a frequency series series that will be populated with data read from the current frame in stream. The channel name of the data to read is given by series->name. The metadata contained in series is over-written with the metadata of the named frequency series in stream, and series->data will be allocated and set to the frequency series data contained in the frame.

Attention: series->data is over-written by this routine; it should be unallocated prior to calling this routine.

Parameters

[in,out]	series	Pointer to the frequency series containing the name of the channel to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetCOMPLEX8FrequencySeries()

int XLALFrStreamGetCOMPLEX8FrequencySeries	(	COMPLEX8FrequencySeries *	series,
		LALFrStream *	stream
	)

Reads frequency series data from the current frame in a LALFrStream stream.

This routine is provided a frequency series series that will be populated with data read from the current frame in stream. The channel name of the data to read is given by series->name. The metadata contained in series is over-written with the metadata of the named frequency series in stream, and series->data will be allocated and set to the frequency series data contained in the frame.

Attention: series->data is over-written by this routine; it should be unallocated prior to calling this routine.

Parameters

[in,out]	series	Pointer to the frequency series containing the name of the channel to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

◆ XLALFrStreamGetCOMPLEX16FrequencySeries()

int XLALFrStreamGetCOMPLEX16FrequencySeries	(	COMPLEX16FrequencySeries *	series,
		LALFrStream *	stream
	)

Reads frequency series data from the current frame in a LALFrStream stream.

This routine is provided a frequency series series that will be populated with data read from the current frame in stream. The channel name of the data to read is given by series->name. The metadata contained in series is over-written with the metadata of the named frequency series in stream, and series->data will be allocated and set to the frequency series data contained in the frame.

Attention: series->data is over-written by this routine; it should be unallocated prior to calling this routine.

Parameters

[in,out]	series	Pointer to the frequency series containing the name of the channel to be read.
	stream	Pointer to a `LALFrStream` stream.

Return values

0	Success.
<0	Failure.

Detailed Description

Prototypes

Random-Access Time Series Reading Routines

Random-Access Frequency Series Reading Routines

Sequential Time Series Reading Routines

Sequential Frequency Series Reading Routines

Function Documentation

◆ XLALFrStreamGetVectorLength()

◆ XLALFrStreamGetTimeSeriesType()

◆ XLALFrStreamInputREAL8TimeSeries()

◆ XLALFrStreamInputCOMPLEX16TimeSeries()

◆ XLALFrStreamInputREAL8FrequencySeries()

◆ XLALFrStreamInputCOMPLEX16FrequencySeries()

◆ XLALFrStreamReadINT2TimeSeries()

◆ XLALFrStreamReadINT4TimeSeries()

◆ XLALFrStreamReadINT8TimeSeries()

◆ XLALFrStreamReadREAL8TimeSeries()

◆ XLALFrStreamReadUINT2TimeSeries()

◆ XLALFrStreamReadUINT4TimeSeries()

◆ XLALFrStreamReadUINT8TimeSeries()

◆ XLALFrStreamReadREAL4TimeSeries()

◆ XLALFrStreamReadCOMPLEX8TimeSeries()

◆ XLALFrStreamReadCOMPLEX16TimeSeries()

◆ XLALFrStreamReadREAL4FrequencySeries()

◆ XLALFrStreamReadREAL8FrequencySeries()

◆ XLALFrStreamReadCOMPLEX8FrequencySeries()

◆ XLALFrStreamReadCOMPLEX16FrequencySeries()

◆ XLALFrStreamGetINT2TimeSeries()

◆ XLALFrStreamGetINT4TimeSeries()

◆ XLALFrStreamGetINT8TimeSeries()

◆ XLALFrStreamGetUINT2TimeSeries()

◆ XLALFrStreamGetUINT4TimeSeries()

◆ XLALFrStreamGetUINT8TimeSeries()

◆ XLALFrStreamGetREAL4TimeSeries()

◆ XLALFrStreamGetREAL8TimeSeries()

◆ XLALFrStreamGetCOMPLEX8TimeSeries()

◆ XLALFrStreamGetCOMPLEX16TimeSeries()

◆ XLALFrStreamGetINT2TimeSeriesMetadata()

◆ XLALFrStreamGetINT4TimeSeriesMetadata()

◆ XLALFrStreamGetINT8TimeSeriesMetadata()

◆ XLALFrStreamGetUINT2TimeSeriesMetadata()

◆ XLALFrStreamGetUINT4TimeSeriesMetadata()

◆ XLALFrStreamGetUINT8TimeSeriesMetadata()

◆ XLALFrStreamGetREAL4TimeSeriesMetadata()

◆ XLALFrStreamGetREAL8TimeSeriesMetadata()

◆ XLALFrStreamGetCOMPLEX8TimeSeriesMetadata()

◆ XLALFrStreamGetCOMPLEX16TimeSeriesMetadata()

◆ XLALFrStreamGetREAL4FrequencySeries()

◆ XLALFrStreamGetREAL8FrequencySeries()

◆ XLALFrStreamGetCOMPLEX8FrequencySeries()

◆ XLALFrStreamGetCOMPLEX16FrequencySeries()