ldas-tools-framecpp  2.7.0
Classes | Typedefs | Enumerations | Functions
C Interface

An interface for C applications to utalize FrameCPP. More...

Classes

struct  gpstime
 GPS Time structure. More...
 
struct  FrameCError_
 Information concerning failure of a function. More...
 
struct  fr_detector_prefix_t
 Channel prefix for this detecor. More...
 
struct  fr_event_parameters_t
 

Typedefs

typedef INT_4U gpstime_seconds_t
 
typedef INT_4U gpstime_nanoseconds_t
 
typedef struct gpstime gpstime_t
 
typedef enum errno_ framec_errno_type
 Enumeration of error codes. More...
 
typedef struct FrameCError_ FrameCError
 Information concerning failure of a function. More...
 
typedef const char * frame_h_name_t
 
typedef INT_4S frame_h_run_t
 
typedef INT_4U frame_h_frame_t
 
typedef INT_4U frame_h_data_quality_t
 
typedef gpstime_t frame_h_gtime_t
 
typedef INT_2U frame_h_uleaps_t
 
typedef REAL_8 frame_h_dt_t
 
typedef INT_2U frame_h_offset_t
 
typedef struct frame_h frame_h_t
 
typedef enum frame_h_fields_ frame_h_fields
 Field specifiers for querying the table of contents. More...
 
typedef const char * fr_detector_name_t
 Instrument name. More...
 
typedef REAL_8 fr_detector_latitude_t
 latitude as used in the fr_detector structure. More...
 
typedef REAL_8 fr_detector_longitude_t
 longitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_elevation_t
 elevation as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_azimuth_t
 x axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_azimuth_t
 y axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_altitude_t
 x axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_altitude_t
 y axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_midpoint_t
 x axis midpoint as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_midpoint_t
 y axis midpoint as used in the fr_detector structure. More...
 
typedef INT_4S fr_detector_localtime_t
 local seasonal time as used in the fr_detector structure. More...
 
typedef enum fr_detector_fields_ fr_detector_fields
 Field specifiers for querying the table of contents. More...
 
typedef struct fr_detector fr_detector_t
 
typedef struct fr_event fr_event_t
 
typedef FR_EVENT_NAME_TYPE fr_event_name_t
 
typedef FR_EVENT_COMMENT_TYPE fr_event_comment_t
 
typedef FR_EVENT_INPUTS_TYPE fr_event_inputs_t
 
typedef gpstime_t fr_event_gtime_t
 
typedef FR_EVENT_TIME_BEFORE_TYPE fr_event_time_before_t
 
typedef FR_EVENT_TIME_AFTER_TYPE fr_event_time_after_t
 
typedef FR_EVENT_EVENT_STATUS_TYPE fr_event_event_status_t
 
typedef FR_EVENT_AMPLITUDE_TYPE fr_event_amplitude_t
 
typedef FR_EVENT_PROBABILITY_TYPE fr_event_probability_t
 
typedef FR_EVENT_STATISTICS_TYPE fr_event_statistics_t
 
typedef FR_EVENT_N_PARAM_TYPE fr_event_n_param_t
 
typedef FR_EVENT_PARAM_VALUE_TYPE fr_event_parameter_t
 
typedef FR_EVENT_PARAM_NAME_TYPE fr_event_parameter_name_t
 
typedef struct fr_history fr_history_t
 
typedef INT_4U fr_history_time_t
 
typedef INT_4U gpstime_seconds_t
 
typedef INT_4U gpstime_nanoseconds_t
 
typedef struct gpstime gpstime_t
 
typedef enum errno_ framec_errno_type
 Enumeration of error codes. More...
 
typedef struct FrameCError_ FrameCError
 Information concerning failure of a function. More...
 
typedef const char * frame_h_name_t
 
typedef INT_4S frame_h_run_t
 
typedef INT_4U frame_h_frame_t
 
typedef INT_4U frame_h_data_quality_t
 
typedef gpstime_t frame_h_gtime_t
 
typedef INT_2U frame_h_uleaps_t
 
typedef REAL_8 frame_h_dt_t
 
typedef INT_2U frame_h_offset_t
 
typedef struct frame_h frame_h_t
 
typedef enum frame_h_fields_ frame_h_fields
 Field specifiers for querying the table of contents. More...
 
typedef const char * fr_detector_name_t
 Instrument name. More...
 
typedef REAL_8 fr_detector_latitude_t
 latitude as used in the fr_detector structure. More...
 
typedef REAL_8 fr_detector_longitude_t
 longitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_elevation_t
 elevation as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_azimuth_t
 x axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_azimuth_t
 y axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_altitude_t
 x axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_altitude_t
 y axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_midpoint_t
 x axis midpoint as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_midpoint_t
 y axis midpoint as used in the fr_detector structure. More...
 
typedef INT_4S fr_detector_localtime_t
 local seasonal time as used in the fr_detector structure. More...
 
typedef enum fr_detector_fields_ fr_detector_fields
 Field specifiers for querying the table of contents. More...
 
typedef struct fr_detector fr_detector_t
 
typedef struct fr_event fr_event_t
 
typedef FR_EVENT_NAME_TYPE fr_event_name_t
 
typedef FR_EVENT_COMMENT_TYPE fr_event_comment_t
 
typedef FR_EVENT_INPUTS_TYPE fr_event_inputs_t
 
typedef gpstime_t fr_event_gtime_t
 
typedef FR_EVENT_TIME_BEFORE_TYPE fr_event_time_before_t
 
typedef FR_EVENT_TIME_AFTER_TYPE fr_event_time_after_t
 
typedef FR_EVENT_EVENT_STATUS_TYPE fr_event_event_status_t
 
typedef FR_EVENT_AMPLITUDE_TYPE fr_event_amplitude_t
 
typedef FR_EVENT_PROBABILITY_TYPE fr_event_probability_t
 
typedef FR_EVENT_STATISTICS_TYPE fr_event_statistics_t
 
typedef FR_EVENT_N_PARAM_TYPE fr_event_n_param_t
 
typedef FR_EVENT_PARAM_VALUE_TYPE fr_event_parameter_t
 
typedef FR_EVENT_PARAM_NAME_TYPE fr_event_parameter_name_t
 
typedef struct fr_history fr_history_t
 
typedef INT_4U fr_history_time_t
 

Enumerations

enum  errno_ {
  FRAMEC_ERRNO_NO_ERROR , FRAMEC_ERRNO_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR , FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR , FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR ,
  FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR , FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR , FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR , FRAMEC_ERRNO_FR_EVENT_FREE_ERROR , FRAMEC_ERRNO_FR_EVENT_READ_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR , FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR , FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR , FRAMEC_ERRNO_FRAME_OPEN_ERROR ,
  FRAMEC_ERRNO_FRAME_CLOSE_ERROR , FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR , FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR , FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR ,
  FRAMEC_ERRNO_FRAME_H_FREE_ERROR , FRAMEC_ERRNO_FRAME_H_READ_ERROR , FRAMEC_ERRNO_FRAME_H_WRITE_ERROR , FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR ,
  FRAMEC_ERRNO_FR_TOC_FREE_ERROR , FRAMEC_ERRNO_FR_TOC_READ_ERROR , FRAMEC_ERRNO_NO_ERROR , FRAMEC_ERRNO_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR , FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR , FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR , FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR ,
  FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR , FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_FREE_ERROR , FRAMEC_ERRNO_FR_EVENT_READ_ERROR , FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR , FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR , FRAMEC_ERRNO_FRAME_OPEN_ERROR , FRAMEC_ERRNO_FRAME_CLOSE_ERROR , FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR ,
  FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR , FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR , FRAMEC_ERRNO_FRAME_H_FREE_ERROR , FRAMEC_ERRNO_FRAME_H_READ_ERROR ,
  FRAMEC_ERRNO_FRAME_H_WRITE_ERROR , FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_TOC_FREE_ERROR , FRAMEC_ERRNO_FR_TOC_READ_ERROR
}
 Enumeration of error codes. More...
 
enum  frame_h_fields_ {
  FRAME_H_FIELD_LAST , FRAME_H_FIELD_NAME , FRAME_H_FIELD_RUN , FRAME_H_FIELD_FRAME ,
  FRAME_H_FIELD_DATA_QUALITY , FRAME_H_FIELD_GTIME , FRAME_H_FIELD_ULEAPS , FRAME_H_FIELD_DT ,
  FRAME_H_FIELD_LAST , FRAME_H_FIELD_NAME , FRAME_H_FIELD_RUN , FRAME_H_FIELD_FRAME ,
  FRAME_H_FIELD_DATA_QUALITY , FRAME_H_FIELD_GTIME , FRAME_H_FIELD_ULEAPS , FRAME_H_FIELD_DT
}
 Field specifiers for querying the table of contents. More...
 
enum  fr_detector_fields_ {
  FR_DETECTOR_FIELD_LAST , FR_DETECTOR_FIELD_NAME , FR_DETECTOR_FIELD_PREFIX , FR_DETECTOR_FIELD_LONGITUDE ,
  FR_DETECTOR_FIELD_LATITUDE , FR_DETECTOR_FIELD_ELEVATION , FR_DETECTOR_FIELD_ARM_X_AZIMUTH , FR_DETECTOR_FIELD_ARM_Y_AZIMUTH ,
  FR_DETECTOR_FIELD_ARM_X_ALTITUDE , FR_DETECTOR_FIELD_ARM_Y_ALTITUDE , FR_DETECTOR_FIELD_ARM_X_MIDPOINT , FR_DETECTOR_FIELD_ARM_Y_MIDPOINT ,
  FR_DETECTOR_FIELD_LOCAL_TIME , FR_DETECTOR_FIELD_LAST , FR_DETECTOR_FIELD_NAME , FR_DETECTOR_FIELD_PREFIX ,
  FR_DETECTOR_FIELD_LONGITUDE , FR_DETECTOR_FIELD_LATITUDE , FR_DETECTOR_FIELD_ELEVATION , FR_DETECTOR_FIELD_ARM_X_AZIMUTH ,
  FR_DETECTOR_FIELD_ARM_Y_AZIMUTH , FR_DETECTOR_FIELD_ARM_X_ALTITUDE , FR_DETECTOR_FIELD_ARM_Y_ALTITUDE , FR_DETECTOR_FIELD_ARM_X_MIDPOINT ,
  FR_DETECTOR_FIELD_ARM_Y_MIDPOINT , FR_DETECTOR_FIELD_LOCAL_TIME
}
 Field specifiers for querying the table of contents. More...
 
enum  std_detectors {
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_V1 ,
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_V1
}
 Standard detectors. More...
 
enum  errno_ {
  FRAMEC_ERRNO_NO_ERROR , FRAMEC_ERRNO_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR , FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR , FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR ,
  FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR , FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR , FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR , FRAMEC_ERRNO_FR_EVENT_FREE_ERROR , FRAMEC_ERRNO_FR_EVENT_READ_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR , FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR , FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR , FRAMEC_ERRNO_FRAME_OPEN_ERROR ,
  FRAMEC_ERRNO_FRAME_CLOSE_ERROR , FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR , FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR , FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR ,
  FRAMEC_ERRNO_FRAME_H_FREE_ERROR , FRAMEC_ERRNO_FRAME_H_READ_ERROR , FRAMEC_ERRNO_FRAME_H_WRITE_ERROR , FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR ,
  FRAMEC_ERRNO_FR_TOC_FREE_ERROR , FRAMEC_ERRNO_FR_TOC_READ_ERROR , FRAMEC_ERRNO_NO_ERROR , FRAMEC_ERRNO_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR , FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR , FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR ,
  FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR , FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR ,
  FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR , FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR , FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_EVENT_FREE_ERROR , FRAMEC_ERRNO_FR_EVENT_READ_ERROR , FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR , FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR ,
  FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR , FRAMEC_ERRNO_FRAME_OPEN_ERROR , FRAMEC_ERRNO_FRAME_CLOSE_ERROR , FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR ,
  FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR , FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR , FRAMEC_ERRNO_FRAME_H_FREE_ERROR , FRAMEC_ERRNO_FRAME_H_READ_ERROR ,
  FRAMEC_ERRNO_FRAME_H_WRITE_ERROR , FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR , FRAMEC_ERRNO_FR_TOC_FREE_ERROR , FRAMEC_ERRNO_FR_TOC_READ_ERROR
}
 Enumeration of error codes. More...
 
enum  frame_h_fields_ {
  FRAME_H_FIELD_LAST , FRAME_H_FIELD_NAME , FRAME_H_FIELD_RUN , FRAME_H_FIELD_FRAME ,
  FRAME_H_FIELD_DATA_QUALITY , FRAME_H_FIELD_GTIME , FRAME_H_FIELD_ULEAPS , FRAME_H_FIELD_DT ,
  FRAME_H_FIELD_LAST , FRAME_H_FIELD_NAME , FRAME_H_FIELD_RUN , FRAME_H_FIELD_FRAME ,
  FRAME_H_FIELD_DATA_QUALITY , FRAME_H_FIELD_GTIME , FRAME_H_FIELD_ULEAPS , FRAME_H_FIELD_DT
}
 Field specifiers for querying the table of contents. More...
 
enum  fr_detector_fields_ {
  FR_DETECTOR_FIELD_LAST , FR_DETECTOR_FIELD_NAME , FR_DETECTOR_FIELD_PREFIX , FR_DETECTOR_FIELD_LONGITUDE ,
  FR_DETECTOR_FIELD_LATITUDE , FR_DETECTOR_FIELD_ELEVATION , FR_DETECTOR_FIELD_ARM_X_AZIMUTH , FR_DETECTOR_FIELD_ARM_Y_AZIMUTH ,
  FR_DETECTOR_FIELD_ARM_X_ALTITUDE , FR_DETECTOR_FIELD_ARM_Y_ALTITUDE , FR_DETECTOR_FIELD_ARM_X_MIDPOINT , FR_DETECTOR_FIELD_ARM_Y_MIDPOINT ,
  FR_DETECTOR_FIELD_LOCAL_TIME , FR_DETECTOR_FIELD_LAST , FR_DETECTOR_FIELD_NAME , FR_DETECTOR_FIELD_PREFIX ,
  FR_DETECTOR_FIELD_LONGITUDE , FR_DETECTOR_FIELD_LATITUDE , FR_DETECTOR_FIELD_ELEVATION , FR_DETECTOR_FIELD_ARM_X_AZIMUTH ,
  FR_DETECTOR_FIELD_ARM_Y_AZIMUTH , FR_DETECTOR_FIELD_ARM_X_ALTITUDE , FR_DETECTOR_FIELD_ARM_Y_ALTITUDE , FR_DETECTOR_FIELD_ARM_X_MIDPOINT ,
  FR_DETECTOR_FIELD_ARM_Y_MIDPOINT , FR_DETECTOR_FIELD_LOCAL_TIME
}
 Field specifiers for querying the table of contents. More...
 
enum  std_detectors {
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_V1 ,
  DETECTOR_LOCATION_H1 , DETECTOR_LOCATION_H2 , DETECTOR_LOCATION_L1 , DETECTOR_LOCATION_V1
}
 Standard detectors. More...
 

Functions

void FrameCErrorInit (FrameCError **Handle)
 
INT_2U FrameCLibraryMinorVersion (void)
 Return the minor version number of the frame library. More...
 
gpstime_seconds_t FrameCGPSTimeNow (void)
 
void FrameCInitialize (void)
 Initialize the library. More...
 
void FrameCCleanup (void)
 Cleanup the library. More...
 
frame_h_tFrameCFrameHAlloc (FrameCError **Error, const char *Name, frame_h_gtime_t Start, frame_h_dt_t Dt, frame_h_frame_t FrameNumber)
 Allocate a fr_frame structure. More...
 
int FrameCFrameHFrChanAdd (FrameCError **Error, frame_h_t *Frame, fr_chan_t *Channel)
 Add a channel to the frame. More...
 
int FrameCFrameHFrDetectorAdd (FrameCError **Error, frame_h_t *Frame, fr_detector_t *Detector)
 Add a detector to the frame. More...
 
int FrameCFrameHFree (FrameCError **Error, frame_h_t *frame)
 
int FrameCFrameHFrEventAdd (FrameCError **Error, frame_h_t *Frame, fr_event_t *Event)
 Add an event to the frame. More...
 
int FrameCFrameHFrHistoryAdd (FrameCError **Error, frame_h_t *Frame, fr_history_t *History)
 Add history to the frame. More...
 
frame_h_tFrameCFrameHRead (FrameCError **Error, fr_file_t *restrict Stream, frame_h_offset_t Pos)
 Read a FrameH structure from the file. More...
 
frame_h_tFrameCFrameHReadNext (FrameCError **Error, fr_file_t *restrict Stream)
 Read a FrameH structure from the file. More...
 
void FrameCFrameHQuery (FrameCError **Error, const frame_h_t *Frame, int Option,...)
 Retrieve vector information related to the Table of Contents. More...
 
void FrameCFrameHSet (FrameCError **Error, const frame_h_t *Frame, int Option,...)
 Set values for the FrameH structure. More...
 
int FrameCFrameHWrite (FrameCError **Error, fr_file_t *restrict stream, frame_h_t *restrict frame)
 Write the frame to the stream. More...
 
int FrameCFrameHWriteCompressed (FrameCError **Error, fr_file_t *restrict stream, frame_h_t *restrict frame, fr_vect_compression_schemes_t compression, fr_vect_compression_level_t level)
 Write the frame to the stream. More...
 
fr_detector_tFrameCFrDetectorAlloc (FrameCError **Error, const char *restrict name, const char *restrict prefix, fr_detector_latitude_t latitude, fr_detector_longitude_t longitude, fr_detector_elevation_t elevation, fr_detector_arm_x_azimuth_t azimuth_x, fr_detector_arm_y_azimuth_t azimuth_y, fr_detector_arm_x_altitude_t altitude_x, fr_detector_arm_y_altitude_t altitude_y, fr_detector_arm_x_midpoint_t midpoint_x, fr_detector_arm_y_midpoint_t midpoint_y, fr_detector_localtime_t localtime)
 Allocate a new Detector structure. More...
 
void FrameCFrDetectorFree (FrameCError **Error, fr_detector_t *detector)
 Recyle the detector structure. More...
 
void FrameCFrDetectorQuery (FrameCError **Error, const fr_detector_t *Detector, int Option,...)
 Retrieve vector information related to the Table of Contents. More...
 
fr_detector_tFrameCFrDetectorRead (FrameCError **Error, fr_file_t *restrict Stream, const char *restrict Name)
 Read a new Detector structure. More...
 
int FrameCFrDetectorWrite (FrameCError **Error, fr_file_t *restrict Stream, const fr_detector_t *restrict Detector)
 Write a Detector structure to the stream. More...
 
fr_detector_tFrameCGetDetector (FrameCError **Error, std_detectors Type, const gpstime_t *restrict Time)
 Retrieve information about some standard detectors. More...
 
fr_event_tFrameCFrEventAlloc (FrameCError **Error, const fr_event_name_t Name, const fr_event_comment_t Comment, const fr_event_inputs_t Inputs, const fr_event_gtime_t GTime, const fr_event_time_before_t TimeBefore, const fr_event_time_after_t TimeAfter, const fr_event_event_status_t EventStatus, const fr_event_amplitude_t Amplitude, const fr_event_probability_t Probability, const fr_event_statistics_t Statistics, const fr_event_n_param_t NParam, const fr_event_parameters_t *Parameters)
 Allocate a fr_frame structure. More...
 
int FrameCFrEventFree (FrameCError **Error, fr_event_t *Event)
 
fr_history_tFrameCFrHistoryAlloc (FrameCError **Error, const char *Name, fr_history_time_t Time, const char *Comment)
 Allocate a fr_frame structure. More...
 
int FrameCFrHistoryFree (FrameCError **Error, fr_history_t *History)
 

FrChan

enum  fr_chan_type {
  FR_ADC_CHAN_TYPE , FR_EVENT_CHAN_TYPE , FR_PROC_CHAN_TYPE , FR_SIM_CHAN_TYPE ,
  FR_SIM_EVENT_CHAN_TYPE , UNKNOWN_CHAN_TYPE , FR_ADC_CHAN_TYPE , FR_EVENT_CHAN_TYPE ,
  FR_PROC_CHAN_TYPE , FR_SIM_CHAN_TYPE , FR_SIM_EVENT_CHAN_TYPE , UNKNOWN_CHAN_TYPE
}
 Enumerated type of channel. More...
 
enum  fr_proc_type {
  FR_PROC_TYPE_UNKNOWN , FR_PROC_TYPE_TIME_SERIES , FR_PROC_TYPE_FREQUENCY_SERIES , FR_PROC_TYPE_OTHER_1D_SERIES ,
  FR_PROC_TYPE_TIME_FREQUENCY , FR_PROC_TYPE_WAVELET , Fr_PROC_TYPE_MULTI_DIMENSIONAL , FR_PROC_TYPE_UNKNOWN ,
  FR_PROC_TYPE_TIME_SERIES , FR_PROC_TYPE_FREQUENCY_SERIES , FR_PROC_TYPE_OTHER_1D_SERIES , FR_PROC_TYPE_TIME_FREQUENCY ,
  FR_PROC_TYPE_WAVELET , Fr_PROC_TYPE_MULTI_DIMENSIONAL
}
 Types of FrProcData. More...
 
enum  fr_proc_sub_type {
  FR_PROC_SUB_TYPE_UNKNOWN , FR_PROC_SUB_TYPE_DFT , FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY ,
  FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_COHERENCE , FR_PROC_SUB_TYPE_TRANSFER_FUNCTION , FR_PROC_SUB_TYPE_UNKNOWN ,
  FR_PROC_SUB_TYPE_DFT , FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY ,
  FR_PROC_SUB_TYPE_COHERENCE , FR_PROC_SUB_TYPE_TRANSFER_FUNCTION
}
 Sub types of FrProcData. More...
 
typedef enum fr_chan_type fr_chan_type_t
 Enumerated type of channel. More...
 
typedef enum fr_proc_type fr_proc_type_t
 Types of FrProcData. More...
 
typedef enum fr_proc_sub_type fr_proc_sub_type_t
 Sub types of FrProcData. More...
 
typedef struct fr_adc_chan fr_adc_chan_t
 Type aliasing for FrAdc channel. More...
 
typedef struct fr_proc_chan fr_proc_chan_t
 Type aliasing for FrProc channel. More...
 
typedef struct fr_sim_chan fr_sim_chan_t
 Type aliasing for FrSimData channel. More...
 
typedef struct fr_chan fr_chan_t
 Type aliasing for fr_chan structure. More...
 
fr_chan_tFrameCFrChanAlloc (FrameCError **Error, const char *Name, fr_chan_type_t Type, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 Alloc an fr_chan_t. More...
 
fr_chan_tFrameCFrProcChanAlloc (FrameCError **Error, const char *Name, fr_proc_type_t Type, fr_proc_sub_type_t SubType, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 Alloc an fr_chan_t. More...
 
fr_chan_tFrameCFrProcMimeChanAlloc (FrameCError **Error, const char *Name, const char *MimeTypeName, fr_vect_ndata_t NData, fr_vect_data_t MimeData)
 Alloc an fr_chan_t. More...
 
void FrameCFrChanFree (FrameCError **Error, fr_chan_t *Channel)
 Recyle the fr_chan_t structure. More...
 
void FrameCFrChanQuery (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
 Retrieve information related to the Channel. More...
 
fr_chan_tFrameCFrChanRead (FrameCError **Error, fr_file_t *restrict Stream, fr_chan_name_t restrict Name, fr_chan_offset_t Pos)
 Read a channel from the stream. More...
 
void FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
 Establish information about the Channel. More...
 
void FrameCFrChanVectorAlloc (FrameCError **Error, fr_chan_t *Channel, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
 Allocate new space for an FrVect. More...
 
void FrameCFrChanVectorCompress (FrameCError **Error, fr_chan_t *Channel, fr_vect_compression_schemes_t Scheme)
 Expand the data located in the data vector. More...
 
void FrameCFrChanVectorExpand (FrameCError **Error, fr_chan_t *Channel)
 Expand the data located in the data vector. More...
 
void FrameCFrChanVectorQuery (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
 Retrieve vector information related to the Channel. More...
 
void FrameCFrChanVectorSet (FrameCError **Error, fr_chan_t *Channel, int Option,...)
 Set vector information related to the Channel. More...
 

FrTOC

enum  fr_toc_fields_ {
  FR_TOC_FIELD_LAST , FR_TOC_FIELD_ADC_N , FR_TOC_FIELD_ADC_NAMES , FR_TOC_FIELD_GTIME ,
  FR_TOC_FIELD_DT , FR_TOC_FIELD_DETECTOR_N , FR_TOC_FIELD_DETECTOR_NAMES , FR_TOC_FIELD_NFRAME ,
  FR_TOC_FIELD_PROC_N , FR_TOC_FIELD_PROC_NAMES , FR_TOC_FIELD_SIM_N , FR_TOC_FIELD_SIM_NAMES ,
  FR_TOC_FIELD_DT_NTH , FR_TOC_FIELD_LAST , FR_TOC_FIELD_ADC_N , FR_TOC_FIELD_ADC_NAMES ,
  FR_TOC_FIELD_GTIME , FR_TOC_FIELD_DT , FR_TOC_FIELD_DETECTOR_N , FR_TOC_FIELD_DETECTOR_NAMES ,
  FR_TOC_FIELD_NFRAME , FR_TOC_FIELD_PROC_N , FR_TOC_FIELD_PROC_NAMES , FR_TOC_FIELD_SIM_N ,
  FR_TOC_FIELD_SIM_NAMES , FR_TOC_FIELD_DT_NTH
}
 Field specifiers for querying the table of contents. More...
 
typedef REAL_8 fr_toc_dt_element_t
 Delta time as used in the fr_toc structure. More...
 
typedef fr_toc_dt_element_tfr_toc_dt_t
 
typedef const char * fr_toc_detector_name_t
 
typedef gpstime_t fr_toc_t0_t
 Start time as used in the fr_toc structure. More...
 
typedef fr_toc_t0_tfr_toc_t0_array_t
 
typedef INT_4U fr_toc_adc_n_t
 
typedef const char * fr_toc_adc_name_t
 
typedef INT_4U fr_toc_nframe_t
 
typedef INT_4U fr_toc_detector_n_t
 
typedef INT_4U fr_toc_proc_n_t
 
typedef const char * fr_toc_proc_name_t
 
typedef INT_4U fr_toc_sim_n_t
 
typedef const char * fr_toc_sim_name_t
 
typedef enum fr_toc_fields_ fr_toc_fields
 Field specifiers for querying the table of contents. More...
 
typedef struct fr_toc_t_ fr_toc_t
 
fr_toc_tFrameCFrTOCRead (FrameCError **Error, fr_file_t *Stream)
 Obtain the table of contensts. More...
 
void FrameCFrTOCFree (FrameCError **Error, fr_toc_t *TOC)
 Recyle the table of contents structure. More...
 
void FrameCFrTOCQuery (FrameCError **Error, const fr_toc_t *TOC, int Option,...)
 Retrieve vector information related to the Table of Contents. More...
 

FrChan

enum  fr_chan_type {
  FR_ADC_CHAN_TYPE , FR_EVENT_CHAN_TYPE , FR_PROC_CHAN_TYPE , FR_SIM_CHAN_TYPE ,
  FR_SIM_EVENT_CHAN_TYPE , UNKNOWN_CHAN_TYPE , FR_ADC_CHAN_TYPE , FR_EVENT_CHAN_TYPE ,
  FR_PROC_CHAN_TYPE , FR_SIM_CHAN_TYPE , FR_SIM_EVENT_CHAN_TYPE , UNKNOWN_CHAN_TYPE
}
 Enumerated type of channel. More...
 
enum  fr_proc_type {
  FR_PROC_TYPE_UNKNOWN , FR_PROC_TYPE_TIME_SERIES , FR_PROC_TYPE_FREQUENCY_SERIES , FR_PROC_TYPE_OTHER_1D_SERIES ,
  FR_PROC_TYPE_TIME_FREQUENCY , FR_PROC_TYPE_WAVELET , Fr_PROC_TYPE_MULTI_DIMENSIONAL , FR_PROC_TYPE_UNKNOWN ,
  FR_PROC_TYPE_TIME_SERIES , FR_PROC_TYPE_FREQUENCY_SERIES , FR_PROC_TYPE_OTHER_1D_SERIES , FR_PROC_TYPE_TIME_FREQUENCY ,
  FR_PROC_TYPE_WAVELET , Fr_PROC_TYPE_MULTI_DIMENSIONAL
}
 Types of FrProcData. More...
 
enum  fr_proc_sub_type {
  FR_PROC_SUB_TYPE_UNKNOWN , FR_PROC_SUB_TYPE_DFT , FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY ,
  FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_COHERENCE , FR_PROC_SUB_TYPE_TRANSFER_FUNCTION , FR_PROC_SUB_TYPE_UNKNOWN ,
  FR_PROC_SUB_TYPE_DFT , FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY , FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY ,
  FR_PROC_SUB_TYPE_COHERENCE , FR_PROC_SUB_TYPE_TRANSFER_FUNCTION
}
 Sub types of FrProcData. More...
 
typedef enum fr_chan_type fr_chan_type_t
 Enumerated type of channel. More...
 
typedef enum fr_proc_type fr_proc_type_t
 Types of FrProcData. More...
 
typedef enum fr_proc_sub_type fr_proc_sub_type_t
 Sub types of FrProcData. More...
 
typedef struct fr_adc_chan fr_adc_chan_t
 Type aliasing for FrAdc channel. More...
 
typedef struct fr_proc_chan fr_proc_chan_t
 Type aliasing for FrProc channel. More...
 
typedef struct fr_sim_chan fr_sim_chan_t
 Type aliasing for FrSimData channel. More...
 
typedef struct fr_chan fr_chan_t
 Type aliasing for fr_chan structure. More...
 

FrTOC

enum  fr_toc_fields_ {
  FR_TOC_FIELD_LAST , FR_TOC_FIELD_ADC_N , FR_TOC_FIELD_ADC_NAMES , FR_TOC_FIELD_GTIME ,
  FR_TOC_FIELD_DT , FR_TOC_FIELD_DETECTOR_N , FR_TOC_FIELD_DETECTOR_NAMES , FR_TOC_FIELD_NFRAME ,
  FR_TOC_FIELD_PROC_N , FR_TOC_FIELD_PROC_NAMES , FR_TOC_FIELD_SIM_N , FR_TOC_FIELD_SIM_NAMES ,
  FR_TOC_FIELD_DT_NTH , FR_TOC_FIELD_LAST , FR_TOC_FIELD_ADC_N , FR_TOC_FIELD_ADC_NAMES ,
  FR_TOC_FIELD_GTIME , FR_TOC_FIELD_DT , FR_TOC_FIELD_DETECTOR_N , FR_TOC_FIELD_DETECTOR_NAMES ,
  FR_TOC_FIELD_NFRAME , FR_TOC_FIELD_PROC_N , FR_TOC_FIELD_PROC_NAMES , FR_TOC_FIELD_SIM_N ,
  FR_TOC_FIELD_SIM_NAMES , FR_TOC_FIELD_DT_NTH
}
 Field specifiers for querying the table of contents. More...
 
typedef REAL_8 fr_toc_dt_element_t
 Delta time as used in the fr_toc structure. More...
 
typedef fr_toc_dt_element_tfr_toc_dt_t
 
typedef const char * fr_toc_detector_name_t
 
typedef gpstime_t fr_toc_t0_t
 Start time as used in the fr_toc structure. More...
 
typedef fr_toc_t0_tfr_toc_t0_array_t
 
typedef INT_4U fr_toc_adc_n_t
 
typedef const char * fr_toc_adc_name_t
 
typedef INT_4U fr_toc_nframe_t
 
typedef INT_4U fr_toc_detector_n_t
 
typedef INT_4U fr_toc_proc_n_t
 
typedef const char * fr_toc_proc_name_t
 
typedef INT_4U fr_toc_sim_n_t
 
typedef const char * fr_toc_sim_name_t
 
typedef enum fr_toc_fields_ fr_toc_fields
 Field specifiers for querying the table of contents. More...
 
typedef struct fr_toc_t_ fr_toc_t
 

Detailed Description

An interface for C applications to utalize FrameCPP.

This API provides an interface for developers using the C language to the FrameCPP library. The library is written to be linked with a C compiler as all exceptions from the FrameCPP library are caught and returned to the caller.

Typedef Documentation

◆ fr_adc_chan_t [1/2]

typedef struct fr_adc_chan fr_adc_chan_t

Type aliasing for FrAdc channel.

◆ fr_adc_chan_t [2/2]

typedef struct fr_adc_chan fr_adc_chan_t

Type aliasing for FrAdc channel.

◆ fr_chan_t [1/2]

typedef struct fr_chan fr_chan_t

Type aliasing for fr_chan structure.

◆ fr_chan_t [2/2]

typedef struct fr_chan fr_chan_t

Type aliasing for fr_chan structure.

◆ fr_chan_type_t [1/2]

Enumerated type of channel.

A channel provides a generic interface to several types of data stream described inside the frame specification. This enumerated type specifies the actual data type stream.

◆ fr_chan_type_t [2/2]

Enumerated type of channel.

A channel provides a generic interface to several types of data stream described inside the frame specification. This enumerated type specifies the actual data type stream.

◆ fr_detector_arm_x_altitude_t [1/2]

x axis altitude as used in the fr_detector structure.

◆ fr_detector_arm_x_altitude_t [2/2]

x axis altitude as used in the fr_detector structure.

◆ fr_detector_arm_x_azimuth_t [1/2]

x axis azimuth as used in the fr_detector structure.

◆ fr_detector_arm_x_azimuth_t [2/2]

x axis azimuth as used in the fr_detector structure.

◆ fr_detector_arm_x_midpoint_t [1/2]

x axis midpoint as used in the fr_detector structure.

◆ fr_detector_arm_x_midpoint_t [2/2]

x axis midpoint as used in the fr_detector structure.

◆ fr_detector_arm_y_altitude_t [1/2]

y axis altitude as used in the fr_detector structure.

◆ fr_detector_arm_y_altitude_t [2/2]

y axis altitude as used in the fr_detector structure.

◆ fr_detector_arm_y_azimuth_t [1/2]

y axis azimuth as used in the fr_detector structure.

◆ fr_detector_arm_y_azimuth_t [2/2]

y axis azimuth as used in the fr_detector structure.

◆ fr_detector_arm_y_midpoint_t [1/2]

y axis midpoint as used in the fr_detector structure.

◆ fr_detector_arm_y_midpoint_t [2/2]

y axis midpoint as used in the fr_detector structure.

◆ fr_detector_elevation_t [1/2]

typedef REAL_4 fr_detector_elevation_t

elevation as used in the fr_detector structure.

◆ fr_detector_elevation_t [2/2]

typedef REAL_4 fr_detector_elevation_t

elevation as used in the fr_detector structure.

◆ fr_detector_fields [1/2]

Field specifiers for querying the table of contents.

◆ fr_detector_fields [2/2]

Field specifiers for querying the table of contents.

◆ fr_detector_latitude_t [1/2]

typedef REAL_8 fr_detector_latitude_t

latitude as used in the fr_detector structure.

◆ fr_detector_latitude_t [2/2]

typedef REAL_8 fr_detector_latitude_t

latitude as used in the fr_detector structure.

◆ fr_detector_localtime_t [1/2]

typedef INT_4S fr_detector_localtime_t

local seasonal time as used in the fr_detector structure.

◆ fr_detector_localtime_t [2/2]

typedef INT_4S fr_detector_localtime_t

local seasonal time as used in the fr_detector structure.

◆ fr_detector_longitude_t [1/2]

typedef REAL_8 fr_detector_longitude_t

longitude as used in the fr_detector structure.

◆ fr_detector_longitude_t [2/2]

typedef REAL_8 fr_detector_longitude_t

longitude as used in the fr_detector structure.

◆ fr_detector_name_t [1/2]

typedef const char* fr_detector_name_t

Instrument name.

◆ fr_detector_name_t [2/2]

typedef const char* fr_detector_name_t

Instrument name.

◆ fr_detector_t [1/2]

typedef struct fr_detector fr_detector_t

◆ fr_detector_t [2/2]

typedef struct fr_detector fr_detector_t

◆ fr_event_amplitude_t [1/2]

◆ fr_event_amplitude_t [2/2]

◆ fr_event_comment_t [1/2]

◆ fr_event_comment_t [2/2]

◆ fr_event_event_status_t [1/2]

◆ fr_event_event_status_t [2/2]

◆ fr_event_gtime_t [1/2]

◆ fr_event_gtime_t [2/2]

◆ fr_event_inputs_t [1/2]

◆ fr_event_inputs_t [2/2]

◆ fr_event_n_param_t [1/2]

◆ fr_event_n_param_t [2/2]

◆ fr_event_name_t [1/2]

◆ fr_event_name_t [2/2]

◆ fr_event_parameter_name_t [1/2]

◆ fr_event_parameter_name_t [2/2]

◆ fr_event_parameter_t [1/2]

◆ fr_event_parameter_t [2/2]

◆ fr_event_probability_t [1/2]

◆ fr_event_probability_t [2/2]

◆ fr_event_statistics_t [1/2]

◆ fr_event_statistics_t [2/2]

◆ fr_event_t [1/2]

typedef struct fr_event fr_event_t

◆ fr_event_t [2/2]

typedef struct fr_event fr_event_t

◆ fr_event_time_after_t [1/2]

◆ fr_event_time_after_t [2/2]

◆ fr_event_time_before_t [1/2]

◆ fr_event_time_before_t [2/2]

◆ fr_history_t [1/2]

typedef struct fr_history fr_history_t

◆ fr_history_t [2/2]

typedef struct fr_history fr_history_t

◆ fr_history_time_t [1/2]

typedef INT_4U fr_history_time_t

◆ fr_history_time_t [2/2]

typedef INT_4U fr_history_time_t

◆ fr_proc_chan_t [1/2]

typedef struct fr_proc_chan fr_proc_chan_t

Type aliasing for FrProc channel.

◆ fr_proc_chan_t [2/2]

typedef struct fr_proc_chan fr_proc_chan_t

Type aliasing for FrProc channel.

◆ fr_proc_sub_type_t [1/2]

Sub types of FrProcData.

◆ fr_proc_sub_type_t [2/2]

Sub types of FrProcData.

◆ fr_proc_type_t [1/2]

Types of FrProcData.

◆ fr_proc_type_t [2/2]

Types of FrProcData.

◆ fr_sim_chan_t [1/2]

typedef struct fr_sim_chan fr_sim_chan_t

Type aliasing for FrSimData channel.

◆ fr_sim_chan_t [2/2]

typedef struct fr_sim_chan fr_sim_chan_t

Type aliasing for FrSimData channel.

◆ fr_toc_adc_n_t [1/2]

typedef INT_4U fr_toc_adc_n_t

◆ fr_toc_adc_n_t [2/2]

typedef INT_4U fr_toc_adc_n_t

◆ fr_toc_adc_name_t [1/2]

typedef const char* fr_toc_adc_name_t

◆ fr_toc_adc_name_t [2/2]

typedef const char* fr_toc_adc_name_t

◆ fr_toc_detector_n_t [1/2]

typedef INT_4U fr_toc_detector_n_t

◆ fr_toc_detector_n_t [2/2]

typedef INT_4U fr_toc_detector_n_t

◆ fr_toc_detector_name_t [1/2]

typedef const char* fr_toc_detector_name_t

◆ fr_toc_detector_name_t [2/2]

typedef const char* fr_toc_detector_name_t

◆ fr_toc_dt_element_t [1/2]

typedef REAL_8 fr_toc_dt_element_t

Delta time as used in the fr_toc structure.

◆ fr_toc_dt_element_t [2/2]

typedef REAL_8 fr_toc_dt_element_t

Delta time as used in the fr_toc structure.

◆ fr_toc_dt_t [1/2]

◆ fr_toc_dt_t [2/2]

◆ fr_toc_fields [1/2]

Field specifiers for querying the table of contents.

◆ fr_toc_fields [2/2]

Field specifiers for querying the table of contents.

◆ fr_toc_nframe_t [1/2]

typedef INT_4U fr_toc_nframe_t

◆ fr_toc_nframe_t [2/2]

typedef INT_4U fr_toc_nframe_t

◆ fr_toc_proc_n_t [1/2]

typedef INT_4U fr_toc_proc_n_t

◆ fr_toc_proc_n_t [2/2]

typedef INT_4U fr_toc_proc_n_t

◆ fr_toc_proc_name_t [1/2]

typedef const char* fr_toc_proc_name_t

◆ fr_toc_proc_name_t [2/2]

typedef const char* fr_toc_proc_name_t

◆ fr_toc_sim_n_t [1/2]

typedef INT_4U fr_toc_sim_n_t

◆ fr_toc_sim_n_t [2/2]

typedef INT_4U fr_toc_sim_n_t

◆ fr_toc_sim_name_t [1/2]

typedef const char* fr_toc_sim_name_t

◆ fr_toc_sim_name_t [2/2]

typedef const char* fr_toc_sim_name_t

◆ fr_toc_t [1/2]

typedef struct fr_toc_t_ fr_toc_t

◆ fr_toc_t [2/2]

typedef struct fr_toc_t_ fr_toc_t

◆ fr_toc_t0_array_t [1/2]

◆ fr_toc_t0_array_t [2/2]

◆ fr_toc_t0_t [1/2]

Start time as used in the fr_toc structure.

◆ fr_toc_t0_t [2/2]

Start time as used in the fr_toc structure.

◆ frame_h_data_quality_t [1/2]

typedef INT_4U frame_h_data_quality_t

◆ frame_h_data_quality_t [2/2]

typedef INT_4U frame_h_data_quality_t

◆ frame_h_dt_t [1/2]

typedef REAL_8 frame_h_dt_t

◆ frame_h_dt_t [2/2]

typedef REAL_8 frame_h_dt_t

◆ frame_h_fields [1/2]

Field specifiers for querying the table of contents.

◆ frame_h_fields [2/2]

Field specifiers for querying the table of contents.

◆ frame_h_frame_t [1/2]

typedef INT_4U frame_h_frame_t

◆ frame_h_frame_t [2/2]

typedef INT_4U frame_h_frame_t

◆ frame_h_gtime_t [1/2]

◆ frame_h_gtime_t [2/2]

◆ frame_h_name_t [1/2]

typedef const char* frame_h_name_t

◆ frame_h_name_t [2/2]

typedef const char* frame_h_name_t

◆ frame_h_offset_t [1/2]

typedef INT_2U frame_h_offset_t

◆ frame_h_offset_t [2/2]

typedef INT_2U frame_h_offset_t

◆ frame_h_run_t [1/2]

typedef INT_4S frame_h_run_t

◆ frame_h_run_t [2/2]

typedef INT_4S frame_h_run_t

◆ frame_h_t [1/2]

typedef struct frame_h frame_h_t

◆ frame_h_t [2/2]

typedef struct frame_h frame_h_t

◆ frame_h_uleaps_t [1/2]

typedef INT_2U frame_h_uleaps_t

◆ frame_h_uleaps_t [2/2]

typedef INT_2U frame_h_uleaps_t

◆ framec_errno_type [1/2]

typedef enum errno_ framec_errno_type

Enumeration of error codes.

To aid in error handling, the C interface adopts from the errno paradigm and has this enumerated type to describe numerically the classification of the error that occurred.

◆ framec_errno_type [2/2]

typedef enum errno_ framec_errno_type

Enumeration of error codes.

To aid in error handling, the C interface adopts from the errno paradigm and has this enumerated type to describe numerically the classification of the error that occurred.

◆ FrameCError [1/2]

typedef struct FrameCError_ FrameCError

Information concerning failure of a function.

◆ FrameCError [2/2]

typedef struct FrameCError_ FrameCError

Information concerning failure of a function.

◆ gpstime_nanoseconds_t [1/2]

typedef INT_4U gpstime_nanoseconds_t

◆ gpstime_nanoseconds_t [2/2]

typedef INT_4U gpstime_nanoseconds_t

◆ gpstime_seconds_t [1/2]

typedef INT_4U gpstime_seconds_t

◆ gpstime_seconds_t [2/2]

typedef INT_4U gpstime_seconds_t

◆ gpstime_t [1/2]

typedef struct gpstime gpstime_t

◆ gpstime_t [2/2]

typedef struct gpstime gpstime_t

Enumeration Type Documentation

◆ errno_ [1/2]

enum errno_

Enumeration of error codes.

To aid in error handling, the C interface adopts from the errno paradigm and has this enumerated type to describe numerically the classification of the error that occurred.

Enumerator
FRAMEC_ERRNO_NO_ERROR 

No error.

This enumerated type is used to represent that the call completed successfully

FRAMEC_ERRNO_ERROR 

General error.

FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR 

Error accessing a data member of the channel.

FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR 

Error releasing the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR 

Error reading the channel structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR 

Error accessing a data member of the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR 

Error allocating the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR 

Error releasing the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR 

Error reading the detector structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR 

Error writing the detector structure to the frame file.

FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR 

Error accessing a data member of the event structure.

FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR 

Error allocating the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_FREE_ERROR 

Error releasing the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_READ_ERROR 

Error reading the event structure from the frame file.

FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR 

Error writing the event structure to the frame file.

FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR 

Error allocating the memory associated with the history structure.

FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR 

Error releasing the memory associated with the FrHistory structure.

FRAMEC_ERRNO_FRAME_OPEN_ERROR 

Error opening the frame file.

FRAMEC_ERRNO_FRAME_CLOSE_ERROR 

Error closing the frame file.

FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR 

Error in the stream indicating inconsistent checksum.

FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR 

Error accessing a data member of the frame.

FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR 

Error obtaining the memory needed for the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_FREE_ERROR 

Error releasing the memory associated with the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_READ_ERROR 

Error reading the FrFrame structure from the frame file.

FRAMEC_ERRNO_FRAME_H_WRITE_ERROR 

Error writing the FrFrame structure to the frame file.

FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR 

Error accessing a data member of the table of contents.

FRAMEC_ERRNO_FR_TOC_FREE_ERROR 

Error releasing the memory associated with the FrTOC structure.

FRAMEC_ERRNO_FR_TOC_READ_ERROR 

Error reading the FrTOC structure from the frame file.

FRAMEC_ERRNO_NO_ERROR 

No error.

This enumerated type is used to represent that the call completed successfully

FRAMEC_ERRNO_ERROR 

General error.

FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR 

Error accessing a data member of the channel.

FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR 

Error releasing the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR 

Error reading the channel structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR 

Error accessing a data member of the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR 

Error allocating the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR 

Error releasing the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR 

Error reading the detector structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR 

Error writing the detector structure to the frame file.

FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR 

Error accessing a data member of the event structure.

FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR 

Error allocating the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_FREE_ERROR 

Error releasing the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_READ_ERROR 

Error reading the event structure from the frame file.

FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR 

Error writing the event structure to the frame file.

FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR 

Error allocating the memory associated with the history structure.

FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR 

Error releasing the memory associated with the FrHistory structure.

FRAMEC_ERRNO_FRAME_OPEN_ERROR 

Error opening the frame file.

FRAMEC_ERRNO_FRAME_CLOSE_ERROR 

Error closing the frame file.

FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR 

Error in the stream indicating inconsistent checksum.

FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR 

Error accessing a data member of the frame.

FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR 

Error obtaining the memory needed for the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_FREE_ERROR 

Error releasing the memory associated with the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_READ_ERROR 

Error reading the FrFrame structure from the frame file.

FRAMEC_ERRNO_FRAME_H_WRITE_ERROR 

Error writing the FrFrame structure to the frame file.

FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR 

Error accessing a data member of the table of contents.

FRAMEC_ERRNO_FR_TOC_FREE_ERROR 

Error releasing the memory associated with the FrTOC structure.

FRAMEC_ERRNO_FR_TOC_READ_ERROR 

Error reading the FrTOC structure from the frame file.

◆ errno_ [2/2]

enum errno_

Enumeration of error codes.

To aid in error handling, the C interface adopts from the errno paradigm and has this enumerated type to describe numerically the classification of the error that occurred.

Enumerator
FRAMEC_ERRNO_NO_ERROR 

No error.

This enumerated type is used to represent that the call completed successfully

FRAMEC_ERRNO_ERROR 

General error.

FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR 

Error accessing a data member of the channel.

FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR 

Error releasing the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR 

Error reading the channel structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR 

Error accessing a data member of the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR 

Error allocating the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR 

Error releasing the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR 

Error reading the detector structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR 

Error writing the detector structure to the frame file.

FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR 

Error accessing a data member of the event structure.

FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR 

Error allocating the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_FREE_ERROR 

Error releasing the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_READ_ERROR 

Error reading the event structure from the frame file.

FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR 

Error writing the event structure to the frame file.

FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR 

Error allocating the memory associated with the history structure.

FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR 

Error releasing the memory associated with the FrHistory structure.

FRAMEC_ERRNO_FRAME_OPEN_ERROR 

Error opening the frame file.

FRAMEC_ERRNO_FRAME_CLOSE_ERROR 

Error closing the frame file.

FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR 

Error in the stream indicating inconsistent checksum.

FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR 

Error accessing a data member of the frame.

FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR 

Error obtaining the memory needed for the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_FREE_ERROR 

Error releasing the memory associated with the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_READ_ERROR 

Error reading the FrFrame structure from the frame file.

FRAMEC_ERRNO_FRAME_H_WRITE_ERROR 

Error writing the FrFrame structure to the frame file.

FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR 

Error accessing a data member of the table of contents.

FRAMEC_ERRNO_FR_TOC_FREE_ERROR 

Error releasing the memory associated with the FrTOC structure.

FRAMEC_ERRNO_FR_TOC_READ_ERROR 

Error reading the FrTOC structure from the frame file.

FRAMEC_ERRNO_NO_ERROR 

No error.

This enumerated type is used to represent that the call completed successfully

FRAMEC_ERRNO_ERROR 

General error.

FRAMEC_ERRNO_FR_CHANNEL_ACCESSOR_ERROR 

Error accessing a data member of the channel.

FRAMEC_ERRNO_FR_CHANNEL_ALLOC_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_COMPRESSION_ERROR 

Error allocating the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_FREE_ERROR 

Error releasing the memory associated with the channel structure.

FRAMEC_ERRNO_FR_CHANNEL_READ_ERROR 

Error reading the channel structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_ACCESSOR_ERROR 

Error accessing a data member of the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_ALLOC_ERROR 

Error allocating the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_FREE_ERROR 

Error releasing the memory associated with the detector structure.

FRAMEC_ERRNO_FR_DETECTOR_READ_ERROR 

Error reading the detector structure from the frame file.

FRAMEC_ERRNO_FR_DETECTOR_WRITE_ERROR 

Error writing the detector structure to the frame file.

FRAMEC_ERRNO_FR_EVENT_ACCESSOR_ERROR 

Error accessing a data member of the event structure.

FRAMEC_ERRNO_FR_EVENT_ALLOC_ERROR 

Error allocating the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_FREE_ERROR 

Error releasing the memory associated with the event structure.

FRAMEC_ERRNO_FR_EVENT_READ_ERROR 

Error reading the event structure from the frame file.

FRAMEC_ERRNO_FR_EVENT_WRITE_ERROR 

Error writing the event structure to the frame file.

FRAMEC_ERRNO_FR_HISTORY_ALLOC_ERROR 

Error allocating the memory associated with the history structure.

FRAMEC_ERRNO_FR_HISTORY_FREE_ERROR 

Error releasing the memory associated with the FrHistory structure.

FRAMEC_ERRNO_FRAME_OPEN_ERROR 

Error opening the frame file.

FRAMEC_ERRNO_FRAME_CLOSE_ERROR 

Error closing the frame file.

FRAMEC_ERRNO_FRAME_CHECKSUM_ERROR 

Error in the stream indicating inconsistent checksum.

FRAMEC_ERRNO_FRAME_H_ACCESSOR_ERROR 

Error accessing a data member of the frame.

FRAMEC_ERRNO_FRAME_H_ALLOC_ERROR 

Error obtaining the memory needed for the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_FREE_ERROR 

Error releasing the memory associated with the FrFrame structure.

FRAMEC_ERRNO_FRAME_H_READ_ERROR 

Error reading the FrFrame structure from the frame file.

FRAMEC_ERRNO_FRAME_H_WRITE_ERROR 

Error writing the FrFrame structure to the frame file.

FRAMEC_ERRNO_FR_TOC_ACCESSOR_ERROR 

Error accessing a data member of the table of contents.

FRAMEC_ERRNO_FR_TOC_FREE_ERROR 

Error releasing the memory associated with the FrTOC structure.

FRAMEC_ERRNO_FR_TOC_READ_ERROR 

Error reading the FrTOC structure from the frame file.

◆ fr_chan_type [1/2]

Enumerated type of channel.

A channel provides a generic interface to several types of data stream described inside the frame specification. This enumerated type specifies the actual data type stream.

Enumerator
FR_ADC_CHAN_TYPE 

Descriptor for FrAdc channel.

FR_EVENT_CHAN_TYPE 

Descriptor for FrEvent channel.

FR_PROC_CHAN_TYPE 

Descriptor for FrProc channel.

FR_SIM_CHAN_TYPE 

Descriptor for FrSimData channel.

FR_SIM_EVENT_CHAN_TYPE 

Descriptor for FrSimEventData channel.

UNKNOWN_CHAN_TYPE 

Descriptor for Unknown channel.

FR_ADC_CHAN_TYPE 

Descriptor for FrAdc channel.

FR_EVENT_CHAN_TYPE 

Descriptor for FrEvent channel.

FR_PROC_CHAN_TYPE 

Descriptor for FrProc channel.

FR_SIM_CHAN_TYPE 

Descriptor for FrSimData channel.

FR_SIM_EVENT_CHAN_TYPE 

Descriptor for FrSimEventData channel.

UNKNOWN_CHAN_TYPE 

Descriptor for Unknown channel.

◆ fr_chan_type [2/2]

Enumerated type of channel.

A channel provides a generic interface to several types of data stream described inside the frame specification. This enumerated type specifies the actual data type stream.

Enumerator
FR_ADC_CHAN_TYPE 

Descriptor for FrAdc channel.

FR_EVENT_CHAN_TYPE 

Descriptor for FrEvent channel.

FR_PROC_CHAN_TYPE 

Descriptor for FrProc channel.

FR_SIM_CHAN_TYPE 

Descriptor for FrSimData channel.

FR_SIM_EVENT_CHAN_TYPE 

Descriptor for FrSimEventData channel.

UNKNOWN_CHAN_TYPE 

Descriptor for Unknown channel.

FR_ADC_CHAN_TYPE 

Descriptor for FrAdc channel.

FR_EVENT_CHAN_TYPE 

Descriptor for FrEvent channel.

FR_PROC_CHAN_TYPE 

Descriptor for FrProc channel.

FR_SIM_CHAN_TYPE 

Descriptor for FrSimData channel.

FR_SIM_EVENT_CHAN_TYPE 

Descriptor for FrSimEventData channel.

UNKNOWN_CHAN_TYPE 

Descriptor for Unknown channel.

◆ fr_detector_fields_ [1/2]

Field specifiers for querying the table of contents.

Enumerator
FR_DETECTOR_FIELD_LAST 

Marker specifying the end of a detector query.

FR_DETECTOR_FIELD_NAME 

Instrument name.

Instrument name as described by the latest frame specification. (e.g., Virgo; GEO_600; TAMA_300; LHO2k; LLO_4k; CIT_40; simulated pseudo data -model version etc.)

FR_DETECTOR_FIELD_PREFIX 

Channel prefix for this detector.

FR_DETECTOR_FIELD_LONGITUDE 

Detector vertex longitude.

Detector vertex longitude, geographical coordinates: radians; Value > 0 => E of Greenwich

FR_DETECTOR_FIELD_LATITUDE 

Detector vertex latitude.

Detector vertex latitude, geographical coordinates: radians; Value > 0 => N of Equator

FR_DETECTOR_FIELD_ELEVATION 

Vertex elevation, meters, relative to WGS84 ellipsoid.

FR_DETECTOR_FIELD_ARM_X_AZIMUTH 

Orientation of X arm.

Orientation of X arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_Y_AZIMUTH 

Orientation of Y arm.

Orientation of Y arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_X_ALTITUDE 

Altitude (pitch) angle of X arm.

Altitude (pitch) angle of X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_Y_ALTITUDE 

Altitude (pitch) angle of Y arm.

Altitude (pitch) angle of Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_X_MIDPOINT 

Distance between the detector vertex and the middle of the X cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_ARM_Y_MIDPOINT 

Distance between the detector vertex and the middle of the Y cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_LOCAL_TIME 

Local seasonal time - UTC in seconds.

If local time % 1800 != 0, then local time is undefined.

FR_DETECTOR_FIELD_LAST 

Marker specifying the end of a detector query.

FR_DETECTOR_FIELD_NAME 

Instrument name.

Instrument name as described by the latest frame specification. (e.g., Virgo; GEO_600; TAMA_300; LHO2k; LLO_4k; CIT_40; simulated pseudo data -model version etc.)

FR_DETECTOR_FIELD_PREFIX 

Channel prefix for this detector.

FR_DETECTOR_FIELD_LONGITUDE 

Detector vertex longitude.

Detector vertex longitude, geographical coordinates: radians; Value > 0 => E of Greenwich

FR_DETECTOR_FIELD_LATITUDE 

Detector vertex latitude.

Detector vertex latitude, geographical coordinates: radians; Value > 0 => N of Equator

FR_DETECTOR_FIELD_ELEVATION 

Vertex elevation, meters, relative to WGS84 ellipsoid.

FR_DETECTOR_FIELD_ARM_X_AZIMUTH 

Orientation of X arm.

Orientation of X arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_Y_AZIMUTH 

Orientation of Y arm.

Orientation of Y arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_X_ALTITUDE 

Altitude (pitch) angle of X arm.

Altitude (pitch) angle of X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_Y_ALTITUDE 

Altitude (pitch) angle of Y arm.

Altitude (pitch) angle of Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_X_MIDPOINT 

Distance between the detector vertex and the middle of the X cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_ARM_Y_MIDPOINT 

Distance between the detector vertex and the middle of the Y cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_LOCAL_TIME 

Local seasonal time - UTC in seconds.

If local time % 1800 != 0, then local time is undefined.

◆ fr_detector_fields_ [2/2]

Field specifiers for querying the table of contents.

Enumerator
FR_DETECTOR_FIELD_LAST 

Marker specifying the end of a detector query.

FR_DETECTOR_FIELD_NAME 

Instrument name.

Instrument name as described by the latest frame specification. (e.g., Virgo; GEO_600; TAMA_300; LHO2k; LLO_4k; CIT_40; simulated pseudo data -model version etc.)

FR_DETECTOR_FIELD_PREFIX 

Channel prefix for this detector.

FR_DETECTOR_FIELD_LONGITUDE 

Detector vertex longitude.

Detector vertex longitude, geographical coordinates: radians; Value > 0 => E of Greenwich

FR_DETECTOR_FIELD_LATITUDE 

Detector vertex latitude.

Detector vertex latitude, geographical coordinates: radians; Value > 0 => N of Equator

FR_DETECTOR_FIELD_ELEVATION 

Vertex elevation, meters, relative to WGS84 ellipsoid.

FR_DETECTOR_FIELD_ARM_X_AZIMUTH 

Orientation of X arm.

Orientation of X arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_Y_AZIMUTH 

Orientation of Y arm.

Orientation of Y arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_X_ALTITUDE 

Altitude (pitch) angle of X arm.

Altitude (pitch) angle of X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_Y_ALTITUDE 

Altitude (pitch) angle of Y arm.

Altitude (pitch) angle of Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_X_MIDPOINT 

Distance between the detector vertex and the middle of the X cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_ARM_Y_MIDPOINT 

Distance between the detector vertex and the middle of the Y cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_LOCAL_TIME 

Local seasonal time - UTC in seconds.

If local time % 1800 != 0, then local time is undefined.

FR_DETECTOR_FIELD_LAST 

Marker specifying the end of a detector query.

FR_DETECTOR_FIELD_NAME 

Instrument name.

Instrument name as described by the latest frame specification. (e.g., Virgo; GEO_600; TAMA_300; LHO2k; LLO_4k; CIT_40; simulated pseudo data -model version etc.)

FR_DETECTOR_FIELD_PREFIX 

Channel prefix for this detector.

FR_DETECTOR_FIELD_LONGITUDE 

Detector vertex longitude.

Detector vertex longitude, geographical coordinates: radians; Value > 0 => E of Greenwich

FR_DETECTOR_FIELD_LATITUDE 

Detector vertex latitude.

Detector vertex latitude, geographical coordinates: radians; Value > 0 => N of Equator

FR_DETECTOR_FIELD_ELEVATION 

Vertex elevation, meters, relative to WGS84 ellipsoid.

FR_DETECTOR_FIELD_ARM_X_AZIMUTH 

Orientation of X arm.

Orientation of X arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_Y_AZIMUTH 

Orientation of Y arm.

Orientation of Y arm, measured in raidans East of North.

FR_DETECTOR_FIELD_ARM_X_ALTITUDE 

Altitude (pitch) angle of X arm.

Altitude (pitch) angle of X arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_Y_ALTITUDE 

Altitude (pitch) angle of Y arm.

Altitude (pitch) angle of Y arm, measured in radians above horizon (local tangent to WGS84 ellipsoid)

FR_DETECTOR_FIELD_ARM_X_MIDPOINT 

Distance between the detector vertex and the middle of the X cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_ARM_Y_MIDPOINT 

Distance between the detector vertex and the middle of the Y cavity.

The distance is in units of meters. The value should be zero for bars.

FR_DETECTOR_FIELD_LOCAL_TIME 

Local seasonal time - UTC in seconds.

If local time % 1800 != 0, then local time is undefined.

◆ fr_proc_sub_type [1/2]

Sub types of FrProcData.

Enumerator
FR_PROC_SUB_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_SUB_TYPE_DFT 

DFT.

FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY 

Amplitude Spectral Density.

FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY 

Power spectral density.

FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY 

Cross spectral density.

FR_PROC_SUB_TYPE_COHERENCE 

Coherence.

FR_PROC_SUB_TYPE_TRANSFER_FUNCTION 

Transfer function.

FR_PROC_SUB_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_SUB_TYPE_DFT 

DFT.

FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY 

Amplitude Spectral Density.

FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY 

Power spectral density.

FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY 

Cross spectral density.

FR_PROC_SUB_TYPE_COHERENCE 

Coherence.

FR_PROC_SUB_TYPE_TRANSFER_FUNCTION 

Transfer function.

◆ fr_proc_sub_type [2/2]

Sub types of FrProcData.

Enumerator
FR_PROC_SUB_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_SUB_TYPE_DFT 

DFT.

FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY 

Amplitude Spectral Density.

FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY 

Power spectral density.

FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY 

Cross spectral density.

FR_PROC_SUB_TYPE_COHERENCE 

Coherence.

FR_PROC_SUB_TYPE_TRANSFER_FUNCTION 

Transfer function.

FR_PROC_SUB_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_SUB_TYPE_DFT 

DFT.

FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY 

Amplitude Spectral Density.

FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY 

Power spectral density.

FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY 

Cross spectral density.

FR_PROC_SUB_TYPE_COHERENCE 

Coherence.

FR_PROC_SUB_TYPE_TRANSFER_FUNCTION 

Transfer function.

◆ fr_proc_type [1/2]

Types of FrProcData.

Enumerator
FR_PROC_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_TYPE_TIME_SERIES 

Time Series.

FR_PROC_TYPE_FREQUENCY_SERIES 

Frequency Series.

FR_PROC_TYPE_OTHER_1D_SERIES 

Other 1D Series data.

FR_PROC_TYPE_TIME_FREQUENCY 

Time-Frequency.

FR_PROC_TYPE_WAVELET 

Wavelets.

Fr_PROC_TYPE_MULTI_DIMENSIONAL 

Multi-dimensional.

FR_PROC_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_TYPE_TIME_SERIES 

Time Series.

FR_PROC_TYPE_FREQUENCY_SERIES 

Frequency Series.

FR_PROC_TYPE_OTHER_1D_SERIES 

Other 1D Series data.

FR_PROC_TYPE_TIME_FREQUENCY 

Time-Frequency.

FR_PROC_TYPE_WAVELET 

Wavelets.

Fr_PROC_TYPE_MULTI_DIMENSIONAL 

Multi-dimensional.

◆ fr_proc_type [2/2]

Types of FrProcData.

Enumerator
FR_PROC_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_TYPE_TIME_SERIES 

Time Series.

FR_PROC_TYPE_FREQUENCY_SERIES 

Frequency Series.

FR_PROC_TYPE_OTHER_1D_SERIES 

Other 1D Series data.

FR_PROC_TYPE_TIME_FREQUENCY 

Time-Frequency.

FR_PROC_TYPE_WAVELET 

Wavelets.

Fr_PROC_TYPE_MULTI_DIMENSIONAL 

Multi-dimensional.

FR_PROC_TYPE_UNKNOWN 

Unknown/user defined.

FR_PROC_TYPE_TIME_SERIES 

Time Series.

FR_PROC_TYPE_FREQUENCY_SERIES 

Frequency Series.

FR_PROC_TYPE_OTHER_1D_SERIES 

Other 1D Series data.

FR_PROC_TYPE_TIME_FREQUENCY 

Time-Frequency.

FR_PROC_TYPE_WAVELET 

Wavelets.

Fr_PROC_TYPE_MULTI_DIMENSIONAL 

Multi-dimensional.

◆ fr_toc_fields_ [1/2]

Field specifiers for querying the table of contents.

Enumerator
FR_TOC_FIELD_LAST 

Marker specifying the end of a TOC query.

FR_TOC_FIELD_ADC_N 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

The number of adc channels in the stream

FR_TOC_FIELD_ADC_NAMES 

The array of adc names in the stream.

FR_TOC_FIELD_GTIME 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DT 

Retrieve the duration of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DETECTOR_N 

The number of detectors in the stream.

FR_TOC_FIELD_DETECTOR_NAMES 

The array of detectors in the stream.

FR_TOC_FIELD_NFRAME 

The number of frames in the stream.

FR_TOC_FIELD_PROC_N 

The number of proc channels in the stream.

FR_TOC_FIELD_PROC_NAMES 

The array of proc names in the stream.

FR_TOC_FIELD_SIM_N 

The number of sim channels in the stream.

FR_TOC_FIELD_SIM_NAMES 

The array of sim names in the stream.

FR_TOC_FIELD_DT_NTH 
FR_TOC_FIELD_LAST 

Marker specifying the end of a TOC query.

FR_TOC_FIELD_ADC_N 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

The number of adc channels in the stream

FR_TOC_FIELD_ADC_NAMES 

The array of adc names in the stream.

FR_TOC_FIELD_GTIME 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DT 

Retrieve the duration of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DETECTOR_N 

The number of detectors in the stream.

FR_TOC_FIELD_DETECTOR_NAMES 

The array of detectors in the stream.

FR_TOC_FIELD_NFRAME 

The number of frames in the stream.

FR_TOC_FIELD_PROC_N 

The number of proc channels in the stream.

FR_TOC_FIELD_PROC_NAMES 

The array of proc names in the stream.

FR_TOC_FIELD_SIM_N 

The number of sim channels in the stream.

FR_TOC_FIELD_SIM_NAMES 

The array of sim names in the stream.

FR_TOC_FIELD_DT_NTH 

◆ fr_toc_fields_ [2/2]

Field specifiers for querying the table of contents.

Enumerator
FR_TOC_FIELD_LAST 

Marker specifying the end of a TOC query.

FR_TOC_FIELD_ADC_N 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

The number of adc channels in the stream

FR_TOC_FIELD_ADC_NAMES 

The array of adc names in the stream.

FR_TOC_FIELD_GTIME 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DT 

Retrieve the duration of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DETECTOR_N 

The number of detectors in the stream.

FR_TOC_FIELD_DETECTOR_NAMES 

The array of detectors in the stream.

FR_TOC_FIELD_NFRAME 

The number of frames in the stream.

FR_TOC_FIELD_PROC_N 

The number of proc channels in the stream.

FR_TOC_FIELD_PROC_NAMES 

The array of proc names in the stream.

FR_TOC_FIELD_SIM_N 

The number of sim channels in the stream.

FR_TOC_FIELD_SIM_NAMES 

The array of sim names in the stream.

FR_TOC_FIELD_DT_NTH 
FR_TOC_FIELD_LAST 

Marker specifying the end of a TOC query.

FR_TOC_FIELD_ADC_N 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

The number of adc channels in the stream

FR_TOC_FIELD_ADC_NAMES 

The array of adc names in the stream.

FR_TOC_FIELD_GTIME 

Retrieve the start time of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DT 

Retrieve the duration of each frame in the stream.

The number of entries in this set is governed by NFRAME

FR_TOC_FIELD_DETECTOR_N 

The number of detectors in the stream.

FR_TOC_FIELD_DETECTOR_NAMES 

The array of detectors in the stream.

FR_TOC_FIELD_NFRAME 

The number of frames in the stream.

FR_TOC_FIELD_PROC_N 

The number of proc channels in the stream.

FR_TOC_FIELD_PROC_NAMES 

The array of proc names in the stream.

FR_TOC_FIELD_SIM_N 

The number of sim channels in the stream.

FR_TOC_FIELD_SIM_NAMES 

The array of sim names in the stream.

FR_TOC_FIELD_DT_NTH 

◆ frame_h_fields_ [1/2]

Field specifiers for querying the table of contents.

Enumerator
FRAME_H_FIELD_LAST 

Marker specifying the end of a frame query.

FRAME_H_FIELD_NAME 

Desciption.

Name of the project or other experiment description

(e.g., GEO; LIGO; VIRGO; TAMA; ... )

FRAME_H_FIELD_RUN 

Run number.

Run number ( number < 0 reserved for simulated data); monotonic for experimental runs.

FRAME_H_FIELD_FRAME 

Frame number.

Frame number, monotonically increasing until end of run, re-startarting from 0 with each new run.

FRAME_H_FIELD_DATA_QUALITY 

Data quality flag.

A logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for various GW detectors.

FRAME_H_FIELD_GTIME 

Frame start time.

GPS start time of the frame.

FRAME_H_FIELD_ULEAPS 

Leap seconds between GPS/TAI and UTC.

The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

FRAME_H_FIELD_DT 

Frame length in seconds.

FRAME_H_FIELD_LAST 

Marker specifying the end of a frame query.

FRAME_H_FIELD_NAME 

Desciption.

Name of the project or other experiment description

(e.g., GEO; LIGO; VIRGO; TAMA; ... )

FRAME_H_FIELD_RUN 

Run number.

Run number ( number < 0 reserved for simulated data); monotonic for experimental runs.

FRAME_H_FIELD_FRAME 

Frame number.

Frame number, monotonically increasing until end of run, re-startarting from 0 with each new run.

FRAME_H_FIELD_DATA_QUALITY 

Data quality flag.

A logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for various GW detectors.

FRAME_H_FIELD_GTIME 

Frame start time.

GPS start time of the frame.

FRAME_H_FIELD_ULEAPS 

Leap seconds between GPS/TAI and UTC.

The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

FRAME_H_FIELD_DT 

Frame length in seconds.

◆ frame_h_fields_ [2/2]

Field specifiers for querying the table of contents.

Enumerator
FRAME_H_FIELD_LAST 

Marker specifying the end of a frame query.

FRAME_H_FIELD_NAME 

Desciption.

Name of the project or other experiment description

(e.g., GEO; LIGO; VIRGO; TAMA; ... )

FRAME_H_FIELD_RUN 

Run number.

Run number ( number < 0 reserved for simulated data); monotonic for experimental runs.

FRAME_H_FIELD_FRAME 

Frame number.

Frame number, monotonically increasing until end of run, re-startarting from 0 with each new run.

FRAME_H_FIELD_DATA_QUALITY 

Data quality flag.

A logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for various GW detectors.

FRAME_H_FIELD_GTIME 

Frame start time.

GPS start time of the frame.

FRAME_H_FIELD_ULEAPS 

Leap seconds between GPS/TAI and UTC.

The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

FRAME_H_FIELD_DT 

Frame length in seconds.

FRAME_H_FIELD_LAST 

Marker specifying the end of a frame query.

FRAME_H_FIELD_NAME 

Desciption.

Name of the project or other experiment description

(e.g., GEO; LIGO; VIRGO; TAMA; ... )

FRAME_H_FIELD_RUN 

Run number.

Run number ( number < 0 reserved for simulated data); monotonic for experimental runs.

FRAME_H_FIELD_FRAME 

Frame number.

Frame number, monotonically increasing until end of run, re-startarting from 0 with each new run.

FRAME_H_FIELD_DATA_QUALITY 

Data quality flag.

A logical 32-bit word to denote top level quality of data. Lowest order bits are reserved in pairs for various GW detectors.

FRAME_H_FIELD_GTIME 

Frame start time.

GPS start time of the frame.

FRAME_H_FIELD_ULEAPS 

Leap seconds between GPS/TAI and UTC.

The integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].

FRAME_H_FIELD_DT 

Frame length in seconds.

◆ std_detectors [1/2]

Standard detectors.

Enumerator
DETECTOR_LOCATION_H1 
DETECTOR_LOCATION_H2 
DETECTOR_LOCATION_L1 
DETECTOR_LOCATION_V1 
DETECTOR_LOCATION_H1 
DETECTOR_LOCATION_H2 
DETECTOR_LOCATION_L1 
DETECTOR_LOCATION_V1 

◆ std_detectors [2/2]

Standard detectors.

Enumerator
DETECTOR_LOCATION_H1 
DETECTOR_LOCATION_H2 
DETECTOR_LOCATION_L1 
DETECTOR_LOCATION_V1 
DETECTOR_LOCATION_H1 
DETECTOR_LOCATION_H2 
DETECTOR_LOCATION_L1 
DETECTOR_LOCATION_V1 

Function Documentation

◆ FrameCCleanup()

void FrameCCleanup ( void  )

Cleanup the library.

◆ FrameCErrorInit()

void FrameCErrorInit ( FrameCError **  Handle)

◆ FrameCFrameHAlloc()

frame_h_t * FrameCFrameHAlloc ( FrameCError **  Error,
const char *  Name,
frame_h_gtime_t  Start,
frame_h_dt_t  Dt,
frame_h_frame_t  FrameNumber 
)

Allocate a fr_frame structure.

Note
This method should be used as there may be additional data allocated to properly interface to the C++ layer.
Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]NameName of project.
[in]StartGPS start time of frame.
[in]DtDuration of frame.
[in]FrameNumberFrame number since start of run.
Returns
Pointer to newly allocated frame_h_t. If a failure happens, a NULL pointer will be returned.

◆ FrameCFrameHFrChanAdd()

int FrameCFrameHFrChanAdd ( FrameCError **  Error,
frame_h_t Frame,
fr_chan_t Channel 
)

Add a channel to the frame.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]FrameThe frame to which the channel data is to be added.
[in]ChannelThe channel to be added.

◆ FrameCFrameHFrDetectorAdd()

int FrameCFrameHFrDetectorAdd ( FrameCError **  Error,
frame_h_t Frame,
fr_detector_t Detector 
)

Add a detector to the frame.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]FrameThe frame to which the detector data is to be added.
[in]DetectorThe detector to be added.

◆ FrameCFrameHFree()

int FrameCFrameHFree ( FrameCError **  Error,
frame_h_t frame 
)

◆ FrameCFrameHFrEventAdd()

int FrameCFrameHFrEventAdd ( FrameCError **  Error,
frame_h_t Frame,
fr_event_t Event 
)

Add an event to the frame.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]FrameThe frame to which the history data is to be added.
[in]EventThe event to be added.

◆ FrameCFrameHFrHistoryAdd()

int FrameCFrameHFrHistoryAdd ( FrameCError **  Error,
frame_h_t Frame,
fr_history_t History 
)

Add history to the frame.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]FrameThe frame to which the history data is to be added.
[in]HistoryThe history to be added.

◆ FrameCFrameHQuery()

void FrameCFrameHQuery ( FrameCError **  Error,
const frame_h_t Frame,
int  Option,
  ... 
)

Retrieve vector information related to the Table of Contents.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]FrameA FrameH to query.
[in]OptionField to query.
[in]...Parameters as dictated by the Option.

Retrieve information about the FrameH structure. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FRAME_H_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FRAME_H_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FRAME_H_FIELD_DATA_QUALITY

    Retrieve the data quality flag of the frame. A single argument should follow this option. The argument needs to be the address of type frame_h_data_quality_t The frame number will be stored here.

  • FRAME_H_FIELD_DT

    Retrieve the frame length. A single argument should follow this option. The argument needs to be the address of type frame_h_dt_t The length of the frame will be stored here.

  • FRAME_H_FIELD_GTIME

    Retrieve the start time of the frame. A single argument should follow this option. The argument needs to be the address of type frame_h_gtime_t The frame start time will be stored here.

  • FRAME_H_FIELD_FRAME

    Retrieve the frame number of the frame. A single argument should follow this option. The argument needs to be the address of type frame_h_frame_t The frame number will be stored here.

  • FRAME_H_FIELD_NAME

    Retrieve the name of the project or other experiment description. A single argument should follow this option. The argument needs to be the address of type frame_h_name_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the frame_h_t object exists.

  • FRAME_H_FIELD_RUN

    Retrieve the run number of the frame. A single argument should follow this option. The argument needs to be the address of type frame_h_run_t The run number will be stored here.

  • FRAME_H_FIELD_ULEAPS

    Retrieve the leap seconds for the frame. A single argument should follow this option. The argument needs to be the address of type frame_h_uleaps_t The numer of leap seconds will be stored here.

◆ FrameCFrameHRead()

frame_h_t * FrameCFrameHRead ( FrameCError **  Error,
fr_file_t *restrict  Stream,
frame_h_offset_t  Pos 
)

Read a FrameH structure from the file.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]StreamThe stream from which to read the FrameH.
[in]PosThe offset in the stream from which to read the channel.

◆ FrameCFrameHReadNext()

frame_h_t * FrameCFrameHReadNext ( FrameCError **  Error,
fr_file_t *restrict  Stream 
)

Read a FrameH structure from the file.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]StreamThe stream from which to read the FrameH.
Note
This function has the potential to consume a large amount of system resources as the full frame is pulled into memory.

◆ FrameCFrameHSet()

void FrameCFrameHSet ( FrameCError **  Error,
const frame_h_t Frame,
int  Option,
  ... 
)

Set values for the FrameH structure.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]Frame
[in]OptionField to set.
[in]...Parameters as dictated by the Option.

Set information about the FrameH structure. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be set by having multiple Option/parameter sets. The last value for Option must be FRAME_H_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FRAME_H_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FRAME_H_FIELD_RUN

    Set the run number of the frame. A single argument should follow this option. The argument needs to be of type frame_h_run_t and contains the new value for the run number.

◆ FrameCFrameHWrite()

int FrameCFrameHWrite ( FrameCError **  Error,
fr_file_t *restrict  stream,
frame_h_t *restrict  frame 
)

Write the frame to the stream.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in,out]streamThe output stream where the object is to be written.
[in]frameThe frame to be written to the stream

◆ FrameCFrameHWriteCompressed()

int FrameCFrameHWriteCompressed ( FrameCError **  Error,
fr_file_t *restrict  stream,
frame_h_t *restrict  frame,
fr_vect_compression_schemes_t  compression,
fr_vect_compression_level_t  level 
)

Write the frame to the stream.

Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in,out]streamThe output stream where the object is to be written.
[in]frameThe frame to be written to the stream
[in]compressionThe method for compression
[in]levelLevel of compression for methods that support multipler levels of compression.

◆ FrameCFrChanAlloc()

fr_chan_t * FrameCFrChanAlloc ( FrameCError **  Error,
const char *  Name,
fr_chan_type_t  Type,
fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)

Alloc an fr_chan_t.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]NameThe name for the channel.
[in]TypeThe fr_chan_type to be created. All except for FR_PROC_CHAN_TYPE can be allocated. Please refer to FrProcChanalloc() if a channel of type FR_PROC_CHAN_TYPE needs to be allocated.
[in]DataTypeSpecifier for the type of data to be stored in the vector.
[in]NDataThe number of data elements the vector needs to have.
Returns
Pointer to newly allocated fr_chan_t. If a failure happens, a NULL pointer will be returned.

◆ FrameCFrChanFree()

void FrameCFrChanFree ( FrameCError **  Error,
fr_chan_t Channel 
)

Recyle the fr_chan_t structure.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]ChannelThe channel resouce to be recycled.

◆ FrameCFrChanQuery()

void FrameCFrChanQuery ( FrameCError **  Error,
const fr_chan_t Channel,
int  Option,
  ... 
)

Retrieve information related to the Channel.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelA channel to query.
[in]OptionField to query.
[in]...Parameters as dictated by the Option.

Retrieve information about the channel structure. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FR_CHAN_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_CHAN_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_CHAN_FIELD_COMMENT

    Retrieve the comment associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_comment_t. The comment associated with the channel will be stored here.

    Todo:
    Inform user that the specified channel does not support querying of this parameter.

  • FR_CHAN_FIELD_CHANNEL_GROUP

    Retrieve the numeric group identifier associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_channel_group_t. The name of the channel will be stored here. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_CHANNEL_NUMBER

    Retrieve the numeric identifier associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_channel_number_t. The name of the channel will be stored here. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_NAME

    Retrieve the name associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_name_t. The name of the channel will be stored here.

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_SAMPLE_RATE

    Retrieve the sample rate associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_sample_rate_t. The name of the channel will be stored here.

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_TIME_OFFSET

    Retrieve the sample rate associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_sample_rate_t. The name of the channel will be stored here.

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

◆ FrameCFrChanRead()

fr_chan_t * FrameCFrChanRead ( FrameCError **  Error,
fr_file_t *restrict  Stream,
fr_chan_name_t restrict  Name,
fr_chan_offset_t  Pos 
)

Read a channel from the stream.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]StreamThe stream from which to read the table of contents.
[in]NameThe name of the channel to be read.
[in]PosThe offset in the stream from which to read the channel.
Returns
Upon successful completion, a newly allocated fr_chan_t structure is returned. It is the responsibility of the user to call FrameCFrChanFree to recycle this resource.

◆ FrameCFrChanSet()

void FrameCFrChanSet ( FrameCError **  Error,
const fr_chan_t Channel,
int  Option,
  ... 
)

Establish information about the Channel.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelA channel to modify.
[in]OptionField to modify.
[in]...Parameters as dictated by the Option.

Establish values for the given channel The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be set by having multiple Option/parameter sets. The last value for Option must be FR_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_VECT_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_CHAN_FIELD_CHANNEL_GROUP

    Set the numeric group identifier associated with the channel. A single argument should follow this option. The argument needs to be of storage type fr_chan_channel_group_t. and contain the group identifier. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_CHANNEL_NUMBER

    Set the numeric identifier associated with the channel. A single argument should follow this option. The argument needs to be the address of storage of type fr_chan_channel_number_t. The name of the channel will be stored here. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_COMMENT

    Set the comment for the specified channel. A single argument should follow this option. The argument needs to be of type fr_chan_comment_t and initialized with the comment value. Available for: FR_ADC_CHAN_TYPE, FR_PROC_CHAN_TYPE, FR_SIM_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_DATA_VALID

    Set the validity of the data for the specified channel. A single argument should follow this option. The argument needs to be of type fr_chan_data_valid_t and initialized with the data valid flag value. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_N_BITS

    Set the number of bits for the specified channel. A single argument should follow this option. The argument needs to be of type fr_chan_n_bits_t and initialized with the number of bits. Available for: FR_ADC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_SAMPLE_RATE

    Set the sample rate for the specified channel. A single argument should follow this option. The argument needs to be of type fr_chan_sample_rate_t and initialized with the sample rate value. Available for: FR_ADC_CHAN_TYPE, FR_SIM_CHAN_TYPE

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_TIME_OFFSET

    Set the time offfset of the 1st sample relative to the frame start time (secondes). The value must be positive and smaller than the frame length. Available for: FR_ADC_CHAN_TYPE, FR_PROC_CHAN_TYPE, FR_SIM_CHAN_TYPE

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

  • FR_CHAN_FIELD_T_RANGE

    Set the time range for the specified channel. A single argument should follow this option. The argument needs to be of type fr_chan_t_range_t and initialized with the time range. Available for: FR_PROC_CHAN_TYPE,

    Todo:
    Inform user that the specified channel does not support setting of sample rate.

◆ FrameCFrChanVectorAlloc()

void FrameCFrChanVectorAlloc ( FrameCError **  Error,
fr_chan_t Channel,
fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)

Allocate new space for an FrVect.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelThe channel containing the data vector to compress.
[in]DataTypeSpecifier for the type of data to be stored in the vector.
[in]NDataThe number of data elements the vector needs to have.

◆ FrameCFrChanVectorCompress()

void FrameCFrChanVectorCompress ( FrameCError **  Error,
fr_chan_t Channel,
fr_vect_compression_schemes_t  Scheme 
)

Expand the data located in the data vector.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelThe channel containing the data vector to compress.
[in]SchemeMethod to use to compress the data.

◆ FrameCFrChanVectorExpand()

void FrameCFrChanVectorExpand ( FrameCError **  Error,
fr_chan_t Channel 
)

Expand the data located in the data vector.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelThe channel containing the data vector to expand.

Expand the data located in the data vector.

◆ FrameCFrChanVectorQuery()

void FrameCFrChanVectorQuery ( FrameCError **  Error,
const fr_chan_t Channel,
int  Option,
  ... 
)

Retrieve vector information related to the Channel.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelA channel to query.
[in]OptionField to query.
[in]...Parameters as dictated by the Option.

Retrieve information about the FrVector structure associated with the channel. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FR_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_VECT_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_VECT_FIELD_COMPRESS

    Retrieve the compression method used on the data. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_compress_t. The compression method used on the data of the vector will be stored here.

  • FR_VECT_FIELD_DATA

    Retrieve the data associated with the vector. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_data_t. This data is read-only.

  • FR_VECT_FIELD_DX

    Retrieve the sample length along each coordinate. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_dx_t and must be sufficiently large to hold fr_vect_ndim_t elements. The sample length of each dimension will be stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_NAME

    Retrieve the name associated with the vector. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_name_t. This data is read-only.

  • FR_VECT_FIELD_NBYTES

    Retrieve the number of bytes in the compressed vector. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_nbytes_t. The number of byrtes in the compressed vector will be stored here.

  • FR_VECT_FIELD_NDATA

    Retrieve the number of sample elements in the data series. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_ndata_t. The number of sample elements in the data series will be stored here.

  • FR_VECT_FIELD_NDIM

    Retrieve the number of dimensions for the vector. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_ndim_t. The number of dimensions for the vector will be stored here.

  • FR_VECT_FIELD_NX

    Retrieve the dimension lengths. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_nx_t and must be sufficiently large to hold fr_vect_ndim_t elements. The length of each dimension will be stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_START_X

    Retrieve the origin for each data set. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_start_x_t and must be sufficiently large to hold fr_vect_ndim_t elements. The start of each data set will be stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_TYPE

    Retrieve the vector class. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_type_t. The vector class will be stored here.

  • FR_VECT_FIELD_UNIT_X

    Retrieve the descriptions of each element. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_unit_x_t and must be sufficiently large to hold fr_vect_ndim_t elements. The description of each element. will be stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_UNIT_Y

    Retrieve the unit_y associated with the vector. A single argument should follow this option. The argument needs to be the address of storage of type fr_vect_unit_y_t. This data is read-only.

◆ FrameCFrChanVectorSet()

void FrameCFrChanVectorSet ( FrameCError **  Error,
fr_chan_t Channel,
int  Option,
  ... 
)

Set vector information related to the Channel.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]ChannelA channel to modify.
[in]OptionField to set.
[in]...Parameters as dictated by the Option.

Retrieve information about the FrVector structure associated with the channel. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FR_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_VECT_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_VECT_FIELD_DATA

    Set the data values of the vector. Three arguments should follow this option. The first argument needs to be of type fr_vect_data_t. The second argument needs to be of type int casting of fr_vect_data_types_t because of argument promotion rules and contains the type appropriate for the data referenced by the first argument. The third argument needs to be of type fr_ndata_t and contain the number of data elements.

    Todo:
    Produce error message because the data type or number of data elements is not consistant.

  • FR_VECT_FIELD_DX

    Set the sample length along each coordinate. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_dx_t and must be sufficiently large to hold fr_vect_ndim_t elements. The sample length of each dimension is stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_NAME

    Set the name associated with the vector. A single argument should follow this option. The argument needs to be of type fr_vect_name_t. This data is read-only.

  • FR_VECT_FIELD_NX

    Set the dimension lengths along each coordinate. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_nx_t and must be sufficiently large to hold fr_vect_ndim_t elements. The sample length of each dimension is stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_START_X

    Set the origin of each data set. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_startx_t and must be sufficiently large to hold fr_vect_ndim_t elements. The origin of each data set is stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_UNIT_X

    Set the ASCII scale factor of each data set. Two arguments should follow this option. The first argument needs to be a pointer of type fr_vect_unit_x_t and must be sufficiently large to hold fr_vect_ndim_t elements. The origin of each data set is stored here. The second arguemnt needs to be of type fr_vect_ndim_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_VECT_FIELD_UNIT_Y

    Set the description of how to interpret the value of each element.

◆ FrameCFrDetectorAlloc()

fr_detector_t * FrameCFrDetectorAlloc ( FrameCError **  Error,
const char *restrict  name,
const char *restrict  prefix,
fr_detector_latitude_t  latitude,
fr_detector_longitude_t  longitude,
fr_detector_elevation_t  elevation,
fr_detector_arm_x_azimuth_t  azimuth_x,
fr_detector_arm_y_azimuth_t  azimuth_y,
fr_detector_arm_x_altitude_t  altitude_x,
fr_detector_arm_y_altitude_t  altitude_y,
fr_detector_arm_x_midpoint_t  midpoint_x,
fr_detector_arm_y_midpoint_t  midpoint_y,
fr_detector_localtime_t  localtime 
)

Allocate a new Detector structure.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]nameInstrument name as described in Appendix D of the frame spec.
[in]prefixChannel prefix for this detector as described in Appendix D.
[in]latitudeDetector vertex latitude, geographical coordinates.
[in]longitudeDetector vertex longitude, geographical coordinates.
[in]elevationVertex elevation, meters, relative to WGS84 ellipsoid.
[in]azimuth_xOrientations of X arm, measured in radians East of North.
[in]azimuth_yOrientations of Y arm, measured in radians East of North.
[in]altitude_xAltitude (pitch) angle of X arm, measured in radians.
[in]altitude_yAltitude (pitch) angle of Y arm, measured in radians.
[in]midpoint_xDistance between the detector vertex and middle of the X cavity (meters).
[in]midpoint_yDistance between the detector vertex and middle of the Y cavity (meters).
[in]localtimeLocal seasonal time - UTC in seconds.
Returns
Upon successful completion, a newly allocated fr_detector_t is returned. It is the responsibility of the user to call FrDetectorFree to recycle this resource.

◆ FrameCFrDetectorFree()

void FrameCFrDetectorFree ( FrameCError **  Error,
fr_detector_t detector 
)

Recyle the detector structure.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]detectorThe detector resouce to be recycled.

◆ FrameCFrDetectorQuery()

void FrameCFrDetectorQuery ( FrameCError **  Error,
const fr_detector_t Detector,
int  Option,
  ... 
)

Retrieve vector information related to the Table of Contents.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]DetectorA FrDetector to query.
[in]OptionField to query.
[in]...Parameters as dictated by the Option.

Retrieve information about the FrDetector structure. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FR_DETECTOR_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_DETECTOR_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_DETECTOR_FIELD_ARM_X_ALTITUDE

    Retrieve the arm_x_altitude of the instrument arm_x_altitude. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_x_altitude_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ARM_X_AZIMUTH

    Retrieve the arm_x_azimuth of the instrument arm_x_azimuth. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_x_azimuth_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ARM_X_MIDPOINT

    Retrieve the arm_x_midpoint of the instrument arm_x_midpoint. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_x_midpoint_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ARM_Y_ALTITUDE

    Retrieve the arm_y_altitude of the instrument arm_y_altitude. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_y_altitude_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ARM_Y_AZIMUTH

    Retrieve the arm_y_azimuth of the instrument arm_y_azimuth. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_y_azimuth_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ARM_Y_MIDPOINT

    Retrieve the arm_y_midpoint of the instrument arm_y_midpoint. A single argument should follow this option. The argument needs to be the address of type fr_detector_arm_y_midpoint_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_ELEVATION

    Retrieve the detector vertex elevation. A single argument should follow this option. The argument needs to be the address of type fr_detector_elevation_t The detector's vertex elevation will be stored here.

  • FR_DETECTOR_FIELD_LATITUDE

    Retrieve the detector vertex latitude. A single argument should follow this option. The argument needs to be the address of type fr_detector_latitude_t The detector's vertex latitude will be stored here.

  • FR_DETECTOR_FIELD_LOCAL_TIME

    Retrieve the detector local time. A single argument should follow this option. The argument needs to be the address of type fr_detector_local_time_t The detector's local time will be stored here.

  • FR_DETECTOR_FIELD_LONGITUDE

    Retrieve the detector vertex longitude. A single argument should follow this option. The argument needs to be the address of type fr_detector_longitude_t The detector's vertex longitude will be stored here.

  • FR_DETECTOR_FIELD_NAME

    Retrieve the name of the instrument name. A single argument should follow this option. The argument needs to be the address of type fr_detector_name_t The description will be stored here. NOTE: This is a shallow pointer which is only valid while the fr_detector_t object exists.

  • FR_DETECTOR_FIELD_PREFIX

    Retrieve the name of the instrument name. A single argument should follow this option. The argument needs to be the address of type fr_detector_prefix_t The prefix will be stored here.

◆ FrameCFrDetectorRead()

fr_detector_t * FrameCFrDetectorRead ( FrameCError **  Error,
fr_file_t *restrict  Stream,
const char *restrict  Name 
)

Read a new Detector structure.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]StreamThe stream from which to read the detector.
[in]NameInstrument name.
Returns
Upon successful completion, a newly allocated fr_detector_t is returned. It is the responsibility of the user to call FrDetectorFree to recycle this resource.

◆ FrameCFrDetectorWrite()

int FrameCFrDetectorWrite ( FrameCError **  Error,
fr_file_t *restrict  Stream,
const fr_detector_t *restrict  Detector 
)

Write a Detector structure to the stream.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]StreamThe stream on which to write the detector.
[in]DetectorThe detector to write to the stream.
Returns
A value of 1 is returned on success; zero otherwise.

◆ FrameCFrEventAlloc()

fr_event_t * FrameCFrEventAlloc ( FrameCError **  Error,
const fr_event_name_t  Name,
const fr_event_comment_t  Comment,
const fr_event_inputs_t  Inputs,
const fr_event_gtime_t  GTime,
const fr_event_time_before_t  TimeBefore,
const fr_event_time_after_t  TimeAfter,
const fr_event_event_status_t  EventStatus,
const fr_event_amplitude_t  Amplitude,
const fr_event_probability_t  Probability,
const fr_event_statistics_t  Statistics,
const fr_event_n_param_t  NParam,
const fr_event_parameters_t Parameters 
)

Allocate a fr_frame structure.

Note
This method should be used as there may be additional data allocated to properly interface to the C++ layer.
Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]NameName of event.
[in]CommentDescriptor of event.
[in]InputsInput channels and filter parameters to event process.
[in]GTimeGPS time corresponding to reference value of event.
[in]TimeBeforeSignal duration before time.
[in]TimeAfterSignal duration after time.
[in]EventStatusDefined by event search algorithm.
[in]AmplitudeContinuous output amplitude returned by event.
[in]ProbabilityLikelihood estimate of event.
[in]StatisticsStatistical description of event.
[in]NParamNumber of additional event parameters.
[in]ParametersArray of additional event parameters.
Returns
Pointer to newly allocated fr_event_t. If a failure happens, a NULL pointer will be returned.

◆ FrameCFrEventFree()

int FrameCFrEventFree ( FrameCError **  Error,
fr_event_t Event 
)

◆ FrameCFrHistoryAlloc()

fr_history_t * FrameCFrHistoryAlloc ( FrameCError **  Error,
const char *  Name,
fr_history_time_t  Time,
const char *  Comment 
)

Allocate a fr_frame structure.

Note
This method should be used as there may be additional data allocated to properly interface to the C++ layer.
Parameters
[out]ErrorIf an error occurs, Error will be non-NULL and a detailed error message will be available.
[in]NameName of the history record
[in]TimeTime of post-processing (GPS seconds since GPS standard epoch)
[in]CommentProgram name and relevant comments needed to define post-processing
Returns
Pointer to newly allocated frame_h_t. If a failure happens, a NULL pointer will be returned.

◆ FrameCFrHistoryFree()

int FrameCFrHistoryFree ( FrameCError **  Error,
fr_history_t History 
)

◆ FrameCFrProcChanAlloc()

fr_chan_t * FrameCFrProcChanAlloc ( FrameCError **  Error,
const char *  Name,
fr_proc_type_t  Type,
fr_proc_sub_type_t  SubType,
fr_vect_data_types_t  DataType,
fr_vect_ndata_t  NData 
)

Alloc an fr_chan_t.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]NameThe name for the channel.
[in]TypeThe fr_proc_type to be created.
[in]SubTypeThe fr_proc_sub_type to be created.
[in]DataTypeSpecifier for the type of data to be stored in the vector.
[in]NDataThe number of data elements the vector needs to have.
Returns
Pointer to newly allocated fr_chan_t. If a failure happens, a NULL pointer will be returned.

◆ FrameCFrProcMimeChanAlloc()

fr_chan_t * FrameCFrProcMimeChanAlloc ( FrameCError **  Error,
const char *  Name,
const char *  MimeTypeName,
fr_vect_ndata_t  NData,
fr_vect_data_t  MimeData 
)

Alloc an fr_chan_t.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]NameThe name for the channel.
[in]MimeTypeNameThe ASCII representation of the mime type
[in]NDataThe number of data elements the vector needs to have.
[in]MimeDataThe mime stream.
Returns
Pointer to newly allocated fr_chan_t. If a failure happens, a NULL pointer will be returned.
Todo:
Currently the DataType and NData fields are not being used. Either they need to be eliminated or used to create an appropriate FrVect for data storage.

◆ FrameCFrTOCFree()

void FrameCFrTOCFree ( FrameCError **  Error,
fr_toc_t TOC 
)

Recyle the table of contents structure.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]TOCThe table of contents resouce to be recycled.

This function simply recycles resources allocated by FrTOCRead. Once the resource have been recyled, the resource are no longer available to the application for use.

◆ FrameCFrTOCQuery()

void FrameCFrTOCQuery ( FrameCError **  Error,
const fr_toc_t TOC,
int  Option,
  ... 
)

Retrieve vector information related to the Table of Contents.

Parameters
[out]ErrorA place to report any errors occuring from this call.
[in]TOCA TOC to query.
[in]OptionField to query.
[in]...Parameters as dsctated by the Option.

Retrieve information about the FrTOC structure associated with the stream. The Option parameter dictates the number and type of parameters to follow. Multiple pieces of information can be retrieved by having multiple Option/parameter sets. The last value for Option must be FR_TOC_FIELD_LAST to indicate the end of the variable length argument list.

The following is a discription of each value of Option and the parameters it takes.

  • FR_TOC_FIELD_LAST

    This is the last option in the list and specifies the end of the query.

  • FR_TOC_FIELD_ADC_N

    Retrieve the number of adc channels in the stream. A single argument should follow this option. The argument needs to be the address of storage of type fr_toc_adc_n_t. The number of adc channels in the stream will be stored here.

  • FR_TOC_FIELD_ADC_NAMES

    Retrieve a list of the adc names in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_adc_names_t and must be sufficiently large to hold fr_toc_adc_n_t elements. The name of each adc will be stored here. The second arguemnt needs to be of type fr_toc_adc_n_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_TOC_FIELD_DETECTOR_N

    Retrieve the number of detectors in the stream. A single argument should follow this option. The argument needs to be the address of storage of type fr_toc_detector_n_t. The number of detectors in the stream will be stored here.

  • FR_TOC_FIELD_DETECTOR_NAMES

    Retrieve a list of the detector names in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_detector_names_t and must be sufficiently large to hold fr_toc_detector_n_t elements. The name of each detector will be stored here. The second arguemnt needs to be of type fr_toc_detector_n_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_TOC_FIELD_NFRAME

    Retrieve the number of frames in the stream. A single argument should follow this option. The argument needs to be the address of storage of type fr_toc_nframe_t. The number of frames in the stream will be stored here.

  • FR_TOC_FIELD_DT

    Retrieve the duration of each frame in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_dt_t and must have sufficiently large to hold nFrame elements. The duration of each frame will be stored here. The second arguemnt needs to be of type fr_toc_nframe_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_TOC_FIELD_GTIME

    Retrieve the start time of each frame in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_dt_t and must have sufficiently large to hold nFrame elements. The duration of each frame will be stored here. The second arguemnt needs to be of type fr_toc_nframe_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_TOC_FIELD_PROC_N

    Retrieve the number of proc channels in the stream. A single argument should follow this option. The argument needs to be the address of storage of type fr_toc_proc_n_t. The number of proc channels in the stream will be stored here.

  • FR_TOC_FIELD_PROC_NAMES

    Retrieve a list of the proc names in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_proc_names_t and must be sufficiently large to hold fr_toc_proc_n_t elements. The name of each proc will be stored here. The second arguemnt needs to be of type fr_toc_proc_n_t and contains the maximum number of elements that can be stored in previous argument.

  • FR_TOC_FIELD_SIM_N

    Retrieve the number of sim channels in the stream. A single argument should follow this option. The argument needs to be the address of storage of type fr_toc_sim_n_t. The number of sim channels in the stream will be stored here.

  • FR_TOC_FIELD_SIM_NAMES

    Retrieve a list of the sim names in the stream. Two arguments should follow this option. The first argument needs to be of type fr_toc_sim_names_t and must be sufficiently large to hold fr_toc_sim_n_t elements. The name of each sim will be stored here. The second arguemnt needs to be of type fr_toc_sim_n_t and contains the maximum number of elements that can be stored in previous argument.

◆ FrameCFrTOCRead()

fr_toc_t * FrameCFrTOCRead ( FrameCError **  Error,
fr_file_t Stream 
)

Obtain the table of contensts.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]StreamThe stream from which to read the table of contents.
Returns
Upon successful completion, a newly allocated fr_toc_t structure is returned. It is the responsibility of the user to call FrameCFrTOCFree to recycle this resource.

Read a subset of the table of contents information.

Note
Currently, this function is currently limited to input streams.

◆ FrameCGetDetector()

fr_detector_t * FrameCGetDetector ( FrameCError **  Error,
std_detectors  Type,
const gpstime_t *restrict  Time 
)

Retrieve information about some standard detectors.

Parameters
[out]ErrorIf an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError.
[in]TypeThis is the interferometer's designation.
[in]TimeThis is the time for which to check the designation. This will rarely change the results, but in the situations where it does, it is critical. The time should be the start time of the frame.

This will retrieve information about standard interferometers. The caller is responsible for releasing the handle back to the system. The handle may be modified as the changes are local only to the returned handle.

◆ FrameCGPSTimeNow()

gpstime_seconds_t FrameCGPSTimeNow ( void  )

◆ FrameCInitialize()

void FrameCInitialize ( void  )

Initialize the library.

◆ FrameCLibraryMinorVersion()

INT_2U FrameCLibraryMinorVersion ( void  )

Return the minor version number of the frame library.

Returns
The minor version number of the frame software. This value is assiged by the developer of the frame library and is only meaningful when compared to other values for the same frame library.