/usr/share/octave/packages/mapping-1.2.1/shaperead.m is in octave-mapping 1.2.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 | ## Copyright (C) 2014,2015 Philip Nienhuis
##
## 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; either version 3 of the License, or
## (at your option) 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.
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} [@var{outstruct} ] = shaperead (@var{shp_filename})
## @deftypefnx {Function File} [@var{outstruct} ] = shaperead (@var{shp_filename}, @var{outstyle})
## @deftypefnx {Function File} [@var{outstruct} ] = shaperead (@var{shp_filename}, @var{outstyle}, @var{opts})
## @deftypefnx {Function File} [@var{outstruct}, @var{atts} ] = shaperead (@var{shp_filename}, ...)
## Read an ArcGis shapefile set (shp, shx and dbf).
##
## Depending on the value of @var{outstyle} some different output formats
## will be returned:
##
## @table @code
## @item 0 (numeric)
## @itemx ml (case-insensitive)
## @itemx m
## Return a Matlab-compatible M X 1 struct with a separate entry for each shape
## feature in the shape file. Each struct element contains fields "Geometry"
## (shape type), "BoundingBox" ([minX minY ; maxX maxY]), X, Y (coordinates of
## points in the shape item as row vectors). For multi-part items, the
## coordinates of each part are separated by NaNs. This output format supports
## neither M and Z type nor MultiPatch shape features. For M and Z type shape
## features the M and Z values will simply be ignored.
## The struct is augmented with attributes found in the accompanying .dbf file,
## if found.
##
## For ML-style output, if only one output argument is requested the attributes
## in the .dbf file will be augmented to that struct. If two output arguments
## are requested, the attributes will be returned separately in output struct
## @var{atts}.
##
## @item 1 (numeric)
## @itemx ext (case-insensitive)
## @itemx e
## Same as 1 but M and Z type and MultiPatch shape features are accepted. The
## resulting output struct is no more ML-compatible. If the shapefile contains
## M and/or Z type shape features the mapstruct or gestruct has extra fields M
## and -optionally- Z. Note that MultiPatch shape features may not have
## M-values even if Z-values are present. For MultiPatch shapes another field
## Parts is added, a Px2 array with zero-based indices to the first vertex of
## each subfeature in the XYZ fields in column 1 and the type of each
## subfeature in column 2; P is the number of shape feature parts.
##
## @item 2 (numeric)
## @itemx oct (case-insensitive)
## @itemx o
## Return a struct containing a N X 6 double array "vals" containing the X, Y,
## and Z coordinates, M-values, record nr. and type of each point in the shape
## file. If no M or Z values were present the relevant columns contain
## NaNs. Individual shape features and shape parts are separated by a row of
## NaN values. The field "idx" contains 1-based pointers into field vals to
## the first vertex of each shape feature.
## Field "bbox" contains an 8 X M double array of XYZ coordinates of the
## bounding boxes and min/max M-values corresponding to the M items found in
## the .shp file; for point shapes these contain NaNs.
## Field "npt" contains a 1 X M array of the number of points for each item.
## Field "npr" contains a 1 X M cell array containing a row of P part indices
## (zero-based) for each Polyline, Polygon or MultiPatch part in the shape
## file; for multipatch each cell contains another row with the part types;
## for other item types (point etc.) the cell array contains empty rows.
## A separate field "shpbox" contains the overall bounding box X, Y and Z
## coordinates and min/max M-values in a 4 X 2 double array. If the shape file
## contains no Z or M values the corresponding columns are filled with NaNs.
##
## The struct field "fields" contains a cellstr array with names of the columns.
## If a corresponding .dbf file was read, the struct array also contains
## a field for each attribute found in the .dbf file with the corresponding
## field name, each containing a 1 X M array of attribute values matching the
## M items in the .shp file. These arrays can be double, char or logical,
## depending on the type found in the .dbf file.
##
## @item 3 (numeric)
## @itemx dat (case-insensitive)
## @itemx d
## Same as OCT or 0 but without a row of NaN values between each shape
## file item in the VALS array.
## @end table
##
## If a character option is given, just one character will suffice. The default
## for @var{outstyle} is "ml".
##
## The output of 'shaperead' can be influenced by property-value pairs. The
## following properties are recognized (of which only the first three
## characters are significant, case doesn't matter):
##
## @table @code
## @item BoundingBox
## Select only those shape items (features) whose bounding box lies within, or
## intersets in at least one point with the limits of the BoundingBox value (a
## 2 X 2 double array [Minx, MinY; MaxX, MaxY]).
## No intersection or clipping with the BoundingBox value will be done by
## default!
##
## @item Clip
## (only useful in conjuction with the BoundingBox property) If a value of 1 or
## true is supplied, clip all shapes to the bounding box limits. This option
## may take quite a bit of processing time. If a value of "0" or false is
## given, do not perform clipping. The default value is 0.
## Clipping is merely meant to be performed in the XY plane. Clipping 3D
## shapes may work to some extent but can lead to unpredictable results; this
## is especially true for MultiPatch shape types.
## For M and Z type polylines and polygons, the M and Z values are linearly
## interpolated for segments crossing the bounding box. As no M and Z values
## can be computed for "new" corner nodes, NaN values are inserted there.
## For clipping polylines and polygons the Octave-Forge geometry and octclip
## packages need to be installed and loaded.
##
## @item Debug
## If a value of 'true' or 1 is given, shaperead echoes the current record
## number while reading. Can be useful for very big shapefiles. The default
## value is 0 (no feedback). If a Matlab-compatible output structarray is
## requested and the Bounding Box property is specified, the extracted shape
## feature indices are added to the field "___Shape_feature_nr___".
##
## @item RecordNumbers
## Select only those records whose numbers are listed as integer values in
## an array following RecordNumbers property. Neither the size nor the class of
## the array matters as long as it is a numeric array.
##
## @item UseGeoCoords
## (Only applicable if a Matlab-style output struct is requested). If a value
## of 'true' (or 1) is supplied, return a geostruct rather than a mapstruct.
## If a value of 0 or false is given, return a mapstruct.
## The mere difference is that in a geostruct the fields 'X' and 'Y' are
## replaced by 'Long' and 'Lat'. The default value is 'false' (return a
## mapstruct').
## @end table
##
## @seealso{geoshow, mapshow, shapedraw, shapeinfo}
## @end deftypefn
## Author: Philip Nienhuis <prnienhuis@users.sf.net>
## Created: 2014-11-07
## Updates: **** FIXME Please leave this until the next mapping package release ***
## 2014-11-07/10 First draft
## 2014-11-12 Rewrite into more logical struct array
## 2014-11-13 Fix indexing in NaN row insertion for outopts=1
## 2014-11-14 Added Matlab-compatible output mapstruct option
## 2014-11-15 Removed redundant code leading to a 75 X speed increase
## '' Fix ML-style X and Y coordinates
## 2014-11-16 Add shape type to each struct element for ML-style output
## '' Initial input options parsing
## '' RecordNumbers, UseGeoCoords and BoundingBox implemented
## 2014-11-17 Double output structs (ML-compatible)
## 2014-11-18 Polygon clipping & test for geometry package
## 2014-11-26 Polygon clipping debugged & working
## 2014-11-28 Return empty cell arr if no shape features read
## '' Return full mapstruct array for no output arg
## 2014-11-29 Doubly run inpolygon to include features > and < BoundingBox
## 2014-11-30 Implement Polygon & Point clipping
## 2014-12-15 Last debug of Polyline clipping
## 2014-12-17 Fix MultiPatch reading, esp. detection of missing M (measure)
## 2014-12-29 Implement selecting cellstr attributes in .dbf file
## 2014-12-30 Do not transpose npr values for MultiPatch
## 2015-01-01 Catch null shapes and prevent reading their attributes
## 2015-01-10 Use .shx (if present) to speed up RecordNumbers searches
## 2015-01-12 For outopts=1, apply cell2mat to numeric & logical attributes
## 2015-01-14 Swap outopts values for ml (now 0) and plt style (now 3). In
## passing, fix wrong switch case id at ~L.651.
## '' Reserve outopts = 1 for future use (ML-comp. mapstruct w. Z & M
## atts & multipatch feature type
## 2015-01-19 Do not include/process NULL shape types once record has been read
## 2015-01-27 Stricter checks on ML compatibility for outopts=1; fix some
## wrong references to outopts type, add ext/e for outopts=1;
## update texinfo header; speed-up reading MultiPatch
## 2015-04-19 Make warning setting local
## '' Add filesep to basename
## 2015-07-10 Separate checks for octclip and geometry package
## '' Make rest of warning settings local
## '' Avoid leading filesep in case of no full path name in basename
## '' Improve struct type check and error message
## **** FIXME Please leave this until the next mapping package release ***
function [ outs, oatt ] = shaperead (fname, varargin);
## FIXME Implementation needed of these ML input arguments:
## - Selector (supposedly difficult. I'd prefer myself to leave this
## outside of shaperead, it needlessly complicates and slows
## this function /PRN)
## Check input
if (nargin < 1)
print_usage ();
endif
## Check file name
[pth, fnm, ext] = fileparts (fname);
if (isempty (ext))
bname = fname;
fname = [fname ".shp"];
elseif (isempty (pth))
## Later on bname.shx and bname.dbf will be read
bname = fnm;
else
## Later on bname.shx and bname.dbf will be read
bname = [pth filesep fnm];
endif
## Find out what args have been supplied
if (nargin == 1)
## Only filename supplied. Set "ml" (Matlab) type as default
outopts = 0;
elseif (nargin == 2)
## Assume filename + outopts was supplied
outopts = varargin{1};
varargin = {};
elseif (rem (nargin, 2) == 0)
## Even number of input args => Outopts & at least one pair of varargin
outopts = varargin{1};
varargin(1) = [];
else
## Only filename and varargin supplied
outopts = 0;
## Just to be sure check, if output type was selected anyway; it would
## imply a missing opts value
if (any (strncmp (varargin{1}, {"ml", "ext", "oct", "dat"}, 1)) || ...
isnumeric (varargin{1}))
outopts = varargin{1};
varargin(1) = [];
endif
endif
## Check output type arg
if (isnumeric (outopts))
if (outopts < 0 || outopts > 3)
error ("shaperead: value for arg. #2 out of range 0-3\n");
endif
elseif (ischar (outopts))
outopts = lower (outopts);
if (! any (strncmp (outopts, {"ml", "ext", "oct", "dat"}, 1)))
error ("shaperead: value for arg. #2 should be one of 'ml', 'ext', 'oct' or 'dat'\n");
endif
switch outopts
case {"ml", "m"}
outopts = 0;
case {"ext", "e"}
outopts = 0;
case {"oct", "o"}
outopts = 2;
case {"dat", "d"}
outopts = 3;
otherwise
error ("shaperead: illegal value for arg. #2: '%s' - expected 'ml', 'ext', 'oct' of 'dat'", ...
outopts);
endswitch
else
error ("shaperead: numeric or character type expected for arg. #2\n");
endif
## ---------------------- 1. .shx ----------------------
## Open .shx file to help speed up seeks to next records. We need this info
## for s_recs check below
have_shx = 0;
fidx = fopen ([bname ".shx"], "r");
if (fidx < 0)
warning ("shaperead: index file %s not found\n", [fnm ".shx"]);
else
fseek (fidx, 24, "bof");
fxlng = fread (fidx, 1, "int32", 72, "ieee-be");
nrec = (fxlng - 50) / 4;
fseek (fidx, 100, "bof");
## Get record start positions & -lengths in 16-bit words
ridx = reshape (fread (fidx, nrec*2, "int32", 0, "ieee-be"), 2, [])';
fclose (fidx);
## Get indices & lengths in bytes
ridx *= 2;
endif
## Parse options; first set defaults
clip = 0;
dbug = 0;
s_atts = {};
s_bbox = [];
s_geo = 0;
s_recs = [];
## Init collection of records that meet BB criteria
bb_union = [];
## Process input args
for ii = 1:2:length (varargin)
switch (lower (varargin{ii})(1:3))
case "att"
## Select records based on attribute values
s_atts = varargin{ii+1};
case "bou"
## Select whether record / shape feature points lie inside or outside limits
try
s_bbox = double (varargin{ii+1});
if (numel (s_bbox) != 4)
error ("shaperead: 2 X 2 numeric array expected for BoundingBox\n");
endif
catch
error ("shaperead: numeric2 X 2 array expected for BoundingBox\n");
end_try_catch
## Initialize supplementary polygon array here
sbox = [s_bbox(1) s_bbox(2); s_bbox(1) s_bbox(4); s_bbox(3) s_bbox(4); ...
s_bbox(3) s_bbox(2); s_bbox(1) s_bbox(2)];
case "cli"
## Clip polygons to requested BoundingBox
try
clip = logical (varargin{ii+1});
catch
error ("numeric or logical value expected for 'Clip'\n");
end_try_catch
case "deb"
## Set verbose output (count records)
try
dbug = logical (varargin{ii+1});
catch
error ("numeric or logical value expected for 'Debug'\n");
end_try_catch
case "rec"
## Select record nrs directly. Check for proper type & clean up
try
s_recs = sort (unique (double (varargin{ii+1}(:))));
have_shx = fidx > 0;
if (have_shx && any (s_recs > nrec))
printf ("shaperead: requ. record nos. > nr. of records (%d) ignored\n", ...
nrec);
s_recs (find (srecs > nrec)) = [];
endif
catch
error ("shaperead: numeric value or array expected for RecordNumbers\n");
end_try_catch
case "sel"
## A hard one, to be implemented later?
printf ("shaperead: 'Selector' option not implemented, option ignored\n");
case "use"
## Return a geostruct or a mapstruct (default). Only for ML-structs
if (outopts != 0)
error ("shaperead: UseGeoCoords only valid for Matlab-style output\n");
endif
try
s_geo = logical (varargin{ii+1});
catch
error ("shaperead: logical value type expected for 'UseGeoCoords'\n");
end_try_catch
otherwise
warning ("shaperead: unknown option '%s' - ignored\n", varargin{ii});
endswitch
endfor
## Post-processing
if (clip)
if (isempty (s_bbox))
warning ("shaperead: no BoundingBox supplied => Clip option ignored.\n");
clip = 0;
endif
if (isempty (which ("oc_polybool")))
## No OF octclip package?
printf ("shaperead: function 'oc_polybool' not found. Clip option ignored\n");
warning (" (OF octclip package installed and loaded?)\n");
clip = 0;
endif
if (isempty (which ("distancePoints")))
## No OF geometry package?
printf ("shaperead: function 'distancePoints' not found. Clip option ignored\n");
warning (" (OF geometry package installed and loaded?)\n");
clip = 0;
endif
endif
## ============= Preparations done, now we can start reading ============
## ---------------------- 2. Read .shp file proper ----------------------
## Start reading header
fidp = fopen (fname, 'r');
if (fidp < 0)
error ("shaperead: couldn't open file %s\n", fname);
endif
fseek (fidp, 0, "bof");
## Read & check file code
fcode = fread (fidp, 1, "int32", 20, "ieee-be");
if (fcode != 9994)
error ("%s is not a valid shapefile\n", fname);
endif
flngt = fread (fidp, 1, "int32", 0, "ieee-be") * 2;
fvsn = fread (fidp, 1, "int32", 0, "ieee-le");
shpt = fread (fidp, 1, "int32"); ## Shape file type
shpbox.X(1) = fread (fidp, 1, "double");
shpbox.Y(1) = fread (fidp, 1, "double");
shpbox.X(2) = fread (fidp, 1, "double");
shpbox.Y(2) = fread (fidp, 1, "double");
shpbox.Z(1) = fread (fidp, 1, "double");
shpbox.Z(2) = fread (fidp, 1, "double");
shpbox.M(1) = fread (fidp, 1, "double");
shpbox.M(2) = fread (fidp, 1, "double");
## FIXME: scan shp file in advance to assess nr of XY points, to be able to
## preallocate rec array. May be difficult, .shp is not favorable for
## it. Initial tries showed no significant speed advantage yet over
## the incremental allocation scheme implemented in Ls. 611+ & 631+
## for oct/plt style output. For ml-style it is much harder as
## we'd need to preallocate a potentially very heterogeneous strtuct
## array.
## Prepare for unsupported (in ML output) shape types
unsupp = 0;
ign_mz = (outopts == 0);
## Buffer for record data
BUFSIZE = 10000;
## Read records, 1 by 1. Initialize final array
vals = npt = npr = bbox = idx = nullsh = [];
## Init nr. of shapes read
nshp = 0;
## Temp pointer to keep track of array size and increase it w. BUFSIZE rows
ivals = 1;
## Assume file has M (measure) values
has_M = true;
## Record index number (equals struct element number)
ir = 1;
do
## If the .shx file is there, skip directly to requested record
if (have_shx)
fseek (fidp, ridx(s_recs(ir), 1), "bof");
endif
if (dbug)
printf ("Reading record %d ...\r", ir);
endif
val = NaN(1, 6);
## Read record index number & record length
val(5) = fread (fidp, 1, "int32", 0, "ieee-be");
rlen = fread (fidp, 1, "int32", 0, "ieee-be");
## Here we decide if the record need be read at all, based on s_recs
if (isempty (s_recs) || ismember (double (val(5)), s_recs))
## => this record # has been desired; proceed. Read shape feature type
val(6) = fread (fidp, 1, "int32");
rincl = 1; ## see s_bbox, below
## Init values for this shape item
tbbox = NaN(1, 8);
switch val(6)
case 1 ## Point
val(1:2) = fread (fidp, 2, "double");
val(3:4) = NaN;
tnpt = 1;
tnpr = 0;
case 11 ## PointZ
val(1:4) = fread (fidp, 4, "double");
tnpt = 1;
tnpr = 0;
case 21 ## PointM
val(1:2) = fread (fidp, 2, "double");
## "Z"
val(3) = 0;
## M
val(4) = fread (fidp, 1, "double");
tnpt = 1;
tnpr = 0;
case 8 ## Multipoint
## Read bounding box
tbbox = fread (fidp, 4, "double");
tnpt = fread (fidp, 1, "int32");
val = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
val(1:tnpt, 3:4) = NaN;
## Copy rec index & type down
val(2:tnpt, 5:6) = val(1, 5:6);
tnpr = 0;
case 18 ## MultipointZ
tbbox = fread (fidp, 4, "double");
tnpt = fread (fidp, 1, "int32");
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## Z min & max values
tbbox(5:6) = fread (fidp, 2, "double");
## Augment val array with Z values
val(1:tnpt, 3) = [ rec(ir).points fread(fidp, tnpt, "double")' ];
## M min & max values
tbbox(7:8) = fread (fidp, 2, "double");
## Augment val array with M values
val(1:tnpt, 4) = [ rec(ir).points fread(fidp, tnpt, "double")' ];
## Copy rec index & type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
tnpr = 0;
case 28 ## MultipointM
tbbox(1:4) = fread (fidp, 4, "double");
tnpt = fread (fidp, 1, "int32");
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## Insert empty column for Z
val(1:tnpt, 4) = NaN;
## M min & max values
bbox(7:8) = fread (fidp, 2, "double");
## Augment val array with Z values
val(1:tnpt, 4) = [ rec(ir).points fread(fidp, tnpt, "double")' ];
## Copy rec index & type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
tnpr = 0;
case {3, 5} ## Polyline/-gon
tbbox(1:4) = fread (fidp, 4, "double");
## Read nparts, npoints, nparts pointers
nparts = fread (fidp, 1, "int32");
tnpt = fread (fidp, 1, "int32");
tnpr = fread (fidp, nparts, "int32")';
## Read XY point coordinates
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## No Z or M data
val(1:tnpt, 3:4) = NaN;
## Copy rec index and type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
case {13, 15} ## Polyline/-gonZ
tbbox(1:4) = fread (fidp, 4, "double");
## Read nparts, npoints, nparts pointers
nparts = fread (fidp, 1, "int32");
tnpt = fread (fidp, 1, "int32");
tnpr = fread (fidp, nparts, "int32")';
## Read XY point coordinates
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## Z min & max values + data
tbbox(5:6) = fread (fidp, 2, "double");
val(1:tnpt, 3) = fread(fidp, tnpt, "double")';
## M min & max values + data
tbbox(7:8) = fread (fidp, 2, "double");
val(1:tnpt, 4) = fread(fidp, tnpt, "double")';
## Copy rec index and type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
case {23, 25} ## Polyline/-gonM
tbbox(1:4) = fread (fidp, 4, "double");
## Read nparts, npoints, nparts pointers
nparts = fread (fidp, 1, "int32");
tnpt = fread (fidp, 1, "int32");
tnpr = fread (fidp, nparts, "int32")';
## Read XY point coordinates
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## No Z data
val(1:tnpt, 3) = NaN;
## M min & max values + data
tbbox(7:8) = fread (fidp, 2, "double");
val(1:tnpt, 4) = fread(fidp, tnpt, "double")';
## Copy rec index and type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
case 31 ## Multipatch
tbbox(1:4) = fread (fidp, 4, "double");
## Read nparts, npoints, nparts pointers, npart types
nparts = fread (fidp, 1, "int32");
tnpt = fread (fidp, 1, "int32");
## Npart types is just another row under npart pointers => read both.
## Provisionally transpose, this is later on reset after NaN insertion
tnpr = reshape (fread (fidp, nparts*2, "int32")', [], 2)';
## Read XY point coordinates
% val = NaN (tnpt + size (tnpr, 2) - 1, 6);
% ipt = 1;
% ttnpr = [tnpr(1, :) tnpt];
% for ii=2:numel (ttnpr)
% val(ipt:ipt+ttnpr(ii)-1, 1:2) = ...
% reshape (fread (fidp, ttnpr(ii)*2, "double"), 2, [])';
% ipt +=ttnpr(ii) + 1;
% endfor
val(1:tnpt, 1:2) = reshape (fread (fidp, tnpt*2, "double"), 2, [])';
## Z min & max values + data. Watch out for incomplete .shp file
EOF = (ftell (fidp) > flngt-2);
if (! EOF)
tbbox(5:6) = fread (fidp, 2, "double");
val(1:tnpt, 3) = fread(fidp, tnpt, "double")';
endif
fptr = ftell (fidp);
EOF = (fptr > flngt-2);
if (! EOF && has_M)
## Check if the file really contains M values: try to read ("peek")
## three int32 record numbers matching the next record nr. to be
## read, the next record length and 31 (= MultiPatch type)
tmp = fread (fidp, 2, "int32", 0, "ieee-be");
tmp(3) = fread (fidp, 1, "int32");
fseek (fidp, fptr, "bof");
if (tmp(1) == (val(1, 5) + 1) && tmp(3) == 31)
## Undoubtedly a record index number.
has_M = false;
## Empirically the min/maxM values in file header mean nothing, so
shpbox.M(1) = 0;
shpbox.M(2) = 0;
endif
endif
## M min & max values + data. Watch out for incomplete .shp file
if (! EOF && has_M)
tbbox(7:8) = fread (fidp, 2, "double");
val(1:tnpt, 4) = fread(fidp, tnpt, "double")';
endif
## Copy rec index and type down
val(2:tnpt, 5:6) = repmat (val(1, 5:6), tnpt-1, 1);
otherwise ## E.g., null shape (0)
## Keep track of null shapes to avoid reading associated attributes
if (val(1, 6) == 0)
nullsh = [ nullsh ir ];
rincl = 0;
elseif (abs(val(1, 6)) > 31)
error ("shaperead.m: unexpected shapetype value %f for feature # %d\n\
Looks like a faulty shape file.", val(1, 6), ir);
endif
endswitch
## Detect if shape lies (partly) within or completely out of BoundingBox.
## Null shapes are automatically skipped
if (! isempty (s_bbox))
## Just check if any shape feature bounding box corner lies in s_bbox
tbox = [tbbox(1) tbbox(2); tbbox(1) tbbox(4); ...
tbbox(3) tbbox(4); tbbox(3) tbbox(2); tbbox(1) tbbox(2)];
rincl = 0;
## For polygons, polylines & multipatches:
if (ismember (val(1, 6), [3, 13, 23, 5, 15, 25, 31])) ## Polygon/line
## To avoid undue CPU time for large shapes we take a shortcut:
## Check if shape feature lies in BoundingBox...
[a, b] = inpolygon (tbox(:, 1), tbox(:, 2), sbox(:, 1), sbox(:, 2));
## ...or BoundingBox lies in polyline/gon. Faster than indiv. points
[c, d] = inpolygon (sbox(:, 1), sbox(:, 2), tbox(:, 1), tbox(:, 2));
if (any ([a; b; c; d]))
## At least one of the shape item bbox corners lies within s_bbox
rincl = 1;
bb_union = unique ([bb_union val(1, 5)]);
## FIXME still the case of polygon edges intersecting bounding box
## w/o vertices inside bounding box. Clipping required for that
endif
elseif (ismember (val(1, 6), [1, 11, 21])) ## (Multi-)Point
## Simply select all points within or on boundaries
[a, b] = inpolygon (val(:, 1), val(:, 2), sbox(:, 1), sbox(:, 2));
val = val(find(a), :);
tnpt = size (val, 1);
if (tnpt)
rincl = 1;
endif
endif
## If clipping has been selected, clip all parts of the shape feature
if (rincl && clip)
## What to do depends on shape type. Null and MultiPatch aren't clipped
switch val(1, 6)
case {3, 13, 33} ## Polyline
## Temporarily silence Octave a bit, then call clipplg
warning ("off", "Octave:broadcast", "local");
[val, tnpt, tnpr] = clippln (val, tnpt, tnpr, sbox, val(1, 6));
case {5, 15, 25, 31} ## Polygon, Multipatch
## Temporarily silence Octave a bit, then call clipplg
warning ("off", "Octave:broadcast", "local");
[val, tnpt, tnpr] = clipplg (val, tnpt, tnpr, sbox, val(1, 6));
otherwise
warning ("shaperead: unknown shape type found (%d) - ignored\n", ...
val(1, 6));
rincl = 0;
val = [];
endswitch
if (isempty (val))
## Don't include it and remove last added bb_union entry
bb_union(end) = [];
rincl = 0;
else
## Update bounding box
tbbox(1) = min (val(:, 1));
tbbox(2) = min (val(:, 2));
tbbox(3) = max (val(:, 1));
tbbox(4) = max (val(:, 2));
endif
endif
endif
## What to do with the val data, if to be included
if (rincl)
## Keep track of nr of shape features read
++nshp;
if (outopts < 3)
## Prepare an Octave or Matlab style struct optimized for fast
## plotting by inserting a NaN row after each polyline/-gon part
nn = size (tnpr, 2);
valt = NaN(tnpt + nn - 1, 6);
ipt = 1;
ttnpr = [tnpr(1, :) tnpt];
dtnpr = diff (ttnpr);
for ii=2:numel (ttnpr)
valt(ipt:ipt+dtnpr(ii-1)-1, :) = val(ttnpr(ii-1)+1:ttnpr(ii), :);
ipt += dtnpr(ii-1) + 1;
endfor
val = valt;
tnpr(1, :) = (tnpr(1, :) + [0:numel(dtnpr)-1]);
endif
## Shape either included by default or it lies in requested BoundingBox
switch outopts
case {0, 1, "ml", "e"}
## Return a ML compatible mapstruct. Attributes will be added later
if (ign_mz && val(1, 6) >= 10)
printf ("shaperead: M and Z values ignored for ml-style output\n");
ign_mz = 0;
endif
switch val(1, 6)
case {1, 11, 21} ## Point
outs(end+1).Geometry = "Point";
case {8, 18, 28} ## Multipoint
outs(end+1).Geometry = "MultiPoint";
case {3, 13, 23} ## Polyline
outs(end+1).Geometry = "Line";
case {5, 15, 25} ## Polygon
outs(end+1).Geometry = "Polygon";
otherwise
if (outopts == 1)
## "Extended" ML-style output struct
if (val(1, 6) == 31) ## MultiPatch
outs(end+1).Geometry = "MultiPatch";
outs(end).Parts = tnpr;
endif
else
if (! unsupp)
warning ("shaperead: shapefile contains unsupported shape types\n");
outs = [];
return
endif
outs(end+1).Geometry = val(1, 6);
endif
endswitch
outs(end).BoundingBox = reshape (tbbox(1:4), 2, [])';
if (s_geo)
outs(end).Lon = val(:, 1)';
outs(end).Lat = val(:, 2)';
else
outs(end).X = val(:, 1)';
outs(end).Y = val(:, 2)';
endif
## (ML-incompatible) add Z- and optional M-values, if any
if (outopts == 1 && any (isfinite (val(:, 4))))
outs(end).M = val(:, 4)';
## FIXME Decision needed if field Geometry should reflect the type
## outs{end}.Geometry = [ outs{end}.Geometry "M"];
endif
if (outopts == 1 && any (isfinite (val(:, 3))))
outs(end).Z = val(:, 3)';
## FIXME Decision needed if field Geometry should reflect the type
## outs{end}.Geometry = [ outs{end}.Geometry "Z"];
endif
## (ML-incompatible) add Z- and optional M-values, if any
if (dbug)
## Add a field with shape feature identifier for boundingbox
outs(end).___Shape_feature_nr___ = val(1, 5);
endif
case {2, "oct"}
## Append to vals array; keep track of appended nr. of rows
lvals = size (vals, 1);
lval = size (val, 1);
if ((size (vals, 1) - ivals) < lval)
## Increase size of vals
vals = [ vals; NaN(BUFSIZE, 6) ];
endif
vals(ivals:ivals+lval-1, :) = val;
idx = [idx ; ivals];
ivals += lval;
## Add a row of NaNs
vals(ivals, :) = NaN(1,6);
++ivals;
## Append the other arrays
npt = [npt; tnpt];
if (isempty (npr))
npr = {tnpr};
else
npr = [npr; {tnpr}];
endif
bbox = [bbox; tbbox];
case {3, "dat"}
## Return an Octave style struct.
## Simply append to vals array; keep track of appended nr. of rows
lvals = size (vals, 1);
lval = size (val, 1);
if ((size (vals, 1) - ivals) < lval)
## Increase size of vals
vals = [ vals; NaN(BUFSIZE, 6) ];
endif
vals(ivals:ivals+lval-1, :) = val;
idx = [idx ; ivals];
ivals += lval;
## Append the other arrays
npt = [npt; tnpt];
if (isempty (npr))
npr = {tnpr};
else
npr = [npr; {tnpr}];
endif
bbox = [bbox; tbbox];
otherwise
endswitch
endif
else
## Record not in s_recs list, skip rest of record
fread (fidp, (rlen*2), "char=>char");
endif
## Next .shp record
++ir;
until (ftell (fidp) > flngt - 3 ||
(have_shx && ir > numel (s_recs))); ## i.e., within last
## file bytes or
fclose (fidp);
## If no shape was read, or none fitted within BoundingBox, return empty
if (nshp < 1)
outs = {};
return;
endif
## ------------------------ Post-processing ------------------------
if (outopts > 1)
## Octave-style outstruct. Truncate vals to proper length
vals = vals(1:ivals-1, :);
if (outopts == 2 && ! isempty (vals))
## Remove last NaN row
vals(end, :) = [];
endif
if (isempty (vals))
s_recs = 0;
endif
endif
if (dbug)
if (outopts <= 1)
ii = numel (outs);
else
ii = numel (npt);
endif
printf ("\n%d records read. \n", ii);
endif
## For Octave style output, add separate arrays to output struct
if (outopts >= 2)
outs.shpbox = shpbox;
outs.vals = vals;
outs.bbox = bbox;
outs.npt = npt;
outs.npr = npr;
outs.idx = idx;
## Clear memory (for very large shape files)
clear shpbox vals bbox npt npr idx val;
outs = setfield (outs, "fields", {"shpbox", "vals", "bbox", "npt", "npr"});
endif
## Clean up s_recs and bb_union
if (! isempty (s_bbox))
s_recs = sort (unique (bb_union));
else
s_recs = sort (unique (s_recs));
endif
## Weed out any null shape records to prevent reading their attributes
if (! isempty (nullsh))
if (! isempty (s_recs))
s_recs = [1:numel (npt)];
endif
s_recs (ismember (nullsh, s_recs)) = [];
endif
## ---------------------- 3. .dbf ----------------------
## Check if dbfread is available
if (isempty (which ("dbfread")))
printf ("shaperead.m: dbfread function not found. No attributes will be added.\n");
printf (" (io package installed and loaded?)\n");
else
## Try to read the .dbf file
try
atts = dbfread ([ bname ".dbf" ], s_recs, s_atts);
if (outopts < 2)
## First check if any attributes match fieldnames; if so, pre-/append "_"
tags = {"shpbox", "vals", "bbox", "npt", "npr", "idx", "Geometry", ...
"BoundingBox", "X", "Y", "Lat", "Lon"};
for ii=1:numel (tags)
idx = find (strcmp (tags{ii}, atts(1, :)));
if (! isempty (idx))
atts(1, idx) = ["_" atts{1, idx} "_"];
endif
endfor
## Matlab style map-/geostruct. Divide attribute values over struct elems
if (nargout < 2)
## Attributes appended to outs struct
for ii=1:size (atts, 2)
[outs.(atts{1, ii})] = deal (atts(2:end, ii){:});
endfor
oatt = [];
else
## Attributes separately in oatt struct
oatt(size (atts, 1) - 1).(atts{1, 1}) = [];
for ii=1:size (atts, 2)
[oatt.(atts{1, ii})] = deal (atts(2:end, ii){:});
endfor
endif
else
## Octave output struct. Add attributes columns as struct fields
for ii=1:size (atts, 2)
outs.fields(end+1) = atts{1, ii};
if (islogical (atts{2, ii}) || isnumeric (atts{2, ii}))
outs = setfield (outs, atts{1, ii}, cell2mat (atts(2:end, ii)));
else
outs = setfield (outs, atts{1, ii}, atts(2:end, ii));
endif
endfor
atts = [];
endif
catch
printf ("shaperead: file %s couldn't be read;\n", [ bname ".dbf" ]);
printf (" no attributes appended\n");
end_try_catch
endif
endfunction
|