LALFrameU.h File Reference

Prototypes
FrFile Routines
void	XLALFrameUFrFileClose (LALFrameUFrFile *stream)
	Close a FrFile stream. More...
LALFrameUFrFile *	XLALFrameUFrFileOpen (const char *filename, const char *mode)
	Open a frame file FrFile stream. More...
int	XLALFrameUFileCksumValid (LALFrameUFrFile *stream)
	Use checksum to determine if FrFile stream is valid. More...
FrTOC Routines
void	XLALFrameUFrTOCFree (LALFrameUFrTOC *toc)
	Free a FrTOC structure. More...
LALFrameUFrTOC *	XLALFrameUFrTOCRead (LALFrameUFrFile *stream)
	Read the table of contents FrTOC structure for a FrFile stream. More...
FrTOC Query Routines
size_t	XLALFrameUFrTOCQueryNFrame (const LALFrameUFrTOC *toc)
	Query FrTOC structure for number of FrameH structures contained. More...
double	XLALFrameUFrTOCQueryGTimeModf (double *iptr, const LALFrameUFrTOC *toc, size_t pos)
	Query FrTOC structure for start time of a FrameH structure. More...
double	XLALFrameUFrTOCQueryDt (const LALFrameUFrTOC *toc, size_t pos)
	Query FrTOC structure for duration of a FrameH structure. More...
size_t	XLALFrameUFrTOCQueryAdcN (const LALFrameUFrTOC *toc)
	Query FrTOC structure for number of FrAdcData structures. More...
const char *	XLALFrameUFrTOCQueryAdcName (const LALFrameUFrTOC *toc, size_t adc)
	Query FrTOC structure for the name of a FrAdcData structure. More...
size_t	XLALFrameUFrTOCQuerySimN (const LALFrameUFrTOC *toc)
	Query FrTOC structure for number of FrSimData structures. More...
const char *	XLALFrameUFrTOCQuerySimName (const LALFrameUFrTOC *toc, size_t sim)
	Query FrTOC structure for the name of a FrSimData structure. More...
size_t	XLALFrameUFrTOCQueryProcN (const LALFrameUFrTOC *toc)
	Query FrTOC structure for number of FrProcData structures. More...
const char *	XLALFrameUFrTOCQueryProcName (const LALFrameUFrTOC *toc, size_t proc)
	Query FrTOC structure for the name of a FrProcData structure. More...
size_t	XLALFrameUFrTOCQueryDetectorN (const LALFrameUFrTOC *toc)
	Query FrTOC structure for number of FrDetector structures. More...
const char *	XLALFrameUFrTOCQueryDetectorName (const LALFrameUFrTOC *toc, size_t det)
	Query FrTOC structure for the name of a FrDetector structure. More...
FrameH Routines
void	XLALFrameUFrameHFree (LALFrameUFrameH *frame)
	Free a FrameH structure. More...
LALFrameUFrameH *	XLALFrameUFrameHAlloc (const char *name, double start1, double start2, double dt, int frnum)
	Allocate memory for a new frame header FrameH structure. More...
LALFrameUFrameH *	XLALFrameUFrameHRead (LALFrameUFrFile *stream, int pos)
	Read a frame header FrameH structure from a FrFile stream. More...
int	XLALFrameUFrameHWrite (LALFrameUFrFile *stream, LALFrameUFrameH *frame)
	Write a FrameH structure to an output FrFile stream. More...
FrameH Add Routines
int	XLALFrameUFrameHFrChanAdd (LALFrameUFrameH *frame, LALFrameUFrChan *channel)
	Add a FrChan structure to a FrameH structure. More...
int	XLALFrameUFrameHFrDetectorAdd (LALFrameUFrameH *frame, LALFrameUFrDetector *detector)
	Add a FrDetector structure to a FrameH structure. More...
int	XLALFrameUFrameHFrHistoryAdd (LALFrameUFrameH *frame, LALFrameUFrHistory *history)
	Add a FrHistory structure to a FrameH structure. More...
FrameH Query Routines
const char *	XLALFrameUFrameHQueryName (const LALFrameUFrameH *frame)
	Query FrameH structure for its name. More...
int	XLALFrameUFrameHQueryRun (const LALFrameUFrameH *frame)
	Query FrameH structure for the run number. More...
int	XLALFrameUFrameHQueryFrame (const LALFrameUFrameH *frame)
	Query FrameH structure for the frame number. More...
int	XLALFrameUFrameHQueryDataQuality (const LALFrameUFrameH *frame)
	Query FrameH structure for the data quality word. More...
double	XLALFrameUFrameHQueryGTimeModf (double *iptr, const LALFrameUFrameH *frame)
	Query FrameH structure for the start time. More...
int	XLALFrameUFrameHQueryULeapS (const LALFrameUFrameH *frame)
	Query FrameH structure for the number of leap seconds. More...
double	XLALFrameUFrameHQueryDt (const LALFrameUFrameH *frame)
	Query FrameH structure for the duration. More...
FrameH Set Routines
int	XLALFrameUFrameHSetRun (LALFrameUFrameH *frame, int run)
	Set the run number in a FrameH structure. More...
FrChan Routines
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...
FrChan Query Routines
const char *	XLALFrameUFrChanQueryName (const LALFrameUFrChan *channel)
	Query FrChan structure for its name. More...
double	XLALFrameUFrChanQueryTimeOffset (const LALFrameUFrChan *channel)
	Query FrChan structure for time offset for this channel. More...
FrChan Set Routines
int	XLALFrameUFrChanSetSampleRate (LALFrameUFrChan *channel, double sampleRate)
	Set the sample rate in a FrChan structure. More...
int	XLALFrameUFrChanSetTimeOffset (LALFrameUFrChan *channel, double timeOffset)
	Set the time offset in a FrChan structure. More...
int	XLALFrameUFrChanSetTRange (LALFrameUFrChan *channel, double tRange)
	Set the time range in a FrChan structure. More...
FrVect Routines
int	XLALFrameUFrChanVectorAlloc (LALFrameUFrChan *channel, int dtype, size_t ndata)
	Allocate memory for a FrVect structure within a FrChan structure. More...
int	XLALFrameUFrChanVectorCompress (LALFrameUFrChan *channel, int compressLevel)
	Compress a FrVect structure within a FrChan structure. More...
int	XLALFrameUFrChanVectorExpand (LALFrameUFrChan *channel)
	Expands a FrVect structure within a FrChan structure. More...
FrVect Query Routines
const char *	XLALFrameUFrChanVectorQueryName (const LALFrameUFrChan *channel)
	Query FrChan structure for the name of its FrVect structure. More...
int	XLALFrameUFrChanVectorQueryCompress (const LALFrameUFrChan *channel)
	Query FrChan structure for the compression scheme of its FrVect structure. More...
int	XLALFrameUFrChanVectorQueryType (const LALFrameUFrChan *channel)
	Query FrChan structure for the data type of its FrVect structure. More...
void *	XLALFrameUFrChanVectorQueryData (const LALFrameUFrChan *channel)
	Query FrChan structure for the data pointer in its FrVect structure. More...
size_t	XLALFrameUFrChanVectorQueryNBytes (const LALFrameUFrChan *channel)
	Query FrChan structure for the number of bytes of data in its FrVect structure. More...
size_t	XLALFrameUFrChanVectorQueryNData (const LALFrameUFrChan *channel)
	Query FrChan structure for the number of points of data in its FrVect structure. More...
size_t	XLALFrameUFrChanVectorQueryNDim (const LALFrameUFrChan *channel)
	Query FrChan structure for the number of dimensions of the multi-dimensional data in its FrVect structure. More...
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. More...
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. More...
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. More...
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. More...
const char *	XLALFrameUFrChanVectorQueryUnitY (const LALFrameUFrChan *channel)
	Query FrChan structure for sample units of the data in the FrVect structure. More...
FrVect Set Routines
int	XLALFrameUFrChanVectorSetName (LALFrameUFrChan *channel, const char *name)
	Set the name of the FrVect structure contained in a FrChan structure. More...
int	XLALFrameUFrChanVectorSetDx (LALFrameUFrChan *channel, double dx)
	Set the sampling interval for the data in the FrVect structure contained in a FrChan structure. More...
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. More...
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. More...
int	XLALFrameUFrChanVectorSetUnitY (LALFrameUFrChan *channel, const char *unit)
	Set the units of the data in the FrVect structure contained in a FrChan structure. More...
FrDetector Routines
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...
FrDetector Query Routines
const char *	XLALFrameUFrDetectorQueryName (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector name. More...
const char *	XLALFrameUFrDetectorQueryPrefix (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector prefix. More...
double	XLALFrameUFrDetectorQueryLongitude (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector longitude. More...
double	XLALFrameUFrDetectorQueryLatitude (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector latitude. More...
double	XLALFrameUFrDetectorQueryElevation (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector elevation. More...
double	XLALFrameUFrDetectorQueryArmXAzimuth (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector x-arm azimuth. More...
double	XLALFrameUFrDetectorQueryArmYAzimuth (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector y-arm azimuth. More...
double	XLALFrameUFrDetectorQueryArmXAltitude (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector x-arm altitude. More...
double	XLALFrameUFrDetectorQueryArmYAltitude (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector y-arm altitude. More...
double	XLALFrameUFrDetectorQueryArmXMidpoint (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector x-arm midpoint. More...
double	XLALFrameUFrDetectorQueryArmYMidpoint (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the detector y-arm midpoint. More...
int	XLALFrameUFrDetectorQueryLocalTime (const LALFrameUFrDetector *detector)
	Query FrDetector structure for the local time offset at the detector. More...
FrHistory Routines
void	XLALFrameUFrHistoryFree (LALFrameUFrHistory *history)
	Free a FrHistory structure. More...
LALFrameUFrHistory *	XLALFrameUFrHistoryAlloc (const char *name, double gpssec, const char *comment)
	Allocate memory for a new detector FrHistory structure. More...

Go to the source code of this file.

Typedefs
typedef struct tagLALFrameUFrameH	LALFrameUFrameH
	Incomplete type for a frame header FrameH structure. More...
typedef struct tagLALFrameUFrTOC	LALFrameUFrTOC
	Incomplete type for a table of contents FrTOC structure. More...
typedef struct tagLALFrameUFrHistory	LALFrameUFrHistory
	Incomplete type for a history data FrHistory structure. More...

Enumerations
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...