Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALFrame 3.0.7.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LALFrStream.h File Reference

Prototypes

LALFrStreamXLALFrStreamCacheOpen (LALCache *cache)
 Opens a LALFrStream associated with a LALCache. More...
 
LALFrStreamXLALFrStreamOpen (const char *dirname, const char *pattern)
 Opens a LALFrStream for specified frame files. More...
 
int XLALFrStreamClose (LALFrStream *stream)
 Closes a LALFrStream. More...
 
int XLALFrStreamGetMode (LALFrStream *stream)
 Returns the current operating mode of a LALFrStream. More...
 
int XLALFrStreamSetMode (LALFrStream *stream, int mode)
 Change the operating mode of a LALFrStream. More...
 
int XLALFrStreamState (LALFrStream *stream)
 Gets the current state of a LALFrStream. More...
 
int XLALFrStreamEnd (LALFrStream *stream)
 Checks to see if a LALFrStream is at the end of the stream. More...
 
int XLALFrStreamError (LALFrStream *stream)
 Checks to see if a LALFrStream has encountered an error. More...
 
int XLALFrStreamClearErr (LALFrStream *stream)
 Resets the state of a LALFrStream. More...
 
int XLALFrStreamRewind (LALFrStream *stream)
 Rewinds a LALFrStream stream. More...
 
int XLALFrStreamNext (LALFrStream *stream)
 Advance a LALFrStream stream to the beginning of the next frame. More...
 
int XLALFrStreamSeek (LALFrStream *stream, const LIGOTimeGPS *epoch)
 Seeks a LALFrStream stream to data at a given time. More...
 
int XLALFrStreamSeekO (LALFrStream *stream, double dt, int whence)
 Seeks a LALFrStream stream by a time offset. More...
 
int XLALFrStreamTell (LIGOTimeGPS *epoch, LALFrStream *stream)
 Tells the current time of the current position of a LALFrStream stream. More...
 
int XLALFrStreamGetpos (LALFrStreamPos *position, LALFrStream *stream)
 Gets the current position of a LALFrStream stream. More...
 
int XLALFrStreamSetpos (LALFrStream *stream, const LALFrStreamPos *position)
 Sets the current position of a LALFrStream stream. More...
 
int XLALFrStreamGetVectorLength (const char *chname, LALFrStream *stream)
 Returns the number of data points in channel chname in the current frame in frame stream stream. More...
 
LALTYPECODE XLALFrStreamGetTimeSeriesType (const char *chname, LALFrStream *stream)
 Returns the type code for the data type of channel chname in the current frame in frame stream stream. More...
 
REAL8TimeSeriesXLALFrStreamInputREAL8TimeSeries (LALFrStream *stream, const char *channel, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration, and performs any needed type conversion. More...
 
COMPLEX16TimeSeriesXLALFrStreamInputCOMPLEX16TimeSeries (LALFrStream *stream, const char *channel, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration, and performs any needed type conversion. More...
 
REAL8FrequencySeriesXLALFrStreamInputREAL8FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed type conversion. More...
 
COMPLEX16FrequencySeriesXLALFrStreamInputCOMPLEX16FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed type conversion. More...
 
Sequential Time Series Reading Routines

These routines are useful for reading sequential blocks of data from a LALFrStream stream.

The following is an example of how to read REAL8 data from channel STRAIN in 1 second blocks starting at the beginning of a stream from frame files in the current directory.

#include <lal/TimeSeries.h>
#include <lal/LALFrStream.h>
...
const char *dirname = ".";
const char *pattern = "*.gwf";
const char *chname = "STRAIN";
LIGOTimeGPS epoch = LIGOTIMEGPSZERO; // value is unimportant
LALFrStream *stream;
REAL8 duration = 1.0;
...
stream = XLALFrStreamOpen(dirname, pattern);
// initial values of metadata other than the name are not important
series = XLALCreateREAL8TimeSeries(chname, &epoch, 0.0, 0.0, &lalDimensionlessUnit, 0);
// update series metadata, particularly the sample rate deltaT
// allocate the required amount of data to the series
series = XLALResizeREAL8TimeSeries(series, 0, duration / series->deltaT);
// read data from stream one second at a time
while (! XLALFrStreamEnd(stream)) {
// get the next second of data
...
}
...
#define LIGOTIMEGPSZERO
double REAL8
int XLALFrStreamEnd(LALFrStream *stream)
Checks to see if a LALFrStream is at the end of the stream.
Definition: LALFrStream.c:368
LALFrStream * XLALFrStreamOpen(const char *dirname, const char *pattern)
Opens a LALFrStream for specified frame files.
Definition: LALFrStream.c:253
int XLALFrStreamGetREAL8TimeSeriesMetadata(REAL8TimeSeries *series, LALFrStream *stream)
int XLALFrStreamGetREAL8TimeSeries(REAL8TimeSeries *series, LALFrStream *stream)
REAL8TimeSeries * XLALResizeREAL8TimeSeries(REAL8TimeSeries *series, int first, size_t length)
REAL8TimeSeries * XLALCreateREAL8TimeSeries(const CHAR *name, const LIGOTimeGPS *epoch, REAL8 f0, REAL8 deltaT, const LALUnit *sampleUnits, size_t length)
const LALUnit lalDimensionlessUnit
This structure details the state of the frame stream.
Definition: LALFrStream.h:95
enum @1 epoch
int XLALFrStreamGetINT2TimeSeries (INT2TimeSeries *series, LALFrStream *stream)
 Reads time series data from the current position in a LALFrStream stream. More...
 
int XLALFrStreamGetINT4TimeSeries (INT4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetINT8TimeSeries (INT8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT2TimeSeries (UINT2TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT4TimeSeries (UINT4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT8TimeSeries (UINT8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetREAL4TimeSeries (REAL4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetREAL8TimeSeries (REAL8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX8TimeSeries (COMPLEX8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX16TimeSeries (COMPLEX16TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetINT2TimeSeriesMetadata (INT2TimeSeries *series, LALFrStream *stream)
 Reads time series metadata from the current position in a LALFrStream stream. More...
 
int XLALFrStreamGetINT4TimeSeriesMetadata (INT4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetINT8TimeSeriesMetadata (INT8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT2TimeSeriesMetadata (UINT2TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT4TimeSeriesMetadata (UINT4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetUINT8TimeSeriesMetadata (UINT8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetREAL4TimeSeriesMetadata (REAL4TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetREAL8TimeSeriesMetadata (REAL8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX8TimeSeriesMetadata (COMPLEX8TimeSeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX16TimeSeriesMetadata (COMPLEX16TimeSeries *series, LALFrStream *stream)
 
Sequential Frequency Series Reading Routines

These routines are useful for reading sequential blocks of data from a LALFrStream stream.

The following is an example of how to read REAL8 data from channel STRAIN_PSD in from each frame starting at the beginning of a stream from frame files in the current directory.

#include <stdio.h>
#include <lal/Sequence.h>
#include <lal/LALFrStream.h>
...
const char *dirname = ".";
const char *pattern = "*.gwf";
const char *chname = "STRAIN_PSD";
LALFrStream *stream;
UINT4 length;
...
stream = XLALFrStreamOpen(dirname, pattern);
// read frequency series from each frame in stream sequentially
while (! XLALFrStreamEnd(stream)) {
snprintf(series.name, sizeof(series.name), "%s", chname);
...
}
...
uint32_t UINT4
int XLALFrStreamNext(LALFrStream *stream)
Advance a LALFrStream stream to the beginning of the next frame.
Definition: LALFrStream.c:437
int XLALFrStreamGetREAL8FrequencySeries(REAL8FrequencySeries *series, LALFrStream *stream)
void XLALDestroyREAL8Sequence(REAL8Sequence *sequence)
REAL8Sequence * data
CHAR name[LALNameLength]
int XLALFrStreamGetREAL4FrequencySeries (REAL4FrequencySeries *series, LALFrStream *stream)
 Reads frequency series data from the current frame in a LALFrStream stream. More...
 
int XLALFrStreamGetREAL8FrequencySeries (REAL8FrequencySeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX8FrequencySeries (COMPLEX8FrequencySeries *series, LALFrStream *stream)
 
int XLALFrStreamGetCOMPLEX16FrequencySeries (COMPLEX16FrequencySeries *series, LALFrStream *stream)
 
Random-Access Time Series Reading Routines

These routines allow the user to read channel data for a specified period of time.

The following is an example of how to read 16 seconds of REAL8 data from channel STRAIN beginning at GPS time 123456789 from frame files in the current directory.

#include <lal/LALFrStream.h>
...
const char *dirname = ".";
const char *pattern = "*.gwf";
const char *chname = "STRAIN";
LALFrStream *stream;
LIGOTimeGPS start = { 123456789 };
REAL8 duration = 16.0;
...
stream = XLALFrStreamOpen(dirname, pattern);
series = XLALFrStreamInputREAL8TimeSeries(stream, chname, &start, duration, 0);
REAL8TimeSeries * XLALFrStreamInputREAL8TimeSeries(LALFrStream *stream, const char *channel, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
Reads a time series channel from a LALFrStream stream with a specified start time and duration,...

Note that the XLALFrStreamInputREAL8TimeSeries() will convert channel data of a different datatype to REAL8 data (so, for example, if the data stored in the frame file is REAL4 data, then it is cast as REAL8 data). If this behaviour is not wanted, use XLALFrStreamReadREAL8TimeSeries() instead.

INT2TimeSeriesXLALFrStreamReadINT2TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
INT4TimeSeriesXLALFrStreamReadINT4TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
INT8TimeSeriesXLALFrStreamReadINT8TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
UINT2TimeSeriesXLALFrStreamReadUINT2TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
UINT4TimeSeriesXLALFrStreamReadUINT4TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
UINT8TimeSeriesXLALFrStreamReadUINT8TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
REAL4TimeSeriesXLALFrStreamReadREAL4TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
REAL8TimeSeriesXLALFrStreamReadREAL8TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
COMPLEX8TimeSeriesXLALFrStreamReadCOMPLEX8TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
COMPLEX16TimeSeriesXLALFrStreamReadCOMPLEX16TimeSeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *start, REAL8 duration, size_t lengthlimit)
 Reads a time series channel from a LALFrStream stream with a specified start time and duration. More...
 
Random-Access Frequency Series Reading Routines

These routines allow the user to read channel data for a specified period of time.

The following is an example of how to read a frequency series REAL8 data from channel STRAIN_PSD beginning at GPS time 123456789 from frame files in the current directory.

#include <lal/LALFrStream.h>
...
const char *dirname = ".";
const char *pattern = "*.gwf";
const char *chname = "STRAIN_PSD";
LALFrStream *stream;
LIGOTimeGPS start = { 123456789 };
...
stream = XLALFrStreamOpen(dirname, pattern);
series = XLALFrStreamInputREAL8FrequencySeries(stream, chname, &start);
...
REAL8FrequencySeries * XLALFrStreamInputREAL8FrequencySeries(LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
Reads a time series channel from a LALFrStream stream with a specified epoch, and performs any needed...

Note that the XLALFrStreamInputREAL8FrequencySeries() will convert channel data of a different datatype to REAL8 data (so, for example, if the data stored in the frame file is REAL4 data, then it is cast as REAL8 data). If this behaviour is not wanted, use XLALFrStreamReadREAL8Frequencyeries() instead.

REAL4FrequencySeriesXLALFrStreamReadREAL4FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch. More...
 
REAL8FrequencySeriesXLALFrStreamReadREAL8FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch. More...
 
COMPLEX8FrequencySeriesXLALFrStreamReadCOMPLEX8FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch. More...
 
COMPLEX16FrequencySeriesXLALFrStreamReadCOMPLEX16FrequencySeries (LALFrStream *stream, const char *chname, const LIGOTimeGPS *epoch)
 Reads a time series channel from a LALFrStream stream with a specified epoch. More...
 
Legacy API
void LALFrCacheOpen (LALStatus *status, LALFrStream **output, LALCache *cache)
 
void LALFrOpen (LALStatus *status, LALFrStream **stream, const CHAR *dirname, const CHAR *pattern)
 
void LALFrClose (LALStatus *status, LALFrStream **stream)
 
void LALFrSeek (LALStatus *status, const LIGOTimeGPS *epoch, LALFrStream *stream)
 
void LALFrGetINT2TimeSeries (LALStatus *status, INT2TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetINT2TimeSeriesMetadata (LALStatus *status, INT2TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetINT4TimeSeries (LALStatus *status, INT4TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetINT4TimeSeriesMetadata (LALStatus *status, INT4TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetINT8TimeSeries (LALStatus *status, INT8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetINT8TimeSeriesMetadata (LALStatus *status, INT8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetREAL4TimeSeries (LALStatus *status, REAL4TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetREAL4TimeSeriesMetadata (LALStatus *status, REAL4TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetREAL8TimeSeries (LALStatus *status, REAL8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetREAL8TimeSeriesMetadata (LALStatus *status, REAL8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetCOMPLEX8TimeSeries (LALStatus *status, COMPLEX8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetCOMPLEX8TimeSeriesMetadata (LALStatus *status, COMPLEX8TimeSeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrGetCOMPLEX8FrequencySeries (LALStatus *status, COMPLEX8FrequencySeries *series, FrChanIn *chanin, LALFrStream *stream)
 
void LALFrWriteINT4TimeSeries (LALStatus *status, INT4TimeSeries *series, FrOutPar *params)
 
void LALFrWriteREAL4TimeSeries (LALStatus *status, REAL4TimeSeries *series, FrOutPar *params)
 

Go to the source code of this file.

Data Structures

struct  LALFrStream
 This structure details the state of the frame stream. More...
 
struct  LALFrStreamPos
 This structure contains a record of the state of a frame stream; this record can be used to restore the stream to the state when the record was made (provided the stream has not been closed). More...
 
struct  FrChanIn
 
struct  FrOutPar
 

Macros

#define FRAMESTREAMH_ENULL   00001
 
#define FRAMESTREAMH_ENNUL   00002
 
#define FRAMESTREAMH_EALOC   00004
 
#define FRAMESTREAMH_EFILE   00010
 
#define FRAMESTREAMH_EOPEN   00020
 
#define FRAMESTREAMH_EREAD   00040
 
#define FRAMESTREAMH_ETIME   00100
 
#define FRAMESTREAMH_ESIZE   00200
 
#define FRAMESTREAMH_ECHAN   00400
 
#define FRAMESTREAMH_ETYPE   01000
 
#define FRAMESTREAMH_ERROR   02000
 
#define FRAMESTREAMH_EDONE   04000
 
#define FRAMESTREAMH_ETREQ   010000
 
#define FRAMESTREAMH_EDGAP   020000
 
#define FRAMESTREAMH_MSGENULL   "Null pointer"
 
#define FRAMESTREAMH_MSGENNUL   "Non-null pointer"
 
#define FRAMESTREAMH_MSGEALOC   "Memory allocation error"
 
#define FRAMESTREAMH_MSGEFILE   "Frame data files not found"
 
#define FRAMESTREAMH_MSGEOPEN   "Frame file open error"
 
#define FRAMESTREAMH_MSGEREAD   "Frame file read error"
 
#define FRAMESTREAMH_MSGETIME   "Invalid ADC offset time"
 
#define FRAMESTREAMH_MSGESIZE   "Invalid vector length"
 
#define FRAMESTREAMH_MSGECHAN   "Could not find ADC channel"
 
#define FRAMESTREAMH_MSGETYPE   "Invalid ADC type"
 
#define FRAMESTREAMH_MSGERROR   "Frame stream error"
 
#define FRAMESTREAMH_MSGEDONE   "End of frame data"
 
#define FRAMESTREAMH_MSGETREQ   "No data at time requested"
 
#define FRAMESTREAMH_MSGEDGAP   "Gap in the data"
 
#define ChannelType   FrChanType
 
#define ProcDataChannel   LAL_PROC_CHAN
 
#define ADCDataChannel   LAL_ADC_CHAN
 
#define SimDataChannel   LAL_SIM_CHAN
 

Enumerations

enum  LALFrStreamState {
  LAL_FR_STREAM_OK = 0 , LAL_FR_STREAM_ERR = 1 , LAL_FR_STREAM_END = 2 , LAL_FR_STREAM_GAP = 4 ,
  LAL_FR_STREAM_URL = 8 , LAL_FR_STREAM_TOC = 16
}
 Enum listing different stream states. More...
 
enum  LALFrStreamMode {
  LAL_FR_STREAM_SILENT_MODE = 0 , LAL_FR_STREAM_TIMEWARN_MODE = 1 , LAL_FR_STREAM_GAPINFO_MODE = 2 , LAL_FR_STREAM_VERBOSE_MODE = 3 ,
  LAL_FR_STREAM_IGNOREGAP_MODE = 4 , LAL_FR_STREAM_IGNORETIME_MODE = 8 , LAL_FR_STREAM_DEFAULT_MODE = 15 , LAL_FR_STREAM_CHECKSUM_MODE = 16
}
 Enum listing different stream modes. More...
 
enum  FrChanType { LAL_ADC_CHAN , LAL_SIM_CHAN , LAL_PROC_CHAN }
 

Macro Definition Documentation

◆ FRAMESTREAMH_ENULL

#define FRAMESTREAMH_ENULL   00001

Definition at line 250 of file LALFrStream.h.

◆ FRAMESTREAMH_ENNUL

#define FRAMESTREAMH_ENNUL   00002

Definition at line 251 of file LALFrStream.h.

◆ FRAMESTREAMH_EALOC

#define FRAMESTREAMH_EALOC   00004

Definition at line 252 of file LALFrStream.h.

◆ FRAMESTREAMH_EFILE

#define FRAMESTREAMH_EFILE   00010

Definition at line 253 of file LALFrStream.h.

◆ FRAMESTREAMH_EOPEN

#define FRAMESTREAMH_EOPEN   00020

Definition at line 254 of file LALFrStream.h.

◆ FRAMESTREAMH_EREAD

#define FRAMESTREAMH_EREAD   00040

Definition at line 255 of file LALFrStream.h.

◆ FRAMESTREAMH_ETIME

#define FRAMESTREAMH_ETIME   00100

Definition at line 256 of file LALFrStream.h.

◆ FRAMESTREAMH_ESIZE

#define FRAMESTREAMH_ESIZE   00200

Definition at line 257 of file LALFrStream.h.

◆ FRAMESTREAMH_ECHAN

#define FRAMESTREAMH_ECHAN   00400

Definition at line 258 of file LALFrStream.h.

◆ FRAMESTREAMH_ETYPE

#define FRAMESTREAMH_ETYPE   01000

Definition at line 259 of file LALFrStream.h.

◆ FRAMESTREAMH_ERROR

#define FRAMESTREAMH_ERROR   02000

Definition at line 260 of file LALFrStream.h.

◆ FRAMESTREAMH_EDONE

#define FRAMESTREAMH_EDONE   04000

Definition at line 261 of file LALFrStream.h.

◆ FRAMESTREAMH_ETREQ

#define FRAMESTREAMH_ETREQ   010000

Definition at line 262 of file LALFrStream.h.

◆ FRAMESTREAMH_EDGAP

#define FRAMESTREAMH_EDGAP   020000

Definition at line 263 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGENULL

#define FRAMESTREAMH_MSGENULL   "Null pointer"

Definition at line 264 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGENNUL

#define FRAMESTREAMH_MSGENNUL   "Non-null pointer"

Definition at line 265 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEALOC

#define FRAMESTREAMH_MSGEALOC   "Memory allocation error"

Definition at line 266 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEFILE

#define FRAMESTREAMH_MSGEFILE   "Frame data files not found"

Definition at line 267 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEOPEN

#define FRAMESTREAMH_MSGEOPEN   "Frame file open error"

Definition at line 268 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEREAD

#define FRAMESTREAMH_MSGEREAD   "Frame file read error"

Definition at line 269 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGETIME

#define FRAMESTREAMH_MSGETIME   "Invalid ADC offset time"

Definition at line 270 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGESIZE

#define FRAMESTREAMH_MSGESIZE   "Invalid vector length"

Definition at line 271 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGECHAN

#define FRAMESTREAMH_MSGECHAN   "Could not find ADC channel"

Definition at line 272 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGETYPE

#define FRAMESTREAMH_MSGETYPE   "Invalid ADC type"

Definition at line 273 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGERROR

#define FRAMESTREAMH_MSGERROR   "Frame stream error"

Definition at line 274 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEDONE

#define FRAMESTREAMH_MSGEDONE   "End of frame data"

Definition at line 275 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGETREQ

#define FRAMESTREAMH_MSGETREQ   "No data at time requested"

Definition at line 276 of file LALFrStream.h.

◆ FRAMESTREAMH_MSGEDGAP

#define FRAMESTREAMH_MSGEDGAP   "Gap in the data"

Definition at line 277 of file LALFrStream.h.

◆ ChannelType

#define ChannelType   FrChanType

Definition at line 291 of file LALFrStream.h.

◆ ProcDataChannel

#define ProcDataChannel   LAL_PROC_CHAN

Definition at line 292 of file LALFrStream.h.

◆ ADCDataChannel

#define ADCDataChannel   LAL_ADC_CHAN

Definition at line 293 of file LALFrStream.h.

◆ SimDataChannel

#define SimDataChannel   LAL_SIM_CHAN

Definition at line 294 of file LALFrStream.h.

Enumeration Type Documentation

◆ FrChanType

enum FrChanType
Enumerator
LAL_ADC_CHAN 
LAL_SIM_CHAN 
LAL_PROC_CHAN 

Definition at line 280 of file LALFrStream.h.

Function Documentation

◆ LALFrCacheOpen()

void LALFrCacheOpen ( LALStatus status,
LALFrStream **  output,
LALCache cache 
)

Definition at line 30 of file LALFrStreamLegacy.c.

◆ LALFrOpen()

void LALFrOpen ( LALStatus status,
LALFrStream **  stream,
const CHAR dirname,
const CHAR pattern 
)

Definition at line 58 of file LALFrStreamLegacy.c.

◆ LALFrClose()

void LALFrClose ( LALStatus status,
LALFrStream **  stream 
)

Definition at line 73 of file LALFrStreamLegacy.c.

◆ LALFrSeek()

void LALFrSeek ( LALStatus status,
const LIGOTimeGPS epoch,
LALFrStream stream 
)

Definition at line 84 of file LALFrStreamLegacy.c.

◆ LALFrGetINT2TimeSeries()

void LALFrGetINT2TimeSeries ( LALStatus status,
INT2TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetINT2TimeSeriesMetadata()

void LALFrGetINT2TimeSeriesMetadata ( LALStatus status,
INT2TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetINT4TimeSeries()

void LALFrGetINT4TimeSeries ( LALStatus status,
INT4TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetINT4TimeSeriesMetadata()

void LALFrGetINT4TimeSeriesMetadata ( LALStatus status,
INT4TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetINT8TimeSeries()

void LALFrGetINT8TimeSeries ( LALStatus status,
INT8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetINT8TimeSeriesMetadata()

void LALFrGetINT8TimeSeriesMetadata ( LALStatus status,
INT8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetREAL4TimeSeries()

void LALFrGetREAL4TimeSeries ( LALStatus status,
REAL4TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetREAL4TimeSeriesMetadata()

void LALFrGetREAL4TimeSeriesMetadata ( LALStatus status,
REAL4TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetREAL8TimeSeries()

void LALFrGetREAL8TimeSeries ( LALStatus status,
REAL8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetREAL8TimeSeriesMetadata()

void LALFrGetREAL8TimeSeriesMetadata ( LALStatus status,
REAL8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetCOMPLEX8TimeSeries()

void LALFrGetCOMPLEX8TimeSeries ( LALStatus status,
COMPLEX8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetCOMPLEX8TimeSeriesMetadata()

void LALFrGetCOMPLEX8TimeSeriesMetadata ( LALStatus status,
COMPLEX8TimeSeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrGetCOMPLEX8FrequencySeries()

void LALFrGetCOMPLEX8FrequencySeries ( LALStatus status,
COMPLEX8FrequencySeries series,
FrChanIn chanin,
LALFrStream stream 
)

◆ LALFrWriteINT4TimeSeries()

void LALFrWriteINT4TimeSeries ( LALStatus status,
INT4TimeSeries series,
FrOutPar params 
)

◆ LALFrWriteREAL4TimeSeries()

void LALFrWriteREAL4TimeSeries ( LALStatus status,
REAL4TimeSeries series,
FrOutPar params 
)