This is a suite of functions for creating, destroying, and manipulating LAL frequency series. One pair of functions (the XLAL version and its LAL counterpart) is available for each method and frequency series type. For example XLALCreateREAL4FrequencySeries() is available for creating frequency series of REAL4
data, and the LAL-stype wrapper LALCreateREAL4FrequencySeries() 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.).
Creation Functions | |
Synopsis#include <lal/FrequencySeries.h>
XLALCreate<frequencyseriestype>()
LALCreate<frequencyseriestype>()
DescriptionThese functions create LAL frequency series. An XLAL function returns a pointer to the newly created series or | |
COMPLEX8FrequencySeries * | XLALCreateCOMPLEX8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
COMPLEX16FrequencySeries * | XLALCreateCOMPLEX16FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
REAL4FrequencySeries * | XLALCreateREAL4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
REAL8FrequencySeries * | XLALCreateREAL8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
INT2FrequencySeries * | XLALCreateINT2FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
INT4FrequencySeries * | XLALCreateINT4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
INT8FrequencySeries * | XLALCreateINT8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
UINT2FrequencySeries * | XLALCreateUINT2FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
UINT4FrequencySeries * | XLALCreateUINT4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
UINT8FrequencySeries * | XLALCreateUINT8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length) |
Destruction Functions | |
Synopsis#include <lal/FrequencySeries.h>
XLALDestroy<frequencyseriestype>()
LALDestroy<frequencyseriestype>()
DescriptionThese functions free all memory associated with a LAL frequency series. It is safe to pass | |
void | XLALDestroyCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series) |
void | XLALDestroyCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series) |
void | XLALDestroyREAL4FrequencySeries (REAL4FrequencySeries *series) |
void | XLALDestroyREAL8FrequencySeries (REAL8FrequencySeries *series) |
void | XLALDestroyINT2FrequencySeries (INT2FrequencySeries *series) |
void | XLALDestroyINT4FrequencySeries (INT4FrequencySeries *series) |
void | XLALDestroyINT8FrequencySeries (INT8FrequencySeries *series) |
void | XLALDestroyUINT2FrequencySeries (UINT2FrequencySeries *series) |
void | XLALDestroyUINT4FrequencySeries (UINT4FrequencySeries *series) |
void | XLALDestroyUINT8FrequencySeries (UINT8FrequencySeries *series) |
Cutting Functions | |
Synopsis#include <lal/FrequencySeries.h>
XLALCut<frequencyseriestype>()
DescriptionThese functions create a new frequency series by extracting a section of an existing frequency series. | |
COMPLEX8FrequencySeries * | XLALCutCOMPLEX8FrequencySeries (const COMPLEX8FrequencySeries *series, size_t first, size_t length) |
COMPLEX16FrequencySeries * | XLALCutCOMPLEX16FrequencySeries (const COMPLEX16FrequencySeries *series, size_t first, size_t length) |
REAL4FrequencySeries * | XLALCutREAL4FrequencySeries (const REAL4FrequencySeries *series, size_t first, size_t length) |
REAL8FrequencySeries * | XLALCutREAL8FrequencySeries (const REAL8FrequencySeries *series, size_t first, size_t length) |
INT2FrequencySeries * | XLALCutINT2FrequencySeries (const INT2FrequencySeries *series, size_t first, size_t length) |
INT4FrequencySeries * | XLALCutINT4FrequencySeries (const INT4FrequencySeries *series, size_t first, size_t length) |
INT8FrequencySeries * | XLALCutINT8FrequencySeries (const INT8FrequencySeries *series, size_t first, size_t length) |
UINT2FrequencySeries * | XLALCutUINT2FrequencySeries (const UINT2FrequencySeries *series, size_t first, size_t length) |
UINT4FrequencySeries * | XLALCutUINT4FrequencySeries (const UINT4FrequencySeries *series, size_t first, size_t length) |
UINT8FrequencySeries * | XLALCutUINT8FrequencySeries (const UINT8FrequencySeries *series, size_t first, size_t length) |
Resizing Functions | |
Synopsis#include <lal/FrequencySeries.h>
XLALResize<frequencyseriestype>()
XLALShrink<frequencyseriestype>()
LALShrink<frequencyseriestype>()
DescriptionThese functions resize an existing frequency series. The new frequency series will have the given length, and its contents will consist of that part of the original time series that started at sample The "Shrink" functions accept non-negative values for the parameter | |
COMPLEX8FrequencySeries * | XLALResizeCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series, int first, size_t length) |
COMPLEX16FrequencySeries * | XLALResizeCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series, int first, size_t length) |
REAL4FrequencySeries * | XLALResizeREAL4FrequencySeries (REAL4FrequencySeries *series, int first, size_t length) |
REAL8FrequencySeries * | XLALResizeREAL8FrequencySeries (REAL8FrequencySeries *series, int first, size_t length) |
INT2FrequencySeries * | XLALResizeINT2FrequencySeries (INT2FrequencySeries *series, int first, size_t length) |
INT4FrequencySeries * | XLALResizeINT4FrequencySeries (INT4FrequencySeries *series, int first, size_t length) |
INT8FrequencySeries * | XLALResizeINT8FrequencySeries (INT8FrequencySeries *series, int first, size_t length) |
UINT2FrequencySeries * | XLALResizeUINT2FrequencySeries (UINT2FrequencySeries *series, int first, size_t length) |
UINT4FrequencySeries * | XLALResizeUINT4FrequencySeries (UINT4FrequencySeries *series, int first, size_t length) |
UINT8FrequencySeries * | XLALResizeUINT8FrequencySeries (UINT8FrequencySeries *series, int first, size_t length) |
COMPLEX8FrequencySeries * | XLALShrinkCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series, size_t first, size_t length) |
COMPLEX16FrequencySeries * | XLALShrinkCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series, size_t first, size_t length) |
REAL4FrequencySeries * | XLALShrinkREAL4FrequencySeries (REAL4FrequencySeries *series, size_t first, size_t length) |
REAL8FrequencySeries * | XLALShrinkREAL8FrequencySeries (REAL8FrequencySeries *series, size_t first, size_t length) |
INT2FrequencySeries * | XLALShrinkINT2FrequencySeries (INT2FrequencySeries *series, size_t first, size_t length) |
INT4FrequencySeries * | XLALShrinkINT4FrequencySeries (INT4FrequencySeries *series, size_t first, size_t length) |
INT8FrequencySeries * | XLALShrinkINT8FrequencySeries (INT8FrequencySeries *series, size_t first, size_t length) |
UINT2FrequencySeries * | XLALShrinkUINT2FrequencySeries (UINT2FrequencySeries *series, size_t first, size_t length) |
UINT4FrequencySeries * | XLALShrinkUINT4FrequencySeries (UINT4FrequencySeries *series, size_t first, size_t length) |
UINT8FrequencySeries * | XLALShrinkUINT8FrequencySeries (UINT8FrequencySeries *series, size_t first, size_t length) |
Conjugation Functions | |
Synopsis#include <lal/FrequencySeries.h>
XLALConjugate<frequencyseriestype>()
DescriptionThese functions replace a frequency series with its complex conjugate. | |
COMPLEX8FrequencySeries * | XLALConjugateCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series) |
COMPLEX16FrequencySeries * | XLALConjugateCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series) |
COMPLEX8FrequencySeries * XLALCreateCOMPLEX8FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
COMPLEX16FrequencySeries * XLALCreateCOMPLEX16FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
REAL4FrequencySeries * XLALCreateREAL4FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
REAL8FrequencySeries * XLALCreateREAL8FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
INT2FrequencySeries * XLALCreateINT2FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
INT4FrequencySeries * XLALCreateINT4FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
INT8FrequencySeries * XLALCreateINT8FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
UINT2FrequencySeries * XLALCreateUINT2FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
UINT4FrequencySeries * XLALCreateUINT4FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
UINT8FrequencySeries * XLALCreateUINT8FrequencySeries | ( | const CHAR * | name, |
const LIGOTimeGPS * | epoch, | ||
REAL8 | f0, | ||
REAL8 | deltaF, | ||
const LALUnit * | sampleUnits, | ||
size_t | length | ||
) |
void XLALDestroyCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | series | ) |
void XLALDestroyCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | series | ) |
void XLALDestroyREAL4FrequencySeries | ( | REAL4FrequencySeries * | series | ) |
void XLALDestroyREAL8FrequencySeries | ( | REAL8FrequencySeries * | series | ) |
void XLALDestroyINT2FrequencySeries | ( | INT2FrequencySeries * | series | ) |
void XLALDestroyINT4FrequencySeries | ( | INT4FrequencySeries * | series | ) |
void XLALDestroyINT8FrequencySeries | ( | INT8FrequencySeries * | series | ) |
void XLALDestroyUINT2FrequencySeries | ( | UINT2FrequencySeries * | series | ) |
void XLALDestroyUINT4FrequencySeries | ( | UINT4FrequencySeries * | series | ) |
void XLALDestroyUINT8FrequencySeries | ( | UINT8FrequencySeries * | series | ) |
COMPLEX8FrequencySeries * XLALCutCOMPLEX8FrequencySeries | ( | const COMPLEX8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
COMPLEX16FrequencySeries * XLALCutCOMPLEX16FrequencySeries | ( | const COMPLEX16FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
REAL4FrequencySeries * XLALCutREAL4FrequencySeries | ( | const REAL4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
REAL8FrequencySeries * XLALCutREAL8FrequencySeries | ( | const REAL8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT2FrequencySeries * XLALCutINT2FrequencySeries | ( | const INT2FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT4FrequencySeries * XLALCutINT4FrequencySeries | ( | const INT4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT8FrequencySeries * XLALCutINT8FrequencySeries | ( | const INT8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT2FrequencySeries * XLALCutUINT2FrequencySeries | ( | const UINT2FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT4FrequencySeries * XLALCutUINT4FrequencySeries | ( | const UINT4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT8FrequencySeries * XLALCutUINT8FrequencySeries | ( | const UINT8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
COMPLEX8FrequencySeries * XLALResizeCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
COMPLEX16FrequencySeries * XLALResizeCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
REAL4FrequencySeries * XLALResizeREAL4FrequencySeries | ( | REAL4FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
REAL8FrequencySeries * XLALResizeREAL8FrequencySeries | ( | REAL8FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
INT2FrequencySeries * XLALResizeINT2FrequencySeries | ( | INT2FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
INT4FrequencySeries * XLALResizeINT4FrequencySeries | ( | INT4FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
INT8FrequencySeries * XLALResizeINT8FrequencySeries | ( | INT8FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
UINT2FrequencySeries * XLALResizeUINT2FrequencySeries | ( | UINT2FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
UINT4FrequencySeries * XLALResizeUINT4FrequencySeries | ( | UINT4FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
UINT8FrequencySeries * XLALResizeUINT8FrequencySeries | ( | UINT8FrequencySeries * | series, |
int | first, | ||
size_t | length | ||
) |
COMPLEX8FrequencySeries * XLALShrinkCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
COMPLEX16FrequencySeries * XLALShrinkCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
REAL4FrequencySeries * XLALShrinkREAL4FrequencySeries | ( | REAL4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
REAL8FrequencySeries * XLALShrinkREAL8FrequencySeries | ( | REAL8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT2FrequencySeries * XLALShrinkINT2FrequencySeries | ( | INT2FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT4FrequencySeries * XLALShrinkINT4FrequencySeries | ( | INT4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
INT8FrequencySeries * XLALShrinkINT8FrequencySeries | ( | INT8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT2FrequencySeries * XLALShrinkUINT2FrequencySeries | ( | UINT2FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT4FrequencySeries * XLALShrinkUINT4FrequencySeries | ( | UINT4FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
UINT8FrequencySeries * XLALShrinkUINT8FrequencySeries | ( | UINT8FrequencySeries * | series, |
size_t | first, | ||
size_t | length | ||
) |
COMPLEX8FrequencySeries * XLALAddCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | arg1, |
const COMPLEX8FrequencySeries * | arg2 | ||
) |
COMPLEX16FrequencySeries * XLALAddCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | arg1, |
const COMPLEX16FrequencySeries * | arg2 | ||
) |
REAL4FrequencySeries * XLALAddREAL4FrequencySeries | ( | REAL4FrequencySeries * | arg1, |
const REAL4FrequencySeries * | arg2 | ||
) |
REAL8FrequencySeries * XLALAddREAL8FrequencySeries | ( | REAL8FrequencySeries * | arg1, |
const REAL8FrequencySeries * | arg2 | ||
) |
INT2FrequencySeries * XLALAddINT2FrequencySeries | ( | INT2FrequencySeries * | arg1, |
const INT2FrequencySeries * | arg2 | ||
) |
INT4FrequencySeries * XLALAddINT4FrequencySeries | ( | INT4FrequencySeries * | arg1, |
const INT4FrequencySeries * | arg2 | ||
) |
INT8FrequencySeries * XLALAddINT8FrequencySeries | ( | INT8FrequencySeries * | arg1, |
const INT8FrequencySeries * | arg2 | ||
) |
UINT2FrequencySeries * XLALAddUINT2FrequencySeries | ( | UINT2FrequencySeries * | arg1, |
const UINT2FrequencySeries * | arg2 | ||
) |
UINT4FrequencySeries * XLALAddUINT4FrequencySeries | ( | UINT4FrequencySeries * | arg1, |
const UINT4FrequencySeries * | arg2 | ||
) |
UINT8FrequencySeries * XLALAddUINT8FrequencySeries | ( | UINT8FrequencySeries * | arg1, |
const UINT8FrequencySeries * | arg2 | ||
) |
COMPLEX8FrequencySeries * XLALConjugateCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | series | ) |
COMPLEX16FrequencySeries * XLALConjugateCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | series | ) |
COMPLEX8FrequencySeries * XLALMultiplyCOMPLEX8FrequencySeries | ( | COMPLEX8FrequencySeries * | arg1, |
const COMPLEX8FrequencySeries * | arg2 | ||
) |
COMPLEX16FrequencySeries * XLALMultiplyCOMPLEX16FrequencySeries | ( | COMPLEX16FrequencySeries * | arg1, |
const COMPLEX16FrequencySeries * | arg2 | ||
) |
REAL4FrequencySeries * XLALMultiplyREAL4FrequencySeries | ( | REAL4FrequencySeries * | arg1, |
const REAL4FrequencySeries * | arg2 | ||
) |
REAL8FrequencySeries * XLALMultiplyREAL8FrequencySeries | ( | REAL8FrequencySeries * | arg1, |
const REAL8FrequencySeries * | arg2 | ||
) |
INT2FrequencySeries * XLALMultiplyINT2FrequencySeries | ( | INT2FrequencySeries * | arg1, |
const INT2FrequencySeries * | arg2 | ||
) |
INT4FrequencySeries * XLALMultiplyINT4FrequencySeries | ( | INT4FrequencySeries * | arg1, |
const INT4FrequencySeries * | arg2 | ||
) |
INT8FrequencySeries * XLALMultiplyINT8FrequencySeries | ( | INT8FrequencySeries * | arg1, |
const INT8FrequencySeries * | arg2 | ||
) |
UINT2FrequencySeries * XLALMultiplyUINT2FrequencySeries | ( | UINT2FrequencySeries * | arg1, |
const UINT2FrequencySeries * | arg2 | ||
) |
UINT4FrequencySeries * XLALMultiplyUINT4FrequencySeries | ( | UINT4FrequencySeries * | arg1, |
const UINT4FrequencySeries * | arg2 | ||
) |
UINT8FrequencySeries * XLALMultiplyUINT8FrequencySeries | ( | UINT8FrequencySeries * | arg1, |
const UINT8FrequencySeries * | arg2 | ||
) |