File: grib_get_data.cc

package info (click to toggle)
eccodes 2.44.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 150,248 kB
  • sloc: cpp: 163,056; ansic: 26,308; sh: 21,602; f90: 6,854; perl: 6,363; python: 5,087; java: 2,226; javascript: 1,427; yacc: 854; fortran: 543; lex: 359; makefile: 285; xml: 183; awk: 66
file content (357 lines) | stat: -rw-r--r-- 12,200 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/*
 * (C) Copyright 2005- ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
 * virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
 */

#include "grib_tools.h"

static void print_key_values(grib_values* values, int values_count);
static grib_values* get_key_values(grib_runtime_options* options, grib_handle* h);

grib_option grib_options[] = {
    /*  {id, args, help}, on, command_line, value */
    { "S", 0, 0, 1, 0, 0 },
    { "M", 0, 0, 0, 1, 0 },
    { "m:", "missingValue",
      "\n\t\tThe missing value is given through this option."
      "\n\t\tAny string is allowed and it is printed in place of the missing"
      "\n\t\tvalues. Default is to skip the missing values.\n",
      0, 1, 0 },
    { "p:", 0, 0, 0, 1, 0 },
    { "F:", "format", "\n\t\tC style format for data values. Default is \"%.10e\"\n", 0, 1, 0 },
    { "L:", "format", "\n\t\tC style format for latitudes/longitudes. Default is \"%9.3f%9.3f\"\n", 0, 1, 0 },
    { "w:", 0, 0, 0, 1, 0 },
    { "s:", 0, 0, 0, 1, 0 },
    { "f", 0, 0, 0, 1, 0 },
    { "G", 0, 0, 0, 1, 0 },
    { "7", 0, 0, 0, 1, 0 },
    { "X:", 0, 0, 0, 1, 0 },
    { "V", 0, 0, 0, 1, 0 },
    { "h", 0, 0, 0, 1, 0 },
};

const char* tool_description =
    "Print a latitude, longitude, data values list.\n"
    "\tNote: Rotated grids are first unrotated";
const char* tool_name  = "grib_get_data";
const char* tool_online_doc = "https://confluence.ecmwf.int/display/ECC/grib_get_data";
const char* tool_usage = "[options] grib_file grib_file ...";

extern FILE* dump_file;

int grib_options_count = sizeof(grib_options) / sizeof(grib_option);

int main(int argc, char* argv[])
{
    return grib_tool(argc, argv);
}

int grib_tool_before_getopt(grib_runtime_options* options)
{
    return 0;
}

int grib_tool_init(grib_runtime_options* options)
{
    return 0;
}

int grib_tool_new_filename_action(grib_runtime_options* options, const char* file)
{
    return 0;
}

int grib_tool_new_file_action(grib_runtime_options* options, grib_tools_file* file)
{
    exit_if_input_is_directory(tool_name, file->name);
    return 0;
}

int grib_tool_new_handle_action(grib_runtime_options* options, grib_handle* h)
{
    int err = 0;

    double missingValue     = 9999;
    int skip_missing        = 1;
    char* missing_string    = NULL;
    int i                   = 0;
    grib_values* values     = NULL;
    grib_iterator* iter     = NULL;
    char format_values[32]  = {0,};
    char format_latlons[32] = {0,};
    const char* default_format_values  = "%.10e";
    const char* default_format_latlons = "%9.3f%9.3f";
    int print_keys               = grib_options_on("p:");
    long numberOfPoints          = 0;
    long bitmapPresent           = 0;
    long* bitmap                 = NULL; /* bitmap array */
    size_t bmp_len               = 0;
    double *data_values = 0, *lats = 0, *lons = 0;
    size_t size = 0, num_bytes = 0;
    long hasMissingValues = 0;

    if (!options->skip) {
        if (options->set_values_count != 0)
            err = grib_set_values(h, options->set_values, options->set_values_count);
        if (err != GRIB_SUCCESS && options->fail)
            exit(err);
    }

    if (grib_options_on("m:")) {
        /* User wants to see missing values */
        char* theEnd = NULL;
        double mval  = 0;
        char* kmiss  = grib_options_get_option("m:");
        char* p      = kmiss;
        skip_missing = 0;
        while (*p != ':' && *p != '\0')
            p++;
        if (*p == ':' && *(p + 1) != '\0') {
            *p             = '\0';
            missing_string = strdup(p + 1);
        }
        else {
            missing_string = strdup(kmiss);
        }
        mval = strtod(kmiss, &theEnd);
        if (kmiss != theEnd && *theEnd == '\0')
            missingValue = mval;
        grib_set_double(h, "missingValue", missingValue);
        /*missing_string=grib_options_get_option("m:");*/
    }

    if (grib_options_on("F:")) {
        const char* str = grib_options_get_option("F:");
        snprintf(format_values, sizeof(format_values), "%s", str);
    }
    else {
        snprintf(format_values, sizeof(format_values), "%s", default_format_values);
    }

    if (grib_options_on("L:")) {
        /* Do a very basic sanity check */
        const char* str = grib_options_get_option("L:");
        if (string_count_char(str, '%') != 2) {
            fprintf(stderr, "ERROR: Invalid lats/lons format option \"%s\".\n"
                    "       The default is: \"%s\"."
                    " For higher precision, try: \"%%12.6f%%12.6f\"\n",
                    str, default_format_latlons);
            exit(1);
        }
        snprintf(format_latlons, sizeof(format_latlons), "%s ", str); /* Add a final space to separate from data values */
    }
    else {
        snprintf(format_latlons, sizeof(format_latlons), "%s ", default_format_latlons);
    }

    if ((err = grib_get_long(h, "numberOfPoints", &numberOfPoints)) != GRIB_SUCCESS) {
        fprintf(stderr, "ERROR: Unable to get number of points\n");
        exit(err);
    }

    iter = grib_iterator_new(h, 0, &err);

    num_bytes   = (numberOfPoints + 1) * sizeof(double);
    data_values = (double*)calloc(numberOfPoints + 1, sizeof(double));
    if (!data_values) {
        fprintf(stderr, "ERROR: Failed to allocate %zu bytes for data values (number of points=%ld)\n",
                num_bytes, numberOfPoints);
        exit(GRIB_OUT_OF_MEMORY);
    }

    if (iter) {
        double *lat = 0, *lon = 0, *val = 0;
        lats = (double*)calloc(numberOfPoints + 1, sizeof(double));
        lons = (double*)calloc(numberOfPoints + 1, sizeof(double));
        lat  = lats;
        lon  = lons;
        val  = data_values;
        while (grib_iterator_next(iter, lat++, lon++, val++)) {}
    }
    else if (err == GRIB_NOT_IMPLEMENTED || err == GRIB_SUCCESS) {
        size = numberOfPoints;
        err  = grib_get_double_array(h, "values", data_values, &size);
        if (err) {
            grib_context_log(h->context, GRIB_LOG_ERROR, "Cannot decode values: %s",
                             grib_get_error_message(err));
            exit(1);
        }
        if (size != (size_t)numberOfPoints) {
            fprintf(stderr, "ERROR: Wrong number of points %ld\n", numberOfPoints);
            if (grib_options_on("f"))
                exit(1);
        }
    }
    else {
        grib_context_log(h->context, GRIB_LOG_ERROR,
                         "%s", grib_get_error_message(err));
        exit(err);
    }

    /* Cater for GRIBs which have missing values but no bitmap */
    /* See ECC-511 */
    GRIB_CHECK(grib_get_long(h, "missingValuesPresent", &hasMissingValues), 0);
    GRIB_CHECK(grib_get_long(h, "bitmapPresent", &bitmapPresent), 0);
    if (bitmapPresent) {
        GRIB_CHECK(grib_get_size(h, "bitmap", &bmp_len), 0);
        bitmap = (long*)malloc(bmp_len * sizeof(long));
        GRIB_CHECK(grib_get_long_array(h, "bitmap", bitmap, &bmp_len), 0);
    }

    if (iter)
        fprintf(dump_file, "Latitude Longitude ");

    fprintf(dump_file, "Value");

    if (print_keys)
        for (i = 0; i < options->print_keys_count; i++)
            fprintf(dump_file, " %s", options->print_keys[i].name);

    fprintf(dump_file, "\n");

    if (print_keys)
        values = get_key_values(options, h);

    if (skip_missing == 0) {
        /* Show missing values in data */
        for (i = 0; i < numberOfPoints; i++) {
            int is_missing_val = 0;
            if (hasMissingValues) {
                if (bitmapPresent)
                    is_missing_val = (bitmap[i] == 0);
                else
                    is_missing_val = (data_values[i] == missingValue);
            }
            if (iter)
                fprintf(dump_file, format_latlons, lats[i], lons[i]);

            if (is_missing_val)
                fprintf(dump_file, "%s", missing_string);
            else
                fprintf(dump_file, format_values, data_values[i]);

            if (print_keys)
                print_key_values(values, options->print_keys_count);
            fprintf(dump_file, "\n");
        }
    }
    else if (skip_missing == 1) {
        /* Skip the missing values in data */
        for (i = 0; i < numberOfPoints; i++) {
            int is_missing_val = 0;
            if (hasMissingValues) {
                if (bitmapPresent)
                    is_missing_val = (bitmap[i] == 0);
                else
                    is_missing_val = (data_values[i] == missingValue);
            }
            if (!is_missing_val) {
                if (iter)
                    fprintf(dump_file, format_latlons, lats[i], lons[i]);
                fprintf(dump_file, format_values, data_values[i]);
                if (print_keys)
                    print_key_values(values, options->print_keys_count);
                fprintf(dump_file, "\n");
            }
        }
    }

    if (iter)
        grib_iterator_delete(iter);
    if (bitmap)
        free(bitmap);

    free(data_values);
    free(missing_string);
    if (iter) {
        free(lats);
        free(lons);
    }

    return 0;
}

int grib_tool_skip_handle(grib_runtime_options* options, grib_handle* h)
{
    grib_handle_delete(h);
    return 0;
}

int grib_tool_finalise_action(grib_runtime_options* options)
{
    return 0;
}

static void print_key_values(grib_values* values, int values_count)
{
    int i = 0;
    for (i = 0; i < values_count; i++) {
        fprintf(dump_file, " %s", values[i].string_value);
    }
}

static grib_values* get_key_values(grib_runtime_options* options, grib_handle* h)
{
    int i                      = 0;
    int ret                    = 0;
    char value[MAX_STRING_LEN] = {0,};
    const char* notfound = "not found";

    for (i = 0; i < options->print_keys_count; i++) {
        size_t len = MAX_STRING_LEN;
        ret        = GRIB_SUCCESS;

        if (grib_is_missing(h, options->print_keys[i].name, &ret) && ret == GRIB_SUCCESS) {
            options->print_keys[i].type = GRIB_TYPE_MISSING;
            snprintf(value, sizeof(value), "MISSING");
        }
        else if (ret != GRIB_NOT_FOUND) {
            if (options->print_keys[i].type == GRIB_TYPE_UNDEFINED) {
                grib_get_native_type(h, options->print_keys[i].name, &(options->print_keys[i].type));
            }

            switch (options->print_keys[i].type) {
                case GRIB_TYPE_STRING:
                    ret = grib_get_string(h, options->print_keys[i].name, value, &len);
                    break;
                case GRIB_TYPE_DOUBLE:
                    ret = grib_get_double(h, options->print_keys[i].name,
                                          &(options->print_keys[i].double_value));
                    snprintf(value, sizeof(value), "%g", options->print_keys[i].double_value);
                    break;
                case GRIB_TYPE_LONG:
                    ret = grib_get_long(h, options->print_keys[i].name,
                                        &(options->print_keys[i].long_value));
                    snprintf(value, sizeof(value), "%ld", (long)options->print_keys[i].long_value);
                    break;
                default:
                    fprintf(dump_file, "invalid type for %s\n", options->print_keys[i].name);
                    exit(1);
            }
        }

        if (ret != GRIB_SUCCESS) {
            if (options->fail)
                GRIB_CHECK_NOLINE(ret, options->print_keys[i].name);
            if (ret == GRIB_NOT_FOUND)
                strcpy(value, notfound);
            else {
                fprintf(dump_file, "%s %s\n", grib_get_error_message(ret), options->print_keys[i].name);
                exit(ret);
            }
        }
        options->print_keys[i].string_value = strdup(value);
    }
    return options->print_keys;
}

int grib_no_handle_action(grib_runtime_options* options, int err)
{
    fprintf(dump_file, "\t\t\"ERROR: unreadable message\"\n");
    return 0;
}