LALFrame 3.0.7.1-eeff03c
LALFrameUFrameL.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2014 Jolien Creighton
3*
4* This program is free software; you can redistribute it and/or modify
5* it under the terms of the GNU General Public License as published by
6* the Free Software Foundation; either version 2 of the License, or
7* (at your option) any later version.
8*
9* This program is distributed in the hope that it will be useful,
10* but WITHOUT ANY WARRANTY; without even the implied warranty of
11* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12* GNU General Public License for more details.
13*
14* You should have received a copy of the GNU General Public License
15* along with with program; see the file COPYING. If not, write to the
16* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17* MA 02110-1301 USA
18*/
19
20#ifndef _LALFRAMEUFRAMEL_H
21#define _LALFRAMEUFRAMEL_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26#if 0
27}
28#endif
29void XLALFrameUFrFileClose_FrameL_(LALFrameUFrFile * stream);
30LALFrameUFrFile *XLALFrameUFrFileOpen_FrameL_(const char *filename, const char *mode);
31int XLALFrameUFileCksumValid_FrameL_(LALFrameUFrFile * stream);
33LALFrameUFrTOC *XLALFrameUFrTOCRead_FrameL_(LALFrameUFrFile * stream);
35double XLALFrameUFrTOCQueryGTimeModf_FrameL_(double *iptr, const LALFrameUFrTOC * toc, size_t pos);
36double XLALFrameUFrTOCQueryDt_FrameL_(const LALFrameUFrTOC * toc, size_t pos);
38const char *XLALFrameUFrTOCQueryAdcName_FrameL_(const LALFrameUFrTOC * toc, size_t adc);
40const char *XLALFrameUFrTOCQuerySimName_FrameL_(const LALFrameUFrTOC * toc, size_t sim);
42const char *XLALFrameUFrTOCQueryProcName_FrameL_(const LALFrameUFrTOC * toc, size_t proc);
44const char *XLALFrameUFrTOCQueryDetectorName_FrameL_(const LALFrameUFrTOC * toc, size_t det);
46LALFrameUFrameH *XLALFrameUFrameHAlloc_FrameL_(const char *name, double start1, double start2, double dt, int frnum);
47LALFrameUFrameH *XLALFrameUFrameHRead_FrameL_(LALFrameUFrFile * stream, int pos);
48int XLALFrameUFrameHWrite_FrameL_(LALFrameUFrFile * stream, LALFrameUFrameH * frame);
49int XLALFrameUFrameHFrChanAdd_FrameL_(LALFrameUFrameH * frame, LALFrameUFrChan * channel);
50int XLALFrameUFrameHFrDetectorAdd_FrameL_(LALFrameUFrameH * frame, LALFrameUFrDetector * detector);
52const char *XLALFrameUFrameHQueryName_FrameL_(const LALFrameUFrameH * frame);
56double XLALFrameUFrameHQueryGTimeModf_FrameL_(double *iptr, const LALFrameUFrameH * frame);
60void XLALFrameUFrChanFree_FrameL_(LALFrameUFrChan * channel);
61LALFrameUFrChan *XLALFrameUFrChanRead_FrameL_(LALFrameUFrFile * stream, const char *name, size_t pos);
62LALFrameUFrChan *XLALFrameUFrAdcChanAlloc_FrameL_(const char *name, int dtype, size_t ndata);
63LALFrameUFrChan *XLALFrameUFrSimChanAlloc_FrameL_(const char *name, int dtype, size_t ndata);
64LALFrameUFrChan *XLALFrameUFrProcChanAlloc_FrameL_(const char *name, int type, int subtype, int dtype, size_t ndata);
65const char *XLALFrameUFrChanQueryName_FrameL_(const LALFrameUFrChan * channel);
66double XLALFrameUFrChanQueryTimeOffset_FrameL_(const LALFrameUFrChan * channel);
67int XLALFrameUFrChanSetSampleRate_FrameL_(LALFrameUFrChan * channel, double sampleRate);
68int XLALFrameUFrChanSetTimeOffset_FrameL_(LALFrameUFrChan * channel, double timeOffset);
69int XLALFrameUFrChanSetTRange_FrameL_(LALFrameUFrChan * channel, double tRange);
70int XLALFrameUFrChanVectorAlloc_FrameL_(LALFrameUFrChan * channel, int dtype, size_t ndata);
71int XLALFrameUFrChanVectorCompress_FrameL_(LALFrameUFrChan * channel, int compressLevel);
73const char *XLALFrameUFrChanVectorQueryName_FrameL_(const LALFrameUFrChan * channel);
74int XLALFrameUFrChanVectorQueryCompress_FrameL_(const LALFrameUFrChan * channel);
75int XLALFrameUFrChanVectorQueryType_FrameL_(const LALFrameUFrChan * channel);
76void *XLALFrameUFrChanVectorQueryData_FrameL_(const LALFrameUFrChan * channel);
77size_t XLALFrameUFrChanVectorQueryNBytes_FrameL_(const LALFrameUFrChan * channel);
78size_t XLALFrameUFrChanVectorQueryNData_FrameL_(const LALFrameUFrChan * channel);
79size_t XLALFrameUFrChanVectorQueryNDim_FrameL_(const LALFrameUFrChan * channel);
80size_t XLALFrameUFrChanVectorQueryNx_FrameL_(const LALFrameUFrChan * channel, size_t dim);
81double XLALFrameUFrChanVectorQueryDx_FrameL_(const LALFrameUFrChan * channel, size_t dim);
82double XLALFrameUFrChanVectorQueryStartX_FrameL_(const LALFrameUFrChan * channel, size_t dim);
83const char *XLALFrameUFrChanVectorQueryUnitX_FrameL_(const LALFrameUFrChan * channel, size_t dim);
84const char *XLALFrameUFrChanVectorQueryUnitY_FrameL_(const LALFrameUFrChan * channel);
85int XLALFrameUFrChanVectorSetName_FrameL_(LALFrameUFrChan * channel, const char *name);
86int XLALFrameUFrChanVectorSetDx_FrameL_(LALFrameUFrChan * channel, double dx);
87int XLALFrameUFrChanVectorSetStartX_FrameL_(LALFrameUFrChan * channel, double x0);
88int XLALFrameUFrChanVectorSetUnitX_FrameL_(LALFrameUFrChan * channel, const char *unit);
89int XLALFrameUFrChanVectorSetUnitY_FrameL_(LALFrameUFrChan * channel, const char *unit);
90void XLALFrameUFrDetectorFree_FrameL_(LALFrameUFrDetector * detector);
91LALFrameUFrDetector *XLALFrameUFrDetectorRead_FrameL_(LALFrameUFrFile * stream, const char *name);
92LALFrameUFrDetector *XLALFrameUFrDetectorAlloc_FrameL_(const char *name, const char *prefix, double latitude, double longitude,
93 double elevation, double azimuthX, double azimuthY, double altitudeX, double altitudeY, double midpointX, double midpointY,
94 int localTime);
95const char *XLALFrameUFrDetectorQueryName_FrameL_(const LALFrameUFrDetector * detector);
96const char *XLALFrameUFrDetectorQueryPrefix_FrameL_(const LALFrameUFrDetector * detector);
97double XLALFrameUFrDetectorQueryLongitude_FrameL_(const LALFrameUFrDetector * detector);
98double XLALFrameUFrDetectorQueryLatitude_FrameL_(const LALFrameUFrDetector * detector);
99double XLALFrameUFrDetectorQueryElevation_FrameL_(const LALFrameUFrDetector * detector);
100double XLALFrameUFrDetectorQueryArmXAzimuth_FrameL_(const LALFrameUFrDetector * detector);
101double XLALFrameUFrDetectorQueryArmYAzimuth_FrameL_(const LALFrameUFrDetector * detector);
102double XLALFrameUFrDetectorQueryArmXAltitude_FrameL_(const LALFrameUFrDetector * detector);
103double XLALFrameUFrDetectorQueryArmYAltitude_FrameL_(const LALFrameUFrDetector * detector);
104double XLALFrameUFrDetectorQueryArmXMidpoint_FrameL_(const LALFrameUFrDetector * detector);
105double XLALFrameUFrDetectorQueryArmYMidpoint_FrameL_(const LALFrameUFrDetector * detector);
106int XLALFrameUFrDetectorQueryLocalTime_FrameL_(const LALFrameUFrDetector * detector);
108LALFrameUFrHistory *XLALFrameUFrHistoryAlloc_FrameL_(const char *name, double gpssec, const char *comment);
109
110#if 0
111{
112#endif
113#ifdef __cplusplus
114}
115#endif
116
117#endif /* _LALFRAMEUFRAMEL_H */
int XLALFrameUFrameHFrHistoryAdd_FrameL_(LALFrameUFrameH *frame, LALFrameUFrHistory *history)
Definition: LALFrameL.c:732
int XLALFrameUFrDetectorQueryLocalTime_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1570
LALFrameUFrameH * XLALFrameUFrameHRead_FrameL_(LALFrameUFrFile *stream, int pos)
Definition: LALFrameL.c:416
const char * XLALFrameUFrDetectorQueryPrefix_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1520
int XLALFrameUFrameHQueryRun_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:749
size_t XLALFrameUFrTOCQuerySimN_FrameL_(const LALFrameUFrTOC *toc)
Definition: LALFrameL.c:306
LALFrameUFrFile * XLALFrameUFrFileOpen_FrameL_(const char *filename, const char *mode)
Definition: LALFrameL.c:155
int XLALFrameUFrameHQueryDataQuality_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:759
void XLALFrameUFrHistoryFree_FrameL_(LALFrameUFrHistory *history)
Definition: LALFrameL.c:1579
void XLALFrameUFrTOCFree_FrameL_(LALFrameUFrTOC *toc)
int XLALFrameUFileCksumValid_FrameL_(LALFrameUFrFile *stream)
Definition: LALFrameL.c:220
const char * XLALFrameUFrTOCQuerySimName_FrameL_(const LALFrameUFrTOC *toc, size_t sim)
Definition: LALFrameL.c:316
int XLALFrameUFrChanVectorCompress_FrameL_(LALFrameUFrChan *channel, int compressLevel)
Definition: LALFrameL.c:1247
int XLALFrameUFrChanVectorQueryCompress_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1278
int XLALFrameUFrameHQueryULeapS_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:771
double XLALFrameUFrDetectorQueryLongitude_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1525
const char * XLALFrameUFrTOCQueryDetectorName_FrameL_(const LALFrameUFrTOC *toc, size_t det)
Definition: LALFrameL.c:360
const char * XLALFrameUFrChanVectorQueryUnitY_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1379
LALFrameUFrameH * XLALFrameUFrameHAlloc_FrameL_(const char *name, double start1, double start2, double dt, int frnum)
Definition: LALFrameL.c:382
const char * XLALFrameUFrChanVectorQueryName_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1269
size_t XLALFrameUFrTOCQueryNFrame_FrameL_(const LALFrameUFrTOC *toc)
Definition: LALFrameL.c:262
const char * XLALFrameUFrChanVectorQueryUnitX_FrameL_(const LALFrameUFrChan *channel, size_t dim)
Definition: LALFrameL.c:1367
int XLALFrameUFrChanVectorExpand_FrameL_(LALFrameUFrChan *channel)
Definition: LALFrameL.c:1258
double XLALFrameUFrameHQueryGTimeModf_FrameL_(double *iptr, const LALFrameUFrameH *frame)
Definition: LALFrameL.c:764
LALFrameUFrDetector * XLALFrameUFrDetectorRead_FrameL_(LALFrameUFrFile *stream, const char *name)
Definition: LALFrameL.c:1453
size_t XLALFrameUFrChanVectorQueryNData_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1315
int XLALFrameUFrameHFrDetectorAdd_FrameL_(LALFrameUFrameH *frame, LALFrameUFrDetector *detector)
Definition: LALFrameL.c:698
LALFrameUFrChan * XLALFrameUFrChanRead_FrameL_(LALFrameUFrFile *stream, const char *name, size_t pos)
Definition: LALFrameL.c:814
void * XLALFrameUFrChanVectorQueryData_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1297
void XLALFrameUFrDetectorFree_FrameL_(LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1444
size_t XLALFrameUFrTOCQueryDetectorN_FrameL_(const LALFrameUFrTOC *toc)
Definition: LALFrameL.c:350
double XLALFrameUFrDetectorQueryArmXAltitude_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1550
int XLALFrameUFrChanSetTRange_FrameL_(LALFrameUFrChan *channel, double tRange)
Definition: LALFrameL.c:1111
int XLALFrameUFrChanVectorSetUnitY_FrameL_(LALFrameUFrChan *channel, const char *unit)
Definition: LALFrameL.c:1398
size_t XLALFrameUFrChanVectorQueryNBytes_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1306
double XLALFrameUFrChanVectorQueryStartX_FrameL_(const LALFrameUFrChan *channel, size_t dim)
Definition: LALFrameL.c:1355
double XLALFrameUFrTOCQueryDt_FrameL_(const LALFrameUFrTOC *toc, size_t pos)
Definition: LALFrameL.c:277
double XLALFrameUFrDetectorQueryLatitude_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1530
int XLALFrameUFrChanVectorSetName_FrameL_(LALFrameUFrChan *channel, const char *name)
Definition: LALFrameL.c:1388
LALFrameUFrHistory * XLALFrameUFrHistoryAlloc_FrameL_(const char *name, double gpssec, const char *comment)
Definition: LALFrameL.c:1585
int XLALFrameUFrChanVectorSetStartX_FrameL_(LALFrameUFrChan *channel, double x0)
Definition: LALFrameL.c:1420
LALFrameUFrChan * XLALFrameUFrProcChanAlloc_FrameL_(const char *name, int type, int subtype, int dtype, size_t ndata)
Definition: LALFrameL.c:1030
double XLALFrameUFrTOCQueryGTimeModf_FrameL_(double *iptr, const LALFrameUFrTOC *toc, size_t pos)
Definition: LALFrameL.c:267
int XLALFrameUFrChanVectorSetDx_FrameL_(LALFrameUFrChan *channel, double dx)
Definition: LALFrameL.c:1410
int XLALFrameUFrameHSetRun_FrameL_(LALFrameUFrameH *frame, int run)
Definition: LALFrameL.c:783
int XLALFrameUFrameHQueryFrame_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:754
LALFrameUFrChan * XLALFrameUFrSimChanAlloc_FrameL_(const char *name, int dtype, size_t ndata)
Definition: LALFrameL.c:1025
const char * XLALFrameUFrDetectorQueryName_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1514
size_t XLALFrameUFrTOCQueryProcN_FrameL_(const LALFrameUFrTOC *toc)
Definition: LALFrameL.c:328
double XLALFrameUFrChanVectorQueryDx_FrameL_(const LALFrameUFrChan *channel, size_t dim)
Definition: LALFrameL.c:1344
int XLALFrameUFrameHFrChanAdd_FrameL_(LALFrameUFrameH *frame, LALFrameUFrChan *channel)
Definition: LALFrameL.c:665
double XLALFrameUFrDetectorQueryArmXMidpoint_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1560
double XLALFrameUFrChanQueryTimeOffset_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1060
double XLALFrameUFrDetectorQueryArmYAzimuth_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1545
size_t XLALFrameUFrChanVectorQueryNDim_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1324
int XLALFrameUFrameHWrite_FrameL_(LALFrameUFrFile *stream, LALFrameUFrameH *frame)
Definition: LALFrameL.c:443
LALFrameUFrDetector * XLALFrameUFrDetectorAlloc_FrameL_(const char *name, const char *prefix, double latitude, double longitude, double elevation, double azimuthX, double azimuthY, double altitudeX, double altitudeY, double midpointX, double midpointY, int localTime)
Definition: LALFrameL.c:1477
int XLALFrameUFrChanVectorQueryType_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1287
int XLALFrameUFrChanSetTimeOffset_FrameL_(LALFrameUFrChan *channel, double timeOffset)
Definition: LALFrameL.c:1092
void XLALFrameUFrFileClose_FrameL_(LALFrameUFrFile *stream)
Definition: LALFrameL.c:144
LALFrameUFrChan * XLALFrameUFrAdcChanAlloc_FrameL_(const char *name, int dtype, size_t ndata)
Definition: LALFrameL.c:1020
LALFrameUFrTOC * XLALFrameUFrTOCRead_FrameL_(LALFrameUFrFile *stream)
Definition: LALFrameL.c:257
double XLALFrameUFrDetectorQueryArmYAltitude_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1555
double XLALFrameUFrDetectorQueryArmYMidpoint_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1565
const char * XLALFrameUFrameHQueryName_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:744
size_t XLALFrameUFrTOCQueryAdcN_FrameL_(const LALFrameUFrTOC *toc)
Definition: LALFrameL.c:284
double XLALFrameUFrameHQueryDt_FrameL_(const LALFrameUFrameH *frame)
Definition: LALFrameL.c:776
int XLALFrameUFrChanSetSampleRate_FrameL_(LALFrameUFrChan *channel, double sampleRate)
Definition: LALFrameL.c:1077
size_t XLALFrameUFrChanVectorQueryNx_FrameL_(const LALFrameUFrChan *channel, size_t dim)
Definition: LALFrameL.c:1333
const char * XLALFrameUFrChanQueryName_FrameL_(const LALFrameUFrChan *channel)
Definition: LALFrameL.c:1043
void XLALFrameUFrChanFree_FrameL_(LALFrameUFrChan *channel)
Definition: LALFrameL.c:793
const char * XLALFrameUFrTOCQueryProcName_FrameL_(const LALFrameUFrTOC *toc, size_t proc)
Definition: LALFrameL.c:338
double XLALFrameUFrDetectorQueryArmXAzimuth_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1540
double XLALFrameUFrDetectorQueryElevation_FrameL_(const LALFrameUFrDetector *detector)
Definition: LALFrameL.c:1535
int XLALFrameUFrChanVectorAlloc_FrameL_(LALFrameUFrChan *channel, int dtype, size_t ndata)
Definition: LALFrameL.c:1129
int XLALFrameUFrChanVectorSetUnitX_FrameL_(LALFrameUFrChan *channel, const char *unit)
Definition: LALFrameL.c:1430
const char * XLALFrameUFrTOCQueryAdcName_FrameL_(const LALFrameUFrTOC *toc, size_t adc)
Definition: LALFrameL.c:294
void XLALFrameUFrameHFree_FrameL_(LALFrameUFrameH *frame)
Definition: LALFrameL.c:376
struct tagLALFrameUFrameH LALFrameUFrameH
Incomplete type for a frame header FrameH structure.
Definition: LALFrameU.h:64
struct tagLALFrameUFrHistory LALFrameUFrHistory
Incomplete type for a history data FrHistory structure.
Definition: LALFrameU.h:105
struct tagLALFrameUFrTOC LALFrameUFrTOC
Incomplete type for a table of contents FrTOC structure.
Definition: LALFrameU.h:78
double dt
Definition: stream.c:110
char * channel
Definition: stream.c:108