Provides a unified low-level interface to frame libraries.
- Author
- Jolien Creighton
This provides a unified interface for reading and writing data files in the "Frame Format for Interferometric Gravitational Wave Detectors".
- See also
- Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Virgo Frame Library [http://lappweb.in2p3.fr/virgo/FrameL].
-
FrameCPP Library [http://www.ldas-sw.ligo.caltech.edu/doc/framecpp/html].
|
| enum | LALFrameUFrVectCompressionScheme {
LAL_FRAMEU_FR_VECT_COMPRESS_RAW = 0
, LAL_FRAMEU_FR_VECT_COMPRESS_GZIP = 1
, LAL_FRAMEU_FR_VECT_COMPRESS_DIFF_GZIP = 3
, LAL_FRAMEU_FR_VECT_COMPRESS_ZERO_SUPPRESS_WORD_2 = 5
,
LAL_FRAMEU_FR_VECT_COMPRESS_ZERO_SUPPRESS_WORD_4 = 8
} |
| | Compression scheme codes. More...
|
| |
| enum | LALFrameUFrVectDataType {
LAL_FRAMEU_FR_VECT_C = 0
, LAL_FRAMEU_FR_VECT_2S = 1
, LAL_FRAMEU_FR_VECT_8R = 2
, LAL_FRAMEU_FR_VECT_4R = 3
,
LAL_FRAMEU_FR_VECT_4S = 4
, LAL_FRAMEU_FR_VECT_8S = 5
, LAL_FRAMEU_FR_VECT_8C = 6
, LAL_FRAMEU_FR_VECT_16C = 7
,
LAL_FRAMEU_FR_VECT_STRING = 8
, LAL_FRAMEU_FR_VECT_2U = 9
, LAL_FRAMEU_FR_VECT_4U = 10
, LAL_FRAMEU_FR_VECT_8U = 11
,
LAL_FRAMEU_FR_VECT_1U = 12
} |
| | FrVect data type codes. More...
|
| |
| enum | LALFrameUFrProcDataType {
LAL_FRAMEU_FR_PROC_TYPE_UNKNOWN = 0
, LAL_FRAMEU_FR_PROC_TYPE_TIME_SERIES = 1
, LAL_FRAMEU_FR_PROC_TYPE_FREQUENCY_SERIES = 2
, LAL_FRAMEU_FR_PROC_TYPE_OTHER_1D_SERIES = 3
,
LAL_FRAMEU_FR_PROC_TYPE_TIME_FREQUENCY = 4
, LAL_FRAMEU_FR_PROC_TYPE_WAVELET = 5
, LAL_FRAMEU_FR_PROC_TYPE_MULTI_DIMENSIONAL = 6
} |
| | FrProcData type codes. More...
|
| |
| enum | LALFrameUFrProcDataSubType {
LAL_FRAMEU_FR_PROC_SUB_TYPE_UNKNOWN = 0
, LAL_FRAMEU_FR_PROC_SUB_TYPE_DFT = 1
, LAL_FRAMEU_FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY = 2
, LAL_FRAMEU_FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY = 3
,
LAL_FRAMEU_FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY = 4
, LAL_FRAMEU_FR_PROC_SUB_TYPE_COHERENCE = 5
, LAL_FRAMEU_FR_PROC_SUB_TYPE_TRANSFER_FUNCTION = 6
} |
| | FrProcData subtype codes for frequency series. More...
|
| |
|
| void | XLALFrameUFrChanFree (LALFrameUFrChan *channel) |
| | Free a FrChan structure. More...
|
| |
| LALFrameUFrChan * | XLALFrameUFrChanRead (LALFrameUFrFile *stream, const char *name, size_t pos) |
| | Read a channel FrChan structure from a FrFile stream. More...
|
| |
| LALFrameUFrChan * | XLALFrameUFrAdcChanAlloc (const char *name, int dtype, size_t ndata) |
| | Allocate memory for a new FrChan structure of FrAdcData type. More...
|
| |
| LALFrameUFrChan * | XLALFrameUFrSimChanAlloc (const char *name, int dtype, size_t ndata) |
| | Allocate memory for a new FrChan structure of FrSimData type. More...
|
| |
| LALFrameUFrChan * | XLALFrameUFrProcChanAlloc (const char *name, int type, int subtype, int dtype, size_t ndata) |
| | Allocate memory for a new FrChan structure of FrAdcData type. More...
|
| |
|
| void | XLALFrameUFrDetectorFree (LALFrameUFrDetector *detector) |
| | Free a FrDetector structure. More...
|
| |
| LALFrameUFrDetector * | XLALFrameUFrDetectorRead (LALFrameUFrFile *stream, const char *name) |
| | Read a detector FrDetector structure from a FrFile stream. More...
|
| |
| LALFrameUFrDetector * | XLALFrameUFrDetectorAlloc (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) |
| | Allocate memory for a new detector FrDetector structure. More...
|
| |
◆ XLALFrameUFrFileClose()
| void XLALFrameUFrFileClose |
( |
LALFrameUFrFile * |
stream | ) |
|
Close a FrFile stream.
- Parameters
-
| stream | Pointer to the FrFile stream to close. |
Definition at line 125 of file LALFrameU.c.
◆ XLALFrameUFrFileOpen()
| LALFrameUFrFile * XLALFrameUFrFileOpen |
( |
const char * |
filename, |
|
|
const char * |
mode |
|
) |
| |
Open a frame file FrFile stream.
- Parameters
-
| filename | Filename of frame file to open. |
| mode | Access mode: either "r" for read or "w" for write. |
- Returns
- Pointer to a FrFile stream.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrFileClose().
Definition at line 130 of file LALFrameU.c.
◆ XLALFrameUFileCksumValid()
| int XLALFrameUFileCksumValid |
( |
LALFrameUFrFile * |
stream | ) |
|
Use checksum to determine if FrFile stream is valid.
- Parameters
-
| stream | Pointer to the FrFile stream to check. |
- Warning
- Pointers to FrTOC might be left dangling by this function.
- Returns
- Logical value indicating if the FrFile stream checksum is correct.
- Return values
-
| 1 | The FrFile stream is valid. |
| 0 | The FrFile stream has an incorrect checksum or an error occurred. |
Definition at line 135 of file LALFrameU.c.
◆ XLALFrameUFrTOCFree()
Free a FrTOC structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to free. |
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 140 of file LALFrameU.c.
◆ XLALFrameUFrTOCRead()
Read the table of contents FrTOC structure for a FrFile stream.
- Parameters
-
| stream | Pointer to the input FrFile stream from which to read FrTOC. |
- Returns
- Pointer to the FrTOC structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrTOCFree().
- Warning
- The pointer returned might be shallow and might be left dangling if the stream is closed or reopened. The FrTOC structure should be freed before calling XLALFrameUFrFileClose() or XLALFrameUFileCksumValid().
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 145 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryNFrame()
Query FrTOC structure for number of FrameH structures contained.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
- Returns
- Number of FrameH structures contained.
- Return values
-
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 150 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryGTimeModf()
| double XLALFrameUFrTOCQueryGTimeModf |
( |
double * |
iptr, |
|
|
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
pos |
|
) |
| |
Query FrTOC structure for start time of a FrameH structure.
- Parameters
-
| iptr | Pointer to the integer number of seconds of the GPS start time. |
| toc | Pointer to the FrTOC structure to be queried. |
| pos | Index position of the FrameH structure. |
- Returns
- Fractional part of the GPS start time.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 155 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryDt()
| double XLALFrameUFrTOCQueryDt |
( |
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
pos |
|
) |
| |
Query FrTOC structure for duration of a FrameH structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
| pos | Index position of the FrameH structure. |
- Returns
- Duration of the frame in seconds.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 160 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryAdcN()
Query FrTOC structure for number of FrAdcData structures.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
- Returns
- Number of FrAdcData structures.
- Return values
-
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 165 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryAdcName()
| const char * XLALFrameUFrTOCQueryAdcName |
( |
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
adc |
|
) |
| |
Query FrTOC structure for the name of a FrAdcData structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
| adc | Index position of the FrAdcData structure. |
- Returns
- Pointer to string with the name of the FrAdcData structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrTOC structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 170 of file LALFrameU.c.
◆ XLALFrameUFrTOCQuerySimN()
Query FrTOC structure for number of FrSimData structures.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
- Returns
- Number of FrSimData structures.
- Return values
-
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 175 of file LALFrameU.c.
◆ XLALFrameUFrTOCQuerySimName()
| const char * XLALFrameUFrTOCQuerySimName |
( |
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
sim |
|
) |
| |
Query FrTOC structure for the name of a FrSimData structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
| sim | Index position of the FrSimData structure. |
- Returns
- Pointer to string with the name of the FrSimData structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrTOC structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 180 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryProcN()
Query FrTOC structure for number of FrProcData structures.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
- Returns
- Number of FrProcData structures.
- Return values
-
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 185 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryProcName()
| const char * XLALFrameUFrTOCQueryProcName |
( |
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
proc |
|
) |
| |
Query FrTOC structure for the name of a FrProcData structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
| proc | Index position of the FrProcData structure. |
- Returns
- Pointer to string with the name of the FrProcData structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrTOC structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 190 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryDetectorN()
Query FrTOC structure for number of FrDetector structures.
- Returns
- Number of FrDetector structures.
- Return values
-
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 195 of file LALFrameU.c.
◆ XLALFrameUFrTOCQueryDetectorName()
| const char * XLALFrameUFrTOCQueryDetectorName |
( |
const LALFrameUFrTOC * |
toc, |
|
|
size_t |
det |
|
) |
| |
Query FrTOC structure for the name of a FrDetector structure.
- Parameters
-
| toc | Pointer to the FrTOC structure to be queried. |
| det | Index position of the FrDetector structure. |
- Returns
- Pointer to string with the name of the FrDetector structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrTOC structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 200 of file LALFrameU.c.
◆ XLALFrameUFrameHFree()
Free a FrameH structure.
- Parameters
-
| frame | Pointer to the FrameH structure to free. |
Definition at line 205 of file LALFrameU.c.
◆ XLALFrameUFrameHAlloc()
| LALFrameUFrameH * XLALFrameUFrameHAlloc |
( |
const char * |
name, |
|
|
double |
start1, |
|
|
double |
start2, |
|
|
double |
dt, |
|
|
int |
frnum |
|
) |
| |
Allocate memory for a new frame header FrameH structure.
- Parameters
-
| name | Name for this FrameH structure. |
| start1 | First of two double precision floating point numbers specifying the GPS start time in seconds for this FrameH structure (to be added to start2). |
| start2 | Second of two double precision floating point numbers GPS start time in seconds for this FrameH structure (to be added to start1). |
| dt | Duration in seconds for this FrameH structure. |
| frnum | Number for this FrameH structure. |
- Returns
- Pointer to a new FrameH structure.
- Return values
-
- Note
- To maintain precision, the start time is broken into two double precision floating point values, start1 and start2, which, when added together is the GPS start time in seconds.
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrameHFree().
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 210 of file LALFrameU.c.
◆ XLALFrameUFrameHRead()
| LALFrameUFrameH * XLALFrameUFrameHRead |
( |
LALFrameUFrFile * |
stream, |
|
|
int |
pos |
|
) |
| |
Read a frame header FrameH structure from a FrFile stream.
- Parameters
-
| stream | Pointer to the input FrFile stream. |
| pos | Index position of the FrameH structure to read. |
- Returns
- Pointer to a frame header FrameH structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrameHFree().
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 215 of file LALFrameU.c.
◆ XLALFrameUFrameHWrite()
| int XLALFrameUFrameHWrite |
( |
LALFrameUFrFile * |
stream, |
|
|
LALFrameUFrameH * |
frame |
|
) |
| |
Write a FrameH structure to an output FrFile stream.
- Parameters
-
| stream | Pointer to the output FrFile stream. |
| frame | Pointer to the FrameH structure to be written. |
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 220 of file LALFrameU.c.
◆ XLALFrameUFrameHFrChanAdd()
| int XLALFrameUFrameHFrChanAdd |
( |
LALFrameUFrameH * |
frame, |
|
|
LALFrameUFrChan * |
channel |
|
) |
| |
Add a FrChan structure to a FrameH structure.
- Parameters
-
| frame | Pointer to the FrameH structure. |
| channel | Pointer to the FrChan structure to be written. |
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 225 of file LALFrameU.c.
◆ XLALFrameUFrameHFrDetectorAdd()
| int XLALFrameUFrameHFrDetectorAdd |
( |
LALFrameUFrameH * |
frame, |
|
|
LALFrameUFrDetector * |
detector |
|
) |
| |
Add a FrDetector structure to a FrameH structure.
- Parameters
-
| frame | Pointer to the FrameH structure. |
| detector | Pointer to the FrDetector structure to be written. |
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 230 of file LALFrameU.c.
◆ XLALFrameUFrameHFrHistoryAdd()
Add a FrHistory structure to a FrameH structure.
- Parameters
-
| frame | Pointer to the FrameH structure. |
| history | Pointer to the FrHistory structure to be written. |
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 235 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryName()
Query FrameH structure for its name.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- Pointer to string with the name of the FrameH structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrameH structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 240 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryRun()
Query FrameH structure for the run number.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- The run number associated with the FrameH structure.
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 245 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryFrame()
Query FrameH structure for the frame number.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- The frame number associated with the FrameH structure.
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 250 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryDataQuality()
Query FrameH structure for the data quality word.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- The 32-bit data quality word expressed as an int type.
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 255 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryGTimeModf()
| double XLALFrameUFrameHQueryGTimeModf |
( |
double * |
iptr, |
|
|
const LALFrameUFrameH * |
frame |
|
) |
| |
Query FrameH structure for the start time.
- Parameters
-
| iptr | Pointer to the integer number of seconds of the GPS start time. |
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- Fractional part of the GPS start time.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 260 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryULeapS()
Query FrameH structure for the number of leap seconds.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- The number of leap seconds (TAI-UTC).
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 265 of file LALFrameU.c.
◆ XLALFrameUFrameHQueryDt()
Query FrameH structure for the duration.
- Parameters
-
| frame | Pointer to the FrameH structure to be queried. |
- Returns
- The duration of the FrameH structure in seconds.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 270 of file LALFrameU.c.
◆ XLALFrameUFrameHSetRun()
Set the run number in a FrameH structure.
- Parameters
-
| frame | Pointer to the FrameH structure to be modified. |
| run | The value of the run number to be set. |
- Return values
-
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 275 of file LALFrameU.c.
◆ XLALFrameUFrChanFree()
| void XLALFrameUFrChanFree |
( |
LALFrameUFrChan * |
channel | ) |
|
Free a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to free. |
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 280 of file LALFrameU.c.
◆ XLALFrameUFrChanRead()
| LALFrameUFrChan * XLALFrameUFrChanRead |
( |
LALFrameUFrFile * |
stream, |
|
|
const char * |
name, |
|
|
size_t |
pos |
|
) |
| |
Read a channel FrChan structure from a FrFile stream.
- Parameters
-
| stream | Pointer to the input FrFile stream. |
| name | Name of the FrChan structure to be read. |
| pos | Index position of the FrameH structure containing the FrChan. |
- Returns
- Pointer to a channel FrChan structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrChanFree().
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 285 of file LALFrameU.c.
◆ XLALFrameUFrAdcChanAlloc()
| LALFrameUFrChan * XLALFrameUFrAdcChanAlloc |
( |
const char * |
name, |
|
|
int |
dtype, |
|
|
size_t |
ndata |
|
) |
| |
Allocate memory for a new FrChan structure of FrAdcData type.
- Parameters
-
| name | Name for this FrChan structure. |
| dtype | Data type code given in LALFrameUFrVectDataType. |
| ndata | Number of data points contained in this FrChan structure. |
- Returns
- Pointer to a new FrChan structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrChanFree().
- See also
- Sections 4.3.2.4 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 290 of file LALFrameU.c.
◆ XLALFrameUFrSimChanAlloc()
| LALFrameUFrChan * XLALFrameUFrSimChanAlloc |
( |
const char * |
name, |
|
|
int |
dtype, |
|
|
size_t |
ndata |
|
) |
| |
Allocate memory for a new FrChan structure of FrSimData type.
- Parameters
-
| name | Name for this FrChan structure. |
| dtype | Data type code given in LALFrameUFrVectDataType. |
| ndata | Number of data points contained in this FrChan structure. |
- Returns
- Pointer to a new FrChan structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrChanFree().
- See also
- Sections 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 295 of file LALFrameU.c.
◆ XLALFrameUFrProcChanAlloc()
| LALFrameUFrChan * XLALFrameUFrProcChanAlloc |
( |
const char * |
name, |
|
|
int |
type, |
|
|
int |
subtype, |
|
|
int |
dtype, |
|
|
size_t |
ndata |
|
) |
| |
Allocate memory for a new FrChan structure of FrAdcData type.
- Parameters
-
- Returns
- Pointer to a new FrChan structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrChanFree().
- See also
- Sections 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 300 of file LALFrameU.c.
◆ XLALFrameUFrChanQueryName()
| const char * XLALFrameUFrChanQueryName |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for its name.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- Pointer to string with the name of the FrChan structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrChan structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 305 of file LALFrameU.c.
◆ XLALFrameUFrChanQueryTimeOffset()
| double XLALFrameUFrChanQueryTimeOffset |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for time offset for this channel.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The offset of the first sample relative to the frame start time in seconds.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 310 of file LALFrameU.c.
◆ XLALFrameUFrChanSetSampleRate()
| int XLALFrameUFrChanSetSampleRate |
( |
LALFrameUFrChan * |
channel, |
|
|
double |
sampleRate |
|
) |
| |
Set the sample rate in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| sampleRate | The value of the sample rate in Hertz to be set. |
- Return values
-
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 315 of file LALFrameU.c.
◆ XLALFrameUFrChanSetTimeOffset()
| int XLALFrameUFrChanSetTimeOffset |
( |
LALFrameUFrChan * |
channel, |
|
|
double |
timeOffset |
|
) |
| |
Set the time offset in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| timeOffset | The offset of the first sample relative to the frame start time in seconds. |
- Return values
-
- See also
- Sections 4.3.2.4, 4.3.2.11, and 4.3.2.14 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 320 of file LALFrameU.c.
◆ XLALFrameUFrChanSetTRange()
| int XLALFrameUFrChanSetTRange |
( |
LALFrameUFrChan * |
channel, |
|
|
double |
tRange |
|
) |
| |
Set the time range in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| tRange | The duration of sampled data in seconds. |
- Return values
-
- See also
- Section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 325 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorAlloc()
| int XLALFrameUFrChanVectorAlloc |
( |
LALFrameUFrChan * |
channel, |
|
|
int |
dtype, |
|
|
size_t |
ndata |
|
) |
| |
Allocate memory for a FrVect structure within a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| dtype | Data type code given in LALFrameUFrVectDataType. |
| ndata | Number of data points contained the FrVect structure. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 330 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorCompress()
| int XLALFrameUFrChanVectorCompress |
( |
LALFrameUFrChan * |
channel, |
|
|
int |
compressLevel |
|
) |
| |
Compress a FrVect structure within a FrChan structure.
- Parameters
-
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 335 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorExpand()
| int XLALFrameUFrChanVectorExpand |
( |
LALFrameUFrChan * |
channel | ) |
|
Expands a FrVect structure within a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 340 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryName()
| const char * XLALFrameUFrChanVectorQueryName |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the name of its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- Pointer to string with the name of the FrVect structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrChan structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 345 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryCompress()
| int XLALFrameUFrChanVectorQueryCompress |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the compression scheme of its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The compression scheme of the FrVect structure as given in LALFrameUFrVectCompressionScheme.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 350 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryType()
| int XLALFrameUFrChanVectorQueryType |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the data type of its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The data type of the FrVect structure as given in LALFrameUFrVectDataType.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 355 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryData()
| void * XLALFrameUFrChanVectorQueryData |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the data pointer in its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- Pointer to the data in the FrVect structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrChan structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 360 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryNBytes()
| size_t XLALFrameUFrChanVectorQueryNBytes |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the number of bytes of data in its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The number of bytes of data in the FrVect structure.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 365 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryNData()
| size_t XLALFrameUFrChanVectorQueryNData |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the number of points of data in its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The number of bytes of data in the FrVect structure.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 370 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryNDim()
| size_t XLALFrameUFrChanVectorQueryNDim |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for the number of dimensions of the multi-dimensional data in its FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- The number of dimensions of the data in the FrVect structure.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 375 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryNx()
| size_t XLALFrameUFrChanVectorQueryNx |
( |
const LALFrameUFrChan * |
channel, |
|
|
size_t |
dim |
|
) |
| |
Query FrChan structure for the number of points in the dim dimension of the multi-dimensional data in the FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
| dim | The dimension of the multi-dimensional data. |
- Returns
- The number of points in the dim dimension of the data in the FrVect structure.
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 380 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryDx()
| double XLALFrameUFrChanVectorQueryDx |
( |
const LALFrameUFrChan * |
channel, |
|
|
size_t |
dim |
|
) |
| |
Query FrChan structure for the sampling interval in the dim dimension of the multi-dimensional data in the FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
| dim | The dimension of the multi-dimensional data. |
- Returns
- The sampling interval in the dim dimension of the data in the FrVect structure.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 385 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryStartX()
| double XLALFrameUFrChanVectorQueryStartX |
( |
const LALFrameUFrChan * |
channel, |
|
|
size_t |
dim |
|
) |
| |
Query FrChan structure for the starting value of the dim dimension of the multi-dimensional data in the FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
| dim | The dimension of the multi-dimensional data. |
- Returns
- The starting value of the dim dimension of the data in the FrVect structure.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 390 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryUnitX()
| const char * XLALFrameUFrChanVectorQueryUnitX |
( |
const LALFrameUFrChan * |
channel, |
|
|
size_t |
dim |
|
) |
| |
Query FrChan structure for the units of the domain of the dim dimension of the multi-dimensional data in the FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
| dim | The dimension of the multi-dimensional data. |
- Returns
- Pointer to a string containing the units of the domain of the dim dimension of the data in the FrVect structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrChan structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 395 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorQueryUnitY()
| const char * XLALFrameUFrChanVectorQueryUnitY |
( |
const LALFrameUFrChan * |
channel | ) |
|
Query FrChan structure for sample units of the data in the FrVect structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be queried. |
- Returns
- Pointer to a string containing the sample units of the data in the FrVect structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrChan structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 400 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorSetName()
| int XLALFrameUFrChanVectorSetName |
( |
LALFrameUFrChan * |
channel, |
|
|
const char * |
name |
|
) |
| |
Set the name of the FrVect structure contained in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| name | Pointer to a string with the name for the FrVect structure. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 405 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorSetDx()
| int XLALFrameUFrChanVectorSetDx |
( |
LALFrameUFrChan * |
channel, |
|
|
double |
dx |
|
) |
| |
Set the sampling interval for the data in the FrVect structure contained in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| dx | The sampling interval for the data. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 410 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorSetStartX()
| int XLALFrameUFrChanVectorSetStartX |
( |
LALFrameUFrChan * |
channel, |
|
|
double |
x0 |
|
) |
| |
Set the starting value for the domain of the data in the FrVect structure contained in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| x0 | The starting value for the domain of the data in the FrVect structure. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 415 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorSetUnitX()
| int XLALFrameUFrChanVectorSetUnitX |
( |
LALFrameUFrChan * |
channel, |
|
|
const char * |
unit |
|
) |
| |
Set the units of the domain of the data in the FrVect structure contained in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| unit | Pointer to a string containing the units of the domain of the data in the FrVect structure. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 420 of file LALFrameU.c.
◆ XLALFrameUFrChanVectorSetUnitY()
| int XLALFrameUFrChanVectorSetUnitY |
( |
LALFrameUFrChan * |
channel, |
|
|
const char * |
unit |
|
) |
| |
Set the units of the data in the FrVect structure contained in a FrChan structure.
- Parameters
-
| channel | Pointer to the FrChan structure to be modified. |
| unit | Pointer to a string containing the units of the data in the FrVect structure. |
- Return values
-
- See also
- Sections 4.3.2.20 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 425 of file LALFrameU.c.
◆ XLALFrameUFrDetectorFree()
| void XLALFrameUFrDetectorFree |
( |
LALFrameUFrDetector * |
detector | ) |
|
Free a FrDetector structure.
- Parameters
-
| detector | Pointer to the FrDetector structure to free. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 430 of file LALFrameU.c.
◆ XLALFrameUFrDetectorRead()
| LALFrameUFrDetector * XLALFrameUFrDetectorRead |
( |
LALFrameUFrFile * |
stream, |
|
|
const char * |
name |
|
) |
| |
Read a detector FrDetector structure from a FrFile stream.
- Parameters
-
| stream | Pointer to the input FrFile stream. |
| name | Name of the FrDetector structure to be read. |
- Returns
- Pointer to a detector FrDetector structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrDetectorFree().
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 435 of file LALFrameU.c.
◆ XLALFrameUFrDetectorAlloc()
| LALFrameUFrDetector * XLALFrameUFrDetectorAlloc |
( |
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 |
|
) |
| |
Allocate memory for a new detector FrDetector structure.
- Parameters
-
| name | Name for this FrDetector structure. |
| prefix | UNDOCUMENTED |
| latitude | Latitude North of the equator of detector in radians. |
| longitude | Longitude East of Greenwich meridian of detector in radians. |
| elevation | Elevation of detector above WGS84 ellipsoid in meters. |
| azimuthX | Orientation of x-arm in radians East of North. |
| azimuthY | Orientation of y-arm in radians East of North. |
| altitudeX | Altitude (pitch) angle of x-arm in radians above horizaon (local tangent to WGS84 ellipsoid). |
| altitudeY | Altitude (pitch) angle of y-arm in radians above horizaon (local tangent to WGS84 ellipsoid). |
| midpointX | Distance in meters between detector vertex and the middle of the x-arm. |
| midpointY | Distance in meters between detector vertex and the middle of the y-arm. |
| localTime | Local seasonal time minus UTC in seconds. |
- Returns
- Pointer to a new FrDetector structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrDetectorFree().
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 440 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryName()
| const char * XLALFrameUFrDetectorQueryName |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector name.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- Pointer to string with the name of the FrDetector structure.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrDetector structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 448 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryPrefix()
| const char * XLALFrameUFrDetectorQueryPrefix |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector prefix.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- Pointer to string with the prefix of the detector.
- Return values
-
- Warning
- The pointer returned is shallow and will be left dangling when the FrDetector structure is freed. The calling routine should not attempt to free the returned pointer.
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 453 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryLongitude()
| double XLALFrameUFrDetectorQueryLongitude |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector longitude.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The detector longitude in radians East of the Greenwich meridian.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 458 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryLatitude()
| double XLALFrameUFrDetectorQueryLatitude |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector latitude.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The detector latitude in radians North of the equator.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 463 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryElevation()
| double XLALFrameUFrDetectorQueryElevation |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector elevation.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The detector elevation in meters relative to the WGS84 ellipsoid.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 468 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmXAzimuth()
| double XLALFrameUFrDetectorQueryArmXAzimuth |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector x-arm azimuth.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The orientation of the x-arm in radians East of North.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 473 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmYAzimuth()
| double XLALFrameUFrDetectorQueryArmYAzimuth |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector y-arm azimuth.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The orientation of the y-arm in radians East of North.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 478 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmXAltitude()
| double XLALFrameUFrDetectorQueryArmXAltitude |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector x-arm altitude.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The altitude (pitch) of the x-arm in radians above horizontal (local tangent to WGS84 ellipsoid).
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 483 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmYAltitude()
| double XLALFrameUFrDetectorQueryArmYAltitude |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector y-arm altitude.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The altitude (pitch) of the y-arm in radians above horizontal (local tangent to WGS84 ellipsoid).
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 488 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmXMidpoint()
| double XLALFrameUFrDetectorQueryArmXMidpoint |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector x-arm midpoint.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The distance in meters between the detector vertex and the midpoint of the x-arm.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 493 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryArmYMidpoint()
| double XLALFrameUFrDetectorQueryArmYMidpoint |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the detector y-arm midpoint.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The distance in meters between the detector vertex and the midpoint of the y-arm.
- Return values
-
| LAL_REAL8_FAIL_NAN | Failure. |
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 498 of file LALFrameU.c.
◆ XLALFrameUFrDetectorQueryLocalTime()
| int XLALFrameUFrDetectorQueryLocalTime |
( |
const LALFrameUFrDetector * |
detector | ) |
|
Query FrDetector structure for the local time offset at the detector.
- Parameters
-
| detector | Pointer to the FrDetector structure to be queried. |
- Returns
- The local seasonal time minus UTC in seconds.
- See also
- Section 4.3.2.5 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
-
Beam Pattern Response Functions and Times of Arrival for Earthbound Interferometer LIGO-T010110 [https://dcc.ligo.org/LIGO-T010110/public]
Definition at line 503 of file LALFrameU.c.
◆ XLALFrameUFrHistoryFree()
Free a FrHistory structure.
- Parameters
-
| history | Pointer to the FrHistory structure to free. |
- See also
- Section 4.3.2.9 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 508 of file LALFrameU.c.
◆ XLALFrameUFrHistoryAlloc()
| LALFrameUFrHistory * XLALFrameUFrHistoryAlloc |
( |
const char * |
name, |
|
|
double |
gpssec, |
|
|
const char * |
comment |
|
) |
| |
Allocate memory for a new detector FrHistory structure.
- Parameters
-
| name | Name for this FrDetector structure. |
| gpssec | Time stamp in GPS seconds for this FrHistory structure. |
| comment | History comment for this FrHistory structure. |
- Returns
- Pointer to a new FrHistory structure.
- Return values
-
- Attention
- The calling routine is responsible for freeing the returned pointer with XLALFrameUFrHistoryFree().
- See also
- Section 4.3.2.9 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 513 of file LALFrameU.c.
◆ LALFrameUFrameH
Incomplete type for a frame header FrameH structure.
- See also
- Section 4.3.2.3 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 64 of file LALFrameU.h.
◆ LALFrameUFrTOC
Incomplete type for a table of contents FrTOC structure.
- See also
- Section 4.3.2.19 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 78 of file LALFrameU.h.
◆ LALFrameUFrHistory
Incomplete type for a history data FrHistory structure.
- See also
- Section 4.3.2.9 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
Definition at line 105 of file LALFrameU.h.
◆ LALFrameUFrVectCompressionScheme
Compression scheme codes.
These compression scheme Id codes are from Appendix B of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
| Enumerator |
|---|
| LAL_FRAMEU_FR_VECT_COMPRESS_RAW | Id for uncompressed raw values.
|
| LAL_FRAMEU_FR_VECT_COMPRESS_GZIP | Id for gzip compression.
|
| LAL_FRAMEU_FR_VECT_COMPRESS_DIFF_GZIP | Id for gzip compression of differential values.
|
| LAL_FRAMEU_FR_VECT_COMPRESS_ZERO_SUPPRESS_WORD_2 | Id for differentiation and zero suppression for 2-byte word integer types only.
|
| LAL_FRAMEU_FR_VECT_COMPRESS_ZERO_SUPPRESS_WORD_4 | Id for differentiation and zero suppression for 4-byte word (integer or floating-point).
|
Definition at line 114 of file LALFrameU.h.
◆ LALFrameUFrVectDataType
FrVect data type codes.
These data type Id codes are from Appendix C of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
| Enumerator |
|---|
| LAL_FRAMEU_FR_VECT_C | Id for 8-bit signed char data type.
|
| LAL_FRAMEU_FR_VECT_2S | Id for 16-bit signed integer data type.
|
| LAL_FRAMEU_FR_VECT_8R | Id for 64-bit double precision floating point data type.
|
| LAL_FRAMEU_FR_VECT_4R | Id for 32-bit single precision floating point data type.
|
| LAL_FRAMEU_FR_VECT_4S | Id for 32-bit signed integer data type.
|
| LAL_FRAMEU_FR_VECT_8S | Id for 64-bit signed integer data type.
|
| LAL_FRAMEU_FR_VECT_8C | Id for 64-bit single precision complex data type.
|
| LAL_FRAMEU_FR_VECT_16C | Id for 128-bit double precision complex data type.
|
| LAL_FRAMEU_FR_VECT_STRING | Id for string data type.
|
| LAL_FRAMEU_FR_VECT_2U | Id for 16-bit unsigned integer data type.
|
| LAL_FRAMEU_FR_VECT_4U | Id for 32-bit unsigned integer data type.
|
| LAL_FRAMEU_FR_VECT_8U | Id for 64-bit unsigned integer data type.
|
| LAL_FRAMEU_FR_VECT_1U | Id for 8-bit unsigned char data type.
|
Definition at line 140 of file LALFrameU.h.
◆ LALFrameUFrProcDataType
FrProcData type codes.
These type codes are from section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
| Enumerator |
|---|
| LAL_FRAMEU_FR_PROC_TYPE_UNKNOWN | Id for unknown or user-defined data.
|
| LAL_FRAMEU_FR_PROC_TYPE_TIME_SERIES | Id for time-series data.
|
| LAL_FRAMEU_FR_PROC_TYPE_FREQUENCY_SERIES | Id for frequency-series data.
|
| LAL_FRAMEU_FR_PROC_TYPE_OTHER_1D_SERIES | Id for other one-dimensional series data.
|
| LAL_FRAMEU_FR_PROC_TYPE_TIME_FREQUENCY | Id for time-frequency data.
|
| LAL_FRAMEU_FR_PROC_TYPE_WAVELET | Id for wavelet data.
|
| LAL_FRAMEU_FR_PROC_TYPE_MULTI_DIMENSIONAL | Id for multi-dimensional data.
|
Definition at line 188 of file LALFrameU.h.
◆ LALFrameUFrProcDataSubType
FrProcData subtype codes for frequency series.
These type codes are from section 4.3.2.11 of Specification of a Common Data Frame Format for Interferometric Gravitational Wave Detectors (IGWD) LIGO-T970130 [https://dcc.ligo.org/LIGO-T970130/public].
| Enumerator |
|---|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_UNKNOWN | Id for unknown or user-defined data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_DFT | Id for DFT data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY | Id for amplitude spectral density data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY | Id for power spectral density data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY | Id for cross spectral density data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_COHERENCE | Id for coherence data.
|
| LAL_FRAMEU_FR_PROC_SUB_TYPE_TRANSFER_FUNCTION | Id for transfer function data.
|
Definition at line 218 of file LALFrameU.h.
1.9.4