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
|
/*--------------------------------------------------------------------
* $Id: gmt_shore.h 10173 2014-01-01 09:52:34Z pwessel $
*
* Copyright (c) 1991-2014 by P. Wessel and W. H. F. Smith
* See LICENSE.TXT file for copying and redistribution conditions.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* Contact info: gmt.soest.hawaii.edu
*--------------------------------------------------------------------*/
#ifndef _GMT_SHORE_H
#define _GMT_SHORE_H
/*
* Include file for gmt_shore.c
*
* Author: Paul Wessel
* Date: 12-AUG-1995
* Revised: 6-NOV-2009
* Version: 4.5.6
*/
#include "netcdf.h"
#define GSHHS_MAX_DELTA 65535 /* Largest value to store in a unsigned short, used as largest dx or dy in bin */
#define GMT_MAX_GSHHS_LEVEL 4 /* Highest hierarchical level of coastlines */
#define GMT_N_BLEVELS 3 /* Number of levels for borders */
#define GMT_N_RLEVELS 11 /* Number of levels for rivers */
#define GMT_RIV_INTERMITTENT 5 /* Id for intermittent rivers */
#define GMT_RIV_CANALS 8 /* Id for river canals */
#define GMT_NO_RIVERLAKES 1
#define GMT_NO_LAKES 2
struct GMT_SHORE_SELECT { /* Information on levels and min area to use */
int low; /* Lowest hierarchical level to use [0] */
int high; /* Highest hierarchical level to use [4] */
int flag; /* 1 = no riverlakes from level 2; 2 = only riverlakes from level 2 */
int fraction; /* If not 0, the microfraction limit on a polygons area vs the full resolution version */
double area; /* Area of smallest geographical feature to include [0] */
};
struct GMT_GSHHS_pol { /* Information pertaining to each GSHHS polygon */
int *parent; /* Array with ids of the parent polygon for each GSHHS polygon (-1 for all level 1 polygons) */
double *area; /* Array with areas in km^2 of the GSHHS polygons */
int *area_fraction; /* Array with micro-fraction fractions of area relative to full res area */
};
struct GMT_SHORE { /* Struct used by pscoast and others */
/* Global variables that remain fixed for all bins */
GMT_LONG nb; /* Number of bins to use */
GMT_LONG *bins; /* Array with the nb bin numbers to use */
GMT_LONG min_level; /* Lowest level to include [0] */
GMT_LONG max_level; /* Highest level to include [4] */
GMT_LONG flag; /* If riverlakes or lakes are to be excluded */
GMT_LONG fraction; /* If not 0, the microfraction limit on a polygons area vs the full resolution version */
double min_area; /* Smallest feature to include in km^2 */
double scale; /* Multiplier to convert dx, dy back to dlon, dlat in degrees */
/* Variables associated with the current bin */
GMT_LONG ns; /* Number of segments to use in current bin */
unsigned char node_level[4];
struct GMT_SHORE_SEGMENT *seg; /* Array of these segments */
struct GSHHS_SIDE *side[4]; /* Has position & id for each side exit/entry */
GMT_LONG nside[4]; /* Number of entries per side, including corner */
GMT_LONG n_entries;
GMT_LONG leftmost_bin; /* TRUE if current bin is at left edge of map */
GMT_LONG skip_feature; /* TRUE if GSHHS version > 2.0 and +r or +l is in use */
double bsize; /* Size of square bins in degrees */
double lon_sw; /* Longitude of SW corner */
double lat_sw; /* Latitude of SW corner */
double lon_corner[4]; /* Longitudes of 4 corners (depends on direction) */
double lat_corner[4]; /* Latitudes of 4 corners (depends on direction) */
/* Data variables associated with shoreline database */
int bin_size; /* Size of square bins in minutes */
int bin_nx; /* Number of bins in 360 degrees of longitude */
int bin_ny; /* Number of bins in 180 degrees of latitude */
int n_poly; /* Number of polygons present in the data set */
int n_bin; /* Number of bins present in the data set */
int n_seg; /* Number of segments present in the data set */
int n_pt; /* Number of points present in the data set */
int n_nodes; /* Number of grid nodes present in the data set */
int *GSHHS_node; /* Array with ids of the polygon that enclose each node */
int *bin_firstseg; /* Array with ids of first segment per bin */
short int *bin_info; /* Array with levels of all 4 nodes per bin */
short int *bin_nseg; /* Array with number of segments per bin */
int *GSHHS_parent; /* Array with ids of the parent polygon for each GSHHS polygon (-1 for all level 1 polygons) */
double *GSHHS_area; /* Array with areas in km^2 of the GSHHS polygons */
int *GSHHS_area_fraction; /* Array with micro-fraction fractions of area relative to full res area */
char units[80]; /* Units of lon/lat */
char title[80]; /* Title of data set */
char source[80]; /* Source of data set */
char version[8]; /* Version of data set */
/* netCDF ID variables */
int cdfid; /* netCDF File id for coastbin file */
int bin_size_id; /* Id for variable bin_size */
int bin_nx_id; /* Id for variable bin_nx */
int bin_ny_id; /* Id for variable bin_ny */
int n_poly_id; /* Id for variable n_bin */
int n_bin_id; /* Id for variable n_bin */
int n_seg_id; /* Id for variable n_seg */
int n_pt_id; /* Id for variable n_pt */
int n_node_id; /* Id for variable n_nodes */
int bin_firstseg_id; /* Id for variable bin_firstseg */
int bin_info_id; /* Id for variable bin_info */
int bin_nseg_id; /* Id for variable bin_nseg */
int seg_info_id; /* Id for variable seg_info */
int seg_start_id; /* Id for variable seg_start */
int seg_GSHHS_ID_id; /* Id for variable seg_GSHHS_ID */
int GSHHS_parent_id; /* Id for variable GSHHS_parent */
int GSHHS_area_id; /* Id for variable GSHHS_area */
int GSHHS_areafrac_id; /* Id for variable GSHHS_area_fraction */
int GSHHS_node_id; /* Id for variable GSHHS_node_id */
int pt_dx_id; /* Id for variable pt_dx */
int pt_dy_id; /* Id for variable pt_dy */
};
struct GMT_SHORE_SEGMENT {
unsigned char level; /* Level of polygon segment (1 i ocean/land, 2 = land/lake, 3 = lake/island, etc) */
unsigned char entry; /* Side (0-3) the segment starts on, or 4 for closed segments */
unsigned char exit; /* Side (0-3) the segment ends on, or 4 for closed segments */
unsigned char fid; /* Fill id (same as level expect for riverlakes which is 5) */
unsigned short n; /* Number of points in segment */
short int *dx; /* Array of scaled longitudes relative to SW corner */
short int *dy; /* Array of scaled latitudes relative to SW corner */
};
struct GSHHS_SIDE {
unsigned short pos; /* Position along side in 0-65535 range */
short int id; /* Local segment id */
};
struct GMT_BR { /* Structure for Borders and Rivers */
/* Global variables that remain fixed for all bins */
GMT_LONG nb; /* Number of bins to use */
GMT_LONG *bins; /* Array with the nb bin numbers to use */
double scale; /* Multiplier to convert dx, dy back to dlon, dlat in degrees */
/* Variables associated with the current bin */
GMT_LONG ns; /* Number of segments to use in current bin */
struct GMT_BR_SEGMENT *seg; /* Array of these segments */
double lon_sw; /* Longitude of SW corner */
double lat_sw; /* Latitude of SW corner */
double bsize; /* Size of square bins in degrees */
/* Data variables associated with shoreline database */
int bin_size; /* Size of square bins in minutes */
int bin_nx; /* Number of bins in 360 degrees of longitude */
int bin_ny; /* Number of bins in 180 degrees of latitude */
int n_bin; /* Number of bins present in the data set */
int n_seg; /* Number of segments present in the data set */
int n_pt; /* Number of points present in the data set */
int *bin_firstseg; /* Array with ids of first segment per bin */
short int *bin_nseg; /* Array with number of segments per bin */
char units[80]; /* Units of lon/lat */
char title[80]; /* Title of data set */
char source[80]; /* Source of data set */
char version[8]; /* Version of data set */
/* netCDF ID variables */
int cdfid; /* File id for coastbin file */
int bin_size_id; /* Id for variable bin_size */
int bin_nx_id; /* Id for variable bin_nx */
int bin_ny_id; /* Id for variable bin_ny */
int n_bin_id; /* Id for variable n_bin */
int n_seg_id; /* Id for variable n_seg */
int n_pt_id; /* Id for variable n_pt */
int bin_firstseg_id; /* Id for variable bin_firstseg */
int bin_nseg_id; /* Id for variable bin_nseg */
int seg_n_id; /* Id for variable seg_n */
int seg_level_id; /* Id for variable seg_level */
int seg_start_id; /* Id for variable seg_start */
int pt_dx_id; /* Id for variable pt_dx */
int pt_dy_id; /* Id for variable pt_dy */
};
struct GMT_BR_SEGMENT {
unsigned short n; /* Number of points in segment */
unsigned short level; /* Hierarchical level of segment */
short int *dx; /* Array of scaled longitudes relative to SW corner */
short int *dy; /* Array of scaled latitudes relative to SW corner */
};
struct GMT_GSHHS_POL {
GMT_LONG n;
GMT_LONG interior; /* TRUE if polygon is inside bin */
GMT_LONG level;
GMT_LONG fid; /* Fill id; same as level but 5 if riverlake */
double *lon;
double *lat;
};
/* Public functions */
EXTERN_MSC void GMT_set_levels (char *info, struct GMT_SHORE_SELECT *I);
EXTERN_MSC GMT_LONG GMT_get_shore_bin (GMT_LONG b, struct GMT_SHORE *c);
EXTERN_MSC GMT_LONG GMT_get_br_bin (GMT_LONG b, struct GMT_BR *c, GMT_LONG *level, GMT_LONG n_levels);
EXTERN_MSC void GMT_free_polygons (struct GMT_GSHHS_POL *p, GMT_LONG n);
EXTERN_MSC void GMT_free_shore (struct GMT_SHORE *c);
EXTERN_MSC void GMT_free_br (struct GMT_BR *c);
EXTERN_MSC void GMT_shore_cleanup (struct GMT_SHORE *c);
EXTERN_MSC void GMT_br_cleanup (struct GMT_BR *c);
EXTERN_MSC GMT_LONG GMT_init_shore (char res, struct GMT_SHORE *c, double w, double e, double s, double n, struct GMT_SHORE_SELECT *I);
EXTERN_MSC GMT_LONG GMT_init_br (char which, char res, struct GMT_BR *c, double w, double e, double s, double n);
EXTERN_MSC GMT_LONG GMT_assemble_shore (struct GMT_SHORE *c, GMT_LONG dir, GMT_LONG assemble, GMT_LONG shift, double west, double east, struct GMT_GSHHS_POL **pol);
EXTERN_MSC GMT_LONG GMT_assemble_br (struct GMT_BR *c, GMT_LONG shift, double edge, struct GMT_GSHHS_POL **pol);
EXTERN_MSC GMT_LONG GMT_prep_polygons (struct GMT_GSHHS_POL **p, GMT_LONG np, GMT_LONG sample, double step, GMT_LONG anti_bin);
EXTERN_MSC GMT_LONG GMT_set_resolution (char *res, char opt);
EXTERN_MSC char GMT_shore_adjust_res (char res);
#endif /* _GMT_SHORE_H */
|
