val_extract.h

Go to the documentation of this file.

 
#ifndef ___VAL_EXTRACT_H_
#define ___VAL_EXTRACT_H_
 
#include "argpar.h"
#include "olog.h"
#include "shash.h"
 
#include <netcdf.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <time.h>
 
#ifndef VALEXTRACT_API_VERSION
 
#define VALEXTRACT_API_VERSION 2007005
 
#define VALEXTRACT_API_VERSION_STR "2.7.5"
#endif
 
#define VALEXTRACT_ERR_NONE EXIT_SUCCESS
 
#define VALEXTRACT_ERR_POINT_NOT_FOUND 99
 
#define VALEXTRACT_ERR_UNKNOWN 100
 
#define VALEXTRACT_ERR_NCFILE_ERR 101
 
#define VALEXTRACT_ERR_NCFILE_INVALID 102
 
#define VALEXTRACT_ERR_FLAG 103
 
#define VALEXTRACT_ERR_VARIABLE 104
 
#define VALEXTRACT_ERR_INPUT 105
 
#define VALEXTRACT_ERR_L2QC 106
 
extern argpar val_extract_argpar;
 
#define VALEXTRACT_KEY_INIT    1
 
#define VALEXTRACT_KEY_FILE    2
 
#define VALEXTRACT_KEY_VAR     3
 
#define VALEXTRACT_KEY_SUCCESS 4
 
#define VALEXTRACT_KEY_ERROR   5
 
#define VALEXTRACT_KEY_FINI    6
 
#define VALEXTRACT_CMD_STOP    2
 
#define VALEXTRACT_UNSET -255
 
typedef int (*val_extract_parser)(int key, void *nc_input, void *user_input);
 
typedef struct val_extract_valid_range {
    char *prefix;
    double min, max;
} val_extract_valid_range;
 
typedef struct val_extract_arguments {
    const char *ifile;
 
    int box_size;
 
    double box_size_km;
 
    bool line_and_pixel;
    int start_line;
    int end_line;
    int start_pixel;
    int end_pixel;
 
    bool lat_and_lon;
    double start_lat;
    double end_lat;
    double start_lon;
    double end_lon;
 
    bool geospatial_only;
    bool geospatial_to_double;
 
    char **products;
    int product_count;
 
    uint32_t ignore_flags_mask;
    char **ignore_flags;
    int ignore_flag_count;
 
    uint32_t count_flags_mask;
    char **count_flags;
    int count_flag_count;
 
    char **l2qc_flags;
    double *l2qc_thresholds;
    int l2qc_threshold_count;
 
    val_extract_valid_range *valid_ranges;
    int valid_range_count;
 
    char **skip_stats;
    int skip_stats_count;
 
    bool global_atts;
 
    bool variable_atts;
 
    olog *log;
 
    double optics_threshold;
 
    val_extract_parser val_extract_parser;
    void *user_input;
} val_extract_arguments;
 
int val_extract(val_extract_arguments *arguments);
 
int val_extract_clean(val_extract_arguments *arguments);
 
void val_extract_clear_args(val_extract_arguments *arguments);
 
void unflatten_index(int index, int ndims, const int *dims, int *result);
 
const char *val_extract_version();
 
const char *val_extract_api_version();
 
/* The following should go into an nc_read library */
 
typedef struct nc_point {
    size_t line, pixel;
} nc_point;
 
typedef struct nc_box {
    size_t start[2], count[2];
} nc_box;
 
typedef struct nc_file {
    const char *file_path;
    int ndims, *dim_lengths;
    int ngrps, *gids;
    int line_dimid, pixel_dimid, pixel_control_dimid, control_point_size;
    int flag_count;
    uint32_t *flag_masks;
    char *flag_string;
    char **flag_meanings;
    shash *attributes;
} nc_file;
 
typedef struct nc_region {
    nc_file *file;
    nc_point center;
    int box_count;
    nc_box *boxes;
    int pixel_count, unflagged_pixel_count, flagged_pixel_count;
    int *flag_counts;
    uint32_t *pixel_flags;
    double lat, lon;
    time_t utime;
    char ascii_time[24];
} nc_region;
 
typedef struct nc_var_stats {
    bool initialized;
    int count;
    double min, max, mean, median, stddev, rms;
    double center_value;
} nc_var_stats;
 
typedef struct nc_var {
    nc_file *file;
    nc_region *region;
    char *name, *group_name;
    int gid, varid;
    bool is_geospatial, uses_control_points;
    bool has_scale, has_offset, has_fill;
    double scale, offset, fill;
    int ndims, *dim_ids;
    shash *attributes;
    nc_var_stats stats, filtered_stats, iqr_stats;
    nc_type data_type;
    size_t data_sizeof;
    double *valid_data;
    int valid_data_count;
    void *data;
} nc_var;
 
size_t nc_get_region_size(nc_region *region);
size_t nc_get_region_dim_size(nc_region *region, int dim_index);
 
#define declare_nc_get_varr(type, suffix) \
    int nc_get_varr ## suffix(int ncid, int varid, nc_region *region, type *p); \
    int nc_get_varrd ## suffix(int ncid, int varid, nc_region *region, int dim_index, type *p);
 
declare_nc_get_varr(char, _text)
declare_nc_get_varr(unsigned char, _uchar)
declare_nc_get_varr(signed char, _schar)
declare_nc_get_varr(short, _short)
declare_nc_get_varr(int, _int)
declare_nc_get_varr(long, _long)
declare_nc_get_varr(float, _float)
declare_nc_get_varr(double, _double)
declare_nc_get_varr(unsigned short, _ushort)
declare_nc_get_varr(unsigned int, _uint)
declare_nc_get_varr(long long, _longlong)
declare_nc_get_varr(unsigned long long, _ulonglong)
declare_nc_get_varr(char *, _string)
declare_nc_get_varr(void,)
 
/* The following should go into a math library */
 
#define declare_compare(type, suffix) int compare ## suffix(const void *a, const void *b)
declare_compare(int8_t, _int8);
declare_compare(uint8_t, _uint8);
declare_compare(int16_t, _int16);
declare_compare(uint16_t, _uint16);
declare_compare(int32_t, _int32);
declare_compare(uint32_t, _uint32);
declare_compare(int64_t, _int64);
declare_compare(uint64_t, _uint64);
declare_compare(float, _float);
declare_compare(double, _double);
 
#endif /* ___VAL_EXTRACT_H_ */