/usr/lib/python3/dist-packages/osgeo/ogr.py is in python3-gdal 1.10.1+dfsg-5ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 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 | # This file was automatically generated by SWIG (http://www.swig.org).
# Version 2.0.11
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.
from sys import version_info
if version_info >= (2,6,0):
def swig_import_helper():
from os.path import dirname
import imp
fp = None
try:
fp, pathname, description = imp.find_module('_ogr', [dirname(__file__)])
except ImportError:
import _ogr
return _ogr
if fp is not None:
try:
_mod = imp.load_module('_ogr', fp, pathname, description)
finally:
fp.close()
return _mod
_ogr = swig_import_helper()
del swig_import_helper
else:
import _ogr
del version_info
try:
_swig_property = property
except NameError:
pass # Python < 2.2 doesn't have 'property'.
def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
if (name == "thisown"): return self.this.own(value)
if (name == "this"):
if type(value).__name__ == 'SwigPyObject':
self.__dict__[name] = value
return
method = class_type.__swig_setmethods__.get(name,None)
if method: return method(self,value)
if (not static):
self.__dict__[name] = value
else:
raise AttributeError("You cannot add attributes to %s" % self)
def _swig_setattr(self,class_type,name,value):
return _swig_setattr_nondynamic(self,class_type,name,value,0)
def _swig_getattr(self,class_type,name):
if (name == "thisown"): return self.this.own()
method = class_type.__swig_getmethods__.get(name,None)
if method: return method(self)
raise AttributeError(name)
def _swig_repr(self):
try: strthis = "proxy of " + self.this.__repr__()
except: strthis = ""
return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
try:
_object = object
_newclass = 1
except AttributeError:
class _object : pass
_newclass = 0
wkb25DBit = _ogr.wkb25DBit
wkb25Bit = _ogr.wkb25Bit
wkbUnknown = _ogr.wkbUnknown
wkbPoint = _ogr.wkbPoint
wkbLineString = _ogr.wkbLineString
wkbPolygon = _ogr.wkbPolygon
wkbMultiPoint = _ogr.wkbMultiPoint
wkbMultiLineString = _ogr.wkbMultiLineString
wkbMultiPolygon = _ogr.wkbMultiPolygon
wkbGeometryCollection = _ogr.wkbGeometryCollection
wkbNone = _ogr.wkbNone
wkbLinearRing = _ogr.wkbLinearRing
wkbPoint25D = _ogr.wkbPoint25D
wkbLineString25D = _ogr.wkbLineString25D
wkbPolygon25D = _ogr.wkbPolygon25D
wkbMultiPoint25D = _ogr.wkbMultiPoint25D
wkbMultiLineString25D = _ogr.wkbMultiLineString25D
wkbMultiPolygon25D = _ogr.wkbMultiPolygon25D
wkbGeometryCollection25D = _ogr.wkbGeometryCollection25D
OFTInteger = _ogr.OFTInteger
OFTIntegerList = _ogr.OFTIntegerList
OFTReal = _ogr.OFTReal
OFTRealList = _ogr.OFTRealList
OFTString = _ogr.OFTString
OFTStringList = _ogr.OFTStringList
OFTWideString = _ogr.OFTWideString
OFTWideStringList = _ogr.OFTWideStringList
OFTBinary = _ogr.OFTBinary
OFTDate = _ogr.OFTDate
OFTTime = _ogr.OFTTime
OFTDateTime = _ogr.OFTDateTime
OJUndefined = _ogr.OJUndefined
OJLeft = _ogr.OJLeft
OJRight = _ogr.OJRight
wkbXDR = _ogr.wkbXDR
wkbNDR = _ogr.wkbNDR
NullFID = _ogr.NullFID
ALTER_NAME_FLAG = _ogr.ALTER_NAME_FLAG
ALTER_TYPE_FLAG = _ogr.ALTER_TYPE_FLAG
ALTER_WIDTH_PRECISION_FLAG = _ogr.ALTER_WIDTH_PRECISION_FLAG
ALTER_ALL_FLAG = _ogr.ALTER_ALL_FLAG
OLCRandomRead = _ogr.OLCRandomRead
OLCSequentialWrite = _ogr.OLCSequentialWrite
OLCRandomWrite = _ogr.OLCRandomWrite
OLCFastSpatialFilter = _ogr.OLCFastSpatialFilter
OLCFastFeatureCount = _ogr.OLCFastFeatureCount
OLCFastGetExtent = _ogr.OLCFastGetExtent
OLCCreateField = _ogr.OLCCreateField
OLCDeleteField = _ogr.OLCDeleteField
OLCReorderFields = _ogr.OLCReorderFields
OLCAlterFieldDefn = _ogr.OLCAlterFieldDefn
OLCTransactions = _ogr.OLCTransactions
OLCDeleteFeature = _ogr.OLCDeleteFeature
OLCFastSetNextByIndex = _ogr.OLCFastSetNextByIndex
OLCStringsAsUTF8 = _ogr.OLCStringsAsUTF8
OLCIgnoreFields = _ogr.OLCIgnoreFields
ODsCCreateLayer = _ogr.ODsCCreateLayer
ODsCDeleteLayer = _ogr.ODsCDeleteLayer
ODrCCreateDataSource = _ogr.ODrCCreateDataSource
ODrCDeleteDataSource = _ogr.ODrCDeleteDataSource
def GetUseExceptions(*args):
"""GetUseExceptions() -> int"""
return _ogr.GetUseExceptions(*args)
def UseExceptions(*args):
"""UseExceptions()"""
return _ogr.UseExceptions(*args)
def DontUseExceptions(*args):
"""DontUseExceptions()"""
return _ogr.DontUseExceptions(*args)
from . import osr
class Driver(_object):
"""Proxy of C++ OGRDriverShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, Driver, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, Driver, name)
def __init__(self, *args, **kwargs): raise AttributeError("No constructor defined")
__repr__ = _swig_repr
__swig_getmethods__["name"] = _ogr.Driver_name_get
if _newclass:name = _swig_property(_ogr.Driver_name_get)
def CreateDataSource(self, *args, **kwargs):
"""
CreateDataSource(Driver self, char const * utf8_path, char ** options=None) -> DataSource
OGRDataSourceH
OGR_Dr_CreateDataSource(OGRSFDriverH hDriver, const char *pszName,
char **papszOptions)
This function attempts to create a new data source based on the passed
driver.
The papszOptions argument can be used to control driver specific
creation options. These options are normally documented in the format
specific documentation.
It is important to call OGR_DS_Destroy() when the datasource is no
longer used to ensure that all data has been properly flushed to disk.
This function is the same as the C++ method
OGRSFDriver::CreateDataSource().
Parameters:
-----------
hDriver: handle to the driver on which data source creation is based.
pszName: the name for the new data source. UTF-8 encoded.
papszOptions: a StringList of name=value options. Options are driver
specific, and driver information can be found at the following
url:http://www.gdal.org/ogr/ogr_formats.html
NULL is returned on failure, or a new OGRDataSource handle on success.
"""
return _ogr.Driver_CreateDataSource(self, *args, **kwargs)
def CopyDataSource(self, *args, **kwargs):
"""
CopyDataSource(Driver self, DataSource copy_ds, char const * utf8_path, char ** options=None) -> DataSource
OGRDataSourceH
OGR_Dr_CopyDataSource(OGRSFDriverH hDriver, OGRDataSourceH hSrcDS,
const char *pszNewName, char **papszOptions)
This function creates a new datasource by copying all the layers from
the source datasource.
It is important to call OGR_DS_Destroy() when the datasource is no
longer used to ensure that all data has been properly flushed to disk.
This function is the same as the C++ method
OGRSFDriver::CopyDataSource().
Parameters:
-----------
hDriver: handle to the driver on which data source creation is based.
hSrcDS: source datasource
pszNewName: the name for the new data source.
papszOptions: a StringList of name=value options. Options are driver
specific, and driver information can be found at the following
url:http://www.gdal.org/ogr/ogr_formats.html
NULL is returned on failure, or a new OGRDataSource handle on success.
"""
return _ogr.Driver_CopyDataSource(self, *args, **kwargs)
def Open(self, *args, **kwargs):
"""
Open(Driver self, char const * utf8_path, int update=0) -> DataSource
OGRDataSourceH OGR_Dr_Open(OGRSFDriverH
hDriver, const char *pszName, int bUpdate)
Attempt to open file with this driver.
This function is the same as the C++ method OGRSFDriver::Open().
Parameters:
-----------
hDriver: handle to the driver that is used to open file.
pszName: the name of the file, or data source to try and open.
bUpdate: TRUE if update access is required, otherwise FALSE (the
default).
NULL on error or if the pass name is not supported by this driver,
otherwise an handle to an OGRDataSource. This OGRDataSource should be
closed by deleting the object when it is no longer needed.
"""
return _ogr.Driver_Open(self, *args, **kwargs)
def DeleteDataSource(self, *args):
"""
DeleteDataSource(Driver self, char const * utf8_path) -> int
OGRErr
OGR_Dr_DeleteDataSource(OGRSFDriverH hDriver, const char
*pszDataSource)
Delete a datasource.
Delete (from the disk, in the database, ...) the named datasource.
Normally it would be safest if the datasource was not open at the
time.
Whether this is a supported operation on this driver case be tested
using TestCapability() on ODrCDeleteDataSource.
This method is the same as the C++ method
OGRSFDriver::DeleteDataSource().
Parameters:
-----------
hDriver: handle to the driver on which data source deletion is based.
pszDataSource: the name of the datasource to delete.
OGRERR_NONE on success, and OGRERR_UNSUPPORTED_OPERATION if this is
not supported by this driver.
"""
return _ogr.Driver_DeleteDataSource(self, *args)
def TestCapability(self, *args):
"""
TestCapability(Driver self, char const * cap) -> bool
int
OGR_Dr_TestCapability(OGRSFDriverH hDriver, const char *pszCap)
Test if capability is available.
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.
ODrCCreateDataSource: True if this driver can support creating data
sources.
ODrCDeleteDataSource: True if this driver supports deleting data
sources.
The #define macro forms of the capability names should be used in
preference to the strings themselves to avoid mispelling.
This function is the same as the C++ method
OGRSFDriver::TestCapability().
Parameters:
-----------
hDriver: handle to the driver to test the capability against.
pszCap: the capability to test.
TRUE if capability available otherwise FALSE.
"""
return _ogr.Driver_TestCapability(self, *args)
def GetName(self, *args):
"""
GetName(Driver self) -> char const *
const char*
OGR_Dr_GetName(OGRSFDriverH hDriver)
Fetch name of driver (file format). This name should be relatively
short (10-40 characters), and should reflect the underlying file
format. For instance "ESRI Shapefile".
This function is the same as the C++ method OGRSFDriver::GetName().
Parameters:
-----------
hDriver: handle to the the driver to get the name from.
driver name. This is an internal string and should not be modified or
freed.
"""
return _ogr.Driver_GetName(self, *args)
def Register(self, *args):
"""Register(Driver self)"""
return _ogr.Driver_Register(self, *args)
def Deregister(self, *args):
"""Deregister(Driver self)"""
return _ogr.Driver_Deregister(self, *args)
Driver_swigregister = _ogr.Driver_swigregister
Driver_swigregister(Driver)
class DataSource(_object):
"""Proxy of C++ OGRDataSourceShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, DataSource, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, DataSource, name)
def __init__(self, *args, **kwargs): raise AttributeError("No constructor defined")
__repr__ = _swig_repr
__swig_getmethods__["name"] = _ogr.DataSource_name_get
if _newclass:name = _swig_property(_ogr.DataSource_name_get)
__swig_destroy__ = _ogr.delete_DataSource
__del__ = lambda self : None;
def GetRefCount(self, *args):
"""
GetRefCount(DataSource self) -> int
int
OGR_DS_GetRefCount(OGRDataSourceH hDataSource)
"""
return _ogr.DataSource_GetRefCount(self, *args)
def GetSummaryRefCount(self, *args):
"""
GetSummaryRefCount(DataSource self) -> int
int
OGR_DS_GetSummaryRefCount(OGRDataSourceH hDataSource)
"""
return _ogr.DataSource_GetSummaryRefCount(self, *args)
def GetLayerCount(self, *args):
"""
GetLayerCount(DataSource self) -> int
int
OGR_DS_GetLayerCount(OGRDataSourceH hDS)
Get the number of layers in this data source.
This function is the same as the C++ method
OGRDataSource::GetLayerCount().
Parameters:
-----------
hDS: handle to the data source from which to get the number of
layers.
layer count.
"""
return _ogr.DataSource_GetLayerCount(self, *args)
def GetDriver(self, *args):
"""
GetDriver(DataSource self) -> Driver
OGRSFDriverH
OGR_DS_GetDriver(OGRDataSourceH hDS)
Returns the driver that the dataset was opened with.
This method is the same as the C++ method OGRDataSource::GetDriver()
Parameters:
-----------
hDS: handle to the datasource
NULL if driver info is not available, or pointer to a driver owned by
the OGRSFDriverManager.
"""
return _ogr.DataSource_GetDriver(self, *args)
def GetName(self, *args):
"""
GetName(DataSource self) -> char const *
const char*
OGR_DS_GetName(OGRDataSourceH hDS)
Returns the name of the data source.
This string should be sufficient to open the data source if passed to
the same OGRSFDriver 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.
This function is the same as the C++ method OGRDataSource::GetName().
Parameters:
-----------
hDS: handle to the data source to get the name from.
pointer to an internal name string which should not be modified or
freed by the caller.
"""
return _ogr.DataSource_GetName(self, *args)
def DeleteLayer(self, *args):
"""
DeleteLayer(DataSource self, int index) -> OGRErr
OGRErr
OGR_DS_DeleteLayer(OGRDataSourceH hDS, int iLayer)
Delete the indicated layer from the datasource.
If this method is supported the ODsCDeleteLayer capability will test
TRUE on the OGRDataSource.
This method is the same as the C++ method
OGRDataSource::DeleteLayer().
Parameters:
-----------
hDS: handle to the datasource
iLayer: the index of the layer to delete.
OGRERR_NONE on success, or OGRERR_UNSUPPORTED_OPERATION if deleting
layers is not supported for this datasource.
"""
return _ogr.DataSource_DeleteLayer(self, *args)
def SyncToDisk(self, *args):
"""
SyncToDisk(DataSource self) -> OGRErr
OGRErr
OGR_DS_SyncToDisk(OGRDataSourceH hDS)
Flush pending changes to disk.
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.
Some data sources do not implement this method, and will still return
OGRERR_NONE. An error is only returned if an error occurs while
attempting to flush to disk.
The default implementation of this method just calls the SyncToDisk()
method on each of the layers. Conceptionally, calling SyncToDisk() on
a datasource should include any work that might be accomplished by
calling SyncToDisk() on layers in that data source.
In any event, you should always close any opened datasource with
OGR_DS_Destroy() that will ensure all data is correctly flushed.
This method is the same as the C++ method OGRDataSource::SyncToDisk()
Parameters:
-----------
hDS: handle to the data source
OGRERR_NONE if no error occurs (even if nothing is done) or an error
code.
"""
return _ogr.DataSource_SyncToDisk(self, *args)
def CreateLayer(self, *args, **kwargs):
"""
CreateLayer(DataSource self, char const * name, SpatialReference srs=None, OGRwkbGeometryType geom_type=wkbUnknown,
char ** options=None) -> Layer
OGRLayerH
OGR_DS_CreateLayer(OGRDataSourceH hDS, const char *pszName,
OGRSpatialReferenceH hSpatialRef, OGRwkbGeometryType eType, char
**papszOptions)
This function attempts to create a new layer on the data source with
the indicated name, coordinate system, geometry type.
The papszOptions argument can be used to control driver specific
creation options. These options are normally documented in the format
specific documentation.
This function is the same as the C++ method
OGRDataSource::CreateLayer().
Parameters:
-----------
hDS: The dataset handle.
pszName: the name for the new layer. This should ideally not match
any existing layer on the datasource.
hSpatialRef: handle to the coordinate system to use for the new
layer, or NULL if no coordinate system is available.
eType: the geometry type for the layer. Use wkbUnknown if there are
no constraints on the types geometry to be written.
papszOptions: a StringList of name=value options. Options are driver
specific, and driver information can be found at the following
url:http://www.gdal.org/ogr/ogr_formats.html
NULL is returned on failure, or a new OGRLayer handle on success.
Example:
"""
return _ogr.DataSource_CreateLayer(self, *args, **kwargs)
def CopyLayer(self, *args, **kwargs):
"""
CopyLayer(DataSource self, Layer src_layer, char const * new_name, char ** options=None) -> Layer
OGRLayerH
OGR_DS_CopyLayer(OGRDataSourceH hDS, OGRLayerH hSrcLayer, const char
*pszNewName, char **papszOptions)
Duplicate an existing layer.
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.
This function is the same as the C++ method OGRDataSource::CopyLayer
Parameters:
-----------
hDS: handle to the data source where to create the new layer
hSrcLayer: handle to the source layer.
pszNewName: the name of the layer to create.
papszOptions: a StringList of name=value options. Options are driver
specific.
an handle to the layer, or NULL if an error occurs.
"""
return _ogr.DataSource_CopyLayer(self, *args, **kwargs)
def GetLayerByIndex(self, *args):
"""GetLayerByIndex(DataSource self, int index=0) -> Layer"""
return _ogr.DataSource_GetLayerByIndex(self, *args)
def GetLayerByName(self, *args):
"""
GetLayerByName(DataSource self, char const * layer_name) -> Layer
OGRLayerH
OGR_DS_GetLayerByName(OGRDataSourceH hDS, const char *pszName)
Fetch a layer by name.
The returned layer remains owned by the OGRDataSource and should not
be deleted by the application.
This function is the same as the C++ method
OGRDataSource::GetLayerByName().
Parameters:
-----------
hDS: handle to the data source from which to get the layer.
pszLayerName: Layer the layer name of the layer to fetch.
an handle to the layer, or NULL if the layer is not found or an error
occurs.
"""
return _ogr.DataSource_GetLayerByName(self, *args)
def TestCapability(self, *args):
"""
TestCapability(DataSource self, char const * cap) -> bool
int
OGR_DS_TestCapability(OGRDataSourceH hDS, const char *pszCap)
Test if capability is available.
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.
ODsCCreateLayer: True if this datasource can create new layers.
The #define macro forms of the capability names should be used in
preference to the strings themselves to avoid mispelling.
This function is the same as the C++ method
OGRDataSource::TestCapability().
Parameters:
-----------
hDS: handle to the data source against which to test the capability.
pszCapability: the capability to test.
TRUE if capability available otherwise FALSE.
"""
return _ogr.DataSource_TestCapability(self, *args)
def ExecuteSQL(self, *args, **kwargs):
"""
ExecuteSQL(DataSource self, char const * statement, Geometry spatialFilter=None, char const * dialect="") -> Layer
OGRLayerH
OGR_DS_ExecuteSQL(OGRDataSourceH hDS, const char *pszStatement,
OGRGeometryH hSpatialFilter, const char *pszDialect)
Execute an SQL statement against the data store.
The result of an SQL query is either NULL for statements that are in
error, or that have no results set, or an OGRLayer handle representing
a results set from the query. Note that this OGRLayer is in addition
to the layers in the data store and must be destroyed with
OGR_DS_ReleaseResultSet() before the data source is closed
(destroyed).
For more information on the SQL dialect supported internally by OGR
review theOGR SQL document. Some drivers (ie. Oracle and PostGIS) pass
the SQL directly through to the underlying RDBMS.
This function is the same as the C++ method
OGRDataSource::ExecuteSQL();
Parameters:
-----------
hDS: handle to the data source on which the SQL query is executed.
pszSQLCommand: the SQL statement to execute.
hSpatialFilter: handle to a geometry which represents a spatial
filter. Can be NULL.
pszDialect: allows control of the statement dialect. If set to NULL,
the OGR SQL engine will be used, except for RDBMS drivers that will
use their dedicated SQL engine, unless OGRSQL is explicitly passed as
the dialect.
an handle to a OGRLayer containing the results of the query.
Deallocate with OGR_DS_ReleaseResultSet().
"""
return _ogr.DataSource_ExecuteSQL(self, *args, **kwargs)
def ReleaseResultSet(self, *args):
"""
ReleaseResultSet(DataSource self, Layer layer)
void
OGR_DS_ReleaseResultSet(OGRDataSourceH hDS, OGRLayerH hLayer)
Release results of OGR_DS_ExecuteSQL().
This function should only be used to deallocate OGRLayers resulting
from an OGR_DS_ExecuteSQL() call on the same OGRDataSource. Failure to
deallocate a results set before destroying the OGRDataSource may cause
errors.
This function is the same as the C++ method
OGRDataSource::ReleaseResultSet().
Parameters:
-----------
hDS: an handle to the data source on which was executed an SQL query.
hLayer: handle to the result of a previous OGR_DS_ExecuteSQL() call.
"""
return _ogr.DataSource_ReleaseResultSet(self, *args)
def Destroy(self):
"Once called, self has effectively been destroyed. Do not access. For backwards compatiblity only"
_ogr.delete_DataSource( self )
self.thisown = 0
def Release(self):
"Once called, self has effectively been destroyed. Do not access. For backwards compatiblity only"
_ogr.delete_DataSource( self )
self.thisown = 0
def Reference(self):
"For backwards compatibility only."
return self.Reference()
def Dereference(self):
"For backwards compatibility only."
self.Dereference()
def __len__(self):
"""Returns the number of layers on the datasource"""
return self.GetLayerCount()
def __getitem__(self, value):
"""Support dictionary, list, and slice -like access to the datasource.
] would return the first layer on the datasource.
aname'] would return the layer named "aname".
:4] would return a list of the first four layers."""
if isinstance(value, slice):
output = []
for i in range(value.start,value.stop,value.step):
try:
output.append(self.GetLayer(i))
except OGRError: #we're done because we're off the end
return output
return output
if isinstance(value, int):
if value > len(self)-1:
raise IndexError
return self.GetLayer(value)
elif isinstance(value, str):
return self.GetLayer(value)
else:
raise TypeError('Input %s is not of String or Int type' % type(value))
def GetLayer(self,iLayer=0):
"""Return the layer given an index or a name"""
if isinstance(iLayer, str):
return self.GetLayerByName(str(iLayer))
elif isinstance(iLayer, int):
return self.GetLayerByIndex(iLayer)
else:
raise TypeError("Input %s is not of String or Int type" % type(iLayer))
def DeleteLayer(self, value):
"""Deletes the layer given an index or layer name"""
if isinstance(value, str):
for i in range(self.GetLayerCount()):
name = self.GetLayer(i).GetName()
if name == value:
return _ogr.DataSource_DeleteLayer(self, i)
raise ValueError("Layer %s not found to delete" % value)
elif isinstance(value, int):
return _ogr.DataSource_DeleteLayer(self, value)
else:
raise TypeError("Input %s is not of String or Int type" % type(value))
DataSource_swigregister = _ogr.DataSource_swigregister
DataSource_swigregister(DataSource)
class Layer(_object):
"""Proxy of C++ OGRLayerShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, Layer, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, Layer, name)
def __init__(self, *args, **kwargs): raise AttributeError("No constructor defined")
__repr__ = _swig_repr
def GetRefCount(self, *args):
"""
GetRefCount(Layer self) -> int
int OGR_L_GetRefCount(OGRLayerH
hLayer)
"""
return _ogr.Layer_GetRefCount(self, *args)
def SetSpatialFilter(self, *args):
"""
SetSpatialFilter(Layer self, Geometry filter)
void
OGR_L_SetSpatialFilter(OGRLayerH hLayer, OGRGeometryH hGeom)
Set a new spatial filter.
This function set the geometry to be used as a spatial filter when
fetching features via the OGR_L_GetNextFeature() function. Only
features that geometrically intersect the filter geometry will be
returned.
Currently this test is may be inaccurately implemented, but it is
guaranteed that all features who's envelope (as returned by
OGR_G_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.
This function makes an internal copy of the passed geometry. The
passed geometry remains the responsibility of the caller, and may be
safely destroyed.
For the time being the passed filter geometry should be in the same
SRS as the layer (as returned by OGR_L_GetSpatialRef()). In the future
this may be generalized.
This function is the same as the C++ method
OGRLayer::SetSpatialFilter.
Parameters:
-----------
hLayer: handle to the layer on which to set the spatial filter.
hGeom: handle to 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.
"""
return _ogr.Layer_SetSpatialFilter(self, *args)
def SetSpatialFilterRect(self, *args):
"""
SetSpatialFilterRect(Layer self, double minx, double miny, double maxx, double maxy)
void
OGR_L_SetSpatialFilterRect(OGRLayerH hLayer, double dfMinX, double
dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
This method set rectangle to be used as a spatial filter when fetching
features via the OGR_L_GetNextFeature() method. Only features that
geometrically intersect the given rectangle will be returned.
The x/y values should be in the same coordinate system as the layer as
a whole (as returned by OGRLayer::GetSpatialRef()). Internally this
method is normally implemented as creating a 5 vertex closed
rectangular polygon and passing it to OGRLayer::SetSpatialFilter(). It
exists as a convenience.
The only way to clear a spatial filter set with this method is to call
OGRLayer::SetSpatialFilter(NULL).
This method is the same as the C++ method
OGRLayer::SetSpatialFilterRect().
Parameters:
-----------
hLayer: handle to the layer on which to set the spatial filter.
dfMinX: the minimum X coordinate for the rectangular region.
dfMinY: the minimum Y coordinate for the rectangular region.
dfMaxX: the maximum X coordinate for the rectangular region.
dfMaxY: the maximum Y coordinate for the rectangular region.
"""
return _ogr.Layer_SetSpatialFilterRect(self, *args)
def GetSpatialFilter(self, *args):
"""
GetSpatialFilter(Layer self) -> Geometry
OGRGeometryH
OGR_L_GetSpatialFilter(OGRLayerH hLayer)
This function returns the current spatial filter for this layer.
The returned pointer is to an internally owned object, and should not
be altered or deleted by the caller.
This function is the same as the C++ method
OGRLayer::GetSpatialFilter().
Parameters:
-----------
hLayer: handle to the layer to get the spatial filter from.
an handle to the spatial filter geometry.
"""
return _ogr.Layer_GetSpatialFilter(self, *args)
def SetAttributeFilter(self, *args):
"""
SetAttributeFilter(Layer self, char * filter_string) -> OGRErr
OGRErr
OGR_L_SetAttributeFilter(OGRLayerH hLayer, const char *pszQuery)
Set a new attribute query.
This function sets the attribute query string to be used when fetching
features via the OGR_L_GetNextFeature() function. Only features for
which the query evaluates as true will be returned.
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:
http://ogdi.sourceforge.net/prop/6.2.CapabilitiesMetadata.html
Note that installing a query string will generally result in resetting
the current reading position (ala OGR_L_ResetReading()).
This function is the same as the C++ method
OGRLayer::SetAttributeFilter().
Parameters:
-----------
hLayer: handle to the layer on which attribute query will be
executed.
pszQuery: query in restricted SQL WHERE format, or NULL to clear the
current query.
OGRERR_NONE if successfully installed, or an error code if the query
expression is in error, or some other failure occurs.
"""
return _ogr.Layer_SetAttributeFilter(self, *args)
def ResetReading(self, *args):
"""
ResetReading(Layer self)
void
OGR_L_ResetReading(OGRLayerH hLayer)
Reset feature reading to start on the first feature.
This affects GetNextFeature().
This function is the same as the C++ method OGRLayer::ResetReading().
Parameters:
-----------
hLayer: handle to the layer on which features are read.
"""
return _ogr.Layer_ResetReading(self, *args)
def GetName(self, *args):
"""
GetName(Layer self) -> char const *
const char* OGR_L_GetName(OGRLayerH
hLayer)
Return the layer name.
This returns the same content as
OGR_FD_GetName(OGR_L_GetLayerDefn(hLayer)), but for a few drivers,
calling OGR_L_GetName() directly can avoid lengthy layer definition
initialization.
This function is the same as the C++ method OGRLayer::GetName().
Parameters:
-----------
hLayer: handle to the layer.
the layer name (must not been freed)
OGR 1.8.0
"""
return _ogr.Layer_GetName(self, *args)
def GetGeomType(self, *args):
"""
GetGeomType(Layer self) -> OGRwkbGeometryType
OGRwkbGeometryType
OGR_L_GetGeomType(OGRLayerH hLayer)
Return the layer geometry type.
This returns the same result as
OGR_FD_GetGeomType(OGR_L_GetLayerDefn(hLayer)), but for a few drivers,
calling OGR_L_GetGeomType() directly can avoid lengthy layer
definition initialization.
This function is the same as the C++ method OGRLayer::GetGeomType().
Parameters:
-----------
hLayer: handle to the layer.
the geometry type
OGR 1.8.0
"""
return _ogr.Layer_GetGeomType(self, *args)
def GetGeometryColumn(self, *args):
"""
GetGeometryColumn(Layer self) -> char const *
const char*
OGR_L_GetGeometryColumn(OGRLayerH hLayer)
This method returns the name of the underlying database column being
used as the geometry column, or "" if not supported.
This method is the same as the C++ method
OGRLayer::GetGeometryColumn()
Parameters:
-----------
hLayer: handle to the layer
geometry column name.
"""
return _ogr.Layer_GetGeometryColumn(self, *args)
def GetFIDColumn(self, *args):
"""
GetFIDColumn(Layer self) -> char const *
const char*
OGR_L_GetFIDColumn(OGRLayerH hLayer)
This method returns the name of the underlying database column being
used as the FID column, or "" if not supported.
This method is the same as the C++ method OGRLayer::GetFIDColumn()
Parameters:
-----------
hLayer: handle to the layer
fid column name.
"""
return _ogr.Layer_GetFIDColumn(self, *args)
def GetFeature(self, *args):
"""
GetFeature(Layer self, long fid) -> Feature
OGRFeatureH
OGR_L_GetFeature(OGRLayerH hLayer, long nFeatureId)
Fetch a feature by its identifier.
This function will attempt to read the identified feature. The nFID
value cannot be OGRNullFID. Success or failure of this operation is
unaffected by the spatial or attribute filters.
If this function returns a non-NULL feature, it is guaranteed that its
feature id ( OGR_F_GetFID()) will be the same as nFID.
Use OGR_L_TestCapability(OLCRandomRead) to establish if this layer
supports efficient random access reading via OGR_L_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.
Sequential reads are generally considered interrupted by a
OGR_L_GetFeature() call.
The returned feature should be free with OGR_F_Destroy().
This function is the same as the C++ method OGRLayer::GetFeature( ).
Parameters:
-----------
hLayer: handle to the layer that owned the feature.
nFeatureId: the feature id of the feature to read.
an handle to a feature now owned by the caller, or NULL on failure.
"""
return _ogr.Layer_GetFeature(self, *args)
def GetNextFeature(self, *args):
"""
GetNextFeature(Layer self) -> Feature
OGRFeatureH
OGR_L_GetNextFeature(OGRLayerH hLayer)
Fetch the next available feature from this layer.
The returned feature becomes the responsiblity of the caller to delete
with OGR_F_Destroy(). It is critical that all features associated with
an OGRLayer (more specifically an OGRFeatureDefn) be deleted before
that layer/datasource is deleted.
Only features matching the current spatial filter (set with
SetSpatialFilter()) will be returned.
This function implements sequential access to the features of a layer.
The OGR_L_ResetReading() function can be used to start at the
beginning again.
This function is the same as the C++ method
OGRLayer::GetNextFeature().
Parameters:
-----------
hLayer: handle to the layer from which feature are read.
an handle to a feature, or NULL if no more features are available.
"""
return _ogr.Layer_GetNextFeature(self, *args)
def SetNextByIndex(self, *args):
"""
SetNextByIndex(Layer self, long new_index) -> OGRErr
OGRErr
OGR_L_SetNextByIndex(OGRLayerH hLayer, long nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
This method allows positioning of a layer such that the
GetNextFeature() 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.
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.
This method is the same as the C++ method OGRLayer::SetNextByIndex()
Parameters:
-----------
hLayer: handle to the layer
nIndex: the index indicating how many steps into the result set to
seek.
OGRERR_NONE on success or an error code.
"""
return _ogr.Layer_SetNextByIndex(self, *args)
def SetFeature(self, *args):
"""
SetFeature(Layer self, Feature feature) -> OGRErr
OGRErr OGR_L_SetFeature(OGRLayerH
hLayer, OGRFeatureH hFeat)
Rewrite an existing feature.
This function will write a feature to the layer, based on the feature
id within the OGRFeature.
Use OGR_L_TestCapability(OLCRandomWrite) to establish if this layer
supports random access writing via OGR_L_SetFeature().
This function is the same as the C++ method OGRLayer::SetFeature().
Parameters:
-----------
hLayer: handle to the layer to write the feature.
hFeat: the feature to write.
OGRERR_NONE if the operation works, otherwise an appropriate error
code.
"""
return _ogr.Layer_SetFeature(self, *args)
def CreateFeature(self, *args):
"""
CreateFeature(Layer self, Feature feature) -> OGRErr
OGRErr
OGR_L_CreateFeature(OGRLayerH hLayer, OGRFeatureH hFeat)
Create and write a new feature within a layer.
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.
This function is the same as the C++ method OGRLayer::CreateFeature().
Parameters:
-----------
hLayer: handle to the layer to write the feature to.
hFeat: the handle of the feature to write to disk.
OGRERR_NONE on success.
"""
return _ogr.Layer_CreateFeature(self, *args)
def DeleteFeature(self, *args):
"""
DeleteFeature(Layer self, long fid) -> OGRErr
OGRErr
OGR_L_DeleteFeature(OGRLayerH hDS, long nFID)
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 return OGRERR_UNSUPPORTED_OPERATION. The
OGR_L_TestCapability() function may be called with OLCDeleteFeature to
check if the driver supports feature deletion.
This method is the same as the C++ method OGRLayer::DeleteFeature().
Parameters:
-----------
hLayer: handle to the layer
nFID: the feature id to be deleted from the layer
OGRERR_NONE on success.
"""
return _ogr.Layer_DeleteFeature(self, *args)
def SyncToDisk(self, *args):
"""
SyncToDisk(Layer self) -> OGRErr
OGRErr OGR_L_SyncToDisk(OGRLayerH
hDS)
Flush pending changes to disk.
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.
Some layers do not implement this method, and will still return
OGRERR_NONE. The default implementation just returns OGRERR_NONE. An
error is only returned if an error occurs while attempting to flush to
disk.
In any event, you should always close any opened datasource with
OGR_DS_Destroy() that will ensure all data is correctly flushed.
This method is the same as the C++ method OGRLayer::SyncToDisk()
Parameters:
-----------
hLayer: handle to the layer
OGRERR_NONE if no error occurs (even if nothing is done) or an error
code.
"""
return _ogr.Layer_SyncToDisk(self, *args)
def GetLayerDefn(self, *args):
"""
GetLayerDefn(Layer self) -> FeatureDefn
OGRFeatureDefnH
OGR_L_GetLayerDefn(OGRLayerH hLayer)
Fetch the schema information for this layer.
The returned handle to the OGRFeatureDefn is owned by the OGRLayer,
and should not be modified or freed by the application. It
encapsulates the attribute schema of the features of the layer.
This function is the same as the C++ method OGRLayer::GetLayerDefn().
Parameters:
-----------
hLayer: handle to the layer to get the schema information.
an handle to the feature definition.
"""
return _ogr.Layer_GetLayerDefn(self, *args)
def GetFeatureCount(self, *args, **kwargs):
"""
GetFeatureCount(Layer self, int force=1) -> int
int
OGR_L_GetFeatureCount(OGRLayerH hLayer, int bForce)
Fetch the feature count in this layer.
Returns the number of features in the layer. For dynamic databases the
count may not be exact. If bForce is FALSE, 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 bForce is TRUE some
implementations will actually scan the entire layer once to count
objects.
The returned count takes the spatial filter into account.
Note that some implementations of this method may alter the read
cursor of the layer.
This function is the same as the CPP OGRLayer::GetFeatureCount().
Parameters:
-----------
hLayer: handle to the layer that owned the features.
bForce: Flag indicating whether the count should be computed even if
it is expensive.
feature count, -1 if count not known.
"""
return _ogr.Layer_GetFeatureCount(self, *args, **kwargs)
def GetExtent(self, *args, **kwargs):
"""
GetExtent(Layer self, int force=1, int can_return_null=0)
OGRErr OGR_L_GetExtent(OGRLayerH
hLayer, OGREnvelope *psExtent, int bForce)
Fetch the extent of this layer.
Returns the extent (MBR) of the data in the layer. If bForce is FALSE,
and it would be expensive to establish the extent then OGRERR_FAILURE
will be returned indicating that the extent isn't know. If bForce is
TRUE then some implementations will actually scan the entire layer
once to compute the MBR of all the features in the layer.
Depending on the drivers, the returned extent may or may not take the
spatial filter into account. So it is safer to call OGR_L_GetExtent()
without setting a spatial filter.
Layers without any geometry may return OGRERR_FAILURE just indicating
that no meaningful extents could be collected.
Note that some implementations of this method may alter the read
cursor of the layer.
This function is the same as the C++ method OGRLayer::GetExtent().
Parameters:
-----------
hLayer: handle to the layer from which to get extent.
psExtent: the structure in which the extent value will be returned.
bForce: Flag indicating whether the extent should be computed even if
it is expensive.
OGRERR_NONE on success, OGRERR_FAILURE if extent not known.
"""
return _ogr.Layer_GetExtent(self, *args, **kwargs)
def TestCapability(self, *args):
"""
TestCapability(Layer self, char const * cap) -> bool
int
OGR_L_TestCapability(OGRLayerH hLayer, const char *pszCap)
Test if this layer supported the named capability.
The capability codes that can be tested are represented as strings,
but #defined constants exists to ensure correct spelling. Specific
layer types may implement class specific capabilities, but this can't
generally be discovered by the caller.
OLCRandomRead / "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.
OLCSequentialWrite / "SequentialWrite": TRUE if the CreateFeature()
method works for this layer. Note this means that this particular
layer is writable. The same OGRLayer class may returned FALSE for
other layer instances that are effectively read-only.
OLCRandomWrite / "RandomWrite": TRUE if the SetFeature() method is
operational on this layer. Note this means that this particular layer
is writable. The same OGRLayer class may returned FALSE for other
layer instances that are effectively read-only.
OLCFastSpatialFilter / "FastSpatialFilter": TRUE if this layer
implements spatial filtering efficiently. Layers that effectively read
all features, and test them with the OGRFeature intersection methods
should return FALSE. This can be used as a clue by the application
whether it should build and maintain its own spatial index for
features in this layer.
OLCFastFeatureCount / "FastFeatureCount": TRUE if this layer can
return a feature count (via OGR_L_GetFeatureCount()) efficiently ...
ie. without counting the features. In some cases this will return TRUE
until a spatial filter is installed after which it will return FALSE.
OLCFastGetExtent / "FastGetExtent": TRUE if this layer can return
its data extent (via OGR_L_GetExtent()) efficiently ... ie. without
scanning all the features. In some cases this will return TRUE until a
spatial filter is installed after which it will return FALSE.
OLCFastSetNextByIndex / "FastSetNextByIndex": TRUE if this layer can
perform the SetNextByIndex() call efficiently, otherwise FALSE.
OLCCreateField / "CreateField": TRUE if this layer can create new
fields on the current layer using CreateField(), otherwise FALSE.
OLCDeleteField / "DeleteField": TRUE if this layer can delete
existing fields on the current layer using DeleteField(), otherwise
FALSE.
OLCReorderFields / "ReorderFields": TRUE if this layer can reorder
existing fields on the current layer using ReorderField() or
ReorderFields(), otherwise FALSE.
OLCAlterFieldDefn / "AlterFieldDefn": TRUE if this layer can alter
the definition of an existing field on the current layer using
AlterFieldDefn(), otherwise FALSE.
OLCDeleteFeature / "DeleteFeature": TRUE if the DeleteFeature()
method is supported on this layer, otherwise FALSE.
OLCStringsAsUTF8 / "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.
OLCTransactions / "Transactions": TRUE if the StartTransaction(),
CommitTransaction() and RollbackTransaction() methods work in a
meaningful way, otherwise FALSE.
This function is the same as the C++ method
OGRLayer::TestCapability().
Parameters:
-----------
hLayer: handle to the layer to get the capability from.
pszCap: the name of the capability to test.
TRUE if the layer has the requested capability, or FALSE otherwise.
OGRLayers will return FALSE for any unrecognised capabilities.
"""
return _ogr.Layer_TestCapability(self, *args)
def CreateField(self, *args, **kwargs):
"""
CreateField(Layer self, FieldDefn field_def, int approx_ok=1) -> OGRErr
OGRErr
OGR_L_CreateField(OGRLayerH hLayer, OGRFieldDefnH hField, int
bApproxOK)
Create a new field on a layer.
You must use this to create new fields on a real layer. Internally the
OGRFeatureDefn for the layer will be updated to reflect the new field.
Applications should never modify the OGRFeatureDefn used by a layer
directly.
This function should not be called while there are feature objects in
existance that were obtained or created with the previous layer
definition.
Not all drivers support this function. 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 existings features of the backing
file/database should be updated accordingly.
This function is the same as the C++ method OGRLayer::CreateField().
Parameters:
-----------
hLayer: handle to the layer to write the field definition.
hField: handle of the field definition to write to disk.
bApproxOK: If TRUE, the field may be created in a slightly different
form depending on the limitations of the format driver.
OGRERR_NONE on success.
"""
return _ogr.Layer_CreateField(self, *args, **kwargs)
def DeleteField(self, *args):
"""
DeleteField(Layer self, int iField) -> OGRErr
OGRErr
OGR_L_DeleteField(OGRLayerH hLayer, int iField)
Create a new field on a layer.
You must use this to delete existing fields on a real layer.
Internally the OGRFeatureDefn for the layer will be updated to reflect
the deleted field. Applications should never modify the OGRFeatureDefn
used by a layer directly.
This function should not be called while there are feature objects in
existance that were obtained or created with the previous layer
definition.
Not all drivers support this function. 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 existings features of the backing
file/database should be updated accordingly.
This function is the same as the C++ method OGRLayer::DeleteField().
Parameters:
-----------
hLayer: handle to the layer.
iField: index of the field to delete.
OGRERR_NONE on success.
OGR 1.9.0
"""
return _ogr.Layer_DeleteField(self, *args)
def ReorderField(self, *args):
"""
ReorderField(Layer self, int iOldFieldPos, int iNewFieldPos) -> OGRErr
OGRErr
OGR_L_ReorderField(OGRLayerH hLayer, int iOldFieldPos, int
iNewFieldPos)
Reorder an existing field on a layer.
This function is a conveniency wrapper of OGR_L_ReorderFields()
dedicated to move a single field.
You must use this to reorder existing fields on a real layer.
Internally the OGRFeatureDefn for the layer will be updated to reflect
the reordering of the fields. Applications should never modify the
OGRFeatureDefn used by a layer directly.
This function should not be called while there are feature objects in
existance that were obtained or created with the previous layer
definition.
The field definition that was at initial position iOldFieldPos will be
moved at position iNewFieldPos, and elements between will be shuffled
accordingly.
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".
Not all drivers support this function. 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 existings features of the backing
file/database should be updated accordingly.
This function is the same as the C++ method OGRLayer::ReorderField().
Parameters:
-----------
hLayer: handle to the layer.
iOldFieldPos: previous position of the field to move. Must be in the
range [0,GetFieldCount()-1].
iNewFieldPos: new position of the field to move. Must be in the range
[0,GetFieldCount()-1].
OGRERR_NONE on success.
OGR 1.9.0
"""
return _ogr.Layer_ReorderField(self, *args)
def ReorderFields(self, *args):
"""
ReorderFields(Layer self, int nList) -> OGRErr
OGRErr
OGR_L_ReorderFields(OGRLayerH hLayer, int *panMap)
Reorder all the fields of a layer.
You must use this to reorder existing fields on a real layer.
Internally the OGRFeatureDefn for the layer will be updated to reflect
the reordering of the fields. Applications should never modify the
OGRFeatureDefn used by a layer directly.
This function should not be called while there are feature objects in
existance that were obtained or created with the previous layer
definition.
panMap is such that,for each field definition at position i after
reordering, its position before reordering was panMap[i].
For example, let suppose the fields were "0","1","2","3","4"
initially. ReorderFields([0,2,3,1,4]) will reorder them as
"0","2","3","1","4".
Not all drivers support this function. 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 existings features of the backing
file/database should be updated accordingly.
This function is the same as the C++ method OGRLayer::ReorderFields().
Parameters:
-----------
hLayer: handle to the layer.
panMap: an array of GetLayerDefn()->GetFieldCount() elements which is
a permutation of [0, GetLayerDefn()->GetFieldCount()-1].
OGRERR_NONE on success.
OGR 1.9.0
"""
return _ogr.Layer_ReorderFields(self, *args)
def AlterFieldDefn(self, *args):
"""
AlterFieldDefn(Layer self, int iField, FieldDefn field_def, int nFlags) -> OGRErr
OGRErr
OGR_L_AlterFieldDefn(OGRLayerH hLayer, int iField, OGRFieldDefnH
hNewFieldDefn, int nFlags)
Alter the definition of an existing field on a layer.
You must use this to alter the definition of an existing field of a
real layer. Internally the OGRFeatureDefn for the layer will be
updated to reflect the altered field. Applications should never modify
the OGRFeatureDefn used by a layer directly.
This function should not be called while there are feature objects in
existance that were obtained or created with the previous layer
definition.
Not all drivers support this function. 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 existings features of the backing
file/database should be updated accordingly. Some drivers might also
not support all update flags.
This function is the same as the C++ method
OGRLayer::AlterFieldDefn().
Parameters:
-----------
hLayer: handle to the layer.
iField: index of the field whose definition must be altered.
hNewFieldDefn: new field definition
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.
OGRERR_NONE on success.
OGR 1.9.0
"""
return _ogr.Layer_AlterFieldDefn(self, *args)
def StartTransaction(self, *args):
"""
StartTransaction(Layer self) -> OGRErr
OGRErr
OGR_L_StartTransaction(OGRLayerH hLayer)
For datasources which support transactions, StartTransaction creates a
transaction.
If starting the transaction fails, will return OGRERR_FAILURE.
Datasources which do not support transactions will always return
OGRERR_NONE.
This function is the same as the C++ method
OGRLayer::StartTransaction().
Parameters:
-----------
hLayer: handle to the layer
OGRERR_NONE on success.
"""
return _ogr.Layer_StartTransaction(self, *args)
def CommitTransaction(self, *args):
"""
CommitTransaction(Layer self) -> OGRErr
OGRErr
OGR_L_CommitTransaction(OGRLayerH hLayer)
For datasources which support transactions, CommitTransaction commits
a transaction.
If no transaction is active, or the commit fails, will return
OGRERR_FAILURE. Datasources which do not support transactions will
always return OGRERR_NONE.
This function is the same as the C++ method
OGRLayer::CommitTransaction().
Parameters:
-----------
hLayer: handle to the layer
OGRERR_NONE on success.
"""
return _ogr.Layer_CommitTransaction(self, *args)
def RollbackTransaction(self, *args):
"""
RollbackTransaction(Layer self) -> OGRErr
OGRErr
OGR_L_RollbackTransaction(OGRLayerH hLayer)
For datasources which support transactions, RollbackTransaction will
roll back a datasource to its state before the start of the current
transaction. If no transaction is active, or the rollback fails, will
return OGRERR_FAILURE. Datasources which do not support transactions
will always return OGRERR_NONE.
This function is the same as the C++ method
OGRLayer::RollbackTransaction().
Parameters:
-----------
hLayer: handle to the layer
OGRERR_NONE on success.
"""
return _ogr.Layer_RollbackTransaction(self, *args)
def GetSpatialRef(self, *args):
"""
GetSpatialRef(Layer self) -> SpatialReference
OGRSpatialReferenceH
OGR_L_GetSpatialRef(OGRLayerH hLayer)
Fetch the spatial reference system for this layer.
The returned object is owned by the OGRLayer and should not be
modified or freed by the application.
This function is the same as the C++ method OGRLayer::GetSpatialRef().
Parameters:
-----------
hLayer: handle to the layer to get the spatial reference from.
spatial reference, or NULL if there isn't one.
"""
return _ogr.Layer_GetSpatialRef(self, *args)
def GetFeaturesRead(self, *args):
"""
GetFeaturesRead(Layer self) -> GIntBig
GIntBig
OGR_L_GetFeaturesRead(OGRLayerH hLayer)
"""
return _ogr.Layer_GetFeaturesRead(self, *args)
def SetIgnoredFields(self, *args):
"""
SetIgnoredFields(Layer self, char const ** options) -> OGRErr
OGRErr
OGR_L_SetIgnoredFields(OGRLayerH hLayer, const char **papszFields)
Set which fields can be omitted when retrieving features from the
layer.
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.
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.
By default, no fields are ignored.
This method is the same as the C++ method OGRLayer::SetIgnoredFields()
Parameters:
-----------
papszFields: an array of field names terminated by NULL item. If NULL
is passed, the ignored list is cleared.
OGRERR_NONE if all field names have been resolved (even if the driver
does not support this method)
"""
return _ogr.Layer_SetIgnoredFields(self, *args)
def Intersection(self, *args, **kwargs):
"""
Intersection(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Intersection(self, *args, **kwargs)
def Union(self, *args, **kwargs):
"""
Union(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Union(self, *args, **kwargs)
def SymDifference(self, *args, **kwargs):
"""
SymDifference(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_SymDifference(self, *args, **kwargs)
def Identity(self, *args, **kwargs):
"""
Identity(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Identity(self, *args, **kwargs)
def Update(self, *args, **kwargs):
"""
Update(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Update(self, *args, **kwargs)
def Clip(self, *args, **kwargs):
"""
Clip(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Clip(self, *args, **kwargs)
def Erase(self, *args, **kwargs):
"""
Erase(Layer self, Layer method_layer, Layer result_layer, char ** options=None, GDALProgressFunc callback=0,
void * callback_data=None) -> OGRErr
"""
return _ogr.Layer_Erase(self, *args, **kwargs)
def Reference(self):
"For backwards compatibility only."
pass
def Dereference(self):
"For backwards compatibility only."
pass
def __len__(self):
"""Returns the number of features in the layer"""
return self.GetFeatureCount()
def __nonzero__(self):
return True
__bool__ = __nonzero__
def __getitem__(self, value):
"""Support list and slice -like access to the layer.
r[0] would return the first feature on the layer.
r[0:4] would return a list of the first four features."""
if isinstance(value, slice):
import sys
output = []
if value.stop == sys.maxsize:
stop = len(self) - 1
else:
stop = value.stop
for i in range(value.start,stop,value.step):
feature = self.GetFeature(i)
if feature:
output.append(feature)
else:
return output
return output
if isinstance(value, int):
if value > len(self)-1:
raise IndexError
return self.GetFeature(value)
else:
raise TypeError("Input %s is not of IntType or SliceType" % type(value))
def CreateFields(self, fields):
"""Create a list of fields on the Layer"""
for i in fields:
self.CreateField(i)
def __iter__(self):
return self
def __next__(self):
feature = self.GetNextFeature()
if not feature:
raise StopIteration
else:
return feature
def schema(self):
output = []
defn = self.GetLayerDefn()
for n in range(defn.GetFieldCount()):
output.append(defn.GetFieldDefn(n))
return output
schema = property(schema)
Layer_swigregister = _ogr.Layer_swigregister
Layer_swigregister(Layer)
class Feature(_object):
"""Proxy of C++ OGRFeatureShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, Feature, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, Feature, name)
__repr__ = _swig_repr
__swig_destroy__ = _ogr.delete_Feature
__del__ = lambda self : None;
def __init__(self, *args, **kwargs):
"""__init__(OGRFeatureShadow self, FeatureDefn feature_def) -> Feature"""
this = _ogr.new_Feature(*args, **kwargs)
try: self.this.append(this)
except: self.this = this
def GetDefnRef(self, *args):
"""
GetDefnRef(Feature self) -> FeatureDefn
OGRFeatureDefnH
OGR_F_GetDefnRef(OGRFeatureH hFeat)
Fetch feature definition.
This function is the same as the C++ method OGRFeature::GetDefnRef().
Parameters:
-----------
hFeat: handle to the feature to get the feature definition from.
an handle to the feature definition object on which feature depends.
"""
return _ogr.Feature_GetDefnRef(self, *args)
def SetGeometry(self, *args):
"""
SetGeometry(Feature self, Geometry geom) -> OGRErr
OGRErr
OGR_F_SetGeometry(OGRFeatureH hFeat, OGRGeometryH hGeom)
Set feature geometry.
This function updates the features geometry, and operate exactly as
SetGeometryDirectly(), except that this function does not assume
ownership of the passed geometry, but instead makes a copy of it.
This function is the same as the C++ OGRFeature::SetGeometry().
Parameters:
-----------
hFeat: handle to the feature on which new geometry is applied to.
hGeom: handle to the new geometry to apply to feature.
OGRERR_NONE if successful, or OGR_UNSUPPORTED_GEOMETRY_TYPE if the
geometry type is illegal for the OGRFeatureDefn (checking not yet
implemented).
"""
return _ogr.Feature_SetGeometry(self, *args)
def SetGeometryDirectly(self, *args):
"""
SetGeometryDirectly(Feature self, Geometry geom) -> OGRErr
OGRErr
OGR_F_SetGeometryDirectly(OGRFeatureH hFeat, OGRGeometryH hGeom)
Set feature geometry.
This function updates the features geometry, and operate exactly as
SetGeometry(), except that this function assumes ownership of the
passed geometry.
This function is the same as the C++ method
OGRFeature::SetGeometryDirectly.
Parameters:
-----------
hFeat: handle to the feature on which to apply the geometry.
hGeom: handle to the new geometry to apply to feature.
OGRERR_NONE if successful, or OGR_UNSUPPORTED_GEOMETRY_TYPE if the
geometry type is illegal for the OGRFeatureDefn (checking not yet
implemented).
"""
return _ogr.Feature_SetGeometryDirectly(self, *args)
def GetGeometryRef(self, *args):
"""
GetGeometryRef(Feature self) -> Geometry
OGRGeometryH
OGR_F_GetGeometryRef(OGRFeatureH hFeat)
Fetch an handle to feature geometry.
This function is the same as the C++ method
OGRFeature::GetGeometryRef().
Parameters:
-----------
hFeat: handle to the feature to get geometry from.
an handle to internal feature geometry. This object should not be
modified.
"""
return _ogr.Feature_GetGeometryRef(self, *args)
def Clone(self, *args):
"""
Clone(Feature self) -> Feature
OGRFeatureH OGR_F_Clone(OGRFeatureH
hFeat)
Duplicate feature.
The newly created feature is owned by the caller, and will have it's
own reference to the OGRFeatureDefn.
This function is the same as the C++ method OGRFeature::Clone().
Parameters:
-----------
hFeat: handle to the feature to clone.
an handle to the new feature, exactly matching this feature.
"""
return _ogr.Feature_Clone(self, *args)
def Equal(self, *args):
"""
Equal(Feature self, Feature feature) -> bool
int OGR_F_Equal(OGRFeatureH hFeat,
OGRFeatureH hOtherFeat)
Test if two features are the same.
Two features are considered equal if the share them (handle equality)
same OGRFeatureDefn, have the same field values, and the same geometry
(as tested by OGR_G_Equal()) as well as the same feature id.
This function is the same as the C++ method OGRFeature::Equal().
Parameters:
-----------
hFeat: handle to one of the feature.
hOtherFeat: handle to the other feature to test this one against.
TRUE if they are equal, otherwise FALSE.
"""
return _ogr.Feature_Equal(self, *args)
def GetFieldCount(self, *args):
"""
GetFieldCount(Feature self) -> int
int
OGR_F_GetFieldCount(OGRFeatureH hFeat)
Fetch number of fields on this feature This will always be the same as
the field count for the OGRFeatureDefn.
This function is the same as the C++ method
OGRFeature::GetFieldCount().
Parameters:
-----------
hFeat: handle to the feature to get the fields count from.
count of fields.
"""
return _ogr.Feature_GetFieldCount(self, *args)
def GetFieldDefnRef(self, *args):
"""
GetFieldDefnRef(Feature self, int id) -> FieldDefn
GetFieldDefnRef(Feature self, char const * name) -> FieldDefn
OGRFieldDefnH
OGR_F_GetFieldDefnRef(OGRFeatureH hFeat, int i)
Fetch definition for this field.
This function is the same as the C++ method
OGRFeature::GetFieldDefnRef().
Parameters:
-----------
hFeat: handle to the feature on which the field is found.
i: the field to fetch, from 0 to GetFieldCount()-1.
an handle to the field definition (from the OGRFeatureDefn). This is
an internal reference, and should not be deleted or modified.
"""
return _ogr.Feature_GetFieldDefnRef(self, *args)
def GetFieldAsString(self, *args):
"""
GetFieldAsString(Feature self, int id) -> char const
GetFieldAsString(Feature self, char const * name) -> char const *
const char*
OGR_F_GetFieldAsString(OGRFeatureH hFeat, int iField)
Fetch field value as a string.
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.
This function is the same as the C++ method
OGRFeature::GetFieldAsString().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
the field value. This string is internal, and should not be modified,
or freed. Its lifetime may be very brief.
"""
return _ogr.Feature_GetFieldAsString(self, *args)
def GetFieldAsInteger(self, *args):
"""
GetFieldAsInteger(Feature self, int id) -> int
GetFieldAsInteger(Feature self, char const * name) -> int
int
OGR_F_GetFieldAsInteger(OGRFeatureH hFeat, int iField)
Fetch field value as integer.
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.
This function is the same as the C++ method
OGRFeature::GetFieldAsInteger().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
the field value.
"""
return _ogr.Feature_GetFieldAsInteger(self, *args)
def GetFieldAsDouble(self, *args):
"""
GetFieldAsDouble(Feature self, int id) -> double
GetFieldAsDouble(Feature self, char const * name) -> double
double
OGR_F_GetFieldAsDouble(OGRFeatureH hFeat, int iField)
Fetch field value as a double.
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.
This function is the same as the C++ method
OGRFeature::GetFieldAsDouble().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
the field value.
"""
return _ogr.Feature_GetFieldAsDouble(self, *args)
def GetFieldAsDateTime(self, *args):
"""
GetFieldAsDateTime(Feature self, int id)
int
OGR_F_GetFieldAsDateTime(OGRFeatureH hFeat, int iField, int *pnYear,
int *pnMonth, int *pnDay, int *pnHour, int *pnMinute, int *pnSecond,
int *pnTZFlag)
Fetch field value as date and time.
Currently this method only works for OFTDate, OFTTime and OFTDateTime
fields.
This function is the same as the C++ method
OGRFeature::GetFieldAsDateTime().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
pnYear: (including century)
pnMonth: (1-12)
pnDay: (1-31)
pnHour: (0-23)
pnMinute: (0-59)
pnSecond: (0-59)
pnTZFlag: (0=unknown, 1=localtime, 100=GMT, see data model for
details)
TRUE on success or FALSE on failure.
"""
return _ogr.Feature_GetFieldAsDateTime(self, *args)
def GetFieldAsIntegerList(self, *args):
"""
GetFieldAsIntegerList(Feature self, int id)
const int*
OGR_F_GetFieldAsIntegerList(OGRFeatureH hFeat, int iField, int
*pnCount)
Fetch field value as a list of integers.
Currently this function only works for OFTIntegerList fields.
This function is the same as the C++ method
OGRFeature::GetFieldAsIntegerList().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
pnCount: an integer to put the list count (number of integers) into.
the field value. This list is internal, and should not be modified, or
freed. Its lifetime may be very brief. If *pnCount is zero on return
the returned pointer may be NULL or non-NULL.
"""
return _ogr.Feature_GetFieldAsIntegerList(self, *args)
def GetFieldAsDoubleList(self, *args):
"""
GetFieldAsDoubleList(Feature self, int id)
const double*
OGR_F_GetFieldAsDoubleList(OGRFeatureH hFeat, int iField, int
*pnCount)
Fetch field value as a list of doubles.
Currently this function only works for OFTRealList fields.
This function is the same as the C++ method
OGRFeature::GetFieldAsDoubleList().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
pnCount: an integer to put the list count (number of doubles) into.
the field value. This list is internal, and should not be modified, or
freed. Its lifetime may be very brief. If *pnCount is zero on return
the returned pointer may be NULL or non-NULL.
"""
return _ogr.Feature_GetFieldAsDoubleList(self, *args)
def GetFieldAsStringList(self, *args):
"""
GetFieldAsStringList(Feature self, int id) -> char **
char**
OGR_F_GetFieldAsStringList(OGRFeatureH hFeat, int iField)
Fetch field value as a list of strings.
Currently this method only works for OFTStringList fields.
The returned list is terminated by a NULL pointer. The number of
elements can also be calculated using CSLCount().
This function is the same as the C++ method
OGRFeature::GetFieldAsStringList().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to fetch, from 0 to GetFieldCount()-1.
the field value. This list is internal, and should not be modified, or
freed. Its lifetime may be very brief.
"""
return _ogr.Feature_GetFieldAsStringList(self, *args)
def IsFieldSet(self, *args):
"""
IsFieldSet(Feature self, int id) -> bool
IsFieldSet(Feature self, char const * name) -> bool
int OGR_F_IsFieldSet(OGRFeatureH
hFeat, int iField)
Test if a field has ever been assigned a value or not.
This function is the same as the C++ method OGRFeature::IsFieldSet().
Parameters:
-----------
hFeat: handle to the feature on which the field is.
iField: the field to test.
TRUE if the field has been set, otherwise false.
"""
return _ogr.Feature_IsFieldSet(self, *args)
def GetFieldIndex(self, *args):
"""
GetFieldIndex(Feature self, char const * name) -> int
int
OGR_F_GetFieldIndex(OGRFeatureH hFeat, const char *pszName)
Fetch the field index given field name.
This is a cover for the OGRFeatureDefn::GetFieldIndex() method.
This function is the same as the C++ method
OGRFeature::GetFieldIndex().
Parameters:
-----------
hFeat: handle to the feature on which the field is found.
pszName: the name of the field to search for.
the field index, or -1 if no matching field is found.
"""
return _ogr.Feature_GetFieldIndex(self, *args)
def GetFID(self, *args):
"""
GetFID(Feature self) -> int
long OGR_F_GetFID(OGRFeatureH hFeat)
Get feature identifier.
This function is the same as the C++ method OGRFeature::GetFID().
Parameters:
-----------
hFeat: handle to the feature from which to get the feature
identifier.
feature id or OGRNullFID if none has been assigned.
"""
return _ogr.Feature_GetFID(self, *args)
def SetFID(self, *args):
"""
SetFID(Feature self, int fid) -> OGRErr
OGRErr OGR_F_SetFID(OGRFeatureH hFeat,
long nFID)
Set the feature identifier.
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.
This function is the same as the C++ method OGRFeature::SetFID().
Parameters:
-----------
hFeat: handle to the feature to set the feature id to.
nFID: the new feature identifier value to assign.
On success OGRERR_NONE, or on failure some other value.
"""
return _ogr.Feature_SetFID(self, *args)
def DumpReadable(self, *args):
"""
DumpReadable(Feature self)
void
OGR_F_DumpReadable(OGRFeatureH hFeat, FILE *fpOut)
Dump this feature in a human readable form.
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.
This function is the same as the C++ method
OGRFeature::DumpReadable().
Parameters:
-----------
hFeat: handle to the feature to dump.
fpOut: the stream to write to, such as strout.
"""
return _ogr.Feature_DumpReadable(self, *args)
def UnsetField(self, *args):
"""
UnsetField(Feature self, int id)
UnsetField(Feature self, char const * name)
void OGR_F_UnsetField(OGRFeatureH
hFeat, int iField)
Clear a field, marking it as unset.
This function is the same as the C++ method OGRFeature::UnsetField().
Parameters:
-----------
hFeat: handle to the feature on which the field is.
iField: the field to unset.
"""
return _ogr.Feature_UnsetField(self, *args)
def SetField(self, *args):
"""
SetField(Feature self, int id, char const * value)
SetField(Feature self, char const * name, char const * value)
SetField(Feature self, int id, int value)
SetField(Feature self, char const * name, int value)
SetField(Feature self, int id, double value)
SetField(Feature self, char const * name, double value)
SetField(Feature self, int id, int year, int month, int day, int hour, int minute, int second, int tzflag)
SetField(Feature self, char const * name, int year, int month, int day, int hour, int minute, int second,
int tzflag)
"""
return _ogr.Feature_SetField(self, *args)
def SetFieldIntegerList(self, *args):
"""
SetFieldIntegerList(Feature self, int id, int nList)
void
OGR_F_SetFieldIntegerList(OGRFeatureH hFeat, int iField, int nCount,
int *panValues)
Set field to list of integers value.
This function currently on has an effect of OFTIntegerList fields.
This function is the same as the C++ method OGRFeature::SetField().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to set, from 0 to GetFieldCount()-1.
nCount: the number of values in the list being assigned.
panValues: the values to assign.
"""
return _ogr.Feature_SetFieldIntegerList(self, *args)
def SetFieldDoubleList(self, *args):
"""
SetFieldDoubleList(Feature self, int id, int nList)
void
OGR_F_SetFieldDoubleList(OGRFeatureH hFeat, int iField, int nCount,
double *padfValues)
Set field to list of doubles value.
This function currently on has an effect of OFTRealList fields.
This function is the same as the C++ method OGRFeature::SetField().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to set, from 0 to GetFieldCount()-1.
nCount: the number of values in the list being assigned.
padfValues: the values to assign.
"""
return _ogr.Feature_SetFieldDoubleList(self, *args)
def SetFieldStringList(self, *args):
"""
SetFieldStringList(Feature self, int id, char ** pList)
void
OGR_F_SetFieldStringList(OGRFeatureH hFeat, int iField, char
**papszValues)
Set field to list of strings value.
This function currently on has an effect of OFTStringList fields.
This function is the same as the C++ method OGRFeature::SetField().
Parameters:
-----------
hFeat: handle to the feature that owned the field.
iField: the field to set, from 0 to GetFieldCount()-1.
papszValues: the values to assign.
"""
return _ogr.Feature_SetFieldStringList(self, *args)
def SetFrom(self, *args, **kwargs):
"""
SetFrom(Feature self, Feature other, int forgiving=1) -> OGRErr
OGRErr OGR_F_SetFrom(OGRFeatureH
hFeat, OGRFeatureH hOtherFeat, int bForgiving)
Set one feature from another.
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 by corresponding field
names. Field types do not have to exactly match. OGR_F_SetField*()
function conversion rules will be applied as needed.
This function is the same as the C++ method OGRFeature::SetFrom().
Parameters:
-----------
hFeat: handle to the feature to set to.
hOtherFeat: handle to the feature from which geometry, and field
values will be copied.
bForgiving: TRUE if the operation should continue despite lacking
output fields matching some of the source fields.
OGRERR_NONE if the operation succeeds, even if some values are not
transferred, otherwise an error code.
"""
return _ogr.Feature_SetFrom(self, *args, **kwargs)
def SetFromWithMap(self, *args):
"""
SetFromWithMap(Feature self, Feature other, int forgiving, int nList) -> OGRErr
OGRErr
OGR_F_SetFromWithMap(OGRFeatureH hFeat, OGRFeatureH hOtherFeat, int
bForgiving, int *panMap)
Set one feature from another.
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.
OGR_F_SetField*() function conversion rules will be applied as needed.
This is more efficient than OGR_F_SetFrom() in that this doesn't
lookup the fields by their names. Particularly useful when the field
names don't match.
This function is the same as the C++ method OGRFeature::SetFrom().
Parameters:
-----------
hFeat: handle to the feature to set to.
hOtherFeat: handle to the feature from which geometry, and field
values will be copied.
panMap: 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.
bForgiving: TRUE if the operation should continue despite lacking
output fields matching some of the source fields.
OGRERR_NONE if the operation succeeds, even if some values are not
transferred, otherwise an error code.
"""
return _ogr.Feature_SetFromWithMap(self, *args)
def GetStyleString(self, *args):
"""
GetStyleString(Feature self) -> char const *
const char*
OGR_F_GetStyleString(OGRFeatureH hFeat)
Fetch style string for this feature.
Set the OGR Feature Style Specification for details on the format of
this string, and ogr_featurestyle.h for services available to parse
it.
This function is the same as the C++ method
OGRFeature::GetStyleString().
Parameters:
-----------
hFeat: handle to the feature to get the style from.
a reference to a representation in string format, or NULL if there
isn't one.
"""
return _ogr.Feature_GetStyleString(self, *args)
def SetStyleString(self, *args):
"""
SetStyleString(Feature self, char const * the_string)
void
OGR_F_SetStyleString(OGRFeatureH hFeat, const char *pszStyle)
Set feature style string. This method operate exactly as
OGR_F_SetStyleStringDirectly() except that it does not assume
ownership of the passed string, but instead makes a copy of it.
This function is the same as the C++ method
OGRFeature::SetStyleString().
Parameters:
-----------
hFeat: handle to the feature to set style to.
pszStyle: the style string to apply to this feature, cannot be NULL.
"""
return _ogr.Feature_SetStyleString(self, *args)
def GetFieldType(self, *args):
"""
GetFieldType(Feature self, int id) -> OGRFieldType
GetFieldType(Feature self, char const * name) -> OGRFieldType
"""
return _ogr.Feature_GetFieldType(self, *args)
def Reference(self):
pass
def Dereference(self):
pass
def Destroy(self):
"Once called, self has effectively been destroyed. Do not access. For backwards compatiblity only"
_ogr.delete_Feature( self )
self.thisown = 0
def __cmp__(self, other):
"""Compares a feature to another for equality"""
return self.Equal(other)
def __copy__(self):
return self.Clone()
def __getattr__(self, key):
"""Returns the values of fields by the given name"""
if key == 'this':
return self.__dict__[key]
try:
return self.GetField(key)
except:
raise AttributeError(key)
def __setattr__(self, key, value):
"""Set the values of fields by the given name"""
if key != 'this' and key != 'thisown' and self.GetFieldIndex(key) != -1:
return self.SetField2(key,value)
else:
self.__dict__[key] = value
def __getitem__(self, key):
"""Returns the values of fields by the given name / field_index"""
return self.GetField(key)
def __setitem__(self, key, value):
"""Returns the value of a field by field name / index"""
self.SetField2( key, value )
def GetField(self, fld_index):
if isinstance(fld_index, str):
fld_index = self.GetFieldIndex(fld_index)
if (fld_index < 0) or (fld_index > self.GetFieldCount()):
raise ValueError("Illegal field requested in GetField()")
if not (self.IsFieldSet(fld_index)):
return None
fld_type = self.GetFieldType(fld_index)
if fld_type == OFTInteger:
return self.GetFieldAsInteger(fld_index)
if fld_type == OFTReal:
return self.GetFieldAsDouble(fld_index)
if fld_type == OFTStringList:
return self.GetFieldAsStringList(fld_index)
if fld_type == OFTIntegerList:
return self.GetFieldAsIntegerList(fld_index)
if fld_type == OFTRealList:
return self.GetFieldAsDoubleList(fld_index)
return self.GetFieldAsString(fld_index)
def SetField2(self, fld_index, value):
if isinstance(fld_index, str):
fld_index = self.GetFieldIndex(fld_index)
if value is None:
self.UnsetField( fld_index )
return
if isinstance(value,list):
if len(value) == 0:
self.UnsetField( fld_index )
return
if isinstance(value[0],int):
self.SetFieldIntegerList(fld_index,value)
return
elif isinstance(value[0],float):
self.SetFieldDoubleList(fld_index,value)
return
elif isinstance(value[0],str):
self.SetFieldStringList(fld_index,value)
return
else:
raise TypeError( 'Unsupported type of list in SetField2()' )
try:
self.SetField( fld_index, value )
except:
self.SetField( fld_index, str(value) )
return
def keys(self):
names = []
for i in range(self.GetFieldCount()):
fieldname = self.GetFieldDefnRef(i).GetName()
names.append(fieldname)
return names
def items(self):
keys = self.keys()
output = {}
for key in keys:
output[key] = self.GetField(key)
return output
def geometry(self):
return self.GetGeometryRef()
def ExportToJson(self, as_object = False, options = None):
"""Exports a GeoJSON object which represents the Feature. The
as_object parameter determines whether the returned value
should be a Python object instead of a string. Defaults to False.
The options parameter is passed to Geometry.ExportToJson()"""
try:
import simplejson
except ImportError:
try:
import json as simplejson
except ImportError:
raise ImportError("Unable to import simplejson or json, needed for ExportToJson.")
geom = self.GetGeometryRef()
if geom is not None:
if options is None:
options = []
geom_json_string = geom.ExportToJson(options = options)
geom_json_object = simplejson.loads(geom_json_string)
else:
geom_json_object = None
output = {'type':'Feature',
'geometry': geom_json_object,
'properties': {}
}
fid = self.GetFID()
if fid != NullFID:
output['id'] = fid
for key in self.keys():
output['properties'][key] = self.GetField(key)
if not as_object:
output = simplejson.dumps(output)
return output
Feature_swigregister = _ogr.Feature_swigregister
Feature_swigregister(Feature)
class FeatureDefn(_object):
"""Proxy of C++ OGRFeatureDefnShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, FeatureDefn, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, FeatureDefn, name)
__repr__ = _swig_repr
__swig_destroy__ = _ogr.delete_FeatureDefn
__del__ = lambda self : None;
def __init__(self, *args, **kwargs):
"""__init__(OGRFeatureDefnShadow self, char const * name_null_ok=None) -> FeatureDefn"""
this = _ogr.new_FeatureDefn(*args, **kwargs)
try: self.this.append(this)
except: self.this = this
def GetName(self, *args):
"""
GetName(FeatureDefn self) -> char const *
const char*
OGR_FD_GetName(OGRFeatureDefnH hDefn)
Get name of the OGRFeatureDefn passed as an argument.
This function is the same as the C++ method OGRFeatureDefn::GetName().
Parameters:
-----------
hDefn: handle to the feature definition to get the name from.
the name. This name is internal and should not be modified, or freed.
"""
return _ogr.FeatureDefn_GetName(self, *args)
def GetFieldCount(self, *args):
"""
GetFieldCount(FeatureDefn self) -> int
int
OGR_FD_GetFieldCount(OGRFeatureDefnH hDefn)
Fetch number of fields on the passed feature definition.
This function is the same as the C++ OGRFeatureDefn::GetFieldCount().
Parameters:
-----------
hDefn: handle to the feature definition to get the fields count from.
count of fields.
"""
return _ogr.FeatureDefn_GetFieldCount(self, *args)
def GetFieldDefn(self, *args):
"""
GetFieldDefn(FeatureDefn self, int i) -> FieldDefn
OGRFieldDefnH
OGR_FD_GetFieldDefn(OGRFeatureDefnH hDefn, int iField)
Fetch field definition of the passed feature definition.
This function is the same as the C++ method
OGRFeatureDefn::GetFieldDefn().
Starting with GDAL 1.7.0, this method will also issue an error if the
index is not valid.
Parameters:
-----------
hDefn: handle to the feature definition to get the field definition
from.
iField: the field to fetch, between 0 and GetFieldCount()-1.
an handle to an internal field definition object or NULL if invalid
index. This object should not be modified or freed by the application.
"""
return _ogr.FeatureDefn_GetFieldDefn(self, *args)
def GetFieldIndex(self, *args):
"""
GetFieldIndex(FeatureDefn self, char const * name) -> int
int
OGR_FD_GetFieldIndex(OGRFeatureDefnH hDefn, const char *pszFieldName)
Find field by name.
The field index of the first field matching the passed field name
(case insensitively) is returned.
This function is the same as the C++ method
OGRFeatureDefn::GetFieldIndex.
Parameters:
-----------
hDefn: handle to the feature definition to get field index from.
pszFieldName: the field name to search for.
the field index, or -1 if no match found.
"""
return _ogr.FeatureDefn_GetFieldIndex(self, *args)
def AddFieldDefn(self, *args):
"""
AddFieldDefn(FeatureDefn self, FieldDefn defn)
void
OGR_FD_AddFieldDefn(OGRFeatureDefnH hDefn, OGRFieldDefnH hNewField)
Add a new field definition to the passed feature definition.
To add a new field definition to a layer definition, do not use this
function directly, but use OGR_L_CreateField() instead.
This function should only be called while there are no OGRFeature
objects in existance based on this OGRFeatureDefn. The OGRFieldDefn
passed in is copied, and remains the responsibility of the caller.
This function is the same as the C++ method
OGRFeatureDefn::AddFieldDefn().
Parameters:
-----------
hDefn: handle to the feature definition to add the field definition
to.
hNewField: handle to the new field definition.
"""
return _ogr.FeatureDefn_AddFieldDefn(self, *args)
def GetGeomType(self, *args):
"""
GetGeomType(FeatureDefn self) -> OGRwkbGeometryType
OGRwkbGeometryType
OGR_FD_GetGeomType(OGRFeatureDefnH hDefn)
Fetch the geometry base type of the passed feature definition.
This function is the same as the C++ method
OGRFeatureDefn::GetGeomType().
Parameters:
-----------
hDefn: handle to the feature definition to get the geometry type
from.
the base type for all geometry related to this definition.
"""
return _ogr.FeatureDefn_GetGeomType(self, *args)
def SetGeomType(self, *args):
"""
SetGeomType(FeatureDefn self, OGRwkbGeometryType geom_type)
void
OGR_FD_SetGeomType(OGRFeatureDefnH hDefn, OGRwkbGeometryType eType)
Assign the base geometry type for the passed layer (the same as the
feature definition).
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 OGRFeatures have been created against this definition.
This function is the same as the C++ method
OGRFeatureDefn::SetGeomType().
Parameters:
-----------
hDefn: handle to the layer or feature definition to set the geometry
type to.
eType: the new type to assign.
"""
return _ogr.FeatureDefn_SetGeomType(self, *args)
def GetReferenceCount(self, *args):
"""
GetReferenceCount(FeatureDefn self) -> int
int
OGR_FD_GetReferenceCount(OGRFeatureDefnH hDefn)
Fetch current reference count.
This function is the same as the C++ method
OGRFeatureDefn::GetReferenceCount().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
the current reference count.
"""
return _ogr.FeatureDefn_GetReferenceCount(self, *args)
def IsGeometryIgnored(self, *args):
"""
IsGeometryIgnored(FeatureDefn self) -> int
int
OGR_FD_IsGeometryIgnored(OGRFeatureDefnH hDefn)
Determine whether the geometry can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::IsGeometryIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
ignore state
"""
return _ogr.FeatureDefn_IsGeometryIgnored(self, *args)
def SetGeometryIgnored(self, *args):
"""
SetGeometryIgnored(FeatureDefn self, int bIgnored)
void
OGR_FD_SetGeometryIgnored(OGRFeatureDefnH hDefn, int bIgnore)
Set whether the geometry can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::SetGeometryIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
bIgnore: ignore state
"""
return _ogr.FeatureDefn_SetGeometryIgnored(self, *args)
def IsStyleIgnored(self, *args):
"""
IsStyleIgnored(FeatureDefn self) -> int
int
OGR_FD_IsStyleIgnored(OGRFeatureDefnH hDefn)
Determine whether the style can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::IsStyleIgnored().
Parameters:
-----------
hDefn: handle to the feature definition on which OGRFeature are based
on.
ignore state
"""
return _ogr.FeatureDefn_IsStyleIgnored(self, *args)
def SetStyleIgnored(self, *args):
"""
SetStyleIgnored(FeatureDefn self, int bIgnored)
void
OGR_FD_SetStyleIgnored(OGRFeatureDefnH hDefn, int bIgnore)
Set whether the style can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::SetStyleIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
bIgnore: ignore state
"""
return _ogr.FeatureDefn_SetStyleIgnored(self, *args)
def Destroy(self):
"Once called, self has effectively been destroyed. Do not access. For backwards compatiblity only"
_ogr.delete_FeatureDefn( self )
self.thisown = 0
FeatureDefn_swigregister = _ogr.FeatureDefn_swigregister
FeatureDefn_swigregister(FeatureDefn)
class FieldDefn(_object):
"""Proxy of C++ OGRFieldDefnShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, FieldDefn, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, FieldDefn, name)
__repr__ = _swig_repr
__swig_destroy__ = _ogr.delete_FieldDefn
__del__ = lambda self : None;
def __init__(self, *args, **kwargs):
"""__init__(OGRFieldDefnShadow self, char const * name_null_ok="unnamed", OGRFieldType field_type=OFTString) -> FieldDefn"""
this = _ogr.new_FieldDefn(*args, **kwargs)
try: self.this.append(this)
except: self.this = this
def GetName(self, *args):
"""GetName(FieldDefn self) -> char const *"""
return _ogr.FieldDefn_GetName(self, *args)
def GetNameRef(self, *args):
"""
GetNameRef(FieldDefn self) -> char const *
const char*
OGR_Fld_GetNameRef(OGRFieldDefnH hDefn)
Fetch name of this field.
This function is the same as the CPP method
OGRFieldDefn::GetNameRef().
Parameters:
-----------
hDefn: handle to the field definition.
the name of the field definition.
"""
return _ogr.FieldDefn_GetNameRef(self, *args)
def SetName(self, *args):
"""
SetName(FieldDefn self, char const * name)
void OGR_Fld_SetName(OGRFieldDefnH
hDefn, const char *pszName)
Reset the name of this field.
This function is the same as the CPP method OGRFieldDefn::SetName().
Parameters:
-----------
hDefn: handle to the field definition to apply the new name to.
pszName: the new name to apply.
"""
return _ogr.FieldDefn_SetName(self, *args)
def GetType(self, *args):
"""
GetType(FieldDefn self) -> OGRFieldType
OGRFieldType
OGR_Fld_GetType(OGRFieldDefnH hDefn)
Fetch type of this field.
This function is the same as the CPP method OGRFieldDefn::GetType().
Parameters:
-----------
hDefn: handle to the field definition to get type from.
field type.
"""
return _ogr.FieldDefn_GetType(self, *args)
def SetType(self, *args):
"""
SetType(FieldDefn self, OGRFieldType type)
void OGR_Fld_SetType(OGRFieldDefnH
hDefn, OGRFieldType eType)
Set the type of this field. This should never be done to an
OGRFieldDefn that is already part of an OGRFeatureDefn.
This function is the same as the CPP method OGRFieldDefn::SetType().
Parameters:
-----------
hDefn: handle to the field definition to set type to.
eType: the new field type.
"""
return _ogr.FieldDefn_SetType(self, *args)
def GetJustify(self, *args):
"""
GetJustify(FieldDefn self) -> OGRJustification
OGRJustification
OGR_Fld_GetJustify(OGRFieldDefnH hDefn)
Get the justification for this field.
This function is the same as the CPP method
OGRFieldDefn::GetJustify().
Parameters:
-----------
hDefn: handle to the field definition to get justification from.
the justification.
"""
return _ogr.FieldDefn_GetJustify(self, *args)
def SetJustify(self, *args):
"""
SetJustify(FieldDefn self, OGRJustification justify)
void
OGR_Fld_SetJustify(OGRFieldDefnH hDefn, OGRJustification eJustify)
Set the justification for this field.
This function is the same as the CPP method
OGRFieldDefn::SetJustify().
Parameters:
-----------
hDefn: handle to the field definition to set justification to.
eJustify: the new justification.
"""
return _ogr.FieldDefn_SetJustify(self, *args)
def GetWidth(self, *args):
"""
GetWidth(FieldDefn self) -> int
int OGR_Fld_GetWidth(OGRFieldDefnH
hDefn)
Get the formatting width for this field.
This function is the same as the CPP method OGRFieldDefn::GetWidth().
Parameters:
-----------
hDefn: handle to the field definition to get width from.
the width, zero means no specified width.
"""
return _ogr.FieldDefn_GetWidth(self, *args)
def SetWidth(self, *args):
"""
SetWidth(FieldDefn self, int width)
void OGR_Fld_SetWidth(OGRFieldDefnH
hDefn, int nNewWidth)
Set the formatting width for this field in characters.
This function is the same as the CPP method OGRFieldDefn::SetWidth().
Parameters:
-----------
hDefn: handle to the field definition to set width to.
nNewWidth: the new width.
"""
return _ogr.FieldDefn_SetWidth(self, *args)
def GetPrecision(self, *args):
"""
GetPrecision(FieldDefn self) -> int
int
OGR_Fld_GetPrecision(OGRFieldDefnH hDefn)
Get the formatting precision for this field. This should normally be
zero for fields of types other than OFTReal.
This function is the same as the CPP method
OGRFieldDefn::GetPrecision().
Parameters:
-----------
hDefn: handle to the field definition to get precision from.
the precision.
"""
return _ogr.FieldDefn_GetPrecision(self, *args)
def SetPrecision(self, *args):
"""
SetPrecision(FieldDefn self, int precision)
void
OGR_Fld_SetPrecision(OGRFieldDefnH hDefn, int nPrecision)
Set the formatting precision for this field in characters.
This should normally be zero for fields of types other than OFTReal.
This function is the same as the CPP method
OGRFieldDefn::SetPrecision().
Parameters:
-----------
hDefn: handle to the field definition to set precision to.
nPrecision: the new precision.
"""
return _ogr.FieldDefn_SetPrecision(self, *args)
def GetTypeName(self, *args):
"""GetTypeName(FieldDefn self) -> char const *"""
return _ogr.FieldDefn_GetTypeName(self, *args)
def GetFieldTypeName(self, *args):
"""GetFieldTypeName(FieldDefn self, OGRFieldType type) -> char const *"""
return _ogr.FieldDefn_GetFieldTypeName(self, *args)
def IsIgnored(self, *args):
"""
IsIgnored(FieldDefn self) -> int
int OGR_Fld_IsIgnored(OGRFieldDefnH
hDefn)
Return whether this field should be omitted when fetching features.
This method is the same as the C++ method OGRFieldDefn::IsIgnored().
Parameters:
-----------
hDefn: handle to the field definition
ignore state
"""
return _ogr.FieldDefn_IsIgnored(self, *args)
def SetIgnored(self, *args):
"""
SetIgnored(FieldDefn self, int bIgnored)
void
OGR_Fld_SetIgnored(OGRFieldDefnH hDefn, int ignore)
Set whether this field should be omitted when fetching features.
This method is the same as the C function OGRFieldDefn::SetIgnored().
Parameters:
-----------
hDefn: handle to the field definition
ignore: ignore state
"""
return _ogr.FieldDefn_SetIgnored(self, *args)
width = property(GetWidth, SetWidth)
type = property(GetType, SetType)
precision = property(GetPrecision, SetPrecision)
name = property(GetName, SetName)
justify = property(GetJustify, SetJustify)
def Destroy(self):
"Once called, self has effectively been destroyed. Do not access. For backwards compatiblity only"
_ogr.delete_FieldDefn( self )
self.thisown = 0
FieldDefn_swigregister = _ogr.FieldDefn_swigregister
FieldDefn_swigregister(FieldDefn)
def CreateGeometryFromWkb(*args, **kwargs):
"""CreateGeometryFromWkb(int len, SpatialReference reference=None) -> Geometry"""
return _ogr.CreateGeometryFromWkb(*args, **kwargs)
def CreateGeometryFromWkt(*args, **kwargs):
"""CreateGeometryFromWkt(char ** val, SpatialReference reference=None) -> Geometry"""
return _ogr.CreateGeometryFromWkt(*args, **kwargs)
def CreateGeometryFromGML(*args):
"""CreateGeometryFromGML(char const * input_string) -> Geometry"""
return _ogr.CreateGeometryFromGML(*args)
def CreateGeometryFromJson(*args):
"""CreateGeometryFromJson(char const * input_string) -> Geometry"""
return _ogr.CreateGeometryFromJson(*args)
def BuildPolygonFromEdges(*args, **kwargs):
"""BuildPolygonFromEdges(Geometry hLineCollection, int bBestEffort=0, int bAutoClose=0, double dfTolerance=0) -> Geometry"""
return _ogr.BuildPolygonFromEdges(*args, **kwargs)
def ApproximateArcAngles(*args, **kwargs):
"""
ApproximateArcAngles(double dfCenterX, double dfCenterY, double dfZ, double dfPrimaryRadius, double dfSecondaryAxis,
double dfRotation, double dfStartAngle, double dfEndAngle, double dfMaxAngleStepSizeDegrees) -> Geometry
"""
return _ogr.ApproximateArcAngles(*args, **kwargs)
def ForceToPolygon(*args):
"""ForceToPolygon(Geometry geom_in) -> Geometry"""
return _ogr.ForceToPolygon(*args)
def ForceToLineString(*args):
"""ForceToLineString(Geometry geom_in) -> Geometry"""
return _ogr.ForceToLineString(*args)
def ForceToMultiPolygon(*args):
"""ForceToMultiPolygon(Geometry geom_in) -> Geometry"""
return _ogr.ForceToMultiPolygon(*args)
def ForceToMultiPoint(*args):
"""ForceToMultiPoint(Geometry geom_in) -> Geometry"""
return _ogr.ForceToMultiPoint(*args)
def ForceToMultiLineString(*args):
"""ForceToMultiLineString(Geometry geom_in) -> Geometry"""
return _ogr.ForceToMultiLineString(*args)
class Geometry(_object):
"""Proxy of C++ OGRGeometryShadow class"""
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, Geometry, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, Geometry, name)
__repr__ = _swig_repr
__swig_destroy__ = _ogr.delete_Geometry
__del__ = lambda self : None;
def __init__(self, *args, **kwargs):
"""__init__(OGRGeometryShadow self, OGRwkbGeometryType type=wkbUnknown, char * wkt=None, int wkb=0, char * gml=None) -> Geometry"""
this = _ogr.new_Geometry(*args, **kwargs)
try: self.this.append(this)
except: self.this = this
def ExportToWkt(self, *args):
"""
ExportToWkt(Geometry self) -> OGRErr
OGRErr
OGR_G_ExportToWkt(OGRGeometryH hGeom, char **ppszSrcText)
Convert a geometry into well known text format.
This function relates to the SFCOM IWks::ExportToWKT() method.
This function is the same as the CPP method
OGRGeometry::exportToWkt().
Parameters:
-----------
hGeom: handle on the geometry to convert to a text format from.
ppszSrcText: a text buffer is allocated by the program, and assigned
to the passed pointer.
Currently OGRERR_NONE is always returned.
"""
return _ogr.Geometry_ExportToWkt(self, *args)
def ExportToWkb(self, *args, **kwargs):
"""
ExportToWkb(Geometry self, OGRwkbByteOrder byte_order=wkbXDR) -> OGRErr
OGRErr
OGR_G_ExportToWkb(OGRGeometryH hGeom, OGRwkbByteOrder eOrder, unsigned
char *pabyDstBuffer)
Convert a geometry into well known binary format.
This function relates to the SFCOM IWks::ExportToWKB() method.
This function is the same as the CPP method
OGRGeometry::exportToWkb().
Parameters:
-----------
hGeom: handle on the geometry to convert to a well know binary data
from.
eOrder: One of wkbXDR or wkbNDR indicating MSB or LSB byte order
respectively.
pabyDstBuffer: a buffer into which the binary representation is
written. This buffer must be at least OGR_G_WkbSize() byte in size.
Currently OGRERR_NONE is always returned.
"""
return _ogr.Geometry_ExportToWkb(self, *args, **kwargs)
def ExportToGML(self, *args, **kwargs):
"""ExportToGML(Geometry self, char ** options=None) -> retStringAndCPLFree *"""
return _ogr.Geometry_ExportToGML(self, *args, **kwargs)
def ExportToKML(self, *args):
"""ExportToKML(Geometry self, char const * altitude_mode=None) -> retStringAndCPLFree *"""
return _ogr.Geometry_ExportToKML(self, *args)
def ExportToJson(self, *args, **kwargs):
"""ExportToJson(Geometry self, char ** options=None) -> retStringAndCPLFree *"""
return _ogr.Geometry_ExportToJson(self, *args, **kwargs)
def AddPoint(self, *args, **kwargs):
"""AddPoint(Geometry self, double x, double y, double z=0)"""
return _ogr.Geometry_AddPoint(self, *args, **kwargs)
def AddPoint_2D(self, *args):
"""AddPoint_2D(Geometry self, double x, double y)"""
return _ogr.Geometry_AddPoint_2D(self, *args)
def AddGeometryDirectly(self, *args):
"""AddGeometryDirectly(Geometry self, Geometry other_disown) -> OGRErr"""
return _ogr.Geometry_AddGeometryDirectly(self, *args)
def AddGeometry(self, *args):
"""AddGeometry(Geometry self, Geometry other) -> OGRErr"""
return _ogr.Geometry_AddGeometry(self, *args)
def Clone(self, *args):
"""
Clone(Geometry self) -> Geometry
OGRGeometryH OGR_G_Clone(OGRGeometryH
hGeom)
Make a copy of this object.
This function relates to the SFCOM IGeometry::clone() method.
This function is the same as the CPP method OGRGeometry::clone().
Parameters:
-----------
hGeom: handle on the geometry to clone from.
an handle on the copy of the geometry with the spatial reference
system as the original.
"""
return _ogr.Geometry_Clone(self, *args)
def GetGeometryType(self, *args):
"""
GetGeometryType(Geometry self) -> OGRwkbGeometryType
OGRwkbGeometryType
OGR_G_GetGeometryType(OGRGeometryH hGeom)
Fetch geometry type.
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.
This function is the same as the CPP method
OGRGeometry::getGeometryType().
Parameters:
-----------
hGeom: handle on the geometry to get type from.
the geometry type code.
"""
return _ogr.Geometry_GetGeometryType(self, *args)
def GetGeometryName(self, *args):
"""
GetGeometryName(Geometry self) -> char const *
const char*
OGR_G_GetGeometryName(OGRGeometryH hGeom)
Fetch WKT name for geometry type.
There is no SFCOM analog to this function.
This function is the same as the CPP method
OGRGeometry::getGeometryName().
Parameters:
-----------
hGeom: handle on the geometry to get name from.
name used for this geometry type in well known text format.
"""
return _ogr.Geometry_GetGeometryName(self, *args)
def Length(self, *args):
"""Length(Geometry self) -> double"""
return _ogr.Geometry_Length(self, *args)
def Area(self, *args):
"""Area(Geometry self) -> double"""
return _ogr.Geometry_Area(self, *args)
def GetArea(self, *args):
"""GetArea(Geometry self) -> double"""
return _ogr.Geometry_GetArea(self, *args)
def GetPointCount(self, *args):
"""GetPointCount(Geometry self) -> int"""
return _ogr.Geometry_GetPointCount(self, *args)
def GetPoints(self, *args, **kwargs):
"""GetPoints(Geometry self, int nCoordDimension=0)"""
return _ogr.Geometry_GetPoints(self, *args, **kwargs)
def GetX(self, *args, **kwargs):
"""GetX(Geometry self, int point=0) -> double"""
return _ogr.Geometry_GetX(self, *args, **kwargs)
def GetY(self, *args, **kwargs):
"""GetY(Geometry self, int point=0) -> double"""
return _ogr.Geometry_GetY(self, *args, **kwargs)
def GetZ(self, *args, **kwargs):
"""GetZ(Geometry self, int point=0) -> double"""
return _ogr.Geometry_GetZ(self, *args, **kwargs)
def GetPoint(self, *args):
"""GetPoint(Geometry self, int iPoint=0)"""
return _ogr.Geometry_GetPoint(self, *args)
def GetPoint_2D(self, *args):
"""GetPoint_2D(Geometry self, int iPoint=0)"""
return _ogr.Geometry_GetPoint_2D(self, *args)
def GetGeometryCount(self, *args):
"""GetGeometryCount(Geometry self) -> int"""
return _ogr.Geometry_GetGeometryCount(self, *args)
def SetPoint(self, *args, **kwargs):
"""SetPoint(Geometry self, int point, double x, double y, double z=0)"""
return _ogr.Geometry_SetPoint(self, *args, **kwargs)
def SetPoint_2D(self, *args, **kwargs):
"""SetPoint_2D(Geometry self, int point, double x, double y)"""
return _ogr.Geometry_SetPoint_2D(self, *args, **kwargs)
def GetGeometryRef(self, *args):
"""GetGeometryRef(Geometry self, int geom) -> Geometry"""
return _ogr.Geometry_GetGeometryRef(self, *args)
def Simplify(self, *args):
"""
Simplify(Geometry self, double tolerance) -> Geometry
OGRGeometryH
OGR_G_Simplify(OGRGeometryH hThis, double dTolerance)
Compute a simplified geometry.
This function is the same as the C++ method OGRGeometry::Simplify().
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.
Parameters:
-----------
hThis: the geometry.
dTolerance: the distance tolerance for the simplification.
the simplified geometry or NULL if an error occurs.
OGR 1.8.0
"""
return _ogr.Geometry_Simplify(self, *args)
def SimplifyPreserveTopology(self, *args):
"""
SimplifyPreserveTopology(Geometry self, double tolerance) -> Geometry
OGRGeometryH
OGR_G_SimplifyPreserveTopology(OGRGeometryH hThis, double dTolerance)
Compute a simplified geometry.
This function is the same as the C++ method
OGRGeometry::SimplifyPreserveTopology().
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.
Parameters:
-----------
hThis: the geometry.
dTolerance: the distance tolerance for the simplification.
the simplified geometry or NULL if an error occurs.
OGR 1.9.0
"""
return _ogr.Geometry_SimplifyPreserveTopology(self, *args)
def Boundary(self, *args):
"""
Boundary(Geometry self) -> Geometry
OGRGeometryH
OGR_G_Boundary(OGRGeometryH hTarget)
Compute boundary.
A new geometry object is created and returned containing the boundary
of the geometry on which the method is invoked.
This function is the same as the C++ method OGR_G_Boundary().
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.
Parameters:
-----------
hTarget: The Geometry to calculate the boundary of.
a handle to a newly allocated geometry now owned by the caller, or
NULL on failure.
OGR 1.8.0
"""
return _ogr.Geometry_Boundary(self, *args)
def GetBoundary(self, *args):
"""
GetBoundary(Geometry self) -> Geometry
OGRGeometryH
OGR_G_GetBoundary(OGRGeometryH hTarget)
Compute boundary (deprecated).
Deprecated See: OGR_G_Boundary()
"""
return _ogr.Geometry_GetBoundary(self, *args)
def ConvexHull(self, *args):
"""
ConvexHull(Geometry self) -> Geometry
OGRGeometryH
OGR_G_ConvexHull(OGRGeometryH hTarget)
Compute convex hull.
A new geometry object is created and returned containing the convex
hull of the geometry on which the method is invoked.
This function is the same as the C++ method OGRGeometry::ConvexHull().
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.
Parameters:
-----------
hTarget: The Geometry to calculate the convex hull of.
a handle to a newly allocated geometry now owned by the caller, or
NULL on failure.
"""
return _ogr.Geometry_ConvexHull(self, *args)
def Buffer(self, *args, **kwargs):
"""
Buffer(Geometry self, double distance, int quadsecs=30) -> Geometry
OGRGeometryH OGR_G_Buffer(OGRGeometryH
hTarget, double dfDist, int nQuadSegs)
Compute buffer of geometry.
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.
Some buffer sections are properly described as curves, but are
converted to approximate polygons. The nQuadSegs parameter can be used
to control how many segements 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.
This function is the same as the C++ method OGRGeometry::Buffer().
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.
Parameters:
-----------
hTarget: the geometry.
dfDist: the buffer distance to be applied.
nQuadSegs: the number of segments used to approximate a 90 degree
(quadrant) of curvature.
the newly created geometry, or NULL if an error occurs.
"""
return _ogr.Geometry_Buffer(self, *args, **kwargs)
def Intersection(self, *args):
"""
Intersection(Geometry self, Geometry other) -> Geometry
OGRGeometryH
OGR_G_Intersection(OGRGeometryH hThis, OGRGeometryH hOther)
Compute intersection.
Generates a new geometry which is the region of intersection of the
two geometries operated on. The OGR_G_Intersects() function can be
used to test if two geometries intersect.
This function is the same as the C++ method
OGRGeometry::Intersection().
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.
Parameters:
-----------
hThis: the geometry.
hOther: the other geometry.
a new geometry representing the intersection or NULL if there is no
intersection or an error occurs.
"""
return _ogr.Geometry_Intersection(self, *args)
def Union(self, *args):
"""
Union(Geometry self, Geometry other) -> Geometry
OGRGeometryH OGR_G_Union(OGRGeometryH
hThis, OGRGeometryH hOther)
Compute union.
Generates a new geometry which is the region of union of the two
geometries operated on.
This function is the same as the C++ method OGRGeometry::Union().
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.
Parameters:
-----------
hThis: the geometry.
hOther: the other geometry.
a new geometry representing the union or NULL if an error occurs.
"""
return _ogr.Geometry_Union(self, *args)
def UnionCascaded(self, *args):
"""
UnionCascaded(Geometry self) -> Geometry
OGRGeometryH
OGR_G_UnionCascaded(OGRGeometryH hThis)
Compute union using cascading.
This function is the same as the C++ method
OGRGeometry::UnionCascaded().
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.
Parameters:
-----------
hThis: the geometry.
a new geometry representing the union or NULL if an error occurs.
"""
return _ogr.Geometry_UnionCascaded(self, *args)
def Difference(self, *args):
"""
Difference(Geometry self, Geometry other) -> Geometry
OGRGeometryH
OGR_G_Difference(OGRGeometryH hThis, OGRGeometryH hOther)
Compute difference.
Generates a new geometry which is the region of this geometry with the
region of the other geometry removed.
This function is the same as the C++ method OGRGeometry::Difference().
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.
Parameters:
-----------
hThis: the geometry.
hOther: the other geometry.
a new geometry representing the difference or NULL if the difference
is empty or an error occurs.
"""
return _ogr.Geometry_Difference(self, *args)
def SymDifference(self, *args):
"""
SymDifference(Geometry self, Geometry other) -> Geometry
OGRGeometryH
OGR_G_SymDifference(OGRGeometryH hThis, OGRGeometryH hOther)
Compute symmetric difference.
Generates a new geometry which is the symmetric difference of this
geometry and the other geometry.
This function is the same as the C++ method
OGRGeometry::SymmetricDifference().
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.
Parameters:
-----------
hThis: the geometry.
hOther: the other geometry.
a new geometry representing the symmetric difference or NULL if the
difference is empty or an error occurs.
OGR 1.8.0
"""
return _ogr.Geometry_SymDifference(self, *args)
def SymmetricDifference(self, *args):
"""
SymmetricDifference(Geometry self, Geometry other) -> Geometry
OGRGeometryH
OGR_G_SymmetricDifference(OGRGeometryH hThis, OGRGeometryH hOther)
Compute symmetric difference (deprecated).
Deprecated See: OGR_G_SymmetricDifference()
"""
return _ogr.Geometry_SymmetricDifference(self, *args)
def Distance(self, *args):
"""
Distance(Geometry self, Geometry other) -> double
double OGR_G_Distance(OGRGeometryH
hFirst, OGRGeometryH hOther)
Compute distance between two geometries.
Returns the shortest distance between the two geometries.
This function is the same as the C++ method OGRGeometry::Distance().
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.
Parameters:
-----------
hFirst: the first geometry to compare against.
hOther: the other geometry to compare against.
the distance between the geometries or -1 if an error occurs.
"""
return _ogr.Geometry_Distance(self, *args)
def Empty(self, *args):
"""
Empty(Geometry self)
void OGR_G_Empty(OGRGeometryH hGeom)
Clear geometry information. This restores the geometry to it's initial
state after construction, and before assignment of actual geometry.
This function relates to the SFCOM IGeometry::Empty() method.
This function is the same as the CPP method OGRGeometry::empty().
Parameters:
-----------
hGeom: handle on the geometry to empty.
"""
return _ogr.Geometry_Empty(self, *args)
def IsEmpty(self, *args):
"""
IsEmpty(Geometry self) -> bool
int OGR_G_IsEmpty(OGRGeometryH hGeom)
Test if the geometry is empty.
This method is the same as the CPP method OGRGeometry::IsEmpty().
Parameters:
-----------
hGeom: The Geometry to test.
TRUE if the geometry has no points, otherwise FALSE.
"""
return _ogr.Geometry_IsEmpty(self, *args)
def IsValid(self, *args):
"""
IsValid(Geometry self) -> bool
int OGR_G_IsValid(OGRGeometryH hGeom)
Test if the geometry is valid.
This function is the same as the C++ method OGRGeometry::IsValid().
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 return FALSE.
Parameters:
-----------
hGeom: The Geometry to test.
TRUE if the geometry has no points, otherwise FALSE.
"""
return _ogr.Geometry_IsValid(self, *args)
def IsSimple(self, *args):
"""
IsSimple(Geometry self) -> bool
int OGR_G_IsSimple(OGRGeometryH
hGeom)
Returns TRUE if the geometry is simple.
Returns TRUE if the geometry has no anomalous geometric points, such
as self intersection or self tangency. The description of each
instantiable geometric class will include the specific conditions that
cause an instance of that class to be classified as not simple.
This function is the same as the c++ method OGRGeometry::IsSimple()
method.
If OGR is built without the GEOS library, this function will always
return FALSE.
Parameters:
-----------
hGeom: The Geometry to test.
TRUE if object is simple, otherwise FALSE.
"""
return _ogr.Geometry_IsSimple(self, *args)
def IsRing(self, *args):
"""
IsRing(Geometry self) -> bool
int OGR_G_IsRing(OGRGeometryH hGeom)
Test if the geometry is a ring.
This function is the same as the C++ method OGRGeometry::IsRing().
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 return FALSE.
Parameters:
-----------
hGeom: The Geometry to test.
TRUE if the geometry has no points, otherwise FALSE.
"""
return _ogr.Geometry_IsRing(self, *args)
def Intersects(self, *args):
"""
Intersects(Geometry self, Geometry other) -> bool
int OGR_G_Intersects(OGRGeometryH
hGeom, OGRGeometryH hOtherGeom)
Do these features intersect?
Currently this is not implemented in a rigerous fashion, and generally
just tests whether the envelopes of the two features intersect.
Eventually this will be made rigerous.
This function is the same as the CPP method OGRGeometry::Intersects.
Parameters:
-----------
hGeom: handle on the first geometry.
hOtherGeom: handle on the other geometry to test against.
TRUE if the geometries intersect, otherwise FALSE.
"""
return _ogr.Geometry_Intersects(self, *args)
def Intersect(self, *args):
"""
Intersect(Geometry self, Geometry other) -> bool
int OGR_G_Intersect(OGRGeometryH
hGeom, OGRGeometryH hOtherGeom)
"""
return _ogr.Geometry_Intersect(self, *args)
def Equals(self, *args):
"""
Equals(Geometry self, Geometry other) -> bool
int OGR_G_Equals(OGRGeometryH hGeom,
OGRGeometryH hOther)
Returns TRUE if two geometries are equivalent.
This function is the same as the CPP method OGRGeometry::Equals()
method.
Parameters:
-----------
hGeom: handle on the first geometry.
hOther: handle on the other geometry to test against.
TRUE if equivalent or FALSE otherwise.
"""
return _ogr.Geometry_Equals(self, *args)
def Equal(self, *args):
"""
Equal(Geometry self, Geometry other) -> bool
int OGR_G_Equal(OGRGeometryH hGeom,
OGRGeometryH hOther)
"""
return _ogr.Geometry_Equal(self, *args)
def Disjoint(self, *args):
"""
Disjoint(Geometry self, Geometry other) -> bool
int OGR_G_Disjoint(OGRGeometryH
hThis, OGRGeometryH hOther)
Test for disjointness.
Tests if this geometry and the other geometry are disjoint.
This function is the same as the C++ method OGRGeometry::Disjoint().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if they are disjoint, otherwise FALSE.
"""
return _ogr.Geometry_Disjoint(self, *args)
def Touches(self, *args):
"""
Touches(Geometry self, Geometry other) -> bool
int OGR_G_Touches(OGRGeometryH hThis,
OGRGeometryH hOther)
Test for touching.
Tests if this geometry and the other geometry are touching.
This function is the same as the C++ method OGRGeometry::Touches().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if they are touching, otherwise FALSE.
"""
return _ogr.Geometry_Touches(self, *args)
def Crosses(self, *args):
"""
Crosses(Geometry self, Geometry other) -> bool
int OGR_G_Crosses(OGRGeometryH hThis,
OGRGeometryH hOther)
Test for crossing.
Tests if this geometry and the other geometry are crossing.
This function is the same as the C++ method OGRGeometry::Crosses().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if they are crossing, otherwise FALSE.
"""
return _ogr.Geometry_Crosses(self, *args)
def Within(self, *args):
"""
Within(Geometry self, Geometry other) -> bool
int OGR_G_Within(OGRGeometryH hThis,
OGRGeometryH hOther)
Test for containment.
Tests if this geometry is within the other geometry.
This function is the same as the C++ method OGRGeometry::Within().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if hThis is within hOther, otherwise FALSE.
"""
return _ogr.Geometry_Within(self, *args)
def Contains(self, *args):
"""
Contains(Geometry self, Geometry other) -> bool
int OGR_G_Contains(OGRGeometryH
hThis, OGRGeometryH hOther)
Test for containment.
Tests if this geometry contains the other geometry.
This function is the same as the C++ method OGRGeometry::Contains().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if hThis contains hOther geometry, otherwise FALSE.
"""
return _ogr.Geometry_Contains(self, *args)
def Overlaps(self, *args):
"""
Overlaps(Geometry self, Geometry other) -> bool
int OGR_G_Overlaps(OGRGeometryH
hThis, OGRGeometryH hOther)
Test for overlap.
Tests if this geometry and the other geometry overlap, that is their
intersection has a non-zero area.
This function is the same as the C++ method OGRGeometry::Overlaps().
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.
Parameters:
-----------
hThis: the geometry to compare.
hOther: the other geometry to compare.
TRUE if they are overlapping, otherwise FALSE.
"""
return _ogr.Geometry_Overlaps(self, *args)
def TransformTo(self, *args):
"""
TransformTo(Geometry self, SpatialReference reference) -> OGRErr
OGRErr
OGR_G_TransformTo(OGRGeometryH hGeom, OGRSpatialReferenceH hSRS)
Transform geometry to new spatial reference system.
This function 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.
This function will only work if the geometry already has an assigned
spatial reference system, and if it is transformable to the target
coordinate system.
Because this function requires internal creation and initialization of
an OGRCoordinateTransformation object it is significantly more
expensive to use this function to transform many geometries than it is
to create the OGRCoordinateTransformation in advance, and call
transform() with that transformation. This function exists primarily
for convenience when only transforming a single geometry.
This function is the same as the CPP method OGRGeometry::transformTo.
Parameters:
-----------
hGeom: handle on the geometry to apply the transform to.
hSRS: handle on the spatial reference system to apply.
OGRERR_NONE on success, or an error code.
"""
return _ogr.Geometry_TransformTo(self, *args)
def Transform(self, *args):
"""
Transform(Geometry self, CoordinateTransformation trans) -> OGRErr
OGRErr OGR_G_Transform(OGRGeometryH
hGeom, OGRCoordinateTransformationH hTransform)
Apply arbitrary coordinate transformation to geometry.
This function 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.
Note that this function 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
OGRCoordinateTransformation object, and the actual SRS of the geometry
will be ignored. On successful completion the output
OGRSpatialReference of the OGRCoordinateTransformation will be
assigned to the geometry.
This function is the same as the CPP method OGRGeometry::transform.
Parameters:
-----------
hGeom: handle on the geometry to apply the transform to.
hTransform: handle on the transformation to apply.
OGRERR_NONE on success or an error code.
"""
return _ogr.Geometry_Transform(self, *args)
def GetSpatialReference(self, *args):
"""
GetSpatialReference(Geometry self) -> SpatialReference
OGRSpatialReferenceH
OGR_G_GetSpatialReference(OGRGeometryH hGeom)
Returns spatial reference system for geometry.
This function relates to the SFCOM IGeometry::get_SpatialReference()
method.
This function is the same as the CPP method
OGRGeometry::getSpatialReference().
Parameters:
-----------
hGeom: handle on the geometry to get spatial reference from.
a reference to the spatial reference geometry.
"""
return _ogr.Geometry_GetSpatialReference(self, *args)
def AssignSpatialReference(self, *args):
"""
AssignSpatialReference(Geometry self, SpatialReference reference)
void
OGR_G_AssignSpatialReference(OGRGeometryH hGeom, OGRSpatialReferenceH
hSRS)
Assign spatial reference to this object.
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
OGRSpatialReference, but does not copy it.
This is similar to the SFCOM IGeometry::put_SpatialReference() method.
This function is the same as the CPP method
OGRGeometry::assignSpatialReference.
Parameters:
-----------
hGeom: handle on the geometry to apply the new spatial reference
system.
hSRS: handle on the new spatial reference system to apply.
"""
return _ogr.Geometry_AssignSpatialReference(self, *args)
def CloseRings(self, *args):
"""
CloseRings(Geometry self)
void OGR_G_CloseRings(OGRGeometryH
hGeom)
Force rings to be closed.
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.
Parameters:
-----------
hGeom: handle to the geometry.
"""
return _ogr.Geometry_CloseRings(self, *args)
def FlattenTo2D(self, *args):
"""
FlattenTo2D(Geometry self)
void
OGR_G_FlattenTo2D(OGRGeometryH hGeom)
Convert geometry to strictly 2D. In a sense this converts all Z
coordinates to 0.0.
This function is the same as the CPP method
OGRGeometry::flattenTo2D().
Parameters:
-----------
hGeom: handle on the geometry to convert.
"""
return _ogr.Geometry_FlattenTo2D(self, *args)
def Segmentize(self, *args):
"""
Segmentize(Geometry self, double dfMaxLength)
void OGR_G_Segmentize(OGRGeometryH
hGeom, double dfMaxLength)
Modify the geometry such it has no segment longer then the given
distance.
Interpolated points will have Z and M values (if needed) set to 0.
Distance computation is performed in 2d only
This function is the same as the CPP method OGRGeometry::segmentize().
Parameters:
-----------
hGeom: handle on the geometry to segmentize
dfMaxLength: the maximum distance between 2 points after
segmentization
"""
return _ogr.Geometry_Segmentize(self, *args)
def GetEnvelope(self, *args):
"""
GetEnvelope(Geometry self)
void
OGR_G_GetEnvelope(OGRGeometryH hGeom, OGREnvelope *psEnvelope)
Computes and returns the bounding envelope for this geometry in the
passed psEnvelope structure.
This function is the same as the CPP method
OGRGeometry::getEnvelope().
Parameters:
-----------
hGeom: handle of the geometry to get envelope from.
psEnvelope: the structure in which to place the results.
"""
return _ogr.Geometry_GetEnvelope(self, *args)
def GetEnvelope3D(self, *args):
"""
GetEnvelope3D(Geometry self)
void
OGR_G_GetEnvelope3D(OGRGeometryH hGeom, OGREnvelope3D *psEnvelope)
Computes and returns the bounding envelope (3D) for this geometry in
the passed psEnvelope structure.
This function is the same as the CPP method
OGRGeometry::getEnvelope().
Parameters:
-----------
hGeom: handle of the geometry to get envelope from.
psEnvelope: the structure in which to place the results.
OGR 1.9.0
"""
return _ogr.Geometry_GetEnvelope3D(self, *args)
def Centroid(self, *args):
"""
Centroid(Geometry self) -> Geometry
int OGR_G_Centroid(OGRGeometryH
hGeom, OGRGeometryH hCentroidPoint)
Compute the geometry centroid.
The centroid location is applied to the passed in OGRPoint object. The
centroid is not necessarily within the geometry.
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).
This function is the same as the C++ method OGRGeometry::Centroid().
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.
OGRERR_NONE on success or OGRERR_FAILURE on error.
"""
return _ogr.Geometry_Centroid(self, *args)
def PointOnSurface(self, *args):
"""PointOnSurface(Geometry self) -> Geometry"""
return _ogr.Geometry_PointOnSurface(self, *args)
def WkbSize(self, *args):
"""
WkbSize(Geometry self) -> int
int OGR_G_WkbSize(OGRGeometryH hGeom)
Returns size of related binary representation.
This function 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 function relates to the SFCOM IWks::WkbSize() method.
This function is the same as the CPP method OGRGeometry::WkbSize().
Parameters:
-----------
hGeom: handle on the geometry to get the binary size from.
size of binary representation in bytes.
"""
return _ogr.Geometry_WkbSize(self, *args)
def GetCoordinateDimension(self, *args):
"""
GetCoordinateDimension(Geometry self) -> int
int
OGR_G_GetCoordinateDimension(OGRGeometryH hGeom)
Get the dimension of the coordinates in this geometry.
This function corresponds to the SFCOM IGeometry::GetDimension()
method.
This function is the same as the CPP method
OGRGeometry::getCoordinateDimension().
Parameters:
-----------
hGeom: handle on the geometry to get the dimension of the coordinates
from.
in practice this will return 2 or 3. It can also return 0 in the case
of an empty point.
"""
return _ogr.Geometry_GetCoordinateDimension(self, *args)
def SetCoordinateDimension(self, *args):
"""
SetCoordinateDimension(Geometry self, int dimension)
void
OGR_G_SetCoordinateDimension(OGRGeometryH hGeom, int nNewDimension)
Set the coordinate dimension.
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.
Parameters:
-----------
hGeom: handle on the geometry to set the dimension of the
coordinates.
nNewDimension: New coordinate dimension value, either 2 or 3.
"""
return _ogr.Geometry_SetCoordinateDimension(self, *args)
def GetDimension(self, *args):
"""
GetDimension(Geometry self) -> int
int
OGR_G_GetDimension(OGRGeometryH hGeom)
Get the dimension of this geometry.
This function corresponds to the SFCOM IGeometry::GetDimension()
method. It indicates the dimension of the geometry, but does not
indicate the dimension of the underlying space (as indicated by
OGR_G_GetCoordinateDimension() function).
This function is the same as the CPP method
OGRGeometry::getDimension().
Parameters:
-----------
hGeom: handle on the geometry to get the dimension from.
0 for points, 1 for lines and 2 for surfaces.
"""
return _ogr.Geometry_GetDimension(self, *args)
def Destroy(self):
self.__swig_destroy__(self)
self.__del__()
self.thisown = 0
def __str__(self):
return self.ExportToWkt()
def __reduce__(self):
return (self.__class__, (), self.ExportToWkb())
def __setstate__(self, state):
result = CreateGeometryFromWkb(state)
self.this = result.this
def __iter__(self):
self.iter_subgeom = 0
return self
def __next__(self):
if self.iter_subgeom < self.GetGeometryCount():
subgeom = self.GetGeometryRef(self.iter_subgeom)
self.iter_subgeom += 1
return subgeom
else:
raise StopIteration
Geometry_swigregister = _ogr.Geometry_swigregister
Geometry_swigregister(Geometry)
def GetDriverCount(*args):
"""GetDriverCount() -> int"""
return _ogr.GetDriverCount(*args)
def GetOpenDSCount(*args):
"""GetOpenDSCount() -> int"""
return _ogr.GetOpenDSCount(*args)
def SetGenerate_DB2_V72_BYTE_ORDER(*args):
"""SetGenerate_DB2_V72_BYTE_ORDER(int bGenerate_DB2_V72_BYTE_ORDER) -> OGRErr"""
return _ogr.SetGenerate_DB2_V72_BYTE_ORDER(*args)
def RegisterAll(*args):
"""RegisterAll()"""
return _ogr.RegisterAll(*args)
def GeometryTypeToName(*args):
"""GeometryTypeToName(OGRwkbGeometryType eType) -> char const *"""
return _ogr.GeometryTypeToName(*args)
def GetFieldTypeName(*args):
"""GetFieldTypeName(OGRFieldType type) -> char const *"""
return _ogr.GetFieldTypeName(*args)
def GetOpenDS(*args):
"""GetOpenDS(int ds_number) -> DataSource"""
return _ogr.GetOpenDS(*args)
def Open(*args, **kwargs):
"""Open(char const * utf8_path, int update=0) -> DataSource"""
return _ogr.Open(*args, **kwargs)
def OpenShared(*args, **kwargs):
"""OpenShared(char const * utf8_path, int update=0) -> DataSource"""
return _ogr.OpenShared(*args, **kwargs)
def GetDriverByName(*args):
"""GetDriverByName(char const * name) -> Driver"""
return _ogr.GetDriverByName(*args)
def GetDriver(*args):
"""GetDriver(int driver_number) -> Driver"""
return _ogr.GetDriver(*args)
def GeneralCmdLineProcessor(*args):
"""GeneralCmdLineProcessor(char ** papszArgv, int nOptions=0) -> char **"""
return _ogr.GeneralCmdLineProcessor(*args)
def TermProgress_nocb(*args, **kwargs):
"""TermProgress_nocb(double dfProgress, char const * pszMessage=None, void * pData=None) -> int"""
return _ogr.TermProgress_nocb(*args, **kwargs)
TermProgress = _ogr.TermProgress
# This file is compatible with both classic and new-style classes.
|