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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
| ;====================================================================== ; This script contains a number of functions and procedures for ; working with shapefiles in NCL. ; ; print_shapefile_info - prints basic information about a shapefile. ; ; plot_shapefile - plots data in a shapefile over a map. ; ; shapefile_mask_data - masks a data array based on outlines in ; a shapefile ;======================================================================
;====================================================================== ; Given a shapefile name, i.e. "xxxx_yyyy.shp", this function returns ; the prefix "xxxx_yyyy". ;====================================================================== undef("get_shapefile_prefix") function get_shapefile_prefix(shapefile_name[1]:string) begin s = str_split(shapefile_name,".") ns = dimsizes(s) if(ns.eq.1) return(s) else return(str_join(s(0:ns-2),"_")) end if end
;====================================================================== ; print_shapefile_info(shapefile_name) ; shapefile_name - Name of shapefile, i.e."AUS_adm0.shp" ; ; This procedure prints basic information about a shapefile. ;====================================================================== undef("print_shapefile_info") procedure print_shapefile_info(shapefile_name[1]:string) local n, f, var_names, geo_dims, num_features, lat, lon, nvars, dq begin dq = str_get_dq()
;---Open shapefile f = addfile(shapefile_name,"r")
;---Read data off shapefile var_names = getfilevarnames(f) ; variable names geo_dims = getfilevardimsizes(f,"geometry") ; features on file num_features = geo_dims(0) lon = f->x lat = f->y nvars = dimsizes(var_names)
print("======================================================================") print("Filename: " + dq + shapefile_name + dq) print(" Geometry type: " + f@geometry_type) print(" # of features: " + num_features) print(" Min/max lat: " + sprintf("%7.2f",min(lat)) + "/" + sprintf("%7.2f",max(lat))) print(" Min/max lon: " + sprintf("%7.2f",min(lon)) + "/" + sprintf("%7.2f",max(lon))) print(" Variable names and their types:") do n=0,nvars-1 print(" " + var_names(n) + " : " + getfilevartypes(f,var_names(n))) end do print("======================================================================") end
;====================================================================== ; shapefile_mask_data ; ; This function masks a rectilinear, curvilinear, or unstructured ; data array based on either all the outlines in a shapefile, or ; based on a string variable name in a shapefile and a list of strings ; to check for, like "Water body" or (/"Ohio","Michigan"/). ; ; You have the option to return the mask array, rather than the masked ; data array. ; ; Input paramaters ; data : numeric - 1D or 2D data to mask or base mask array on ; shp_file_name[1] : string - Name of shapefile ; opt[1] : logical - Use to set options for this function. If ; set to False, then all options will be ignored. ; ; "opt" can have the following attributes: ; ; "keep" - Whether to keep the values in the given shapefile ; areas or toss them. ; [default True] ; ; "shape_var" - Name of variable on shapefile that contains the ; string names of specific areas you want to mask. ; [default is to use the whole shapefile] ; ; "shape_names" - List of string names in "shape_name" to mask against ; [no default] ; ; "return_mask" - Whether to return a mask array (0s and 1s) ; instead of the masked data. ; [default False] ; ; "minlat", "maxlat", "minlon", "maxlon" - You can tell the masking ; routine what rough lat/lon box you are interested ; in, so that it doesn't check every lat/lon segment ; in the shapefile. ; [default is the min/max of the lat/lon on shapefile] ; ; "loop_check" - Whether to do a min/max lat/lon check for every loop iteration. ; I tested this on four examples, and it sped every one of them up. ; I decided to make this True by default.; ; [default True] ; ; "debug" - Whether to print debug information. ; [default False] ; ; - If a rectilinear grid, then "data" must have coordinate arrays ; attached. ; - If a curvilinear grid, then "data" must have the special lat2d ; and lon2d attributes attached. ; - If a unstructured grid, then "data"must have the special lat1d ; and lon1d attributes attached. ;====================================================================== undef("shapefile_mask_data") function shapefile_mask_data(data:numeric,shapefile_name[1]:string,\ opt[1]:logical) local mask_start_time, mask_end_time,keep_true_value, keep_false_value, \ dims, rank, grid_type, lat1d, lon1d, nlatlon1d, f, segments, geometry, \ segsDims, geomDims, geom_segIndex, geom_numSegs, segs_xyzIndex, segs_numPnts,numFeatures, lat, lon, shp_mask_names, found, nf, numFeatures, \ startSegment, numSegments, seg, startPT, endPT, lon_sub, lat_sub, \ min_lat_shp, max_lat_shp, min_lon_shp, max_lon_shp begin mask_start_time = get_cpu_time()
;---Make sure we can open shapefile if(.not.isfilepresent(shapefile_name)) then print("shapefile_mask_data : Error: " + shapefile_name + \ " either doesn't exist or is not a valid shapefile.") exit end if f = addfile(shapefile_name,"r")
;---Parse options and check for errors DEBUG = get_res_value_keep(opt,"debug",False) KEEP = get_res_value_keep(opt,"keep",True) RETURN_MASK = get_res_value_keep(opt,"return_mask",False) LOOP_CHECK = get_res_value_keep(opt,"loop_check",True) SHP_VAR = opt.and.isatt(opt,"shape_var") if(opt.and.isatt(opt,"shape_var")) then if(.not.isatt(opt,"shape_names")) then print("shapefile_mask_data : Error: if you set 'shape_var' you must also set 'shape_names'") exit end if shp_var_name = opt@shape_var usr_mask_names = opt@shape_names
;---Make sure shp_var_name is on shapefile. if(isfilevar(f,shp_var_name)) then shp_mask_names = f->$shp_var_name$ else print("shapefile_mask_data : Error: The given variable name to use does not exist on the given shapefile.") exit end if
;---Make sure usr_mask_names has at least one match in shp_mask_names num_found = 0 nusr_mask_names = dimsizes(usr_mask_names) do i=0,nusr_mask_names-1 if(any(usr_mask_names(i).eq.shp_mask_names)) then num_found = num_found+1 end if end do if(num_found.eq.0) then print("shapefile_mask_data : Error: none of the given mask_names match the names on the shapefile.") exit end if if(num_found.lt.nusr_mask_names) then print("shapefile_mask_data : warning: Only found " + num_found + \ " of the " + nusr_mask_names) print(" given mask_names on the shapefile.") end if end if
if(KEEP) then keep_true_value = 1 ; 1 ==> values inside given mask areas will be kept keep_false_value = 0 else keep_true_value = 0 ; 0 ==> values inside given mask areas will be tossed keep_false_value = 1 end if
;---Determine the grid type dims = dimsizes(data) rank = dimsizes(dims)
grid_type = "" if(rank.eq.2.and.\ isdimnamed(data,0).and.iscoord(data,data!0).and.\ isdimnamed(data,1).and.iscoord(data,data!1)) then lat1d = ndtooned(conform_dims(dims,data&$data!0$,0)) lon1d = ndtooned(conform_dims(dims,data&$data!1$,1)) grid_type = "rectilinear" else if(rank.eq.2.and.all(isatt(data,(/"lat2d","lon2d"/)))) then ;---Curvilinear lat1d = ndtooned(data@lat2d) lon1d = ndtooned(data@lon2d) if(product(dims).eq.dimsizes(lat1d).and.\ product(dims).eq.dimsizes(lon1d)) then grid_type = "curvilinear" end if else if(rank.eq.1.and.all(isatt(data,(/"lat1d","lon1d"/)))) then ;---Unstructured lat1d = data@lat1d lon1d = data@lon1d if(dims.eq.dimsizes(lat1d).and.\ product(dims).eq.dimsizes(lon1d)) then grid_type = "unstructured" end if end if end if end if
if(grid_type.eq."") then print("shapefile_mask_data: Error: not a valid rectilinear, curvilinear, or unstructured grid") exit end if nlatlon1d = dimsizes(lat1d)
;---Read data off the shapefile segments = f->segments geometry = f->geometry segsDims = dimsizes(segments) geomDims = dimsizes(geometry)
;---Read global attributes geom_segIndex = f@geom_segIndex geom_numSegs = f@geom_numSegs segs_xyzIndex = f@segs_xyzIndex segs_numPnts = f@segs_numPnts numFeatures = geomDims(0)
;---Read shapefile lat/lon lon = f->x lat = f->y ; ; If shp_var_name is specified, then get the approximate lat/lon box that ; encloses the shapefile areas of interest. This can make the ; gc_inout checking go faster later. If the user has input ; all four "usr_min/max_lat/lon" attributes, then don't do the check. ; if(SHP_VAR.and..not.(opt.and.isatt(opt,"minlat").and.isatt(opt,"maxlat").and.\ isatt(opt,"minlon").and.isatt(opt,"maxlon"))) then found = False do nf=0,numFeatures-1 if(any(shp_mask_names(nf).eq.usr_mask_names)) then startSegment = geometry(nf, geom_segIndex) numSegments = geometry(nf, geom_numSegs) do seg=startSegment, startSegment+numSegments-1 startPT = segments(seg, segs_xyzIndex) endPT = startPT + segments(seg, segs_numPnts) - 1 lat_sub := lat(startPT:endPT) lon_sub := lon(startPT:endPT) if(found) then min_lat_shp = min((/min_lat_shp,min(lat_sub)/)) max_lat_shp = max((/max_lat_shp,max(lat_sub)/)) min_lon_shp = min((/min_lon_shp,min(lon_sub)/)) max_lon_shp = max((/max_lon_shp,max(lon_sub)/)) else min_lat_shp = min(lat_sub) max_lat_shp = max(lat_sub) min_lon_shp = min(lon_sub) max_lon_shp = max(lon_sub) found = True end if end do end if end do else ;---Use the whole shapefile min_lat_shp = min(lat) max_lat_shp = max(lat) min_lon_shp = min(lon) max_lon_shp = max(lon) end if ;--lat/lon coordinates of data array min_lat_data = min(lat1d) max_lat_data = max(lat1d) min_lon_data = min(lon1d) max_lon_data = max(lon1d)
;---min/max lat/lon to use for checking the data lat/lon min_lat_chk = get_res_value(opt,"minlat",min_lat_shp) max_lat_chk = get_res_value(opt,"maxlat",max_lat_shp) min_lon_chk = get_res_value(opt,"minlon",min_lon_shp) max_lon_chk = get_res_value(opt,"maxlon",max_lon_shp)
;---Get index values where data lat/lon values fall inside this "box". if(.not.LOOP_CHECK) then ii_latlon = ind(min_lat_chk.le.lat1d.and.lat1d.le.max_lat_chk.and.\ min_lon_chk.le.lon1d.and.lon1d.le.max_lon_chk) nii = dimsizes(ii_latlon) end if
if(DEBUG) then print("==================================================") print("Shapefile: " + shapefile_name) if(SHP_VAR) then print("Areas of interest: " + str_join(""+usr_mask_names,",")) else print("Areas of interest: the whole shapefile") end if print("min_lat_chk: " + min_lat_chk) print("max_lat_chk: " + max_lat_chk) print("min_lon_chk: " + min_lon_chk) print("max_lon_chk: " + max_lon_chk) print("min_lat_data: " + min_lat_data) print("max_lat_data: " + max_lat_data) print("min_lon_data: " + min_lon_data) print("max_lon_data: " + max_lon_data) print(dimsizes(lat1d) + " data values originally") if(.not.LOOP_CHECK) then print(nii + " data values within given shapefile areas.") end if if(keep_true_value.eq.1) then print("Will keep data values inside given shapefile areas") else print("Will toss data values inside given shapefile areas") end if end if
;---Create array to hold new data mask data_mask_1d = new(nlatlon1d,integer) data_mask_1d = keep_false_value
; ; Setting opt@loop_check = True seems to produce the best results, timing-wise. ; Maybe get rid of the "else" part of this "if" statement at some point? ; if(LOOP_CHECK) then do nf=0,numFeatures-1 if(.not.SHP_VAR.or.(SHP_VAR.and.\ any(shp_mask_names(nf).eq.usr_mask_names))) then startSegment = geometry(nf, geom_segIndex) numSegments = geometry(nf, geom_numSegs) do seg=startSegment, startSegment+numSegments-1 startPT = segments(seg, segs_xyzIndex) endPT = startPT + segments(seg, segs_numPnts) - 1 lat_sub := lat(startPT:endPT) lon_sub := lon(startPT:endPT) ii_latlon := ind(min(lat_sub).le.lat1d.and.lat1d.le.max(lat_sub).and.\ min(lon_sub).le.lon1d.and.lon1d.le.max(lon_sub)) if(any(ismissing(ii_latlon))) then continue end if nii = dimsizes(ii_latlon) do n=0,nii-1 iltln = ii_latlon(n) if(data_mask_1d(iltln).ne.keep_true_value.and.\ gc_inout(lat1d(iltln),lon1d(iltln),lat_sub,lon_sub)) then data_mask_1d(iltln) = keep_true_value end if end do end do end if end do else do n=0,nii-1 iltln = ii_latlon(n) do nf=0,numFeatures-1 if(data_mask_1d(iltln).ne.keep_true_value.and.\ (.not.SHP_VAR.or.(SHP_VAR.and.\ any(shp_mask_names(nf).eq.usr_mask_names)))) then startSegment = geometry(nf, geom_segIndex) numSegments = geometry(nf, geom_numSegs) do seg=startSegment, startSegment+numSegments-1 startPT = segments(seg, segs_xyzIndex) endPT = startPT + segments(seg, segs_numPnts) - 1 lat_sub := lat(startPT:endPT) lon_sub := lon(startPT:endPT) if(.not.(all(lon_sub.lt.min_lon_data).or. \ all(lon_sub.gt.max_lon_data).or. \ all(lat_sub.lt.min_lat_data).or. \ all(lat_sub.gt.max_lat_data)).and.\ gc_inout(lat1d(iltln),lon1d(iltln),lat_sub,lon_sub)) then data_mask_1d(iltln) = keep_true_value break end if end do end if end do end do end if if(DEBUG) then print("==================================================") if(KEEP) then print(num(data_mask_1d.eq.keep_true_value) + " data values kept") else print(num(data_mask_1d.ne.keep_true_value) + " data values kept") end if end if ; ; Create a 2D data array of same size as original data, ; but with appropriate values masked. Create a missing ; value if our data doesn't have one. ; if(.not.isatt(data,"_FillValue")) then data_msg = default_fillvalue(typeof(data)) else data_msg = data@_FillValue end if
;---Keep all the locations where the mask array is 1. if(RETURN_MASK) then data_mask = onedtond(data_mask_1d,dims) else data_mask = where(onedtond(data_mask_1d,dims).eq.1,data,data_msg) copy_VarMeta(data,data_mask) ; Copy all metadata
if(.not.isatt(data,"_FillValue")) then data_mask@_FillValue = data_msg end if end if
if(DEBUG) then ;---Print timings mask_end_time = get_cpu_time() print("shapefile_mask_data: elapsed time: " + \ (mask_end_time-mask_start_time) + " CPU seconds.") print("==================================================") end if return(data_mask) end
;====================================================================== ; create_shapefile_map(wks,shapefile_name,geometry_type,lat,lon) ; wks - workstation ; ; shapefile_name - Name of shapefile, i.e."AUS_adm0.shp" ; ; geometry_type - Geometry type, read off shapefile via ; "geometry_type" attribute. Must be ; "point", "polylines", or "polygon". ; As of NCL V6.5.0, this routine will ; use "point" if the geometry is not ; set or not recognized. ; ; lat,lon - Arrays containing lat/lon values - can be ; read off file via "y" and "x" arrays on ; shapefile. ; ; This function creates a map for which to add shapefile outlines ; or points. It uses the shapefile_name for a title, and the geometry ; type to determine whether to draw map outlines. ; ; Note: this function could have been written to open the shapefile ; and read the geometry type and lat/lon, but since it is likely ; to be called from a routine that has to read lat/lon anyway, it ; seemed best just to pass this information in, to save time and ; memory. ;====================================================================== undef("create_shapefile_map") function create_shapefile_map(wks,shapefile_name,geometry_type,lat,lon) local res begin res = True
res@tiMainString = shapefile_name
res@gsnMaximize = True ; maximize plot in frame res@gsnDraw = False res@gsnFrame = False
if(geometry_type.eq."point") then res@mpOutlineOn = True res@mpOutlineBoundarySets = "AllBoundaries" else res@mpFillOn = False res@mpOutlineOn = False end if res@mpMinLatF = min(lat) res@mpMaxLatF = max(lat) res@mpMinLonF = min(lon) res@mpMaxLonF = max(lon)
res@pmTickMarkDisplayMode = "Always"
map = gsn_csm_map(wks,res) return(map) end
;====================================================================== ; plot_shapefile - Given a shapefile name ("AUS_adm0.shp"), this ; procedure draws a map with the data from the given shapefile drawn ; on top. ; ; The data is drawn depending on the "geometry_type" attribute of ; the shapefile: ; ; - "points" - data is drawn as filled black circles ; - "polyline" - data is drawn as black polylines ; - "polygon" - data is drawn as colored, filled polygons, with ; black polylines. ;====================================================================== undef("plot_shapefile") procedure plot_shapefile(shapefile_name) local f, wks, shp_type, sres, geometry_type begin ;---Open file f = addfile(shapefile_name,"r") ;---Check validity of shapefile if(.not.isatt(f,"geometry_type")) then print("plot_shapefile: Error: This doesn't appear to be a valid shapefile") print("No 'geometry_type' attribute is present.") exit else if(.not.any(f@geometry_type.eq.(/"point","polyline","polygon"/))) then print("plot_shapefile: Warning: the 'geometry_type' attribute on '" + shapefile_name + "'") print(" is not set to 'point', 'polyline', or 'polygon'.") print(" Will try to plot this data using 'point', but you") print(" may want to examine the file further to make sure") print(" it is correct.") geometry_type = "point" else geometry_type = f@geometry_type end if end if
;---Open device to draw graphics. wks = gsn_open_wks("png",get_shapefile_prefix(shapefile_name))
;---Read lat/lon and create map lat = f->y lon = f->x map = create_shapefile_map(wks,shapefile_name,geometry_type,lat,lon) sres = True if(geometry_type.eq."point") then sres@gsMarkerIndex = 16 id = gsn_add_shapefile_polymarkers(wks,map,shapefile_name,sres) else if(geometry_type.eq."polyline") then id = gsn_add_shapefile_polylines(wks,map,shapefile_name,sres) else if(geometry_type.eq."polygon") then sres@gsFillColor = "SkyBlue" id1 = gsn_add_shapefile_polygons(wks,map,shapefile_name,sres) id2 = gsn_add_shapefile_polylines(wks,map,shapefile_name,sres) end if end if end if
draw(map) ; This will draw map and attached outlines or markers frame(wks) end
|