LAL  7.5.0.1-8083555
FrequencySeries.h File Reference

Prototypes

Creation Functions

Synopsis

#include <lal/FrequencySeries.h>
XLALCreate<frequencyseriestype>()
LALCreate<frequencyseriestype>()

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.

COMPLEX8FrequencySeriesXLALCreateCOMPLEX8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
COMPLEX16FrequencySeriesXLALCreateCOMPLEX16FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
REAL4FrequencySeriesXLALCreateREAL4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
REAL8FrequencySeriesXLALCreateREAL8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
INT2FrequencySeriesXLALCreateINT2FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
INT4FrequencySeriesXLALCreateINT4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
INT8FrequencySeriesXLALCreateINT8FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
UINT2FrequencySeriesXLALCreateUINT2FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
UINT4FrequencySeriesXLALCreateUINT4FrequencySeries (const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaF, const LALUnit *sampleUnits, size_t length)
 
UINT8FrequencySeriesXLALCreateUINT8FrequencySeries (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>()

Description

These functions free all memory associated with a LAL frequency series. It is safe to pass NULL to these functions.

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>()

Description

These functions create a new frequency series by extracting a section of an existing frequency series.

COMPLEX8FrequencySeriesXLALCutCOMPLEX8FrequencySeries (const COMPLEX8FrequencySeries *series, size_t first, size_t length)
 
COMPLEX16FrequencySeriesXLALCutCOMPLEX16FrequencySeries (const COMPLEX16FrequencySeries *series, size_t first, size_t length)
 
REAL4FrequencySeriesXLALCutREAL4FrequencySeries (const REAL4FrequencySeries *series, size_t first, size_t length)
 
REAL8FrequencySeriesXLALCutREAL8FrequencySeries (const REAL8FrequencySeries *series, size_t first, size_t length)
 
INT2FrequencySeriesXLALCutINT2FrequencySeries (const INT2FrequencySeries *series, size_t first, size_t length)
 
INT4FrequencySeriesXLALCutINT4FrequencySeries (const INT4FrequencySeries *series, size_t first, size_t length)
 
INT8FrequencySeriesXLALCutINT8FrequencySeries (const INT8FrequencySeries *series, size_t first, size_t length)
 
UINT2FrequencySeriesXLALCutUINT2FrequencySeries (const UINT2FrequencySeries *series, size_t first, size_t length)
 
UINT4FrequencySeriesXLALCutUINT4FrequencySeries (const UINT4FrequencySeries *series, size_t first, size_t length)
 
UINT8FrequencySeriesXLALCutUINT8FrequencySeries (const UINT8FrequencySeries *series, size_t first, size_t length)
 
Resizing Functions

Synopsis

#include <lal/FrequencySeries.h>
XLALResize<frequencyseriestype>()
XLALShrink<frequencyseriestype>()
LALShrink<frequencyseriestype>()

Description

These 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 first. If first is negative, then the new time series is padded at the start by that many samples. The frequency series' heterodyne frequency, (f_{0}), is adjusted appropriately.

The "Shrink" functions accept non-negative values for the parameter first, and are retained only for historical purposes. New code should use the "Resize" variants.

COMPLEX8FrequencySeriesXLALResizeCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series, int first, size_t length)
 
COMPLEX16FrequencySeriesXLALResizeCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series, int first, size_t length)
 
REAL4FrequencySeriesXLALResizeREAL4FrequencySeries (REAL4FrequencySeries *series, int first, size_t length)
 
REAL8FrequencySeriesXLALResizeREAL8FrequencySeries (REAL8FrequencySeries *series, int first, size_t length)
 
INT2FrequencySeriesXLALResizeINT2FrequencySeries (INT2FrequencySeries *series, int first, size_t length)
 
INT4FrequencySeriesXLALResizeINT4FrequencySeries (INT4FrequencySeries *series, int first, size_t length)
 
INT8FrequencySeriesXLALResizeINT8FrequencySeries (INT8FrequencySeries *series, int first, size_t length)
 
UINT2FrequencySeriesXLALResizeUINT2FrequencySeries (UINT2FrequencySeries *series, int first, size_t length)
 
UINT4FrequencySeriesXLALResizeUINT4FrequencySeries (UINT4FrequencySeries *series, int first, size_t length)
 
UINT8FrequencySeriesXLALResizeUINT8FrequencySeries (UINT8FrequencySeries *series, int first, size_t length)
 
COMPLEX8FrequencySeriesXLALShrinkCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series, size_t first, size_t length)
 
COMPLEX16FrequencySeriesXLALShrinkCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series, size_t first, size_t length)
 
REAL4FrequencySeriesXLALShrinkREAL4FrequencySeries (REAL4FrequencySeries *series, size_t first, size_t length)
 
REAL8FrequencySeriesXLALShrinkREAL8FrequencySeries (REAL8FrequencySeries *series, size_t first, size_t length)
 
INT2FrequencySeriesXLALShrinkINT2FrequencySeries (INT2FrequencySeries *series, size_t first, size_t length)
 
INT4FrequencySeriesXLALShrinkINT4FrequencySeries (INT4FrequencySeries *series, size_t first, size_t length)
 
INT8FrequencySeriesXLALShrinkINT8FrequencySeries (INT8FrequencySeries *series, size_t first, size_t length)
 
UINT2FrequencySeriesXLALShrinkUINT2FrequencySeries (UINT2FrequencySeries *series, size_t first, size_t length)
 
UINT4FrequencySeriesXLALShrinkUINT4FrequencySeries (UINT4FrequencySeries *series, size_t first, size_t length)
 
UINT8FrequencySeriesXLALShrinkUINT8FrequencySeries (UINT8FrequencySeries *series, size_t first, size_t length)
 
Addition Functions

Synopsis

#include <lal/FrequencySeries.h>
XLALAdd<frequencyseriestype>()

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 epoch and frequency resolution, and have units that differ only by a dimensionless factor.

COMPLEX8FrequencySeriesXLALAddCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *arg1, const COMPLEX8FrequencySeries *arg2)
 
COMPLEX16FrequencySeriesXLALAddCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *arg1, const COMPLEX16FrequencySeries *arg2)
 
REAL4FrequencySeriesXLALAddREAL4FrequencySeries (REAL4FrequencySeries *arg1, const REAL4FrequencySeries *arg2)
 
REAL8FrequencySeriesXLALAddREAL8FrequencySeries (REAL8FrequencySeries *arg1, const REAL8FrequencySeries *arg2)
 
INT2FrequencySeriesXLALAddINT2FrequencySeries (INT2FrequencySeries *arg1, const INT2FrequencySeries *arg2)
 
INT4FrequencySeriesXLALAddINT4FrequencySeries (INT4FrequencySeries *arg1, const INT4FrequencySeries *arg2)
 
INT8FrequencySeriesXLALAddINT8FrequencySeries (INT8FrequencySeries *arg1, const INT8FrequencySeries *arg2)
 
UINT2FrequencySeriesXLALAddUINT2FrequencySeries (UINT2FrequencySeries *arg1, const UINT2FrequencySeries *arg2)
 
UINT4FrequencySeriesXLALAddUINT4FrequencySeries (UINT4FrequencySeries *arg1, const UINT4FrequencySeries *arg2)
 
UINT8FrequencySeriesXLALAddUINT8FrequencySeries (UINT8FrequencySeries *arg1, const UINT8FrequencySeries *arg2)
 
Conjugation Functions

Synopsis

#include <lal/FrequencySeries.h>
XLALConjugate<frequencyseriestype>()

Description

These functions replace a frequency series with its complex conjugate.

COMPLEX8FrequencySeriesXLALConjugateCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series)
 
COMPLEX16FrequencySeriesXLALConjugateCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series)
 
Multiplication Functions

Synopsis

#include <lal/FrequencySeries.h>
XLALMultiply<frequencyseriestype>()

Description

These functions multiply the first argument by the second argument, returning a pointer to the first argument on success or NULL on failure. The two series must have the same epoch and frequency resolution, and have units that differ only by a dimensionless factor.

COMPLEX8FrequencySeriesXLALMultiplyCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *arg1, const COMPLEX8FrequencySeries *arg2)
 
COMPLEX16FrequencySeriesXLALMultiplyCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *arg1, const COMPLEX16FrequencySeries *arg2)
 
REAL4FrequencySeriesXLALMultiplyREAL4FrequencySeries (REAL4FrequencySeries *arg1, const REAL4FrequencySeries *arg2)
 
REAL8FrequencySeriesXLALMultiplyREAL8FrequencySeries (REAL8FrequencySeries *arg1, const REAL8FrequencySeries *arg2)
 
INT2FrequencySeriesXLALMultiplyINT2FrequencySeries (INT2FrequencySeries *arg1, const INT2FrequencySeries *arg2)
 
INT4FrequencySeriesXLALMultiplyINT4FrequencySeries (INT4FrequencySeries *arg1, const INT4FrequencySeries *arg2)
 
INT8FrequencySeriesXLALMultiplyINT8FrequencySeries (INT8FrequencySeries *arg1, const INT8FrequencySeries *arg2)
 
UINT2FrequencySeriesXLALMultiplyUINT2FrequencySeries (UINT2FrequencySeries *arg1, const UINT2FrequencySeries *arg2)
 
UINT4FrequencySeriesXLALMultiplyUINT4FrequencySeries (UINT4FrequencySeries *arg1, const UINT4FrequencySeries *arg2)
 
UINT8FrequencySeriesXLALMultiplyUINT8FrequencySeries (UINT8FrequencySeries *arg1, const UINT8FrequencySeries *arg2)
 

Go to the source code of this file.