Loading [MathJax]/extensions/TeX/AMSsymbols.js
LAL 7.7.0.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Module PrintFrequencySeries.c

Detailed Description

Print a <datatype>FrequencySeries 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 <datatype>FrequencySeries 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 LALI8PrintFrequencySeries() and LALU8PrintFrequencySeries() use a typecast to REAL8 and are thus only valid for numbers between around \(-10^{15}\) and \(10^{15}\).

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

  1. the name of the series
  2. heterodyning information, if any
  3. the starting epoch, relative to the GPS reference epoch (1980 January 6)
  4. the units expressed in terms of the basic SI units
  5. 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 frequency in hertz corresponding to the row in question; for real and integer frequency series, the second column is the value of the series; for complex frequency series, the second column is the real part and the third the imaginary part of the value.

Note that the frequency given is the physical frequency. In the case of a heterodyned frequency series, this is the heterodyning frequency plus the frequency offset. A frequency series of length \([N]\) is assumed to be packed so that the 0th element corresponds to zero frequency offset, elements 1 through \([N/2]\) to positive frequency offsets (in ascending order), and elements \(N-[N/2]\) to \(N-1\) to negative frequency offsets (also in ascending order, so that the frequency corresponding to the \(N-1\)st element is just below that of the 0th element). If \(N\) is even, the element in position \(N/2\) is assumed to correspond both the maximum poitive and negative frequency offset.

Prototypes

void LALI2PrintFrequencySeries (INT2FrequencySeries *series, const CHAR *filename)
 
void LALI4PrintFrequencySeries (INT4FrequencySeries *series, const CHAR *filename)
 
void LALI8PrintFrequencySeries (INT8FrequencySeries *series, const CHAR *filename)
 
void LALU2PrintFrequencySeries (UINT2FrequencySeries *series, const CHAR *filename)
 
void LALU4PrintFrequencySeries (UINT4FrequencySeries *series, const CHAR *filename)
 
void LALU8PrintFrequencySeries (UINT8FrequencySeries *series, const CHAR *filename)
 
void LALPrintFrequencySeries (REAL4FrequencySeries *series, const CHAR *filename)
 
void LALSPrintFrequencySeries (REAL4FrequencySeries *series, const CHAR *filename)
 
void LALDPrintFrequencySeries (REAL8FrequencySeries *series, const CHAR *filename)
 
void LALCPrintFrequencySeries (COMPLEX8FrequencySeries *series, const CHAR *filename)
 
void LALZPrintFrequencySeries (COMPLEX16FrequencySeries *series, const CHAR *filename)
 

Function Documentation

◆ LALI2PrintFrequencySeries()

void LALI2PrintFrequencySeries ( INT2FrequencySeries series,
const CHAR filename 
)

◆ LALI4PrintFrequencySeries()

void LALI4PrintFrequencySeries ( INT4FrequencySeries series,
const CHAR filename 
)

◆ LALI8PrintFrequencySeries()

void LALI8PrintFrequencySeries ( INT8FrequencySeries series,
const CHAR filename 
)

◆ LALU2PrintFrequencySeries()

void LALU2PrintFrequencySeries ( UINT2FrequencySeries series,
const CHAR filename 
)

◆ LALU4PrintFrequencySeries()

void LALU4PrintFrequencySeries ( UINT4FrequencySeries series,
const CHAR filename 
)

◆ LALU8PrintFrequencySeries()

void LALU8PrintFrequencySeries ( UINT8FrequencySeries series,
const CHAR filename 
)

◆ LALPrintFrequencySeries()

void LALPrintFrequencySeries ( REAL4FrequencySeries series,
const CHAR filename 
)

◆ LALSPrintFrequencySeries()

void LALSPrintFrequencySeries ( REAL4FrequencySeries series,
const CHAR filename 
)

◆ LALDPrintFrequencySeries()

void LALDPrintFrequencySeries ( REAL8FrequencySeries series,
const CHAR filename 
)

◆ LALCPrintFrequencySeries()

void LALCPrintFrequencySeries ( COMPLEX8FrequencySeries series,
const CHAR filename 
)

◆ LALZPrintFrequencySeries()

void LALZPrintFrequencySeries ( COMPLEX16FrequencySeries series,
const CHAR filename 
)