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
|
/*
* Copyright (C) 2007-2024 S[&]T, The Netherlands.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PDSDUMP_H
#define PDSDUMP_H
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <assert.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#ifdef HAVE_HDF4
#include "mfhdf.h"
#endif
#include "coda.h"
#include "codadump-filter.h"
#define MAX_NUM_DIMS CODA_MAX_NUM_DIMS
#define MAX_DIM_NAME (3 + 3 + CODA_CURSOR_MAXDEPTH * 4 + 3 + 1)
typedef enum run_mode
{
RUN_MODE_LIST,
RUN_MODE_ASCII,
RUN_MODE_HDF4,
RUN_MODE_JSON,
RUN_MODE_YAML,
RUN_MODE_DEBUG
} run_mode_t;
extern run_mode_t run_mode;
extern char *ascii_col_sep;
extern FILE *ascii_output;
extern char *output_file_name;
extern char *starting_path;
extern int verbosity;
extern int calc_dim;
extern int max_depth;
extern int show_dim_vals;
extern int show_index;
extern int show_label;
extern int show_quotes;
extern int show_time_as_string;
extern int show_type;
extern int show_unit;
extern int show_description;
/* this structure contains the dimension information for a single product variable
*(i.e. the combined information of all arrays that are a parent to the variable)
*/
typedef struct dim_info
{
int32_t num_dims; /* total number of dimensions */
int32_t dim[MAX_NUM_DIMS]; /* (maximum) dimensions */
int32_t min_dim[MAX_NUM_DIMS]; /* minimum dimension (only set if the dimension is variable sized) */
int is_var_size; /* is any of the dimensions variable sized? */
int is_var_size_dim[MAX_NUM_DIMS]; /* is a specific dimension variable sized? */
int last_var_size_dim; /* last variable sized dimension (-1 if there is no variable sized dimension) */
int32_t *var_dim[MAX_NUM_DIMS]; /* array pointing to lists of all posible values for variable dimensions */
int32_t var_dim_num_dims[MAX_NUM_DIMS]; /* allocated size of var_dim[i] is num_elements[var_dim_num_dims[i]] */
int64_t array_size[MAX_NUM_DIMS]; /* amount of elements needed for all subdimensions (product of max dim sizes, dim_id = k..n) */
int64_t num_elements[MAX_NUM_DIMS]; /* product of max dim sizes, dim_id = 1..k */
int64_t filled_num_elements[MAX_NUM_DIMS]; /* total number of elements that are really in the product (dim_id = 1..k) (i.e. by counting instead of multiplying maximum dimensions) */
} dim_info_t;
extern dim_info_t dim_info;
typedef struct array_info
{
int32_t dim_id; /* offset of dimensions for this array in dim_info struct */
int32_t num_dims; /* number of dimensions of this pds array */
int32_t dim[MAX_NUM_DIMS]; /* fixed diminsions as returned by data dictionary */
int32_t num_elements; /* product of max dim sizes for this array */
int32_t global_index; /* cumulative index within all elements of this array */
int32_t index[MAX_NUM_DIMS]; /* current index in array */
} array_info_t;
typedef struct traverse_info
{
char *file_name;
coda_product *pf;
/* properties regarding position in product */
coda_type *type[CODA_CURSOR_MAXDEPTH]; /* data type */
int current_depth; /* current depth in product */
coda_cursor cursor; /* cursor positioned at root point */
/* filter properties */
codadump_filter *filter[CODA_CURSOR_MAXDEPTH + 1]; /* applicable filter at each cursor depth */
int filter_depth;
/* array properties */
array_info_t array_info[CODA_CURSOR_MAXDEPTH]; /* info for each parent that is an array */
int num_arrays; /* number of parents that are arrays */
/* record properties */
int field_available_status[CODA_CURSOR_MAXDEPTH]; /* -1 if dynamically available, otherwise 1 */
int parent_index[CODA_CURSOR_MAXDEPTH]; /* field indices for parents that are records */
const char *field_name[CODA_CURSOR_MAXDEPTH]; /* field names for parents that are records */
int num_records; /* number of parents that are records */
} traverse_info_t;
extern traverse_info_t traverse_info;
#ifdef HAVE_HDF4
typedef struct hdf4_info
{
int32 hdf_vfile_id;
int32 hdf_file_id;
int32 sds_id;
int32 vgroup_id[CODA_CURSOR_MAXDEPTH];
int32 vgroup_depth;
int32 hdf_type;
int32 sizeof_hdf_type;
char dim_name[MAX_NUM_DIMS][MAX_DIM_NAME];
/* properties for writing field data */
int32 start[MAX_NUM_DIMS];
int32 edges[MAX_NUM_DIMS];
int offset;
unsigned char *data;
} hdf4_info_t;
extern hdf4_info_t hdf4_info;
#endif
/* codadump.c functions */
void handle_coda_error(void);
/* codadump-ascii.c functions */
void export_data_element_to_ascii(void);
/* codadump-dim.c functions */
void print_all_distinct_dims(int dim_id);
void dim_info_init(void);
void dim_info_done(void);
void dim_enter_array(void);
void dim_leave_array(void);
void clear_array_info(void);
int dim_record_field_available(void);
/* codadump-hdf4.c functions */
#ifdef HAVE_HDF4
void hdf4_info_init(void);
void hdf4_info_done(void);
void hdf4_enter_record(void);
void hdf4_leave_record(void);
void hdf4_enter_array(void);
void hdf4_leave_array(void);
void export_data_element_to_hdf4(void);
#endif
/* codadump-json.c functions */
void print_json_data(int include_attributes);
/* codadump-yaml.c functions */
void print_yaml_data(int include_attributes);
/* codadump-debug.c functions */
void print_debug_data(const char *product_class, const char *product_type, int format_version);
/* codadump-traverse.c functions */
void print_full_field_name(FILE *f, int print_dims, int compound_as_array);
void traverse_info_init(void);
void traverse_info_done(void);
void traverse_product(void);
#endif
|
