ldas-tools-framecpp 2.8.1
|
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 |
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 |
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 struct fr_adc_chan fr_adc_chan_t |
Type aliasing for FrAdc channel.
typedef struct fr_adc_chan fr_adc_chan_t |
Type aliasing for FrAdc channel.
typedef struct fr_adc_chan fr_adc_chan_t |
Type aliasing for FrAdc channel.
typedef struct fr_chan fr_chan_t |
Type aliasing for fr_chan structure.
typedef struct fr_chan fr_chan_t |
Type aliasing for fr_chan structure.
typedef struct fr_chan fr_chan_t |
Type aliasing for fr_chan structure.
typedef enum fr_chan_type fr_chan_type_t |
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.
typedef enum fr_chan_type fr_chan_type_t |
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.
typedef enum fr_chan_type fr_chan_type_t |
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.
typedef REAL_4 fr_detector_arm_x_altitude_t |
x axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_altitude_t |
x axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_altitude_t |
x axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_azimuth_t |
x axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_azimuth_t |
x axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_azimuth_t |
x axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_midpoint_t |
x axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_midpoint_t |
x axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_x_midpoint_t |
x axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_altitude_t |
y axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_altitude_t |
y axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_altitude_t |
y axis altitude as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_azimuth_t |
y axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_azimuth_t |
y axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_azimuth_t |
y axis azimuth as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_midpoint_t |
y axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_midpoint_t |
y axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_arm_y_midpoint_t |
y axis midpoint as used in the fr_detector structure.
typedef REAL_4 fr_detector_elevation_t |
elevation as used in the fr_detector structure.
typedef REAL_4 fr_detector_elevation_t |
elevation as used in the fr_detector structure.
typedef REAL_4 fr_detector_elevation_t |
elevation as used in the fr_detector structure.
typedef enum fr_detector_fields_ fr_detector_fields |
Field specifiers for querying the table of contents.
typedef enum fr_detector_fields_ fr_detector_fields |
Field specifiers for querying the table of contents.
typedef enum fr_detector_fields_ fr_detector_fields |
Field specifiers for querying the table of contents.
typedef REAL_8 fr_detector_latitude_t |
latitude as used in the fr_detector structure.
typedef REAL_8 fr_detector_latitude_t |
latitude as used in the fr_detector structure.
typedef REAL_8 fr_detector_latitude_t |
latitude as used in the fr_detector structure.
typedef INT_4S fr_detector_localtime_t |
local seasonal time as used in the fr_detector structure.
typedef INT_4S fr_detector_localtime_t |
local seasonal time as used in the fr_detector structure.
typedef INT_4S fr_detector_localtime_t |
local seasonal time as used in the fr_detector structure.
typedef REAL_8 fr_detector_longitude_t |
longitude as used in the fr_detector structure.
typedef REAL_8 fr_detector_longitude_t |
longitude as used in the fr_detector structure.
typedef REAL_8 fr_detector_longitude_t |
longitude as used in the fr_detector structure.
typedef const char* fr_detector_name_t |
Instrument name.
typedef const char* fr_detector_name_t |
Instrument name.
typedef const char* fr_detector_name_t |
Instrument name.
typedef struct fr_detector fr_detector_t |
typedef struct fr_detector fr_detector_t |
typedef struct fr_detector fr_detector_t |
typedef gpstime_t fr_event_gtime_t |
typedef gpstime_t fr_event_gtime_t |
typedef gpstime_t fr_event_gtime_t |
typedef FR_EVENT_NAME_TYPE fr_event_name_t |
typedef FR_EVENT_NAME_TYPE fr_event_name_t |
typedef FR_EVENT_NAME_TYPE fr_event_name_t |
typedef struct fr_event fr_event_t |
typedef struct fr_event fr_event_t |
typedef struct fr_event fr_event_t |
typedef struct fr_history fr_history_t |
typedef struct fr_history fr_history_t |
typedef struct fr_history fr_history_t |
typedef INT_4U fr_history_time_t |
typedef INT_4U fr_history_time_t |
typedef INT_4U fr_history_time_t |
typedef struct fr_proc_chan fr_proc_chan_t |
Type aliasing for FrProc channel.
typedef struct fr_proc_chan fr_proc_chan_t |
Type aliasing for FrProc channel.
typedef struct fr_proc_chan fr_proc_chan_t |
Type aliasing for FrProc channel.
typedef enum fr_proc_sub_type fr_proc_sub_type_t |
Sub types of FrProcData.
typedef enum fr_proc_sub_type fr_proc_sub_type_t |
Sub types of FrProcData.
typedef enum fr_proc_sub_type fr_proc_sub_type_t |
Sub types of FrProcData.
typedef enum fr_proc_type fr_proc_type_t |
Types of FrProcData.
typedef enum fr_proc_type fr_proc_type_t |
Types of FrProcData.
typedef enum fr_proc_type fr_proc_type_t |
Types of FrProcData.
typedef struct fr_sim_chan fr_sim_chan_t |
Type aliasing for FrSimData channel.
typedef struct fr_sim_chan fr_sim_chan_t |
Type aliasing for FrSimData channel.
typedef struct fr_sim_chan fr_sim_chan_t |
Type aliasing for FrSimData channel.
typedef INT_4U fr_toc_adc_n_t |
typedef INT_4U fr_toc_adc_n_t |
typedef INT_4U fr_toc_adc_n_t |
typedef const char* fr_toc_adc_name_t |
typedef const char* fr_toc_adc_name_t |
typedef const char* fr_toc_adc_name_t |
typedef INT_4U fr_toc_detector_n_t |
typedef INT_4U fr_toc_detector_n_t |
typedef INT_4U fr_toc_detector_n_t |
typedef const char* fr_toc_detector_name_t |
typedef const char* fr_toc_detector_name_t |
typedef const char* fr_toc_detector_name_t |
typedef REAL_8 fr_toc_dt_element_t |
Delta time as used in the fr_toc structure.
typedef REAL_8 fr_toc_dt_element_t |
Delta time as used in the fr_toc structure.
typedef REAL_8 fr_toc_dt_element_t |
Delta time as used in the fr_toc structure.
typedef fr_toc_dt_element_t* fr_toc_dt_t |
typedef fr_toc_dt_element_t* fr_toc_dt_t |
typedef fr_toc_dt_element_t* fr_toc_dt_t |
typedef enum fr_toc_fields_ fr_toc_fields |
Field specifiers for querying the table of contents.
typedef enum fr_toc_fields_ fr_toc_fields |
Field specifiers for querying the table of contents.
typedef enum fr_toc_fields_ fr_toc_fields |
Field specifiers for querying the table of contents.
typedef INT_4U fr_toc_nframe_t |
typedef INT_4U fr_toc_nframe_t |
typedef INT_4U fr_toc_nframe_t |
typedef INT_4U fr_toc_proc_n_t |
typedef INT_4U fr_toc_proc_n_t |
typedef INT_4U fr_toc_proc_n_t |
typedef const char* fr_toc_proc_name_t |
typedef const char* fr_toc_proc_name_t |
typedef const char* fr_toc_proc_name_t |
typedef INT_4U fr_toc_sim_n_t |
typedef INT_4U fr_toc_sim_n_t |
typedef INT_4U fr_toc_sim_n_t |
typedef const char* fr_toc_sim_name_t |
typedef const char* fr_toc_sim_name_t |
typedef const char* fr_toc_sim_name_t |
typedef struct fr_toc_t_ fr_toc_t |
typedef struct fr_toc_t_ fr_toc_t |
typedef struct fr_toc_t_ fr_toc_t |
typedef fr_toc_t0_t* fr_toc_t0_array_t |
typedef fr_toc_t0_t* fr_toc_t0_array_t |
typedef fr_toc_t0_t* fr_toc_t0_array_t |
typedef gpstime_t fr_toc_t0_t |
Start time as used in the fr_toc structure.
typedef gpstime_t fr_toc_t0_t |
Start time as used in the fr_toc structure.
typedef gpstime_t fr_toc_t0_t |
Start time as used in the fr_toc structure.
typedef INT_4U frame_h_data_quality_t |
typedef INT_4U frame_h_data_quality_t |
typedef INT_4U frame_h_data_quality_t |
typedef REAL_8 frame_h_dt_t |
typedef REAL_8 frame_h_dt_t |
typedef REAL_8 frame_h_dt_t |
typedef enum frame_h_fields_ frame_h_fields |
Field specifiers for querying the table of contents.
typedef enum frame_h_fields_ frame_h_fields |
Field specifiers for querying the table of contents.
typedef enum frame_h_fields_ frame_h_fields |
Field specifiers for querying the table of contents.
typedef INT_4U frame_h_frame_t |
typedef INT_4U frame_h_frame_t |
typedef INT_4U frame_h_frame_t |
typedef gpstime_t frame_h_gtime_t |
typedef gpstime_t frame_h_gtime_t |
typedef gpstime_t frame_h_gtime_t |
typedef const char* frame_h_name_t |
typedef const char* frame_h_name_t |
typedef const char* frame_h_name_t |
typedef INT_2U frame_h_offset_t |
typedef INT_2U frame_h_offset_t |
typedef INT_2U frame_h_offset_t |
typedef INT_4S frame_h_run_t |
typedef INT_4S frame_h_run_t |
typedef INT_4S frame_h_run_t |
typedef struct frame_h frame_h_t |
typedef struct frame_h frame_h_t |
typedef struct frame_h frame_h_t |
typedef INT_2U frame_h_uleaps_t |
typedef INT_2U frame_h_uleaps_t |
typedef INT_2U frame_h_uleaps_t |
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.
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.
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.
typedef struct FrameCError_ FrameCError |
Information concerning failure of a function.
typedef struct FrameCError_ FrameCError |
Information concerning failure of a function.
typedef struct FrameCError_ FrameCError |
Information concerning failure of a function.
typedef INT_4U gpstime_nanoseconds_t |
typedef INT_4U gpstime_nanoseconds_t |
typedef INT_4U gpstime_nanoseconds_t |
typedef INT_4U gpstime_seconds_t |
typedef INT_4U gpstime_seconds_t |
typedef INT_4U gpstime_seconds_t |
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.
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.
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.
enum fr_chan_type |
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.
enum fr_chan_type |
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.
enum fr_chan_type |
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.
enum fr_detector_fields_ |
Field specifiers for querying the table of contents.
enum fr_detector_fields_ |
Field specifiers for querying the table of contents.
enum fr_detector_fields_ |
Field specifiers for querying the table of contents.
enum fr_proc_sub_type |
Sub types of FrProcData.
enum fr_proc_sub_type |
Sub types of FrProcData.
enum fr_proc_sub_type |
Sub types of FrProcData.
enum fr_proc_type |
Types of FrProcData.
enum fr_proc_type |
Types of FrProcData.
enum fr_proc_type |
Types of FrProcData.
enum fr_toc_fields_ |
Field specifiers for querying the table of contents.
enum fr_toc_fields_ |
Field specifiers for querying the table of contents.
enum fr_toc_fields_ |
Field specifiers for querying the table of contents.
enum frame_h_fields_ |
Field specifiers for querying the table of contents.
enum frame_h_fields_ |
Field specifiers for querying the table of contents.
enum frame_h_fields_ |
Field specifiers for querying the table of contents.
enum std_detectors |
enum std_detectors |
enum std_detectors |
void FrameCCleanup | ( | void | ) |
Cleanup the library.
void FrameCErrorInit | ( | FrameCError ** | Handle | ) |
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.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Name | Name of project. |
[in] | Start | GPS start time of frame. |
[in] | Dt | Duration of frame. |
[in] | FrameNumber | Frame number since start of run. |
int FrameCFrameHFrChanAdd | ( | FrameCError ** | Error, |
frame_h_t * | Frame, | ||
fr_chan_t * | Channel | ||
) |
Add a channel to the frame.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Frame | The frame to which the channel data is to be added. |
[in] | Channel | The channel to be added. |
int FrameCFrameHFrDetectorAdd | ( | FrameCError ** | Error, |
frame_h_t * | Frame, | ||
fr_detector_t * | Detector | ||
) |
Add a detector to the frame.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Frame | The frame to which the detector data is to be added. |
[in] | Detector | The detector to be added. |
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.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Frame | The frame to which the history data is to be added. |
[in] | Event | The event to be added. |
int FrameCFrameHFrHistoryAdd | ( | FrameCError ** | Error, |
frame_h_t * | Frame, | ||
fr_history_t * | History | ||
) |
Add history to the frame.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Frame | The frame to which the history data is to be added. |
[in] | History | The history to be added. |
void FrameCFrameHQuery | ( | FrameCError ** | Error, |
const frame_h_t * | Frame, | ||
int | Option, | ||
... | |||
) |
Retrieve vector information related to the Table of Contents.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Frame | A FrameH to query. |
[in] | Option | Field 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.
frame_h_t * FrameCFrameHRead | ( | FrameCError ** | Error, |
fr_file_t *restrict | Stream, | ||
frame_h_offset_t | Pos | ||
) |
frame_h_t * FrameCFrameHReadNext | ( | FrameCError ** | Error, |
fr_file_t *restrict | Stream | ||
) |
Read a FrameH structure from the file.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Stream | The stream from which to read the FrameH. |
void FrameCFrameHSet | ( | FrameCError ** | Error, |
const frame_h_t * | Frame, | ||
int | Option, | ||
... | |||
) |
Set values for the FrameH structure.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Frame | |
[in] | Option | Field 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.
int FrameCFrameHWrite | ( | FrameCError ** | Error, |
fr_file_t *restrict | stream, | ||
frame_h_t *restrict | frame | ||
) |
Write the frame to the stream.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in,out] | stream | The output stream where the object is to be written. |
[in] | frame | The frame to be written to the stream |
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.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in,out] | stream | The output stream where the object is to be written. |
[in] | frame | The frame to be written to the stream |
[in] | compression | The method for compression |
[in] | level | Level of compression for methods that support multipler levels of compression. |
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.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Name | The name for the channel. |
[in] | Type | The 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] | DataType | Specifier for the type of data to be stored in the vector. |
[in] | NData | The number of data elements the vector needs to have. |
void FrameCFrChanFree | ( | FrameCError ** | Error, |
fr_chan_t * | Channel | ||
) |
Recyle the fr_chan_t structure.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Channel | The channel resouce to be recycled. |
void FrameCFrChanQuery | ( | FrameCError ** | Error, |
const fr_chan_t * | Channel, | ||
int | Option, | ||
... | |||
) |
Retrieve information related to the Channel.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | A channel to query. |
[in] | Option | Field 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.
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,
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,
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.
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.
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.
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.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream from which to read the table of contents. |
[in] | Name | The name of the channel to be read. |
[in] | Pos | The offset in the stream from which to read the channel. |
void FrameCFrChanSet | ( | FrameCError ** | Error, |
const fr_chan_t * | Channel, | ||
int | Option, | ||
... | |||
) |
Establish information about the Channel.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | A channel to modify. |
[in] | Option | Field 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,
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,
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,
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,
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,
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
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
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,
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.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | The channel containing the data vector to compress. |
[in] | DataType | Specifier for the type of data to be stored in the vector. |
[in] | NData | The number of data elements the vector needs to have. |
void FrameCFrChanVectorCompress | ( | FrameCError ** | Error, |
fr_chan_t * | Channel, | ||
fr_vect_compression_schemes_t | Scheme | ||
) |
Expand the data located in the data vector.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | The channel containing the data vector to compress. |
[in] | Scheme | Method to use to compress the data. |
void FrameCFrChanVectorExpand | ( | FrameCError ** | Error, |
fr_chan_t * | Channel | ||
) |
Expand the data located in the data vector.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | The channel containing the data vector to expand. |
Expand the data located in the data vector.
void FrameCFrChanVectorQuery | ( | FrameCError ** | Error, |
const fr_chan_t * | Channel, | ||
int | Option, | ||
... | |||
) |
Retrieve vector information related to the Channel.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | A channel to query. |
[in] | Option | Field 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.
void FrameCFrChanVectorSet | ( | FrameCError ** | Error, |
fr_chan_t * | Channel, | ||
int | Option, | ||
... | |||
) |
Set vector information related to the Channel.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Channel | A channel to modify. |
[in] | Option | Field 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.
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.
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.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | name | Instrument name as described in Appendix D of the frame spec. |
[in] | prefix | Channel prefix for this detector as described in Appendix D. |
[in] | latitude | Detector vertex latitude, geographical coordinates. |
[in] | longitude | Detector vertex longitude, geographical coordinates. |
[in] | elevation | Vertex elevation, meters, relative to WGS84 ellipsoid. |
[in] | azimuth_x | Orientations of X arm, measured in radians East of North. |
[in] | azimuth_y | Orientations of Y arm, measured in radians East of North. |
[in] | altitude_x | Altitude (pitch) angle of X arm, measured in radians. |
[in] | altitude_y | Altitude (pitch) angle of Y arm, measured in radians. |
[in] | midpoint_x | Distance between the detector vertex and middle of the X cavity (meters). |
[in] | midpoint_y | Distance between the detector vertex and middle of the Y cavity (meters). |
[in] | localtime | Local seasonal time - UTC in seconds. |
void FrameCFrDetectorFree | ( | FrameCError ** | Error, |
fr_detector_t * | detector | ||
) |
Recyle the detector structure.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | detector | The detector resouce to be recycled. |
void FrameCFrDetectorQuery | ( | FrameCError ** | Error, |
const fr_detector_t * | Detector, | ||
int | Option, | ||
... | |||
) |
Retrieve vector information related to the Table of Contents.
[out] | Error | A place to report any errors occuring from this call. |
[in] | Detector | A FrDetector to query. |
[in] | Option | Field 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.
fr_detector_t * FrameCFrDetectorRead | ( | FrameCError ** | Error, |
fr_file_t *restrict | Stream, | ||
const char *restrict | Name | ||
) |
Read a new Detector structure.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream from which to read the detector. |
[in] | Name | Instrument name. |
int FrameCFrDetectorWrite | ( | FrameCError ** | Error, |
fr_file_t *restrict | Stream, | ||
const fr_detector_t *restrict | Detector | ||
) |
Write a Detector structure to the stream.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream on which to write the detector. |
[in] | Detector | The detector to write to the stream. |
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.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Name | Name of event. |
[in] | Comment | Descriptor of event. |
[in] | Inputs | Input channels and filter parameters to event process. |
[in] | GTime | GPS time corresponding to reference value of event. |
[in] | TimeBefore | Signal duration before time. |
[in] | TimeAfter | Signal duration after time. |
[in] | EventStatus | Defined by event search algorithm. |
[in] | Amplitude | Continuous output amplitude returned by event. |
[in] | Probability | Likelihood estimate of event. |
[in] | Statistics | Statistical description of event. |
[in] | NParam | Number of additional event parameters. |
[in] | Parameters | Array of additional event parameters. |
int FrameCFrEventFree | ( | FrameCError ** | Error, |
fr_event_t * | Event | ||
) |
fr_history_t * FrameCFrHistoryAlloc | ( | FrameCError ** | Error, |
const char * | Name, | ||
fr_history_time_t | Time, | ||
const char * | Comment | ||
) |
Allocate a fr_frame structure.
[out] | Error | If an error occurs, Error will be non-NULL and a detailed error message will be available. |
[in] | Name | Name of the history record |
[in] | Time | Time of post-processing (GPS seconds since GPS standard epoch) |
[in] | Comment | Program name and relevant comments needed to define post-processing |
int FrameCFrHistoryFree | ( | FrameCError ** | Error, |
fr_history_t * | History | ||
) |
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.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Name | The name for the channel. |
[in] | Type | The fr_proc_type to be created. |
[in] | SubType | The fr_proc_sub_type to be created. |
[in] | DataType | Specifier for the type of data to be stored in the vector. |
[in] | NData | The number of data elements the vector needs to have. |
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.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Name | The name for the channel. |
[in] | MimeTypeName | The ASCII representation of the mime type |
[in] | NData | The number of data elements the vector needs to have. |
[in] | MimeData | The mime stream. |
void FrameCFrTOCFree | ( | FrameCError ** | Error, |
fr_toc_t * | TOC | ||
) |
Recyle the table of contents structure.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | TOC | The 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.
void FrameCFrTOCQuery | ( | FrameCError ** | Error, |
const fr_toc_t * | TOC, | ||
int | Option, | ||
... | |||
) |
Retrieve vector information related to the Table of Contents.
[out] | Error | A place to report any errors occuring from this call. |
[in] | TOC | A TOC to query. |
[in] | Option | Field 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.
fr_toc_t * FrameCFrTOCRead | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Obtain the table of contensts.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream from which to read the table of contents. |
Read a subset of the table of contents information.
fr_detector_t * FrameCGetDetector | ( | FrameCError ** | Error, |
std_detectors | Type, | ||
const gpstime_t *restrict | Time | ||
) |
Retrieve information about some standard detectors.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Type | This is the interferometer's designation. |
[in] | Time | This 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.
gpstime_seconds_t FrameCGPSTimeNow | ( | void | ) |
void FrameCInitialize | ( | void | ) |
Initialize the library.
INT_2U FrameCLibraryMinorVersion | ( | void | ) |
Return the minor version number of the frame library.