sdata-impl.h
Go to the documentation of this file.
1 /*
2  * Copyright 2016 CNRS & Universite Lille 1. All rights reserved.
3  *
4  * Licensed under the GRASP Open Source License V1.0 (see LICENSE file)
5  */
6 
13 #ifndef SDATA_IMPL_H
14 #define SDATA_IMPL_H
15 
16 #include <time.h>
17 #include "sdata.h"
18 
19 extern int sdata_dump_handle(FILE *output_stream, SDATA_HANDLE *handle);
20 extern int sdata_read_next_record(SDATA_HANDLE *handle, SDATA_RECORD *record);
21 extern void sdata_get_date_time(SDATA_RECORD *record, char str_date_time[20 + 1]); /* format YYYY-MM-DDThh:mm:ssZ */
22 extern size_t sdata_get_num_pixels(SDATA_RECORD *record);
23 extern const SDATA_PIXEL *sdata_get_pixel(const SDATA_RECORD *record, size_t ipixel);
24 
25 
26 typedef struct SDATA_VALID_RANGES_ {
27  int ix_min, ix_max;
28  int iy_min, iy_max;
29  int cloud_flag_min, cloud_flag_max;
30  double longitude_min, longitude_max;
31  double latitude_min, latitude_max;
32  double hgr_min, hgr_max;
33  double land_percent_min, land_percent_max;
34  int num_wavelengths_min, num_wavelengths_max;
35  double wavelength_min, wavelength_max;
36  int num_meas_type_min, num_meas_type_max;
37  int meas_type_min, meas_type_max;
38  int num_valid_meas_min, num_valid_meas_max;
39  double thetas_min, thetas_max;
40  double thetav_min, thetav_max;
41  double dphi_min, dphi_max;
42  double hvp_min, hvp_max;
43  double groundpar_min, groundpar_max;
44  double gaspar_min, gaspar_max;
45  double meas_min, meas_max;
46  int ifcov_min, ifcov_max;
47  int ifmp_min, ifmp_max;
48  double cmtrx_min, cmtrx_max;
49  double mprof_min, mprof_max;
50 } SDATA_VALID_RANGES;
51 
52 struct SDATA_HANDLE_ {
53  char file_name[255 + 1];
54  FILE *file_pointer;
55  SDATA_HEADER header;
56  SDATA_VALID_RANGES valid_ranges;
57  int current_line;
58  int current_record;
59 };
60 
61 struct SDATA_RECORD_ {
62  int npixels;
63  double sdata_time; /* number of days since a reference day (e.g. 1st january of the current year), + fraction of the day */
64  time_t unix_time; /* time of acquisition, in seconds since 1970-01-01T00:00:00Zday of year */
65  char str_date_time[20 + 1]; /* date of the acquisition, format YYYY-MM-DDThh:mm:ssZ (redundant with unix_time, but provided for convenience and control) */
66  double hobs;
67  int nsurf;
68  int ifgas;
69  SDATA_HANDLE *handle;
70  SDATA_PIXEL pixels[SDATA_MAX_NX*SDATA_MAX_NY];
71 };
72 
73 extern void init_valid_ranges(SDATA_VALID_RANGES *valid_ranges);
74 
75 #endif /* SDATA_IMPL_H */
SDATA_VALID_RANGES_::hvp_max
double hvp_max
Definition: sdata-impl.h:42
SDATA_VALID_RANGES_::num_meas_type_min
int num_meas_type_min
Definition: sdata-impl.h:36
SDATA_VALID_RANGES_::num_valid_meas_min
int num_valid_meas_min
Definition: sdata-impl.h:38
SDATA_VALID_RANGES_::ifmp_max
int ifmp_max
Definition: sdata-impl.h:47
SDATA_VALID_RANGES_::hgr_max
double hgr_max
Definition: sdata-impl.h:32
SDATA_VALID_RANGES
struct SDATA_VALID_RANGES_ SDATA_VALID_RANGES
SDATA_VALID_RANGES_::latitude_min
double latitude_min
Definition: sdata-impl.h:31
sdata_get_date_time
void sdata_get_date_time(SDATA_RECORD *record, char str_date_time[20+1])
Definition: sdata.c:1561
SDATA_RECORD_::nsurf
int nsurf
Definition: sdata-impl.h:67
SDATA_VALID_RANGES_::gaspar_min
double gaspar_min
Definition: sdata-impl.h:44
SDATA_RECORD_::handle
SDATA_HANDLE * handle
Definition: sdata-impl.h:69
SDATA_VALID_RANGES_::longitude_min
double longitude_min
Definition: sdata-impl.h:30
SDATA_HANDLE_::header
SDATA_HEADER header
Definition: sdata-impl.h:55
SDATA_HANDLE_::current_record
int current_record
Definition: sdata-impl.h:58
sdata_get_num_pixels
size_t sdata_get_num_pixels(SDATA_RECORD *record)
Definition: sdata.c:1570
SDATA_MAX_NY
#define SDATA_MAX_NY
Definition: sdata.h:34
SDATA_RECORD_
Definition: sdata-impl.h:61
SDATA_VALID_RANGES_::groundpar_min
double groundpar_min
Definition: sdata-impl.h:43
SDATA_VALID_RANGES_::land_percent_max
double land_percent_max
Definition: sdata-impl.h:33
SDATA_VALID_RANGES_::cloud_flag_max
int cloud_flag_max
Definition: sdata-impl.h:29
SDATA_HANDLE_::valid_ranges
SDATA_VALID_RANGES valid_ranges
Definition: sdata-impl.h:56
SDATA_VALID_RANGES_::cmtrx_max
double cmtrx_max
Definition: sdata-impl.h:48
SDATA_VALID_RANGES_::thetas_min
double thetas_min
Definition: sdata-impl.h:39
SDATA_VALID_RANGES_::wavelength_min
double wavelength_min
Definition: sdata-impl.h:35
SDATA_HANDLE_::file_pointer
FILE * file_pointer
Definition: sdata-impl.h:54
SDATA_VALID_RANGES_::longitude_max
double longitude_max
Definition: sdata-impl.h:30
SDATA_RECORD_::sdata_time
double sdata_time
Definition: sdata-impl.h:63
SDATA_RECORD_::pixels
SDATA_PIXEL pixels[SDATA_MAX_NX *SDATA_MAX_NY]
Definition: sdata-impl.h:70
SDATA_VALID_RANGES_::dphi_min
double dphi_min
Definition: sdata-impl.h:41
SDATA_RECORD_::hobs
double hobs
Definition: sdata-impl.h:66
sdata_get_pixel
const SDATA_PIXEL * sdata_get_pixel(const SDATA_RECORD *record, size_t ipixel)
Definition: sdata.c:1577
SDATA_VALID_RANGES_::wavelength_max
double wavelength_max
Definition: sdata-impl.h:35
SDATA_VALID_RANGES_::num_wavelengths_max
int num_wavelengths_max
Definition: sdata-impl.h:34
SDATA_MAX_NX
#define SDATA_MAX_NX
Definition: sdata.h:33
sdata_read_next_record
int sdata_read_next_record(SDATA_HANDLE *handle, SDATA_RECORD *record)
Definition: sdata.c:1828
SDATA_VALID_RANGES_::thetav_max
double thetav_max
Definition: sdata-impl.h:40
SDATA_RECORD_::npixels
int npixels
Definition: sdata-impl.h:62
SDATA_VALID_RANGES_::mprof_max
double mprof_max
Definition: sdata-impl.h:49
SDATA_VALID_RANGES_::thetav_min
double thetav_min
Definition: sdata-impl.h:40
SDATA_VALID_RANGES_::num_valid_meas_max
int num_valid_meas_max
Definition: sdata-impl.h:38
SDATA_VALID_RANGES_::num_wavelengths_min
int num_wavelengths_min
Definition: sdata-impl.h:34
SDATA_VALID_RANGES_::thetas_max
double thetas_max
Definition: sdata-impl.h:39
SDATA_VALID_RANGES_::iy_max
int iy_max
Definition: sdata-impl.h:28
SDATA_VALID_RANGES_::ix_max
int ix_max
Definition: sdata-impl.h:27
SDATA_VALID_RANGES_::latitude_max
double latitude_max
Definition: sdata-impl.h:31
SDATA_VALID_RANGES_::gaspar_max
double gaspar_max
Definition: sdata-impl.h:44
SDATA_HANDLE_::file_name
char file_name[255+1]
Definition: sdata-impl.h:53
SDATA_VALID_RANGES_::meas_min
double meas_min
Definition: sdata-impl.h:45
SDATA_VALID_RANGES_::mprof_min
double mprof_min
Definition: sdata-impl.h:49
SDATA_VALID_RANGES_::meas_max
double meas_max
Definition: sdata-impl.h:45
SDATA_VALID_RANGES_::iy_min
int iy_min
Definition: sdata-impl.h:28
SDATA_VALID_RANGES_::ifcov_min
int ifcov_min
Definition: sdata-impl.h:46
SDATA_VALID_RANGES_::num_meas_type_max
int num_meas_type_max
Definition: sdata-impl.h:36
SDATA_RECORD_::unix_time
time_t unix_time
Definition: sdata-impl.h:64
SDATA_VALID_RANGES_::groundpar_max
double groundpar_max
Definition: sdata-impl.h:43
SDATA_HANDLE_::current_line
int current_line
Definition: sdata-impl.h:57
sdata_dump_handle
int sdata_dump_handle(FILE *output_stream, SDATA_HANDLE *handle)
Definition: sdata.c:2341
SDATA_VALID_RANGES_::meas_type_max
int meas_type_max
Definition: sdata-impl.h:37
SDATA_VALID_RANGES_::hgr_min
double hgr_min
Definition: sdata-impl.h:32
SDATA_RECORD_::ifgas
int ifgas
Definition: sdata-impl.h:68
SDATA_VALID_RANGES_::ix_min
int ix_min
Definition: sdata-impl.h:27
SDATA_RECORD_::str_date_time
char str_date_time[20+1]
Definition: sdata-impl.h:65
SDATA_PIXEL_
Definition: sdata.h:65
SDATA_HANDLE_
Definition: sdata-impl.h:52
init_valid_ranges
void init_valid_ranges(SDATA_VALID_RANGES *valid_ranges)
Definition: sdata.c:161
SDATA_VALID_RANGES_::ifmp_min
int ifmp_min
Definition: sdata-impl.h:47
SDATA_VALID_RANGES_::land_percent_min
double land_percent_min
Definition: sdata-impl.h:33
SDATA_VALID_RANGES_::meas_type_min
int meas_type_min
Definition: sdata-impl.h:37
SDATA_VALID_RANGES_::hvp_min
double hvp_min
Definition: sdata-impl.h:42
SDATA_VALID_RANGES_::cloud_flag_min
int cloud_flag_min
Definition: sdata-impl.h:29
SDATA_VALID_RANGES_::dphi_max
double dphi_max
Definition: sdata-impl.h:41
SDATA_VALID_RANGES_::cmtrx_min
double cmtrx_min
Definition: sdata-impl.h:48
SDATA_HEADER_
Definition: sdata.h:54
SDATA_VALID_RANGES_::ifcov_max
int ifcov_max
Definition: sdata-impl.h:46
SDATA_VALID_RANGES_
Definition: sdata-impl.h:26