Module PrintTimeSeries.c

Detailed Description

Print a <datatype>TimeSeries object into a file.

For use in non-production and test code only.

Description

Each member of this family of functions prints the elements of \(\langle\mbox{datatype}\rangle\)TimeSeries into a file. Note: the file name is specified using a character string. This function is for debugging use only: its arguments do not conform to LAL standards so it should not be used in any real analysis codes.

Notes

This function's arguments do not conform to the LAL spec. For this reason it should only be used for debugging purposes in test functions, not in any production code.

Additionally, since printf cannot handle INT8 as integers, the functions LALI8PrintTimeSeries() and LALU8PrintTimeSeries() use a typecast to REAL8 and are thus only valid for numbers between around \(-10^{15}\) and \(10^{15}\).

The first five lines of the file are a header containing:

1. the name of the series
2. the starting epoch
3. the units expressed in terms of the basic SI units
4. column labels

after which come the data, one per line.

The output format is two or three tab-separated columns: the first column is the time corresponding to the row in question, in seconds after the series' starting epoch; for real and integer time series, the second column is the value of the series; for complex time series, the second column is the real part and the third the imaginary part of the value.

Prototypes
void	LALI2PrintTimeSeries (INT2TimeSeries *series, const CHAR *filename)
void	LALI4PrintTimeSeries (INT4TimeSeries *series, const CHAR *filename)
void	LALI8PrintTimeSeries (INT8TimeSeries *series, const CHAR *filename)
void	LALU2PrintTimeSeries (UINT2TimeSeries *series, const CHAR *filename)
void	LALU4PrintTimeSeries (UINT4TimeSeries *series, const CHAR *filename)
void	LALU8PrintTimeSeries (UINT8TimeSeries *series, const CHAR *filename)
void	LALPrintTimeSeries (REAL4TimeSeries *series, const CHAR *filename)
void	LALSPrintTimeSeries (REAL4TimeSeries *series, const CHAR *filename)
void	LALDPrintTimeSeries (REAL8TimeSeries *series, const CHAR *filename)
void	LALCPrintTimeSeries (COMPLEX8TimeSeries *series, const CHAR *filename)
void	LALZPrintTimeSeries (COMPLEX16TimeSeries *series, const CHAR *filename)

Function Documentation

LALI2PrintTimeSeries()

void LALI2PrintTimeSeries	(	INT2TimeSeries *	series,
		const CHAR *	filename
	)

LALI4PrintTimeSeries()

void LALI4PrintTimeSeries	(	INT4TimeSeries *	series,
		const CHAR *	filename
	)

LALI8PrintTimeSeries()

void LALI8PrintTimeSeries	(	INT8TimeSeries *	series,
		const CHAR *	filename
	)

LALU2PrintTimeSeries()

void LALU2PrintTimeSeries	(	UINT2TimeSeries *	series,
		const CHAR *	filename
	)

LALU4PrintTimeSeries()

void LALU4PrintTimeSeries	(	UINT4TimeSeries *	series,
		const CHAR *	filename
	)

LALU8PrintTimeSeries()

void LALU8PrintTimeSeries	(	UINT8TimeSeries *	series,
		const CHAR *	filename
	)

LALPrintTimeSeries()

void LALPrintTimeSeries	(	REAL4TimeSeries *	series,
		const CHAR *	filename
	)

LALSPrintTimeSeries()

void LALSPrintTimeSeries	(	REAL4TimeSeries *	series,
		const CHAR *	filename
	)

LALDPrintTimeSeries()

void LALDPrintTimeSeries	(	REAL8TimeSeries *	series,
		const CHAR *	filename
	)

LALCPrintTimeSeries()

void LALCPrintTimeSeries	(	COMPLEX8TimeSeries *	series,
		const CHAR *	filename
	)

LALZPrintTimeSeries()

void LALZPrintTimeSeries	(	COMPLEX16TimeSeries *	series,
		const CHAR *	filename
	)