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 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361
|
/* ***************************************************************************
*
* Project: GDAL/OGR Java bindings
* Purpose: Documentation for the Java bindings
* Author: Even Rouault <even dot rouault at spatialys.com>
*
*******************************************************************************
* Copyright (c) 2009, Even Rouault <even dot rouault at spatialys.com>
* Copyright (c) 1999-2009, Frank Warmerdam
*
* SPDX-License-Identifier: MIT
*************************************************************************** */
/* Class gdal */
/**
* Class gdal is an uninstanciable class providing various utility functions as static methods.
* <p>
* In particular, it provides :
* <ul>
* <li>gdal.<a href="#AllRegister()">AllRegister()</a> and gdal.<a href="#Open(java.lang.String, int)">Open()</a> methods.
* <li>bindings for various GDAL algorithms.
* <li>bindings for some general purpose CPL functions.
* </ul>
*/
public class gdal
/**
* General utility option processing.
*
* This function is intended to provide a variety of generic commandline
* options for all GDAL commandline utilities. It takes care of the following
* commandline options:
* <p><ul>
* <li>--version: report version of GDAL in use.
* <li>--license: report GDAL license info.
* <li>--formats: report all format drivers configured.
* <li>--format [format]: report details of one format driver.
* <li>--optfile filename: expand an option file into the argument list.
* <li>--config key value: set system configuration option.
* <li>--debug [on/off/value]: set debug level.
* <li>--mempreload dir: preload directory contents into /vsimem
* <li>--help-general: report detailed help on general options.
* </ul><p>
* The typical usage looks something like the following. Note that the formats
* should be registered so that the --formats and --format options will work properly.
* <pre>
* public static void main( Strings[] args )
* {
* gdal.AllRegister();
*
* args = gdal.GeneralCmdLineProcessor( args, 0 );
* }
* </pre>
* @param args the argument list array
* @param options currently unused
*
* @return updated argument list array.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String[] GeneralCmdLineProcessor(String[] args, int options)
/**
* General utility option processing.
*
* Same as below with options == 0
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String[] GeneralCmdLineProcessor(String[] args)
/**
* General utility option processing.
*
* Same as below but with arguments as a Vector of strings
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*/
public class gdal:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args, int options)
/**
* General utility option processing.
*
* Same as below but with arguments as a Vector of strings and options == 0
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args)
/**
* Display a debugging message.
*
* The category argument is used in conjunction with the CPL_DEBUG
* environment variable to establish if the message should be displayed.
* If the CPL_DEBUG environment variable is not set, no debug messages
* are emitted (use Error(gdalconst.CE_Warning,...) to ensure messages are displayed).
* If CPL_DEBUG is set, but is an empty string or the word "ON" then all
* debug messages are shown. Otherwise only messages whose category appears
* somewhere within the CPL_DEBUG value are displayed (as determined by
* strstr()).
* <p>
* Categories are usually an identifier for the subsystem producing the
* error. For instance "GDAL" might be used for the GDAL core, and "TIFF"
* for messages from the TIFF translator.
*
* @param msg_class name of the debugging message category.
* @param message message to display.
*/
public class gdal:public static void Debug(String msg_class, String message)
/**
* Push a new error handler.
*
* This pushes a new error handler on the thread-local error handler
* stack. This handler will be used until removed with gdal.PopErrorHandler().
*
* @param callbackName handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"
*/
public class gdal:public static int PushErrorHandler(String callbackName)
/**
* Push the quiet error handler.
*
* This pushes a new error handler on the thread-local error handler
* stack. This handler will be used until removed with gdal.PopErrorHandler().
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int PushErrorHandler()
/**
* Set a global error handler.
*
* This installs a global error handler.
*
* Note; if a local handler is already installed with PushErrorHandler(), the global error
* handler will not be used until the last local handler is uninstalled with PopErrorHandler().
*
* @since Java bindings 1.10.0
*
* @param callbackName handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"
*/
public class gdal:public static int SetErrorHandler(String callbackName)
/**
* Set a quiet global error handler.
*
* This installs a quiet global error handler.
*
* Note; if a local handler is already installed with PushErrorHandler(), the global error
* handler will not be used until the last local handler is uninstalled with PopErrorHandler().
*
* @since Java bindings 1.10.0
*/
public class gdal:public static int SetErrorHandler()
/**
* Report an error.
*
* This function reports an error in a manner that can be hooked
* and reported appropriate by different applications.
* <p>
* The msg_class argument can have the value gdalconst.CE_Warning indicating that the
* message is an informational warning, gdalconst.CE_Failure indicating that the
* action failed, but that normal recover mechanisms will be used or
* CE_Fatal meaning that a fatal error has occurred, and that Error()
* should not return.
* <p>
* The default behavior of Error() is to report errors to stderr,
* and to abort() after reporting a gdalconst.CE_Fatal error. It is expected that
* some applications will want to suppress error reporting, and will want to
* install a C++ exception, or longjmp() approach to no local fatal error
* recovery.
* <p>
* Regardless of how application error handlers or the default error
* handler choose to handle an error, the error number, and message will
* be stored for recovery with gdal.GetLastErrorNo() and gdal.GetLastErrorMsg().
*
* @param msg_class one of gdalconst.CE_Warning, gdalconst.CE_Failure or gdalconst.CE_Fatal.
* @param err_code the error number (CPLE_*) from cpl_error.h.
* @param msg message to display..
*/
public class gdal:public static void Error(int msg_class, int err_code, String msg)
/**
* Pop error handler off stack.
* <p>
* Discards the current error handler on the error handler stack, and restores
* the one in use before the last gdal.PushErrorHandler() call. This method
* has no effect if there are no error handlers on the current threads error
* handler stack.
*/
public class gdal:public static void PopErrorHandler()
/**
* Erase any traces of previous errors.
* <p>
* This is normally used to ensure that an error which has been recovered
* from does not appear to be still in play with high level functions.
*/
public class gdal:public static void ErrorReset()
/**
* Apply escaping to string to preserve special characters.
*
* @see #EscapeString(String str, int scheme)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String EscapeString(byte[] byteArray, int scheme)
/**
* Create memory "file" from a buffer.
*
* A virtual memory file is created from the passed buffer with the indicated filename. Under normal conditions the filename would need to be absolute and within the /vsimem/ portion of the filesystem.
* <p>
* The filename then can be used with GDAL and OGR drivers that uses the virtual file API.
* <p>
* To free the memory associated with the file, you must use Unlink(fileName), otherwise memory leaks will occur.
*
* @param fileName filename (should begin with "/vsimem/")
* @param byteArray data buffer to put in the file
*
* @since Java bindings 1.7.0
*
* @see #Unlink(String fileName)
*/
public class gdal:public static void FileFromMemBuffer(String fileName, byte[] byteArray)
/**
* Fetch buffer underlying memory file.
*
* This function returns a byte[] array with a copy of the content of the memory
* buffer underlying a virtual "in memory" file. The original file is unmodified
* by this operation, and must be removed with Unlink(fileName) if necessary.
*
* @param fileName filename (should begin with "/vsimem/")
*
* @return file content
*
* @since 3.10.1
*
* @see #Unlink(String fileName)
*/
public class gdal:public static byte[] GetMemFileBuffer(String fileName)
/**
* Delete a file.
* <p>
* Deletes a file object from the file system. This method goes through the
* VSIFileHandler virtualization and may work on unusual filesystems such as in memory.
* <p>
* Analog of the POSIX unlink() function.
*
* @param fileName the path of the file to be deleted.
* @return 0 on success or -1 on an error.
*
* @since Java bindings 1.7.0
*
* @see #FileFromMemBuffer(String fileName, byte[] byteArray)
*/
public class gdal:public static int Unlink(String fileName)
/**
* Apply escaping to string to preserve special characters.
*
* This function will "escape" a variety of special characters
* to make the string suitable to embed within a string constant
* or to write within a text stream but in a form that can be
* reconstituted to it's original form. The escaping will even preserve
* zero bytes allowing preservation of raw binary data.
* <ul>
* <li>gdalconst.CPLES_BackslashQuotable(0): This scheme turns a binary string into
* a form suitable to be placed within double quotes as a string constant.
* The backslash, quote, '\\0' and newline characters are all escaped in
* the usual C style.
*
* <li>gdalconst.CPLES_XML(1): This scheme converts the '<', '>' and '&' characters into
* their XML/HTML equivalent (&gt;, &lt; and &amp;) making a string safe
* to embed as CDATA within an XML element. The '\\0' is not escaped and
* should not be included in the input.
*
* <li>gdalconst.CPLES_URL(2): Everything except alphanumerics and the underscore are
* converted to a percent followed by a two digit hex encoding of the character
* (leading zero supplied if needed). This is the mechanism used for encoding
* values to be passed in URLs.
*
* <li>gdalconst.CPLES_SQL(3): All single quotes are replaced with two single quotes.
* Suitable for use when constructing literal values for SQL commands where
* the literal will be enclosed in single quotes.
*
* <li>gdalconst.CPLES_CSV(4): If the values contains commas, double quotes, or newlines it
* placed in double quotes, and double quotes in the value are doubled.
* Suitable for use when constructing field values for .csv files. Note that
* gdal.UnescapeString() currently does not support this format, only
* gdal.EscapeString(). See cpl_csv.cpp for csv parsing support.
* </ul>
* @param str the string to escape.
* @param scheme the encoding scheme to use.
*
* @return an escaped string
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String EscapeString(String str, int scheme)
/**
* Fetch the last error number.
* <p>
* This is the error number, not the error class.
*
* @return the error number of the last error to occur, or gdalconst.CPLE_None (0)
* if there are no posted errors.
*/
public class gdal:public static int GetLastErrorNo()
/**
* Fetch the last error type.
* <p>
* This is the error class, not the error number.
*
* @return the error number of the last error to occur, or gdalconst.CE_None (0)
* if there are no posted errors.
*/
public class gdal:public static int GetLastErrorType()
/**
* Get the last error message.
* <p>
* Fetches the last error message posted with CPLError(), that hasn't
* been cleared by gdal.ErrorReset().
*
* @return the last error message, or null if there is no posted error
* message.
*/
public class gdal:public static String GetLastErrorMsg()
/**
* Set a configuration option for GDAL/OGR use.
* <p>
* Those options are defined as a (key, value) couple. The value corresponding
* to a key can be got later with the gdal.GetConfigOption() method.
* <p>
* This mechanism is similar to environment variables, but options set with
* gdal.SetConfigOption() overrides, for gdal.GetConfigOption() point of view,
* values defined in the environment.
* <p>
* If gdal.SetConfigOption() is called several times with the same key, the
* value provided during the last call will be used.
* <p>
* Options can also be passed on the command line of most GDAL utilities
* with the with '--config KEY VALUE'. For example,
* ogrinfo --config CPL_DEBUG ON ~/data/test/point.shp
*
* @param key the key of the option
* @param value the value of the option
*
* @see #GetConfigOption
*/
public class gdal:public static void SetConfigOption(String key, String value)
/**
* Get the value of a configuration option.
* <p>
* The value is the value of a (key, value) option set with gdal.SetConfigOption().
* If the given option was no defined with gdal.SetConfigOption(), it tries to find
* it in environment variables.
*
* @param key the key of the option to retrieve
* @param defaultValue a default value if the key does not match existing defined options (may be null)
* @return the value associated to the key, or the default value if not found
*
* @see #SetConfigOption
*/
public class gdal:public static String GetConfigOption(String key, String defaultValue)
/**
* Get the value of a configuration option.
* <p>
* Same as below with defaultValue == null
*
* @see #GetConfigOption(String key, String defaultValue)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String GetConfigOption(String key)
/**
* Generate Geotransform from GCPs.
* <p>
* Given a set of GCPs perform first order fit as a geotransform.
* <p>
* Due to imprecision in the calculations the fit algorithm will often
* return non-zero rotational coefficients even if given perfectly non-rotated
* inputs. A special case has been implemented for corner corner coordinates
* given in TL, TR, BR, BL order. So when using this to get a geotransform
* from 4 corner coordinates, pass them in this order.
*
* @param gcpArray the array of GCP.
* @param outGeoTransform the six double array in which the affine
* geotransformation will be returned.
* @param bApproxOK If 0 the function will fail if the geotransform is not
* essentially an exact fit (within 0.25 pixel) for all GCPs.
*
* @return 1 on success or 0 if there aren't enough points to prepare a
* geotransform, the pointers are ill-determined or if bApproxOK is 0
* and the fit is poor.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform, int bApproxOK)
/**
* Generate Geotransform from GCPs.
* <p>
* Same as below with bApproxOK == 0
*
* @see #GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform, int bApproxOK)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform)
/**
* Compute optimal PCT for RGB image.
* <p>
* This function implements a median cut algorithm to compute an "optimal"
* pseudocolor table for representing an input RGB image. This PCT could
* then be used with GDALDitherRGB2PCT() to convert a 24bit RGB image into
* an eightbit pseudo-colored image.
* <p>
* This code was based on the tiffmedian.c code from libtiff (www.libtiff.org)
* which was based on a paper by Paul Heckbert:
* <p>
* <pre>
* "Color Image Quantization for Frame Buffer Display", Paul
* Heckbert, SIGGRAPH proceedings, 1982, pp. 297-307.
* </pre>
* <p>
* The red, green and blue input bands do not necessarily need to come
* from the same file, but they must be the same width and height. They will
* be clipped to 8bit during reading, so non-eight bit bands are generally
* inappropriate.
*
* @param red Red input band.
* @param green Green input band.
* @param blue Blue input band.
* @param num_colors the desired number of colors to be returned (2-256).
* @param colors the color table will be returned in this color table object.
* @param callback for reporting algorithm progress. May be null
*
* @return returns gdalconst.CE_None on success or gdalconst.CE_Failure if an error occurs.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors, ProgressCallback callback)
/**
* Compute optimal PCT for RGB image.
* <p>
* Same as below with callback == null
*
* @see #ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors)
/**
* 24bit to 8bit conversion with dithering.
* <p>
* This functions utilizes Floyd-Steinberg dithering in the process of
* converting a 24bit RGB image into a pseudocolored 8bit image using a
* provided color table.
* <p>
* The red, green and blue input bands do not necessarily need to come
* from the same file, but they must be the same width and height. They will
* be clipped to 8bit during reading, so non-eight bit bands are generally
* inappropriate. Likewise the hTarget band will be written with 8bit values
* and must match the width and height of the source bands.
* <p>
* The color table cannot have more than 256 entries.
*
* @param red Red input band.
* @param green Green input band.
* @param blue Blue input band.
* @param target Output band.
* @param colors the color table to use with the output band.
* @param callback for reporting algorithm progress. May be null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if an error occurs.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors, ProgressCallback callback)
/**
* 24bit to 8bit conversion with dithering.
* <p>
* Same as below with callback == null
* @see #DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors)
/**
* Reproject image.
* <p>
* This is a convenience function utilizing the GDALWarpOperation class to
* reproject an image from a source to a destination. In particular, this
* function takes care of establishing the transformation function to
* implement the reprojection, and will default a variety of other
* warp options.
* <p>
* By default all bands are transferred, with no masking or nodata values
* in effect. No metadata, projection info, or color tables are transferred
* to the output file.
*
* @param src_ds the source image file.
* @param dst_ds the destination image file.
* @param src_wkt the source projection. If null the source projection
* is read from from src_ds.
* @param dst_wkt the destination projection. If null the destination
* projection will be read from dst_ds.
* @param resampleAlg the type of resampling to use. (among gdalconst.GRA_*)
* @param warpMemoryLimit the amount of memory (in bytes) that the warp
* API is allowed to use for caching. This is in addition to the memory
* already allocated to the GDAL caching (as per gdal.SetCacheMax()). May be
* 0.0 to use default memory settings.
* @param maxError maximum error measured in input pixels that is allowed
* in approximating the transformation (0.0 for exact calculations).
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
/**
* Reproject image.
* <p>
* Same as below with callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError)
/**
* Reproject image.
* <p>
* Same as below with maxError == 0.0 and callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit)
/**
* Reproject image.
* <p>
* Same as below with warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg)
/**
* Reproject image.
* <p>
* Same as below with resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt)
/**
* Reproject image.
* <p>
* Same as below with dst_wkt == null, resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt)
/**
* Reproject image.
* <p>
* Same as below with src_wkt == null, dst_wkt == null, resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.
*
* @see #ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ReprojectImage(Dataset src_ds, Dataset dst_ds)
/**
* Compute the proximity of all pixels in the image to a set of pixels in the source image.
* <p>
* The following options are used to define the behavior of the function. By
* default all non-zero pixels in srcBand will be considered the
* "target", and all proximities will be computed in pixels. Note
* that target pixels are set to the value corresponding to a distance
* of zero.
* <p>
* Options:
* <dl>
* <dt>VALUES=n[,n]*</dt> <dd>
* A list of target pixel values to measure the distance from. If this
* option is not provided proximity will be computed from non-zero
* pixel values. Currently pixel values are internally processed as
* integers.</dd>
* <dt>DISTUNITS=[PIXEL]/GEO</dt> <dd>
* Indicates whether distances will be computed in pixel units or
* in georeferenced units. The default is pixel units. This also
* determines the interpretation of MAXDIST.</dd>
* <dt>MAXDIST=n</dt> <dd>
* The maximum distance to search. Proximity distances greater than
* this value will not be computed. Instead output pixels will be
* set to a nodata value.</dd>
* <dt>NODATA=n</dt> <dd>
* The NODATA value to use on the output band for pixels that are
* beyond MAXDIST. If not provided, the hProximityBand will be
* queried for a nodata value. If one is not found, 65535 will be used.</dd>
* <dt>FIXED_BUF_VAL=n</dt> <dd>
* If this option is set, all pixels within the MAXDIST threadhold are
* set to this fixed value instead of to a proximity distance.</dd>
* </dl>
* @param srcBand the source band
* @param proximityBand the destination band
* @param options a vector of strings with the above options
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options, ProgressCallback callback)
/**
* Compute the proximity of all pixels in the image to a set of pixels in the source image.
* <p>
* Same as below with callback = null
*
* @see #ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options, ProgressCallback callback)
*
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options)
/**
* Compute the proximity of all pixels in the image to a set of pixels in the source image.
* <p>
* Same as below with options == null and callback == null
*
* @see #ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options, ProgressCallback callback)
*
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int ComputeProximity(Band srcBand, Band proximityBand)
/**
* Burn geometries from the specified layer into raster.
* <p>
* Rasterize all the geometric objects from a layer into a raster
* dataset.
* <p>
* The transform
* needs to transform the geometry locations into pixel/line coordinates
* on the raster dataset.
* <p>
* The output raster may be of any GDAL supported datatype, though currently
* internally the burning is done either as gdal.GDT_Byte or gdal.GDT_Float32. This
* may be improved in the future. An explicit list of burn values for
* each layer for each band must be passed in.
*
* @param dataset output data, must be opened in update mode.
* @param bandNumbers the list of bands to be updated.
* @param layer the layer to burn in.
* @param burn_values the array of values to burn into the raster.
* There should be as many values as in bandNumbers. If null, 255 will be used
* @param options a vector of strings for special options controlling rasterization:
* <dl>
* <dt>"ATTRIBUTE":</dt> <dd>Identifies an attribute field on the features to be
* used for a burn in value. The value will be burned into all output
* bands. If specified, burn_values will not be used and can be a null value.</dd>
* <dt>"CHUNKYSIZE":</dt> <dd>The height in lines of the chunk to operate on.
* The larger the chunk size the less times we need to make a pass through all
* the shapes. If it is not set or set to zero the default chunk size will be
* used. Default size will be estimated based on the GDAL cache buffer size
* using formula: cache_size_bytes/scanline_size_bytes, so the chunk will
* not exceed the cache.</dd>
* </dl>
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on error.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)
/**
* Burn geometries from the specified layer into raster.
* <p>
* Same as below with callback == null
*
* @see #RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options)
/**
* Burn geometries from the specified layer into raster.
* <p>
* Same as below with options == null and callback == null
*
* @see #RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values)
/**
* Burn geometries from the specified layer into raster.
* <p>
* Same as below with burn_values == null, options == null and callback == null
*
* @see #RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer)
/**
* Create polygon coverage from raster data.
* <p>
* This function creates vector polygons for all connected regions of pixels in
* the raster sharing a common pixel value. Optionally each polygon may be
* labelled with the pixel value in an attribute. Optionally a mask band
* can be provided to determine which pixels are eligible for processing.
* <p>
* Note that currently the source pixel band values are read into a
* signed 32bit integer buffer (Int32), so floating point or complex
* bands will be implicitly truncated before processing.
* <p>
* Polygon features will be created on the output layer, with polygon
* geometries representing the polygons. The polygon geometries will be
* in the georeferenced coordinate system of the image (based on the
* geotransform of the source dataset). It is acceptable for the output
* layer to already have features. Note that gdal.Polygonize() does not
* set the coordinate system on the output layer. Application code should
* do this when the layer is created, presumably matching the raster
* coordinate system.
* <p>
* The algorithm used attempts to minimize memory use so that very large
* rasters can be processed. However, if the raster has many polygons
* or very large/complex polygons, the memory use for holding polygon
* enumerations and active polygon geometries may grow to be quite large.
* <p>
* The algorithm will generally produce very dense polygon geometries, with
* edges that follow exactly on pixel boundaries for all non-interior pixels.
* For non-thematic raster data (such as satellite images) the result will
* essentially be one small polygon per pixel, and memory and output layer
* sizes will be substantial. The algorithm is primarily intended for
* relatively simple thematic imagery, masks, and classification results.
*
* @param srcBand the source raster band to be processed.
* @param maskBand an optional mask band (or null). All pixels in the mask band with a
* value other than zero will be considered suitable for collection as
* polygons.
* @param outLayer the vector feature layer to which the polygons should
* be written.
* @param iPixValField the attribute field index indicating the feature
* attribute into which the pixel value of the polygon should be written.
* @param options a name/value list of additional options (none currently
* supported. just pass null).
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options, ProgressCallback callback)
/**
* Create polygon coverage from raster data.
* <p>
* Same as below with callback == null
*
* @see #Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options)
/**
* Create polygon coverage from raster data.
* <p>
* Same as below with options == null and callback == null
*
* @see #Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField)
/**
* Fill selected raster regions by interpolation from the edges.
* <p>
* This algorithm will interpolate values for all designated
* nodata pixels (marked by zeros in maskBand). For each pixel
* a four direction conic search is done to find values to interpolate
* from (using inverse distance weighting). Once all values are
* interpolated, zero or more smoothing iterations (3x3 average
* filters on interpolated pixels) are applied to smooth out
* artifacts.
* <p>
* This algorithm is generally suitable for interpolating missing
* regions of fairly continuously varying rasters (such as elevation
* models for instance). It is also suitable for filling small holes
* and cracks in more irregularly varying images (like airphotos). It
* is generally not so great for interpolating a raster from sparse
* point data - see the algorithms defined in gdal_grid.h for that case.
*
* @param targetBand the raster band to be modified in place.
* @param maskBand a mask band indicating pixels to be interpolated (zero valued
* @param maxSearchDist the maximum number of pixels to search in all
* directions to find values to interpolate from.
* @param smoothingIterations the number of 3x3 smoothing filter passes to
* run (0 or more).
* @param options additional name=value options in a string list (none
* supported at this time - just pass null).
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options, ProgressCallback callback)
/**
* Fill selected raster regions by interpolation from the edges.
* <p>
* Same as below with callback == null
*
* @see #FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options)
/**
* Fill selected raster regions by interpolation from the edges.
* <p>
* Same as below with options == null and callback == null
*
* @see #FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations)
/**
* Removes small raster polygons.
* <p>
* The function removes raster polygons smaller than a provided
* threshold size (in pixels) and replaces them with the pixel value
* of the largest neighbour polygon.
* <p>
* Polygon are determined (per GDALRasterPolygonEnumerator) as regions of
* the raster where the pixels all have the same value, and that are contiguous
* (connected).
* <p>
* Pixels determined to be "nodata" per maskBand will not be treated as part
* of a polygon regardless of their pixel values. Nodata areas will never be
* changed nor affect polygon sizes.
* <p>
* Polygons smaller than the threshold with no neighbours that are as large
* as the threshold will not be altered. Polygons surrounded by nodata areas
* will therefore not be altered.
* <p>
* The algorithm makes three passes over the input file to enumerate the
* polygons and collect limited information about them. Memory use is
* proportional to the number of polygons (roughly 24 bytes per polygon), but
* is not directly related to the size of the raster. So very large raster
* files can be processed effectively if there aren't too many polygons. But
* extremely noisy rasters with many one pixel polygons will end up being
* expensive (in memory) to process.
*
* @param srcBand the source raster band to be processed.
* @param maskBand an optional mask band. All pixels in the mask band with a
* value other than zero will be considered suitable for inclusion in polygons.
* @param dstBand the output raster band. It may be the same as srcBand
* to update the source in place.
* @param threshold raster polygons with sizes smaller than this will
* be merged into their largest neighbour.
* @param connectedness either 4 indicating that diagonal pixels are not
* considered directly adjacent for polygon membership purposes or 8
* indicating they are.
* @param options algorithm options in name=value list form. None currently
* supported. just pass null
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)
/**
* Removes small raster polygons.
* <p>
* Same as below with callback == null
*
* @see #SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options)
/**
* Removes small raster polygons.
* <p>
* Same as below with options == null and callback == null
*
* @see #SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness)
/**
* Removes small raster polygons.
* <p>
* Same as below with connectedness == 4, options == null and callback == null
*
* @see #SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold)
/**
* Generate downsampled overviews.
* <p>
* This function will generate one or more overview images from a base
* image using the requested downsampling algorithm. It's primary use
* is for generating overviews via Dataset.<a href="Dataset.html#BuildOverviews(java.lang.String, int[], org.gdal.gdal.ProgressCallback)">BuildOverviews()</a>, but it
* can also be used to generate downsampled images in one file from another
* outside the overview architecture.
* <p>
* The output bands need to exist in advance.
* <p>
* The full set of resampling algorithms is documented in
* Dataset.BuildOverviews().
*
* @param srcBand the source (base level) band.
* @param overviewBands the list of downsampled bands to be generated.
* @param resampling Resampling algorithm (eg. "AVERAGE").
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
*
* @see Dataset#BuildOverviews(java.lang.String resampling, int[] overviewlist, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
/**
* Generate downsampled overviews.
* <p>
* Same as below with callback == null
*
* @see #RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling)
/**
* Generate downsampled overviews.
* <p>
* Same as below with resampling == "AVERAGE" and callback == null
*
* @see #RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverviews(Band srcBand, Band[] overviewBands)
/**
* Generate downsampled overview.
* <p>
* Same as below for a unique overview band
*
* @see #RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverview(Band srcBand, Band overviewBand, String resampling, ProgressCallback callback)
/**
* Generate downsampled overview.
* <p>
* Same as below for a unique overview band and callback == null
*
* @see #RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverview(Band srcBand, Band overviewBand, String resampling)
/**
* Generate downsampled overview.
* <p>
* Same as below for a unique overview band, resampling == "AVERAGE" and callback == null
*
* @see #RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int RegenerateOverview(Band srcBand, Band overviewBand)
/**
* Create virtual warped dataset automatically.
* <p>
* This function will create a warped virtual file representing the
* input image warped into the target coordinate system. A GenImgProj
* transformation is created to accomplish any required GCP/Geotransform
* warp and reprojection to the target coordinate system. The output virtual
* dataset will be "northup" in the target coordinate system. The
* GDALSuggestedWarpOutput() function is used to determine the bounds and
* resolution of the output virtual file which should be large enough to
* include all the input image
* <p>
* Note that the constructed Dataset object will acquire one or more references
* to the passed in src_ds. Reference counting semantics on the source
* dataset should be honoured. That is, don't just GDALClose() it unless it
* was opened with GDALOpenShared().
* <p>
* The returned dataset will have no associated filename for itself. If you
* want to write the virtual dataset description to a file, use the
* SetDescription() method on the dataset
* to assign a filename before it is closed.
*
* @param src_ds The source dataset.
*
* @param src_wkt The coordinate system of the source image. If null, it
* will be read from the source image.
*
* @param dst_wkt The coordinate system to convert to. If null no change
* of coordinate system will take place.
*
* @param eResampleAlg One of gdalconst.GRA_NearestNeighbour, gdalconst.GRA_Bilinear, gdalconst.GRA_Cubic or
* gdalconst.RA_CubicSpline. Controls the sampling method used.
*
* @param maxError Maximum error measured in input pixels that is allowed in
* approximating the transformation (0.0 for exact calculations).
*
* @return null on failure, or a new virtual dataset handle on success.
*/
public class gdal:public static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
/**
* Create virtual warped dataset automatically.
* <p>
* Same as below with maxError == 0.0
*
* @see #AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg)
/**
* Create virtual warped dataset automatically.
* <p>
* Same as below with eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0
*
* @see #AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt)
/**
* Create virtual warped dataset automatically.
* <p>
* Same as below with dst_wkt == null, eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0
*
* @see #AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt)
/**
* Create virtual warped dataset automatically.
* <p>
* Same as below with src_wkt == null, dst_wkt == null, eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0
*
* @see #AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset AutoCreateWarpedVRT(Dataset src_ds)
/**
* Get runtime version information.
* <p>
* Available request values:
* <ul>
* <li> "VERSION_NUM": Returns GDAL_VERSION_NUM formatted as a string. i.e. "1170"
* Note: starting with GDAL 1.10, this string will be longer than 4 characters.
* <li> "RELEASE_DATE": Returns GDAL_RELEASE_DATE formatted as a string.
* i.e. "20020416".
* <li> "RELEASE_NAME": Returns the GDAL_RELEASE_NAME. i.e. "1.1.7"
* <li> "--version": Returns one line version message suitable for use in
* response to --version requests. i.e. "GDAL 1.1.7, released 2002/04/16"
* <li> "LICENCE": Returns the content of the LICENSE.TXT file from the GDAL_DATA directory.
* </ul>
*
* @param request the type of version info desired, as listed above.
*
* @return a string containing the requested information.
*/
public class gdal:public static String VersionInfo(String request)
/**
* Get runtime version information.
*
* @return a string containing GDAL_VERSION_NUM formatted as a string. i.e. "1170"
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String VersionInfo()
/**
* Register all known configured GDAL drivers.
* <p>
* This function will drive any of the following that are configured into
* GDAL. Many others as well that haven't been updated in this
* documentation (see <a href="http://gdal.org/formats_list.html">full list</a>):
* <p>
* <ul>
* <li> GeoTIFF (GTiff)
* <li> Geosoft GXF (GXF)
* <li> Erdas Imagine (HFA)
* <li> CEOS (CEOS)
* <li> ELAS (ELAS)
* <li> Arc/Info Binary Grid (AIGrid)
* <li> SDTS Raster DEM (SDTS)
* <li> OGDI (OGDI)
* <li> ESRI Labelled BIL (EHdr)
* <li> PCI .aux Labelled Raw Raster (PAux)
* <li> HDF4 Hierachal Data Format Release 4
* <li> HDF5 Hierachal Data Format Release 5
* <li> GSAG Golden Software ASCII Grid
* <li> GSBG Golden Software Binary Grid
* </ul>
* <p>
* This function should generally be called once at the beginning of the application.
*/
public class gdal:public static void AllRegister()
/**
* Get maximum cache memory.
* <p>
* Gets the maximum amount of memory available to the GDALRasterBlock
* caching system for caching GDAL read/write imagery.
*
* @return maximum in bytes.
*/
public class gdal:public static int GetCacheMax()
/**
* Set maximum cache memory.
* <p>
* This function sets the maximum amount of memory that GDAL is permitted
* to use for GDALRasterBlock caching.
*
* @param newSize the maximum number of bytes for caching. Maximum is 2GB.
*/
public class gdal:public static void SetCacheMax(int newSize)
/**
* Get cache memory used.
*
* @return the number of bytes of memory currently in use by the
* GDALRasterBlock memory caching.
*/
public class gdal:public static int GetCacheUsed()
/**
* Get data type size in bits.
* <p>
* Returns the size of a GDT_* type <b>in bits</b>, not bytes!
*
* @param eDataType type, such as gdalconst.GDT_Byte.
* @return the number of bits or zero if it is not recognised.
*/
public class gdal:public static int GetDataTypeSize(int eDataType)
/**
* Is data type complex?
*
* @return 1 if the passed type is complex (one of gdalconst.GDT_CInt16, GDT_CInt32,
* GDT_CFloat32 or GDT_CFloat64), that is it consists of a real and imaginary
* component.
*/
public class gdal:public static int DataTypeIsComplex(int eDataType)
/**
* Get name of data type.
* <p>
* Returns a symbolic name for the data type. This is essentially the
* the enumerated item name with the GDT_ prefix removed. So gdalconst.GDT_Byte returns
* "Byte". These strings are useful for reporting
* datatypes in debug statements, errors and other user output.
*
* @param eDataType type to get name of.
* @return string corresponding to type.
*/
public class gdal:public static String GetDataTypeName(int eDataType)
/**
* Get data type by symbolic name.
* <p>
* Returns a data type corresponding to the given symbolic name. This
* function is opposite to the gdal.GetDataTypeName().
*
* @param dataTypeName string containing the symbolic name of the type.
*
* @return GDAL data type.
*/
public class gdal:public static int GetDataTypeByName(String dataTypeName)
/**
* Get name of color interpretation.
* <p>
* Returns a symbolic name for the color interpretation. This is derived from
* the enumerated item name with the GCI_ prefix removed, but there are some
* variations. So GCI_GrayIndex returns "Gray" and GCI_RedBand returns "Red".
* The returned strings are static strings and should not be modified
* or freed by the application.
*
* @param eColorInterp color interpretation to get name of.
* @return string corresponding to color interpretation.
*/
public class gdal:public static String GetColorInterpretationName(int eColorInterp)
/**
* Get name of palette interpretation.
* <p>
* Returns a symbolic name for the palette interpretation. This is the
* the enumerated item name with the GPI_ prefix removed. So GPI_Gray returns
* "Gray". The returned strings are static strings and should not be modified
* or freed by the application.
*
* @param ePaletteInterp palette interpretation to get name of.
* @return string corresponding to palette interpretation.
*/
public class gdal:public static String GetPaletteInterpretationName(int ePaletteInterp)
/**
* Fetch the number of registered drivers.
*
* @return the number of registered drivers.
*/
public class gdal:public static int GetDriverCount()
/**
* Fetch a driver based on the short name.
*
* @param name the short name, such as "GTiff", being searched for.
*
* @return the identified driver, or null if no match is found.
*/
public class gdal:public static Driver GetDriverByName(String name)
/**
* Fetch driver by index.
*
* @param iDriver the driver index from 0 to gdal.GetDriverCount()-1.
*
* @return the driver identified by the index or null if the index is invalid
*/
public class gdal:public static Driver GetDriver(int iDriver)
/**
* Open a raster file as a Dataset object.
* <p>
* This function will try to open the passed file, or virtual dataset
* name by invoking the Open method of each registered Driver in turn.
* The first successful open will result in a returned dataset. If all
* drivers fail then null is returned.
* <p>
* It is required that you explicitly close a dataset opened in update
* mode with the Dataset.delete() method. Otherwise the data might not be
* flushed to the disk. Don't rely only on Java garbage collection.
*
* @param name the name of the file to access. In the case of
* exotic drivers this may not refer to a physical file, but instead contain
* information for the driver on how to access a dataset.
*
* @param eAccess the desired access, either gdalconst.GA_Update or gdalconst.GA_ReadOnly. Many
* drivers support only read only access.
*
* @return A Dataset object or null on failure.
*
* @see #OpenShared(String name, int eAccess)
*/
public class gdal:public static Dataset Open(String name, int eAccess)
/**
* Open a raster file as a Dataset object.
* <p>
* Same as below with eAccess == gdalconst.GA_ReadOnly
*
* @see #Open(String name, int eAccess)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset Open(String name)
/**
* Open a raster file as a GDALDataset.
* <p>
* This function works the same as gdal.Open(), but allows the sharing of
* GDALDataset handles for a dataset with other callers to gdal.OpenShared().
* <p>
* In particular, gdal.OpenShared() will first consult it's list of currently
* open and shared Dataset's, and if the <a href="MajorObject.html#GetDescription()">GetDescription()</a> name for one
* exactly matches the name passed to gdal.OpenShared() it will be
* referenced and returned.
*
* @param name the name of the file to access. In the case of
* exotic drivers this may not refer to a physical file, but instead contain
* information for the driver on how to access a dataset.
*
* @param eAccess the desired access, either gdalconst.GA_Update or gdalconst.GA_ReadOnly. Many
* drivers support only read only access.
*
* @return A Dataset object or null on failure.
*
* @see #Open(String name, int eAccess)
*/
public class gdal:public static Dataset OpenShared(String name, int eAccess)
/**
* Open a raster file as a Dataset object.
* <p>
* Same as below with eAccess == gdalconst.GA_ReadOnly
*
* @see #OpenShared(String name, int eAccess)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Dataset OpenShared(String name)
/**
* Identify the driver that can open a raster file.
* <p>
* This function will try to identify the driver that can open the passed file
* name by invoking the Identify method of each registered Driver in turn.
* The first driver that successful identifies the file name will be returned.
* If all drivers fail then null is returned.
* <p>
* In order to reduce the need for such searches touch the operating system
* file system machinery, it is possible to give an optional list of files.
* This is the list of all files at the same level in the file system as the
* target file, including the target file. The filenames will not include any
* path components, are an essentially just the output of ReadDir() on the
* parent directory. If the target object does not have filesystem semantics
* then the file list should be null.
*
* @param name the name of the file to access. In the case of
* exotic drivers this may not refer to a physical file, but instead contain
* information for the driver on how to access a dataset.
*
* @param fileList a vector of strings.
* These strings are filenames that are auxiliary to the main filename. The passed
* value may be null.
*
* @return A Driver object or null on failure.
*/
public class gdal:public static Driver IdentifyDriver(String name, java.util.Vector fileList)
/**
* Identify the driver that can open a raster file.
* <p>
* Same as below with fileList == null
*
* @see #IdentifyDriver(String name, java.util.Vector fileList)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static Driver IdentifyDriver(String name)
/**
* Parse an XML string into tree form.
* <p>
* The passed document is parsed into a XMLNode tree representation.
* If the document is not well formed XML then null is returned, and errors
* are reported via CPLError(). No validation beyond wellformedness is
* done.
* <p>
* If the document has more than one "root level" element then those after the
* first will be attached to the first as siblings (via the psNext pointers)
* even though there is no common parent. A document with no XML structure
* (no angle brackets for instance) would be considered well formed, and
* returned as a single CXT_Text node.
*
* @param xmlString the document to parse.
*
* @return parsed tree or null on error.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static XMLNode ParseXMLString(String xmlString)
/**
* Convert tree into string document.
* <p>
* This function converts a XMLNode tree representation of a document
* into a flat string representation. White space indentation is used
* visually preserve the tree structure of the document.
*
* @param xmlnode the root of the tree to serialize
*
* @return the document on success or null on failure.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String SerializeXMLTree(XMLNode xmlnode)
/**
* Apply GeoTransform to x/y coordinate.
* <p>
* Applies the following computation, converting a (pixel,line) coordinate
* into a georeferenced (geo_x,geo_y) location.
* <pre>
* pdfGeoX[0] = padfGeoTransform[0] + dfPixel * padfGeoTransform[1] + dfLine * padfGeoTransform[2];
* pdfGeoY[0] = padfGeoTransform[3] + dfPixel * padfGeoTransform[4] + dfLine * padfGeoTransform[5];
* </pre>
*
* @param padfGeoTransform Six coefficient GeoTransform to apply.
* @param dfPixel Input pixel position
* @param dfLine Input line position.
* @param pdfGeoX allocated array of 1 double where geo_x (easting/longitude) location is placed.
* @param pdfGeoY allocated array of 1 double where geo_y (northing/latitude) location is placed.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static void ApplyGeoTransform(double[] padfGeoTransform, double dfPixel, double dfLine, double[] pdfGeoX, double[] pdfGeoY)
/**
* Invert Geotransform.
* <p>
* This function will invert a standard 3x2 set of GeoTransform coefficients.
* This converts the equation from being pixel to geo to being geo to pixel.
*
* @param gt_in Input geotransform (allocated array of six doubles - unaltered).
* @param gt_out Output geotransform (allocated array of six doubles - updated).
*
* @return 1 on success or 0 if the equation is uninvertable.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int InvGeoTransform(double[] gt_in, double[] gt_out)
/**
* Invert Geotransform.
* <p>
* This function will invert a standard 3x2 set of GeoTransform coefficients.
* This converts the equation from being pixel to geo to being geo to pixel.
*
* @param gt_in Input geotransform (allocated array of six doubles - unaltered).
*
* @return an array of six doubles with the inverted geotransform on success or null if the equation is uninvertable.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static double[] InvGeoTransform(double[] gt_in)
@hide public class gdal:public static int HasThreadSupport()
/**
* Create a directory.
* <p>
* Create a new directory with the indicated mode. The mode is ignored
* on some platforms. A reasonable default mode value would be 0666.
* This method goes through the VSIFileHandler virtualization and may
* work on unusual filesystems such as in memory.
* <p>
* Analog of the POSIX mkdir() function.
*
* @param path the path to the directory to create.
* @param mode the permissions mode.
*
* @return 0 on success or -1 on an error.
*
* @since Java bindings 1.8.0
*/
public class gdal:public static int Mkdir(String path, int mode)
/**
* Rename a file.
* <p>
* Renames a file object in the file system. It should be possible
* to rename a file onto a new filesystem, but it is safest if this
* function is only used to rename files that remain in the same directory.
* <p>
* This method goes through the VSIFileHandler virtualization and may
* work on unusual filesystems such as in memory.
* <p>
* Analog of the POSIX rename() function.
*
* @param oldpath the name of the file to be renamed.
* @param newpath the name the file should be given.
*
* @return 0 on success or -1 on an error.
*
* @since Java bindings 1.8.0
*/
public class gdal:public static int Rename( String oldpath, String newpath )
/**
* Delete a directory.
* <p>
* Deletes a directory object from the file system. On some systems
* the directory must be empty before it can be deleted.
* <p>
* This method goes through the VSIFileHandler virtualization and may
* work on unusual filesystems such as in memory.
* <p>
* Analog of the POSIX rmdir() function.
*
* @param path the path of the directory to be deleted.
*
* @return 0 on success or -1 on an error.
*
* @since Java bindings 1.8.0
*/
public class gdal:public static int Rmdir(String path)
/**
* Read names in a directory.
* <p>
* This function abstracts access to directory contains. It returns a
* list of strings containing the names of files, and directories in this
* directory.
* <p>
* Note that no error is issued via CPLError() if the directory path is
* invalid, though null is returned.
*
* @param path the relative, or absolute path of a directory to read.
* @return The list of entries in the directory, or null if the directory
* doesn't exist.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static java.util.Vector ReadDir(String path)
/* Class ColorTable */
/**
* Class ColorTable represents a color table / palette.
*
* <p>
* The ColorTable class is a binding for the C++ <a href="http://gdal.org/classGDALColorTable.html">GDALColorTable</a> class.
*/
public class ColorTable
/**
* Construct a new color table.
* <p>
* Same as below with ePaletteInterpretation == gdalconst.GPI_RGB
*
* @see #ColorTable(int ePaletteInterpretation)
*/
public class ColorTable:public ColorTable()
/**
* Construct a new color table.
*/
public class ColorTable:public ColorTable(int ePaletteInterpretation)
/**
* Make a copy of a color table.
*/
public class ColorTable:public Object clone()
/**
* Make a copy of a color table.
*/
public class ColorTable:public ColorTable Clone()
/**
* Create color ramp.
* <p>
* Automatically creates a color ramp from one color entry to another. It can be called several times to create multiples ramps in the same color table.
*
* @param nStartIndex index to start the ramp on the color table [0..255]
* @param startcolor a color value to start the ramp
* @param nEndIndex index to end the ramp on the color table [0..255]
* @param endcolor a color value to end the ramp
*/
public class ColorTable:public void CreateColorRamp(int nStartIndex, java.awt.Color startcolor, int nEndIndex, java.awt.Color endcolor)
/**
* Fetch a color entry from table.
*
* @param entry entry offset from zero to GetCount()-1.
*
* @return color entry, or null if index is out of range.
*/
public class ColorTable:public java.awt.Color GetColorEntry(int entry)
/**
* Get number of color entries in table.
*
* @return the number of color entries.
*/
public class ColorTable:public int GetCount()
/**
* Fetch palette interpretation.
* <p>
* The returned value is used to interpret the values in the GDALColorEntry.
*
* @return palette interpretation enumeration value, usually gdalconst.GPI_RGB.
*/
public class ColorTable:public int GetPaletteInterpretation()
/**
* Set entry in color table.
* <p>
* The passed in entry must match the color interpretation of the table to which it is being assigned.
* <p>
* The table is grown as needed to hold the supplied offset.
*
* @param entry entry offset from zero to GetCount()-1.
* @param centry value to assign to table.
*/
public class ColorTable:public void SetColorEntry(int entry, java.awt.Color centry)
/* Class Dataset */
/**
* Class Dataset is an uninstanciable class providing various methods to access a set of associated raster bands, usually from one file.
*
* <p>
* The Dataset class is a binding for the C++ <a href="http://gdal.org/classGDALDataset.html">GDALDataset</a> class.
*
* <p>
* A dataset encapsulating one or more raster bands. Details are further discussed in the <a href="http://gdal.org/gdal_datamodel.html#GDALDataset">GDAL Data Model</a>.
* <p>
* Dataset objects are returned by methods from other classes, such as
* gdal.<a href="gdal.html#Open(java.lang.String, int)">Open()</a> or
* Driver.<a href="Driver.html#Create(java.lang.String, int, int, int, int, java.lang.String[])">Create()</a> /
* Driver.<a href="Driver.html#CreateCopy(java.lang.String, org.gdal.gdal.Dataset)">CreateCopy()</a>
*/
public class Dataset
/**
* Add a band to a dataset.
* <p>
* This method will add a new band to the dataset if the underlying format
* supports this action. Except VRT and MEM drivers, most formats do not.
* <p>
* Note that the new Band object is not returned. It may be fetched
* after successful completion of the method by calling
* ds.GetRasterBand(ds.GetRasterCount()) as the newest
* band will always be the last band.
*
* @param datatype the data type of the pixels in the new band.
*
* @param options a vector of options strings, each being "NAME=VALUE". The supported
* options are format specific. null may be passed by default.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on failure.
*/
public class Dataset:public int AddBand(int datatype, java.util.Vector options)
/**
* Add a band to a dataset.
* <p>
* Same as below with options == null
*
* @see #AddBand(int datatype, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int AddBand(int datatype)
/**
* Add a band to a dataset.
* <p>
* Same as below with datatype == gdalconst.GDT_Byte and options == null
*
* @see #AddBand(int datatype, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int AddBand()
/**
* Build raster overview(s).
* <p>
* If the operation is unsupported for the indicated dataset, then
* gdalconst.CE_Failure is returned, and gdal.GetLastErrorNo() will return
* gdalconst.CPLE_NotSupported.
* <p>
*
* For example, to build overview level 2, 4 and 8 on all bands the following
* call could be made:
* <pre>
* ds.BuildOverviews( "NEAREST", new int[] { 2, 4, 8 }, null );
* </pre>
*
* @param resampling one of "NEAREST", "GAUSS", "AVERAGE",
* "AVERAGE_MAGPHASE" or "NONE" controlling the downsampling method applied.
* @param overviewlist the list of overview decimation factors to build.
* @param callback for reporting progress or null
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if the operation doesn't work.
*
* @see gdal#RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int BuildOverviews(String resampling, int[] overviewlist, ProgressCallback callback)
/**
* Build raster overview(s).
* <p>
* Same as below with callback == null
*
* @see #BuildOverviews(String resampling, int[] overviewlist, ProgressCallback callback)
*/
public class Dataset:public int BuildOverviews(String resampling, int[] overviewlist)
/**
* Build raster overview(s).
* <p>
* Same as below with resampling == "NEAREST" and callback == null
*
* @see #BuildOverviews(String resampling, int[] overviewlist, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int BuildOverviews(int[] overviewlist)
/**
* Build raster overview(s).
* <p>
* Same as below with resampling == "NEAREST"
*
* @see #BuildOverviews(String resampling, int[] overviewlist, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int BuildOverviews(int[] overviewlist, ProgressCallback callback)
/**
* Adds a mask band to the current band.
* <p>
* The default implementation of the CreateMaskBand() method is implemented
* based on similar rules to the .ovr handling implemented using the
* GDALDefaultOverviews object. A TIFF file with the extension .msk will
* be created with the same basename as the original file, and it will have
* as many bands as the original image (or just one for GMF_PER_DATASET).
* The mask images will be deflate compressed tiled images with the same
* block size as the original image if possible.
*
* @since GDAL 1.5.0
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on an error.
*
* @see <a href="http://trac.osgeo.org/gdal/wiki/rfc15_nodatabitmask">RFC 15 - No data bit mask</a>
*
*/
public class Dataset:public int CreateMaskBand(int nFlags)
/**
* Frees the native resource associated to a Dataset object and close the file.
* <p>
* This method will delete the underlying C++ object. After it has been called,
* all native resources will have been destroyed, so it will be illegal (and likely to
* cause JVM crashes) to use any method on this object or any derived objects,
* such as Band objects of this Dataset.
* <p>
* The delete() method <b>must</b> be called when a dataset has been opened in update
* or creation mode, otherwise data might not be properly flushed to the disk. You
* cannot rely on the finalization to call delete().
*/
public class Dataset:public void delete()
/**
* Flush all write cached data to disk.
* <p>
* Any raster (or other GDAL) data written via GDAL calls, but buffered
* internally will be written to disk.
* <p>
* Calling this method is generally not sufficient to ensure that the file is in
* a consistent state. You <b>must</b> call <a href="#delete()">delete()</a> for that
*
* @see #delete()
*/
public class Dataset:public void FlushCache()
/**
* Fetch the driver to which this dataset relates.
*
* @return the driver on which the dataset was created with gdal.Open() or
* Driver.Create().
*/
public class Dataset:public Driver GetDriver()
/**
* Fetch a band object for a dataset.
*
* @param nBandId the index number of the band to fetch, from 1 to
GetRasterCount().
* @return the nBandId th band object
*/
public class Dataset:public Band GetRasterBand(int nBandId)
/**
* Fetch the projection definition string for this dataset.
* <p>
* The returned string defines the projection coordinate system of the
* image in OpenGIS WKT format. It should be suitable for use with the
* OGRSpatialReference class.
* <p>
* When a projection definition is not available an empty (but not null)
* string is returned.
*
* @return the projection string.
*
* @see <a href="https://gdal.org/tutorials/osr_api_tut.html">OSR tutorial</a>
*/
public class Dataset:public String GetProjection()
/**
* Fetch the projection definition string for this dataset.
* <p>
* The returned string defines the projection coordinate system of the
* image in OpenGIS WKT format. It should be suitable for use with the
* OGRSpatialReference class.
* <p>
* When a projection definition is not available an empty (but not null)
* string is returned.
*
* @return the projection string.
*
* @see <a href="https://gdal.org/tutorials/osr_api_tut.html">OSR tutorial</a>
*/
public class Dataset:public String GetProjectionRef()
/**
* Set the projection reference string for this dataset.
* <p>
* The string should be in OGC WKT or PROJ.4 format. An error may occur
* because of incorrectly specified projection strings, because the dataset
* is not writable, or because the dataset does not support the indicated
* projection. Many formats do not support writing projections.
*
* @param projection projection reference string.
*
* @return gdalconst.CE_Failure if an error occurs, otherwise gdalconst.CE_None.
*/
public class Dataset:public int SetProjection(String projection)
/**
* Fetch the affine transformation coefficients.
* <p>
* Fetches the coefficients for transforming between pixel/line (P,L) raster
* space, and projection coordinates (Xp,Yp) space.
* <p>
* <pre>
* Xp = geoTransformArray[0] + P*geoTransformArray[1] + L*geoTransformArray[2];
* Yp = geoTransformArray[3] + P*geoTransformArray[4] + L*geoTransformArray[5];
* </pre>
* <p>
* In a north up image, geoTransformArray[1] is the pixel width, and
* geoTransformArray[5] is the pixel height. The upper left corner of the
* upper left pixel is at position (geoTransformArray[0],geoTransformArray[3]).
* <p>
* The default transform is (0,1,0,0,0,1) and should be returned even when
* an error occurs, such as for formats that don't support
* transformation to projection coordinates.
* <p>
* NOTE: GetGeoTransform() isn't expressive enough to handle the variety of
* OGC Grid Coverages pixel/line to projection transformation schemes.
* Eventually this method will be depreciated in favour of a more general
* scheme.
*
* @param geoTransformArray an existing six double array into which the
* transformation will be placed.
*
* @see gdal#ApplyGeoTransform(double[] padfGeoTransform, double dfPixel, double dfLine, double[] pdfGeoX, double[] pdfGeoY)
* @see gdal#InvGeoTransform(double[] gt_in)
*/
public class Dataset:public void GetGeoTransform(double[] geoTransformArray)
/**
* Fetch the affine transformation coefficients.
* <p>
* Same as below, except the geotransform array is returned by the method
*
* @see #GetGeoTransform(double[] geoTransformArray)
*
* @since Java bindings 1.7.0
*
* @see gdal#ApplyGeoTransform(double[] padfGeoTransform, double dfPixel, double dfLine, double[] pdfGeoX, double[] pdfGeoY)
* @see gdal#InvGeoTransform(double[] gt_in)
*/
public class Dataset:public double[] GetGeoTransform()
/**
* Set the affine transformation coefficients.
* <p>
* See <a href="#GetGeoTransform(double[])">#GetGeoTransform()</a> for details on the meaning of the geoTransformArray
* coefficients.
*
* @param geoTransformArray a six double array containing the transformation
* coefficients to be written with the dataset.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure if this transform cannot be
* written.
*
* @see #GetGeoTransform(double[] geoTransformArray)
*/
public class Dataset:public int SetGeoTransform(double[] geoTransformArray)
/**
* Fetch files forming dataset.
* <p>
* Returns a list of files believed to be part of this dataset. If it returns
* an empty list of files it means there is believed to be no local file
* system files associated with the dataset (for instance a virtual dataset).
* <p>
* The returned filenames will normally be relative or absolute paths
* depending on the path used to originally open the dataset.
*
* @return null or a vector of strings of file names.
*/
public class Dataset:public java.util.Vector GetFileList()
/**
* Get number of GCPs.
*
* @return number of GCPs for this dataset. Zero if there are none.
*/
public class Dataset:public int GetGCPCount()
/**
* Get output projection for GCPs.
* <p>
* The projection string follows the normal rules from <a href="#GetProjectionRef()">GetProjectionRef()</a>.
*
* @return projection string or "" if there are no GCPs.
*/
public class Dataset:public String GetGCPProjection()
/**
* Fetch GCPs.
* <p>
* Add to the provided vector the GCPs of the dataset
*
* @param gcpVector non null Vector object
*/
public class Dataset:public void GetGCPs(java.util.Vector gcpVector)
/**
* Fetch GCPs.
*
* @return a vector of GCP objects
*
* @since Java bindings 1.7.0
*/
public class Dataset:public java.util.Vector GetGCPs()
/**
* Assign GCPs.
* <p>
* This method assigns the passed set of GCPs to this dataset, as well as
* setting their coordinate system. Internally copies are made of the
* coordinate system and list of points, so the caller remains responsible for
* deallocating these arguments if appropriate.
* <p>
* Most formats do not support setting of GCPs, even formats that can
* handle GCPs. These formats will return CE_Failure.
*
* @param gcpArray array of GCP objects being assigned
*
* @param GCPProjection the new OGC WKT coordinate system to assign for the
* GCP output coordinates. This parameter should be "" if no output coordinate
* system is known.
*
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure (including if action is
* not supported for this format).
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int SetGCPs(GCP[] gcpArray, String GCPProjection)
/**
* Fetch raster width in pixels.
*
* @return the width in pixels of raster bands in this Dataset.
*/
public class Dataset:public int getRasterXSize()
/**
* Fetch raster width in pixels.
*
* @return the width in pixels of raster bands in this Dataset.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int GetRasterXSize()
/**
* Fetch raster height in pixels.
*
* @return the height in pixels of raster bands in this Dataset.
*/
public class Dataset:public int getRasterYSize()
/**
* Fetch raster height in pixels.
*
* @return the height in pixels of raster bands in this Dataset.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int GetRasterYSize()
/**
* Fetch the number of raster bands on this dataset.
*
* @return the number of raster bands.
*/
public class Dataset:public int getRasterCount()
/**
* Fetch the number of raster bands on this dataset.
*
* @return the number of raster bands.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int GetRasterCount()
/**
* Read a region of image data from multiple bands.
* <p>
* This method allows reading a region of one or more Band's from
* this dataset into a buffer. It automatically takes care of data type
* translation if the data type (buf_type) of the buffer is different than
* that of the Band.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
* <p>
* The nPixelSpace, nLineSpace and nBandSpace parameters allow reading into or
* writing from various organization of buffers.
* <p>
* For highest performance full resolution data access, read
* on "block boundaries" as returned by <a href="Band.html#GetBlockSize(int[], int[])">Band.GetBlockSize(int[], int[])</a>, or use the
* <a href="Band.html#ReadBlock_Direct(int, int, java.nio.ByteBuffer)">Band.ReadBlock(int, int, java.nio.ByteBuffer)</a> method.
* <p>
* When requesting a multi-byte datatype (GDT_Int16, GDT_Int32, GDT_Float32, ...),
* you should generally set the byte order of the buffer to the native order of the machine
* with nioBuffer.order(ByteOrder.nativeOrder()) (the default is BIG_ENDIAN) if you use
* the getShort(), getInt(), getFloat(), ... methods of the ByteBuffer class.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
* @param buf_xsize the width of the buffer image into which the desired region
* is to be read.
*
* @param buf_ysize the height of the buffer image into which the desired
* region is to be read.
*
* @param buf_type the type of the pixel values in the nioBuffer data buffer. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed.
*
* @param nioBuffer The buffer into which the data will be written. This buffer must contain at least
* buf_xsize * buf_ysize * nBandCount words of type buf_type. It is organized
* in left to right,top to bottom pixel order. Spacing is controlled by the
* nPixelSpace, and nLineSpace parameters.
*
* @param band_list the list of band numbers being read/written.
* Note band numbers are 1 based. This may be null to select the first
* nBandCount bands.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @param nBandSpace the byte offset from the start of one bands data to the
* start of the next. If defaulted (zero) the value will be
* nLineSpace * buf_ysize implying band sequential organization
* of the data buffer.
*
* @return gdalconst.CE_Failure if the access fails, otherwise gdalconst.CE_None.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list)
/**
* Read a region of image data from multiple bands.
* <p>
* This method allows reading a region of one or more Band's from
* this dataset into a buffer. It automatically takes care of data type
* translation if the data type (buf_type) of the buffer is different than
* that of the Band.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
* <p>
* The nPixelSpace, nLineSpace and nBandSpace parameters allow reading into or
* writing from various organization of buffers.
* <p>
* For highest performance full resolution data access, read
* on "block boundaries" as returned by <a href="Band.html#GetBlockSize(int[], int[])">Band.GetBlockSize(int[], int[])</a>, or use the
* <a href="Band.html#ReadBlock_Direct(int, int, java.nio.ByteBuffer)">Band.ReadBlock(int, int, java.nio.ByteBuffer)</a> method.
* <p>
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
* @param buf_xsize the width of the buffer image into which the desired region
* is to be read.
*
* @param buf_ysize the height of the buffer image into which the desired
* region is to be read.
*
* @param buf_type the type of the pixel values in the array. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed. The GDAL type must be consistent with the type of the Java array.
*
* @param array The array into which the data will be written. This buffer must contain at least
* buf_xsize * buf_ysize elements * nBandCount . It is organized
* in left to right,top to bottom pixel order. Spacing is controlled by the
* nPixelSpace, and nLineSpace parameters.
*
* @param band_list the list of band numbers being read/written.
* Note band numbers are 1 based. This may be null to select the first
* nBandCount bands.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @param nBandSpace the byte offset from the start of one bands data to the
* start of the next. If defaulted (zero) the value will be
* nLineSpace * buf_ysize implying band sequential organization
* of the data buffer.
*
* @return gdalconst.CE_Failure if the access fails, otherwise gdalconst.CE_None.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list)
/**
* Read a region of image data from multiple bands.
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list)
/**
* Read a region of image data from multiple bands.
* <p>
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list)
/**
* Read a region of image data from multiple bands.
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list)
/**
* Read a region of image data from multiple bands.
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace)
/**
* Read a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list)
/**
* Write a region of image data from multiple bands.
* <p>
* This method allows writing data from a buffer into a region
* of the Band's. It automatically takes care of data type
* translation if the data type (buf_type) of the buffer is different than
* that of the Band.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
* <p>
* The nPixelSpace, nLineSpace and nBandSpace parameters allow reading into or
* writing from various organization of buffers.
* <p>
* For highest performance full resolution data access, write
* on "block boundaries" as returned by <a href="Band.html#GetBlockSize(int[], int[])">Band.GetBlockSize(int[], int[])</a>, or use the
* <a href="Band.html#WriteBlock_Direct(int, int, java.nio.ByteBuffer)">Band.WriteBlock(int, int, java.nio.ByteBuffer)</a> method.
*<p>
* Before writing into a multi-byte datatype buffer (GDT_Int16, GDT_Int32, GDT_Float32, ...),
* you should generally set the byte order of the buffer to the native order of the machine
* with nioBuffer.order(ByteOrder.nativeOrder()) (the default is BIG_ENDIAN) if you use
* the putShort(), putInt(), putFloat(), ... methods of the ByteBuffer class.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
* @param buf_xsize the width of the buffer image from which the desired region is to be written.
*
* @param buf_ysize the height of the buffer image from which the desired region is to be written.
*
* @param buf_type the type of the pixel values in the nioBuffer data buffer. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed.
*
* @param nioBuffer The buffer into which the data should be read, or from which
* it should be written. This buffer must contain at least
* buf_xsize * buf_ysize * nBandCount words of type buf_type. It is organized
* in left to right,top to bottom pixel order. Spacing is controlled by the
* nPixelSpace, and nLineSpace parameters.
*
* @param band_list the list of band numbers being read/written.
* Note band numbers are 1 based. This may be null to select the first
* nBandCount bands.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @param nBandSpace the byte offset from the start of one bands data to the
* start of the next. If defaulted (zero) the value will be
* nLineSpace * buf_ysize implying band sequential organization
* of the data buffer.
*
* @return gdalconst.CE_Failure if the access fails, otherwise gdalconst.CE_None.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int[] band_list)
/**
* Write a region of image data from multiple bands.
* <p>
* This method allows writing data from a buffer into a region
* of the Band's. It automatically takes care of data type
* translation if the data type (buf_type) of the buffer is different than
* that of the Band.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
* <p>
* The nPixelSpace, nLineSpace and nBandSpace parameters allow reading into or
* writing from various organization of buffers.
* <p>
* For highest performance full resolution data access, write
* on "block boundaries" as returned by <a href="Band.html#GetBlockSize(int[], int[])">Band.GetBlockSize(int[], int[])</a>, or use the
* <a href="Band.html#WriteBlock_Direct(int, int, java.nio.ByteBuffer)">Band.WriteBlock(int, int, java.nio.ByteBuffer)</a> method.
*<p>
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
* @param buf_xsize the width of the buffer image from which the desired region is to be written.
*
* @param buf_ysize the height of the buffer image from which the desired region is to be written.
*
* @param buf_type the type of the pixel values in the array. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed. The GDAL type must be consistent with the type of the Java array.
*
* @param array The array from which the data will be read. This buffer must contain at least
* buf_xsize * buf_ysize elements * nBandCount . It is organized
* in left to right,top to bottom pixel order. Spacing is controlled by the
* nPixelSpace, and nLineSpace parameters.
*
* @param band_list the list of band numbers being read/written.
* Note band numbers are 1 based. This may be null to select the first
* nBandCount bands.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @param nBandSpace the byte offset from the start of one bands data to the
* start of the next. If defaulted (zero) the value will be
* nLineSpace * buf_ysize implying band sequential organization
* of the data buffer.
*
* @return gdalconst.CE_Failure if the access fails, otherwise gdalconst.CE_None.
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list)
/**
* Write a region of image data from multiple bands.
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
*
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int[] band_list)
/**
* Write a region of image data from multiple bands.
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
*
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int[] band_list)
/**
* Write a region of image data from multiple bands.
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int[] band_list)
/**
* Write a region of image data from multiple bands.
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace)
@hide public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace)
/**
* Write a region of image data from multiple bands.
* <p>
* Same as below with nPixelSpace == 0, nLineSpace == 0 and nBandSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list, int nPixelSpace, int nLineSpace, int nBandSpace)
*
* @since Java bindings 1.7.0
*/
public class Dataset:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int[] band_list)
/* Class Band */
/**
* Class Band is an uninstanciable class providing various methods to access a single raster band (or channel).
*
* <p>
* The Band class is a binding for the C++ <a href="http://gdal.org/classGDALRasterBand.html">GDALRasterBand</a> class.
* <p>
* Band objects are returned by methods from other classes, such as
* Dataset.<a href="Dataset.html#GetRasterBand(int)">GetRasterBand()</a>
*
* Users of the Java bindings must be aware that the Java primitive types byte, short, int are signed types, whereas a few GDAL
* data types (GDT_Byte, GDT_UInt16 and GDT_UInt32) are unsigned. To read/write those data types, you may have to
* choose a "larger" type for example (short/GDT_Int16 for GDT_Byte, int/GDT_Int32 for GDT_UInt16, double/GDT_Float64 for GDT_UInt32), or use
* some tricks to hold unsigned values into signed data type. For example :
* <pre>
* byte[] byteArray = new byte[xsize * ysize];
* byte[] byteArray2 = new byte[xsize * ysize];
* band.ReadRaster(0, 0, xsize, ysize, gdalconst.GDT_Byte, byteArray);
* for(int j=0; j < ysize; j++)
* {
* for(int i=0; i < xsize; i++)
* {
* byte bVal = byteArray[j*xsize+i]; // ranging from -128 to 127
* int nVal = ((int)bVal) & 0xff; // remapped to range from 0 to 255
* int nVal2;
* if (nVal > threshold)
* nVal2 = 255;
* else
* nVal2 = 0;
* byte bVal2 = (nVal2 > 127) ? nVal2 - 256 : nVal2; // remapped to range from -128 to 127
* byteArray2[j*xsize+i] = bVal2;
* }
* }
* band2.WriteRaster(0, 0, xsize, ysize, gdalconst.GDT_Byte, byteArray2);
* </pre>
*
*
*/
public class Band
/**
* @deprecated Do not do anything...
*/
public class Band:public void delete()
/**
* Compute checksum for image region.
* <p>
* Computes a 16bit (0-65535) checksum from a region of raster data on the raster band.
* Floating point data is converted to 32bit integer
* so decimal portions of such raster data will not affect the checksum.
* Real and Imaginary components of complex bands influence the result.
*
* @param xoff pixel offset of window to read.
* @param yoff line offset of window to read.
* @param xsize pixel size of window to read.
* @param ysize line size of window to read.
*
* @return Checksum value.
*/
public class Band:public int Checksum(int xoff, int yoff, int xsize, int ysize)
/**
* Compute checksum for while image.
* <p>
* Computes a 16bit (0-65535) checksum from data on the raster band.
* Floating point data is converted to 32bit integer
* so decimal portions of such raster data will not affect the checksum.
* Real and Imaginary components of complex bands influence the result.
*
* @return Checksum value.
* @since Java bindings 1.7.0
*/
public class Band:public int Checksum()
/**
* Compute mean and standard deviation values.
*
* @param meanAndStdDevArray the allocated array of 2 doubles in which the mean value (meanAndStdDevArray[0])
* and the standard deviation (meanAndStdDevArray[1]) are returned
* @param samplestep step in number of lines
*/
public class Band:public void ComputeBandStats(double[] meanAndStdDevArray, int samplestep)
/**
* Compute mean and standard deviation values.
* <p>
* Same as below with samplestep == 1
*
* @see #ComputeBandStats(double[] meanAndStdDevArray, int samplestep)
* @since Java bindings 1.7.0
*/
public class Band:public void ComputeBandStats(double[] meanAndStdDevArray)
/**
* Compute the min/max values for a band.
* <p>
* If approximate is OK, then the band's GetMinimum()/GetMaximum() will
* be trusted. If it doesn't work, a subsample of blocks will be read to
* get an approximate min/max. If the band has a nodata value it will
* be excluded from the minimum and maximum.
* <p>
* If approx_ok is 0, then all pixels will be read and used to compute
* an exact range.
*
* @param minMaxArray the allocated array of 2 doubles in which the minimum (minMaxArray[0]) and the
* maximum (minMaxArray[1]) are returned.
* @param approx_ok 1 if an approximate (faster) answer is OK, otherwise 0.
*/
public class Band:public void ComputeRasterMinMax(double[] minMaxArray, int approx_ok)
/**
* Compute the min/max values for a band.
* <p>
* Same as below with approx_ok == 0
*
* @see #ComputeRasterMinMax(double[] minMaxArray, int approx_ok)
* @since Java bindings 1.7.0
*/
public class Band:public void ComputeRasterMinMax(double[] minMaxArray)
/**
* Compute image statistics.
* <p>
* Returns the minimum, maximum, mean and standard deviation of all
* pixel values in this band. If approximate statistics are sufficient,
* the approx_ok flag can be set to true in which case overviews, or a
* subset of image tiles may be used in computing the statistics.
* <p>
* Once computed, the statistics will generally be "set" back on the
* raster band using SetStatistics().
*
* @param approx_ok If true statistics may be computed based on overviews
* or a subset of all tiles.
*
* @param min Allocated array of one double into which to load image minimum (may be null).
*
* @param max Allocated array of one double into which to load image maximum (may be null).
*
* @param mean Allocated array of one double into which to load image mean (may be null).
*
* @param stddev Allocated array of one double into which to load image standard deviation
* (may be null).
*
* @param callback for reporting algorithm progress. May be null
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure if an error occurs or processing
* is terminated by the user.
*
* @since Java bindings 1.7.0
*/
public class Band:public int ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean, double[] stddev, ProgressCallback callback)
/**
* Compute image statistics.
* <p>
* Same as below with callback == null
*
* @see #ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean, double[] stddev, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean, double[] stddev)
@hide public class Band:public int ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean)
/**
* Compute image statistics.
* <p>
* Same as below with mean == null, stddev == null and callback == null
*
* @see #ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean, double[] stddev, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ComputeStatistics(boolean approx_ok, double[] min, double[] max)
@hide public class Band:public int ComputeStatistics(boolean approx_ok, double[] min)
/**
* Compute image statistics.
* <p>
* Same as below with min == null, max == null, mean == null, stddev == null and callback == null
*
* @see #ComputeStatistics(boolean approx_ok, double[] min, double[] max, double[] mean, double[] stddev, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ComputeStatistics(boolean approx_ok)
/**
* Adds a mask band to the current band.
* <p>
* The default implementation of the CreateMaskBand() method is implemented
* based on similar rules to the .ovr handling implemented using the
* GDALDefaultOverviews object. A TIFF file with the extension .msk will
* be created with the same basename as the original file, and it will have
* as many bands as the original image (or just one for GMF_PER_DATASET).
* The mask images will be deflate compressed tiled images with the same
* block size as the original image if possible.
*
* @since GDAL 1.5.0
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on an error.
*
* @see <a href="http://trac.osgeo.org/gdal/wiki/rfc15_nodatabitmask">RFC 15 - No data bit mask</a>
*
*/
public class Band:public int CreateMaskBand(int nFlags)
/**
* Fill this band with a constant value.
* <p>
* GDAL makes no guarantees
* about what values pixels in newly created files are set to, so this
* method can be used to clear a band to a specified "default" value.
* The fill value is passed in as a double but this will be converted
* to the underlying type before writing to the file. An optional
* second argument allows the imaginary component of a complex
* constant value to be specified.
*
* @param real_fill Real component of fill value
* @param imag_fill Imaginary component of fill value, defaults to zero
*
* @return gdalconst.CE_Failure if the write fails, otherwise gdalconst.CE_None
*/
public class Band:public int Fill(double real_fill, double imag_fill)
/**
* Fill this band with a constant value.
* <p>
* Same as below with image_fill == 0
*
* @see #Fill(double real_fill, double imag_fill)
*
* @since Java bindings 1.7.0
*/
public class Band:public int Fill(double real_fill)
/**
* Flush raster data cache.
* <p>
* This call will recover memory used to cache data blocks for this raster
* band, and ensure that new requests are referred to the underlying driver.
*/
public class Band:public void FlushCache()
/**
* Fetch the band number.
* <p>
* This method returns the band that this Band object represents
* within its dataset. This method may return a value of 0 to indicate
* Band objects without an apparently relationship to a dataset,
* such as Band's serving as overviews.
*
* @return band number (1+) or 0 if the band number isn't known.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetBand()
/**
* Fetch the "natural" block size of this band.
* <p>
* GDAL contains a concept of the natural block size of rasters so that
* applications can organized data access efficiently for some file formats.
* The natural block size is the block size that is most efficient for
* accessing the format. For many formats this is simple a whole scanline
* in which case pnBlockXSize[0] is set to GetXSize(), and pnBlockXSize[1] is set to 1.
* <p>
* However, for tiled images this will typically be the tile size.
* <p>
* Note that the X and Y block sizes don't have to divide the image size
* evenly, meaning that right and bottom edge blocks may be incomplete.
* See <a href="#ReadBlock_Direct(int, int, java.nio.ByteBuffer)">ReadBlock_Direct()</a> for an example of code dealing with these issues.
*
* @param pnBlockXSize allocated array of 1 integer to put the X block size into or null.
*
* @param pnBlockYSize allocated array of 1 integer to put the Y block size into or null.
*/
public class Band:public void GetBlockSize(int[] pnBlockXSize, int[] pnBlockYSize)
/**
* Fetch the "natural" block width of this band
* @return the X block size
* @see #GetBlockSize(int[] pnBlockXSize, int[] pnBlockYSize)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetBlockXSize()
/**
* Fetch the "natural" block height of this band
* @return the Y block size
* @see #GetBlockSize(int[] pnBlockXSize, int[] pnBlockYSize)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetBlockYSize()
/**
* How should this band be interpreted as color?
* <p>
* gdalconst.GCI_Undefined is returned when the format doesn't know anything
* about the color interpretation.
*
* @return color interpretation value for band.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetColorInterpretation()
/**
* Fetch the color table associated with band.
* <p>
* If there is no associated color table, the return result is null. The
* returned color table remains owned by the Band object.
* It should not be modified by the caller.
*
* @return color table, or null.
*/
public class Band:public ColorTable GetColorTable()
/**
* Return the data type of the band.
* <p>
* A value such as gdalconst.GDT_Byte, gdalconst.GDT_Int16, ...
* @return the data type of the band.
*/
public class Band:public int getDataType()
/**
* Fetch default raster histogram.
* <p>
* The default method in GDALRasterBand will compute a default histogram. This
* method is overridden by derived classes (such as GDALPamRasterBand, VRTDataset, HFADataset...)
* that may be able to fetch efficiently an already stored histogram.
* <p>
* For example,
* <pre>
* double[] dfMin = new double[1];
* double[] dfMax = new double[1];
* int[][] panHistogram = new int[1][];
* int eErr = hBand.GetDefaultHistogram(dfMin, dfMax, panHistogram, true, new TermProgressCallback());
* if( eErr == gdalconst.CE_None )
* {
* int iBucket;
* int nBucketCount = panHistogram[0].length;
* System.out.print( " " + nBucketCount + " buckets from " +
* dfMin[0] + " to " + dfMax[0] + ":\n " );
* for( iBucket = 0; iBucket < nBucketCount; iBucket++ )
* System.out.print( panHistogram[0][iBucket] + " ");
* System.out.print( "\n" );
* }
* </pre>
*
* @param min_ret allocated array of one double that will contain the lower bound of the histogram.
* @param max_ret allocated array of one double that will contain the upper bound of the histogram.
* @param histogram_ret allocated array of one int[] into which the histogram totals are placed.
* @param force true to force the computation. If false and no default histogram is available, the method will return CE_Warning
* @param callback for reporting algorithm progress. May be null
*
* @return gdalconst.CE_None on success, gdalconst.CE_Failure if something goes wrong, or
* gdalconst.CE_Warning if no default histogram is available.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetDefaultHistogram(double[] min_ret, double[] max_ret, int[][] histogram_ret, boolean force, ProgressCallback callback)
/**
* Fetch default raster histogram.
* <p>
* Same as below with callback == null
*
* @see #GetDefaultHistogram(double[] min_ret, double[] max_ret, int[][] histogram_ret, boolean force, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetDefaultHistogram(double[] min_ret, double[] max_ret, int[][] histogram_ret, boolean force)
/**
* Fetch default raster histogram.
* <p>
* Same as below with force == true and callback == null
*
* @see #GetDefaultHistogram(double[] min_ret, double[] max_ret, int[][] histogram_ret, boolean force, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetDefaultHistogram(double[] min_ret, double[] max_ret, int[][] histogram_ret)
/**
* Fetch default Raster Attribute Table.
* <p>
* A RAT will be returned if there is a default one associated with the
* band, otherwise null is returned. The returned RAT is owned by the
* band and should not be altered by the application.
*
* @return a RAT or null
*/
public class Band:public RasterAttributeTable GetDefaultRAT()
/**
* Compute raster histogram.
* <p>
* Note that the bucket size is (dfMax-dfMin) / nBuckets.
* <p>
* For example to compute a simple 256 entry histogram of eight bit data,
* the following would be suitable. The unusual bounds are to ensure that
* bucket boundaries don't fall right on integer values causing possible errors
* due to rounding after scaling.
* <pre>
* int anHistogram = new int[256];
*
* band.GetHistogram( -0.5, 255.5, 256, anHistogram, false, false, null);
* </pre>
* <p>
* Note that setting approx_ok will generally result in a subsampling of the
* file, and will utilize overviews if available. It should generally
* produce a representative histogram for the data that is suitable for use
* in generating histogram based luts for instance. Generally bApproxOK is
* much faster than an exactly computed histogram.
*
* @param min the lower bound of the histogram.
* @param max the upper bound of the histogram.
* @param histogram allocated array into which the histogram totals are placed.
* @param include_out_of_range if true values below the histogram range will
* mapped into anHistogram[0], and values above will be mapped into
* anHistogram[anHistogram.length-1] otherwise out of range values are discarded.
* @param approx_ok true if an approximate, or incomplete histogram OK.
* @param callback for reporting algorithm progress. May be null
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure if something goes wrong.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetHistogram(double min, double max, int[] histogram, boolean include_out_of_range, boolean approx_ok, ProgressCallback callback)
/**
* Compute raster histogram.
* <p>
* Same as below with callback == null
*
* @see #GetHistogram(double min, double max, int[] histogram, boolean include_out_of_range, boolean approx_ok, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetHistogram(double min, double max, int[] histogram, boolean include_out_of_range, boolean approx_ok)
/**
* Compute raster histogram.
* <p>
* Same as below with include_out_of_range == 0, approx_ok == true and callback == null
*
* @see #GetHistogram(double min, double max, int[] histogram, boolean include_out_of_range, boolean approx_ok, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetHistogram(double min, double max, int[] histogram)
/**
* Compute raster histogram.
* <p>
* Same as below with include_out_of_range == 0, approx_ok == true and callback == null
*
* @see #GetHistogram(double min, double max, int[] histogram, boolean include_out_of_range, boolean approx_ok, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetHistogram(int[] histogram)
/**
* Return the mask band associated with the band.
* <p>
* The GDALRasterBand class includes a default implementation of GetMaskBand() that
* returns one of four default implementations :
* <ul>
* <li>If a corresponding .msk file exists it will be used for the mask band.</li>
* <li>If the dataset has a NODATA_VALUES metadata item, an instance of the
* new GDALNoDataValuesMaskBand class will be returned.
* GetMaskFlags() will return GMF_NODATA | GMF_PER_DATASET. @since GDAL 1.6.0</li>
* <li>If the band has a nodata value set, an instance of the new
* GDALNodataMaskRasterBand class will be returned.
* GetMaskFlags() will return GMF_NODATA.</li>
* <li>If there is no nodata value, but the dataset has an alpha band that seems
* to apply to this band (specific rules yet to be determined) and that is
* of type GDT_Byte then that alpha band will be returned, and the flags
* GMF_PER_DATASET and GMF_ALPHA will be returned in the flags.</li>
* <li>If neither of the above apply, an instance of the new GDALAllValidRasterBand
* class will be returned that has 255 values for all pixels.
* The null flags will return GMF_ALL_VALID.</li>
* </ul>
* <p>
* Note that the GetMaskBand() should always return a GDALRasterBand mask, even if it is only
* an all 255 mask with the flags indicating GMF_ALL_VALID.
*
* @return a valid mask band.
*
* @since GDAL 1.5.0
*
* @see <a href="http://trac.osgeo.org/gdal/wiki/rfc15_nodatabitmask">RFC 15 - No data bit mask</a>
*
*/
public class Band:public Band GetMaskBand()
/**
* Return the status flags of the mask band associated with the band.
* <p>
* The GetMaskFlags() method returns an bitwise OR-ed set of status flags with
* the following available definitions that may be extended in the future:
* <ul>
* <li>GMF_ALL_VALID(0x01): There are no invalid pixels, all mask values will be 255.
* When used this will normally be the only flag set.</li>
* <li>GMF_PER_DATASET(0x02): The mask band is shared between all bands on the dataset.</li>
* <li>GMF_ALPHA(0x04): The mask band is actually an alpha band and may have values
* other than 0 and 255.</li>
* <li>GMF_NODATA(0x08): Indicates the mask is actually being generated from nodata values.
* (mutually exclusive of GMF_ALPHA)</li>
* </ul>
* <p>
* The GDALRasterBand class includes a default implementation of GetMaskBand() that
* returns one of four default implementations :
* <ul>
* <li>If a corresponding .msk file exists it will be used for the mask band.</li>
* <li>If the dataset has a NODATA_VALUES metadata item, an instance of the
* new GDALNoDataValuesMaskBand class will be returned.
* GetMaskFlags() will return GMF_NODATA | GMF_PER_DATASET. @since GDAL 1.6.0</li>
* <li>If the band has a nodata value set, an instance of the new
* GDALNodataMaskRasterBand class will be returned.
* GetMaskFlags() will return GMF_NODATA.</li>
* <li>If there is no nodata value, but the dataset has an alpha band that seems
* to apply to this band (specific rules yet to be determined) and that is
* of type GDT_Byte then that alpha band will be returned, and the flags
* GMF_PER_DATASET and GMF_ALPHA will be returned in the flags.</li>
* <li>If neither of the above apply, an instance of the new GDALAllValidRasterBand
* class will be returned that has 255 values for all pixels.
* The null flags will return GMF_ALL_VALID.</li>
* </ul>
*
* @since GDAL 1.5.0
*
* @return a valid mask band.
*
* @see <a href="http://trac.osgeo.org/gdal/wiki/rfc15_nodatabitmask">RFC 15 - No data bit mask</a>
*
*/
public class Band:public int GetMaskFlags()
/**
* Fetch the minimum value for this band.
* <p>
* For file formats that don't know this intrinsically, no value will be returned
*
* @param val empty allocated array of type Double[] of size 1. val[0] will contain a Double object
* with the minimum value if available, other val[0] will contain null
*/
public class Band:public void GetMinimum(Double[] val)
/**
* Fetch the maximum value for this band.
* <p>
* For file formats that don't know this intrinsically, no value will be returned
*
* @param val empty allocated array of type Double[] of size 1. val[0] will contain a Double object
* with the maximum value if available, other val[0] will contain null
*/
public class Band:public void GetMaximum(Double[] val)
/**
* Fetch the raster value offset.
* <p>
* This value (in combination with the GetScale() value) is used to
* transform raw pixel values into the units returned by GetUnits().
* For example this might be used to store elevations in GUInt16 bands
* with a precision of 0.1, and starting from -100.
* <p>
* Units value = (raw value * scale) + offset
* <p>
* For file formats that don't know this intrinsically, no value will be returned
*
* @param val empty allocated array of type Double[] of size 1. val[0] will contain a Double object
* with the offset value if available, other val[0] will contain null
*/
public class Band:public void GetOffset(Double[] val)
/**
* Fetch the raster value scale.
* <p>
* This value (in combination with the GetOffset() value) is used to
* transform raw pixel values into the units returned by GetUnits().
* For example this might be used to store elevations in GUInt16 bands
* with a precision of 0.1, and starting from -100.
* <p>
* Units value = (raw value * scale) + offset
* <p>
* For file formats that don't know this intrinsically, no value will be returned
*
* @param val empty allocated array of type Double[] of size 1. val[0] will contain a Double object
* with the scale value if available, other val[0] will contain null
*/
public class Band:public void GetScale(Double[] val)
/**
* Fetch the no data value for this band.
* <p>
* The no data value for a band is generally a special marker
* value used to mark pixels that are not valid data. Such pixels should
* generally not be displayed, nor contribute to analysis operations.
*
* @param val empty allocated array of type Double[] of size 1. val[0] will contain a Double object
* with the no data value if available, other val[0] will contain null
*/
public class Band:public void GetNoDataValue(Double[] val)
/**
* Fetch overview raster band object.
*
* @param i overview index between 0 and GetOverviewCount()-1.
*
* @return overview Band.
*/
public class Band:public Band GetOverview(int i)
/**
* Return the number of overview layers available.
*
* @return overview count, zero if none.
*/
public class Band:public int GetOverviewCount()
/**
* Fetch the list of category names for this raster.
* <p>
* Raster values without
* associated names will have an empty string in the returned list. The
* first entry in the list is for raster values of zero, and so on.
*
* @return vector of names, or null if none.
*
* @since GDAL 1.9.0
*/
public class Band:public java.util.Vector GetCategoryNames()
/**
* Fetch the list of category names for this raster.
* <p>
* Raster values without
* associated names will have an empty string in the returned list. The
* first entry in the list is for raster values of zero, and so on.
*
* @return vector of names, or null if none.
*/
public class Band:public java.util.Vector GetRasterCategoryNames()
/**
* How should this band be interpreted as color?
* <p>
* gdalconst.GCI_Undefined is returned when the format doesn't know anything
* about the color interpretation.
*
* @return color interpretation value for band.
*/
public class Band:public int GetRasterColorInterpretation()
/**
* Fetch the color table associated with band.
* <p>
* If there is no associated color table, the return result is null. The
* returned color table remains owned by the Band object.
* It should not be modified by the caller.
*
* @return color table, or null.
*/
public class Band:public ColorTable GetRasterColorTable()
/**
* Return the data type of the band.
* <p>
* A value such as gdalconst.GDT_Byte, gdalconst.GDT_Int16, ...
* @return the data type of the band.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetRasterDataType()
/**
* Fetch image statistics.
* <p>
* Returns the minimum, maximum, mean and standard deviation of all
* pixel values in this band. If approximate statistics are sufficient,
* the approx_ok flag can be set to true in which case overviews, or a
* subset of image tiles may be used in computing the statistics.
* <p>
* If force is false results will only be returned if it can be done
* quickly (i.e. without scanning the data). If force is false and
* results cannot be returned efficiently, the method will return CE_Warning
* but no warning will have been issued. This is a non-standard use of
* the CE_Warning return value to indicate "nothing done".
* <p>
* Note that file formats using PAM (Persistent Auxiliary Metadata) services
* will generally cache statistics in the .pam file allowing fast fetch
* after the first request.
*
* @param approx_ok If true statistics may be computed based on overviews
* or a subset of all tiles.
*
* @param force If true statistics will only be returned if it can
* be done without rescanning the image.
*
* @param min Allocated array of one double into which to load image minimum (may be null).
*
* @param max Allocated array of one double into which to load image maximum (may be null).
*
* @param mean Allocated array of one double into which to load image mean (may be null).
*
* @param stddev Allocated array of one double into which to load image standard deviation
* (may be null).
*
* @return gdalconst.CE_None on success, gdalconst.CE_Warning if no values returned,
* gdalconst.CE_Failure if an error occurs.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetStatistics(boolean approx_ok, boolean force, double[] min, double[] max, double[] mean, double[] stddev)
/**
* Fetch image statistics.
* <p>
* Same as below but boolean value of true should be replaced with 1, and false with 0.
*
* @see #GetStatistics(boolean approx_ok, boolean force, double[] min, double[] max, double[] mean, double[] stddev)
*/
public class Band:public int GetStatistics(int approx_ok, int force, double[] min, double[] max, double[] mean, double[] stddev)
/**
* Return raster unit type.
* <p>
* Return a name for the units of this raster's values. For instance, it
* might be "m" for an elevation model in meters, or "ft" for feet. If no
* units are available, a value of "" will be returned.
*
* @return unit name string.
*
* @since Java bindings 1.7.0
*/
public class Band:public String GetUnitType()
/**
* Fetch XSize of raster.
*
* @return the width in pixels of this band.
*/
public class Band:public int getXSize()
/**
* Fetch XSize of raster.
*
* @return the width in pixels of this band.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetXSize()
/**
* Fetch YSize of raster.
*
* @return the height in pixels of this band.
*/
public class Band:public int getYSize()
/**
* Fetch YSize of raster.
*
* @return the height in pixels of this band.
*
* @since Java bindings 1.7.0
*/
public class Band:public int GetYSize()
/**
* Check for arbitrary overviews.
* <p>
* This returns true if the underlying datastore can compute arbitrary
* overviews efficiently, such as is the case with OGDI over a network.
* Datastores with arbitrary overviews don't generally have any fixed
* overviews, but the ReadRaster() method can be used in downsampling mode
* to get overview data efficiently.
*
* @return true if arbitrary overviews available (efficiently), otherwise
* false.
*
* @since Java bindings 1.7.0
*/
public class Band:public boolean HasArbitraryOverviews()
/**
* Read a region of image data for this band.
* <p>
* This method allows reading a region of a GDALRasterBand into a buffer. It
* automatically takes care of data type translation if the data type
* (buf_type) of the buffer is different than that of the GDALRasterBand.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
*<p>
* The nPixelSpace and nLineSpace parameters allow reading into or
* writing from unusually organized buffers. This is primarily used
* for buffers containing more than one bands raster data in interleaved
* format.
*<p>
* Some formats may efficiently implement decimation into a buffer by
* reading from lower resolution overview images.
* <p>
* For highest performance full resolution data access, read
* on "block boundaries" as returned by <a href="#GetBlockSize(int[], int[])">GetBlockSize(int[], int[])</a>, or use the
* <a href="#ReadBlock_Direct(int, int, java.nio.ByteBuffer)">ReadBlock(int, int, java.nio.ByteBuffer)</a> method.
* <p>
* When requesting a multi-byte datatype (GDT_Int16, GDT_Int32, GDT_Float32, ...),
* you should generally set the byte order of the buffer to the native order of the machine
* with nioBuffer.order(ByteOrder.nativeOrder()) (the default is BIG_ENDIAN) if you use
* the getShort(), getInt(), getFloat() etc... methods of the ByteBuffer class.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
*
* @param buf_xsize the width of the buffer image into which the desired region is
* to be read, or from which it is to be written.
*
* @param buf_ysize the height of the buffer image into which the desired region is
* to be read, or from which it is to be written.
*
* @param buf_type the type of the pixel values in the nioBuffer data buffer. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the GDALRasterBand
* data type as needed.
*
* @param nioBuffer The buffer into which the data should be read.
* This buffer must contain at least buf_xsize *
* buf_ysize words of type buf_type. It is organized in left to right,
* top to bottom pixel order. Spacing is controlled by the nPixelSpace,
* and nLineSpace parameters.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @return CE_Failure if the access fails, otherwise CE_None.
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*/
public class Band:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_type == gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, java.nio.ByteBuffer nioBuffer)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type == gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, java.nio.ByteBuffer nioBuffer)
/**
* Read a region of image data for this band.
* <p>
* Same as below but buffer is allocated by the method
*
* @return a newly allocated byte buffer with the read region. Its byte order is BIG_ENDIAN by default.
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, java.nio.ByteBuffer nioBuffer)
*
* @since Java bindings 1.7.0
*/
public class Band:public java.nio.ByteBuffer ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0 but buffer is allocated by the method
*
* @return a newly allocated byte buffer with the read region. Its byte order is BIG_ENDIAN by default.
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public java.nio.ByteBuffer ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_type)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0 but buffer is allocated by the method
*
* @return a newly allocated byte buffer with the read region. Its byte order is BIG_ENDIAN by default.
*
* @see #ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public java.nio.ByteBuffer ReadRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type)
/**
* Read a region of image data for this band.
* <p>
* This method allows reading a region of a GDALRasterBand into a buffer. It
* automatically takes care of data type translation if the data type
* (buf_type) of the buffer is different than that of the GDALRasterBand.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
*<p>
* The nPixelSpace and nLineSpace parameters allow reading into or
* writing from unusually organized buffers. This is primarily used
* for buffers containing more than one bands raster data in interleaved
* format.
*<p>
* Some formats may efficiently implement decimation into a buffer by
* reading from lower resolution overview images.
* <p>
* For highest performance full resolution data access, read
* on "block boundaries" as returned by <a href="#GetBlockSize(int[], int[])">GetBlockSize(int[], int[])</a>, or use the
* <a href="#ReadBlock_Direct(int, int, java.nio.ByteBuffer)">ReadBlock(int, int, java.nio.ByteBuffer)</a> method.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
*
* @param buf_xsize the width of the buffer image into which the desired region is
* to be read, or from which it is to be written.
*
* @param buf_ysize the height of the buffer image into which the desired region is
* to be read, or from which it is to be written.
*
* @param buf_type the type of the pixel values in the array. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed. The GDAL type must be consistent with the type of the Java array.
*
* @param array The buffer into which the data should be read.
* This buffer must contain at least buf_xsize *
* buf_ysize words of type buf_type. It is organized in left to right,
* top to bottom pixel order. Spacing is controlled by the nPixelSpace,
* and nLineSpace parameters.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @return CE_Failure if the access fails, otherwise CE_None.
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, byte[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type = gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, byte[] array)
/**
* Read a region of image data for this band.
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, short[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type = gdalconst.GDT_Int16, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, short[] array)
/**
* Read a region of image data for this band.
* <p>
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, int[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type = gdalconst.GDT_Int32, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int[] array)
/**
* Read a region of image data for this band.
* <p>
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, float[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type = gdalconst.GDT_Float32, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, float[] array)
/**
* Read a region of image data for this band.
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace)
/**
* Read a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, double[] array)
/**
* Read a region of image data for this band.
* <p>
* Same as below with buf_xsize = xsize, buf_ysize = ysize, buf_type = gdalconst.GDT_Float64, nPixelSpace == 0 and nLineSpace == 0
*
* @see #ReadRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadRaster(int xoff, int yoff, int xsize, int ysize, double[] array)
/**
* Write a region of image data for this band.
* <p>
* This method allows writing data from a buffer into a region
* of the Band. It
* automatically takes care of data type translation if the data type
* (buf_type) of the buffer is different than that of the GDALRasterBand.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
*<p>
* The nPixelSpace and nLineSpace parameters allow reading into or
* writing from unusually organized buffers. This is primarily used
* for buffers containing more than one bands raster data in interleaved
* format.
*<p>
* Some formats may efficiently implement decimation into a buffer by
* reading from lower resolution overview images.
* <p>
* For highest performance full resolution data access, write
* on "block boundaries" as returned by <a href="#GetBlockSize(int[], int[])">GetBlockSize(int[], int[])</a>, or use the
* <a href="#WriteBlock_Direct(int, int, java.nio.ByteBuffer)">WriteBlock(int, int, java.nio.ByteBuffer)</a> method.
*<p>
* Before writing into a multi-byte datatype buffer (GDT_Int16, GDT_Int32, GDT_Float32, ...),
* you should generally set the byte order of the buffer to the native order of the machine
* with nioBuffer.order(ByteOrder.nativeOrder()) (the default is BIG_ENDIAN) if you use
* the putShort(), putInt(), putFloat(), ... methods of the ByteBuffer class.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
*
* @param buf_xsize the width of the buffer image from which the desired region is to be written.
*
* @param buf_ysize the height of the buffer image from which the desired region is to be written.
*
* @param buf_type the type of the pixel values in the nioBuffer data buffer. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the GDALRasterBand
* data type as needed.
*
* @param nioBuffer The buffer into which the data should be read.
* This buffer must contain at least buf_xsize *
* buf_ysize words of type buf_type. It is organized in left to right,
* top to bottom pixel order. Spacing is controlled by the nPixelSpace,
* and nLineSpace parameters.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @return CE_Failure if the access fails, otherwise CE_None.
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*/
public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_type == gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, java.nio.ByteBuffer nioBuffer)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_type, java.nio.ByteBuffer nioBuffer)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, java.nio.ByteBuffer nioBuffer, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster_Direct(int xoff, int yoff, int xsize, int ysize, java.nio.ByteBuffer nioBuffer)
/**
* Write a region of image data for this band.
* <p>
* This method allows writing data from a buffer into a region
* of the Band. It
* automatically takes care of data type translation if the data type
* (buf_type) of the buffer is different than that of the GDALRasterBand.
* The method also takes care of image decimation / replication if the
* buffer size (buf_xsize x buf_ysize) is different than the size of the
* region being accessed (xsize x ysize).
*<p>
* The nPixelSpace and nLineSpace parameters allow reading into or
* writing from unusually organized buffers. This is primarily used
* for buffers containing more than one bands raster data in interleaved
* format.
*<p>
* Some formats may efficiently implement decimation into a buffer by
* reading from lower resolution overview images.
* <p>
* For highest performance full resolution data access, write
* on "block boundaries" as returned by <a href="#GetBlockSize(int[], int[])">GetBlockSize(int[], int[])</a>, or use the
* <a href="#WriteBlock_Direct(int, int, java.nio.ByteBuffer)">WriteBlock(int, int, java.nio.ByteBuffer)</a> method.
*
* @param xoff The pixel offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the left side.
*
* @param yoff The line offset to the top left corner of the region
* of the band to be accessed. This would be zero to start from the top.
*
* @param xsize The width of the region of the band to be accessed in pixels.
*
* @param ysize The height of the region of the band to be accessed in lines.
*
* @param buf_xsize the width of the buffer image from which the desired region is to be written.
*
* @param buf_ysize the height of the buffer image from which the desired region is to be written.
*
* @param buf_type the type of the pixel values in the array. One of
* <a href="../gdalconst/gdalconstConstants.html#GDT_Byte">gdalconstConstants.GDT_Byte</a>,
* <a href="../gdalconst/gdalconstConstants.html#GDT_Int16">gdalconstConstants.GDT_Int16</a>, ...
* The pixel values will automatically be translated to/from the Band
* data type as needed. The GDAL type must be consistent with the type of the Java array.
*
* @param array The buffer into which the data should be read.
* This buffer must contain at least buf_xsize *
* buf_ysize words of type buf_type. It is organized in left to right,
* top to bottom pixel order. Spacing is controlled by the nPixelSpace,
* and nLineSpace parameters.
*
* @param nPixelSpace The byte offset from the start of one pixel value in
* the buffer to the start of the next pixel value within a scanline. If defaulted
* (0) the size of the datatype buf_type is used.
*
* @param nLineSpace The byte offset from the start of one scanline in
* the buffer to the start of the next. If defaulted the size of the datatype
* buf_type * buf_xsize is used.
*
* @return CE_Failure if the access fails, otherwise CE_None.
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, byte[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Byte, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, byte[] array)
/**
* Write a region of image data for this band.
* <p>
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, short[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Int16, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, short[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, short[] array)
/**
* Write a region of image data for this band.
* <p>
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, int[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Int32, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, int[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int[] array)
/**
* Write a region of image data for this band.
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, float[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Float32, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, float[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, float[] array)
/**
* Write a region of image data for this band.
* <p>
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, byte[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
@hide public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace)
/**
* Write a region of image data for this band.
* <p>
* Same as below with nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_type, double[] array)
/**
* Write a region of image data for this band.
* <p>
* Same as below with buf_xsize == xsize, buf_ysize == ysize, buf_type == gdalconst.GDT_Float64, nPixelSpace == 0 and nLineSpace == 0
*
* @see #WriteRaster(int xoff, int yoff, int xsize, int ysize, int buf_xsize, int buf_ysize, int buf_type, double[] array, int nPixelSpace, int nLineSpace)
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteRaster(int xoff, int yoff, int xsize, int ysize, double[] array)
/**
* Read a block of image data efficiently.
* <p>
* This method accesses a "natural" block from the raster band without
* resampling, or data type conversion. For a more generalized, but
* potentially less efficient access use ReadRaster().
*
* @param nXBlockOff the horizontal block offset, with zero indicating
* the left most block, 1 the next block and so forth.
*
* @param nYBlockOff the vertical block offset, with zero indicating
* the left most block, 1 the next block and so forth.
*
* @param nioBuffer the buffer into which the data will be read. The buffer
* must be large enough to hold GetBlockXSize()*GetBlockYSize() words
* of type GetRasterDataType().
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on an error.
*
* @since Java bindings 1.7.0
*/
public class Band:public int ReadBlock_Direct(int nXBlockOff, int nYBlockOff, java.nio.ByteBuffer nioBuffer)
/**
* Write a block of image data efficiently.
* <p>
* This method accesses a "natural" block from the raster band without
* resampling, or data type conversion. For a more generalized, but
* potentially less efficient access use WriteRaster().
*
* @param nXBlockOff the horizontal block offset, with zero indicating
* the left most block, 1 the next block and so forth.
*
* @param nYBlockOff the vertical block offset, with zero indicating
* the left most block, 1 the next block and so forth.
*
* @param nioBuffer the buffer from which the data will be written. The buffer
* must be large enough to hold GetBlockXSize()*GetBlockYSize() words
* of type GetRasterDataType().
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on an error.
*
* @since Java bindings 1.7.0
*/
public class Band:public int WriteBlock_Direct(int nXBlockOff, int nYBlockOff, java.nio.ByteBuffer nioBuffer)
/**
* Set color interpretation of a band.
*
* @param eColorInterp the new color interpretation to apply to this band.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if method is unsupported by format.
*
* @since Java bindings 1.7.0
*/
public class Band:public int SetColorInterpretation(int eColorInterp)
/**
* Set color interpretation of a band.
*
* @param eColorInterp the new color interpretation to apply to this band.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if method is unsupported by format.
*/
public class Band:public int SetRasterColorInterpretation(int eColorInterp)
/**
* Set the raster color table.
*
* @param colorTable the color table to apply. This may be null to clear the color
* table (where supported).
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure on failure. If the action is
* unsupported by the driver, a value of CE_Failure is returned, but no
* error is issued.
*/
public class Band:public int SetColorTable(ColorTable colorTable)
/**
* Set the raster color table.
*
* @param colorTable the color table to apply. This may be null to clear the color
* table (where supported).
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure on failure. If the action is
* unsupported by the driver, a value of CE_Failure is returned, but no
* error is issued.
*/
public class Band:public int SetRasterColorTable(ColorTable colorTable)
/**
* Set default histogram
*
* @since Java bindings 1.7.0
*/
public class Band:public int SetDefaultHistogram(double min, double max, int[] histogram)
/**
* Set default Raster Attribute Table.
* <p>
* Associates a default RAT with the band. If not implemented for the
* format a CPLE_NotSupported error will be issued.
*
* @param table the RAT to assign to the band.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if unsupported or otherwise
* failing.
*/
public class Band:public int SetDefaultRAT(RasterAttributeTable table)
/**
* Set the no data value for this band.
* <p>
* To clear the nodata value, just set it with an "out of range" value.
* Complex band no data values must have an imagery component of zero.
*
* @param nodataValue the value to set.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure on failure. If unsupported
* by the driver, CE_Failure is returned by no error message will have
* been emitted.
*/
public class Band:public int SetNoDataValue(double nodataValue)
/**
* Set scaling offset.
* <p>
* Very few formats implement this method.
* When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
*
* @param newoffset the new offset.
*
* @return gdalconst.CE_None or success or gdalconst.CE_Failure on failure.
*
* @since Java bindings 1.8.0
*/
public class Band:public int SetOffset(double newoffset)
/**
* Set scaling ratio.
* <p>
* Very few formats implement this method.
* When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
*
* @param newscale the new scale.
*
* @return gdalconst.CE_None or success or gdalconst.CE_Failure on failure.
*
* @since Java bindings 1.8.0
*/
public class Band:public int SetScale(double newscale)
/**
* Set unit type.
* <p>
* Set the unit type for a raster band. Values should be one of
* "" (the default indicating it is unknown), "m" indicating meters,
* or "ft" indicating feet, though other nonstandard values are allowed.
*
* @param newunittype the new unit type value.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if not succuessful, or
* unsupported.
*
* @since Java bindings 1.8.0
*/
public class Band:public int SetUnitType(String newunittype)
/**
* Set the category names for this band.
* <p>
* See the GetCategoryNames() method for more on the interpretation of
* category names.
*
* @param names a vector of strings with category names. May
* be ,ull to just clear the existing list.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure on failure. If unsupported
* by the driver, CE_Failure is returned by no error message will have
* been emitted.
*
* @since GDAL 1.9.0
*/
public class Band:public int SetCategoryNames(java.util.Vector names)
/**
* Set the category names for this band.
* <p>
* See the GetCategoryNames() method for more on the interpretation of
* category names.
*
* @param names a vector of strings with category names. May
* be ,ull to just clear the existing list.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure on failure. If unsupported
* by the driver, CE_Failure is returned by no error message will have
* been emitted.
*/
public class Band:public int SetRasterCategoryNames(java.util.Vector names)
/**
* Set statistics on band.
* <p>
* This method can be used to store min/max/mean/standard deviation
* statistics on a raster band.
* <p>
* The default implementation stores them as metadata, and will only work
* on formats that can save arbitrary metadata. This method cannot detect
* whether metadata will be properly saved and so may return CE_None even
* if the statistics will never be saved.
*
* @param min minimum pixel value.
*
* @param max maximum pixel value.
*
* @param mean mean (average) of all pixel values.
*
* @param stddev Standard deviation of all pixel values.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure on failure.
*/
public class Band:public int SetStatistics(double min, double max, double mean, double stddev)
/* Class RasterAttributeTable */
/**
* The RasterAttributeTable (or RAT) class is used to encapsulate a table
* used to provide attribute information about pixel values. Each row
* in the table applies to a range of pixel values (or a single value in
* some cases), and might have attributes such as the histogram count for
* that range, the color pixels of that range should be drawn names of classes
* or any other generic information.
*
* <p>
* The RasterAttributeTable class is a binding for the C++ <a href="http://gdal.org/classGDALRasterAttributeTable.html">GDALRasterAttributeTable</a> class.
* <p>
* Raster attribute tables can be used to represent histograms, color tables,
* and classification information.
* <p>
* Each column in a raster attribute table has a name, a type (integer,
* floating point or string), and a GDALRATFieldUsage. The usage distinguishes
* columns with particular understood purposes (such as color, histogram
* count, name) and columns that have specific purposes not understood by
* the library (long label, suitability_for_growing_wheat, etc).
* <p>
* In the general case each row has a column indicating the minimum pixel
* values falling into that category, and a column indicating the maximum
* pixel value. These are indicated with usage values of GFU_Min, and
* GFU_Max. In other cases where each row is a discrete pixel value, one
* column of usage GFU_MinMax can be used.
* <p>
* In other cases all the categories are of equal size and regularly spaced
* and the categorization information can be determine just by knowing the
* value at which the categories start, and the size of a category. This
* is called "Linear Binning" and the information is kept specially on
* the raster attribute table as a whole.
* <p>
* RATs are normally associated with Bands and be be queried
* using the Band.GetDefaultRAT() method.
*/
public class RasterAttributeTable
/**
* Construct empty table.
*/
public class RasterAttributeTable:public RasterAttributeTable()
/**
* Copy Raster Attribute Table.
* <p>
* Creates a new copy of an existing raster attribute table.
*
* @return new copy of the RAT.
*/
public class RasterAttributeTable:public RasterAttributeTable Clone()
/**
* Create new column.
* <p>
* If the table already has rows, all row values for the new column will
* be initialized to the default value ("", or zero). The new column is
* always created as the last column, can will be column (field)
* "GetColumnCount()-1" after CreateColumn() has completed successfully.
*
* @param name the name of the field to create.
* @param eFieldType the field type (integer, double or string).
* @param eFieldUsage the field usage, GFU_Generic if not known.
*
* @return gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
*/
public class RasterAttributeTable:public int CreateColumn(String name, int eFieldType, int eFieldUsage)
/**
* Fetch column index for given usage.
* <p>
* Returns the index of the first column of the requested usage type, or -1
* if no match is found.
*
* @param eUsage usage type to search for.
*
* @return column index, or -1 on failure.
*/
public class RasterAttributeTable:public int GetColOfUsage(int eUsage)
/**
* Fetch table column count.
*
* @return the number of columns.
*/
public class RasterAttributeTable:public int GetColumnCount()
/**
* Get linear binning information.
* <p>
* Returns linear binning information if any is associated with the RAT.
*
* @param pdfRow0Min (out) array of 1 double that will contain the lower bound (pixel value) of the first category.
* @param pdfBinSize (out) array of 1 double that will contain the width of each category (in pixel value units).
*
* @return true if linear binning information exists or false if there is none.
*
* @since Java bindings 1.7.0
*/
public class RasterAttributeTable:public boolean GetLinearBinning(double[] pdfRow0Min, double[] pdfBinSize)
/**
* Fetch name of indicated column.
*
* @param iCol the column index (zero based).
*
* @return the column name or an empty string for invalid column numbers.
*/
public class RasterAttributeTable:public String GetNameOfCol(int iCol)
/**
* Fetch row count.
*
* @return the number of rows.
*/
public class RasterAttributeTable:public int GetRowCount()
/**
* Get row for pixel value.
* <p>
* Given a raw pixel value, the raster attribute table is scanned to
* determine which row in the table applies to the pixel value. The
* row index is returned.
*
* @param dfValue the pixel value.
*
* @return the row index or -1 if no row is appropriate.
*/
public class RasterAttributeTable:public int GetRowOfValue(double dfValue)
/**
* Fetch color type.
*
* @param iCol the column index (zero based).
*
* @return column type or GFT_Integer if the column index is illegal.
*/
public class RasterAttributeTable:public int GetTypeOfCol(int iCol)
/**
* Fetch column usage value.
*
* @param iCol the column index (zero based).
*
* @return the column usage, or GFU_Generic for improper column numbers.
*/
public class RasterAttributeTable:public int GetUsageOfCol(int iCol)
/**
* Fetch field value as a double.
* <p>
* The value of the requested column in the requested row is returned
* as a double. Non double fields will be converted to double with
* the possibility of data loss.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
*
* @return field value
*/
public class RasterAttributeTable:public double GetValueAsDouble(int iRow, int iCol)
/**
* Fetch field value as a integer.
* <p>
* The value of the requested column in the requested row is returned
* as an integer. Non-integer fields will be converted to integer with
* the possibility of data loss.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
*
* @return field value
*/
public class RasterAttributeTable:public int GetValueAsInt(int iRow, int iCol)
/**
* Fetch field value as a string.
* <p>
* The value of the requested column in the requested row is returned
* as a string. If the field is numeric, it is formatted as a string
* using default rules, so some precision may be lost.
* except it returns a "const char *" result.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
*
* @return field value
*/
public class RasterAttributeTable:public String GetValueAsString(int iRow, int iCol)
/**
* Set linear binning information.
* <p>
* For RATs with equal sized categories (in pixel value space) that are
* evenly spaced, this method may be used to associate the linear binning
* information with the table.
*
* @param dfRow0Min the lower bound (pixel value) of the first category.
* @param dfBinSize the width of each category (in pixel value units).
*
* @return CE_None on success or CE_Failure on failure.
*
* @since Java bindings 1.7.0
*/
public class RasterAttributeTable:public int SetLinearBinning(double dfRow0Min, double dfBinSize)
/**
* Set row count.
* <p>
* Resizes the table to include the indicated number of rows. Newly created
* rows will be initialized to their default values - "" for strings,
* and zero for numeric fields.
*
* @param nCount the new number of rows.
*/
public class RasterAttributeTable:public void SetRowCount(int nCount)
/**
* Set field value from double.
* <p>
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
* @param dfValue the value to assign.
*/
public class RasterAttributeTable:public void SetValueAsDouble(int iRow, int iCol, double dfValue)
/**
* Set field value from integer.
* <p>
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
* @param nValue the value to assign.
*/
public class RasterAttributeTable:public void SetValueAsInt(int iRow, int iCol, int nValue)
/**
* Set field value from string.
* <p>
* The indicated field (column) on the indicated row is set from the
* passed value. The value will be automatically converted for other field
* types, with a possible loss of precision.
*
* @param iRow row to fetch (zero based).
* @param iCol column to fetch (zero based).
* @param pszValue the value to assign.
*/
public class RasterAttributeTable:public void SetValueAsString(int iRow, int iCol, String pszValue)
/* Class Driver */
/**
* Class Driver is an uninstanciable class providing various methods for a format specific driver.
*
* <p>
* The Driver class is a binding for the C++ <a href="http://gdal.org/classGDALDriver.html">GDALDriver</a> class.
* <p>
* An instance of this class is created for each supported format, and manages information about the format.
* This roughly corresponds to a file format, though some drivers may be gateways to many formats through a secondary multi-library.
* <p>
* Drivers are loaded and registered with the gdal.<a href="./gdal.html#AllRegister()">AllRegister()</a> method
*/
public class org.gdal.gdal.Driver
/**
* @deprecated Do not do anything...
*/
public class org.gdal.gdal.Driver:public void delete()
/**
* Create a new dataset with this driver.
* <p>
* What argument values are legal for particular drivers is driver specific,
* and there is no way to query in advance to establish legal values (except
* querying driver.GetMetadataItem(gdalconst.DMD_CREATIONOPTIONLIST)
* <p>
* That function will try to validate the creation option list passed to the driver
* with the GDALValidateCreationOptions() method. This check can be disabled
* by defining the configuration option GDAL_VALIDATE_CREATION_OPTIONS=NO.
* <p>
* At the end of dataset manipulation, the delete() method <b>must</b> be called
* on the returned dataset otherwise data might not be properly flushed to the disk.
*
* @param name the name of the dataset to create.
* @param xsize width of created raster in pixels.
* @param ysize height of created raster in pixels.
* @param nBands number of bands.
* @param eType type of raster.
* @param options list of driver specific control parameters (may be null)
*
* @return null on failure, or a Dataset object
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
/**
* Create a new dataset with this driver.
* <p>
* Same as below but options are passed as a Vector of String.
*
* @see #Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize, int nBands, int eType, java.util.Vector options)
/**
* Create a new dataset with this driver.
* <p>
* Same as below with eType == gdalconst.GDT_Byte
*
* @see #Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize, int nBands, String[] options)
/**
* Create a new dataset with this driver.
* <p>
* Same as below with options == null
*
* @see #Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize, int nBands, int eType)
/**
* Create a new dataset with this driver.
* <p>
* Same as below with eType == gdalconst.GDT_Byte and options == null
*
* @see #Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize, int nBands)
/**
* Create a new dataset with this driver.
* <p>
* Same as below with nbands == 1, eType == gdalconst.GDT_Byte and options == null
*
* @see #Create(String name, int xsize, int ysize, int nBands, int eType, String[] options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset Create(String name, int xsize, int ysize)
/**
* Create a copy of a dataset.
* <p>
* This method will attempt to create a copy of a raster dataset with the
* indicated filename, and in this drivers format. Band number, size,
* type, projection, geotransform and so forth are all to be copied from
* the provided template dataset.
* <p>
* Note that many sequential write once formats (such as JPEG and PNG) don't
* implement the Create() method but do implement this CreateCopy() method.
* If the driver doesn't implement CreateCopy(), but does implement Create()
* then the default CreateCopy() mechanism built on calling Create() will
* be used.
* <p>
* It is intended that CreateCopy() will often be used with a source dataset
* which is a virtual dataset allowing configuration of band types, and
* other information without actually duplicating raster data (see the VRT driver).
* This is what is done by the gdal_translate utility for example.
* <p>
* That function will try to validate the creation option list passed to the driver
* with the GDALValidateCreationOptions() method. This check can be disabled
* by defining the configuration option GDAL_VALIDATE_CREATION_OPTIONS=NO.
* <p>
* At the end of dataset manipulation, the delete() method <b>must</b> be called
* on the returned dataset otherwise data might not be properly flushed to the disk.
*
* @param name the name for the new dataset.
* @param src_ds the dataset being duplicated.
* @param strict 1 if the copy must be strictly equivalent, or more
* normally 0 indicating that the copy may adapt as needed for the
* output format.
* @param options additional format dependent options controlling
* creation of the output file.
* @param callback for reporting algorithm progress. May be null
*
* @return the newly created dataset (may be read-only access).
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
/**
* Create a copy of a dataset.
* <p>
* Same as below with callback == null
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options)
/**
* Create a copy of a dataset.
* <p>
* Same as below with strict == 1 and callback == null
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, Vector options)
/**
* Create a copy of a dataset.
* <p>
* Same as below with options == null and callback == null
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, int strict)
/**
* Create a copy of a dataset.
* <p>
* Same as below with strict == 1, options == null and callback == null
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds)
/**
* Create a copy of a dataset.
* <p>
* Same as below with callback == null and options as an array of strings
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, int strict, String[] options)
/**
* Create a copy of a dataset.
* <p>
* Same as below with strict == 1, callback == null and options as an array of strings
*
* @see #CreateCopy(String name, Dataset src_ds, int strict, java.util.Vector options, ProgressCallback callback)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.gdal.Driver:public Dataset CreateCopy(String name, Dataset src_ds, String[] options)
/**
* Delete named dataset.
* <p>
* The driver will attempt to delete the named dataset in a driver specific
* fashion. Full featured drivers will delete all associated files,
* database objects, or whatever is appropriate. The default behavior when
* no driver specific behavior is provided is to attempt to delete the
* passed name as a single file.
* <p>
* It is unwise to have open dataset handles on this dataset when it is
* deleted.
*
* @param name name of dataset to delete.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure if the operation fails.
*/
public class org.gdal.gdal.Driver:public int Delete(String name)
/**
* Rename a dataset.
* <p>
* Rename a dataset. This may including moving the dataset to a new directory
* or even a new filesystem.
* <p>
* It is unwise to have open dataset handles on this dataset when it is
* being renamed.
*
* @param newName new name for the dataset.
* @param oldName old name for the dataset.
*
* @return gdalconst.CE_None on success, or gdalconst.CE_Failure if the operation fails.
*/
public class org.gdal.gdal.Driver:public int Rename(String newName, String oldName)
/**
* Register a driver for use.
* <p>
* Normally this method is used by format specific C callable registration
* entry points such as GDALRegister_GTiff() rather than being called
* directly by application level code.
* <p>
* If this driver is already
* registered, then no change is made, and the index of the existing driver
* is returned. Otherwise the driver list is extended, and the new driver
* is added at the end.
*
* @return the index of the new installed driver.
*/
public class org.gdal.gdal.Driver:public int Register()
/**
* Deregister the driver.
*/
public class org.gdal.gdal.Driver:public void Deregister()
/**
* Return the short name of a driver.
* <p>
* This is the string that can be
* passed to the GDALGetDriverByName() function.
* <p>
* For the GeoTIFF driver, this is "GTiff"
*
* @return the short name of the driver.
*/
public class org.gdal.gdal.Driver:public String getShortName()
/**
* Return the long name of a driver.
* <p>
* For the GeoTIFF driver, this is "GeoTIFF"
*
* @return the long name of the driver or empty string.
*/
public class org.gdal.gdal.Driver:public String getLongName()
/**
* Return the URL to the help that describes the driver.
* <p>
* That URL is relative to the GDAL documentation directory.
* <p>
* For the GeoTIFF driver, this is "frmt_gtiff.html"
*
* @return the URL to the help that describes the driver or null
*/
public class org.gdal.gdal.Driver:public String getHelpTopic()
/* Class ProgressCallback */
/**
* Class used to report progression of long operations.
* <p>
* This class will not do anything by itself, but it can be subclassed, like <a href="TermProgressCallback.html">TermProgressCallback</a> class.
* to do more useful things.
*
* @since Java bindings 1.7.0
*/
public class ProgressCallback
/**
* Callback method called from long processing from GDAL methods.
* <p>
* This method is called back with the progression percentage. Its return value
* is used by the caller to determine whether the processing should go on or be
* interrupted.
* <p>
* This method should be subclassed by classes subclassing ProgressCallback.
*
* @param dfComplete progression percentage between 0 and 1
* @param message processing message, may be null
*
* @return 0 if you want to interrupt the processing, any value different from 0 to go on
*
* @since Java bindings 1.7.0
*/
public class ProgressCallback:public int run(double dfComplete, String message)
/* Class TermProgressCallback */
/**
* Class used for simple progress report to terminal.
* <p>
* This progress reporter prints simple progress report to the
* terminal window. The progress report generally looks something like
* this:
* <pre>
* 0...10...20...30...40...50...60...70...80...90...100 - done.
* </pre>
* Every 2.5% of progress another number or period is emitted. Note that
* GDALTermProgress() uses internal static data to keep track of the last
* percentage reported and will get confused if two terminal based progress
* reportings are active at the same time either in in a single thread or across multiple threads.
* <p>
* Example :
* <pre>
* driver.CreateCopy("dest.tif", src_ds, 0, null, new TermProgressCallback());
* </pre>
*
* @since Java bindings 1.7.0
*/
public class TermProgressCallback
/* Class MajorObject */
/**
* Class used for object with metadata.
*
* <p>
* The MajorObject class is a binding for the C++ <a href="http://gdal.org/classGDALMajorObject.html">GDALMajorObject</a> class.
*/
public class MajorObject
/**
* Fetch object description.
* <p>
* The semantics of the returned description are specific to the derived
* type. For Dataset object it is the dataset name. For Band object
* it is actually a description (if supported) or "".
*
* @return description
*/
public class MajorObject:public String GetDescription()
/**
* Set object description.
* <p>
* The semantics of the returned description are specific to the derived
* type. For Dataset object it is the dataset name. For Band object
* it is actually a description (if supported) or "".
*
* Normally application code should not set the "description" for
* GDALDatasets. It is handled internally.
*
* @param newDescription new description
*/
public class MajorObject:public void SetDescription(String newDescription)
/**
* Fetch metadata.
*
* Returns metadata as (key, value) tuples in the result table
*
* @param domain the domain of interest. Use "" or null for the default
* domain.
*
* @return null or a hash table with metadata
*/
public class MajorObject:public java.util.Hashtable GetMetadata_Dict(String domain)
/**
* Fetch metadata.
*
* Returns metadata from the default domain as (key, value) tuples in the result table
*
* @return null or a hash table with metadata
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public java.util.Hashtable GetMetadata_Dict()
/**
* Fetch metadata.
*
* Returns metadata as a vector of strings of the format "KEY=VALUE".
*
* @param domain the domain of interest. Use "" or null for the default
* domain.
*
* @return null or a vector of strings
*/
public class MajorObject:public java.util.Vector GetMetadata_List(String domain)
/**
* Fetch metadata.
* <p>
* Returns metadata from the default domain as a vector of strings of the format "KEY=VALUE".
*
* @return null or a vector of strings
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public java.util.Vector GetMetadata_List()
/**
* Set metadata.
* <p>
* The metadata is set into the domain specified.
*
* @param metadata the metadata as a table of (key, value) tuples to apply
* @param domain the domain of interest. Use "" or null for the default
* domain.
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*/
public class MajorObject:public int SetMetadata(java.util.Hashtable metadata, String domain)
/**
* Set metadata.
* <p>
* The metadata is set into the default domain
*
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public int SetMetadata(java.util.Hashtable metadata)
/**
* Set metadata.
* <p>
* The metadata is set into the domain specified.
*
* @param metadataString the metadata to apply as a string of the format "KEY=VALUE".
* @param domain the domain of interest. Use "" or null for the default
* domain.
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*/
public class MajorObject:public int SetMetadata(String metadataString, String domain)
/**
* Set metadata.
* <p>
* The metadata is set into the default domain
*
* @param metadataString the metadata to apply as a string of the format "KEY=VALUE".
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public int SetMetadata(String metadataString)
/**
* Set metadata.
* <p>
* The metadata is set into the domain specified.
*
* @param metadata the metadata to apply as a vector of strings of the format "KEY=VALUE".
* @param domain the domain of interest. Use "" or null for the default
* domain.
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public int SetMetadata(java.util.Vector metadata, String domain)
/**
* Set metadata.
* <p>
* The metadata is set into the default domain
*
* @param metadata the metadata to apply as a vector of strings of the format "KEY=VALUE".
* @return gdalconst.CE_None on success, gdalconst.CE_Failure on failure and gdalconst.CE_Warning if the
* metadata has been accepted, but is likely not maintained persistently
* by the underlying object between sessions.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public int SetMetadata(java.util.Vector metadata)
/**
* Fetch single metadata item.
*
* @param name the key for the metadata item to fetch.
* @param domain the domain to fetch for, use null for the default domain.
*
* @return null on failure to find the key, or the value string on success.
*/
public class MajorObject:public String GetMetadataItem( String name, String domain )
/**
* Fetch single metadata item.
* <p>
* The metadata item is searched into the default domain.
*
* @param name the key for the metadata item to fetch.
*
* @return null on failure to find the key, or the value string on success.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public String GetMetadataItem( String name )
/**
* Set single metadata item.
*
* @param name the key for the metadata item to fetch.
* @param value the value to assign to the key.
* @param domain the domain to set within, use null for the default domain.
*
* @return gdalconst.CE_None on success, or an error code on failure.
*/
public class MajorObject:public int SetMetadataItem( String name, String value, String domain )
/**
* Set single metadata item.
* <p>
* The metadata item is set into the default domain.
*
* @param name the key for the metadata item to fetch.
* @param value the value to assign to the key.
*
* @return gdalconst.CE_None on success, or an error code on failure.
*
* @since Java bindings 1.7.0
*/
public class MajorObject:public int SetMetadataItem( String name, String value )
/* Class Transformer */
/**
* Class used for image to image transformer.
*/
public class Transformer
/**
* Create image to image transformer.
* <p>
* This function creates a transformation object that maps from pixel/line
* coordinates on one image to pixel/line coordinates on another image. The
* images may potentially be georeferenced in different coordinate systems,
* and may used GCPs to map between their pixel/line coordinates and
* georeferenced coordinates (as opposed to the default assumption that their
* geotransform should be used).
* <p>
* This transformer potentially performs three concatenated transformations.
* <p>
* The first stage is from source image pixel/line coordinates to source
* image georeferenced coordinates, and may be done using the geotransform,
* or if not defined using a polynomial model derived from GCPs. If GCPs
* are used this stage is accomplished using GDALGCPTransform().
* <p>
* The second stage is to change projections from the source coordinate system
* to the destination coordinate system, assuming they differ. This is
* accomplished internally using GDALReprojectionTransform().
* <p>
* The third stage is converting from destination image georeferenced
* coordinates to destination image coordinates. This is done using the
* destination image geotransform, or if not available, using a polynomial
* model derived from GCPs. If GCPs are used this stage is accomplished using
* GDALGCPTransform(). This stage is skipped if dst_ds is null when the
* transformation is created.
*
* Supported Options:
* <ul>
* <li> SRC_SRS: WKT SRS to be used as an override for src_ds.
* <li> DST_SRS: WKT SRS to be used as an override for dst_ds.
* <li> GCPS_OK: If FALSE, GCPs will not be used, default is TRUE.
* <li> MAX_GCP_ORDER: the maximum order to use for GCP derived polynomials if
* possible. The default is to autoselect based on the number of GCPs.
* A value of -1 triggers use of Thin Plate Spline instead of polynomials.
* <li> METHOD: may have a value which is one of GEOTRANSFORM, GCP_POLYNOMIAL,
* GCP_TPS, GEOLOC_ARRAY, RPC to force only one geolocation method to be
* considered on the source dataset.
* <li> RPC_HEIGHT: A fixed height to be used with RPC calculations.
* <li> RPC_DEM: The name of a DEM file to be used with RPC calculations.
* </ul>
*
* @param src_ds source dataset, or null.
* @param dst_ds destination dataset (or null).
* @param options options provides as a vector of strings of the format "NAME=VALUE" (or null)
*/
public class Transformer:public Transformer(Dataset src_ds, Dataset dst_ds, java.util.Vector options)
/**
* Transform a 3D point.
* <p>
* The method will use the provided 3 double values and update them.
*
* @param inout array of 3 double values (x, y, z) used for input and output.
* @param bDstToSrc 1 for inverse transformation, 0 for forward transformation.
* @return 1 on success, 0 otherwise
*/
public class Transformer:public int TransformPoint(int bDstToSrc, double[] inout)
/**
* Transform a 3D point.
* <p>
* The method will use the provided (x, y, z) values and put the transformed
* values into argout
*
* @param argout array of 3 double values where the transformed coordinates will be put.
* @param bDstToSrc 1 for inverse transformation, 0 for forward transformation.
* @param x input x value
* @param y input y value
* @param z input z value
* @return 1 on success, 0 otherwise
*/
public class Transformer:public int TransformPoint(double[] argout, int bDstToSrc, double x, double y, double z)
/**
* Transform a 2D point.
* <p>
* The method will use the provided (x, y) values and put the transformed
* values into argout
*
* @param argout array of <b>3</b> double values where the transformed coordinates will be put.
* @param bDstToSrc 1 for inverse transformation, 0 for forward transformation.
* @param x input x value
* @param y input y value
* @return 1 on success, 0 otherwise
*
* @since Java bindings 1.7.0
*/
public class Transformer:public int TransformPoint(double[] argout, int bDstToSrc, double x, double y)
/**
* Transform an array of coordinates.
* <p>
* The method will use the provided array of values and put the update coordinates
* into it.
*
* @param arrayOfCoords array of 2D or 3D values.
* @param bDstToSrc 1 for inverse transformation, 0 for forward transformation.
* @param panSuccess array where to put the success flag for each transformation.
* May be null, otherwise panSuccess.length must be equal to arrayOfCoords.length
*
* @return 1 on success, 0 otherwise
*
* @since Java bindings 1.7.0
*/
public class Transformer:public int TransformPoints(int bDstToSrc, double[][] arrayOfCoords, int[] panSuccess)
/* Interface gdalconstConstants */
/**
* Various constants used by the org.gdal.gdal package.
* <p>
* These constants correspond to different enumerations : error codes, XML content type, metadata, palette interpretation,
* color interpretation, data type, raster color table attribute type, band mask flags, resampling methods...
*/
public interface gdalconstConstants
/**
* Debug error == 1 (message class).
*/
public interface gdalconstConstants:public final static int CE_Debug
/**
* Failure error == 3 (message class and error return code).
*/
public interface gdalconstConstants:public final static int CE_Failure
/**
* Fatal error == 4 (message class).
*/
public interface gdalconstConstants:public final static int CE_Fatal
/**
* No error == 0 (message class and error return code).
*/
public interface gdalconstConstants:public final static int CE_None
/**
* Warning error == 2 (message class and error return code).
*/
public interface gdalconstConstants:public final static int CE_Warning
/**
* CPLE_None == 0 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_None
/**
* CPLE_AppDefined == 1 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_AppDefined
/**
* CPLE_OutOfMemory == 2 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_OutOfMemory
/**
* CPLE_FileIO == 3 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_FileIO
/**
* CPLE_OpenFailed == 4 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_OpenFailed
/**
* CPLE_IllegalArg == 5 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_IllegalArg
/**
* CPLE_NotSupported == 6 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_NotSupported
/**
* CPLE_AssertionFailed == 7 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_AssertionFailed
/**
* CPLE_NoWriteAccess == 8 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_NoWriteAccess
/**
* CPLE_UserInterrupt == 9 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_UserInterrupt
/**
* CPLE_ObjectNull == 10 (error code).
*/
public interface gdalconstConstants:public final static int CPLE_ObjectNull
/**
* CPLES_BackslashQuotable(0).
* <p>
* This scheme turns a binary string into
* a form suitable to be placed within double quotes as a string constant.
* The backslash, quote, '\\0' and newline characters are all escaped in
* the usual C style.
*/
public interface gdalconstConstants:public final static int CPLES_BackslashQuotable
/**
* CPLES_XML(1).
* <p>
* This scheme converts the '<', '>' and '&' characters into
* their XML/HTML equivalent (&gt;, &lt; and &amp;) making a string safe
* to embed as CDATA within an XML element. The '\\0' is not escaped and
* should not be included in the input.
*/
public interface gdalconstConstants:public final static int CPLES_XML
/**
* CPLES_URL(2).
* <p>
* Everything except alphanumerics and the underscore are
* converted to a percent followed by a two digit hex encoding of the character
* (leading zero supplied if needed). This is the mechanism used for encoding
* values to be passed in URLs.
*/
public interface gdalconstConstants:public final static int CPLES_URL
/**
* CPLES_SQL(3).
* <p>
* All single quotes are replaced with two single quotes.
* Suitable for use when constructing literal values for SQL commands where
* the literal will be enclosed in single quotes.
*/
public interface gdalconstConstants:public final static int CPLES_SQL
/**
* CPLES_CSV(4).
* <p>
* If the values contains commas, double quotes, or newlines it
* placed in double quotes, and double quotes in the value are doubled.
* Suitable for use when constructing field values for .csv files. Note that
* CPLUnescapeString() currently does not support this format, only
* CPLEscapeString(). See cpl_csv.cpp for csv parsing support.
*/
public interface gdalconstConstants:public final static int CPLES_CSV
/**
* CTX_Element(0) : node is an element.
*/
public interface gdalconstConstants:public final static int CXT_Element
/**
* CXT_Text(1) : node is a raw text value
*/
public interface gdalconstConstants:public final static int CXT_Text
/**
* CXT_Attribute(2) : node is an attribute.
*/
public interface gdalconstConstants:public final static int CXT_Attribute
/**
* CXT_Comment(3) : node is a XML comment.
*/
public interface gdalconstConstants:public final static int CXT_Comment
/**
* CXT_Literal(4) : node is a special literal.
*/
public interface gdalconstConstants:public final static int CXT_Literal
/**
* DCAP_CREATE_COPY.
* Driver.GetMetadataItem(gdalconst.DCAP_CREATE) will return "YES" if the driver supports the Create() method
*/
public interface gdalconstConstants:public final static String DCAP_CREATE
/**
* DCAP_CREATE_COPY.
* Driver.GetMetadataItem(gdalconst.DCAP_CREATE_COPY) will return "YES" if the driver supports the CreateCopy() method
*/
public interface gdalconstConstants:public final static String DCAP_CREATECOPY
/**
* DCAP_VIRTUALIO.
* Driver.GetMetadataItem(gdalconst.DCAP_VIRTUALIO) will return "YES" if the driver supports virtual file IO
*/
public interface gdalconstConstants:public final static String DCAP_VIRTUALIO
/**
* DMD_CREATIONDATATYPES.
* Driver.GetMetadataItem(gdalconst.DMD_CREATIONDATATYPES) will return a string with the supported data types in creation
*/
public interface gdalconstConstants:public final static String DMD_CREATIONDATATYPES
/**
* DMD_CREATIONOPTIONLIST.
* Driver.GetMetadataItem(gdalconst.DMD_CREATIONOPTIONLIST) will return a XML string with the definition of supported creation options
*/
public interface gdalconstConstants:public final static String DMD_CREATIONOPTIONLIST
/**
* DMD_EXTENSION.
* Driver.GetMetadataItem(gdalconst.DMD_EXTENSION) will return a string with the extensions supported by the driver
*/
public interface gdalconstConstants:public final static String DMD_EXTENSION
/**
* DMD_HELPTOPIC.
* Driver.GetMetadataItem(gdalconst.DMD_HELPTOPIC) will return a string with the URL to driver documentation
*/
public interface gdalconstConstants:public final static String DMD_HELPTOPIC
/**
* DMD_LONGNAME.
* Driver.GetMetadataItem(gdalconst.DMD_LONGNAME) will return a string with the long name of the driver
*/
public interface gdalconstConstants:public final static String DMD_LONGNAME
/**
* DMD_MIMETYPE.
* Driver.GetMetadataItem(gdalconst.DMD_MIMETYPE) will return a string with the MIME type supported by the driver
*/
public interface gdalconstConstants:public final static String DMD_MIMETYPE
/**
* GA_ReadOnly : flag used for opening a dataset in read-only mode with gdal.Open()
*/
public interface gdalconstConstants:public final static int GA_ReadOnly
/**
* GA_Update : flag used for opening a dataset in update mode with gdal.Open()
*/
public interface gdalconstConstants:public final static int GA_Update
@hide public interface gdalconstConstants:public final static int GF_Read
@hide public interface gdalconstConstants:public final static int GF_Write
/**
* GCI_Undefined(0) : undefined (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_Undefined
/**
* GCI_GrayIndex(1) : greyscale (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_GrayIndex
/**
* GCI_PaletteIndex(2) : paletted with color table (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_PaletteIndex
/**
* GCI_RedBand(3) : Red band of RGBA image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_RedBand
/**
* GCI_GreenBand(4) : Green band of RGBA image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_GreenBand
/**
* GCI_BlueBand(5) : Blue band of RGBA image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_BlueBand
/**
* GCI_AlphaBand(6) : Alpha band of RGBA image (0=transparent, 255=opaque) (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_AlphaBand
/**
* GCI_HueBand(7) : Hue band of HLS image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_HueBand
/**
* GCI_SaturationBand(8) : Saturation band of HLS image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_SaturationBand
/**
* GCI_LightnessBand(9) : Lightness band of HLS image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_LightnessBand
/**
* GCI_CyanBand(10) : Cyan band of CMYK image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_CyanBand
/**
* GCI_MagentaBand(11) : Magenta band of CMYK image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_MagentaBand
/**
* GCI_YellowBand(12) : Yellow band of CMYK image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_YellowBand
/**
* GCI_BlackBand(13) : Black band of CMYK image (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_BlackBand
/**
* GCI_YCbCr_YBand(14) : Y Luminance (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_YCbCr_YBand
/**
* GCI_YCbCr_CbBand(15) : Cb Luminance (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_YCbCr_CbBand
/**
* GCI_YCbCr_CrBand(16) : Cr Luminance (color interpretation)
*/
public interface gdalconstConstants:public final static int GCI_YCbCr_CrBand
/**
* GDT_Unknown(0) : Unknown (data type)
*/
public interface gdalconstConstants:public final static int GDT_Unknown
/**
* GDT_Byte(1) : Eight bit unsigned integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_Byte
/**
* GDT_Int8(14) : Eight bit signed integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_Int8
/**
* GDT_UInt16(2) : Sixteen bit unsigned integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_UInt16
/**
* GDT_Int16(3) : Sixteen bit signed integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_Int16
/**
* GDT_UInt32(4) : Thirty two bit unsigned integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_UInt32
/**
* GDT_Int32(5) : Thirty two bit signed integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_Int32
/**
* GDT_UInt64(12) : 64 bit unsigned integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_UInt64
/**
* GDT_Int64(13) : 64 bit signed integer (data type)
*/
public interface gdalconstConstants:public final static int GDT_Int64
/**
* GDT_Float32(6) : Thirty two bit floating point (data type)
*/
public interface gdalconstConstants:public final static int GDT_Float32
/**
* GDT_Float64(7) : Sixty four bit floating point (data type)
*/
public interface gdalconstConstants:public final static int GDT_Float64
/**
* GDT_CInt16(8) : Complex Int16 (data type)
*/
public interface gdalconstConstants:public final static int GDT_CInt16
/**
* GDT_CInt32(9) : Complex Int32 (data type)
*/
public interface gdalconstConstants:public final static int GDT_CInt32
/**
* GDT_CFloat32(10) : Complex Float32 (data type)
*/
public interface gdalconstConstants:public final static int GDT_CFloat32
/**
* GDT_CFloat64(11) : Complex Float64 (data type)
*/
public interface gdalconstConstants:public final static int GDT_CFloat64
/**
* GDT_TypeCount(15) : Maximum type (data type)
*/
public interface gdalconstConstants:public final static int GDT_TypeCount
/**
* GRA_NearestNeighbour(0) : Nearest neighbour (select on one input pixel) (warping algorithm)
*/
public interface gdalconstConstants:public final static int GRA_NearestNeighbour
/**
* GRA_Bilinear(1) : Bilinear (2x2 kernel) (warping algorithm)
*/
public interface gdalconstConstants:public final static int GRA_Bilinear
/**
* GRA_Cubic(2) : Cubic Convolution Approximation (4x4 kernel) (warping algorithm)
*/
public interface gdalconstConstants:public final static int GRA_Cubic
/**
* GRA_CubicSpline(3) : Cubic B-Spline Approximation (4x4 kernel) (warping algorithm)
*/
public interface gdalconstConstants:public final static int GRA_CubicSpline
/**
* GRA_Lanczos(4) : Lanczos windowed sinc interpolation (6x6 kernel) (warping algorithm)
*/
public interface gdalconstConstants:public final static int GRA_Lanczos
/**
* GMF_ALL_VALID(0x01) (mask band flag).
* There are no invalid pixels, all mask values will be 255.
* When used this will normally be the only flag set.
*/
public interface gdalconstConstants:public final static int GMF_ALL_VALID
/**
* GMF_PER_DATASET(0x02) (mask band flag).
* The mask band is shared between all bands on the dataset.
*/
public interface gdalconstConstants:public final static int GMF_PER_DATASET
/**
* GMF_ALPHA(0x04) (mask band flag).
* The mask band is actually an alpha band and may have values
* other than 0 and 255.
*/
public interface gdalconstConstants:public final static int GMF_ALPHA
/**
* GMF_NODATA(0x08) (mask band flag).
* Indicates the mask is actually being generated from nodata values.
* (mutually exclusive of GMF_ALPHA)
*/
public interface gdalconstConstants:public final static int GMF_NODATA
/**
* GPI_Gray(0) (palette interpretation).
* Grayscale (in GDALColorEntry.c1)
*/
public interface gdalconstConstants:public final static int GPI_Gray
/**
* GPI_RGB(1) (palette interpretation).
* Red, Green, Blue and Alpha in (in c1, c2, c3 and c4)
*/
public interface gdalconstConstants:public final static int GPI_RGB
/**
* GPI_CMYK(2) (palette interpretation).
* Cyan, Magenta, Yellow and Black (in c1, c2, c3 and c4)
*/
public interface gdalconstConstants:public final static int GPI_CMYK
/**
* GPI_HLS(3) (palette interpretation).
* Hue, Lightness and Saturation (in c1, c2, and c3)
*/
public interface gdalconstConstants:public final static int GPI_HLS
/* Class Driver */
/**
* Class Driver is an uninstanciable class providing various methods to represents an operational format driver.
*
* <p>
* The Driver class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRSFDriver.html">OGRSFDriver</a> class.
*/
public class org.gdal.ogr.Driver
/**
* @deprecated Do not do anything...
*/
public class org.gdal.ogr.Driver:public void delete()
/**
Attempt to create a new data source based on the passed driver.
<p>
The papszOptions argument can be used to control driver specific
creation options. These options are normally documented in the format
specific documentation.
<p>
The returned dataset should be properly closed with the
DataSource.<a href="DataSource.html#delete()">delete()</a> method.
@param name the name for the new data source.
@param options a vector of strings of the format name=value. Options are driver
specific, and driver information can be found at the following url:
<a href="http://www.gdal.org/ogr/ogr_formats.html ">OGR Formats</a>
@return null is returned on failure, or a new DataSource on
success.
*/
public class org.gdal.ogr.Driver:public DataSource CreateDataSource(String name, java.util.Vector options)
/**
* Attempt to create a new data source based on the passed driver.
* <p>
* Same as below with options == null.
*
* @see #CreateDataSource(String name, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.ogr.Driver:public DataSource CreateDataSource(String name)
/**
Creates a new datasource by copying all the layers from the
source datasource.
@param src_ds source datasource
@param name the name for the new data source.
@param options a vector of strings of the format name=value. Options are driver
specific, and driver information can be found at the following url:
<a href="http://www.gdal.org/ogr/ogr_formats.html ">OGR Formats</a>
@return null is returned on failure, or a new DataSource on
success.
*/
public class org.gdal.ogr.Driver:public DataSource CopyDataSource(DataSource src_ds, String name, java.util.Vector options)
/**
* Creates a new datasource by copying all the layers from the
* source datasource.
* <p>
* Same as below with options == null.
*
* @see #CreateDataSource(String name, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.ogr.Driver:public DataSource CopyDataSource(DataSource src_ds, String name)
/**
Attempt to open file with this driver.
<p>
The returned dataset should be properly closed with the
DataSource.<a href="DataSource.html#delete()">delete()</a> method.
@param name the name of the file, or data source to try and open.
@param update 1 if update access is required, otherwise 0 (the
default).
@return null on error or if the pass name is not supported by this driver,
otherwise a DataSource.
*/
public class org.gdal.ogr.Driver:public DataSource Open(String name, int update)
/**
* Attempt to open file with this driver.
* <p>
* Same as below with update == 0.
*
* @see #Open(String name, int update)
*
* @since Java bindings 1.7.0
*/
public class org.gdal.ogr.Driver:public DataSource Open(String name)
/**
Destroy a datasource.
<p>
Destroy the named datasource. Normally it would be safest if the
datasource was not open at the time.
<p>
Whether this is a supported operation on this driver case be tested
using TestCapability() on ODrCDeleteDataSource.
@param name the name of the datasource to delete.
@return 0 on success. Otherwise throws a RuntimeException if this
is not supported by this driver (or an error code if DontUseExceptions() has been called)
*/
public class org.gdal.ogr.Driver:public int DeleteDataSource(String name)
/**
Test if capability is available.
<p>
One of the following data source capability names can be passed into this
function, and a TRUE or FALSE value will be returned indicating whether
or not the capability is available for this object.
<p>
<ul>
<li> <b>ODrCCreateDataSource</b>: True if this driver can support creating data sources.<p>
<li> <b>ODrCDeleteDataSource</b>: True if this driver supports deleting data sources.<p>
</ul>
<p>
The constant forms of the capability names should be used in preference
to the strings themselves to avoid misspelling.
@param cap the capability to test.
@return true if capability available otherwise false.
*/
public class org.gdal.ogr.Driver:public boolean TestCapability(String cap)
/**
Fetch name of driver (file format).
<p>
This name should be relatively short
(10-40 characters), and should reflect the underlying file format. For
instance "ESRI Shapefile".
@return driver name.
*/
public class org.gdal.ogr.Driver:public String getName()
/**
Fetch name of driver (file format).
<p>
This name should be relatively short
(10-40 characters), and should reflect the underlying file format. For
instance "ESRI Shapefile".
@return driver name.
*/
public class org.gdal.ogr.Driver:public String GetName()
/**
Add a driver to the list of registered drivers.
<p>
If the driver is already registered (based on handle comparison)
then the driver isn't registered. New drivers are added at the end of
the list of registered drivers.
@since GDAL 1.8.0
*/
public class org.gdal.ogr.Driver:public void Register()
/**
Remove the driver from the list of registered drivers.
@since GDAL 1.8.0
*/
public class org.gdal.ogr.Driver:public void Deregister()
/* Class DataSource */
/**
* This class represents a data source.
*
* <p>
* The DataSource class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRDataSource.html">OGRDataSource</a> class.
* <p>
* A data source potentially consists of many layers (<a href="Layer.html">Layer</a>). A data source normally consists of one, or a
* related set of files, though the name doesn't have to be a real item in the file system.
* When an DataSource is destroyed, all it's associated Layer objects are also destroyed.
*/
public class DataSource
/**
* Frees the native resource associated to a DataSource object and close the file.
* <p>
* This method will delete the underlying C++ object. After it has been called,
* all native resources will have been destroyed, so it will be illegal (and likely to
* cause JVM crashes) to use any method on this object or any derived objects,
* such as Layer objects of this Dataset.
* <p>
* The delete() method <b>must</b> be called when a datasource has been opened in update
* or creation mode, otherwise data might not be properly flushed to the disk. You
* cannot rely on the finalization to call delete().
*/
public class DataSource:public void delete()
/**
Duplicate an existing layer.
<p>
This function creates a new layer, duplicate the field definitions of the
source layer and then duplicate each features of the source layer.
The papszOptions argument
can be used to control driver specific creation options. These options are
normally documented in the format specific documentation.
The source layer may come from another dataset.
@param src_layer source layer.
@param new_name the name of the layer to create.
@param options a StringList of name=value options. Options are driver
specific, and driver information can be found at the following url:
<a href="http://www.gdal.org/ogr/ogr_formats.html ">OGR Formats</a>
@return a new layer, or null if an error occurs.
*/
public class DataSource:public Layer CopyLayer(Layer src_layer, String new_name, java.util.Vector options)
/**
* Duplicate an existing layer.
* <p>
* Same as below with options == null.
*
* @see #CopyLayer(Layer src_layer, String new_name, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer CopyLayer(Layer src_layer, String new_name)
/**
Create a new layer on the data source with the indicated name, coordinate system, geometry type.
<p>
The options argument
can be used to control driver specific creation options. These options are
normally documented in the format specific documentation.
<p>
Example:
<pre>
Layer layer;
Vector options = new Vector();
if( !ds.TestCapability( ogr.ODsCCreateLayer ) )
{
...
}
options.add("DIM=2");
layer = ds.CreateLayer( "NewLayer", null, ogr.wkbUnknown,
options );
if( layer == null )
{
...
}
</pre>
@param name the name for the new layer. This should ideally not
match any existing layer on the datasource.
@param srs the coordinate system to use for the new layer, or null if
no coordinate system is available.
@param geom_type the geometry type for the layer. Use ogr.wkbUnknown if there
are no constraints on the types geometry to be written.
@param options a vector of strings of the format name=value. Options are driver
specific, and driver information can be found at the following url:
<a href="http://www.gdal.org/ogr/ogr_formats.html ">OGR Formats</a>
@return null is returned on failure, or a new Layer on success.
*/
public class DataSource:public Layer CreateLayer(String name, SpatialReference srs, int geom_type, java.util.Vector options)
/**
* Create a new layer on the data source with the indicated name, coordinate system, geometry type.
* <p>
* Same as below with options == null.
*
* @see #CreateLayer(String name, SpatialReference srs, int geom_type, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer CreateLayer(String name, SpatialReference srs, int geom_type)
/**
* Create a new layer on the data source with the indicated name, coordinate system.
* <p>
* Same as below with geom_type == ogr.wkbUnknown and options == null.
*
* @see #CreateLayer(String name, SpatialReference srs, int geom_type, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer CreateLayer(String name, SpatialReference srs)
/**
* Create a new layer on the data source with the indicated name.
* <p>
* Same as below with srs == null, geom_type == ogr.wkbUnknown and options == null.
*
* @see #CreateLayer(String name, SpatialReference srs, int geom_type, java.util.Vector options)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer CreateLayer(String name)
/**
Delete the indicated layer from the datasource.
<p>
If this method is supported
the ODsCDeleteLayer capability will test true on the DataSource.
@param index the index of the layer to delete.
@return 0 on success. Otherwise throws a RuntimeException if deleting
layers is not supported for this datasource (or an error code if DontUseExceptions() has been called).
*/
public class DataSource:public int DeleteLayer(int index)
/**
Execute an SQL statement against the data store.
<p>
The result of an SQL query is either null for statements that are in error,
or that have no results set, or a Layer representing a results
set from the query. Note that this Layer is in addition to the layers
in the data store and must be destroyed with
ReleaseResultsSet() before the data source is closed (destroyed).
<p>
For more information on the SQL dialect supported internally by OGR
review the <a href="ogr_sql.html">OGR SQL</a> document. Some drivers (i.e.
Oracle and PostGIS) pass the SQL directly through to the underlying RDBMS.
@param statement the SQL statement to execute.
@param spatialFilter geometry which represents a spatial filter.
@param dialect allows control of the statement dialect. By default it
is assumed to be "generic" SQL, whatever that is.
@return a Layer containing the results of the query. Deallocate with
ReleaseResultsSet().
*/
public class DataSource:public Layer ExecuteSQL(String statement, Geometry spatialFilter, String dialect)
/**
* Execute an SQL statement against the data store.
* <p>
* Same as below with dialect = ""
*
* @see #ExecuteSQL(String statement, Geometry spatialFilter, String dialect)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer ExecuteSQL(String statement, Geometry spatialFilter)
/**
* Execute an SQL statement against the data store.
* <p>
* Same as below with spatialFilter == null and dialect = ""
*
* @see #ExecuteSQL(String statement, Geometry spatialFilter, String dialect)
*
* @since Java bindings 1.7.0
*/
public class DataSource:public Layer ExecuteSQL(String statement)
/**
Release results of ExecuteSQL().
<p>
This method should only be used to deallocate Layers resulting from
an ExecuteSQL() call on the same DataSource. Failure to deallocate a
results set before destroying the DataSource may cause errors.
@param layer the result of a previous ExecuteSQL() call.
*/
public class DataSource:public void ReleaseResultSet(Layer layer)
/**
Flush pending changes to disk.
<p>
This call is intended to force the datasource to flush any pending writes to
disk, and leave the disk file in a consistent state. It would not normally
have any effect on read-only datasources.
<p>
Some data sources do not implement this method, and will still return
ogr.OGRERR_NONE. An error is only returned if an error occurs while attempting
to flush to disk.
<p>
The default implementation of this method just calls the SyncToDisk() method
on each of the layers. Conceptually, calling SyncToDisk() on a datasource
should include any work that might be accomplished by calling SyncToDisk()
on layers in that data source.
<p>
In any event, you should always close any opened datasource with
delete() that will ensure all data is correctly flushed.
@return ogr.OGRERR_NONE if no error occurs (even if nothing is done) or an
error code.
*/
public class DataSource:public int SyncToDisk()
/**
Test if capability is available.
<p>
One of the following data source capability names can be passed into this
method, and a true or false value will be returned indicating whether or not
the capability is available for this object.
<p>
<ul>
<li> <b>ODsCCreateLayer</b>: True if this datasource can create new layers.<p>
<li> <b>ODsCDeleteLayer</b>: True if this datasource can delete existing layers.<p>
</ul>
<p>
The constant forms of the capability names should be used in preference
to the strings themselves to avoid misspelling.
@param cap the capability to test.
@return true if capability available otherwise false.
*/
public class DataSource:public boolean TestCapability(String cap)
/**
Fetch a layer by index.
<p>
The returned layer remains owned by the
DataSource and should not be deleted by the application.
@param index a layer number between 0 and GetLayerCount()-1.
@return the layer, or null if index is out of range or an error occurs.
*/
public class DataSource:public Layer GetLayerByIndex(int index)
/**
Fetch a layer by index.
<p>
The returned layer remains owned by the
DataSource and should not be deleted by the application.
@param index a layer number between 0 and GetLayerCount()-1.
@return the layer, or null if index is out of range or an error occurs.
@since Java bindings 1.7.0
*/
public class DataSource:public Layer GetLayer(int index)
/**
Fetch a layer by name.
<p>
The returned layer remains owned by the
DataSource and should not be deleted by the application.
@param layer_name the layer name of the layer to fetch.
@return the layer, or null if index is out of range or an error occurs.
*/
public class DataSource:public Layer GetLayerByName(String layer_name)
/**
Fetch a layer by name.
The returned layer remains owned by the
DataSource and should not be deleted by the application.
@param layer_name the layer name of the layer to fetch.
@return the layer, or null if index is out of range or an error occurs.
@since Java bindings 1.7.0
*/
public class DataSource:public Layer GetLayer(String layer_name)
/**
Get the number of layers in this data source.
@return layer count.
*/
public class DataSource:public int GetLayerCount()
/**
Returns the name of the data source.
<p>
This string should be sufficient to
open the data source if passed to the same Driver that this data
source was opened with, but it need not be exactly the same string that
was used to open the data source. Normally this is a filename.
@return name of the data source
*/
public class DataSource:public String GetName()
/**
Returns the name of the data source.
<p>
This string should be sufficient to
open the data source if passed to the same Driver that this data
source was opened with, but it need not be exactly the same string that
was used to open the data source. Normally this is a filename.
@return name of the data source
*/
public class DataSource:public String getName()
/**
Returns the driver that the dataset was opened with.
@return null if driver info is not available, or the driver
*/
public class DataSource:public Driver GetDriver()
/**
Fetch reference count.
@return the current reference count for the datasource object itself.
*/
public class DataSource:public int GetRefCount()
/**
Fetch reference count of datasource and all owned layers.
@return the current summary reference count for the datasource and its layers.
*/
public class DataSource:public int GetSummaryRefCount()
/* Class Layer */
/**
* This class represents a layer of simple features, with access methods.
*
* <p>
* The Layer class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRLayer.html">OGRLayer</a> class.
*/
public class Layer
/**
* @deprecated Do not do anything...
*/
public class Layer:public void delete()
/**
Create and write a new feature within a layer.
<p>
The passed feature is written to the layer as a new feature, rather than
overwriting an existing one. If the feature has a feature id other than
OGRNullFID, then the native implementation may use that as the feature id
of the new feature, but not necessarily. Upon successful return the
passed feature will have been updated with the new feature id.
@param feature the feature to write to disk.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@see #SetFeature(Feature)
*/
public class Layer:public int CreateFeature(Feature feature)
/**
Create a new field on a layer.
<p>
You must use this to create new fields
on a real layer. Internally the FeatureDefn for the layer will be updated
to reflect the new field. Applications should never modify the FeatureDefn
used by a layer directly.
<p>
This method should not be called while there are feature objects in existence that
were obtained or created with the previous layer definition.
<p>
Not all drivers support this method. You can query a layer to check if it supports it
with the OLCCreateField capability. Some drivers may only support this method while
there are still no features in the layer. When it is supported, the existing features of the
backing file/database should be updated accordingly.
@param field_def field definition to write to disk.
@param approx_ok If 1, the field may be created in a slightly different
form depending on the limitations of the format driver.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int CreateField(FieldDefn field_def, int approx_ok)
/**
* Create a new field on a layer.
*
* Same as below with approx_ok == 0.
*
* @see #CreateField(FieldDefn field_def, int approx_ok)
*/
public class Layer:public int CreateField(FieldDefn field_def)
/**
Delete an existing field on a layer.
<p>
You must use this to delete existing fields
on a real layer. Internally the FeatureDefn for the layer will be updated
to reflect the deleted field. Applications should never modify the FeatureDefn
used by a layer directly.
<p>
This method should not be called while there are feature objects in existence that
were obtained or created with the previous layer definition.
<p>
Not all drivers support this method. You can query a layer to check if it supports it
with the OLCDeleteField capability. Some drivers may only support this method while
there are still no features in the layer. When it is supported, the existing features of the
backing file/database should be updated accordingly.
@param iField index of the field to delete.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@since OGR 1.9.0
*/
public class Layer:public int DeleteField( int iField )
/**
Reorder all the fields of a layer.
<p>
You must use this to reorder existing fields
on a real layer. Internally the FeatureDefn for the layer will be updated
to reflect the reordering of the fields. Applications should never modify the FeatureDefn
used by a layer directly.
<p>
This method should not be called while there are feature objects in existence that
were obtained or created with the previous layer definition.
<p>
panMap is such that,for each field definition at position i after reordering,
its position before reordering was panMap[i].
<p>
For example, let suppose the fields were "0","1","2","3","4" initially.
ReorderFields(new Integer[]{0,2,3,1,4}) will reorder them as "0","2","3","1","4".
<p>
Not all drivers support this method. You can query a layer to check if it supports it
with the OLCReorderFields capability. Some drivers may only support this method while
there are still no features in the layer. When it is supported, the existing features of the
backing file/database should be updated accordingly.
@param panMap an array of GetLayerDefn().GetFieldCount() elements which
is a permutation of [0, GetLayerDefn().GetFieldCount()-1].
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@since OGR 1.9.0
*/
public class Layer:public int ReorderFields( int[] panMap )
/**
Reorder an existing field on a layer.
<p>
This method is a convenience wrapper of ReorderFields() dedicated to move a single field.
It is a non-virtual method, so drivers should implement ReorderFields() instead.
<p>
You must use this to reorder existing fields
on a real layer. Internally the FeatureDefn for the layer will be updated
to reflect the reordering of the fields. Applications should never modify the FeatureDefn
used by a layer directly.
<p>
This method should not be called while there are feature objects in existence that
were obtained or created with the previous layer definition.
<p>
The field definition that was at initial position iOldFieldPos will be moved at
position iNewFieldPos, and elements between will be shuffled accordingly.
<p>
For example, let suppose the fields were "0","1","2","3","4" initially.
ReorderField(1, 3) will reorder them as "0","2","3","1","4".
<p>
Not all drivers support this method. You can query a layer to check if it supports it
with the OLCReorderFields capability. Some drivers may only support this method while
there are still no features in the layer. When it is supported, the existing features of the
backing file/database should be updated accordingly.
@param iOldFieldPos previous position of the field to move. Must be in the range [0,GetFieldCount()-1].
@param iNewFieldPos new position of the field to move. Must be in the range [0,GetFieldCount()-1].
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@since OGR 1.9.0
*/
public class Layer:public int ReorderField( int iOldFieldPos, int iNewFieldPos )
/**
Alter the definition of an existing field on a layer.
<p>
You must use this to alter the definition of an existing field of a real layer.
Internally the FeatureDefn for the layer will be updated
to reflect the altered field. Applications should never modify the FeatureDefn
used by a layer directly.
<p>
This method should not be called while there are feature objects in existence that
were obtained or created with the previous layer definition.
<p>
Not all drivers support this method. You can query a layer to check if it supports it
with the OLCAlterFieldDefn capability. Some drivers may only support this method while
there are still no features in the layer. When it is supported, the existing features of the
backing file/database should be updated accordingly. Some drivers might also not support
all update flags.
@param iField index of the field whose definition must be altered.
@param newFieldDefn new field definition
@param nFlags combination of ALTER_NAME_FLAG, ALTER_TYPE_FLAG and ALTER_WIDTH_PRECISION_FLAG
to indicate which of the name and/or type and/or width and precision fields from the new field
definition must be taken into account.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@since OGR 1.9.0
*/
public class Layer:public int AlterFieldDefn( int iField, FieldDefn newFieldDefn, int nFlags )
/**
Fetch the extent of this layer.
<p>
Returns the extent (MBR) of the data in the layer. If force is 0,
and it would be expensive to establish the extent then a RuntimeException
will be thrown indicating that the extent is not known. If force is
1 then some implementations will actually scan the entire layer once
to compute the MBR of all the features in the layer.
<p>
Depending on the drivers, the returned extent may or may not take the
spatial filter into account. So it is safer to call GetExtent() without
setting a spatial filter.
<p>
Layers without any geometry may throw a RuntimeException just indicating that
no meaningful extents could be collected.
@param extent an allocated array of 4 doubles in which the extent value will be returned.
@param force Flag indicating whether the extent should be computed even
if it is expensive (1 for true, 0 for false).
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int GetExtent(double[] extent, int force)
/**
Fetch the extent of this layer.
<p>
Returns the extent (MBR) of the data in the layer. If force is false,
and it would be expensive to establish the extent then a null value
will be returned indicating that the extent isn't know. If force is
true then some implementations will actually scan the entire layer once
to compute the MBR of all the features in the layer.
<p>
Depending on the drivers, the returned extent may or may not take the
spatial filter into account. So it is safer to call GetExtent() without
setting a spatial filter.
<p>
Layers without any geometry may return a null value just indicating that
no meaningful extents could be collected.
@param force Flag indicating whether the extent should be computed even
if it is expensive
@return an allocated array of 4 doubles in which the extent value or null in case of failure
@since Java bindings 1.7.0
*/
public class Layer:public double[] GetExtent(boolean force)
/**
* Fetch the extent of this layer.
*
* Same as below with force == true.
*
* @see #GetExtent(boolean force)
*
* @since Java bindings 1.7.0
*/
public class Layer:public double[] GetExtent()
/**
Delete feature from layer.
The feature with the indicated feature id is deleted from the layer if
supported by the driver. Most drivers do not support feature deletion,
and will throw a RuntimeException. The <a href="#TestCapability(java.lang.String)">TestCapability()</a>
layer method may be called with OLCDeleteFeature to check if the driver
supports feature deletion.
@param fid the feature id to be deleted from the layer
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int DeleteFeature(long fid)
/**
Fetch a feature by its identifier.
This function will attempt to read the identified feature. The fid
value cannot be OGRNullFID. Success or failure of this operation is
unaffected by the spatial or attribute filters.
<p>
If this method returns a non-null feature, it is guaranteed that its
feature id (Feature.GetFID()) will be the same as fid.
<p>
Use Layer.<a href="#TestCapability(java.lang.String)">TestCapability</a>(ogr.OLCRandomRead) to establish if this layer
supports efficient random access reading via GetFeature(); however, the
call should always work if the feature exists as a fallback implementation
just scans all the features in the layer looking for the desired feature.
<p>
Sequential reads are generally considered interrupted by a GetFeature() call.
<p>
The returned feature will be properly handled by the Java garbage collector,
but you can help it by explicitly calling the
Feature.<a href="Feature.html#delete()">delete()</a> method.
@param fid the feature id of the feature to read.
@return a feature, or null on failure.
*/
public class Layer:public Feature GetFeature(long fid)
/**
Fetch the feature count in this layer.
<p>
Returns the number of features in the layer. For dynamic databases the
count may not be exact. If force is 0, and it would be expensive
to establish the feature count a value of -1 may be returned indicating
that the count isn't know. If force is 1 some implementations will
actually scan the entire layer once to count objects.
<p>
The returned count takes the spatial filter into account.
@param force Flag indicating whether the count should be computed even
if it is expensive.
@return feature count, -1 if count not known.
*/
public class Layer:public long GetFeatureCount(int force)
/**
* Fetch the feature count in this layer.
* <p>
* Same as below with force == 1.
*
* @see #GetFeatureCount(int force)
*
* @since Java bindings 1.7.0
*/
public class Layer:public long GetFeatureCount()
/**
* Return the total number of features read.
* <p>
* Note: not all drivers seem to update properly this count.
* @return total number of features read.
*
* @since Java bindings 1.7.0
*/
public class Layer:public long GetFeaturesRead()
/**
Returns the name of the FID column.
<p>
This method returns the name of the underlying database column
being used as the FID column, or "" if not supported.
@return fid column name.
*/
public class Layer:public String GetFIDColumn()
/**
Returns the name of the geometry column.
<p>
This method returns the name of the underlying database column
being used as the geometry column, or "" if not supported.
@return fid column name.
*/
public class Layer:public String GetGeometryColumn()
/**
Set which fields can be omitted when retrieving features from the layer.
<p>
If the driver supports this functionality (testable using OLCIgnoreFields capability), it will not fetch the specified fields
in subsequent calls to GetFeature() / GetNextFeature() and thus save some processing time and/or bandwidth.
<p>
Besides field names of the layers, the following special fields can be passed: "OGR_GEOMETRY" to ignore geometry and
"OGR_STYLE" to ignore layer style.
<p>
By default, no fields are ignored.
@param fieldNames a vector of field names. If null is passed, the ignored list is cleared.
@return ogr.OGRERR_NONE if all field names have been resolved (even if the driver does not support this method)
@since OGR 1.8.0
*/
public class Layer:public int SetIgnoredFields(java.util.Vector fieldNames)
/**
Fetch the schema information for this layer.
<p>
The returned FeatureDefn is owned by the Layer, and should not be
modified or freed by the application. It encapsulates the attribute schema
of the features of the layer.
@return feature definition.
*/
public class Layer:public FeatureDefn GetLayerDefn()
/**
* Return the layer name.
* <p>
* This returns the same content as GetLayerDefn().GetName(), but for a
* few drivers, calling GetName() directly can avoid lengthy layer
* definition initialization.
*
* @return the layer name
* @see #GetNameAsByteArray()
*/
public class Layer:public String GetName()
/**
* Return the layer name (when it is not UTF-8 encoded).
* <p>
* This returns the same content as GetLayerDefn().GetName(), but for a
* few drivers, calling GetName() directly can avoid lengthy layer
* definition initialization.
*
* @return the layer name
* @since 3.10
*/
public class Layer:public byte GetNameAsByteArray()
/**
* Return the layer geometry type.
* <p>
* This returns the same result as GetLayerDefn().GetGeomType(), but for a
* few drivers, calling GetGeomType() directly can avoid lengthy layer
* definition initialization.
*
* @return the geometry name
*
* @since OGR 1.8.0
*/
public class Layer:public int GetGeomType()
/**
Fetch the next available feature from this layer.
<p>
Only features matching the current spatial filter (set with
<a href="#SetSpatialFilter(org.gdal.ogr.Geometry)">SetSpatialFilter()</a> will be returned.
<p>
This method implements sequential access to the features of a layer. The
ResetReading() method can be used to start at the beginning again.
<p>
The returned feature will be properly handled by the Java garbage collector,
but you can help it by explicitly calling the
Feature.<a href="Feature.html#delete()">delete()</a> method.
@return a feature, or null if no more features are available.
*/
public class Layer:public Feature GetNextFeature()
/**
Fetch reference count.
<p>
Should be of little use in Java...
@return the current reference count for the layer object itself.
*/
public class Layer:public int GetRefCount()
/**
Return the current spatial filter for this layer.
@return spatial filter geometry, or null if there isn't one.
*/
public class Layer:public Geometry GetSpatialFilter()
/**
Fetch the spatial reference system for this layer.
@return spatial reference, or null if there isn't one.
*/
public class Layer:public SpatialReference GetSpatialRef()
/**
Reset feature reading to start on the first feature. This affects
GetNextFeature().
*/
public class Layer:public void ResetReading()
/**
Set a new attribute query.
<p>
This method sets the attribute query string to be used when
fetching features via the <a href="#GetNextFeature()">GetNextFeature()</a> method. Only features for which
the query evaluates as true will be returned.
<p>
The query string should be in the format of an SQL WHERE clause. For
instance "population > 1000000 and population < 5000000" where population
is an attribute in the layer. The query format is a restricted form of SQL
WHERE clause as defined "eq_format=restricted_where" about half way through
this document:
<pre>
<a href="http://ogdi.sourceforge.net/prop/6.2.CapabilitiesMetadata.html">Proposal 6.2: Capabilities Metadata</a>
</pre>
Note that installing a query string will generally result in resetting
the current reading position (ala <a href="#ResetReading()">ResetReading()</a>).
@param filter_string query in restricted SQL WHERE format, or null to clear the
current query.
@return 0 if successfully installed. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int SetAttributeFilter(String filter_string)
/**
Rewrite an existing feature.
<p>
This method will write a feature to the layer, based on the feature id
within the Feature.
<p>
Use Layer.<a href="#TestCapability(java.lang.String)">TestCapability</a>(ogr.OLCRandomWrite) to establish if this layer
supports random access writing via SetFeature().
@param feature the feature to write.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
@see #CreateFeature(Feature)
*/
public class Layer:public int SetFeature(Feature feature)
/**
Move read cursor to the new_index'th feature in the current resultset.
<p>
This method allows positioning of a layer such that the <a href="#GetNextFeature()">GetNextFeature()</a>
call will read the requested feature, where nIndex is an absolute index
into the current result set. So, setting it to 3 would mean the next
feature read with GetNextFeature() would have been the 4th feature to have
been read if sequential reading took place from the beginning of the layer,
including accounting for spatial and attribute filters.
<p>
Only in rare circumstances is SetNextByIndex() efficiently implemented.
In all other cases the default implementation which calls ResetReading()
and then calls GetNextFeature() nIndex times is used. To determine if
fast seeking is available on the current layer use the TestCapability()
method with a value of OLCFastSetNextByIndex.
@param new_index the index indicating how many steps into the result set
to seek.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int SetNextByIndex(long new_index)
/**
Set a new spatial filter.
<p>
This method set the geometry to be used as a spatial filter when
fetching features via the <a href="#GetNextFeature()">GetNextFeature()</a> method. Only features that
geometrically intersect the filter geometry will be returned.
<p>
Currently this test is may be inaccurately implemented, but it is
guaranteed that all features who's envelope (as returned by
Geometry.getEnvelope()) overlaps the envelope of the spatial filter
will be returned. This can result in more shapes being returned that
should strictly be the case.
<p>
This method makes an internal copy of the passed geometry. The
passed geometry remains the responsibility of the caller, and may
be safely destroyed.
<p>
For the time being the passed filter geometry should be in the same
SRS as the layer (as returned by <a href="#GetSpatialRef()">GetSpatialRef()</a>). In the
future this may be generalized.
@param filter the geometry to use as a filtering region. null may
be passed indicating that the current spatial filter should be cleared,
but no new one instituted.
*/
public class Layer:public void SetSpatialFilter(Geometry filter)
/**
Set a new rectangular spatial filter.
This method set rectangle to be used as a spatial filter when
fetching features via the <a href="#GetNextFeature()">GetNextFeature()</a> method method. Only features that
geometrically intersect the given rectangle will be returned.
<p>
The x/y values should be in the same coordinate system as the layer as
a whole (as returned by <a href="#GetSpatialRef()">GetSpatialRef()</a>). Internally this
method is normally implemented as creating a 5 vertex closed rectangular
polygon and passing it to <a href="#SetSpatialFilter(org.gdal.ogr.Geometry)">SetSpatialFilter()</a>. It exists as
a convenience.
<p>
The only way to clear a spatial filter set with this method is to
call SetSpatialFilter(null).
@param minx the minimum X coordinate for the rectangular region.
@param miny the minimum Y coordinate for the rectangular region.
@param maxx the maximum X coordinate for the rectangular region.
@param maxy the maximum Y coordinate for the rectangular region.
*/
public class Layer:public void SetSpatialFilterRect(double minx, double miny, double maxx, double maxy)
/**
Flush pending changes to disk.
<p>
This call is intended to force the layer to flush any pending writes to
disk, and leave the disk file in a consistent state. It would not normally
have any effect on read-only datasources.
<p>
Some layers do not implement this method, and will still return
0. The default implementation just returns 0. An error
is only returned if an error occurs while attempting to flush to disk.
@return 0 if no error occurs (even if nothing is done). Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int SyncToDisk()
/**
For datasources which support transactions, StartTransaction creates
a transaction.
<p>
If starting the transaction fails, will throw a RuntimeException (or an error code if DontUseExceptions() has been called).
Datasources which do not support transactions will always return 0.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int StartTransaction()
/**
For datasources which support transactions, CommitTransaction commits a
transaction.
<p>
If no transaction is active, or the commit fails, will throw a RuntimeException (or an error code if DontUseExceptions() has been called).
Datasources which do not support transactions will always return 0.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int CommitTransaction()
/**
For datasources which support transactions, RollbackTransaction will roll
back a datasource to its state before the start of the current transaction.
<p>
If no transaction is active, or the rollback fails, will throw a RuntimeException (or an error code if DontUseExceptions() has been called).
Datasources which do not support transactions will always return 0.
@return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Layer:public int RollbackTransaction()
/**
Test if this layer supported the named capability.
<p>
The capability codes that can be tested are represented as strings, but
ogrConstants constants exists to ensure correct spelling. Specific layer
types may implement class specific capabilities, but this can't generally
be discovered by the caller. <p>
<ul>
<li> <b>OLCRandomRead</b> / "RandomRead": true if the GetFeature() method
is implemented in an optimized way for this layer, as opposed to the default
implementation using ResetReading() and GetNextFeature() to find the requested
feature id.<p>
<li> <b>OLCSequentialWrite</b> / "SequentialWrite": true if the
CreateFeature() method works for this layer. Note this means that this
particular layer is writable. The same Layer class may returned false
for other layer instances that are effectively read-only.<p>
<li> <b>OLCRandomWrite</b> / "RandomWrite": true if the SetFeature() method
is operational on this layer. Note this means that this
particular layer is writable. The same Layer class may returned false
for other layer instances that are effectively read-only.<p>
<li> <b>OLCFastSpatialFilter</b> / "FastSpatialFilter": true if this layer
implements spatial filtering efficiently. Layers that effectively read all
features, and test them with the Feature intersection methods should
return false. This can be used as a clue by the application whether it
should build and maintain it's own spatial index for features in this layer.<p>
<li> <b>OLCFastFeatureCount</b> / "FastFeatureCount":
true if this layer can return a feature
count (via GetFeatureCount()) efficiently, i.e. without counting
the features. In some cases this will return true until a spatial filter is
installed after which it will return false.<p>
<li> <b>OLCFastGetExtent</b> / "FastGetExtent":
true if this layer can return its data extent (via GetExtent()) efficiently, i.e. without scanning all the features. In some cases this will return true until a spatial filter is installed after which it will return false.<p>
<li> <b>OLCFastSetNextByIndex</b> / "FastSetNextByIndex":
true if this layer can perform the SetNextByIndex() call efficiently, otherwise
false.<p>
<li> <b>OLCCreateField</b> / "CreateField": true if this layer can create
new fields on the current layer using CreateField(), otherwise false.<p>
<li> <b>OLCDeleteField</b> / "DeleteField": TRUE if this layer can delete
existing fields on the current layer using DeleteField(), otherwise false.<p>
<li> <b>OLCReorderFields</b> / "ReorderFields": TRUE if this layer can reorder
existing fields on the current layer using ReorderField() or ReorderFields(), otherwise false.<p>
<li> <b>OLCAlterFieldDefn</b> / "AlterFieldDefn": TRUE if this layer can alter
the definition of an existing field on the current layer using AlterFieldDefn(), otherwise false.<p>
<li> <b>OLCDeleteFeature</b> / "DeleteFeature": true if the DeleteFeature()
method is supported on this layer, otherwise false.<p>
<li> <b>OLCStringsAsUTF8</b> / "StringsAsUTF8": true if values of OFTString
fields are assured to be in UTF-8 format. If false the encoding of fields
is uncertain, though it might still be UTF-8.<p>
<li> <b>OLCStringsAsUTF8</b> / "StringsAsUTF8": true if values of OFTString
fields are assured to be in UTF-8 format. If false the encoding of fields
is uncertain, though it might still be UTF-8.<p>
<li> <b>OLCTransactions</b> / "Transactions": true if the StartTransaction(), CommitTransaction() and RollbackTransaction() methods work in a meaningful way, otherwise false.<p>
<li> <b>OLCIgnoreFields</b> / "IgnoreFields": true if fields, geometry and style will be omitted when fetching features as set by SetIgnoredFields() method.<p>
<p>
</ul>
@param cap the name of the capability to test.
@return true if the layer has the requested capability, or false otherwise.
Layers will return false for any unrecognized capabilities.<p>
*/
public class Layer:public boolean TestCapability(String cap)
/**
* Intersection of two layers.
* <p>
* The result layer contains features whose geometries represent areas
* that are common between features in the input layer and in the
* method layer. The features in the result layer have attributes from
* both input and method layers. The schema of the result layer can be
* set by the user or, if it is empty, is initialized to contain all
* fields in the input and method layers.
* <p>
* If the schema of the result is set by user and contains
* fields that have the same name as a field in input and in method
* layer, then the attribute in the result feature will get the value
* from the feature of the method layer.
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Intersection( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Intersection of two layers.
*
* @see #Intersection( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Intersection( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Intersection( Layer pLayerMethod, Layer pLayerResult)
/**
* Union of two layers.
* <p>
* The result layer contains features whose geometries represent areas
* that are in either in the input layer or in the method layer. The
* features in the result layer have attributes from both input and
* method layers. For features which represent areas that are only in
* the input or in the method layer the respective attributes have
* undefined values. The schema of the result layer can be set by the
* user or, if it is empty, is initialized to contain all fields in
* the input and method layers.
* <p>
* If the schema of the result is set by user and contains
* fields that have the same name as a field in input and in method
* layer, then the attribute in the result feature will get the value
* from the feature of the method layer (even if it is undefined).
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Union( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Union of two layers.
*
* @see #Union( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Union( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Union( Layer pLayerMethod, Layer pLayerResult)
/**
* Symmetrical difference of two layers.
* <p>
* The result layer contains features whose geometries represent areas
* that are in either in the input layer or in the method layer but
* not in both. The features in the result layer have attributes from
* both input and method layers. For features which represent areas
* that are only in the input or in the method layer the respective
* attributes have undefined values. The schema of the result layer
* can be set by the user or, if it is empty, is initialized to
* contain all fields in the input and method layers.
* <p>
* If the schema of the result is set by user and contains
* fields that have the same name as a field in input and in method
* layer, then the attribute in the result feature will get the value
* from the feature of the method layer (even if it is undefined).
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int SymDifference( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Symmetrical difference of two layers.
*
* @see #SymDifference( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int SymDifference( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int SymDifference( Layer pLayerMethod, Layer pLayerResult)
/**
* Identify the features of this layer with the ones from the
* identity layer.
* <p>
* The result layer contains features whose geometries represent areas
* that are in the input layer. The features in the result layer have
* attributes from both input and method layers. The schema of the
* result layer can be set by the user or, if it is empty, is
* initialized to contain all fields in input and method layers.
* <p>
* If the schema of the result is set by user and contains
* fields that have the same name as a field in input and in method
* layer, then the attribute in the result feature will get the value
* from the feature of the method layer (even if it is undefined).
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Identity( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Identify the features of this layer with the ones from the
* identity layer.
*
* @see #Identity( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Identity( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Identity( Layer pLayerMethod, Layer pLayerResult)
/**
* Update this layer with features from the update layer.
* <p>
* The result layer contains features whose geometries represent areas
* that are either in the input layer or in the method layer. The
* features in the result layer have areas of the features of the
* method layer or those ares of the features of the input layer that
* are not covered by the method layer. The features of the result
* layer get their attributes from the input layer. The schema of the
* result layer can be set by the user or, if it is empty, is
* initialized to contain all fields in the input layer.
* <p>
* If the schema of the result is set by user and contains
* fields that have the same name as a field in the method layer, then
* the attribute in the result feature the originates from the method
* layer will get the value from the feature of the method layer.
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Update( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Update this layer with features from the update layer.
*
* @see #Update( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Update( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Update( Layer pLayerMethod, Layer pLayerResult)
/**
* Clip off areas that are not covered by the method layer.
* <p>
* The result layer contains features whose geometries represent areas
* that are in the input layer and in the method layer. The features
* in the result layer have the (possibly clipped) areas of features
* in the input layer and the attributes from the same features. The
* schema of the result layer can be set by the user or, if it is
* empty, is initialized to contain all fields in the input layer.
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Clip( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Clip off areas that are not covered by the method layer.
*
* @see #Clip( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Clip( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Clip( Layer pLayerMethod, Layer pLayerResult)
/**
* Remove areas that are covered by the method layer.
* <p>
* The result layer contains features whose geometries represent areas
* that are in the input layer but not in the method layer. The
* features in the result layer have attributes from the input
* layer. The schema of the result layer can be set by the user or, if
* it is empty, is initialized to contain all fields in the input
* layer.
* <p>
* For best performance use the minimum amount of features in
* the method layer and copy it into a memory layer.
* <p>
* The recognized list of options is :
* <ul>
* <li>SKIP_FAILURES=YES/NO. Set it to YES to go on, even when a
* feature could not be inserted.
* <li>PROMOTE_TO_MULTI=YES/NO. Set it to YES to convert Polygons
* into MultiPolygons, or LineStrings to MultiLineStrings.
* <li>INPUT_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the input layer.
* <li>METHOD_PREFIX=string. Set a prefix for the field names that
* will be created from the fields of the method layer.
* </ul>
* <p>
* This method relies on GEOS support. Do not use unless the
* GEOS support is compiled in.
*
* @param pLayerMethod the method layer. Should not be null.
*
* @param pLayerResult the layer where the features resulting from the
* operation are inserted. Should not be null. See above the note
* about the schema.
*
* @param options list of options (may be null).
*
* @param callback a callback function for reporting progress or null.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.10
*/
public class Layer:public int Erase( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
/**
* Remove areas that are covered by the method layer.
*
* @see #Erase( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options, ProgressCallback callback )
*/
public class Layer:public int Erase( Layer pLayerMethod, Layer pLayerResult, java.util.Vector options )
public class Layer:public int Erase( Layer pLayerMethod, Layer pLayerResult)
/* Class Feature */
/**
* A simple feature, including geometry and attributes.
*
* <p>
* The Feature class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRFeature.html">OGRFeature</a> class.
*/
public class Feature
/**
* Constructor.
* <p>
* Note that the Feature will increment the reference count of its
* defining FeatureDefn.
*
* @param feature_def feature class (layer) definition to which the feature will
* adhere.
*/
public class Feature:public Feature(FeatureDefn feature_def)
/**
* Duplicate feature.
* <p>
* The newly created feature is owned by the caller, and will have its own
* reference to the FeatureDefn.
*
* @return new feature, exactly matching this feature.
*/
public class Feature:public Feature Clone()
/**
* Delete (in memory) a feature.
* <p>
* Calling this method is not required as normal garbage collection will
* reclaim associated resources when the object goes out of scope.
* Otherwise calling delete() explicitly will help release resources sooner.
* Don't call any method on a deleted object !
*/
public class Feature:public void delete()
/**
* Dump this feature in a human readable form.
* <p>
* This dumps the attributes, and geometry; however, it doesn't definition
* information (other than field types and names), nor does it report the
* geometry spatial reference system.
* The standard output will be used.
*/
public class Feature:public void DumpReadable()
/**
* Test if two features are the same.
* <p>
* Two features are considered equal if they share the (pointer equality)
* same FeatureDefn, have the same field values, and the same geometry
* (as tested by Geometry.Equal()) as well as the same feature id.
*
* @param feature the other feature to test this one against.
*
* @return true if they are equal, otherwise false.
*/
public class Feature:public boolean Equal(Feature feature)
/**
* Fetch feature definition.
*
* @return a reference to the feature definition object.
*/
public class Feature:public FeatureDefn GetDefnRef()
/**
* Get feature identifier.
*
* @return feature id or OGRNullFID if none has been assigned.
*/
public class Feature:public long GetFID()
/**
* Fetch field value as date and time.
* <p>
* Currently this method only works for OFTDate, OFTTime and OFTDateTime fields.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
* @param pnYear an allocated array of 1 integer to put the year (including century)
* @param pnMonth an allocated array of 1 integer to put the month (1-12)
* @param pnDay an allocated array of 1 integer to put the day (1-31)
* @param pnHour an allocated array of 1 integer to put the hour (0-23)
* @param pnMinute an allocated array of 1 integer to put the minute (0-59)
* @param pfSecond an allocated array of 1 integer to put the second (0-59)
* @param pnTZFlag an allocated array of 1 integer to put the time zone flag (0=unknown, 1=localtime, 100=GMT, see data model for details)
*/
public class Feature:public void GetFieldAsDateTime(int ifield, int[] pnYear, int[] pnMonth, int[] pnDay, int[] pnHour, int[] pnMinute, float[] pfSecond, int[] pnTZFlag)
/**
* Fetch field value as a double.
* <p>
* OFTString features will be translated using atof(). OFTInteger fields
* will be cast to double. Other field types, or errors will result in
* a return value of zero.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value.
*/
public class Feature:public double GetFieldAsDouble(int ifield)
/**
* Fetch field value as a double.
* <p>
* OFTString features will be translated using atof(). OFTInteger fields
* will be cast to double. Other field types, or errors will result in
* a return value of zero.
*
* @param name the name of the field to fetch.
*
* @return the field value.
*/
public class Feature:public double GetFieldAsDouble(String name)
/**
* Fetch field value as a list of doubles.
* <p>
* Currently this method only works for OFTRealList fields.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value. The returned value may be null.
*
* @since Java bindings 1.7.0
*/
public class Feature:public double[] GetFieldAsDoubleList(int ifield)
/**
* Fetch field value as integer.
* <p>
* OFTString features will be translated using atoi(). OFTReal fields
* will be cast to integer. Other field types, or errors will result in
* a return value of zero.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value.
*/
public class Feature:public int GetFieldAsInteger(int ifield)
/**
* Fetch field value as integer.
* <p>
* OFTString features will be translated using atoi(). OFTReal fields
* will be cast to integer. Other field types, or errors will result in
* a return value of zero.
*
* @param name the name of the field to fetch.
*
* @return the field value.
*/
public class Feature:public int GetFieldAsInteger(String name)
/**
* Fetch field value as a list of integers.
* <p>
* Currently this method only works for OFTIntegerList fields.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value. The returned value may be null.
*
* @since Java bindings 1.7.0
*/
public class Feature:public int[] GetFieldAsIntegerList(int ifield)
/**
* Fetch field value as a string.
* <p>
* OFTReal and OFTInteger fields will be translated to string using
* sprintf(), but not necessarily using the established formatting rules.
* Other field types, or errors will result in a return value of zero.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value.
* @see #GetFieldAsStringAsByteArray(int)
*/
public class Feature:public String GetFieldAsString(int ifield)
/**
* Fetch field value as a string.
* <p>
* OFTReal and OFTInteger fields will be translated to string using
* sprintf(), but not necessarily using the established formatting rules.
* Other field types, or errors will result in a return value of zero.
*
* @param name the name of the field to fetch.
*
* @return the field value.
* @see #GetFieldAsStringAsByteArray(String)
*/
public class Feature:public String GetFieldAsString(String name)
/**
* Fetch field value as a string (when it is not UTF-8 encoded).
* <p>
* OFTReal and OFTInteger fields will be translated to string using
* sprintf(), but not necessarily using the established formatting rules.
* Other field types, or errors will result in a return value of zero.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value.
* @since 3.10
*/
public class Feature:public byte[] GetFieldAsStringAsByteArray(int ifield)
/**
* Fetch field value as a string (when it is not UTF-8 encoded).
* <p>
* OFTReal and OFTInteger fields will be translated to string using
* sprintf(), but not necessarily using the established formatting rules.
* Other field types, or errors will result in a return value of zero.
*
* @param name the name of the field to fetch.
*
* @return the field value.
* @since 3.10
*/
public class Feature:public byte[] GetFieldAsStringAsByteArray(String name)
/**
* Fetch field value as a list of strings.
* <p>
* Currently this method only works for OFTStringList fields.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field value. The returned value may be null.
*
* @since Java bindings 1.7.0
*/
public class Feature:public String[] GetFieldAsStringList(int ifield)
/**
*
* Fetch number of fields on this feature. This will always be the same
* as the field count for the FeatureDefn.
*
* @return count of fields.
*/
public class Feature:public int GetFieldCount()
/**
* Fetch definition for this field.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field definition (from the FeatureDefn).
*/
public class Feature:public FieldDefn GetFieldDefnRef(int ifield)
/**
* Fetch definition for this field.
*
* @param name the name of the field to fetch.
*
* @return the field definition (from the FeatureDefn).
*/
public class Feature:public FieldDefn GetFieldDefnRef(String name)
/**
* Fetch the field index given field name.
*
* This is a cover for the FeatureDefn.GetFieldIndex() method.
*
* @param name the name of the field to search for.
*
* @return the field index, or -1 if no matching field is found.
*/
public class Feature:public int GetFieldIndex(String name)
/**
* Fetch the field type.
* <p>
* This is a cover for the FeatureDefn.GetFieldType() method.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
*
* @return the field type (like ogr.OFTInteger, etc.)
*/
public class Feature:public int GetFieldType(int ifield)
/**
* Fetch the field type.
* <p>
* This is a cover for the FeatureDefn.GetFieldType() method.
*
* @param name the name of the field to fetch.
*
* @return the field type (like ogr.OFTInteger, etc.)
*/
public class Feature:public int GetFieldType(String name)
/**
* Fetch pointer to feature geometry.
*
* @return internal feature geometry (or null if no geometry). This object should
* not be modified.
*/
public class Feature:public Geometry GetGeometryRef()
/**
* Fetch style string for this feature.
* <p>
* Set the OGR Feature Style Specification for details on the format of
* this string, and ogr_featurestyle.h for services available to parse it.
*
* @return a reference to a representation in string format, or null if
* there isn't one.
*
* @see #GetStyleStringAsByteArray()
*/
public class Feature:public String GetStyleString()
/**
* Fetch style string for this feature (when it is not UTF-8 encoded).
* <p>
* Set the OGR Feature Style Specification for details on the format of
* this string, and ogr_featurestyle.h for services available to parse it.
*
* @return a reference to a representation in string format, or null if
* there isn't one.
* @since 3.10
*/
public class Feature:public byte[] GetStyleStringAsByteArray()
/**
* Test if a field has ever been assigned a value or not.
*
* @param ifield the field to test.
*
* @return true if the field has been set, otherwise false.
*/
public class Feature:public boolean IsFieldSet(int ifield)
/**
* Test if a field has ever been assigned a value or not.
*
* @param name the name of the field to test.
*
* @return true if the field has been set, otherwise false.
*/
public class Feature:public boolean IsFieldSet(String name)
/**
* Set the feature identifier.
* <p>
* For specific types of features this operation may fail on illegal
* features ids. Generally it always succeeds. Feature ids should be
* greater than or equal to zero, with the exception of OGRNullFID (-1)
* indicating that the feature id is unknown.
*
* @param fid the new feature identifier value to assign.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Feature:public int SetFID(long fid)
/**
* Set field to double value.
* <p>
* OFTInteger and OFTReal fields will be set directly. OFTString fields
* will be assigned a string representation of the value, but not necessarily
* taking into account formatting constraints on this field. Other field
* types may be unaffected.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
* @param val the value to assign.
*/
public class Feature:public void SetField(int ifield, double val)
/**
* Set field to integer value.
* <p>
* OFTInteger and OFTReal fields will be set directly. OFTString fields
* will be assigned a string representation of the value, but not necessarily
* taking into account formatting constraints on this field. Other field
* types may be unaffected.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
* @param val the value to assign.
*/
public class Feature:public void SetField(int ifield, int val)
/**
* Set field to date.
* <p>
* This method currently only has an effect for OFTDate, OFTTime and OFTDateTime
* fields.
*
* @param ifield the field to set, from 0 to GetFieldCount()-1.
* @param year (including century)
* @param month (1-12)
* @param day (1-31)
* @param hour (0-23)
* @param minute (0-59)
* @param second (0-59)
* @param tzflag (0=unknown, 1=localtime, 100=GMT, see data model for details)
*/
public class Feature:public void SetField(int ifield, int year, int month, int day, int hour, int minute, float second, int tzflag)
/**
* Set field to string value.
* <p>
* OFTInteger fields will be set based on an atoi() conversion of the string.
* OFTReal fields will be set based on an atof() conversion of the string.
* Other field types may be unaffected.
*
* @param ifield the field to fetch, from 0 to GetFieldCount()-1.
* @param val the value to assign.
*/
public class Feature:public void SetField(int ifield, String val)
/**
* Set field to double value.
* <p>
* OFTInteger and OFTReal fields will be set directly. OFTString fields
* will be assigned a string representation of the value, but not necessarily
* taking into account formatting constraints on this field. Other field
* types may be unaffected.
*
* @param name the name of the field to set.
* @param val the value to assign.
*/
public class Feature:public void SetField(String name, double val)
/**
* Set field to integer value.
* <p>
* OFTInteger and OFTReal fields will be set directly. OFTString fields
* will be assigned a string representation of the value, but not necessarily
* taking into account formatting constraints on this field. Other field
* types may be unaffected.
*
* @param name the name of the field to set.
* @param val the value to assign.
*/
public class Feature:public void SetField(String name, int val)
/**
* Set field to date.
* <p>
* This method currently only has an effect for OFTDate, OFTTime and OFTDateTime
* fields.
*
* @param name the name of the field to set.
* @param year (including century)
* @param month (1-12)
* @param day (1-31)
* @param hour (0-23)
* @param minute (0-59)
* @param second (0-59)
* @param tzflag (0=unknown, 1=localtime, 100=GMT, see data model for details)
*/
public class Feature:public void SetField(String name, int year, int month, int day, int hour, int minute, float second, int tzflag)
/**
* Set field to string value.
* <p>
* OFTInteger fields will be set based on an atoi() conversion of the string.
* OFTReal fields will be set based on an atof() conversion of the string.
* Other field types may be unaffected.
*
* @param name the name of the field to set.
* @param val the value to assign.
*/
public class Feature:public void SetField(String name, String val)
/**
* Set field to list of doubles value.
* <p>
* This method currently on has an effect of OFTRealList fields.
*
* @param ifield the field to set, from 0 to GetFieldCount()-1.
* @param values the values to assign.
*/
public class Feature:public void SetFieldDoubleList(int ifield, double[] values)
/**
* Set field to list of integers value.
* <p>
* This method currently on has an effect of OFTIntegerList fields.
*
* @param ifield the field to set, from 0 to GetFieldCount()-1.
* @param values the values to assign.
*/
public class Feature:public void SetFieldIntegerList(int ifield, int[] values)
/**
* Set field to list of strings value.
* <p>
* This method currently on has an effect of OFTStringList fields.
*
* @param ifield the field to set, from 0 to GetFieldCount()-1.
* @param values the values to assign (vector of strings).
*
* @since Java bindings 1.7.0
*/
public class Feature:public void SetFieldStringList(int ifield, java.util.Vector values)
/**
* Set one feature from another.
* <p>
* Overwrite the contents of this feature from the geometry and attributes
* of another. The srcFeature does not need to have the same
* FeatureDefn. Field values are copied by corresponding field names.
* Field types do not have to exactly match. SetField() method conversion
* rules will be applied as needed.
*
* @param srcFeature the feature from which geometry, and field values will
* be copied.
*
* @param forgiving 1 if the operation should continue despite lacking
* output fields matching some of the source fields.
*
* @return 0 if the operation succeeds, even if some values are
* not transferred, otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @see #SetFromWithMap(org.gdal.ogr.Feature srcFeature, int forgiving, int[] map)
*/
public class Feature:public int SetFrom(Feature srcFeature, int forgiving)
/**
* Set one feature from another.
* <p>
* Same as below with forgiving == 1
*
* @see #SetFrom(Feature srcFeature, int forgiving)
*
* @since Java bindings 1.7.0
*/
public class Feature:public int SetFrom(Feature srcFeature)
/**
* Set one feature from another.
* <p>
* Overwrite the contents of this feature from the geometry and attributes
* of another. The hOtherFeature does not need to have the same
* OGRFeatureDefn. Field values are copied according to the provided indices
* map. Field types do not have to exactly match. SetField() function
* conversion rules will be applied as needed. This is more efficient than
* <a href="#SetFrom(org.gdal.ogr.Feature, int)">SetFrom(Feature, int)</a>
* in that this doesn't lookup the fields by their names.
* Particularly useful when the field names don't match.
*
* @param srcFeature the feature from which geometry, and field values will
* be copied.
*
* @param forgiving 1 if the operation should continue despite lacking
* output fields matching some of the source fields.
*
* @param map Array of the indices of the destination feature's fields
* stored at the corresponding index of the source feature's fields. A value of
* -1 should be used to ignore the source's field. The array should not be null
* and be as long as the number of fields in the source feature.
*
* @return 0 if the operation succeeds, even if some values are
* not transferred, otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.8.0
*
* @see #SetFrom(org.gdal.ogr.Feature srcFeature, int forgiving)
*/
public class Feature:public int SetFromWithMap(Feature srcFeature, int forgiving, int[] map)
/**
* Set feature geometry.
* <p>
* This method updates the features geometry, and operate exactly as
* SetGeometryDirectly(), except that this method does not assume ownership
* of the passed geometry, but instead makes a copy of it.
*
* @param geom new geometry to apply to feature. Passing null value here
* is correct and it will result in deallocation of currently assigned geometry
* without assigning new one.
*
* @return 0 if successful, or throws a RuntimeException (or an error code if DontUseExceptions() has been called) if
* the geometry type is illegal for the FeatureDefn (checking not yet
* implemented).
*/
public class Feature:public int SetGeometry(Geometry geom)
/**
* Set feature geometry.
* <p>
* This method updates the features geometry, and operate exactly as
* SetGeometry(), except that this method assumes ownership of the
* passed geometry.
*
* @param geom new geometry to apply to feature. Passing null value here
* is correct and it will result in deallocation of currently assigned geometry
* without assigning new one.
*
* @return 0 if successful, or throws a RuntimeException (or an error code if DontUseExceptions() has been called) if
* the geometry type is illegal for the FeatureDefn (checking not yet
* implemented).
*/
public class Feature:public int SetGeometryDirectly(Geometry geom)
/**
* Set feature style string.
*
* @param style_string the style string to apply to this feature, cannot be null.
*/
public class Feature:public void SetStyleString(String style_string)
/**
* Clear a field, marking it as unset.
*
* @param ifield the field to unset, from 0 to GetFieldCount()-1.
*/
public class Feature:public void UnsetField(int ifield)
/**
* Clear a field, marking it as unset.
*
* @param name the name of the field to unset.
*/
public class Feature:public void UnsetField(String name)
/* Class Geometry */
/**
* Abstract base class for all geometry classes.
*
* <p>
* The Geometry class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRGeometry.html">OGRGeometry</a> class.
* <p>
* Some spatial analysis methods require that OGR is built on the GEOS library
* to work properly. The precise meaning of methods that describe spatial relationships
* between geometries is described in the SFCOM, or other simple features interface
* specifications, like "OpenGIS(R) Implementation Specification for
* Geographic information - Simple feature access - Part 1: Common architecture"
* (<a href="http://www.opengeospatial.org/standards/sfa">OGC 06-103r3</a>)
*
*/
public class Geometry
/**
* Create an empty geometry of desired type.
* <p>
* The type may be one of ogr.wkbPoint, etc..
*
* @param eGeometryType the type code of the geometry class to be instantiated.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public Geometry(int eGeometryType)
/**
* Create a new geometry.
* <p>
* The geometry can be instantiated by 4 different and exclusive way:
* <ul>
* <li> By specifying the geometry type (ogr.wkbPoint, etc..)</li>
* <li> By specifying the well known text representation (wkt)</li>
* <li> By specifying the well known binary representation (wkb)</li>
* <li> By specifying the GML representation</li>
* </ul>
* <p>
* You should rather use either the Geometry(int) constructor, or the static methods
* like Geometry.CreateFromWkt(), Geometry.CreateFromWbt() or Geometry.CreateFromGML().
*
* @param eGeometryType the type code of the geometry class to be instantiated.
* @param wkt the well known text representation
* @param wkb the well known binary representation
* @param gml the GML representation
* @see #Geometry(int eGeometryType)
* @see #CreateFromWkt(String wkt)
* @see #CreateFromWkb(byte[] wkb)
* @see #CreateFromGML(String gml)
*
* @deprecated Use referenced methods instead.
*/
public class Geometry:public Geometry(int eGeometryType, String wkt, byte[] wkb, String gml)
/**
* Add a geometry to the container.
* <p>
* Some subclasses of OGRGeometryCollection restrict the types of geometry
* that can be added, and may return an error. The passed geometry is cloned
* to make an internal copy.
* <p>
* There is no SFCOM analog to this method.
* <p>
* For a polygon, other must be a linearring. If the polygon is empty,
* the first added subgeometry will be the exterior ring. The next ones will be
* the interior rings.
*
* @param other geometry to add to the container.
*
* @return 0 if successful, or throws RuntimeException (or an error code if DontUseExceptions() has been called) if
* the geometry type is illegal for the type of geometry container.
*/
public class Geometry:public int AddGeometry(Geometry other)
/**
* Add a geometry directly to the container.
* <p>
* Some subclasses of OGRGeometryCollection restrict the types of geometry
* that can be added, and may return an error. Ownership of the passed
* geometry is taken by the container rather than cloning as addGeometry()
* does.
* <p>
* There is no SFCOM analog to this method.
* <p>
* For a polygon, other must be a linearring. If the polygon is empty,
* the first added subgeometry will be the exterior ring. The next ones will be
* the interior rings.
*
* @param other geometry to add to the container.
*
* @return 0 if successful, or throws RuntimeException (or an error code if DontUseExceptions() has been called) if
* the geometry type is illegal for the type of geometry container.
*/
public class Geometry:public int AddGeometryDirectly(Geometry other)
/**
* Add a point to a geometry (line string or point).
* <p>
* The vertex count of the line string is increased by one, and assigned from
* the passed location value.
*
* @param x x coordinate of point to add.
* @param y y coordinate of point to add.
*/
public class Geometry:public void AddPoint_2D(double x, double y)
/**
* Add a point to a geometry (line string or point).
* <p>
* The vertex count of the line string is increased by one, and assigned from
* the passed location value.
*
* @param x coordinate of point to add.
* @param y coordinate of point to add.
* @param z coordinate of point to add.
*/
public class Geometry:public void AddPoint(double x, double y, double z)
/**
* Add a point to a geometry (line string or point).
* <p>
* The vertex count of the line string is increased by one, and assigned from
* the passed location value.
*
* @param x coordinate of point to add.
* @param y coordinate of point to add.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public void AddPoint(double x, double y)
/**
* Assign spatial reference to this object.
* <p>
* Any existing spatial reference
* is replaced, but under no circumstances does this result in the object
* being reprojected. It is just changing the interpretation of the existing
* geometry. Note that assigning a spatial reference increments the
* reference count on the SpatialReference, but does not copy it.
*
* This is similar to the SFCOM IGeometry::put_SpatialReference() method.
*
* @param srs new spatial reference system to apply.
*/
public class Geometry:public void AssignSpatialReference(SpatialReference srs)
/**
* Compute buffer of geometry.
* <p>
* Builds a new geometry containing the buffer region around the geometry
* on which it is invoked. The buffer is a polygon containing the region within
* the buffer distance of the original geometry.
* <p>
* Some buffer sections are properly described as curves, but are converted to
* approximate polygons. The nQuadSegs parameter can be used to control how many
* segments should be used to define a 90 degree curve - a quadrant of a circle.
* A value of 30 is a reasonable default. Large values result in large numbers
* of vertices in the resulting buffer geometry while small numbers reduce the
* accuracy of the result.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param distance the buffer distance to be applied.
*
* @param quadsecs the number of segments used to approximate a 90 degree (quadrant) of
* curvature.
*
* @return the newly created geometry, or null if an error occurs.
*/
public class Geometry:public Geometry Buffer(double distance, int quadsecs)
/**
* Compute buffer of geometry.
* <p>
* Same as below with quadsecs == 30.
*
* @see #Buffer(double distance, int quadsecs)
*
* @since Java bindings 1.7.0
*/
public class Geometry:public Geometry Buffer(double distance)
/**
* Compute the geometry centroid.
*
* The centroid is not necessarily within the geometry.
* <p>
* This method relates to the SFCOM ISurface::get_Centroid() method
* however the current implementation based on GEOS can operate on other
* geometry types such as multipoint, linestring, geometrycollection such as
* multipolygons.
* OGC SF SQL 1.1 defines the operation for surfaces (polygons).
* SQL/MM-Part 3 defines the operation for surfaces and multisurfaces (multipolygons).
* <p>
* This function is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this function will always fail,
* issuing a CPLE_NotSupported error.
*
* @return point with the centroid location, or null in case of failure
*/
public class Geometry:public Geometry Centroid()
/**
* Make a copy of this object.
* <p>
* This method relates to the SFCOM IGeometry::clone() method.
*
* @return a new object instance with the same geometry, and spatial
* reference system as the original.
*/
public class Geometry:public Geometry Clone()
/**
* Force rings to be closed.
* <p>
* If this geometry, or any contained geometries has polygon rings that
* are not closed, they will be closed by adding the starting point at
* the end.
*/
public class Geometry:public void CloseRings()
/**
* Test for containment.
* <p>
* Tests if actual geometry object contains the passed geometry.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if poOtherGeom contains this geometry, otherwise false
*/
public class Geometry:public boolean Contains(Geometry other)
/**
* Compute convex hull.
* <p>
* A new geometry object is created and returned containing the convex
* hull of the geometry on which the method is invoked.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @return a newly allocated geometry now owned by the caller, or null on failure.
*/
public class Geometry:public Geometry ConvexHull()
/**
* Create geometry from GML.
* <p>
* This method translates a fragment of GML containing only the geometry
* portion into a corresponding Geometry. There are many limitations
* on the forms of GML geometries supported by this parser, but they are
* too numerous to list here.
*
* @param gml The GML fragment for the geometry.
*
* @return a geometry on success, or null on error.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public static Geometry CreateFromGML(String gml)
/**
* Create geometry from GeoJSON.
*
* @param json GeoJSON content
*
* @return a geometry on success, or null on error.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public static Geometry CreateFromJson(String json)
/**
* Create a geometry object of the appropriate type from it's well known
* binary representation.
*
* @param wkb input BLOB data.
*
* @return a geometry on success, or null on error.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public static Geometry CreateFromWkb(byte[] wkb)
/**
* Create a geometry object of the appropriate type from it's well known
* text representation.
*
* @param wkt string containing well known text
* representation of the geometry to be created.
*
* @return a geometry on success, or null on error.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public static Geometry CreateFromWkt(String wkt)
/**
* Test for crossing.
* <p>
* Tests if this geometry and the other passed into the method are crossing.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if they are crossing, otherwise false.
*/
public class Geometry:public boolean Crosses(Geometry other)
/**
* Delete a geometry.
* <p>
* Calling this method is not required as normal garbage collection will
* reclaim associated resources when the object goes out of scope.
* Otherwise calling delete() explicitly will help release resources sooner.
* Don't call any method on a deleted object !
*/
public class Geometry:public void delete()
/**
* Compute difference.
* <p>
* Generates a new geometry which is the region of this geometry with the
* region of the second geometry removed.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the other geometry removed from "this" geometry.
*
* @return a new geometry representing the difference or null if the
* difference is empty or an error occurs.
*/
public class Geometry:public Geometry Difference(Geometry other)
/**
* Test for disjointness.
* <p>
* Tests if this geometry and the other passed into the method are disjoint.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if they are disjoint, otherwise false.
*/
public class Geometry:public boolean Disjoint(Geometry other)
/**
* Compute distance between two geometries.
* <p>
* Returns the shortest distance between the two geometries.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the other geometry to compare against.
*
* @return the distance between the geometries or -1 if an error occurs.
*/
public class Geometry:public double Distance(Geometry other)
/**
* Clear geometry information.
* <p>
* This restores the geometry to it's initial
* state after construction, and before assignment of actual geometry.
* <p>
* This method relates to the SFCOM IGeometry::Empty() method.
*/
public class Geometry:public void Empty()
/**
* Returns two if two geometries are equivalent.
*
* @return true if equivalent or false otherwise.
*/
public class Geometry:public boolean Equal(Geometry other)
/**
* Convert a geometry into GML format.
* <p>
* The GML geometry is expressed directly in terms of GML basic data
* types assuming the this is available in the gml namespace.
*
* @return A GML fragment or null in case of error.
*/
public class Geometry:public String ExportToGML()
/**
* Convert a geometry into GML format.
* <p>
* The GML geometry is expressed directly in terms of GML basic data
* types assuming the this is available in the gml namespace.
*
* The supported options in OGR 1.8.0 are :
* <ul>
* <li>FORMAT=GML3. Otherwise it will default to GML 2.1.2 output.</li>
* <li>GML3_LINESTRING_ELEMENT=curve. (Only valid for FORMAT=GML3) To use gml:Curve element for linestrings. Otherwise gml:LineString will be used .</li>
* <li>GML3_LONGSRS=YES/NO. (Only valid for FORMAT=GML3) Default to YES. If YES, SRS with EPSG authority will be written with the "urn:ogc:def:crs:EPSG::" prefix. In the case, if the SRS is a geographic SRS without explicit AXIS order, but that the same SRS authority code imported with ImportFromEPSGA() should be treated as lat/long, then the function will take care of coordinate order swapping. If set to NO, SRS with EPSG authority will be written with the "EPSG:" prefix, even if they are in lat/long order.</li>
* </ul>
*
* @param options a list of strings.
* @return A GML fragment or null in case of error.
*
* @since OGR 1.8.0
*/
public class Geometry:public String ExportToGML(java.util.Vector options)
/**
* Convert a geometry into KML format.
*
* @param altitude_mode string which will be inserted in-between the <altitude_mode> tag.
*
* @return A KML fragment or null in case of error.
*/
public class Geometry:public String ExportToKML(String altitude_mode)
/**
* Convert a geometry into KML format.
*
* @return A KML fragment or null in case of error.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public String ExportToKML()
/**
* Convert a geometry into GeoJSON format.
*
* @return A GeoJSON fragment or null in case of error.
*/
public class Geometry:public String ExportToJson()
/**
* Convert a geometry into GeoJSON format.
*
* @param options a list of strings. For now, only COORDINATE_PRECISION=int_number
* where int_number is the maximum number of figures after decimal separator to write in coordinates.
* @return A GeoJSON fragment or null in case of error.
*
* @since OGR 1.9.0
*/
public class Geometry:public String ExportToJson(java.util.Vector options)
/**
* Convert a geometry into well known binary format.
* <p>
* This function relates to the SFCOM IWks::ExportToWKB() method.
*
* @param byte_order One of wkbXDR or wkbNDR indicating MSB or LSB byte order
* respectively.
*
* @return the wkb content
*
* @since Java bindings 1.7.0
*/
public class Geometry:public byte[] ExportToWkb(int byte_order)
/**
* Convert a geometry into well known binary format.
* <p>
* This function relates to the SFCOM IWks::ExportToWKB() method.
*
* @param wkbArray a sufficiently large array (at least WkbSize() large) to receive the wkb content.
* @param byte_order One of wkbXDR or wkbNDR indicating MSB or LSB byte order
* respectively.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Geometry:public int ExportToWkb(byte[] wkbArray, int byte_order)
/**
* Convert a geometry into well known binary format.
* <p>
* This function relates to the SFCOM IWks::ExportToWKB() method.
* MSB order (wkbXDR) will be used.
*
* @return the wkb content
*
* @since Java bindings 1.7.0
*/
public class Geometry:public byte[] ExportToWkb()
/**
* Convert a geometry into well known text format.
* <p>
* This method relates to the SFCOM IWks::ExportToWKT() method.
*
* @param argout an allocated array of 1 string where the WKT output will be inserted
*
* @return Currently 0 is always returned.
*/
public class Geometry:public int ExportToWkt(String[] argout)
/**
* Convert a geometry into well known text format.
* <p>
* This method relates to the SFCOM IWks::ExportToWKT() method.
*
* @return the WKT string
*
* @since Java bindings 1.7.0
*/
public class Geometry:public String ExportToWkt()
/**
* Convert geometry to strictly 2D.
* <p>
* In a sense this converts all Z coordinates
* to 0.0.
*/
public class Geometry:public void FlattenTo2D()
/**
* Compute geometry area.
* <p>
* Computes the area for an OGRLinearRing, OGRPolygon or OGRMultiPolygon.
* Undefined for all other geometry types (returns zero).
*
* @return the area or 0.0 for unsupported geometry types.
*
* @since OGR 1.8.0
*/
public class Geometry:public double Area()
/**
* Compute geometry area (deprecated).
*
* @deprecated
*
* @see #Area()
*/
public class Geometry:public double GetArea()
/**
* Compute boundary.
* <p>
* A new geometry object is created and returned containing the boundary
* of the geometry on which the method is invoked.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @return a newly allocated geometry now owned by the caller, or null on failure.
*
* @since OGR 1.8.0
*/
public class Geometry:public Geometry Boundary()
/**
* Compute boundary (deprecated).
*
* @deprecated
*
* @see #Boundary()
*/
public class Geometry:public Geometry GetBoundary()
/**
* Get the dimension of the coordinates in this object.
* <p>
* This method corresponds to the SFCOM IGeometry::GetDimension() method.
*
* @return in practice this always returns 2 indicating that coordinates are
* specified within a two dimensional space.
*/
public class Geometry:public int GetCoordinateDimension()
/**
* Get the dimension of this object.
* <p>
* This method corresponds to the SFCOM IGeometry::GetDimension() method.
* It indicates the dimension of the object, but does not indicate the
* dimension of the underlying space (as indicated by
* GetCoordinateDimension()).
*
* @return 0 for points, 1 for lines and 2 for surfaces.
*/
public class Geometry:public int GetDimension()
/**
* Computes and returns the bounding envelope for this geometry.
* <p>
* @param argout an allocated array of 4 doubles into which to place the result
*/
public class Geometry:public void GetEnvelope(double[] argout)
/**
* Computes and returns the 3D bounding envelope for this geometry.
* <p>
* @param argout an allocated array of 6 doubles into which to place the result
*
* @since OGR 1.9.0
*/
public class Geometry:public void GetEnvelope3D(double[] argout)
/**
* Fetch the number of elements in a geometry or number of geometries in
* container.
* <p>
* Only geometries of type wkbPolygon[25D], wkbMultiPoint[25D], wkbMultiLineString[25D],
* wkbMultiPolygon[25D] or wkbGeometryCollection[25D] may return a valid value.
* Other geometry types will silently return 0.
*
* For a polygon, the returned number is the number of rings (exterior ring + interior rings).
*
* @return the number of elements.
*/
public class Geometry:public int GetGeometryCount()
/**
* Fetch WKT name for geometry type.
* <p>
* There is no SFCOM analog to this method.
*
* @return name used for this geometry type in well known text format.
*/
public class Geometry:public String GetGeometryName()
/**
* Fetch geometry from a geometry container.
* <p>
* This function returns a handle to a geometry within the container.
* The returned geometry remains owned by the container, and should not be
* modified. The handle is only valid until the next change to the
* geometry container. Use Clone() to make a copy.
* <p>
* This function relates to the SFCOM
* IGeometryCollection::get_Geometry() method.
* <p>
* For a polygon, OGR_G_GetGeometryRef(iSubGeom) returns the exterior ring
* if iSubGeom == 0, and the interior rings for iSubGeom > 0.
*
* @param iSubGeom the index of the geometry to fetch, between 0 and
* GetGeometryCount() - 1.
* @return requested geometry.
*/
public class Geometry:public Geometry GetGeometryRef(int iSubGeom)
/**
* Fetch geometry type.
* <p>
* Note that the geometry type may include the 2.5D flag. To get a 2D
* flattened version of the geometry type apply the wkbFlatten() macro
* to the return result.
*
* @return the geometry type code.
*/
public class Geometry:public int GetGeometryType()
/**
* Fetch a point in line string or a point geometry.
*
* @param iPoint the vertex to fetch, from 0 to GetNumPoints()-1, zero for a point.
* @param argout an allocated array of 3 doubles to contain the x, y, z coordinates.
*/
public class Geometry:public void GetPoint(int iPoint, double[] argout)
/**
* Fetch a point in line string or a point geometry.
*
* @param iPoint the vertex to fetch, from 0 to GetNumPoints()-1, zero for a point.
* @return an allocated array of 3 doubles to contain the x, y, z coordinates.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public double[] GetPoint(int iPoint)
/**
* Fetch a point in line string or a point geometry.
*
* @param iPoint the vertex to fetch, from 0 to GetNumPoints()-1, zero for a point.
* @param argout an allocated array of 2 doubles to contain the x, y coordinates.
*/
public class Geometry:public void GetPoint_2D(int iPoint, double[] argout)
/**
* Fetch a point in line string or a point geometry.
*
* @param iPoint the vertex to fetch, from 0 to GetNumPoints()-1, zero for a point.
* @return an allocated array of 2 doubles to contain the x, y coordinates.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public double[] GetPoint_2D(int iPoint)
/**
* Fetch number of points from a geometry.
* <p>
* Only wkbPoint[25D] or wkbLineString[25D] may return a valid value.
* Other geometry types will silently return 0.
*
* @return the number of points.
*/
public class Geometry:public int GetPointCount()
/**
* Returns all points of a point or a line string.
* <p>
* This method returns an array of tuples with the [x,y] or [x,y,z] coordinates pair or triplets.
* <p>
* Only wkbPoint[25D] or wkbLineString[25D] may return a valid value.
* Other geometry types will return null.
*
* @param nCoordinateDimension if nCoordinateDimension == 0 then the number of coordinates per tuple
* will reflect the coordinate dimension of the geometry. If nCoordinateDimension == 2,
* the number of coordinates per tuple will be 2. If nCoordinateDimension == 3, the number of
* coordinates per tuple will be 3.
*
* @return the coordinates
*
* @since OGR 1.9.0
*/
public class Geometry:public double[][] GetPoints(int nCoordinateDimension)
/**
* Returns all points of a point or a line string.
* <p>
* Same as below with nCoordinateDimension == 0
*
* @return the coordinates
*
* @since OGR 1.9.0
*
* @see #GetPoints(int)
*/
public class Geometry:public double[][] GetPoints()
/**
* Returns spatial reference system for object.
* <p>
* This method relates to the SFCOM IGeometry::get_SpatialReference() method.
*
* @return a reference to the spatial reference object. The object may be
* shared with many geometry objects, and should not be modified.
*/
public class Geometry:public SpatialReference GetSpatialReference()
/**
* Fetch the x coordinate of a point from a geometry.
*
* @param ipoint point to get the x coordinate. (must be 0 for a point geometry)
* @return the X coordinate of this point.
*/
public class Geometry:public double GetX(int ipoint)
/**
* Fetch the y coordinate of a point from a geometry.
*
* @param ipoint point to get the y coordinate. (must be 0 for a point geometry)
* @return the Y coordinate of this point.
*/
public class Geometry:public double GetY(int ipoint)
/**
* Fetch the z coordinate of a point from a geometry.
*
* @param ipoint point to get the z coordinate. (must be 0 for a point geometry)
* @return the Z coordinate of this point.
*/
public class Geometry:public double GetZ(int ipoint)
/**
* Fetch the x coordinate of the first point from a geometry.
*
* @return the X coordinate of this point.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public double GetX()
/**
* Fetch the y coordinate of the first point from a geometry.
*
* @return the Y coordinate of this point.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public double GetY()
/**
* Fetch the z coordinate of the first point from a geometry.
*
* @return the Z coordinate of this point.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public double GetZ()
/**
* Do these features intersect?
*
* @deprecated
*
* @see #Intersects(Geometry)
*/
public class Geometry:public boolean Intersect(Geometry other)
/**
* Do these features intersect?
* <p>
* Determines whether two geometries intersect. If GEOS is enabled, then
* this is done in rigorous fashion otherwise true is returned if the
* envelopes (bounding boxes) of the two features overlap.
* <p>
* The geom argument may be safely null, but in this case the method
* will always return true. That is, a null geometry is treated as being
* everywhere.
*
* @param other the other geometry to test against.
*
* @return true if the geometries intersect, otherwise false.
*
* @since OGR 1.8.0
*/
public class Geometry:public boolean Intersects(Geometry other)
/**
* Compute intersection.
* <p>
* Generates a new geometry which is the region of intersection of the
* two geometries operated on. The Intersects() method can be used to test if
* two geometries intersect.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the other geometry intersected with "this" geometry.
*
* @return a new geometry representing the intersection or null if there is
* no intersection or an error occurs.
*
* @see #Intersects(Geometry)
*/
public class Geometry:public Geometry Intersection(Geometry other)
/**
* Returns true (non-zero) if the object has no points.
* <p>
* Normally this
* returns false except between when an object is instantiated and points
* have been assigned.
*
* This method relates to the SFCOM IGeometry::IsEmpty() method.
*
* @return true if object is empty, otherwise false.
*/
public class Geometry:public boolean IsEmpty()
/**
* Test if the geometry is valid.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always return
* false.
*
*
* @return true if the geometry has no points, otherwise false.
*/
public class Geometry:public boolean IsValid()
/**
* Test if the geometry is simple.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always return
* false.
*
*
* @return true if the geometry has no points, otherwise false.
*/
public class Geometry:public boolean IsSimple()
/**
* Test if the geometry is a ring.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always return
* false.
*
*
* @return true if the geometry has no points, otherwise false.
*/
public class Geometry:public boolean IsRing()
/**
* Test for overlap.
* <p>
* Tests if this geometry and the other passed into the method overlap, that is
* their intersection has a non-zero area.
*
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if they are overlapping, otherwise false.
*/
public class Geometry:public boolean Overlaps(Geometry other)
/**
* Modify the geometry such it has no segment longer then the given distance.
* <p>
* Interpolated points will have Z and M values (if needed) set to 0.
* Distance computation is performed in 2d only
*
* @param max_length the maximum distance between 2 points after segmentization
*
* @since Java bindings 1.7.0
*/
public class Geometry:public void Segmentize(double max_length)
/**
* Set the coordinate dimension.
* <p>
* This method sets the explicit coordinate dimension. Setting the coordinate
* dimension of a geometry to 2 should zero out any existing Z values. Setting
* the dimension of a geometry collection will not necessarily affect the
* children geometries.
*
* @param dimension New coordinate dimension value, either 2 or 3.
*/
public class Geometry:public void SetCoordinateDimension(int dimension)
/**
* Set the location of a vertex in a point or linestring geometry.
* <p>
* If ipoint is larger than the number of existing
* points in the linestring, the point count will be increased to
* accommodate the request.
*
* @param ipoint the index of the vertex to assign (zero based) or
* zero for a point.
* @param x input X coordinate to assign.
* @param y input Y coordinate to assign.
*/
public class Geometry:public void SetPoint_2D(int ipoint, double x, double y)
/**
* Set the location of a vertex in a point or linestring geometry.
* <p>
* If ipoint is larger than the number of existing
* points in the linestring, the point count will be increased to
* accommodate the request.
*
* @param ipoint the index of the vertex to assign (zero based) or
* zero for a point.
* @param x input X coordinate to assign.
* @param y input Y coordinate to assign.
* @param z input Z coordinate to assign (defaults to zero).
*/
public class Geometry:public void SetPoint(int ipoint, double x, double y, double z)
/**
* Set the location of a vertex in a point or linestring geometry.
* <p>
* If ipoint is larger than the number of existing
* points in the linestring, the point count will be increased to
* accommodate the request.
*
* @param ipoint the index of the vertex to assign (zero based) or
* zero for a point.
* @param x input X coordinate to assign.
* @param y input Y coordinate to assign.
*
* @since Java bindings 1.7.0
*/
public class Geometry:public void SetPoint(int ipoint, double x, double y)
/**
* Simplify the geometry.
* <p>
* This function is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this function will always fail,
* issuing a CPLE_NotSupported error.
*
* @param dTolerance the distance tolerance for the simplification.
*
* @return the simplified geometry or null if an error occurs.
*
* @since OGR 1.8.0
*/
public class Geometry:public Geometry Simplify(double dTolerance)
/**
* Simplify the geometry while preserving topology.
* <p>
* This function is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this function will always fail,
* issuing a CPLE_NotSupported error.
*
* @param dTolerance the distance tolerance for the simplification.
*
* @return the simplified geometry or null if an error occurs.
*
* @since OGR 1.9.0
*/
public class Geometry:public Geometry SimplifyPreserveTopology(double dTolerance)
/**
* Compute symmetric difference.
* <p>
* Generates a new geometry which is the symmetric difference of this
* geometry and the second geometry passed into the method.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the other geometry.
*
* @return a new geometry representing the symmetric difference or null if the
* difference is empty or an error occurs.
*
* @since OGR 1.8.0
*/
public class Geometry:public Geometry SymDifference(Geometry other)
/**
* Compute symmetric difference (deprecated).
*
* @deprecated
*
* @see #SymDifference(Geometry)
*/
public class Geometry:public Geometry SymmetricDifference(Geometry other)
/**
* Test for touching.
* <p>
* Tests if this geometry and the other passed into the method are touching.
*
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if they are touching, otherwise false.
*/
public class Geometry:public boolean Touches(Geometry other)
/**
* Transform geometry to new spatial reference system.
* <p>
* This method will transform the coordinates of a geometry from
* their current spatial reference system to a new target spatial
* reference system. Normally this means reprojecting the vectors,
* but it could include datum shifts, and changes of units.
* <p>
* This method will only work if the geometry already has an assigned
* spatial reference system, and if it is transformable to the target
* coordinate system.
* <p>
* Because this method requires internal creation and initialization of an
* CoordinateTransformation object it is significantly more expensive to
* use this method to transform many geometries than it is to create the
* CoordinateTransformation in advance, and call transform() with that
* transformation. This method exists primarily for convenience when only
* transforming a single geometry.
*
* @param srs spatial reference system to transform to.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Geometry:public int TransformTo(SpatialReference srs)
/**
* Apply arbitrary coordinate transformation to geometry.
* <p>
* This method will transform the coordinates of a geometry from
* their current spatial reference system to a new target spatial
* reference system. Normally this means reprojecting the vectors,
* but it could include datum shifts, and changes of units.
* <p>
* Note that this method does not require that the geometry already
* have a spatial reference system. It will be assumed that they can
* be treated as having the source spatial reference system of the
* CoordinateTransformation object, and the actual SRS of the geometry
* will be ignored. On successful completion the output OGRSpatialReference
* of the CoordinateTransformation will be assigned to the geometry.
*
* @param ct the transformation to apply.
*
* @return 0 on success. Otherwise throws a RuntimeException (or an error code if DontUseExceptions() has been called).
*/
public class Geometry:public int Transform(CoordinateTransformation ct)
/**
* Compute union.
* <p>
* Generates a new geometry which is the region of union of the
* two geometries operated on.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the other geometry unioned with "this" geometry.
*
* @return a new geometry representing the union or null if an error occurs.
*/
public class Geometry:public Geometry Union(Geometry other)
/**
* Compute union using cascading.
* <p>
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail,
* issuing a CPLE_NotSupported error.
*
* @return a new geometry representing the union or null if an error occurs.
*
* @since OGR 1.8.0
*/
public class Geometry:public Geometry UnionCascaded()
/**
* Test for containment.
* <p>
* Tests if actual geometry object is within the passed geometry.
*
* This method is built on the GEOS library, check it for the definition
* of the geometry operation.
* If OGR is built without the GEOS library, this method will always fail.
*
* @param other the geometry to compare to this geometry.
*
* @return true if poOtherGeom is within this geometry, otherwise false.
*/
public class Geometry:public boolean Within(Geometry other)
/**
* Returns size of related binary representation.
* <p>
* This method returns the exact number of bytes required to hold the
* well known binary representation of this geometry object. Its computation
* may be slightly expensive for complex geometries.
*
* This method relates to the SFCOM IWks::WkbSize() method.
*
* @return size of binary representation in bytes.
*/
public class Geometry:public int WkbSize()
/**
* Returns the length of the geometry
* @return length of the geometry
* @since Java bindings 1.8.0
*/
public class Geometry:public double Length()
/* Class FeatureDefn */
/**
* Definition of a feature class or feature layer.
*
* <p>
* The FeatureDefn class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRFeatureDefn.html">OGRFeatureDefn</a> class.
* <p>
* This object contains schema information for a set of Feature. In table based systems,
* a FeatureDefn is essentially a layer. In more object oriented approaches (such as SF CORBA)
* this can represent a class of features but doesn't necessarily relate to all of a layer, or just one layer.
* <p>
* This object also can contain some other information such as a name, the base geometry type and potentially other metadata.
* <p>
* It is reasonable for different translators to derive classes from FeatureDefn with additional translator specific information.
*/
public class FeatureDefn
/**
* Constructor.
* <p>
* The FeatureDefn maintains a reference count, but this starts at
* zero. It is mainly intended to represent a count of Feature's
* based on this definition.
* The FeatureDefn will be unnamed.
*/
public class FeatureDefn:public FeatureDefn()
/**
* Constructor.
* <p>
* The FeatureDefn maintains a reference count, but this starts at
* zero. It is mainly intended to represent a count of Feature's
* based on this definition.
*
* @param name the name to be assigned to this layer/class. It does not
* need to be unique. and may be null.
*
* @since Java bindings 1.7.0
*/
public class FeatureDefn:public FeatureDefn(String name)
/**
* Add a new field definition.
* <p>
* To add a new field definition to a layer definition, do not use this
* function directly, but use Layer.<a href="Layer.html#CreateField(org.gdal.ogr.FieldDefn)">CreateField()</a> instead.
* <p>
* This method should only be called while there are no Feature
* objects in existence based on this FeatureDefn. The FieldDefn
* passed in is copied, and remains the responsibility of the caller.
*
* @param defn the definition of the new field.
*/
public class FeatureDefn:public void AddFieldDefn(FieldDefn defn)
/**
* Fetch number of fields on this feature.
*
* @return count of fields.
*/
public class FeatureDefn:public int GetFieldCount()
/**
* Get name of this FeatureDefn.
*
* @return the name.
*/
public class FeatureDefn:public String GetName()
/**
* Get name of this FeatureDefn (when it is not UTF-8 encoded).
*
* @return the name
* @since 3.10
*/
public class FeatureDefn:public byte GetNameAsByteArray()
/**
/**
* Fetch field definition.
*
* @param ifield the field to fetch, between 0 and GetFieldCount()-1.
*
* @return a pointer to an internal field definition object. This object
* should not be modified or freed by the application.
*/
public class FeatureDefn:public FieldDefn GetFieldDefn(int ifield)
/**
* Find field by name.
* <p>
* The field index of the first field matching the passed field name (case
* insensitively) is returned.
*
* @param name the field name to search for.
*
* @return the field index, or -1 if no match found.
*/
public class FeatureDefn:public int GetFieldIndex(String name)
/**
* Determine whether the geometry can be omitted when fetching features.
*
* @return ignore state (1 if ignored, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FeatureDefn:public int IsGeometryIgnored()
/**
* Set whether the geometry can be omitted when fetching features.
*
* @param bIgnore ignore state (1 to ignore, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FeatureDefn:public void SetGeometryIgnored(int bIgnore)
/**
* Determine whether the style can be omitted when fetching features.
*
* @return ignore state (1 if ignored, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FeatureDefn:public int IsStyleIgnored()
/**
* Set whether the style can be omitted when fetching features.
*
* @param bIgnore ignore state (1 to ignore, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FeatureDefn:public void SetStyleIgnored(int bIgnore)
/**
* Fetch the geometry base type.
* <p>
* Note that some drivers are unable to determine a specific geometry
* type for a layer, in which case wkbUnknown is returned. A value of
* wkbNone indicates no geometry is available for the layer at all.
* Many drivers do not properly mark the geometry
* type as 25D even if some or all geometries are in fact 25D. A few (broken)
* drivers return wkbPolygon for layers that also include wkbMultiPolygon.
*
* @return the base type for all geometry related to this definition.
*/
public class FeatureDefn:public int GetGeomType()
/**
* Assign the base geometry type for this layer.
* <p>
* All geometry objects using this type must be of the defined type or
* a derived type. The default upon creation is wkbUnknown which allows for
* any geometry type. The geometry type should generally not be changed
* after any Features have been created against this definition.
*
* @param geom_type the new type to assign.
*/
public class FeatureDefn:public void SetGeomType(int geom_type)
/**
* Fetch current reference count.
*
* @return the current reference count.
*/
public class FeatureDefn:public int GetReferenceCount()
/* Class FieldDefn */
/**
* Definition of an attribute of a FeatureDefn.
*
* <p>
* The FieldDefn class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRFieldDefn.html">OGRFieldDefn</a> class.
*/
public class FieldDefn
/**
* Constructor.
* <p>
* The new field will be named "unnamed" and of type OFTString
*
* @since Java bindings 1.7.0
*/
public class FieldDefn:public FieldDefn()
/**
* Constructor.
* <p>
* The new field will be of type OFTString
* @param name the name of the new field.
*
* @since Java bindings 1.7.0
*/
public class FieldDefn:public FieldDefn(String name)
/**
* Constructor.
*
* @param name the name of the new field.
* @param field_type the type of the new field.
*/
public class FieldDefn:public FieldDefn(String name, int field_type)
/**
* Return the field type
*
* @return the field type
*/
public class FieldDefn:public int GetFieldType()
/**
* Fetch human readable name for a field type.
*
* @param type the field type to get name for.
*
* @return field type name
*/
public class FieldDefn:public String GetFieldTypeName(int type)
/**
* Get the justification for this field.
*
* @return the justification.
*/
public class FieldDefn:public int GetJustify()
/**
* Get the name of this field.
*
* @return the name of the field
*/
public class FieldDefn:public String GetName()
/**
* Get the name of this field (when it is not UTF-8 encoded).
*
* @return the name of the field
* @since 3.10
*/
public class FieldDefn:public byte GetNameAsByteArray()
/**
* Fetch name of this field.
*
* @return the name of the field
*/
public class FieldDefn:public String GetNameRef()
/**
* Get the formatting precision for this field.
* <p>
* This should normally be
* zero for fields of types other than OFTReal.
*
* @return the precision.
*/
public class FieldDefn:public int GetPrecision()
/**
* Fetch human readable name for the field
*
* @return field type name
*/
public class FieldDefn:public String GetTypeName()
/**
* Get the formatting width for this field.
*
* @return the width, zero means no specified width.
*/
public class FieldDefn:public int GetWidth()
/**
* Set the justification for this field.
*
* @param justify the new justification.
*/
public class FieldDefn:public void SetJustify(int justify)
/**
* Reset the name of this field.
*
* @param name the new name to apply.
*/
public class FieldDefn:public void SetName(String name)
/**
* Set the formatting precision for this field in characters.
* <p>
* This should normally be zero for fields of types other than OFTReal.
*
* @param precision the new precision.
*/
public class FieldDefn:public void SetPrecision(int precision)
/**
* Set the type of this field.
* <p>
* This should never be done to an FieldDefn
* that is already part of an FeatureDefn.
*
* @param type the new field type.
*/
public class FieldDefn:public void SetType(int type)
/**
* Set the formatting width for this field in characters.
*
* @param width the new width.
*/
public class FieldDefn:public void SetWidth(int width)
/**
* Return whether this field should be omitted when fetching features.
*
* @return ignore state (1 if ignored, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FieldDefn:public int IsIgnored()
/**
* Set whether this field should be omitted when fetching features.
*
* @param bIgnored ignore state (1 to ignore, 0 otherwise)
*
* @since OGR 1.8.0
*/
public class FieldDefn:public void SetIgnored(int bIgnored)
/* Class ogr */
/**
* Class ogr is an uninstanciable class providing various utility functions as static methods.
* <p>
* In particular, it provides ogr.<a href="#RegisterAll()">RegisterAll()</a> and ogr.<a href="#Open(java.lang.String, int)">Open()</a> methods.
*/
public class ogr
/**
* Use exceptions instead of error return codes.
* <p>
* This is the default behavior : methods that in C/C++ return an OGRErr return code
* would throw a RuntimeException() in case the code it is different
* from ogr.OGRERR_NONE. By calling this method, you can get
* back to that original state if DontUseExceptions() was called in-between.
* This will only apply to the org.gdal.ogr.* package.
*
* @since Java bindings 1.7.0
*/
public class ogr:public static void UseExceptions()
/**
* Use return code instead of exceptions.
* <p>
* By default, methods that in C/C++ return an OGRErr return code
* would throw a RuntimeException() in case the code it is different
* from ogr.OGRERR_NONE. By calling this method, you can prevent
* the exception to be thrown and get the original error code
* (ogr.OGRERR_* codes)
* This will only apply to the org.gdal.ogr.* package.
*
* @since Java bindings 1.7.0
*/
public class ogr:public static void DontUseExceptions()
/**
* Stroke arc to linestring.
* <p>
* Stroke an arc of a circle to a linestring based on a center
* point, radius, start angle and end angle, all angles in degrees.
*
* @param dfCenterX center X
* @param dfCenterY center Y
* @param dfZ center Z
* @param dfPrimaryRadius X radius of ellipse.
* @param dfSecondaryRadius Y radius of ellipse.
* @param dfRotation rotation of the ellipse clockwise.
* @param dfStartAngle angle to first point on arc (clockwise of X-positive)
* @param dfEndAngle angle to last point on arc (clockwise of X-positive)
* @param dfMaxAngleStepSizeDegrees the largest step in degrees along the arc.
*
* @return LineString geometry representing an approximation of the arc.
*
* @since Java bindings 1.7.0
*/
public class ogr:public static Geometry ApproximateArcAngles(double dfCenterX, double dfCenterY, double dfZ, double dfPrimaryRadius, double dfSecondaryRadius, double dfRotation, double dfStartAngle, double dfEndAngle, double dfMaxAngleStepSizeDegrees)
/**
* Build a ring from a bunch of arcs.
* <p>
* Same as below with bAutoClose == 0 and dfTolerance == 0.
*
* @see #BuildPolygonFromEdges(Geometry lineCollection, int bBestEffort, int bAutoClose, double dfTolerance)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static Geometry BuildPolygonFromEdges(Geometry hLineCollection, int bBestEffort)
/**
* Build a ring from a bunch of arcs.
* <p>
* Same as below with dfTolerance == 0.
*
* @see #BuildPolygonFromEdges(Geometry lineCollection, int bBestEffort, int bAutoClose, double dfTolerance)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static Geometry BuildPolygonFromEdges(Geometry hLineCollection, int bBestEffort, int bAutoClose)
/**
* Build a ring from a bunch of arcs.
*
* @param lineCollection geometry of type OGRGeometryCollection (or OGRMultiLineString) containing the line string geometries to be built into rings.
* @param bBestEffort not yet implemented???.
* @param bAutoClose indicates if the ring should be close when first and
* last points of the ring are the same.
* @param dfTolerance tolerance into which two arcs are considered
* close enough to be joined.
* @return a polygon or null in case of failure
*/
public class ogr:public static Geometry BuildPolygonFromEdges(Geometry lineCollection, int bBestEffort, int bAutoClose, double dfTolerance)
/**
* Create a new Geometry from a GML string.
*
* @param gml the GML string
* @return the new geometry
*/
public class ogr:public static Geometry CreateGeometryFromGML(String gml)
/**
* Create a new Geometry from a GeoJSON string.
*
* @param json the GeoJSON string
* @return the new geometry
*/
public class ogr:public static Geometry CreateGeometryFromJson(String json)
/**
* Create a new Geometry from a well known binary (wkb) content.
*
* @param wkb the wkb content
* @return the new geometry
*
* @since Java bindings 1.7.0
*/
public class ogr:public static Geometry CreateGeometryFromWkb(byte[] wkb)
/**
* Create a new Geometry from a well known binary (wkb) content.
*
* @param wkb the wkb content
* @param srs the srs to assign to the geometry
* @return the new geometry
*/
public class ogr:public static Geometry CreateGeometryFromWkb(byte[] wkb, SpatialReference srs)
/**
* Create a new Geometry from a well known text (wkt) string.
*
* @param wkt the wkt content
* @return the new geometry
*
* @since Java bindings 1.7.0
*/
public class ogr:public static Geometry CreateGeometryFromWkt(String wkt)
/**
* Create a new Geometry from a well known text (wkt) content.
*
* @param wkt the wkt content
* @param srs the srs to assign to the geometry
* @return the new geometry
*/
public class ogr:public static Geometry CreateGeometryFromWkt(String wkt, SpatialReference srs)
/**
* General utility option processing.
* <p>
* This function is intended to provide a variety of generic commandline
* options for all OGR commandline utilities. It takes care of the following
* commandline options:
* <p><ul>
* <li>--version: report version of OGR in use.
* <li>--license: report OGR license info.
* <li>--formats: report all format drivers configured.
* <li>--format [format]: report details of one format driver.
* <li>--optfile filename: expand an option file into the argument list.
* <li>--config key value: set system configuration option.
* <li>--debug [on/off/value]: set debug level.
* <li>--mempreload dir: preload directory contents into /vsimem
* <li>--help-general: report detailed help on general options.
* </ul><p>
* The typical usage looks something like the following. Note that the formats
* should be registered so that the --formats and --format options will work properly.
* <pre>
* public static void main( Strings[] args )
* {
* ogr.RegisterAll();
*
* args = ogr.GeneralCmdLineProcessor( args, 0 );
* }
* </pre>
* @param args the argument list array
* @param options currently unused
*
* @return updated argument list array.
*
* @since Java bindings 1.7.0
*/
public class ogr:public static String[] GeneralCmdLineProcessor(String[] args, int options)
/**
* General utility option processing.
* <p>
* Same as below with options == 0
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static String[] GeneralCmdLineProcessor(String[] args)
/**
* General utility option processing.
* <p>
* Same as below but with arguments as a Vector of strings
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args, int options)
/**
* General utility option processing.
* <p>
* Same as below but with arguments as a Vector of strings and options == 0
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args)
/**
* Fetch a human readable name corresponding to an OGRwkBGeometryType value.
*
* @param eType the geometry type.
*
* @return human readable string, or null on failure.
*
* @since Java bindings 1.7.0
*/
public class ogr:public static String GeometryTypeToName(int eType)
/**
Fetch the indicated driver.
@param iDriver the driver index, from 0 to GetDriverCount()-1.
@return the driver, or null if iDriver is out of range.
*/
public class ogr:public static Driver GetDriver(int iDriver)
/**
Fetch the indicated driver.
@param name the driver name
@return the driver, or null if no driver with that name is found
*/
public class ogr:public static Driver GetDriverByName(String name)
/**
Fetch the number of registered drivers.
@return the drivers count.
*/
public class ogr:public static int GetDriverCount()
/**
* Fetch human readable name for a field type.
*
* @param type the field type to get name for.
*
* @return field type name
*
* @since Java bindings 1.7.0
*/
public class ogr:public static String GetFieldTypeName(int type)
/**
Return the iDS th datasource opened.
@param iDS the index of the dataset to return (between 0 and GetOpenDSCount() - 1)
*/
public class ogr:public static DataSource GetOpenDS(int iDS)
/**
Return the number of opened datasources.
@return the number of opened datasources.
*/
public class ogr:public static int GetOpenDSCount()
/**
* Open a file / data source with one of the registered drivers.
* <p>
* Same as below with update == 0
*
* @see #Open(String filename, int update)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static DataSource Open(String filename)
/**
* Open a file / data source with one of the registered drivers.
* <p>
* Same as below with boolean value being transformed to 1 (for true) or 0 (for false)
*
* @see #Open(String filename, int update)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static DataSource Open(String filename, boolean update)
/**
Open a file / data source with one of the registered drivers.
<p>
This method loops through all the drivers registered with the driver
manager trying each until one succeeds with the given data source.
<p>
If this method fails, gdal.GetLastErrorMsg() can be used to check if there
is an error message explaining why.
<p>
The returned dataset should be properly closed with the
DataSource.<a href="DataSource.html#delete()">delete()</a> method.
<p>
<b>Example:</b>
<pre>
DataSource ds = ogr.Open( "polygon.shp" );
if( ds == null )
{
return;
}
... use the data source ...
ds.delete();
</pre>
@param filename the name of the file, or data source to open.
@param update 0 for read-only access (the default) or 1 for
read-write access.
@return null on error or if the pass name is not supported by this driver,
otherwise a pointer to an DataSource. This DataSource should be
closed by calling the delete() method when it is no longer needed.
*/
public class ogr:public static DataSource Open(String filename, int update)
/**
* Open a file / data source with one of the registered drivers.
* <p>
* This first try finding an existing open dataset matching exactly
* on the original datasource raw name used to open the
* datasource.
* <p>
* NOTE: It is an error, but currently we ignore the bUpdate,
* and return whatever is open even if it is read-only and the
* application requested update access.
*
* @see #Open(String filename, int update)
*
* @since Java bindings 1.7.0
*/
public class ogr:public static DataSource OpenShared(String filename)
/**
* Open a file / data source with one of the registered drivers.
* <p>
* This first try finding an existing open dataset matching exactly
* on the original datasource raw name used to open the
* datasource.
* <p>
* NOTE: It is an error, but currently we ignore the bUpdate,
* and return whatever is open even if it is read-only and the
* application requested update access.
*
* @see #Open(String filename, int update)
*/
public class ogr:public static DataSource OpenShared(String filename, int update)
/**
* Register all known configured OGR drivers.
* <p>
* This function will drive any of the following that are configured into
* OGR. Many others as well that haven't been updated in this
* documentation (see <a href="http://gdal.org/ogr/ogr_formats.html">full list</a>):
* <p>
* <ul>
* <li>Arc/Info Binary Coverage</li>
* <li>Arc/Info .E00 (ASCII) Coverage</li>
* <li>Atlas BNA</li>
* <li>Comma Separated Value (.csv)</li>
* <li>DODS/OPeNDAP</li>
* <li>ESRI Personal GeoDatabase</li>
* <li>ESRI ArcSDE</li>
* <li>ESRI Shapefile</li>
* <li>FMEObjects Gateway</li>
* <li>GeoJSON</li>
* <li>Geoconcept Export</li>
* <li>GeoRSS</li>
* <li>GML</li>
* <li>GMT</li>
* <li>GPX</li>
* <li>GRASS</li>
* <li>Informix DataBlade</li>
* <li>INTERLIS</li>
* <li>INGRES</li>
* <li>KML</li>
* <li>Mapinfo File</li>
* <li>Microstation DGN</li>
* <li>Memory</li>
* <li>MySQL</li>
* <li>Oracle Spatial</li>
* <li>ODBC</li>
* <li>OGDI Vectors</li>
* <li>PostgreSQL</li>
* <li>S-57 (ENC)</li>
* <li>SDTS</li>
* <li>SQLite</li>
* <li>UK .NTF</li>
* <li>U.S. Census TIGER/Line</li>
* <li>VRT - Virtual Datasource</li>
* <li>X-Plane/Flightgear aeronautical data</li>
* </ul>
* <p>
* This function should generally be called once at the beginning of the application.
*/
public class ogr:public static void RegisterAll()
/**
* Special entry point to enable the hack for generating DB2 V7.2 style WKB.
* <p>
* DB2 seems to have placed (and require) an extra 0x30 or'ed with the byte order in
* WKB. This entry point is used to turn on or off the
* generation of such WKB.
*/
public class ogr:public static int SetGenerate_DB2_V72_BYTE_ORDER(int bGenerate_DB2_V72_BYTE_ORDER)
/**
* Convert to polygon.
* <p>
* Tries to force the provided geometry to be a polygon. Currently
* this just effects a change on multipolygons.
* <p>
* Note: contrary to the C/C++ method, a new object is returned.
*
* @param geom the input geometry
* @return new geometry.
* @since Java bindings 1.8.0
*/
public class ogr:public static Geometry ForceToPolygon(Geometry geom)
/**
* Convert to multipolygon.
* <p>
* Tries to force the provided geometry to be a multipolygon. Currently
* this just effects a change on polygons.
* <p>
* Note: contrary to the C/C++ method, a new object is returned.
*
* @param geom the input geometry
* @return new geometry.
* @since Java bindings 1.8.0
*/
public class ogr:public static Geometry ForceToMultiPolygon(Geometry geom)
/**
* Convert to multipoint.
* <p>
* Tries to force the provided geometry to be a multipoint. Currently
* this just effects a change on points.
* <p>
* Note: contrary to the C/C++ method, a new object is returned.
*
* @param geom the input geometry
* @return new geometry.
* @since Java bindings 1.8.0
*/
public class ogr:public static Geometry ForceToMultiPoint(Geometry geom)
/**
* Convert to multilinestring.
* <p>
* Tries to force the provided geometry to be a multilinestring.
* <ul>
* <li>linestrings are placed in a multilinestring.
* <li>geometry collections will be converted to multilinestring if they only
* contain linestrings.
* <li>polygons will be changed to a collection of linestrings (one per ring).
* </ul>
* <p>
* Note: contrary to the C/C++ method, a new object is returned.
*
* @param geom the input geometry
* @return new geometry.
* @since Java bindings 1.8.0
*/
public class ogr:public static Geometry ForceToMultiLineString(Geometry geom)
/** Creates a new coded field domain.
*
* This is the same as the C++ method OGRCodedFieldDomain::OGRCodedFieldDomain()
*
* @param name Domain name. Should not be NULL.
* @param description Domain description (can be NULL)
* @param type Field type. Generally numeric. Potentially OFTDateTime
* @param subtype Field subtype.
* @param enumeration Enumeration as (code, value) pairs. Should not be
* NULL. The enumeration will be copied.
*
* @return new field domain.
* @since Java bindings 3.8.0
*/
public class ogr:public static FieldDomain CreateCodedFieldDomain(String name, String description, int type, int subtype, java.util.HashMap<String, String> enumeration)
/**
* Definition of a field domain.
*
* A field domain is a set of constraints that apply to one or several fields.
*
* This is a concept found in
* <a href="https://desktop.arcgis.com/en/arcmap/latest/manage-data/geodatabases/an-overview-of-attribute-domains.htm">File
* Geodatabase</a> or GeoPackage (using the <a href="http://www.geopackage.org/spec/#extension_schema">schema extension</a>)
* for example.
*
* A field domain can be:
* <ul>
* <li>OGRCodedFieldDomain: an enumerated list of (code, value) tuples.</li>
* <li>OGRRangeFieldDomain: a range constraint (min, max).</li>
* <li>OGRGlobFieldDomain: a glob expression.</li>
* </ul>
*
* @since GDAL 3.3
*/
public class FieldDomain
/** Get the enumeration as (code, value) pairs.
*
* This is the same as the C++ method OGRCodedFieldDomain::GetEnumeration()
*
* @return the (code, value) pairs, or nullptr in case of error.
* @since Java bindings 3.8.0
*/
public class FieldDomain:public java.util.HashMap<String, String> GetEnumeration()
/* Class SpatialReference */
/**
* This class represents an OpenGIS Spatial Reference System, and contains
* methods for converting between this object organization and well known
* text (WKT) format. This object is reference counted as one instance of
* the object is normally shared between many Geometry objects.
* <p>
* The SpatialReference class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRSpatialReference.html">OGRSpatialReference</a> class.
* <p>
* Normally application code can fetch needed parameter values for this
* SRS using GetAttrValue(), but in special cases the underlying parse tree
* (or OGR_SRSNode objects) can be accessed more directly.
* <p>
* See <a href="https://gdal.org/tutorials/osr_api_tut.html">the tutorial</a> for more information on
* how to use this class.
*/
public class SpatialReference
/**
* Constructor.
* <p>
* This constructor takes an optional string argument which if passed
* should be a WKT representation of an SRS. Passing this is equivalent
* to not passing it, and then calling importFromWkt() with the WKT string.
* <p>
* Note that newly created objects are given a reference count of one.
*
* @param wkt well known text definition to which the object should
* be initialized, or null (the default).
*/
public class SpatialReference:public SpatialReference(String wkt)
/**
* Constructor.
* <p>
* Same as below with wkt == null.
*
* @see #SpatialReference(String wkt)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public SpatialReference()
/**
* Convert this SRS into a pretty WKT format.
*
* @return the srs
*/
public class SpatialReference:public String __str__()
/**
* Set EPSG authority info if possible.
* <p>
* This method inspects a WKT definition, and adds EPSG authority nodes
* where an aspect of the coordinate system can be easily and safely
* corresponded with an EPSG identifier. In practice, this method will
* evolve over time. In theory it can add authority nodes for any object
* (i.e. spheroid, datum, GEOGCS, units, and PROJCS) that could have an
* authority node. Mostly this is useful to inserting appropriate
* PROJCS codes for common formulations (like UTM n WGS84).
* <p>
* If it success the OGRSpatialReference is updated in place, and the
* method return 0. If the method fails to identify the
* general coordinate system, a RuntimeException() will be throwned
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int AutoIdentifyEPSG()
/**
* Make a duplicate of this SpatialReference object.
*
* @return a new SRS, which becomes the responsibility of the caller.
*/
public class SpatialReference:public SpatialReference Clone()
/**
* Make a duplicate of the GEOGCS node of this SpatialReference object.
*
* @return a new SRS, which becomes the responsibility of the caller.
*/
public class SpatialReference:public SpatialReference CloneGeogCS()
/**
* Copy GEOGCS from another OGRSpatialReference.
* <p>
* The GEOGCS information is copied into this SpatialReference from another.
* If this object has a PROJCS root already, the GEOGCS is installed within
* it, otherwise it is installed as the root.
*
* @param src_srs the spatial reference to copy the GEOGCS information from.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int CopyGeogCSFrom(SpatialReference src_srs)
/**
* Export coordinate system in Mapinfo style CoordSys format.
*
* @return the coordinate system in Mapinfo style CoordSys format.
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToMICoordSys()
/**
* Export coordinate system in Mapinfo style CoordSys format.
*
* @param argout an already allocated array of 1 string to receive the output
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ExportToMICoordSys(String[] argout)
/**
* Export coordinate system in PCI projection definition.
* <p>
* Converts the loaded coordinate reference system into PCI projection
* definition to the extent possible.
* <p>
* LOCAL_CS coordinate systems are not translatable. An empty string
* will be returned along with 0.
*
* @param proj an already allocated array of 1 string to receive the PCI projection
* definition
*
* @param units an already allocated array of 1 string to receive units definition
*
* @param params an already allocated array of 17 doubles to receive the 17
* projection parameters will be assigned. See importFromPCI() for the list of parameters.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ExportToPCI(String[] proj, String[] units, double[] params)
/**
* Convert this SRS into a nicely formatted WKT string for display to a person.
* <p>
* Same as below with simplify == 0 and the string is returned as a return value
*
* @see #ExportToPrettyWkt(String[] argout, int simplify)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToPrettyWkt()
/**
* Convert this SRS into a nicely formatted WKT string for display to a person.
* <p>
* Same as below but the string is returned as a return value
*
* @see #ExportToPrettyWkt(String[] argout, int simplify)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToPrettyWkt(int simplify)
/**
* Convert this SRS into a nicely formatted WKT string for display to a person.
* <p>
* Same as below with simplify == 0.
*
* @see #ExportToPrettyWkt(String[] argout, int simplify)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ExportToPrettyWkt(String[] argout)
/**
* Convert this SRS into a nicely formatted WKT string for display to a person.
*
* @param argout an already allocated array of 1 string to receive the output
* @param simplify 1 if the AXIS, AUTHORITY and EXTENSION nodes should be stripped off
*
* @return 0.
*/
public class SpatialReference:public int ExportToPrettyWkt(String[] argout, int simplify)
/**
* Export coordinate system in PROJ.4 format.
* <p>
* Same as below but the string is returned as a return value
*
* @see #ExportToProj4(String[] argout)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToProj4()
/**
* Export coordinate system in PROJ.4 format.
* <p>
* Converts the loaded coordinate reference system into PROJ.4 format
* to the extent possible.
* <p>
* LOCAL_CS coordinate systems are not translatable. An empty string
* will be returned along with 0.
*
* @param argout an already allocated array of 1 string to receive the PROJ.4 definition
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ExportToProj4(String[] argout)
/**
* Export coordinate system in USGS GCTP projection definition.
*
* @param projsys an already allocated array of 1 integer to receive the projection system code.
*
* @param zone an already allocated array of 1 integer to receive the zone for UTM and State Plane
* projection.
*
* @param params n already allocated array of 15 doubles to receive
* 15 projection parameters. See importFromUSGS() for
* the list of parameters.
*
* @param datum an already allocated array of 1 integer to receive the datum code.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ExportToUSGS(int[] projsys, int[] zone, double[] params, int[] datum)
/**
* Convert this SRS into WKT format.
* <p>
* Same as below but the string is returned as a return value
*
* @see #ExportToWkt(String[] argout)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToWkt()
/**
* Convert this SRS into WKT format.
*
* @param argout an already allocated array of 1 string to receive the output
*
* @return 0.
*/
public class SpatialReference:public int ExportToWkt(String[] argout)
/**
* Export coordinate system in XML format.
*
* @see #ExportToXML(String[] argout, String dialect)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToXML()
/**
* Export coordinate system in XML format.
*
* @see #ExportToXML(String[] argout, String dialect)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String ExportToXML(String dialect)
/**
* Export coordinate system in XML format.
*
* @see #ExportToXML(String[] argout, String dialect)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ExportToXML(String[] argout)
/**
* Export coordinate system in XML format.
* <p>
* Converts the loaded coordinate reference system into XML format
* to the extent possible.
* <p>
* LOCAL_CS coordinate systems are not translatable. An empty string
* will be returned along with 0.
*
* @param argout an already allocated array of 1 string to receive the XML definition.
* @param dialect currently ignored. The dialect used is GML based.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ExportToXML(String[] argout, String dialect)
/**
* Fixup as needed.
* <p>
* Some mechanisms to create WKT using OGRSpatialReference, and some
* imported WKT, are not valid according to the OGC CT specification. This
* method attempts to fill in any missing defaults that are required, and
* fixup ordering problems (using OSRFixupOrdering()) so that the resulting
* WKT is valid.
* <p>
* This method should be expected to evolve over time to as problems are
* discovered. The following are among the fixup actions this method will
* take:
* <ul>
* <li>Fixup the ordering of nodes to match the BNF WKT ordering, using
* the FixupOrdering() method.</li>
* <li>Add missing linear or angular units nodes.</li>
* </ul>
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int Fixup()
/**
* Correct parameter ordering to match CT Specification.
* <p>
* Some mechanisms to create WKT using OGRSpatialReference, and some
* imported WKT fail to maintain the order of parameters required according
* to the BNF definitions in the OpenGIS SF-SQL and CT Specifications. This
* method attempts to massage things back into the required order.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int FixupOrdering()
/**
* Fetch angular geographic coordinate system units.
* <p>
* If no units are available, a value of SRS_UA_DEGREE_CONV
* will be assumed. This method only checks directly under the GEOGCS node
* for units.
*
* @return the value to multiply by angular distances to transform them to
* radians.
*/
public class SpatialReference:public double GetAngularUnits()
/**
* Fetch angular geographic coordinate system units name.
* <p>
* If no units are available, a value of "degree"
* will be assumed. This method only checks directly under the GEOGCS node
* for units.
*
* @return the units name
* @since Java bindings 2.1.0
*/
public class SpatialReference:public String GetAngularUnitsName()
/**
* Fetch first attribute of named node.
* <p>
* This method uses GetAttrNode() to find the named node, and then extracts
* the value of the first child.
*
* @param name the tree node to look for (case insensitive).
*
* @return the requested value, or null if it fails for any reason.
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public String GetAttrValue(String name)
/**
* Fetch indicated attribute of named node.
* <p>
* This method uses GetAttrNode() to find the named node, and then extracts
* the value of the indicated child. Thus a call to GetAttrValue("UNIT",1)
* would return the second child of the UNIT node, which is normally the
* length of the linear unit in meters.
*
* @param name the tree node to look for (case insensitive).
* @param child the child of the node to fetch (zero based).
*
* @return the requested value, or null if it fails for any reason.
*/
public class SpatialReference:public String GetAttrValue(String name, int child)
/**
* Get the authority code for a node.
* <p>
* This method is used to query an AUTHORITY[] node from within the
* WKT tree, and fetch the code value.
* <p>
* While in theory values may be non-numeric, for the EPSG authority all
* code values should be integral.
*
* @param target_key the partial or complete path to the node to
* get an authority from. i.e. "PROJCS", "GEOGCS", "GEOGCS|UNIT" or null to
* search for an authority node on the root element.
*
* @return value code from authority node, or null on failure.
*/
public class SpatialReference:public String GetAuthorityCode(String target_key)
/**
* Get the authority name for a node.
* <p>
* This method is used to query an AUTHORITY[] node from within the
* WKT tree, and fetch the authority name value.
* <p>
* The most common authority is "EPSG".
*
* @param target_key the partial or complete path to the node to
* get an authority from. i.e. "PROJCS", "GEOGCS", "GEOGCS|UNIT" or null to
* search for an authority node on the root element.
*
* @return value code from authority node, or null on failure.
*/
public class SpatialReference:public String GetAuthorityName(String target_key)
/**
* Get the axis name for a node.
* <p>
* This method is used to query an AXIS[] node from within the
* WKT tree, and fetch the axis name value.
* <p>
*
* @param target_key the partial or complete path to the node to
* get an authority from. i.e. "PROJCS", "GEOGCS" or null to
* search for an authority node on the root element.
* @param iAxis axis index (starting with 0)
*
* @return axis name, or null on failure.
* @since GDAL 2.1
*/
public class SpatialReference:public String GetAxisName(String target_key, int iAxis)
/**
* Get the axis orientation for a node.
* <p>
* This method is used to query an AXIS[] node from within the
* WKT tree, and fetch the axis orientation value.
* <p>
*
* @param target_key the partial or complete path to the node to
* get an authority from. i.e. "PROJCS", "GEOGCS" or null to
* search for an authority node on the root element.
* @param iAxis axis index (starting with 0)
*
* @return axis orientation (org.gdal.osr.osr.OAO_Other, org.gdal.osr.osr.OAO_North,
* org.gdal.osr.osr.OAO_South, org.gdal.osr.osr.OAO_East,
* org.gdal.osr.osr.OAO_West, org.gdal.osr.osr.OAO_Up, org.gdal.osr.osr.OAO_Down), or org.gdal.osr.osr.OAO_Other on failure.
* @since GDAL 2.1
*/
public class SpatialReference:public int GetAxisOrientation(String target_key, int iAxis)
/**
* Fetch linear projection units.
* <p>
* If no units are available, a value of "Meters" and 1.0 will be assumed.
* This method only checks directly under the PROJCS or LOCAL_CS node for
* units.
*
* @return the value to multiply by linear distances to transform them to
* meters.
*/
public class SpatialReference:public double GetLinearUnits()
/**
* Fetch linear projection units name.
* <p>
* If no units are available, a value of "Meters" will be assumed.
* This method only checks directly under the PROJCS or LOCAL_CS node for
* units.
*
* @return the units name
*/
public class SpatialReference:public String GetLinearUnitsName()
/**
* Fetch a normalized projection parameter value.
* <p>
* Same as below with default_val == 0
*
* @see #GetNormProjParm(String name, double default_val)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public double GetNormProjParm(String name)
/**
* Fetch a normalized projection parameter value.
* <p>
* This method is the same as GetProjParm() except that the value of
* the parameter is "normalized" into degrees or meters depending on
* whether it is linear or angular.
*
* @param name the name of the parameter to fetch, from the set of
* SRS_PP codes in ogr_srs_api.h.
*
* @param default_val the value to return if this parameter doesn't exist.
*
* @return value of parameter.
*/
public class SpatialReference:public double GetNormProjParm(String name, double default_val)
/**
* Fetch a projection parameter value.
* <p>
* Same as below with default_val == 0
*
* @see #GetProjParm(String name, double default_val)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public double GetProjParm(String name)
/**
* Fetch a projection parameter value.
* <p>
* NOTE: This code should be modified to translate non degree angles into
* degrees based on the GEOGCS unit. This has not yet been done.
*
* @param name the name of the parameter to fetch, from the set of
* SRS_PP codes in ogr_srs_api.h.
*
* @param default_val the value to return if this parameter doesn't exist.
*
* @return value of parameter.
*/
public class SpatialReference:public double GetProjParm(String name, double default_val)
/**
* Fetch TOWGS84 parameters, if available.
*
* @return an array of doubles into which up to 7 coefficients are placed.
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public double[] GetTOWGS84()
/**
* Fetch TOWGS84 parameters, if available.
*
* @param argout allocated array of 7 doubles into which up to 7 coefficients are placed.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int GetTOWGS84(double[] argout)
/**
* Initialize SRS based on EPSG GCS or PCS code.
* <p>
* This method will initialize the spatial reference based on the
* passed in EPSG GCS or PCS code. The coordinate system definitions
* are normally read from the EPSG derived support files such as
* pcs.csv, gcs.csv, pcs.override.csv, gcs.override.csv and falling
* back to search for a PROJ.4 epsg init file or a definition in epsg.wkt.
* <p>
* These support files are normally searched for in /usr/local/share/gdal
* or in the directory identified by the GDAL_DATA configuration option.
* See CPLFindFile() for details.
* <p>
* This method is relatively expensive, and generally involves quite a bit
* of text file scanning. Reasonable efforts should be made to avoid calling
* it many times for the same coordinate system.
* <p>
* This method is similar to importFromEPSGA() except that EPSG preferred
* axis ordering will *not* be applied for geographic coordinate systems.
* EPSG normally defines geographic coordinate systems to use lat/long
* contrary to typical GIS use).
*
* @param nCode a GCS or PCS code from the horizontal coordinate system table.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromEPSG(int nCode)
/**
* Import coordinate system from ESRI .prj format(s).
* <p>
* This function will read the text loaded from an ESRI .prj file, and
* translate it into an OGRSpatialReference definition. This should support
* many (but by no means all) old style (Arc/Info 7.x) .prj files, as well
* as the newer pseudo-OGC WKT .prj files. Note that new style .prj files
* are in OGC WKT format, but require some manipulation to correct datum
* names, and units on some projection parameters. This is addressed within
* importFromESRI() by an automatic call to morphFromESRI().
* <p>
* Currently only GEOGRAPHIC, UTM, STATEPLANE, GREATBRITIAN_GRID, ALBERS,
* EQUIDISTANT_CONIC, and TRANSVERSE (mercator) projections are supported
* from old style files.
* <p>
* At this time there is no equivalent exportToESRI() method. Writing old
* style .prj files is not supported by OGRSpatialReference. However the
* morphToESRI() and exportToWkt() methods can be used to generate output
* suitable to write to new style (Arc 8) .prj files.
*
* @param ppszInput vector of strings containing the definition.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromESRI(java.util.Vector ppszInput)
/**
* Import Mapinfo style CoordSys definition.
* <p>
* The SpatialReference is initialized from the passed Mapinfo style CoordSys definition string.
*
* @param coord_sys Mapinfo style CoordSys definition string.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromMICoordSys(String coord_sys)
/**
* Import coordinate system from PCI projection definition.
* <p>
* Same as below with units == null and prjParams == null
*
* @see #ImportFromPCI(String proj, String units, double[] prjParams)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ImportFromPCI(String proj)
/**
* Import coordinate system from PCI projection definition.
* <p>
* Same as below with prjParams == null
*
* @see #ImportFromPCI(String proj, String units, double[] prjParams)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ImportFromPCI(String proj, String units)
/**
* Import coordinate system from PCI projection definition.
* <p>
* PCI software uses 16-character string to specify coordinate system
* and datum/ellipsoid. You should supply at least this string to the
* importFromPCI() function.
*
* @param proj string containing the definition. Looks
* like "pppppppppppp Ennn" or "pppppppppppp Dnnn", where "pppppppppppp" is
* a projection code, "Ennn" is an ellipsoid code, "Dnnn" --- a datum code.
*
* @param units Grid units code ("DEGREE" or "METRE"). If null, "METRE" will
* be used.
*
* @param prjParams Array of 17 coordinate system parameters:
* <pre>
* [0] Spheroid semi major axis
* [1] Spheroid semi minor axis
* [2] Reference Longitude
* [3] Reference Latitude
* [4] First Standard Parallel
* [5] Second Standard Parallel
* [6] False Easting
* [7] False Northing
* [8] Scale Factor
* [9] Height above sphere surface
* [10] Longitude of 1st point on center line
* [11] Latitude of 1st point on center line
* [12] Longitude of 2nd point on center line
* [13] Latitude of 2nd point on center line
* [14] Azimuth east of north for center line
* [15] Landsat satellite number
* [16] Landsat path number
* </pre>
* Particular projection uses different parameters, unused ones may be set to
* zero. If null supplied instead of array pointer default values will be
* used (i.e., zeroes).
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromPCI(String proj, String units, double[] prjParams)
/**
* Import PROJ.4 coordinate string.
* <p>
* The OGRSpatialReference is initialized from the passed PROJ.4 style
* coordinate system string. In addition to many +proj formulations which
* have OGC equivalents, it is also possible to import "+init=epsg:n" style
* definitions. These are passed to importFromEPSG(). Other init strings
* (such as the state plane zones) are not currently supported.
* <p><pre>
* Example:
* pszProj4 = "+proj=utm +zone=11 +datum=WGS84"
* </pre><p>
* Some parameters, such as grids, recognized by PROJ.4 may not be well
* understood and translated into the OGRSpatialReference model. It is possible
* to add the +wktext parameter which is a special keyword that OGR recognizes
* as meaning "embed the entire PROJ.4 string in the WKT and use it literally
* when converting back to PROJ.4 format".
* <p><pre>
* For example:
* "+proj=nzmg +lat_0=-41 +lon_0=173 +x_0=2510000 +y_0=6023150 +ellps=intl
* +units=m +nadgrids=nzgd2kgrid0005.gsb +wktext"
*</pre><p>
* will be translated as :
* <pre>
* PROJCS["unnamed",
* GEOGCS["International 1909 (Hayford)",
* DATUM["unknown",
* SPHEROID["intl",6378388,297]],
* PRIMEM["Greenwich",0],
* UNIT["degree",0.0174532925199433]],
* PROJECTION["New_Zealand_Map_Grid"],
* PARAMETER["latitude_of_origin",-41],
* PARAMETER["central_meridian",173],
* PARAMETER["false_easting",2510000],
* PARAMETER["false_northing",6023150],
* UNIT["Meter",1],
* EXTENSION["PROJ4","+proj=nzmg +lat_0=-41 +lon_0=173 +x_0=2510000
* +y_0=6023150 +ellps=intl +units=m +nadgrids=nzgd2kgrid0005.gsb +wktext"]]
* </pre>
*
* @param proj4 the PROJ.4 style string.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromProj4(String proj4)
/**
* Set spatial reference from a URL.
* <p>
* This method will download the spatial reference at a given URL and
* feed it into SetFromUserInput for you.
*
* @param url text definition to try to deduce SRS from.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromUrl(String url)
/**
* Import coordinate system from USGS projection definition.
* <p>
* Same as below with iZone == 0, padfPrjParams == null and iDatum == 0
*
* @see #ImportFromUSGS(int iProjSys, int iZone, double[] padfPrjParams, int iDatum)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ImportFromUSGS(int iProjSys)
/**
* Import coordinate system from USGS projection definition.
* <p>
* Same as below with padfPrjParams == null and iDatum == 0
*
* @see #ImportFromUSGS(int iProjSys, int iZone, double[] padfPrjParams, int iDatum)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ImportFromUSGS(int iProjSys, int iZone)
/**
* Import coordinate system from USGS projection definition.
* <p>
* Same as below with iDatum == 0
*
* @see #ImportFromUSGS(int iProjSys, int iZone, double[] padfPrjParams, int iDatum)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int ImportFromUSGS(int iProjSys, int iZone, double[] padfPrjParams)
/**
* Import coordinate system from USGS projection definition.
* <p>
* This method will import projection definition in style, used by USGS GCTP
* software. GCTP operates on angles in packed DMS format (see
* CPLDecToPackedDMS() function for details), so all angle values (latitudes,
* longitudes, azimuths, etc.) specified in the padfPrjParams array should
* be in the packed DMS format.
*
* Projection Transformation Package Projection Parameters:
* <pre>
* ----------------------------------------------------------------------------
* | Array Element
* Code & Projection Id |---------------------------------------------------
* | 0 | 1 | 2 | 3 | 4 | 5 |6 | 7
* ----------------------------------------------------------------------------
* 0 Geographic | | | | | | | |
* 1 U T M |Lon/Z |Lat/Z | | | | | |
* 2 State Plane | | | | | | | |
* 3 Albers Equal Area |SMajor|SMinor|STDPR1|STDPR2|CentMer|OriginLat|FE|FN
* 4 Lambert Conformal C |SMajor|SMinor|STDPR1|STDPR2|CentMer|OriginLat|FE|FN
* 5 Mercator |SMajor|SMinor| | |CentMer|TrueScale|FE|FN
* 6 Polar Stereographic |SMajor|SMinor| | |LongPol|TrueScale|FE|FN
* 7 Polyconic |SMajor|SMinor| | |CentMer|OriginLat|FE|FN
* 8 Equid. Conic A |SMajor|SMinor|STDPAR| |CentMer|OriginLat|FE|FN
* Equid. Conic B |SMajor|SMinor|STDPR1|STDPR2|CentMer|OriginLat|FE|FN
* 9 Transverse Mercator |SMajor|SMinor|Factor| |CentMer|OriginLat|FE|FN
* 10 Stereographic |Sphere| | | |CentLon|CenterLat|FE|FN
* 11 Lambert Azimuthal |Sphere| | | |CentLon|CenterLat|FE|FN
* 12 Azimuthal |Sphere| | | |CentLon|CenterLat|FE|FN
* 13 Gnomonic |Sphere| | | |CentLon|CenterLat|FE|FN
* 14 Orthographic |Sphere| | | |CentLon|CenterLat|FE|FN
* 15 Gen. Vert. Near Per |Sphere| |Height| |CentLon|CenterLat|FE|FN
* 16 Sinusoidal |Sphere| | | |CentMer| |FE|FN
* 17 Equirectangular |Sphere| | | |CentMer|TrueScale|FE|FN
* 18 Miller Cylindrical |Sphere| | | |CentMer| |FE|FN
* 19 Van der Grinten |Sphere| | | |CentMer|OriginLat|FE|FN
* 20 Hotin Oblique Merc A |SMajor|SMinor|Factor| | |OriginLat|FE|FN
* Hotin Oblique Merc B |SMajor|SMinor|Factor|AziAng|AzmthPt|OriginLat|FE|FN
* 21 Robinson |Sphere| | | |CentMer| |FE|FN
* 22 Space Oblique Merc A |SMajor|SMinor| |IncAng|AscLong| |FE|FN
* Space Oblique Merc B |SMajor|SMinor|Satnum|Path | | |FE|FN
* 23 Alaska Conformal |SMajor|SMinor| | | | |FE|FN
* 24 Interrupted Goode |Sphere| | | | | | |
* 25 Mollweide |Sphere| | | |CentMer| |FE|FN
* 26 Interrupt Mollweide |Sphere| | | | | | |
* 27 Hammer |Sphere| | | |CentMer| |FE|FN
* 28 Wagner IV |Sphere| | | |CentMer| |FE|FN
* 29 Wagner VII |Sphere| | | |CentMer| |FE|FN
* 30 Oblated Equal Area |Sphere| |Shapem|Shapen|CentLon|CenterLat|FE|FN
* ----------------------------------------------------------------------------
*
* ----------------------------------------------------
* | Array Element |
* Code & Projection Id |---------------------------
* | 8 | 9 | 10 | 11 | 12 |
* ----------------------------------------------------
* 0 Geographic | | | | | |
* 1 U T M | | | | | |
* 2 State Plane | | | | | |
* 3 Albers Equal Area | | | | | |
* 4 Lambert Conformal C | | | | | |
* 5 Mercator | | | | | |
* 6 Polar Stereographic | | | | | |
* 7 Polyconic | | | | | |
* 8 Equid. Conic A |zero | | | | |
* Equid. Conic B |one | | | | |
* 9 Transverse Mercator | | | | | |
* 10 Stereographic | | | | | |
* 11 Lambert Azimuthal | | | | | |
* 12 Azimuthal | | | | | |
* 13 Gnomonic | | | | | |
* 14 Orthographic | | | | | |
* 15 Gen. Vert. Near Per | | | | | |
* 16 Sinusoidal | | | | | |
* 17 Equirectangular | | | | | |
* 18 Miller Cylindrical | | | | | |
* 19 Van der Grinten | | | | | |
* 20 Hotin Oblique Merc A |Long1|Lat1|Long2|Lat2|zero|
* Hotin Oblique Merc B | | | | |one |
* 21 Robinson | | | | | |
* 22 Space Oblique Merc A |PSRev|LRat|PFlag| |zero|
* Space Oblique Merc B | | | | |one |
* 23 Alaska Conformal | | | | | |
* 24 Interrupted Goode | | | | | |
* 25 Mollweide | | | | | |
* 26 Interrupt Mollweide | | | | | |
* 27 Hammer | | | | | |
* 28 Wagner IV | | | | | |
* 29 Wagner VII | | | | | |
* 30 Oblated Equal Area |Angle| | | | |
* ----------------------------------------------------
*
* where
*
* Lon/Z Longitude of any point in the UTM zone or zero. If zero,
* a zone code must be specified.
* Lat/Z Latitude of any point in the UTM zone or zero. If zero, a
* zone code must be specified.
* SMajor Semi-major axis of ellipsoid. If zero, Clarke 1866 in meters
* is assumed.
* SMinor Eccentricity squared of the ellipsoid if less than zero,
* if zero, a spherical form is assumed, or if greater than
* zero, the semi-minor axis of ellipsoid.
* Sphere Radius of reference sphere. If zero, 6370997 meters is used.
* STDPAR Latitude of the standard parallel
* STDPR1 Latitude of the first standard parallel
* STDPR2 Latitude of the second standard parallel
* CentMer Longitude of the central meridian
* OriginLat Latitude of the projection origin
* FE False easting in the same units as the semi-major axis
* FN False northing in the same units as the semi-major axis
* TrueScale Latitude of true scale
* LongPol Longitude down below pole of map
* Factor Scale factor at central meridian (Transverse Mercator) or
* center of projection (Hotine Oblique Mercator)
* CentLon Longitude of center of projection
* CenterLat Latitude of center of projection
* Height Height of perspective point
* Long1 Longitude of first point on center line (Hotine Oblique
* Mercator, format A)
* Long2 Longitude of second point on center line (Hotine Oblique
* Mercator, format A)
* Lat1 Latitude of first point on center line (Hotine Oblique
* Mercator, format A)
* Lat2 Latitude of second point on center line (Hotine Oblique
* Mercator, format A)
* AziAng Azimuth angle east of north of center line (Hotine Oblique
* Mercator, format B)
* AzmthPt Longitude of point on central meridian where azimuth occurs
* (Hotine Oblique Mercator, format B)
* IncAng Inclination of orbit at ascending node, counter-clockwise
* from equator (SOM, format A)
* AscLong Longitude of ascending orbit at equator (SOM, format A)
* PSRev Period of satellite revolution in minutes (SOM, format A)
* LRat Landsat ratio to compensate for confusion at northern end
* of orbit (SOM, format A -- use 0.5201613)
* PFlag End of path flag for Landsat: 0 = start of path,
* 1 = end of path (SOM, format A)
* Satnum Landsat Satellite Number (SOM, format B)
* Path Landsat Path Number (Use WRS-1 for Landsat 1, 2 and 3 and
* WRS-2 for Landsat 4, 5 and 6.) (SOM, format B)
* Shapem Oblated Equal Area oval shape parameter m
* Shapen Oblated Equal Area oval shape parameter n
* Angle Oblated Equal Area oval rotation angle
*
* Array elements 13 and 14 are set to zero. All array elements with blank
* fields are set to zero too.
* </pre>
*
* If the datum code is negative, the first two values in the parameter array
* (param) are used to define the values as follows:
*
* <ul>
*
* <li> If padfPrjParams[0] is a non-zero value and padfPrjParams[1] is
* greater than one, the semimajor axis is set to padfPrjParams[0] and
* the semiminor axis is set to padfPrjParams[1].
*
* <li> If padfPrjParams[0] is nonzero and padfPrjParams[1] is greater than
* zero but less than or equal to one, the semimajor axis is set to
* padfPrjParams[0] and the semiminor axis is computed from the eccentricity
* squared value padfPrjParams[1]:<p>
*
* semiminor = sqrt(1.0 - ES) * semimajor<p>
*
* where<p>
*
* ES = eccentricity squared
*
* <li> If padfPrjParams[0] is nonzero and padfPrjParams[1] is equal to zero,
* the semimajor axis and semiminor axis are set to padfPrjParams[0].
*
* <li> If padfPrjParams[0] equals zero and padfPrjParams[1] is greater than
* zero, the default Clarke 1866 is used to assign values to the semimajor
* axis and semiminor axis.
*
* <li> If padfPrjParams[0] and padfPrjParams[1] equals zero, the semimajor
* axis is set to 6370997.0 and the semiminor axis is set to zero.
*
* </ul>
*
* If a datum code is zero or greater, the semimajor and semiminor axis are
* defined by the datum code as found in the following table:
*
* Supported Datums:
* <pre>
* 0: Clarke 1866 (default)
* 1: Clarke 1880
* 2: Bessel
* 3: International 1967
* 4: International 1909
* 5: WGS 72
* 6: Everest
* 7: WGS 66
* 8: GRS 1980/WGS 84
* 9: Airy
* 10: Modified Everest
* 11: Modified Airy
* 12: Walbeck
* 13: Southeast Asia
* 14: Australian National
* 15: Krassovsky
* 16: Hough
* 17: Mercury 1960
* 18: Modified Mercury 1968
* 19: Sphere of Radius 6370997 meters
* </pre>
*
* @param iProjSys Input projection system code, used in GCTP.
*
* @param iZone Input zone for UTM and State Plane projection systems. For
* Southern Hemisphere UTM use a negative zone code. iZone ignored for all
* other projections.
*
* @param padfPrjParams Array of 15 coordinate system parameters. These
* parameters differs for different projections.
*
* @param iDatum Input spheroid.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromUSGS(int iProjSys, int iZone, double[] padfPrjParams, int iDatum)
/**
* Import from WKT string.
* <p>
* This method will wipe the existing SRS definition, and
* reassign it based on the contents of the passed WKT string. Only as
* much of the input string as needed to construct this SRS is consumed from
* the input string.
*
* @param wkt WKT string
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromWkt(String wkt)
/**
* Import coordinate system from XML format (GML only currently).
*
* @param xmlString XML string to import
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int ImportFromXML(String xmlString)
/**
* Check if coordinate system is compound.
*
* @return 1 if this is rooted with a COMPD_CS node.
*
* @since GDAL 1.9.0
*/
public class SpatialReference:public int IsCompound()
/**
* Check if geocentric coordinate system.
*
* @return 1 if this contains a GEOCCS node indicating a it is a
* geocentric coordinate system.
*
* @since GDAL 1.9.0
*/
public class SpatialReference:public int IsGeocentric()
/**
* Check if geographic coordinate system.
*
* @return 1 if this spatial reference is geographic ... that is the
* root is a GEOGCS node.
*/
public class SpatialReference:public int IsGeographic()
/**
* Check if local coordinate system.
*
* @return 1 if this spatial reference is local ... that is the
* root is a LOCAL_CS node.
*/
public class SpatialReference:public int IsLocal()
/**
* Check if projected coordinate system.
*
* @return 1 if this contains a PROJCS node indicating a it is a
* projected coordinate system.
*/
public class SpatialReference:public int IsProjected()
/**
* Do these two spatial references describe the same system ?
*
* @param other the SRS being compared to.
*
* @return 1 if equivalent or 0 otherwise.
*/
public class SpatialReference:public int IsSame(SpatialReference other)
/**
* Do the GeogCS'es match?
*
* @param other the SRS being compared against.
*
* @return 1 if they are the same or 0 otherwise.
*/
public class SpatialReference:public int IsSameGeogCS(SpatialReference other)
/**
* Do the VertCS'es match?
*
* @param other the SRS being compared against.
*
* @return 1 if they are the same or 0 otherwise.
*/
public class SpatialReference:public int IsSameVertCS(SpatialReference other)
/**
* Check if vertical coordinate system.
*
* @return 1 if this contains a VERT_CS node indicating a it is a
* vertical coordinate system.
*
* @since OGR 1.8.0
*/
public class SpatialReference:public int IsVertical()
/**
* Convert in place from ESRI WKT format.
* <p>
* The value notes of this coordinate system are modified in various manners
* to adhere more closely to the WKT standard. This mostly involves
* translating a variety of ESRI names for projections, arguments and
* datums to "standard" names, as defined by Adam Gawne-Cain's reference
* translation of EPSG to WKT for the CT specification.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int MorphFromESRI()
/**
* Convert in place to ESRI WKT format.
* <p>
* The value nodes of this coordinate system are modified in various manners
* more closely map onto the ESRI concept of WKT format. This includes
* renaming a variety of projections and arguments, and stripping out
* nodes note recognised by ESRI (like AUTHORITY and AXIS).
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int MorphToESRI()
/**
* Set the angular units for the geographic coordinate system.
* <p>
* This method creates a UNITS subnode with the specified values as a
* child of the GEOGCS node.
*
* @param name the units name to be used. Some preferred units
* names can be found in ogr_srs_api.h such as SRS_UA_DEGREE.
*
* @param to_radians the value to multiple by an angle in the indicated
* units to transform to radians. Some standard conversion factors can
* be found in ogr_srs_api.h.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetAngularUnits(String name, double to_radians)
/**
* Set attribute value in spatial reference.
* <p>
* Missing intermediate nodes in the path will be created if not already
* in existence. If the attribute has no children one will be created and
* assigned the value otherwise the zeroth child will be assigned the value.
*
* @param name full path to attribute to be set. For instance
* "PROJCS|GEOGCS|UNITS".
*
* @param value value to be assigned to node, such as "meter".
* This may be null if you just want to force creation of the intermediate
* path.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetAttrValue(String name, String value)
/**
* Set the authority for a node.
*
* @param target_key the partial or complete path to the node to
* set an authority on. i.e. "PROJCS", "GEOGCS" or "GEOGCS|UNIT".
*
* @param authority authority name, such as "EPSG".
*
* @param code code for value with this authority.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetAuthority(String target_key, String authority, int code)
/**
* Set spatial reference from various text formats.
* <p>
* This method will examine the provided input, and try to deduce the
* format, and then use it to initialize the spatial reference system. It
* may take the following forms:
*
* <ol>
* <li> Well Known Text definition - passed on to importFromWkt().
* <li> "EPSG:n" - number passed on to importFromEPSG().
* <li> "EPSGA:n" - number passed on to importFromEPSGA().
* <li> "AUTO:proj_id,unit_id,lon0,lat0" - WMS auto projections.
* <li> "urn:ogc:def:crs:EPSG::n" - ogc urns
* <li> PROJ.4 definitions - passed on to importFromProj4().
* <li> filename - file read for WKT, XML or PROJ.4 definition.
* <li> well known name accepted by SetWellKnownGeogCS(), such as NAD27, NAD83,
* WGS84 or WGS72.
* <li> WKT (directly or in a file) in ESRI format should be prefixed with
* ESRI:: to trigger an automatic morphFromESRI().
* </ol>
*
* It is expected that this method will be extended in the future to support
* XML and perhaps a simplified "minilanguage" for indicating common UTM and
* State Plane definitions.
* <p>
* This method is intended to be flexible, but by it's nature it is
* imprecise as it must guess information about the format intended. When
* possible applications should call the specific method appropriate if the
* input is known to be in a particular format.
*
* @param definition text definition to try to deduce SRS from.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetFromUserInput(String definition)
/**
* Set the user visible GEOCCS name.
* <p>
* Same as below with name == null
*
* @see #SetGeocCS(String name)
*
* @since OGR 1.9.0
*/
public class SpatialReference:public int SetGeocCS()
/**
* Set the user visible GEOCCS name.
* <p>
* This method is will ensure a GEOCCS node is created as the root,
* and set the provided name on it. If used on a GEOGCS coordinate system,
* the DATUM and PRIMEM nodes from the GEOGCS will be transferred over to
* the GEOGCS.
*
* @param name the user visible name to assign. Not used as a key. May be null
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.9.0
*/
public class SpatialReference:public int SetGeocCS(String name)
/**
* Set geographic coordinate system.
* <p>
* Same as below with pszPMName = "Greenwich", dfPMOffset = 0.0, pszAngularUnits = "degree" and dfConvertToRadians = 0.0174532925199433
*
* @see #SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszAngularUnits, double dfConvertToRadians)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening)
/**
* Set geographic coordinate system.
* <p>
* Same as below with dfPMOffset = 0.0, pszAngularUnits = "degree" and dfConvertToRadians = 0.0174532925199433
*
* @see #SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszAngularUnits, double dfConvertToRadians)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName)
/**
* Set geographic coordinate system.
* <p>
* Same as below with pszAngularUnits = "degree" and dfConvertToRadians = 0.0174532925199433
*
* @see #SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszAngularUnits, double dfConvertToRadians)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset)
/**
* Set geographic coordinate system.
* <p>
* Same as below with dfConvertToRadians = 0.0174532925199433
*
* @see #SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszUnits, double dfConvertToRadians)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszAngularUnits)
/**
* Set geographic coordinate system.
* <p>
* This method is used to set the datum, ellipsoid, prime meridian and
* angular units for a geographic coordinate system. It can be used on it's
* own to establish a geographic spatial reference, or applied to a
* projected coordinate system to establish the underlying geographic
* coordinate system.
*
* @param pszGeogName user visible name for the geographic coordinate system
* (not to serve as a key).
*
* @param pszDatumName key name for this datum. The OpenGIS specification
* lists some known values, and otherwise EPSG datum names with a standard
* transformation are considered legal keys.
*
* @param pszSpheroidName user visible spheroid name (not to serve as a key)
*
* @param dfSemiMajor the semi major axis of the spheroid.
*
* @param dfInvFlattening the inverse flattening for the spheroid.
* This can be computed from the semi minor axis as
* 1/f = 1.0 / (1.0 - semiminor/semimajor).
*
* @param pszPMName the name of the prime meridian (not to serve as a key)
* If this is null a default value of "Greenwich" will be used.
*
* @param dfPMOffset the longitude of greenwich relative to this prime
* meridian.
*
* @param pszAngularUnits the angular units name (see ogr_srs_api.h for some
* standard names). If null a value of "degrees" will be assumed.
*
* @param dfConvertToRadians value to multiply angular units by to transform
* them to radians. A value of SRS_UL_DEGREE_CONV will be used if
* pszAngularUnits is null.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetGeogCS(String pszGeogName, String pszDatumName, String pszSpheroidName, double dfSemiMajor, double dfInvFlattening, String pszPMName, double dfPMOffset, String pszAngularUnits, double dfConvertToRadians)
/**
* Set the linear units for the projection.
* <p>
* This method creates a UNITS subnode with the specified values as a
* child of the PROJCS or LOCAL_CS node.
*
* @param name the units name to be used. Some preferred units
* names can be found in ogr_srs_api.h such as SRS_UL_METER, SRS_UL_FOOT
* and SRS_UL_US_FOOT.
*
* @param to_meters the value to multiple by a length in the indicated
* units to transform to meters. Some standard conversion factors can
* be found in ogr_srs_api.h.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetLinearUnits(String name, double to_meters)
/**
* Set the linear units for the projection.
* <p>
* This method creates a UNITS subnode with the specified values as a
* child of the PROJCS or LOCAL_CS node. It works the same as the
* SetLinearUnits() method, but it also updates all existing linear
* projection parameter values from the old units to the new units.
*
* @param name the units name to be used. Some preferred units
* names can be found in ogr_srs_api.h such as SRS_UL_METER, SRS_UL_FOOT
* and SRS_UL_US_FOOT.
*
* @param to_meters the value to multiple by a length in the indicated
* units to transform to meters. Some standard conversion factors can
* be found in ogr_srs_api.h.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetLinearUnitsAndUpdateParameters(String name, double to_meters)
/**
* Set the user visible LOCAL_CS name.
* <p>
* This method is will ensure a LOCAL_CS node is created as the root,
* and set the provided name on it. It must be used before SetLinearUnits().
*
* @param name the user visible name to assign. Not used as a key.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetLocalCS(String name)
/**
* Set a projection parameter with a normalized value.
* <p>
* This method is the same as SetProjParm() except that the value of
* the parameter passed in is assumed to be in "normalized" form (decimal
* degrees for angular values, meters for linear values. The values are
* converted in a form suitable for the GEOGCS and linear units in effect.
*
* @param name the parameter name, which should be selected from
* the macros in ogr_srs_api.h, such as SRS_PP_CENTRAL_MERIDIAN.
*
* @param val value to assign.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetNormProjParm(String name, double val)
/**
* Set the user visible PROJCS name.
* <p>
* Same as below with name == null
*
* @see #SetProjCS(String name)
*/
public class SpatialReference:public int SetProjCS()
/**
* Set the user visible PROJCS name.
* <p>
* This method is will ensure a PROJCS node is created as the root,
* and set the provided name on it. If used on a GEOGCS coordinate system,
* the GEOGCS node will be demoted to be a child of the new PROJCS root.
*
* @param name the user visible name to assign. May be null
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetProjCS(String name)
/**
* Set a projection name.
*
* @param name the projection name, which should be selected from
* the macros in ogr_srs_api.h, such as SRS_PT_TRANSVERSE_MERCATOR.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetProjection(String name)
/**
* Set a projection parameter value.
* <p>
* Adds a new PARAMETER under the PROJCS with the indicated name and value.
* <p>
* Please check <a href="https://gdal.org/proj_list">https://gdal.org/proj_list</a> pages for
* legal parameter names for specific projections.
*
* @param name the parameter name, which should be selected from
* the macros in ogr_srs_api.h, such as SRS_PP_CENTRAL_MERIDIAN.
*
* @param val value to assign.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetProjParm(String name, double val)
/**
* Set State Plane projection definition.
* <p>
* Same as below with is_nad83 == 1, unitsname == "" and units == 0
*
* @see #SetStatePlane(int zone, int is_nad83, String unitsname, double units)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetStatePlane(int zone)
/**
* Set State Plane projection definition.
* <p>
* Same as below with unitsname == "" and units == 0
*
* @see #SetStatePlane(int zone, int is_nad83, String unitsname, double units)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetStatePlane(int zone, int is_nad83)
/**
* Set State Plane projection definition.
* <p>
* Same as below with units == 0
*
* @see #SetStatePlane(int zone, int is_nad83, String unitsname, double units)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetStatePlane(int zone, int is_nad83, String unitsname)
/**
* Set State Plane projection definition.
* <p>
* This will attempt to generate a complete definition of a state plane
* zone based on generating the entire SRS from the EPSG tables. If the
* EPSG tables are unavailable, it will produce a stubbed LOCAL_CS definition
* and return OGRERR_FAILURE.
*
* @param zone State plane zone number, in the USGS numbering scheme (as
* distinct from the Arc/Info and Erdas numbering scheme.
*
* @param is_nad83 1 if the NAD83 zone definition should be used or 0
* if the NAD27 zone definition should be used.
*
* @param unitsname Linear unit name to apply overriding the
* legal definition for this zone.
*
* @param units Linear unit conversion factor to apply overriding
* the legal definition for this zone.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetStatePlane(int zone, int is_nad83, String unitsname, double units)
/**
* Set the linear units for the projection.
* <p>
* This method creates a UNIT subnode with the specified values as a
* child of the target node.
*
* @param target the keyword to set the linear units for. i.e. "PROJCS" or "VERT_CS"
*
* @param name the units name to be used. Some preferred units
* names can be found in ogr_srs_api.h such as SRS_UL_METER, SRS_UL_FOOT
* and SRS_UL_US_FOOT.
*
* @param to_meters the value to multiple by a length in the indicated
* units to transform to meters. Some standard conversion factors can
* be found in ogr_srs_api.h.
*
* @return OGRERR_NONE on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.9.0
*/
public class SpatialReference:public int SetTargetLinearUnits(String target, String name, double to_meters)
/**
* Set the Bursa-Wolf conversion to WGS84.
* <p>
* Same as below with dfEX == dfEY == dfEZ == dfPPM == 0
*
* @see #SetTOWGS84(double dfDX, double dfDY, double dfDZ, double dfEX, double dfEY, double dfEZ, double dfPPM)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetTOWGS84(double p1, double p2, double p3)
/**
* Set the Bursa-Wolf conversion to WGS84.
* <p>
* This will create the TOWGS84 node as a child of the DATUM. It will fail
* if there is no existing DATUM node. Unlike most OGRSpatialReference
* methods it will insert itself in the appropriate order, and will replace
* an existing TOWGS84 node if there is one.
* <p>
* The parameters have the same meaning as EPSG transformation 9606
* (Position Vector 7-param. transformation).
*
* @param dfDX X child in meters.
* @param dfDY Y child in meters.
* @param dfDZ Z child in meters.
* @param dfEX X rotation in arc seconds (optional, defaults to zero).
* @param dfEY Y rotation in arc seconds (optional, defaults to zero).
* @param dfEZ Z rotation in arc seconds (optional, defaults to zero).
* @param dfPPM scaling factor (parts per million).
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetTOWGS84(double dfDX, double dfDY, double dfDZ, double dfEX, double dfEY, double dfEZ, double dfPPM)
/**
* Set UTM projection definition.
* <p>
* Same as below with north == 1
*
* @see #SetUTM(int zone, int north)
*
* @since Java bindings 1.7.0
*/
public class SpatialReference:public int SetUTM(int zone)
/**
* Set UTM projection definition.
* <p>
* This will generate a projection definition with the full set of
* transverse mercator projection parameters for the given UTM zone.
* If no PROJCS[] description is set yet, one will be set to look
* like "UTM Zone %d, {Northern, Southern} Hemisphere".
*
* @param zone UTM zone.
*
* @param north 1 for northern hemisphere, or 0 for southern
* hemisphere.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetUTM(int zone, int north)
/**
* Get UTM zone information.
*
* @return the UTM zone. As a positive value for the northern hemisphere
* and as a negative value for the southern hemisphere.
*
* @since Java bindings 1.8.0
*/
public class SpatialReference:public int GetUTMZone()
/**
* Set the user visible VERT_CS name.
* <p>
* This method is will ensure a VERT_CS node is created if needed. If the
* existing coordinate system is GEOGCS or PROJCS rooted, then it will be
* turned into a COMPD_CS.
*
* @param VertCSName the user visible name of the vertical coordinate
* system. Not used as a key.
*
* @param VertDatumName the user visible name of the vertical datum. It
* is helpful if this matches the EPSG name.
*
* @param VertDatumType the OGC vertical datum type, usually 2005.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*
* @since OGR 1.9.0
*/
public class SpatialReference:public int SetVertCS(String VertCSName, String VertDatumName, int VertDatumType)
/**
* Set a GeogCS based on well known name.
* <p>
* This may be called on an empty OGRSpatialReference to make a geographic
* coordinate system, or on something with an existing PROJCS node to
* set the underlying geographic coordinate system of a projected coordinate
* system.
* <p>
* The following well known text values are currently supported:
* <ul>
* <li> "WGS84": same as "EPSG:4326" but has no dependence on EPSG data files.
* <li> "WGS72": same as "EPSG:4322" but has no dependence on EPSG data files.
* <li> "NAD27": same as "EPSG:4267" but has no dependence on EPSG data files.
* <li> "NAD83": same as "EPSG:4269" but has no dependence on EPSG data files.
* <li> "EPSG:n": where n is the code a Geographic coordinate reference system.
* </ul>
*
* @param name name of well known geographic coordinate system.
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int SetWellKnownGeogCS(String name)
/**
* Strip OGC CT Parameters.
* <p>
* This method will remove all components of the coordinate system
* that are specific to the OGC CT Specification. That is it will attempt
* to strip it down to being compatible with the Simple Features 1.0
* specification.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int StripCTParms()
/**
* Convert this SRS into a pretty WKT format.
*
* @return the srs
*/
public class SpatialReference:public String toString()
/**
* Validate SRS tokens.
* <p>
* This method attempts to verify that the spatial reference system is
* well formed, and consists of known tokens. The validation is not
* comprehensive.
*
* @return 0 on success. Otherwise throws a RuntimeException() (or an error code if DontUseExceptions() has been called).
*/
public class SpatialReference:public int Validate()
/**
* This method returns 1 if this geographic coordinate
* system should be treated as having lat/long coordinate ordering.
* <p>
* Currently this returns TRUE for all geographic coordinate systems
* with axes set defining it as lat, long (prior to GDAL 3.10, it
* also checked that the CRS had belonged to EPSG authority, but this check
* has now been removed).
* <p>
* FALSE will be returned for all coordinate systems that are not geographic,
* or whose axes ordering is not latitude, longitude.
*
* @return 1 or 0.
*/
public class SpatialReference:public int EPSGTreatsAsLatLong()
/**
* This method returns 1 if this projected coordinate
* system should be treated as having northing/easting coordinate ordering.
* <p>
* Currently this returns TRUE for all projected coordinate systems
* with an EPSG code set, and axes set defining it as northing, easting.
* <p>
* FALSE will be returned for all coordinate systems that are not projected,
* or whose axes ordering is not northing, easting.
*
* @return 1 or 0.
*/
public class SpatialReference:public int EPSGTreatsAsNorthingEasting()
/* Class CoordinateTransformation */
/**
* Object for transforming between coordinate systems.
*
* <p>
* The CoordinateTransformation class is a binding for the C++ <a href="http://gdal.org/ogr/classOGRCoordinateTransformation.html">OGRCoordinateTransformation</a> class.
*/
public class CoordinateTransformation
/**
* Create transformation object.
* <p>
* Caution: the coordinate transformation object returned can be in a non
* working state if no coordinate transformation can be established between
* src and dst, and calling other methods on it can result in the process
* termination. If using GDAL 1.10 or above, it is recommended to use the
* <a href="#CreateCoordinateTransformation(org.gdal.osr.SpatialReference,%20org.gdal.osr.SpatialReference)">
* CreateCoordinateTransformation(org.gdal.osr.SpatialReference, org.gdal.osr.SpatialReference)</a> method instead.
* <p>
* For GDAL 1.9.X or below, you might use the following snippet :
* <pre>
* gdal.PushErrorHandler( "CPLQuietErrorHandler" );
* hTransform = new CoordinateTransformation(src, dst);
* gdal.PopErrorHandler();
* if (gdal.GetLastErrorMsg().indexOf("Unable to load PROJ.4 library") != -1)
* hTransform = null;
* </pre>
*
* @param src source spatial reference system.
* @param dst target spatial reference system.
* @deprecated
* @see #CreateCoordinateTransformation(org.gdal.osr.SpatialReference, org.gdal.osr.SpatialReference)
*/
public class CoordinateTransformation:public CoordinateTransformation(SpatialReference src, SpatialReference dst)
/**
* Create transformation object.
*
* @param src source spatial reference system.
* @param dst target spatial reference system.
* @return a new CoordinateTransformation object, or null in case of failure
* @since GDAL 1.10
*/
public class CoordinateTransformation:public static CoordinateTransformation CreateCoordinateTransformation(SpatialReference src, SpatialReference dst)
/**
* Transform point from source to destination space.
* <p>
* The provided array will be modified in place.
*
* @param inout an array of 3 doubles
*/
public class CoordinateTransformation:public void TransformPoint(double[] inout)
/**
* Transform point from source to destination space.
*
* @param argout array of 3 double values where the transformed coordinates will be put.
* @param x input x value
* @param y input y value
*
* @since Java bindings 1.7.0
*/
public class CoordinateTransformation:public void TransformPoint(double[] argout, double x, double y)
/**
* Transform point from source to destination space.
*
* @param argout array of 3 double values where the transformed coordinates will be put.
* @param x input x value
* @param y input y value
* @param z input z value
*/
public class CoordinateTransformation:public void TransformPoint(double[] argout, double x, double y, double z)
/**
* Transform point from source to destination space.
*
* @param x input x value
* @param y input y value
* @return the transformed coordinates
*
* @since Java bindings 1.7.0
*/
public class CoordinateTransformation:public double[] TransformPoint(double x, double y)
/**
* Transform point from source to destination space.
*
* @param x input x value
* @param y input y value
* @return the transformed coordinates
*
* @since Java bindings 1.7.0
*/
public class CoordinateTransformation:public double[] TransformPoint(double x, double y, double z)
/**
* Transform points from source to destination space.
* <p>
* The provided array will be modified in place.
*
* @param pointArray an array of coordinates. Each coordinate can be either 2D, 3D or 4D
*/
public class CoordinateTransformation:public void TransformPoints(double[][] pointArray)
/**
* Transform point from source to destination space.
*
* @param argout array of 4 double values where the transformed coordinates will be put.
* @param x input x value
* @param y input y value
* @param z input z value
* @param t input t value
* @return the error code. 0 means no error.
* See osrConstants.PROJ_ERR_xxxxx enumerated code for the possible error codes.
* @since GDAL 3.3 and PROJ 8
*/
public class CoordinateTransformation:public int TransformPointWithErrorCode(double[] argout, double x, double y, double z, double t)
/**
* Transform points from source to destination space.
* <p>
* The provided array will be modified in place.
*
* @param pointArray an array of coordinates. Each coordinate can be either 2D, 3D or 4D
* @return an array of integer with the error codes for each coordinate. 0 means no error.
* See osrConstants.PROJ_ERR_xxxxx enumerated code for the possible error codes.
* @since GDAL 3.3 and PROJ 8
*/
public class CoordinateTransformation:public int[] TransformPointsWithErrorCodes(double[][] pointArray)
/**
* Class of error codes typically related to coordinate operation initialization,
* typically when creating a PJ* object from a PROJ string.
*
* Some of them can also be emitted during coordinate transformation,
* like PROJ_ERR_INVALID_OP_FILE_NOT_FOUND_OR_INVALID in case the resource loading
* is deferred until it is really needed.
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP
/**
* Invalid pipeline structure, missing +proj argument, etc.
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP_WRONG_SYNTAX
/**
*Missing required operation parameter
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP_MISSING_ARG
/**
*One of the operation parameter has an illegal value.
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE
/**
* Mutually exclusive arguments.
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP_MUTUALLY_EXCLUSIVE_ARGS
/**
* File not found or with invalid content (particular case of PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE)
*/
public interface osrConstants:public final static int PROJ_ERR_INVALID_OP_FILE_NOT_FOUND_OR_INVALID
/**
* Class of error codes related to transformation on a specific coordinate.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM
/**
* Invalid input coordinate. e.g a latitude > 90 deg.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM_INVALID_COORD
/**
* Coordinate is outside of the projection domain. e.g approximate mercator with \|longitude - lon_0\| > 90 deg,
* or iterative convergence method failed.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM_OUTSIDE_PROJECTION_DOMAIN
/**
* No operation found, e.g if no match the required accuracy, or if ballpark transformations
* were asked to not be used and they would be only such candidate.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM_NO_OPERATION
/**
* Point to transform falls outside grid/subgrid/TIN.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM_OUTSIDE_GRID
/**
* Point to transform falls in a grid cell that evaluates to nodata.
*/
public interface osrConstants:public final static int PROJ_ERR_COORD_TRANSFM_GRID_AT_NODATA
/**
* Class of error codes that do not fit into one of the above class.
*/
public interface osrConstants:public final static int PROJ_ERR_OTHER
/**
* Error related to a misuse of PROJ API.
*/
public interface osrConstants:public final static int PROJ_ERR_OTHER_API_MISUSE
/**
* No inverse method available.
*/
public interface osrConstants:public final static int PROJ_ERR_OTHER_NO_INVERSE_OP
/**
* Failure when accessing a network resource.
*/
public interface osrConstants:public final static int PROJ_ERR_OTHER_NETWORK_ERROR
/* Class osr */
/**
* Class with static methods for utility functions.
*/
public class osr
/**
* Use exceptions instead of error return codes.
* <p>
* This is the default behavior : methods that in C/C++ return an OGRErr return code
* would throw a RuntimeException() in case the code it is different
* from ogr.OGRERR_NONE. By calling this method, you can get
* back to that original state if DontUseExceptions() was called in-between.
* This will only apply to the org.gdal.osr.* package.
*
* @since Java bindings 1.7.0
*/
public class osr:public static void UseExceptions()
/**
* Use return code instead of exceptions.
* <p>
* By default, methods that in C/C++ return an OGRErr return code
* would throw a RuntimeException() in case the code is different
* from ogr.OGRERR_NONE. By calling this method, you can prevent
* the exception to be thrown and get the original error code
* (ogr.OGRERR_* codes)
* This will only apply to the org.gdal.osr.* package.
*
* @since Java bindings 1.7.0
*/
public class osr:public static void DontUseExceptions()
/**
* Utility function that returns the WKT definition of the SRS expressed as a user input.
* <p>
* Such a user input is what can be passed in to
* SpatialReference.<a href="SpatialReference.html#SetFromUserInput(java.lang.String)">SetFromUserInput()</a>.
*
* @param definition text definition to try to deduce SRS from.
*
* @return WKT definition
*/
public class osr:public static String GetUserInputAsWKT(String definition)
/**
* Utility function that returns the WKT definition of the SRS expressed as a well known Geog CS.
* <p>
* Such a user input is what can be passed in to
* SpatialReference.<a href="SpatialReference.html#SetWellKnownGeogCS(java.lang.String)">SetWellKnownGeogCS()</a>.
*
* @param definition text definition to try to deduce SRS from.
*
* @return WKT definition
*/
public class osr:public static String GetWellKnownGeogCSAsWKT(String definition)
/**
* Create transformation object.
*
* @param src source spatial reference system.
* @param dst target spatial reference system.
* @return a new CoordinateTransformation object, or null in case of failure
* @since GDAL 1.10
* @see <a href="CoordinateTransformation.html#CreateCoordinateTransformation(org.gdal.osr.SpatialReference,%20org.gdal.osr.SpatialReference)">
* CoordinateTransformation.CreateCoordinateTransformation(org.gdal.osr.SpatialReference, org.gdal.osr.SpatialReference</a>
*/
public class osr:public static CoordinateTransformation CreateCoordinateTransformation(SpatialReference src, SpatialReference dst)
/**
* @deprecated This is a typo. Use wkb25DBit instead.
*/
public interface ogrConstants:public final static int wkb25Bit
/**
* Bit mask to indicate that a geometry type is of 2.5D kind.
*
* @since Java bindings 1.7.0
*/
public interface ogrConstants:public final static int wkb25DBit
/**
* Unknown type, non-standard
*/
public interface ogrConstants:public final static int wkbUnknown
/**
* 0-dimensional geometric object, standard WKB
*/
public interface ogrConstants:public final static int wkbPoint
/**
* 1-dimensional geometric object with linear interpolation between Points, standard WKB
*/
public interface ogrConstants:public final static int wkbLineString
/**
* Planar 2-dimensional geometric object defined
* by 1 exterior boundary and 0 or more interior
* boundaries, standard WKB
*/
public interface ogrConstants:public final static int wkbPolygon
/**
* GeometryCollection of Points, standard WKB
*/
public interface ogrConstants:public final static int wkbMultiPoint
/**
* GeometryCollection of LineStrings, standard WKB
*/
public interface ogrConstants:public final static int wkbMultiLineString
/**
* GeometryCollection of Polygons, standard WKB
*/
public interface ogrConstants:public final static int wkbMultiPolygon
/**
* Geometric object that is a collection of 1 or more geometric objects, standard WKB
*/
public interface ogrConstants:public final static int wkbGeometryCollection
/**
* non-standard, for pure attribute records
*/
public interface ogrConstants:public final static int wkbNone
/**
* non-standard, just for Geometry() constructor
*/
public interface ogrConstants:public final static int wkbLinearRing
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbPoint25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbLineString25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbPolygon25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbMultiPoint25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbMultiLineString25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbMultiPolygon25D
/**
* 2.5D extension as per 99-402
*/
public interface ogrConstants:public final static int wkbGeometryCollection25D
/**
* MSB/Sun/Motorola: Most Significant Byte First
*/
public interface ogrConstants:public final static int wkbXDR
/**
* LSB/Intel/Vax: Least Significant Byte First
*/
public interface ogrConstants:public final static int wkbNDR
|