Time Series Manipulation

Detailed Description

This is a suite of functions for creating, destroying, and manipulating LAL time series. One pair of functions (the XLAL version and its LAL counterpart) is available for each method and series type. For example XLALCreateREAL4TimeSeries() is available for creating time series of REAL4 data, and the LAL-stype wrapper LALCreateREAL4TimeSeries() is provided which is equivalent to the XLAL version in all respects except that it adheres to the LAL calling conventions (eg. it takes a LALStatus pointer as its first argument, its return type is void, etc.).

Author

Kipp Cannon kipp@.nosp@m.grav.nosp@m.ity.p.nosp@m.hys..nosp@m.uwm.e.nosp@m.du

Creation Functions
Synopsis #include <lal/TimeSeries.h> XLALCreate<timeseriestype>() LALCreate<timeseriestype>() Description These functions create LAL frequency series. An XLAL function returns a pointer to the newly created series or NULL on failure. The LAL counterpart accepts the address of a pointer which it fills with the address of the newly created series or NULL on failure. Additionally, the LAL wrapper provides standard LAL-style error checking via a LALStatus pointer.
COMPLEX8TimeSeries *	XLALCreateCOMPLEX8TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
COMPLEX16TimeSeries *	XLALCreateCOMPLEX16TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
REAL4TimeSeries *	XLALCreateREAL4TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
REAL8TimeSeries *	XLALCreateREAL8TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
INT2TimeSeries *	XLALCreateINT2TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
INT4TimeSeries *	XLALCreateINT4TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
INT8TimeSeries *	XLALCreateINT8TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
UINT2TimeSeries *	XLALCreateUINT2TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
UINT4TimeSeries *	XLALCreateUINT4TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
UINT8TimeSeries *	XLALCreateUINT8TimeSeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)

Destruction Functions
Synopsis #include <lal/TimeSeries.h> XLALDestroy<timeseriestype>() LALDestroy<timeseriestype>() Description These functions free all memory associated with a LAL time series. It is safe to pass NULL to these functions.
void	XLALDestroyCOMPLEX8TimeSeries (COMPLEX8TimeSeries *series)
void	XLALDestroyCOMPLEX16TimeSeries (COMPLEX16TimeSeries *series)
void	XLALDestroyREAL4TimeSeries (REAL4TimeSeries *series)
void	XLALDestroyREAL8TimeSeries (REAL8TimeSeries *series)
void	XLALDestroyINT2TimeSeries (INT2TimeSeries *series)
void	XLALDestroyINT4TimeSeries (INT4TimeSeries *series)
void	XLALDestroyINT8TimeSeries (INT8TimeSeries *series)
void	XLALDestroyUINT2TimeSeries (UINT2TimeSeries *series)
void	XLALDestroyUINT4TimeSeries (UINT4TimeSeries *series)
void	XLALDestroyUINT8TimeSeries (UINT8TimeSeries *series)

Conversion Functions
Synopsis #include <lal/TimeSeries.h> XLALConvertREAL8TimeSeriesToREAL4() XLALConvertREAL4TimeSeriesToREAL8() Description These functions create a new REAL8 or REAL4 time series, initialized from a REAL4 or REAL8 time series, respectively. The source time series is not deallocated.
REAL4TimeSeries *	XLALConvertREAL8TimeSeriesToREAL4 (const REAL8TimeSeries *series)
REAL8TimeSeries *	XLALConvertREAL4TimeSeriesToREAL8 (const REAL4TimeSeries *series)

Cutting Functions
Synopsis #include <lal/TimeSeries.h> XLALCut<timeseriestype>() LALCut<timeseriestype>() Description These functions create a new time series by extracting a section of an existing time series.
COMPLEX8TimeSeries *	XLALCutCOMPLEX8TimeSeries (const COMPLEX8TimeSeries *series, size_t first, size_t length)
COMPLEX16TimeSeries *	XLALCutCOMPLEX16TimeSeries (const COMPLEX16TimeSeries *series, size_t first, size_t length)
REAL4TimeSeries *	XLALCutREAL4TimeSeries (const REAL4TimeSeries *series, size_t first, size_t length)
REAL8TimeSeries *	XLALCutREAL8TimeSeries (const REAL8TimeSeries *series, size_t first, size_t length)
INT2TimeSeries *	XLALCutINT2TimeSeries (const INT2TimeSeries *series, size_t first, size_t length)
INT4TimeSeries *	XLALCutINT4TimeSeries (const INT4TimeSeries *series, size_t first, size_t length)
INT8TimeSeries *	XLALCutINT8TimeSeries (const INT8TimeSeries *series, size_t first, size_t length)
UINT2TimeSeries *	XLALCutUINT2TimeSeries (const UINT2TimeSeries *series, size_t first, size_t length)
UINT4TimeSeries *	XLALCutUINT4TimeSeries (const UINT4TimeSeries *series, size_t first, size_t length)
UINT8TimeSeries *	XLALCutUINT8TimeSeries (const UINT8TimeSeries *series, size_t first, size_t length)

Resizing Functions
Synopsis #include <lal/TimeSeries.h> XLALResize<timeseriestype>() LALResize<timeseriestype>() XLALShrink<timeseriestype>() LALShrink<timeseriestype>() Description These functions resize an existing time series. The new time series will have the given length, and its contents will consist of that part of the original time series that started at sample first. If first is negative, then the new time series is padded at the start by that many samples. The time series' epoch is adjusted appropriately.
COMPLEX8TimeSeries *	XLALResizeCOMPLEX8TimeSeries (COMPLEX8TimeSeries *series, int first, size_t length)
COMPLEX16TimeSeries *	XLALResizeCOMPLEX16TimeSeries (COMPLEX16TimeSeries *series, int first, size_t length)
REAL4TimeSeries *	XLALResizeREAL4TimeSeries (REAL4TimeSeries *series, int first, size_t length)
REAL8TimeSeries *	XLALResizeREAL8TimeSeries (REAL8TimeSeries *series, int first, size_t length)
INT2TimeSeries *	XLALResizeINT2TimeSeries (INT2TimeSeries *series, int first, size_t length)
INT4TimeSeries *	XLALResizeINT4TimeSeries (INT4TimeSeries *series, int first, size_t length)
INT8TimeSeries *	XLALResizeINT8TimeSeries (INT8TimeSeries *series, int first, size_t length)
UINT2TimeSeries *	XLALResizeUINT2TimeSeries (UINT2TimeSeries *series, int first, size_t length)
UINT4TimeSeries *	XLALResizeUINT4TimeSeries (UINT4TimeSeries *series, int first, size_t length)
UINT8TimeSeries *	XLALResizeUINT8TimeSeries (UINT8TimeSeries *series, int first, size_t length)
COMPLEX8TimeSeries *	XLALShrinkCOMPLEX8TimeSeries (COMPLEX8TimeSeries *series, size_t first, size_t length)
COMPLEX16TimeSeries *	XLALShrinkCOMPLEX16TimeSeries (COMPLEX16TimeSeries *series, size_t first, size_t length)
REAL4TimeSeries *	XLALShrinkREAL4TimeSeries (REAL4TimeSeries *series, size_t first, size_t length)
REAL8TimeSeries *	XLALShrinkREAL8TimeSeries (REAL8TimeSeries *series, size_t first, size_t length)
INT2TimeSeries *	XLALShrinkINT2TimeSeries (INT2TimeSeries *series, size_t first, size_t length)
INT4TimeSeries *	XLALShrinkINT4TimeSeries (INT4TimeSeries *series, size_t first, size_t length)
INT8TimeSeries *	XLALShrinkINT8TimeSeries (INT8TimeSeries *series, size_t first, size_t length)
UINT2TimeSeries *	XLALShrinkUINT2TimeSeries (UINT2TimeSeries *series, size_t first, size_t length)
UINT4TimeSeries *	XLALShrinkUINT4TimeSeries (UINT4TimeSeries *series, size_t first, size_t length)
UINT8TimeSeries *	XLALShrinkUINT8TimeSeries (UINT8TimeSeries *series, size_t first, size_t length)

Addition Functions
Synopsis #include <lal/TimeSeries.h> XLALAdd<timeseriestype>() Description These functions add the second argument to the first argument, returning a pointer to the first argument on success or NULL on failure. The two series must have the same heterodyne frequency and time resolution, and have units that differ only by a dimensionless factor.
COMPLEX8TimeSeries *	XLALAddCOMPLEX8TimeSeries (COMPLEX8TimeSeries *arg1, const COMPLEX8TimeSeries *arg2)
COMPLEX16TimeSeries *	XLALAddCOMPLEX16TimeSeries (COMPLEX16TimeSeries *arg1, const COMPLEX16TimeSeries *arg2)
REAL4TimeSeries *	XLALAddREAL4TimeSeries (REAL4TimeSeries *arg1, const REAL4TimeSeries *arg2)
REAL8TimeSeries *	XLALAddREAL8TimeSeries (REAL8TimeSeries *arg1, const REAL8TimeSeries *arg2)
INT2TimeSeries *	XLALAddINT2TimeSeries (INT2TimeSeries *arg1, const INT2TimeSeries *arg2)
INT4TimeSeries *	XLALAddINT4TimeSeries (INT4TimeSeries *arg1, const INT4TimeSeries *arg2)
INT8TimeSeries *	XLALAddINT8TimeSeries (INT8TimeSeries *arg1, const INT8TimeSeries *arg2)
UINT2TimeSeries *	XLALAddUINT2TimeSeries (UINT2TimeSeries *arg1, const UINT2TimeSeries *arg2)
UINT4TimeSeries *	XLALAddUINT4TimeSeries (UINT4TimeSeries *arg1, const UINT4TimeSeries *arg2)
UINT8TimeSeries *	XLALAddUINT8TimeSeries (UINT8TimeSeries *arg1, const UINT8TimeSeries *arg2)

Function Documentation

XLALCreateCOMPLEX8TimeSeries()

COMPLEX8TimeSeries* XLALCreateCOMPLEX8TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALCreateCOMPLEX16TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateREAL4TimeSeries()

REAL4TimeSeries* XLALCreateREAL4TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateREAL8TimeSeries()

REAL8TimeSeries* XLALCreateREAL8TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateINT2TimeSeries()

INT2TimeSeries* XLALCreateINT2TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateINT4TimeSeries()

INT4TimeSeries* XLALCreateINT4TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateINT8TimeSeries()

INT8TimeSeries* XLALCreateINT8TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateUINT2TimeSeries()

UINT2TimeSeries* XLALCreateUINT2TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateUINT4TimeSeries()

UINT4TimeSeries* XLALCreateUINT4TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALCreateUINT8TimeSeries()

UINT8TimeSeries* XLALCreateUINT8TimeSeries	(	const CHAR *	name,
		const LIGOTimeGPS *	epoch,
		REAL8	f0,
		REAL8	deltaT,
		const LALUnit *	sampleUnits,
		size_t	length
	)

XLALDestroyCOMPLEX8TimeSeries()

void XLALDestroyCOMPLEX8TimeSeries

(

COMPLEX8TimeSeries *

series

)

XLALDestroyCOMPLEX16TimeSeries()

void XLALDestroyCOMPLEX16TimeSeries

(

COMPLEX16TimeSeries *

series

)

XLALDestroyREAL4TimeSeries()

void XLALDestroyREAL4TimeSeries

(

REAL4TimeSeries *

series

)

XLALDestroyREAL8TimeSeries()

void XLALDestroyREAL8TimeSeries

(

REAL8TimeSeries *

series

)

XLALDestroyINT2TimeSeries()

void XLALDestroyINT2TimeSeries

(

INT2TimeSeries *

series

)

XLALDestroyINT4TimeSeries()

void XLALDestroyINT4TimeSeries

(

INT4TimeSeries *

series

)

XLALDestroyINT8TimeSeries()

void XLALDestroyINT8TimeSeries

(

INT8TimeSeries *

series

)

XLALDestroyUINT2TimeSeries()

void XLALDestroyUINT2TimeSeries

(

UINT2TimeSeries *

series

)

XLALDestroyUINT4TimeSeries()

void XLALDestroyUINT4TimeSeries

(

UINT4TimeSeries *

series

)

XLALDestroyUINT8TimeSeries()

void XLALDestroyUINT8TimeSeries

(

UINT8TimeSeries *

series

)

XLALConvertREAL8TimeSeriesToREAL4()

REAL4TimeSeries* XLALConvertREAL8TimeSeriesToREAL4

(

const REAL8TimeSeries *

series

)

Definition at line 33 of file TimeSeries.c.

XLALConvertREAL4TimeSeriesToREAL8()

REAL8TimeSeries* XLALConvertREAL4TimeSeriesToREAL8

(

const REAL4TimeSeries *

series

)

Definition at line 50 of file TimeSeries.c.

XLALCutCOMPLEX8TimeSeries()

COMPLEX8TimeSeries* XLALCutCOMPLEX8TimeSeries	(	const COMPLEX8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALCutCOMPLEX16TimeSeries	(	const COMPLEX16TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutREAL4TimeSeries()

REAL4TimeSeries* XLALCutREAL4TimeSeries	(	const REAL4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutREAL8TimeSeries()

REAL8TimeSeries* XLALCutREAL8TimeSeries	(	const REAL8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutINT2TimeSeries()

INT2TimeSeries* XLALCutINT2TimeSeries	(	const INT2TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutINT4TimeSeries()

INT4TimeSeries* XLALCutINT4TimeSeries	(	const INT4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutINT8TimeSeries()

INT8TimeSeries* XLALCutINT8TimeSeries	(	const INT8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutUINT2TimeSeries()

UINT2TimeSeries* XLALCutUINT2TimeSeries	(	const UINT2TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutUINT4TimeSeries()

UINT4TimeSeries* XLALCutUINT4TimeSeries	(	const UINT4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALCutUINT8TimeSeries()

UINT8TimeSeries* XLALCutUINT8TimeSeries	(	const UINT8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALResizeCOMPLEX8TimeSeries()

COMPLEX8TimeSeries* XLALResizeCOMPLEX8TimeSeries	(	COMPLEX8TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALResizeCOMPLEX16TimeSeries	(	COMPLEX16TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeREAL4TimeSeries()

REAL4TimeSeries* XLALResizeREAL4TimeSeries	(	REAL4TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeREAL8TimeSeries()

REAL8TimeSeries* XLALResizeREAL8TimeSeries	(	REAL8TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeINT2TimeSeries()

INT2TimeSeries* XLALResizeINT2TimeSeries	(	INT2TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeINT4TimeSeries()

INT4TimeSeries* XLALResizeINT4TimeSeries	(	INT4TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeINT8TimeSeries()

INT8TimeSeries* XLALResizeINT8TimeSeries	(	INT8TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeUINT2TimeSeries()

UINT2TimeSeries* XLALResizeUINT2TimeSeries	(	UINT2TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeUINT4TimeSeries()

UINT4TimeSeries* XLALResizeUINT4TimeSeries	(	UINT4TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALResizeUINT8TimeSeries()

UINT8TimeSeries* XLALResizeUINT8TimeSeries	(	UINT8TimeSeries *	series,
		int	first,
		size_t	length
	)

XLALShrinkCOMPLEX8TimeSeries()

COMPLEX8TimeSeries* XLALShrinkCOMPLEX8TimeSeries	(	COMPLEX8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALShrinkCOMPLEX16TimeSeries	(	COMPLEX16TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkREAL4TimeSeries()

REAL4TimeSeries* XLALShrinkREAL4TimeSeries	(	REAL4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkREAL8TimeSeries()

REAL8TimeSeries* XLALShrinkREAL8TimeSeries	(	REAL8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkINT2TimeSeries()

INT2TimeSeries* XLALShrinkINT2TimeSeries	(	INT2TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkINT4TimeSeries()

INT4TimeSeries* XLALShrinkINT4TimeSeries	(	INT4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkINT8TimeSeries()

INT8TimeSeries* XLALShrinkINT8TimeSeries	(	INT8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkUINT2TimeSeries()

UINT2TimeSeries* XLALShrinkUINT2TimeSeries	(	UINT2TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkUINT4TimeSeries()

UINT4TimeSeries* XLALShrinkUINT4TimeSeries	(	UINT4TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALShrinkUINT8TimeSeries()

UINT8TimeSeries* XLALShrinkUINT8TimeSeries	(	UINT8TimeSeries *	series,
		size_t	first,
		size_t	length
	)

XLALAddCOMPLEX8TimeSeries()

COMPLEX8TimeSeries* XLALAddCOMPLEX8TimeSeries	(	COMPLEX8TimeSeries *	arg1,
		const COMPLEX8TimeSeries *	arg2
	)

XLALAddCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALAddCOMPLEX16TimeSeries	(	COMPLEX16TimeSeries *	arg1,
		const COMPLEX16TimeSeries *	arg2
	)

XLALAddREAL4TimeSeries()

REAL4TimeSeries* XLALAddREAL4TimeSeries	(	REAL4TimeSeries *	arg1,
		const REAL4TimeSeries *	arg2
	)

XLALAddREAL8TimeSeries()

REAL8TimeSeries* XLALAddREAL8TimeSeries	(	REAL8TimeSeries *	arg1,
		const REAL8TimeSeries *	arg2
	)

XLALAddINT2TimeSeries()

INT2TimeSeries* XLALAddINT2TimeSeries	(	INT2TimeSeries *	arg1,
		const INT2TimeSeries *	arg2
	)

XLALAddINT4TimeSeries()

INT4TimeSeries* XLALAddINT4TimeSeries	(	INT4TimeSeries *	arg1,
		const INT4TimeSeries *	arg2
	)

XLALAddINT8TimeSeries()

INT8TimeSeries* XLALAddINT8TimeSeries	(	INT8TimeSeries *	arg1,
		const INT8TimeSeries *	arg2
	)

XLALAddUINT2TimeSeries()

UINT2TimeSeries* XLALAddUINT2TimeSeries	(	UINT2TimeSeries *	arg1,
		const UINT2TimeSeries *	arg2
	)

XLALAddUINT4TimeSeries()

UINT4TimeSeries* XLALAddUINT4TimeSeries	(	UINT4TimeSeries *	arg1,
		const UINT4TimeSeries *	arg2
	)

XLALAddUINT8TimeSeries()

UINT8TimeSeries* XLALAddUINT8TimeSeries	(	UINT8TimeSeries *	arg1,
		const UINT8TimeSeries *	arg2
	)