| idf_data (1S) | UDF PROGRAMMERS MANUAL | idf_data (1S) |
|---|
SYNOPSIS #include "util_str.h"
struct idf_data {
| u_ByTe_4 | data_key; | |
|---|---|---|
| ByTe_2 | sensor; | |
| ByTe_2 | column; | |
| ByTe_2 | byear; | |
| ByTe_2 | bday; | |
| ByTe_4 | bmilli; | |
| ByTe_4 | bnano; | |
| ByTe_2 | eyear; | |
| ByTe_2 | eday; | |
| ByTe_4 | emilli; | |
| ByTe_4 | enano; | |
| ByTe_2 | mode_byear; | |
| ByTe_2 | mode_bday; | |
| ByTe_4 | mode_bmilli; | |
| ByTe_4 | mode_bnano; | |
| ByTe_2 | mode_eyear; | |
| ByTe_2 | mode_eday; | |
| ByTe_4 | mode_emilli; | |
| ByTe_4 | mode_enano; | |
| ByTe_4 | data_accum_ms; | |
| ByTe_4 | data_accum_ns; | |
| ByTe_4 | data_lat_ms; | |
| ByTe_4 | data_lat_ns; | |
| ByTe_4 | swp_reset_ms; | |
| ByTe_4 | swp_reset_ns; | |
| ByTe_4 | sen_reset_ms; | |
| ByTe_4 | sen_reset_ns; | |
| ReaL_4 | *start_az; | |
| ReaL_4 | *stop_az; | |
| ReaL_4 | *start_theta; | |
| ReaL_4 | *stop_theta; | |
| ReaL_4 | *pitch_angles; | |
| ByTe_2 | num_swp_steps; | |
| u_ByTe_2 | num_sample; | |
| ByTe_2 | TotCols; | |
| ByTe_4 | cal_len; | |
| u_ByTe_2 | num_angle; | |
| u_ByTe_2 | num_pitch; | |
| ByTe_4 | sun_sen; | |
| ByTe_4 | spin_rate; | |
| ByTe_4 | *gcal_data; | |
| ByTe_4 | *cal_data; | |
| ByTe_4 | *sen_data; | |
| ByTe_4 | *swp_data; | |
| ByTe_4 | *mode; | |
| ByTe_4 | d_qual; | |
| unsigned int | cal_size; | |
| unsigned int | data_size; | |
| unsigned int | swp_size; | |
| unsigned int | mode_size; | |
| unsigned int | angle_size; | |
| unsigned int | pitch_size; | |
| void | base_cal; | |
| void | base_data; | |
| void | base_swp; | |
| void | base_angle; | |
| void | base_mode; | |
| void | base_pitch; | |
| u_ByTe_1 | mode_len; | |
| ByTe_1 | hdr_change; | |
| ByTe_1 | exten[3]; | |
| ByTe_1 | filled_data; | |
| u_ByTe_2 | version; | |
| void | base_cset; | |
| u_ByTe_2 | *cset_num; |
FIELD DEFINITIONS
| data_key | - | The data key used in the read_drec call. | ||||||
| sensor | - | The sensor from which data was requested in the read_drec call. | ||||||
| column | - | The column in the sensor matrix from which data was requested in the read_drec call. The value is undefined if the sensor is not a matrix sensor. | ||||||
| byear | - | The beginning year of the first data value in the returned data array. | ||||||
| bday | - | The beginning day of the first data value in the returned data array. | ||||||
| bmilli | - | The beginning millisecond of the first data value in the returned data array. | ||||||
| bnano | - | The beginning nanosecond of the first data value in the returned data array. | ||||||
| eyear | - | The ending year of the last data value in the returned data array. | ||||||
| eday | - | The ending day of the last data value in the returned data array. | ||||||
| emilli | - | The ending millisecond of the last data value in the returned data array. | ||||||
| enano | - | The ending nanosecond of the last data value in the returned data array. | ||||||
| mode_byear | - | The beginning year of the first data value in the current UDF data record. Used as the beginning year for any mode data contained within the data record. | ||||||
| mode_bday | - | The beginning day of the first data value in the current UDF data record. Used as the beginning day for any mode data contained within the data record. | ||||||
| mode_bmilli | - | The beginning millisecond of the first data value in the current UDF data record. Used as the beginning millisecond for any mode data contained within the data record. | ||||||
| mode_bnano | - | The beginning nanosecond of the first data value in the current UDF data record. Used as the beginning nanosecond for any mode data contained within the data record. | ||||||
| mode_eyear | - | The ending year of the last data value in the current UDF data record. Used as the ending year for any mode data contained within the data record. | ||||||
| mode_eday | - | The ending day of the last data value in the current UDF data record. Used as the ending day for any mode data contained within the data record. | ||||||
| mode_emilli | - | The ending millisecond of the last data value in the current UDF data record. Used as the ending millisecond for any mode data contained within the data record. | ||||||
| mode_enano | - | The ending nanosecond of the last data value in the current UDF data record. Used as the ending nanosecond for any mode data contained within the data record. | ||||||
| data_accum_ms | - | The millisecond portion of the accumulation period of a single data value. | ||||||
| data_accum_ns | - | The nanosecond portion of the accumulation period of a single data value. | ||||||
| data_lat_ms | - | The millisecond portion of the latency time (dead time) between adjacent data values. | ||||||
| data_lat_ns | - | The nanosecond portion of the latency time (dead time) between adjacent data values. | ||||||
| swp_reset_ms | - | The millisecond portion of the latency time (dead time) between adjacent columns of data in the UDF data record. In general this deadtime between adjacent data scans. | ||||||
| swp_reset_ns | - | The nanosecond portion of the latency time (dead time) between adjacent columns of data in the UDF data record. In general this deadtime between adjacent data scans. | ||||||
| sen_reset_ms | - | The millisecond portion of the latency time (dead time) between adjacent sensor sets in the UDF data record. | ||||||
| sen_reset_ns | - | The nanosecond portion of the latency time (dead time) between adjacent sensor sets in the UDF data record. | ||||||
| start_az | - | Pointer to the array of starting azimuthal (phase) angles associated with each of the returned data values. Pointer is to address 0 if unused. | ||||||
| stop_az | - | Pointer to the array of ending azimuthal (phase) angles associated with each of the returned data values. Pointer is to address 0 if unused. | ||||||
| start_theta | - | Pointer to the array of starting theta (polar) angles associated with each of the returned data values. Pointer is to address 0 if unused. | ||||||
| stop_theta | - | Pointer to the array of ending theta (polar) angles associated with each of the returned data values. Pointer is to address 0 if unused. | ||||||
| pitch_angles | - | Pointer to the array of pitch angles associated with each of the returned data values. Pointer is to address 0 if unused. | ||||||
| num_swp_steps | - | The number of elements returned in the scan array associated with the returned data. | ||||||
| num_sample | - | The number of elements returned in the data array. | ||||||
| TotCols | - | Total number of matrix columns associated with the returned sensor. This value is 1 if the sensor is not a matrix sensor. | ||||||
| cal_len | - | The number of data values returned in the ancillary data array. | ||||||
| num_angle | - | The number of data values returned in the start_az and stop_az arrays. | ||||||
| num_pitch | - | The number of data values returned in the pitch_angle array. | ||||||
| sun_sen | - | The milliseconds of day of the current zero degree crossing. | ||||||
| spin_rate | - | The current spin period in milliseconds. | ||||||
| gcal_data | - | Unused pointer. | ||||||
| cal_data | - | Pointer to the array of returned ancillary data values. Pointer is to address 0 if unused. | ||||||
| sen_data | - | Pointer to the array of returned sensor data values. Pointer is to address 0 if unused. | ||||||
| swp_data | - | Pointer to the array of returned scan indices. Pointer is to address 0 if unused. | ||||||
| mode | - | Pointer to the array of returned status (mode) values. Pointer is to address 0 if unused. | ||||||
| d_qual | - | The data quality value associated with the sensor of the returned data. | ||||||
| cal_size | - | Number of bytes allocated for the cal_data array. | ||||||
| data_size | - | Number of bytes allocated for the sen_data array. | ||||||
| swp_size | - | Number of bytes allocated for the swp_data array. | ||||||
| mode_size | - | Number of bytes allocated for the mode array. | ||||||
| angle_size | - | Number of bytes allocated for the combined start_az and stop_az arrays. | ||||||
| pitch_size | - | Number of bytes allocated for the combined pitch_angle array. | ||||||
| base_cal | - | The base address of the cal_data array. | ||||||
| base_data | - | The base address of the sen_data array. | ||||||
| base_swp | - | The base address of the swp_data array. | ||||||
| base_angle | - | The base address of the start_az and stop_az arrays. | ||||||
| base_pitch | - | The base address of the pitch_angle array. | ||||||
| mode_len | - | Number of status values returned in the mode array. | ||||||
| hdr_change | - | Flag indicating that a change the header pointer occurred in this read. | ||||||
| ||||||||
| exten | - | The NULL terminated data extension used in the read_drec call. | ||||||
| filled_data | - | Flag indicating if data was actually acquired for the requested sensor in the read. | ||||||
| ||||||||
| exten | ||||||||
| version | - | The version number used in the read_drec call. | ||||||
| base_cset | - | The base address of the cset_num array. | ||||||
| cset_num | - | Pointer to the number of elements in each acquired ancillary data sets returned in the cal_data array. |
DESCRIPTION This structure holds the output of generated by a UDF read_drec call.
APPLICABLE FORMATS UDF V2.2, IDFS V2.1
SEE ALSO read_drec (1)
| UDF V2.2 | January 11, 2000 | UDF V2.2 |
|---|