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
|
<!-- Converted by db4-upgrade version 1.1 -->
<section xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Geometry_Processing">
<title>Geometry Processing</title><info>
<abstract>
<para>These functions compute geometric constructions,
or alter geometry size or shape.
</para>
</abstract>
</info>
<refentry xml:id="ST_Buffer">
<refnamediv>
<refname>ST_Buffer</refname>
<refpurpose>
Computes a geometry covering all points within a given distance from a geometry.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Buffer</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef><type>float </type> <parameter>radius_of_buffer</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>buffer_style_parameters = ''</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_Buffer</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef><type>float </type> <parameter>radius_of_buffer</parameter></paramdef>
<paramdef><type>integer </type> <parameter>num_seg_quarter_circle</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Buffer</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
<paramdef><type>float </type> <parameter>radius_of_buffer</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>buffer_style_parameters</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Buffer</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
<paramdef><type>float </type> <parameter>radius_of_buffer</parameter></paramdef>
<paramdef><type>integer </type> <parameter>num_seg_quarter_circle</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a POLYGON or MULTIPOLYGON that represents all points whose distance
from a geometry/geography is less than or equal to a given distance.
A negative distance shrinks the geometry rather than expanding it.
A negative distance may shrink a polygon completely, in which case POLYGON EMPTY is returned.
For points and lines negative distances always return empty results.
</para>
<para>For geometry, the distance is specified in the units of the
Spatial Reference System of the geometry.
For geography, the distance is specified in meters.</para>
<para>The optional third parameter controls the buffer accuracy and style.
The accuracy of circular arcs in the buffer is specified as the number of line segments
used to approximate a quarter circle (default is 8).
The buffer style can be specified by
providing a list of blank-separated key=value pairs as follows:
<itemizedlist>
<listitem>
<para>'quad_segs=#' : number of line segments used to approximate a quarter circle (default is 8).</para>
</listitem>
<listitem>
<para>'endcap=round|flat|square' : endcap style (defaults to "round"). 'butt' is accepted as a synonym for 'flat'.</para>
</listitem>
<listitem>
<para>'join=round|mitre|bevel' : join style (defaults to "round"). 'miter' is accepted as a synonym for 'mitre'.</para>
</listitem>
<listitem>
<para>'mitre_limit=#.#' : mitre ratio limit (only affects mitered join style). 'miter_limit' is accepted as a synonym for 'mitre_limit'.</para>
</listitem>
<listitem>
<para>'side=both|left|right' : 'left' or 'right' performs a single-sided buffer on the geometry, with the buffered side relative to the direction of the line.
This is only applicable to LINESTRING geometry and does not affect POINT or POLYGON geometries. By default end caps are square.</para>
</listitem>
</itemizedlist>
</para>
<note><para>&geography_transform;
It determines a planar spatial reference system that best fits the bounding box of the geography object
(trying UTM, Lambert Azimuthal Equal Area (LAEA) North/South pole, and finally Mercator ).
The buffer is computed in the planar space, and then transformed back to WGS84.
This may not produce the desired behavior if the input object is much larger than a UTM zone or crosses the dateline
</para></note>
<note><para>Buffer output is always a valid polygonal geometry.
Buffer can handle invalid inputs,
so buffering by distance 0 is sometimes used as a way of repairing invalid polygons.
<xref linkend="ST_MakeValid"/> can also be used for this purpose.
</para></note>
<note><para>Buffering is sometimes used to perform a within-distance search.
For this use case it is more efficient to use <xref linkend="ST_DWithin"/>.</para></note>
<note><para>This function ignores the Z dimension.
It always gives a 2D result even when used on a 3D geometry.</para></note>
<para role="enhanced" conformance="2.5.0">Enhanced: 2.5.0 - ST_Buffer geometry support was enhanced to allow for side buffering specification <code>side=both|left|right</code>.</para>
<para role="availability" conformance="1.5">Availability: 1.5 - ST_Buffer was enhanced to support different endcaps and join types. These are useful for example to convert road linestrings
into polygon roads with flat or square edges instead of rounded edges. Thin wrapper for geography was added.
</para>
<para>Performed by the GEOS module.</para>
<para>&sfs_compliant; s2.1.1.3</para>
<para>&sqlmm_compliant; SQL-MM IEC 13249-3: 5.1.30</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer01.png"/>
</imageobject>
<caption><para>quad_segs=8 (default)</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText('POINT(100 90)'),
50, 'quad_segs=8');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer02.png"/>
</imageobject>
<caption><para>quad_segs=2 (lame)</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText('POINT(100 90)'),
50, 'quad_segs=2');
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer03.png"/>
</imageobject>
<caption><para>endcap=round join=round (default)</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'endcap=round join=round');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer04.png"/>
</imageobject>
<caption><para>endcap=square</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'endcap=square join=round');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer05.png"/>
</imageobject>
<caption><para>endcap=flat</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'endcap=flat join=round');
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer07.png"/>
</imageobject>
<caption><para>join=bevel</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'join=bevel');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer06.png"/>
</imageobject>
<caption><para>join=mitre mitre_limit=5.0 (default mitre limit)</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'join=mitre mitre_limit=5.0');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer08.png"/>
</imageobject>
<caption><para>join=mitre mitre_limit=1</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'join=mitre mitre_limit=1.0');
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer09.png"/>
</imageobject>
<caption><para>side=left</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'side=left');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer10.png"/>
</imageobject>
<caption><para>side=right</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'side=right');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer11.png"/>
</imageobject>
<caption><para>side=left join=mitre</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'
), 10, 'side=left join=mitre');
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer12.png"/>
</imageobject>
<caption><para>right-hand-winding, polygon boundary side=left</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_ForceRHR(
ST_Boundary(
ST_GeomFromText(
'POLYGON ((50 50, 50 150, 150 150, 150 50, 50 50))'))),
), 20, 'side=left');
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buffer13.png"/>
</imageobject>
<caption><para>right-hand-winding, polygon boundary side=right</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_Buffer(
ST_ForceRHR(
ST_Boundary(
ST_GeomFromText(
'POLYGON ((50 50, 50 150, 150 150, 150 50, 50 50))'))
), 20,'side=right')
</programlisting>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>--A buffered point approximates a circle
-- A buffered point forcing approximation of (see diagram)
-- 2 points per quarter circle is poly with 8 sides (see diagram)
SELECT ST_NPoints(ST_Buffer(ST_GeomFromText('POINT(100 90)'), 50)) As promisingcircle_pcount,
ST_NPoints(ST_Buffer(ST_GeomFromText('POINT(100 90)'), 50, 2)) As lamecircle_pcount;
promisingcircle_pcount | lamecircle_pcount
------------------------+-------------------
33 | 9
--A lighter but lamer circle
-- only 2 points per quarter circle is an octagon
--Below is a 100 meter octagon
-- Note coordinates are in NAD 83 long lat which we transform
to Mass state plane meter and then buffer to get measurements in meters;
SELECT ST_AsText(ST_Buffer(
ST_Transform(
ST_SetSRID(ST_Point(-71.063526, 42.35785),4269), 26986)
,100,2)) As octagon;
----------------------
POLYGON((236057.59057465 900908.759918696,236028.301252769 900838.049240578,235
957.59057465 900808.759918696,235886.879896532 900838.049240578,235857.59057465
900908.759918696,235886.879896532 900979.470596815,235957.59057465 901008.759918
696,236028.301252769 900979.470596815,236057.59057465 900908.759918696))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Collect"/>, <xref linkend="ST_DWithin"/>, <xref linkend="ST_SetSRID"/>, <xref linkend="ST_Transform"/>, <xref linkend="ST_Union"/>, <xref linkend="ST_MakeValid"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_BuildArea">
<refnamediv>
<refname>ST_BuildArea</refname>
<refpurpose>Creates a polygonal geometry formed by the linework of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_BuildArea</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Creates an areal geometry formed by the constituent linework
of the input geometry.
The input can be a LineString, MultiLineString, Polygon, MultiPolygon or a GeometryCollection.
The result is a Polygon or MultiPolygon, depending on input.
If the input linework does not form polygons, NULL is returned.
</para>
<para>Unlike <xref linkend="ST_MakePolygon"/>,
this function accepts rings formed by multiple lines, and can form any number of polygons.
</para>
<para>This function converts inner rings into holes.
To turn inner rings into polygons as well, use <xref linkend="ST_Polygonize"/>.
</para>
<note>
<para>Input linework must be correctly noded for this function to work properly.
<xref linkend="ST_Node"/> can be used to node lines.
</para>
<para>If the input linework crosses, this function will produce invalid polygons.
<xref linkend="ST_MakeValid"/> can be used to ensure the output is valid.
</para>
</note>
<para role="availability" conformance="1.1.0">Availability: 1.1.0</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buildarea02.png"/>
</imageobject>
<caption><para>Input lines</para></caption>
</mediaobject>
</informalfigure>
</para></entry>
<entry><para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buildarea03.png"/>
</imageobject>
<caption><para>Area result</para></caption>
</mediaobject>
</informalfigure>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>WITH data(geom) AS (VALUES
('LINESTRING (180 40, 30 20, 20 90)'::geometry)
,('LINESTRING (180 40, 160 160)'::geometry)
,('LINESTRING (160 160, 80 190, 80 120, 20 90)'::geometry)
,('LINESTRING (80 60, 120 130, 150 80)'::geometry)
,('LINESTRING (80 60, 150 80)'::geometry)
)
SELECT ST_AsText( ST_BuildArea( ST_Collect( geom )))
FROM data;
------------------------------------------------------------------------------------------
POLYGON((180 40,30 20,20 90,80 120,80 190,160 160,180 40),(150 80,120 130,80 60,150 80))
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_buildarea01.png"/>
</imageobject>
<caption><para>Create a donut from two circular polygons</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_BuildArea(ST_Collect(inring,outring))
FROM (SELECT
ST_Buffer('POINT(100 90)', 25) As inring,
ST_Buffer('POINT(100 90)', 50) As outring) As t;
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_Collect"/>,
<xref linkend="ST_MakePolygon"/>,
<xref linkend="ST_MakeValid"/>,
<xref linkend="ST_Node"/>,
<xref linkend="ST_Polygonize"/>,
<xref linkend="ST_BdPolyFromText"/>,
<xref linkend="ST_BdMPolyFromText"/> (wrappers to
this function with standard OGC interface)</para>
</refsection>
</refentry>
<refentry xml:id="ST_Centroid">
<refnamediv>
<refname>ST_Centroid</refname>
<refpurpose>Returns the geometric center of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Centroid</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Centroid</function></funcdef>
<paramdef><type>geography </type>
<parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type>
<parameter>use_spheroid = true</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a point which is the geometric center of mass of a geometry.
For [<varname>MULTI</varname>]<varname>POINT</varname>s,
the centroid is the arithmetic mean of the input coordinates.
For [<varname>MULTI</varname>]<varname>LINESTRING</varname>s,
the centroid is computed using the weighted length of each line segment.
For [<varname>MULTI</varname>]<varname>POLYGON</varname>s,
the centroid is computed in terms of area.
If an empty geometry is supplied, an empty <varname>GEOMETRYCOLLECTION</varname> is returned.
If <varname>NULL</varname> is supplied, <varname>NULL</varname> is returned.
If <varname>CIRCULARSTRING</varname> or <varname>COMPOUNDCURVE</varname>
are supplied, they are converted to linestring with CurveToLine first,
then same than for <varname>LINESTRING</varname>
</para>
<para>For mixed-dimension input, the result is equal to the centroid of the component
Geometries of highest dimension (since the lower-dimension geometries
contribute zero "weight" to the centroid).</para>
<para>Note that for polygonal geometries the centroid does not necessarily
lie in the interior of the polygon. For example, see the diagram below
of the centroid of a C-shaped polygon.
To construct a point guaranteed to lie in the interior
of a polygon use <xref linkend="ST_PointOnSurface"/>.
</para>
<para>New in 2.3.0 : supports <varname>CIRCULARSTRING</varname> and <varname>COMPOUNDCURVE</varname> (using CurveToLine)</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0 support for geography was introduced.</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.1.4, 9.5.5</para>
</refsection>
<refsection>
<title>Examples</title>
<para>In the following illustrations the red dot is
the centroid of the source geometry.</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_centroid01.png"/>
</imageobject>
<caption><para>Centroid of a
<varname>MULTIPOINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_centroid02.png"/>
</imageobject>
<caption><para>Centroid of a
<varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_centroid03.png"/>
</imageobject>
<caption><para>Centroid of a
<varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_centroid04.png"/>
</imageobject>
<caption><para>Centroid of a
<varname>GEOMETRYCOLLECTION</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>SELECT ST_AsText(ST_Centroid('MULTIPOINT ( -1 0, -1 2, -1 3, -1 4, -1 7, 0 1, 0 3, 1 1, 2 0, 6 0, 7 8, 9 8, 10 6 )'));
st_astext
------------------------------------------
POINT(2.30769230769231 3.30769230769231)
(1 row)
SELECT ST_AsText(ST_centroid(g))
FROM ST_GeomFromText('CIRCULARSTRING(0 2, -1 1,0 0, 0.5 0, 1 0, 2 1, 1 2, 0.5 2, 0 2)') AS g ;
------------------------------------------
POINT(0.5 1)
SELECT ST_AsText(ST_centroid(g))
FROM ST_GeomFromText('COMPOUNDCURVE(CIRCULARSTRING(0 2, -1 1,0 0),(0 0, 0.5 0, 1 0),CIRCULARSTRING( 1 0, 2 1, 1 2),(1 2, 0.5 2, 0 2))' ) AS g;
------------------------------------------
POINT(0.5 1)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_PointOnSurface"/>, <xref linkend="ST_GeometricMedian"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ChaikinSmoothing">
<refnamediv>
<refname>ST_ChaikinSmoothing</refname>
<refpurpose>Returns a smoothed version of a geometry, using the Chaikin algorithm</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ChaikinSmoothing</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer</type> <parameter>nIterations = 1</parameter></paramdef>
<paramdef choice="opt"><type>boolean</type> <parameter>preserveEndPoints = false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Smoothes a linear or polygonal geometry using
<link xlink:href="http://www.idav.ucdavis.edu/education/CAGDNotes/Chaikins-Algorithm/Chaikins-Algorithm.html">Chaikin's algorithm</link>.
The degree of smoothing is controlled by the <varname>nIterations</varname> parameter.
On each iteration, each interior vertex is replaced
by two vertices located at 1/4 of the length of the line segments before and after the vertex.
A reasonable degree of smoothing is provided by 3 iterations; the maximum is limited to 5.
</para>
<para>If <varname>preserveEndPoints</varname> is true, the endpoints of Polygon rings are not smoothed.
The endpoints of LineStrings are always preserved.
</para>
<note><para>The number of vertices doubles with each iteration,
so the result geometry may have many more points than the input.
To reduce the number of points use a simplification function on the result
(see <xref linkend="ST_Simplify"/>, <xref linkend="ST_SimplifyPreserveTopology"/>
and <xref linkend="ST_SimplifyVW"/>).
</para></note>
<para>The result has interpolated values for the Z and M dimensions when present.</para>
<para>&Z_support;</para>
<para role="availability" conformance="2.5.0">Availability: 2.5.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Smoothing a triangle:</para>
<programlisting>
SELECT ST_AsText(ST_ChaikinSmoothing(geom)) smoothed
FROM (SELECT 'POLYGON((0 0, 8 8, 0 16, 0 0))'::geometry geom) AS foo;
smoothed
───────────────────────────────────────────
POLYGON((2 2,6 6,6 10,2 14,0 12,0 4,2 2))
</programlisting>
<para>Smoothing a Polygon using 1, 2 and 3 iterations:</para>
<informaltable>
<tgroup cols="3">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing01.png"/>
</imageobject>
<caption><para>nIterations = 1</para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing02.png"/>
</imageobject>
<caption><para>nIterations = 2</para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing03.png"/>
</imageobject>
<caption><para>nIterations = 3</para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>
SELECT ST_ChaikinSmoothing(
'POLYGON ((20 20, 60 90, 10 150, 100 190, 190 160, 130 120, 190 50, 140 70, 120 10, 90 60, 20 20))',
generate_series(1, 3) );
</programlisting>
<para>Smoothing a LineString using 1, 2 and 3 iterations:</para>
<informaltable>
<tgroup cols="3">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing04.png"/>
</imageobject>
<caption><para>nIterations = 1</para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing05.png"/>
</imageobject>
<caption><para>nIterations = 2</para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_chaikinsmoothing06.png"/>
</imageobject>
<caption><para>nIterations = 3</para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>
SELECT ST_ChaikinSmoothing(
'LINESTRING (10 140, 80 130, 100 190, 190 150, 140 20, 120 120, 50 30, 30 100)',
generate_series(1, 3) );
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Simplify"/>, <xref linkend="ST_SimplifyPreserveTopology"/>, <xref linkend="ST_SimplifyVW"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ConcaveHull">
<refnamediv>
<refname>ST_ConcaveHull</refname>
<refpurpose>Computes a possibly concave geometry that contains all input geometry vertices</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ConcaveHull</function></funcdef>
<paramdef><type>geometry </type> <parameter>param_geom</parameter></paramdef>
<paramdef><type>float </type> <parameter>param_pctconvex</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type> <parameter>param_allow_holes = false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>A concave hull is a (usually) concave geometry which contains the input,
and whose vertices are a subset of the input vertices.
In the general case the concave hull is a Polygon.
The concave hull of two or more collinear points is a two-point LineString.
The concave hull of one or more identical points is a Point.
The polygon will not contain holes unless the optional <varname>param_allow_holes</varname>
argument is specified as true.
</para>
<para>One can think of a concave hull as "shrink-wrapping" a set of points.
This is different to the <link linkend="ST_ConvexHull">convex hull</link>,
which is more like wrapping a rubber band around the points.
A concave hull generally has a smaller area
and represents a more natural boundary for the input points.
</para>
<para>The <varname>param_pctconvex</varname> controls the concaveness of the computed hull.
A value of 1 produces the convex hull.
Values between 1 and 0 produce hulls of increasing concaveness.
A value of 0 produces a hull with maximum concaveness (but still a single polygon).
Choosing a suitable value depends on the nature of the input data,
but often values between 0.3 and 0.1 produce reasonable results.
</para>
<note><para>
Technically, the <varname>param_pctconvex</varname> determines a length as a fraction of the difference between
the longest and shortest edges in the Delaunay Triangulation of the input points.
Edges longer than this length are "eroded" from the triangulation.
The triangles remaining form the concave hull.
</para></note>
<para>For point and linear inputs, the hull will enclose all the points of the inputs.
For polygonal inputs, the hull will enclose all the points of the input <emphasis>and also</emphasis> all the areas covered by the input.
If you want a point-wise hull of a polygonal input, convert it to points first using <xref linkend="ST_Points"/>.</para>
<para>This is not an aggregate function.
To compute the concave hull of a set of geometries use <xref linkend="ST_Collect"/>
(e.g. <code>ST_ConcaveHull( ST_Collect( geom ), 0.80)</code>.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para role="enhanced" conformance="3.3.0">Enhanced: 3.3.0, GEOS native implementation enabled for GEOS 3.11+</para>
</refsection>
<refsection>
<title>Examples</title>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_concavehull01.png"/>
</imageobject>
<caption><para>Concave Hull of a MultiPoint</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText( ST_ConcaveHull(
'MULTIPOINT ((10 72), (53 76), (56 66), (63 58), (71 51), (81 48), (91 46), (101 45), (111 46), (121 47), (131 50), (140 55), (145 64), (144 74), (135 80), (125 83), (115 85), (105 87), (95 89), (85 91), (75 93), (65 95), (55 98), (45 102), (37 107), (29 114), (22 122), (19 132), (18 142), (21 151), (27 160), (35 167), (44 172), (54 175), (64 178), (74 180), (84 181), (94 181), (104 181), (114 181), (124 181), (134 179), (144 177), (153 173), (162 168), (171 162), (177 154), (182 145), (184 135), (139 132), (136 142), (128 149), (119 153), (109 155), (99 155), (89 155), (79 153), (69 150), (61 144), (63 134), (72 128), (82 125), (92 123), (102 121), (112 119), (122 118), (132 116), (142 113), (151 110), (161 106), (170 102), (178 96), (185 88), (189 78), (190 68), (189 58), (185 49), (179 41), (171 34), (162 29), (153 25), (143 23), (133 21), (123 19), (113 19), (102 19), (92 19), (82 19), (72 21), (62 22), (52 25), (43 29), (33 34), (25 41), (19 49), (14 58), (21 73), (31 74), (42 74), (173 134), (161 134), (150 133), (97 104), (52 117), (157 156), (94 171), (112 106), (169 73), (58 165), (149 40), (70 33), (147 157), (48 153), (140 96), (47 129), (173 55), (144 86), (159 67), (150 146), (38 136), (111 170), (124 94), (26 59), (60 41), (71 162), (41 64), (88 110), (122 34), (151 97), (157 56), (39 146), (88 33), (159 45), (47 56), (138 40), (129 165), (33 48), (106 31), (169 147), (37 122), (71 109), (163 89), (37 156), (82 170), (180 72), (29 142), (46 41), (59 155), (124 106), (157 80), (175 82), (56 50), (62 116), (113 95), (144 167))',
0.1 ) );
---st_astext--
POLYGON ((18 142, 21 151, 27 160, 35 167, 44 172, 54 175, 64 178, 74 180, 84 181, 94 181, 104 181, 114 181, 124 181, 134 179, 144 177, 153 173, 162 168, 171 162, 177 154, 182 145, 184 135, 173 134, 161 134, 150 133, 139 132, 136 142, 128 149, 119 153, 109 155, 99 155, 89 155, 79 153, 69 150, 61 144, 63 134, 72 128, 82 125, 92 123, 102 121, 112 119, 122 118, 132 116, 142 113, 151 110, 161 106, 170 102, 178 96, 185 88, 189 78, 190 68, 189 58, 185 49, 179 41, 171 34, 162 29, 153 25, 143 23, 133 21, 123 19, 113 19, 102 19, 92 19, 82 19, 72 21, 62 22, 52 25, 43 29, 33 34, 25 41, 19 49, 14 58, 10 72, 21 73, 31 74, 42 74, 53 76, 56 66, 63 58, 71 51, 81 48, 91 46, 101 45, 111 46, 121 47, 131 50, 140 55, 145 64, 144 74, 135 80, 125 83, 115 85, 105 87, 95 89, 85 91, 75 93, 65 95, 55 98, 45 102, 37 107, 29 114, 22 122, 19 132, 18 142))
</programlisting>
</para>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_concavehull02.png"/>
</imageobject>
<caption><para>Concave Hull of a MultiPoint, allowing holes</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText( ST_ConcaveHull(
'MULTIPOINT ((132 64), (114 64), (99 64), (81 64), (63 64), (57 49), (52 36), (46 20), (37 20), (26 20), (32 36), (39 55), (43 69), (50 84), (57 100), (63 118), (68 133), (74 149), (81 164), (88 180), (101 180), (112 180), (119 164), (126 149), (132 131), (139 113), (143 100), (150 84), (157 69), (163 51), (168 36), (174 20), (163 20), (150 20), (143 36), (139 49), (132 64), (99 151), (92 138), (88 124), (81 109), (74 93), (70 82), (83 82), (99 82), (112 82), (126 82), (121 96), (114 109), (110 122), (103 138), (99 151), (34 27), (43 31), (48 44), (46 58), (52 73), (63 73), (61 84), (72 71), (90 69), (101 76), (123 71), (141 62), (166 27), (150 33), (159 36), (146 44), (154 53), (152 62), (146 73), (134 76), (143 82), (141 91), (130 98), (126 104), (132 113), (128 127), (117 122), (112 133), (119 144), (108 147), (119 153), (110 171), (103 164), (92 171), (86 160), (88 142), (79 140), (72 124), (83 131), (79 118), (68 113), (63 102), (68 93), (35 45))',
0.15, true ) );
---st_astext--
POLYGON ((43 69, 50 84, 57 100, 63 118, 68 133, 74 149, 81 164, 88 180, 101 180, 112 180, 119 164, 126 149, 132 131, 139 113, 143 100, 150 84, 157 69, 163 51, 168 36, 174 20, 163 20, 150 20, 143 36, 139 49, 132 64, 114 64, 99 64, 81 64, 63 64, 57 49, 52 36, 46 20, 37 20, 26 20, 32 36, 35 45, 39 55, 43 69), (88 124, 81 109, 74 93, 83 82, 99 82, 112 82, 121 96, 114 109, 110 122, 103 138, 92 138, 88 124))
</programlisting>
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_concavehull03.png"/>
</imageobject>
<caption><para><varname>polygon_hull</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_concavehull04.png"/>
</imageobject>
<caption><para><varname>points_hull</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Comparing a concave hull of a Polygon to the concave hull of the constituent points.
The hull respects the boundary of the polygon, whereas the points-based hull does not.
</para>
<programlisting>
WITH data(geom) AS (VALUES
('POLYGON ((10 90, 39 85, 61 79, 50 90, 80 80, 95 55, 25 60, 90 45, 70 16, 63 38, 60 10, 50 30, 43 27, 30 10, 20 20, 10 90))'::geometry)
)
SELECT ST_ConcaveHull( geom, 0.1) AS polygon_hull,
ST_ConcaveHull( ST_Points(geom), 0.1) AS points_hull
FROM data;
</programlisting>
<para>Using with ST_Collect to compute the concave hull of a geometry set.</para>
<programlisting>
-- Compute estimate of infected area based on point observations
SELECT disease_type,
ST_ConcaveHull( ST_Collect(obs_pnt), 0.3 ) AS geom
FROM disease_obs
GROUP BY disease_type;
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_ConvexHull"/>, <xref linkend="ST_Collect"/>, <xref linkend="ST_AlphaShape"/>, <xref linkend="ST_OptimalAlphaShape"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ConvexHull">
<refnamediv>
<refname>ST_ConvexHull</refname>
<refpurpose>Computes the convex hull of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ConvexHull</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes the convex hull of a geometry.
The convex hull is the smallest convex
geometry that encloses all geometries in the input.</para>
<para>One can think of the convex hull as the geometry obtained by wrapping an rubber
band around a set of geometries. This is different from a
<link linkend="ST_ConcaveHull">concave hull</link>
which is analogous to "shrink-wrapping" the geometries.
A convex hull is often used to
determine an affected area based on a set of point observations.</para>
<para>In the general case the convex hull is a Polygon.
The convex hull of two or more collinear points is a two-point LineString.
The convex hull of one or more identical points is a Point.</para>
<para>This is not an aggregate function.
To compute the convex hull of a set of geometries, use <xref linkend="ST_Collect"/>
to aggregate them into a geometry collection
(e.g. <code>ST_ConvexHull(ST_Collect(geom))</code>.</para>
<para>Performed by the GEOS module</para>
<para>&sfs_compliant; s2.1.1.3</para>
<para>&sqlmm_compliant; SQL-MM IEC 13249-3: 5.1.16</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_convexhull01.png"/>
</imageobject>
<caption><para>Convex Hull of a MultiLinestring and a MultiPoint</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_ConvexHull(
ST_Collect(
ST_GeomFromText('MULTILINESTRING((100 190,10 8),(150 10, 20 30))'),
ST_GeomFromText('MULTIPOINT(50 5, 150 30, 50 10, 10 10)')
)) );
---st_astext--
POLYGON((50 5,10 8,10 10,100 190,150 30,150 10,50 5))
</programlisting>
</para>
<para>Using with ST_Collect to compute the convex hulls of geometry sets.</para>
<programlisting>
--Get estimate of infected area based on point observations
SELECT d.disease_type,
ST_ConvexHull(ST_Collect(d.geom)) As geom
FROM disease_obs As d
GROUP BY d.disease_type;
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Collect"/>, <xref linkend="ST_ConcaveHull"/>, <xref linkend="ST_MinimumBoundingCircle"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DelaunayTriangles">
<refnamediv>
<refname>ST_DelaunayTriangles</refname>
<refpurpose>
Returns the Delaunay triangulation of the vertices of a geometry.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_DelaunayTriangles</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>float </type> <parameter>tolerance = 0.0</parameter></paramdef>
<paramdef choice="opt"><type>int4 </type> <parameter>flags = 0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Computes the <link xlink:href="http://en.wikipedia.org/wiki/Delaunay_triangulation">Delaunay triangulation</link>
of the vertices of the input geometry.
The optional <varname>tolerance</varname> can be used to snap nearby input vertices together,
which improves robustness in some situations.
The result geometry is bounded by the convex hull of the input vertices.
The result geometry representation is determined by the <varname>flags</varname> code:
</para>
<itemizedlist>
<listitem><para> <code>0</code> - a GEOMETRYCOLLECTION of triangular POLYGONs (default) </para></listitem>
<listitem><para> <code>1</code> - a MULTILINESTRING of the edges of the triangulation </para></listitem>
<listitem><para> <code>2</code> - A TIN of the triangulation </para></listitem>
</itemizedlist>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="2.1.0">Availability: 2.1.0</para>
<para>&Z_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="1">
<tbody>
<row><entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_delaunaytriangles01.png"/>
</imageobject>
<caption><para>Original polygons</para></caption>
</mediaobject>
</informalfigure></para>
<programlisting>
<lineannotation>our original geometry</lineannotation>
ST_Union(ST_GeomFromText('POLYGON((175 150, 20 40,
50 60, 125 100, 175 150))'),
ST_Buffer(ST_GeomFromText('POINT(110 170)'), 20)
)</programlisting></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_delaunaytriangles03.png"/>
</imageobject>
<caption><para>ST_DelaunayTriangles of 2 polygons: delaunay triangle polygons each triangle themed in different color</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
<lineannotation>
geometries overlaid multilinestring triangles
</lineannotation>
SELECT
ST_DelaunayTriangles(
ST_Union(ST_GeomFromText('POLYGON((175 150, 20 40,
50 60, 125 100, 175 150))'),
ST_Buffer(ST_GeomFromText('POINT(110 170)'), 20)
))
As dtriag;
</programlisting>
</para></entry></row>
<row><entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_delaunaytriangles02.png"/>
</imageobject>
<caption><para>-- delaunay triangles as multilinestring</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT
ST_DelaunayTriangles(
ST_Union(ST_GeomFromText('POLYGON((175 150, 20 40,
50 60, 125 100, 175 150))'),
ST_Buffer(ST_GeomFromText('POINT(110 170)'), 20)
),0.001,1)
As dtriag;</programlisting>
</para></entry>
</row>
<row><entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_delaunaytriangles04.png"/>
</imageobject>
<caption><para>-- delaunay triangles of 45 points as 55 triangle polygons</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
<lineannotation>
this produces a table of 42 points that form an L shape
</lineannotation>
SELECT (ST_DumpPoints(ST_GeomFromText(
'MULTIPOINT(14 14,34 14,54 14,74 14,94 14,114 14,134 14,
150 14,154 14,154 6,134 6,114 6,94 6,74 6,54 6,34 6,
14 6,10 6,8 6,7 7,6 8,6 10,6 30,6 50,6 70,6 90,6 110,6 130,
6 150,6 170,6 190,6 194,14 194,14 174,14 154,14 134,14 114,
14 94,14 74,14 54,14 34,14 14)'))).geom
INTO TABLE l_shape;
<lineannotation>
output as individual polygon triangles
</lineannotation>
SELECT ST_AsText((ST_Dump(geom)).geom) As wkt
FROM ( SELECT ST_DelaunayTriangles(ST_Collect(geom)) As geom
FROM l_shape) As foo;
<lineannotation>
wkt
</lineannotation>
POLYGON((6 194,6 190,14 194,6 194))
POLYGON((14 194,6 190,14 174,14 194))
POLYGON((14 194,14 174,154 14,14 194))
POLYGON((154 14,14 174,14 154,154 14))
POLYGON((154 14,14 154,150 14,154 14))
POLYGON((154 14,150 14,154 6,154 14))
</programlisting>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Example using vertices with Z values.</para>
<programlisting>
<lineannotation>
3D multipoint
</lineannotation>
SELECT ST_AsText(ST_DelaunayTriangles(ST_GeomFromText(
'MULTIPOINT Z(14 14 10, 150 14 100,34 6 25, 20 10 150)'))) As wkt;
<lineannotation>
wkt
</lineannotation>
GEOMETRYCOLLECTION Z (POLYGON Z ((14 14 10,20 10 150,34 6 25,14 14 10))
,POLYGON Z ((14 14 10,34 6 25,150 14 100,14 14 10)))</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_VoronoiPolygons"/>,
<xref linkend="ST_TriangulatePolygon"/>,
<xref linkend="ST_ConstrainedDelaunayTriangles"/>,
<xref linkend="ST_VoronoiLines"/>,
<xref linkend="ST_ConvexHull"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_FilterByM">
<refnamediv>
<refname>ST_FilterByM</refname>
<refpurpose>Removes vertices based on their M value</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_FilterByM</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>double precision</type> <parameter>min</parameter></paramdef>
<paramdef><type>double precision</type> <parameter>max = null</parameter></paramdef>
<paramdef><type>boolean</type> <parameter>returnM = false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Filters out vertex points based on their M-value. Returns a geometry with only
vertex points that have a M-value larger or equal to the min value and smaller or equal to
the max value. If max-value argument is left out only min value is considered. If fourth argument is left out the m-value
will not be in the resulting geometry. If resulting geometry have too few vertex points left for its geometry type an empty
geometry will be returned. In a geometry collection
geometries without enough points will just be left out silently.</para>
<para>This function is mainly intended to be used in conjunction with ST_SetEffectiveArea. ST_EffectiveArea sets the effective area
of a vertex in its m-value. With ST_FilterByM it then is possible to get a simplified version of the geometry without any calculations, just by filtering</para>
<note><para>There is a difference in what ST_SimplifyVW returns when not enough points meet the criteria compared to ST_FilterByM.
ST_SimplifyVW returns the geometry with enough points while ST_FilterByM returns an empty geometry</para></note>
<note><para>Note that the returned geometry might be invalid</para></note>
<note><para>This function returns all dimensions, including the Z and M values</para></note>
<para role="availability" conformance="2.5.0">Availability: 2.5.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>A linestring is filtered</para>
<programlisting>
SELECT ST_AsText(ST_FilterByM(geom,30)) simplified
FROM (SELECT ST_SetEffectiveArea('LINESTRING(5 2, 3 8, 6 20, 7 25, 10 10)'::geometry) geom) As foo;
<lineannotation>
result
</lineannotation>
simplified
----------------------------
LINESTRING(5 2,7 25,10 10)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_SetEffectiveArea"/>, <xref linkend="ST_SimplifyVW"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_GeneratePoints">
<refnamediv>
<refname>ST_GeneratePoints</refname>
<refpurpose>Generates a multipoint of random points contained in a Polygon or MultiPolygon.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_GeneratePoints</function></funcdef>
<paramdef><type>geometry</type> <parameter>g</parameter></paramdef>
<paramdef><type>integer</type> <parameter>npoints</parameter></paramdef>
<paramdef choice="opt"><type>integer</type> <parameter>seed = 0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
ST_GeneratePoints generates a multipoint consisting of a given number of pseudo-random points
which lie within the input area.
The optional <varname>seed</varname> is used to regenerate a deterministic sequence of points,
and must be greater than zero.
</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0, added seed parameter</para>
</refsection>
<refsection>
<title>Examples</title>
<para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_generatepoints01.png"/>
</imageobject>
<caption><para>Generated a multipoint consisting of 12 Points overlaid on top of original polygon using a random seed value 1996</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_GeneratePoints(geom, 12, 1996)
FROM (
SELECT ST_Buffer(
ST_GeomFromText(
'LINESTRING(50 50,150 150,150 50)'),
10, 'endcap=round join=round') AS geom
) AS s;</programlisting>
</para>
<para>Given a table of polygons s, return 12 individual points per polygon. Results will be different each time you run.</para>
<programlisting>SELECT s.id, dp.path[1] AS pt_id, dp.geom
FROM s, ST_DumpPoints(ST_GeneratePoints(s.geom,12)) AS dp;</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_DumpPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_GeometricMedian">
<refnamediv>
<refname>
ST_GeometricMedian
</refname>
<refpurpose>
Returns the geometric median of a MultiPoint.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_GeometricMedian</function> </funcdef>
<paramdef> <type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>float8</type> <parameter>tolerance = NULL</parameter></paramdef>
<paramdef choice="opt"><type>int</type> <parameter>max_iter = 10000</parameter></paramdef>
<paramdef choice="opt"><type>boolean</type> <parameter>fail_if_not_converged = false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Computes the approximate geometric median of a MultiPoint geometry
using the Weiszfeld algorithm.
The geometric median is the point minimizing the sum of distances to the input points.
It provides a centrality measure
that is less sensitive to outlier points than the centroid (center of mass).
</para>
<para>
The algorithm iterates until the distance change between
successive iterations is less than the supplied <varname>tolerance</varname>
parameter. If this condition has not been met after <varname>max_iterations</varname>
iterations, the function produces an error and exits,
unless <varname>fail_if_not_converged</varname> is set to <code>false</code> (the default).
</para>
<para>
If a <varname>tolerance</varname> argument is not provided, the tolerance value
is calculated based on the extent of the input geometry.
</para>
<para>
If present, the input point M values are interpreted as their relative weights.
</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
<para role="enhanced" conformance="2.5.0">Enhanced: 2.5.0 Added support for M as weight of points.</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_geometricmedian01.png"/>
</imageobject>
<caption>
<para>
Comparison of the geometric median (red)
and centroid (turquoise) of a MultiPoint.
</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<programlisting>
WITH test AS (
SELECT 'MULTIPOINT((10 10), (10 40), (40 10), (190 190))'::geometry geom)
SELECT
ST_AsText(ST_Centroid(geom)) centroid,
ST_AsText(ST_GeometricMedian(geom)) median
FROM test;
centroid | median
--------------------+----------------------------------------
POINT(62.5 62.5) | POINT(25.01778421249728 25.01778421249728)
(1 row)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Centroid"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_LineMerge">
<refnamediv>
<refname>ST_LineMerge</refname>
<refpurpose>Return the lines formed by sewing together
a MultiLineString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_LineMerge</function></funcdef>
<paramdef><type>geometry </type> <parameter>amultilinestring</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_LineMerge</function></funcdef>
<paramdef><type>geometry </type> <parameter>amultilinestring</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>directed</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a LineString or MultiLineString formed by joining together
the line elements of a MultiLineString.
Lines are joined at their endpoints at 2-way intersections.
Lines are not joined across intersections of 3-way or greater degree.
</para>
<para>If <emphasis role="bold">directed</emphasis> is TRUE, then ST_LineMerge
will not change point order within LineStrings, so lines with opposite directions
will not be merged</para>
<note><para>Only use with MultiLineString/LineStrings. Other geometry types
return an empty GeometryCollection</para></note>
<para>Performed by the GEOS module.</para>
<para role="enhanced" conformance="3.3.0">Enhanced: 3.3.0 accept a directed parameter.</para>
<para role="geos_requirement" conformance="3.11.0">Requires GEOS >= 3.11.0 to use the directed parameter.</para>
<para role="availability" conformance="1.1.0">Availability: 1.1.0</para>
<warning><para>This function strips the M dimension.</para></warning>
</refsection>
<refsection>
<title>Examples</title>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linemerge01.png"/>
</imageobject>
<caption>
<para>Merging lines with different orientation.
</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<programlisting>SELECT ST_AsText(ST_LineMerge(
'MULTILINESTRING((10 160, 60 120), (120 140, 60 120), (120 140, 180 120))'
));
--------------------------------------------
LINESTRING(10 160,60 120,120 140,180 120)
</programlisting>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linemerge02.png"/>
</imageobject>
<caption>
<para>Lines are not merged across intersections with degree > 2.
</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<programlisting>SELECT ST_AsText(ST_LineMerge(
'MULTILINESTRING((10 160, 60 120), (120 140, 60 120), (120 140, 180 120), (100 180, 120 140))'
));
--------------------------------------------
MULTILINESTRING((10 160,60 120,120 140),(100 180,120 140),(120 140,180 120))
</programlisting>
<para>If merging is not possible due to non-touching lines,
the original MultiLineString is returned.</para>
<programlisting>
SELECT ST_AsText(ST_LineMerge(
'MULTILINESTRING((-29 -27,-30 -29.7,-36 -31,-45 -33),(-45.2 -33.2,-46 -32))'
));
----------------
MULTILINESTRING((-45.2 -33.2,-46 -32),(-29 -27,-30 -29.7,-36 -31,-45 -33))
</programlisting>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_linemerge03.png"/>
</imageobject>
<caption>
<para>Lines with opposite directions are not merged if directed = TRUE.</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<programlisting>
SELECT ST_AsText(ST_LineMerge(
'MULTILINESTRING((60 30, 10 70), (120 50, 60 30), (120 50, 180 30))',
TRUE));
-------------------------------------------------------
MULTILINESTRING((120 50,60 30,10 70),(120 50,180 30))
</programlisting>
<para>Example showing Z-dimension handling.</para>
<programlisting>
SELECT ST_AsText(ST_LineMerge(
'MULTILINESTRING((-29 -27 11,-30 -29.7 10,-36 -31 5,-45 -33 6), (-29 -27 12,-30 -29.7 5), (-45 -33 1,-46 -32 11))'
));
--------------------------------------------------------------------------------------------------
LINESTRING Z (-30 -29.7 5,-29 -27 11,-30 -29.7 10,-36 -31 5,-45 -33 1,-46 -32 11)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Segmentize"/>, <xref linkend="ST_LineSubstring"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_MaximumInscribedCircle">
<refnamediv>
<refname>ST_MaximumInscribedCircle</refname>
<refpurpose>Computes the largest circle contained within a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>(geometry, geometry, double precision) <function>ST_MaximumInscribedCircle</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Finds the largest circle that is contained within a (multi)polygon,
or which does not overlap any lines and points.
Returns a record with fields:
</para>
<itemizedlist>
<listitem><para> <varname>center</varname> - center point of the circle </para></listitem>
<listitem><para> <varname>nearest</varname> - a point on the geometry nearest to the center </para></listitem>
<listitem><para> <varname>radius</varname> - radius of the circle </para></listitem>
</itemizedlist>
<para>For polygonal inputs, the circle is inscribed within the boundary rings, using the internal rings as boundaries.
For linear and point inputs, the circle is inscribed within the convex hull of the input,
using the input lines and points as further boundaries.</para>
<para role="availability" conformance="3.1.0">Availability: 3.1.0.</para>
<para role="geos_requirement" conformance="3.9.0">Requires GEOS >= 3.9.0.</para>
</refsection>
<refsection>
<title>Examples</title>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_maximuminscribedcircle01.png"/>
</imageobject>
<caption><para>Maximum inscribed circle of a polygon. Center, nearest point, and radius are returned.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT radius, ST_AsText(center) AS center, ST_AsText(nearest) AS nearest
FROM ST_MaximumInscribedCircle(
'POLYGON ((40 180, 110 160, 180 180, 180 120, 140 90, 160 40, 80 10, 70 40, 20 50, 40 180),
(60 140, 50 90, 90 140, 60 140))');
radius | center | nearest
-----------------+----------------------------+---------------
45.165845650018 | POINT(96.953125 76.328125) | POINT(140 90)
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_maximuminscribedcircle02.png"/>
</imageobject>
<caption><para>Maximum inscribed circle of a multi-linestring. Center, nearest point, and radius are returned.</para></caption>
</mediaobject>
</informalfigure>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_MinimumBoundingRadius"/>, <xref linkend="ST_LargestEmptyCircle"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_LargestEmptyCircle">
<refnamediv>
<refname>ST_LargestEmptyCircle</refname>
<refpurpose>Computes the largest circle not overlapping a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>(geometry, geometry, double precision) <function>ST_LargestEmptyCircle</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>double precision </type> <parameter>tolerance=0.0</parameter></paramdef>
<paramdef choice="opt"><type>geometry </type> <parameter>boundary=POINT EMPTY</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Finds the largest circle which does not overlap a set of point and line obstacles. (Polygonal geometries may be included as obstacles, but only their boundary lines are used.) The center of the circle is constrained to lie inside a polygonal boundary, which by default is the convex hull of the input geometry. The circle center is the point in the interior of the boundary which has the farthest distance from the obstacles. The circle itself is provided by the center point and a nearest point lying on an obstacle determining the circle radius.</para>
<para>The circle center is determined to a given accuracy specified by a distance tolerance, using an iterative algorithm. If the accuracy distance is not specified a reasonable default is used.</para>
<para>Returns a record with fields:</para>
<itemizedlist>
<listitem><para> <varname>center</varname> - center point of the circle </para></listitem>
<listitem><para> <varname>nearest</varname> - a point on the geometry nearest to the center </para></listitem>
<listitem><para> <varname>radius</varname> - radius of the circle </para></listitem>
</itemizedlist>
<para>To find the largest empty circle in the interior of a polygon, see <xref linkend="ST_MaximumInscribedCircle"/>.</para>
<para role="availability" conformance="3.4.0">Availability: 3.4.0.</para>
<para role="geos_requirement" conformance="3.9.0">Requires GEOS >= 3.9.0.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT radius,
center,
nearest
FROM ST_LargestEmptyCircle(
'MULTILINESTRING (
(10 100, 60 180, 130 150, 190 160),
(20 50, 70 70, 90 20, 110 40),
(160 30, 100 100, 180 100))');</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_largestemptycircle01.png"/>
</imageobject>
<caption><para>Largest Empty Circle within a set of lines.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT radius,
center,
nearest
FROM ST_LargestEmptyCircle(
ST_Collect(
'MULTIPOINT ((70 50), (60 130), (130 150), (80 90))'::geometry,
'POLYGON ((90 190, 10 100, 60 10, 190 40, 120 100, 190 180, 90 190))'::geometry),
0,
'POLYGON ((90 190, 10 100, 60 10, 190 40, 120 100, 190 180, 90 190))'::geometry
);</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_largestemptycircle02.png"/>
</imageobject>
<caption><para>Largest Empty Circle within a set of points, constrained to lie in a polygon. The constraint polygon boundary must be included as an obstacle, as well as specified as the constraint for the circle center. </para></caption>
</mediaobject>
</informalfigure>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_MinimumBoundingRadius"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_MinimumBoundingCircle">
<refnamediv>
<refname>ST_MinimumBoundingCircle</refname>
<refpurpose>Returns the smallest circle polygon that contains a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_MinimumBoundingCircle</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>num_segs_per_qt_circ=48</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the smallest circle polygon that contains a geometry. </para>
<note><para>The bounding circle is approximated by a polygon with a default of 48 segments per quarter circle.
Because the polygon is an approximation of the minimum bounding circle, some points in the input geometry may not be contained within the polygon.
The approximation can be improved by increasing the number of segments.
For applications where an approximation is not suitable <xref linkend="ST_MinimumBoundingRadius"/> may be used.</para></note>
<para>Use with <xref linkend="ST_Collect"/> to get the minimum bounding circle of a set of geometries.</para>
<para>To compute two points lying on the minimum circle (the "maximum diameter") use <xref linkend="ST_LongestLine"/>.
</para>
<para>The ratio of the area of a polygon divided by the area of its Minimum Bounding Circle
is referred to as the <emphasis>Reock compactness score</emphasis>.</para>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="1.4.0">Availability: 1.4.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT d.disease_type,
ST_MinimumBoundingCircle(ST_Collect(d.geom)) As geom
FROM disease_obs As d
GROUP BY d.disease_type;
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_minimumboundingcircle01.png"/>
</imageobject>
<caption><para>Minimum bounding circle of a point and linestring. Using 8 segs to approximate a quarter circle</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_MinimumBoundingCircle(
ST_Collect(
ST_GeomFromText('LINESTRING(55 75,125 150)'),
ST_Point(20, 80)), 8
)) As wktmbc;
wktmbc
-----------
POLYGON((135.59714732062 115,134.384753327498 102.690357210921,130.79416296937 90.8537670908995,124.963360620072 79.9451031602111,117.116420743937 70.3835792560632,107.554896839789 62.5366393799277,96.6462329091006 56.70583703063,84.8096427890789 53.115246672502,72.5000000000001 51.9028526793802,60.1903572109213 53.1152466725019,48.3537670908996 56.7058370306299,37.4451031602112 62.5366393799276,27.8835792560632 70.383579256063,20.0366393799278 79.9451031602109,14.20583703063 90.8537670908993,10.615246672502 102.690357210921,9.40285267938019 115,10.6152466725019 127.309642789079,14.2058370306299 139.1462329091,20.0366393799275 150.054896839789,27.883579256063 159.616420743937,
37.4451031602108 167.463360620072,48.3537670908992 173.29416296937,60.190357210921 176.884753327498,
72.4999999999998 178.09714732062,84.8096427890786 176.884753327498,96.6462329091003 173.29416296937,107.554896839789 167.463360620072,
117.116420743937 159.616420743937,124.963360620072 150.054896839789,130.79416296937 139.146232909101,134.384753327498 127.309642789079,135.59714732062 115))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Collect"/>, <xref linkend="ST_MinimumBoundingRadius"/>, <xref linkend="ST_LargestEmptyCircle"/>, <xref linkend="ST_LongestLine"/> </para>
</refsection>
</refentry>
<refentry xml:id="ST_MinimumBoundingRadius">
<refnamediv>
<refname>ST_MinimumBoundingRadius</refname>
<refpurpose>Returns the center point and radius of the smallest circle that contains a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>(geometry, double precision) <function>ST_MinimumBoundingRadius</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes the center point and radius of the smallest circle that contains a geometry.
Returns a record with fields:
</para>
<itemizedlist>
<listitem><para> <varname>center</varname> - center point of the circle </para></listitem>
<listitem><para> <varname>radius</varname> - radius of the circle </para></listitem>
</itemizedlist>
<para>Use with <xref linkend="ST_Collect"/> to get the minimum bounding circle of a set of geometries.</para>
<para>To compute two points lying on the minimum circle (the "maximum diameter") use <xref linkend="ST_LongestLine"/>.
</para>
<para role="availability" conformance="2.3.0">Availability - 2.3.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(center), radius FROM ST_MinimumBoundingRadius('POLYGON((26426 65078,26531 65242,26075 65136,26096 65427,26426 65078))');
st_astext | radius
------------------------------------------+------------------
POINT(26284.8418027133 65267.1145090825) | 247.436045591407
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Collect"/>, <xref linkend="ST_MinimumBoundingCircle"/>, <xref linkend="ST_LongestLine"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_OrientedEnvelope">
<refnamediv>
<refname>ST_OrientedEnvelope</refname>
<refpurpose>Returns a minimum-area rectangle containing a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_OrientedEnvelope</function></funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns the minimum-area rotated rectangle enclosing a geometry.
Note that more than one such rectangle may exist.
May return a Point or LineString in the case of degenerate inputs.
</para>
<para role="availability" conformance="2.5.0">
Availability: 2.5.0.
</para>
<para role="geos_requirement" conformance="3.6.0">Requires GEOS >= 3.6.0.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_OrientedEnvelope('MULTIPOINT ((0 0), (-1 -1), (3 2))'));
st_astext
------------------------------------------------
POLYGON((3 2,2.88 2.16,-1.12 -0.84,-1 -1,3 2))
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_orientedenvelope01.png"/>
</imageobject>
<caption><para>Oriented envelope of a point and linestring.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_OrientedEnvelope(
ST_Collect(
ST_GeomFromText('LINESTRING(55 75,125 150)'),
ST_Point(20, 80))
)) As wktenv;
wktenv
-----------
POLYGON((19.9999999999997 79.9999999999999,33.0769230769229 60.3846153846152,138.076923076924 130.384615384616,125.000000000001 150.000000000001,19.9999999999997 79.9999999999999))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_Envelope"/>
<xref linkend="ST_MinimumBoundingCircle"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_OffsetCurve">
<refnamediv>
<refname>ST_OffsetCurve</refname>
<refpurpose>
Returns an offset line at a given distance and side from an input line.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_OffsetCurve</function></funcdef>
<paramdef><type>geometry </type> <parameter>line</parameter></paramdef>
<paramdef><type>float </type> <parameter>signed_distance</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>style_parameters=''</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Return an offset line at a given distance and side from an input line.
All points of the returned geometries are not further than the given
distance from the input geometry.
Useful for computing parallel lines about a center line.
</para>
<para>
For positive distance the offset is on the left side of the input line
and retains the same direction. For a negative distance it is on the right
side and in the opposite direction.
</para>
<para>
Units of distance are measured in units of the spatial reference system.
</para>
<para>
Note that output may be a MULTILINESTRING or EMPTY for some jigsaw-shaped input geometries.
</para>
<para>
The optional third parameter allows specifying a list of blank-separated
key=value pairs to tweak operations as follows:
<itemizedlist>
<listitem>
<para>'quad_segs=#' : number of segments used to approximate a quarter circle (defaults to 8).</para>
</listitem>
<listitem>
<para>'join=round|mitre|bevel' : join style (defaults to "round"). 'miter' is also accepted as a synonym for 'mitre'.</para>
</listitem>
<listitem>
<para>'mitre_limit=#.#' : mitre ratio limit (only affects mitred join style). 'miter_limit' is also accepted as a synonym for 'mitre_limit'.</para>
</listitem>
</itemizedlist>
</para>
<para>Performed by the GEOS module.</para>
<para role="changed">Behavior changed in GEOS 3.11 so offset curves now have the same direction as the input line, for both positive and negative offsets.</para>
<para role="availability" conformance="2.0">Availability: 2.0</para>
<para role="enhanced" conformance="2.5">Enhanced: 2.5 - added support for GEOMETRYCOLLECTION and MULTILINESTRING</para>
<note><para>This function ignores the Z dimension.
It always gives a 2D result even when used on a 3D geometry.</para></note>
</refsection>
<refsection>
<title>Examples</title>
<para>Compute an open buffer around roads</para>
<programlisting>
SELECT ST_Union(
ST_OffsetCurve(f.geom, f.width/2, 'quad_segs=4 join=round'),
ST_OffsetCurve(f.geom, -f.width/2, 'quad_segs=4 join=round')
) as track
FROM someroadstable;
</programlisting>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve01.png"/>
</imageobject>
<caption><para>15, 'quad_segs=4 join=round' original line
and its offset 15 units.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_OffsetCurve(ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)'),
15, 'quad_segs=4 join=round'));
<lineannotation>
output
</lineannotation>
LINESTRING(164 1,18 1,12.2597485145237 2.1418070123307,
7.39339828220179 5.39339828220179,
5.39339828220179 7.39339828220179,
2.14180701233067 12.2597485145237,1 18,1 195)
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve02.png"/>
</imageobject>
<caption><para>-15, 'quad_segs=4 join=round' original line
and its offset -15 units </para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_OffsetCurve(geom,
-15, 'quad_segs=4 join=round')) As notsocurvy
FROM ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)') As geom;
<lineannotation>
notsocurvy
</lineannotation>
LINESTRING(31 195,31 31,164 31)
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve05.png"/>
</imageobject>
<caption><para>double-offset to get more curvy, note the first reverses direction, so -30 + 15 = -15</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_OffsetCurve(ST_OffsetCurve(geom,
-30, 'quad_segs=4 join=round'), -15, 'quad_segs=4 join=round')) As morecurvy
FROM ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)') As geom;
<lineannotation>
morecurvy
</lineannotation>
LINESTRING(164 31,46 31,40.2597485145236 32.1418070123307,
35.3933982822018 35.3933982822018,
32.1418070123307 40.2597485145237,31 46,31 195)
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve06.png"/>
</imageobject>
<caption><para>double-offset to get more curvy,combined with regular offset 15 to get parallel lines. Overlaid with original.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_AsText(ST_Collect(
ST_OffsetCurve(geom, 15, 'quad_segs=4 join=round'),
ST_OffsetCurve(ST_OffsetCurve(geom,
-30, 'quad_segs=4 join=round'), -15, 'quad_segs=4 join=round')
)
) As parallel_curves
FROM ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)') As geom;
<lineannotation>
parallel curves
</lineannotation>
MULTILINESTRING((164 1,18 1,12.2597485145237 2.1418070123307,
7.39339828220179 5.39339828220179,5.39339828220179 7.39339828220179,
2.14180701233067 12.2597485145237,1 18,1 195),
(164 31,46 31,40.2597485145236 32.1418070123307,35.3933982822018 35.3933982822018,
32.1418070123307 40.2597485145237,31 46,31 195))
</programlisting>
</para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve03.png"/>
</imageobject>
<caption><para>15, 'quad_segs=4 join=bevel' shown with original line</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_OffsetCurve(ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)'),
15, 'quad_segs=4 join=bevel'));
<lineannotation>
output
</lineannotation>
LINESTRING(164 1,18 1,7.39339828220179 5.39339828220179,
5.39339828220179 7.39339828220179,1 18,1 195)
</programlisting>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_offsetcurve04.png"/>
</imageobject>
<caption><para>15,-15 collected, join=mitre mitre_limit=2.1</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_Collect(
ST_OffsetCurve(geom, 15, 'quad_segs=4 join=mitre mitre_limit=2.2'),
ST_OffsetCurve(geom, -15, 'quad_segs=4 join=mitre mitre_limit=2.2')
) )
FROM ST_GeomFromText(
'LINESTRING(164 16,144 16,124 16,104 16,84 16,64 16,
44 16,24 16,20 16,18 16,17 17,
16 18,16 20,16 40,16 60,16 80,16 100,
16 120,16 140,16 160,16 180,16 195)') As geom;
<lineannotation>
output
</lineannotation>
MULTILINESTRING((164 1,11.7867965644036 1,1 11.7867965644036,1 195),
(31 195,31 31,164 31))
</programlisting>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Buffer"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_PointOnSurface">
<refnamediv>
<refname>ST_PointOnSurface</refname>
<refpurpose>Computes a point guaranteed to lie in a polygon, or on a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_PointOnSurface</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a <varname>POINT</varname> which is guaranteed to lie in the interior of a surface
(<varname>POLYGON</varname>, <varname>MULTIPOLYGON</varname>, and <varname>CURVEPOLYGON</varname>).
In PostGIS this function also works on line and point geometries.
</para>
<para>&sfs_compliant; s3.2.14.2 // s3.2.18.2</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.1.5, 9.5.6.
The specifications define ST_PointOnSurface for surface geometries only.
PostGIS extends the function to support all common geometry types.
Other databases (Oracle, DB2, ArcSDE) seem to support this function only for surfaces.
SQL Server 2008 supports all common geometry types.</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_pointonsurface01.png"/>
</imageobject>
<caption><para>Point on surface of a
<varname>MULTIPOINT</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_pointonsurface02.png"/>
</imageobject>
<caption><para>Point on surface of a
<varname>LINESTRING</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_pointonsurface03.png"/>
</imageobject>
<caption><para>Point on surface of a
<varname>POLYGON</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_pointonsurface04.png"/>
</imageobject>
<caption><para>Point on surface of a
<varname>GEOMETRYCOLLECTION</varname></para></caption>
</mediaobject>
</informalfigure></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>SELECT ST_AsText(ST_PointOnSurface('POINT(0 5)'::geometry));
------------
POINT(0 5)
SELECT ST_AsText(ST_PointOnSurface('LINESTRING(0 5, 0 10)'::geometry));
------------
POINT(0 5)
SELECT ST_AsText(ST_PointOnSurface('POLYGON((0 0, 0 5, 5 5, 5 0, 0 0))'::geometry));
----------------
POINT(2.5 2.5)
SELECT ST_AsEWKT(ST_PointOnSurface(ST_GeomFromEWKT('LINESTRING(0 5 1, 0 0 1, 0 10 2)')));
----------------
POINT(0 0 1)
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
The result of ST_PointOnSurface is guaranteed to lie within polygons,
whereas the point computed by <xref linkend="ST_Centroid"/> may be outside.
</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_pointonsurface.png"/>
</imageobject>
<caption><para>Red: point on surface; Green: centroid</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_PointOnSurface(geom)) AS pt_on_surf,
ST_AsText(ST_Centroid(geom)) AS centroid
FROM (SELECT 'POLYGON ((130 120, 120 190, 30 140, 50 20, 190 20,
170 100, 90 60, 90 130, 130 120))'::geometry AS geom) AS t;
pt_on_surf | centroid
-----------------+---------------------------------------------
POINT(62.5 110) | POINT(100.18264840182648 85.11415525114155)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Centroid"/>, <xref linkend="ST_MaximumInscribedCircle"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Polygonize">
<refnamediv>
<refname>ST_Polygonize</refname>
<refpurpose>Computes a collection of polygons formed from the linework of a set of geometries.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Polygonize</function></funcdef>
<paramdef><type>geometry set</type> <parameter>geomfield</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_Polygonize</function></funcdef>
<paramdef><type>geometry[]</type> <parameter>geom_array</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Creates a GeometryCollection containing the
polygons formed by the linework of a set of geometries.
If the input linework does not form any polygons, an empty GeometryCollection is returned.
</para>
<para>This function creates polygons covering all delimited areas.
If the result is intended to form a valid polygonal geometry,
use <xref linkend="ST_BuildArea"/> to prevent holes being filled.
</para>
<note>
<para>
The input linework must be correctly noded for this function to work properly.
To ensure input is noded use <xref linkend="ST_Node"/> on the input geometry
before polygonizing.
</para>
</note>
<note>
<para>GeometryCollections can be difficult to handle with external tools.
Use <xref linkend="ST_Dump"/> to convert the polygonized result
into separate polygons.</para>
</note>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="1.0.0">Availability: 1.0.0RC1</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_polygonize01.png"/>
</imageobject>
<caption><para>Input lines</para></caption>
</mediaobject>
</informalfigure>
</para></entry>
<entry><para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_polygonize02.png"/>
</imageobject>
<caption><para>Polygonized result</para></caption>
</mediaobject>
</informalfigure>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>WITH data(geom) AS (VALUES
('LINESTRING (180 40, 30 20, 20 90)'::geometry)
,('LINESTRING (180 40, 160 160)'::geometry)
,('LINESTRING (80 60, 120 130, 150 80)'::geometry)
,('LINESTRING (80 60, 150 80)'::geometry)
,('LINESTRING (20 90, 70 70, 80 130)'::geometry)
,('LINESTRING (80 130, 160 160)'::geometry)
,('LINESTRING (20 90, 20 160, 70 190)'::geometry)
,('LINESTRING (70 190, 80 130)'::geometry)
,('LINESTRING (70 190, 160 160)'::geometry)
)
SELECT ST_AsText( ST_Polygonize( geom ))
FROM data;
------------------------------------------------------------------------------------------
GEOMETRYCOLLECTION (POLYGON ((180 40, 30 20, 20 90, 70 70, 80 130, 160 160, 180 40), (150 80, 120 130, 80 60, 150 80)),
POLYGON ((20 90, 20 160, 70 190, 80 130, 70 70, 20 90)),
POLYGON ((160 160, 80 130, 70 190, 160 160)),
POLYGON ((80 60, 120 130, 150 80, 80 60)))
</programlisting>
<para>Polygonizing a table of linestrings:</para>
<programlisting>
SELECT ST_AsEWKT(ST_Polygonize(geom_4269)) As geomtextrep
FROM (SELECT geom_4269 FROM ma.suffolk_edges) As foo;
-------------------------------------
SRID=4269;GEOMETRYCOLLECTION(POLYGON((-71.040878 42.285678,-71.040943 42.2856,-71.04096 42.285752,-71.040878 42.285678)),
POLYGON((-71.17166 42.353675,-71.172026 42.354044,-71.17239 42.354358,-71.171794 42.354971,-71.170511 42.354855,
-71.17112 42.354238,-71.17166 42.353675)))
--Use ST_Dump to dump out the polygonize geoms into individual polygons
SELECT ST_AsEWKT((ST_Dump(t.polycoll)).geom) AS geomtextrep
FROM (SELECT ST_Polygonize(geom_4269) AS polycoll
FROM (SELECT geom_4269 FROM ma.suffolk_edges)
As foo) AS t;
------------------------
SRID=4269;POLYGON((-71.040878 42.285678,-71.040943 42.2856,-71.04096 42.285752,
-71.040878 42.285678))
SRID=4269;POLYGON((-71.17166 42.353675,-71.172026 42.354044,-71.17239 42.354358
,-71.171794 42.354971,-71.170511 42.354855,-71.17112 42.354238,-71.17166 42.353675))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_BuildArea"/>,
<xref linkend="ST_Dump"/>,
<xref linkend="ST_Node"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_ReducePrecision">
<refnamediv>
<refname>ST_ReducePrecision</refname>
<refpurpose>Returns a valid geometry with points rounded to a grid tolerance.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ReducePrecision</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g</parameter></paramdef>
<paramdef><type>float8 </type>
<parameter>gridsize</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a valid geometry with all points rounded to the provided grid tolerance, and features below the tolerance removed.</para>
<para>Unlike <xref linkend="ST_SnapToGrid"/> the returned geometry will be valid, with no ring self-intersections or collapsed components.</para>
<para>
Precision reduction can be used to:
<itemizedlist>
<listitem><para>
match coordinate precision to the data accuracy
</para></listitem>
<listitem><para>
reduce the number of coordinates needed to represent a geometry
</para></listitem>
<listitem><para>
ensure valid geometry output to formats which use lower precision
(e.g. text formats such as WKT, GeoJSON or KML
when the number of output decimal places is limited).
</para></listitem>
<listitem><para>
export valid geometry to systems which use lower or limited precision
(e.g. SDE, Oracle tolerance value)
</para></listitem>
</itemizedlist>
</para>
<para role="availability" conformance="3.1.0">Availability: 3.1.0.</para>
<para role="geos_requirement" conformance="3.9.0">Requires GEOS >= 3.9.0.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(ST_ReducePrecision('POINT(1.412 19.323)', 0.1));
st_astext
-----------------
POINT(1.4 19.3)
SELECT ST_AsText(ST_ReducePrecision('POINT(1.412 19.323)', 1.0));
st_astext
-------------
POINT(1 19)
SELECT ST_AsText(ST_ReducePrecision('POINT(1.412 19.323)', 10));
st_astext
-------------
POINT(0 20)
</programlisting>
<para>Precision reduction can reduce number of vertices</para>
<programlisting>SELECT ST_AsText(ST_ReducePrecision('LINESTRING (10 10, 19.6 30.1, 20 30, 20.3 30, 40 40)', 1));
st_astext
-------------
LINESTRING (10 10, 20 30, 40 40)
</programlisting>
<para>Precision reduction splits polygons if needed to ensure validity</para>
<programlisting>SELECT ST_AsText(ST_ReducePrecision('POLYGON ((10 10, 60 60.1, 70 30, 40 40, 50 10, 10 10))', 10));
st_astext
-------------
MULTIPOLYGON (((60 60, 70 30, 40 40, 60 60)), ((40 40, 50 10, 10 10, 40 40)))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_SnapToGrid"/>, <xref linkend="ST_Simplify"/>, <xref linkend="ST_SimplifyVW"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SharedPaths">
<refnamediv>
<refname>ST_SharedPaths</refname>
<refpurpose>Returns a collection containing paths shared by the two input linestrings/multilinestrings.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SharedPaths</function></funcdef>
<paramdef><type>geometry</type> <parameter>lineal1</parameter></paramdef>
<paramdef><type>geometry</type> <parameter>lineal2</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a collection containing paths shared by the two input geometries.
Those going in the same direction are in the first element of the collection, those going in the opposite direction are in the second element.
The paths themselves are given in the direction of the first geometry.
</para>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
</refsection>
<refsection>
<title>Examples: Finding shared paths</title>
<informaltable>
<tgroup cols="1">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_sharedpaths01.png"/>
</imageobject>
<caption><para>A multilinestring and a linestring</para></caption>
</mediaobject>
</informalfigure></para>
</entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_sharedpaths02.png"/>
</imageobject>
<caption><para>The shared path of multilinestring and linestring overlaid with original geometries.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(
ST_SharedPaths(
ST_GeomFromText('MULTILINESTRING((26 125,26 200,126 200,126 125,26 125),
(51 150,101 150,76 175,51 150))'),
ST_GeomFromText('LINESTRING(151 100,126 156.25,126 125,90 161, 76 175)')
)
) As wkt
wkt
-------------------------------------------------------------
GEOMETRYCOLLECTION(MULTILINESTRING((126 156.25,126 125),
(101 150,90 161),(90 161,76 175)),MULTILINESTRING EMPTY)
</programlisting>
</para>
</entry>
</row>
<row>
<entry><para>
<programlisting>
<lineannotation>
same example but linestring orientation flipped
</lineannotation>
SELECT ST_AsText(
ST_SharedPaths(
ST_GeomFromText('LINESTRING(76 175,90 161,126 125,126 156.25,151 100)'),
ST_GeomFromText('MULTILINESTRING((26 125,26 200,126 200,126 125,26 125),
(51 150,101 150,76 175,51 150))')
)
) As wkt
wkt
-------------------------------------------------------------
GEOMETRYCOLLECTION(MULTILINESTRING EMPTY,
MULTILINESTRING((76 175,90 161),(90 161,101 150),(126 125,126 156.25)))
</programlisting>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_Dump"/>,
<xref linkend="ST_GeometryN"/>,
<xref linkend="ST_NumGeometries"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_Simplify">
<refnamediv>
<refname>ST_Simplify</refname>
<refpurpose>Returns a simplified representation of a geometry, using the Douglas-Peucker algorithm.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Simplify</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_Simplify</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
<paramdef><type>boolean</type> <parameter>preserveCollapsed</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a simplified representation of a geometry using the
<link xlink:href="https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm">Douglas-Peucker algorithm</link>.
The simplification <varname>tolerance</varname> is a distance value, in the units of the input SRS.
Simplification removes vertices which are within the tolerance distance of the simplified linework.
The result may not be valid even if the input is.
</para>
<para>
The function can be called with any kind of geometry (including GeometryCollections),
but only line and polygon elements are simplified.
Endpoints of linear geometry are preserved.
</para>
<para>The <varname>preserveCollapsed</varname> flag retains small geometries that would otherwise
be removed at the given tolerance. For example, if a 1m long line is simplified with a 10m
tolerance, when <varname>preserveCollapsed</varname> is true the line will not disappear.
This flag is useful for rendering purposes, to prevent
very small features disappearing from a map.</para>
<note><para>The returned geometry may lose its simplicity (see <xref linkend="ST_IsSimple"/>),
topology may not be preserved, and polygonal results may be invalid (see <xref linkend="ST_IsValid"/>).
Use <xref linkend="ST_SimplifyPreserveTopology"/> to preserve topology and ensure validity.</para></note>
<note><para>This function does not preserve boundaries shared between polygons. Use <xref linkend="ST_CoverageSimplify"/> if this is required.</para></note>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
</refsection>
<refsection>
<title>Examples</title>
<para>A circle simplified too much becomes a triangle, medium an octagon, </para>
<programlisting>SELECT ST_Npoints(geom) AS np_before,
ST_NPoints(ST_Simplify(geom, 0.1)) AS np01_notbadcircle,
ST_NPoints(ST_Simplify(geom, 0.5)) AS np05_notquitecircle,
ST_NPoints(ST_Simplify(geom, 1)) AS np1_octagon,
ST_NPoints(ST_Simplify(geom, 10)) AS np10_triangle,
(ST_Simplify(geom, 100) is null) AS np100_geometrygoesaway
FROM (SELECT ST_Buffer('POINT(1 3)', 10,12) As geom) AS t;
np_before | np01_notbadcircle | np05_notquitecircle | np1_octagon | np10_triangle | np100_geometrygoesaway
-----------+-------------------+---------------------+-------------+---------------+------------------------
49 | 33 | 17 | 9 | 4 | t
</programlisting>
<para>Simplifying a set of lines. Lines may intersect after simplification.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplify01.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_Simplify(
'MULTILINESTRING ((20 180, 20 150, 50 150, 50 100, 110 150, 150 140, 170 120), (20 10, 80 30, 90 120), (90 120, 130 130), (130 130, 130 70, 160 40, 180 60, 180 90, 140 80), (50 40, 70 40, 80 70, 70 60, 60 60, 50 50, 50 40))',
40);
</programlisting>
<para>Simplifying a MultiPolygon. Polygonal results may be invalid.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplify02.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_Simplify(
'MULTIPOLYGON (((90 110, 80 180, 50 160, 10 170, 10 140, 20 110, 90 110)), ((40 80, 100 100, 120 160, 170 180, 190 70, 140 10, 110 40, 60 40, 40 80), (180 70, 170 110, 142.5 128.5, 128.5 77.5, 90 60, 180 70)))',
40);
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_IsSimple"/>,
<xref linkend="ST_SimplifyPreserveTopology"/>,
<xref linkend="ST_SimplifyVW"/>,
<xref linkend="ST_CoverageSimplify"/>,
Topology <xref linkend="TP_ST_Simplify"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SimplifyPreserveTopology">
<refnamediv>
<refname>ST_SimplifyPreserveTopology</refname>
<refpurpose>Returns a simplified and valid representation of a geometry, using
the Douglas-Peucker algorithm.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SimplifyPreserveTopology</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a simplified representation of a geometry using a variant of the
<link xlink:href="https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm">Douglas-Peucker algorithm</link>
which limits simplification to ensure the result has the same topology as the input.
The simplification <varname>tolerance</varname> is a distance value, in the units of the input SRS.
Simplification removes vertices which are within the tolerance distance
of the simplified linework, as long as topology is preserved.
The result will be valid and simple if the input is.
</para>
<para>
The function can be called with any kind of geometry (including GeometryCollections),
but only line and polygon elements are simplified.
For polygonal inputs, the result will have the same number of rings (shells and holes),
and the rings will not cross. Ring endpoints may be simplified.
For linear inputs, the result will have the same number of lines, and lines will not intersect
if they did not do so in the original geometry.
Endpoints of linear geometry are preserved.
</para>
<note><para>This function does not preserve boundaries shared between polygons. Use <xref linkend="ST_CoverageSimplify"/> if this is required.</para></note>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="1.3.3">Availability: 1.3.3</para>
</refsection>
<refsection>
<title>Examples</title>
<para>For the same example as <xref linkend="ST_Simplify"/>, ST_SimplifyPreserveTopology prevents oversimplification. The circle can at most become a square.</para>
<programlisting>
SELECT ST_Npoints(geom) AS np_before,
ST_NPoints(ST_SimplifyPreserveTopology(geom, 0.1)) AS np01_notbadcircle,
ST_NPoints(ST_SimplifyPreserveTopology(geom, 0.5)) AS np05_notquitecircle,
ST_NPoints(ST_SimplifyPreserveTopology(geom, 1)) AS np1_octagon,
ST_NPoints(ST_SimplifyPreserveTopology(geom, 10)) AS np10_square,
ST_NPoints(ST_SimplifyPreserveTopology(geom, 100)) AS np100_stillsquare
FROM (SELECT ST_Buffer('POINT(1 3)', 10,12) AS geom) AS t;
np_before | np01_notbadcircle | np05_notquitecircle | np1_octagon | np10_square | np100_stillsquare
-----------+-------------------+---------------------+-------------+-------------+-------------------
49 | 33 | 17 | 9 | 5 | 5
</programlisting>
<para>Simplifying a set of lines, preserving topology of non-intersecting lines.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifypreservetopology01.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyPreserveTopology(
'MULTILINESTRING ((20 180, 20 150, 50 150, 50 100, 110 150, 150 140, 170 120), (20 10, 80 30, 90 120), (90 120, 130 130), (130 130, 130 70, 160 40, 180 60, 180 90, 140 80), (50 40, 70 40, 80 70, 70 60, 60 60, 50 50, 50 40))',
40);
</programlisting>
<para>Simplifying a MultiPolygon, preserving topology of shells and holes.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifypreservetopology02.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyPreserveTopology(
'MULTIPOLYGON (((90 110, 80 180, 50 160, 10 170, 10 140, 20 110, 90 110)), ((40 80, 100 100, 120 160, 170 180, 190 70, 140 10, 110 40, 60 40, 40 80), (180 70, 170 110, 142.5 128.5, 128.5 77.5, 90 60, 180 70)))',
40);
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Simplify"/>,
<xref linkend="ST_SimplifyVW"/>,
<xref linkend="ST_CoverageSimplify"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SimplifyPolygonHull">
<refnamediv>
<refname>ST_SimplifyPolygonHull</refname>
<refpurpose>Computes a simplifed topology-preserving outer or inner hull of a polygonal geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SimplifyPolygonHull</function></funcdef>
<paramdef><type>geometry </type> <parameter>param_geom</parameter></paramdef>
<paramdef><type>float </type> <parameter>vertex_fraction</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type> <parameter>is_outer = true</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a simplified topology-preserving outer or inner hull of a polygonal geometry.
An outer hull completely covers the input geometry.
An inner hull is completely covered by the input geometry.
The result is a polygonal geometry formed by a subset of the input vertices.
MultiPolygons and holes are handled and produce a result with the same structure as the input.
</para>
<para>The reduction in vertex count is controlled by the <varname>vertex_fraction</varname> parameter,
which is a number in the range 0 to 1.
Lower values produce simpler results, with smaller vertex count and less concaveness.
For both outer and inner hulls a vertex fraction of 1.0 produces the original geometry.
For outer hulls a value of 0.0 produces the convex hull (for a single polygon);
for inner hulls it produces a triangle.</para>
<para>
The simplification process operates by progressively removing concave corners that contain the least amount of area, until the vertex count target is reached.
It prevents edges from crossing, so the result is always a valid polygonal geometry.
</para>
<para>To get better results with geometries that contain relatively long line segments, it might be necessary to "segmentize" the input, as shown below.</para>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="3.3.0">Availability: 3.3.0.</para>
<para role="geos_requirement" conformance="3.11.0">Requires GEOS >= 3.11.0.</para>
</refsection>
<refsection>
<title>Examples</title>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifypolygonhull02.png"/>
</imageobject>
<caption><para>Outer hull of a Polygon</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyPolygonHull(
'POLYGON ((131 158, 136 163, 161 165, 173 156, 179 148, 169 140, 186 144, 190 137, 185 131, 174 128, 174 124, 166 119, 158 121, 158 115, 165 107, 161 97, 166 88, 166 79, 158 57, 145 57, 112 53, 111 47, 93 43, 90 48, 88 40, 80 39, 68 32, 51 33, 40 31, 39 34, 49 38, 34 38, 25 34, 28 39, 36 40, 44 46, 24 41, 17 41, 14 46, 19 50, 33 54, 21 55, 13 52, 11 57, 22 60, 34 59, 41 68, 75 72, 62 77, 56 70, 46 72, 31 69, 46 76, 52 82, 47 84, 56 90, 66 90, 64 94, 56 91, 33 97, 36 100, 23 100, 22 107, 29 106, 31 112, 46 116, 36 118, 28 131, 53 132, 59 127, 62 131, 76 130, 80 135, 89 137, 87 143, 73 145, 80 150, 88 150, 85 157, 99 162, 116 158, 115 165, 123 165, 122 170, 134 164, 131 158))',
0.3);
</programlisting>
</para>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifypolygonhull03.png"/>
</imageobject>
<caption><para>Inner hull of a Polygon</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyPolygonHull(
'POLYGON ((131 158, 136 163, 161 165, 173 156, 179 148, 169 140, 186 144, 190 137, 185 131, 174 128, 174 124, 166 119, 158 121, 158 115, 165 107, 161 97, 166 88, 166 79, 158 57, 145 57, 112 53, 111 47, 93 43, 90 48, 88 40, 80 39, 68 32, 51 33, 40 31, 39 34, 49 38, 34 38, 25 34, 28 39, 36 40, 44 46, 24 41, 17 41, 14 46, 19 50, 33 54, 21 55, 13 52, 11 57, 22 60, 34 59, 41 68, 75 72, 62 77, 56 70, 46 72, 31 69, 46 76, 52 82, 47 84, 56 90, 66 90, 64 94, 56 91, 33 97, 36 100, 23 100, 22 107, 29 106, 31 112, 46 116, 36 118, 28 131, 53 132, 59 127, 62 131, 76 130, 80 135, 89 137, 87 143, 73 145, 80 150, 88 150, 85 157, 99 162, 116 158, 115 165, 123 165, 122 170, 134 164, 131 158))',
0.3, false);
</programlisting>
</para>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifypolygonhull01.png"/>
</imageobject>
<caption><para>Outer hull simplification of a MultiPolygon, with segmentization</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyPolygonHull(
ST_Segmentize(ST_Letters('xt'), 2.0),
0.1);
</programlisting>
</para>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_ConvexHull"/>, <xref linkend="ST_SimplifyVW"/>, <xref linkend="ST_ConcaveHull"/>, <xref linkend="ST_Segmentize"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SimplifyVW">
<refnamediv>
<refname>ST_SimplifyVW</refname>
<refpurpose>Returns a simplified representation of a geometry, using the Visvalingam-Whyatt algorithm</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SimplifyVW</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para> Returns a simplified representation of a geometry using the
<link xlink:href="https://en.wikipedia.org/wiki/Visvalingam%E2%80%93Whyatt_algorithm">Visvalingam-Whyatt algorithm</link>.
The simplification <varname>tolerance</varname> is an area value, in the units of the input SRS.
Simplification removes vertices which form "corners" with area less than the tolerance.
The result may not be valid even if the input is.
</para>
<para>
The function can be called with any kind of geometry (including GeometryCollections),
but only line and polygon elements are simplified.
Endpoints of linear geometry are preserved.
</para>
<note><para>The returned geometry may lose its simplicity (see <xref linkend="ST_IsSimple"/>),
topology may not be preserved, and polygonal results may be invalid (see <xref linkend="ST_IsValid"/>).
Use <xref linkend="ST_SimplifyPreserveTopology"/> to preserve topology and ensure validity.
<xref linkend="ST_CoverageSimplify"/> also preserves topology and validity.
</para></note>
<note><para>This function does not preserve boundaries shared between polygons. Use <xref linkend="ST_CoverageSimplify"/> if this is required.</para></note>
<note><para>This function handles 3D and the third dimension will affect the result.</para></note>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>A LineString is simplified with a minimum-area tolerance of 30.</para>
<programlisting>
SELECT ST_AsText(ST_SimplifyVW(geom,30)) simplified
FROM (SELECT 'LINESTRING(5 2, 3 8, 6 20, 7 25, 10 10)'::geometry AS geom) AS t;
simplified
------------------------------
LINESTRING(5 2,7 25,10 10)
</programlisting>
<para>Simplifying a line.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifyvw01.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyVW(
'LINESTRING (10 10, 50 40, 30 70, 50 60, 70 80, 50 110, 100 100, 90 140, 100 180, 150 170, 170 140, 190 90, 180 40, 110 40, 150 20)',
1600);
</programlisting>
<para>Simplifying a polygon.</para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_simplifyvw02.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_SimplifyVW(
'MULTIPOLYGON (((90 110, 80 180, 50 160, 10 170, 10 140, 20 110, 90 110)), ((40 80, 100 100, 120 160, 170 180, 190 70, 140 10, 110 40, 60 40, 40 80), (180 70, 170 110, 142.5 128.5, 128.5 77.5, 90 60, 180 70)))',
40);
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_SetEffectiveArea"/>,
<xref linkend="ST_Simplify"/>,
<xref linkend="ST_SimplifyPreserveTopology"/>,
<xref linkend="ST_CoverageSimplify"/>,
Topology <xref linkend="TP_ST_Simplify"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SetEffectiveArea">
<refnamediv>
<refname>ST_SetEffectiveArea</refname>
<refpurpose>
Sets the effective area for each vertex, using the Visvalingam-Whyatt algorithm.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SetEffectiveArea</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>float</type> <parameter>threshold = 0</parameter></paramdef>
<paramdef><type>integer</type> <parameter>set_area = 1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Sets the effective area for each vertex, using the Visvalingam-Whyatt algorithm.
The effective area is stored as the M-value of the vertex.
If the optional "threshold" parameter is used, a simplified geometry will be returned, containing only vertices with an effective area
greater than or equal to the threshold value.
</para><para>
This function can be used for server-side simplification when a threshold is specified. Another option is to use a threshold value of zero.
In this case, the full geometry will be returned with effective areas as M-values, which can be used by the client to simplify very quickly.
</para><para>
Will actually do something only with
(multi)lines and (multi)polygons but you can safely call it with
any kind of geometry. Since simplification occurs on a
object-by-object basis you can also feed a GeometryCollection to
this function.
</para>
<note><para>Note that returned geometry might lose its
simplicity (see <xref linkend="ST_IsSimple"/>)</para></note>
<note><para>Note topology may not be preserved and may result in invalid geometries. Use (see <xref linkend="ST_SimplifyPreserveTopology"/>) to preserve topology.</para></note>
<note><para>The output geometry will lose all previous information in the M-values</para></note>
<note><para>This function handles 3D and the third dimension will affect the effective area</para></note>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>
Calculating the effective area of a LineString. Because we use a threshold value of zero, all vertices in the input geometry are returned.
</para>
<programlisting>
select ST_AsText(ST_SetEffectiveArea(geom)) all_pts, ST_AsText(ST_SetEffectiveArea(geom,30) ) thrshld_30
FROM (SELECT 'LINESTRING(5 2, 3 8, 6 20, 7 25, 10 10)'::geometry geom) As foo;
-result
all_pts | thrshld_30
-----------+-------------------+
LINESTRING M (5 2 3.40282346638529e+38,3 8 29,6 20 1.5,7 25 49.5,10 10 3.40282346638529e+38) | LINESTRING M (5 2 3.40282346638529e+38,7 25 49.5,10 10 3.40282346638529e+38)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_SimplifyVW"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_TriangulatePolygon">
<refnamediv>
<refname>ST_TriangulatePolygon</refname>
<refpurpose>Computes the constrained Delaunay triangulation of polygons</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_TriangulatePolygon</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes the constrained Delaunay triangulation of polygons.
Holes and Multipolygons are supported.
</para>
<para>
The "constrained Delaunay triangulation" of a polygon is a set of triangles formed from the vertices of the polygon,
and covering it exactly, with the maximum total interior angle over all possible triangulations.
It provides the "best quality" triangulation of the polygon.</para>
<para role="availability" conformance="3.3.0">Availability: 3.3.0.</para>
<para role="geos_requirement" conformance="3.11.0">Requires GEOS >= 3.11.0.</para>
</refsection>
<refsection>
<title>Example</title>
<para>Triangulation of a square.</para>
<programlisting>
SELECT ST_AsText(
ST_TriangulatePolygon('POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))'));
st_astext
---------------------------------------------------------------------------
GEOMETRYCOLLECTION(POLYGON((0 0,0 1,1 1,0 0)),POLYGON((1 1,1 0,0 0,1 1)))
</programlisting>
</refsection>
<refsection>
<title>Example</title>
<para>Triangulation of the letter P.</para>
<programlisting>SELECT ST_AsText(ST_TriangulatePolygon(
'POLYGON ((26 17, 31 19, 34 21, 37 24, 38 29, 39 43, 39 161, 38 172, 36 176, 34 179, 30 181, 25 183, 10 185, 10 190, 100 190, 121 189, 139 187, 154 182, 167 177, 177 169, 184 161, 189 152, 190 141, 188 128, 186 123, 184 117, 180 113, 176 108, 170 104, 164 101, 151 96, 136 92, 119 89, 100 89, 86 89, 73 89, 73 39, 74 32, 75 27, 77 23, 79 20, 83 18, 89 17, 106 15, 106 10, 10 10, 10 15, 26 17), (152 147, 151 152, 149 157, 146 162, 142 166, 137 169, 132 172, 126 175, 118 177, 109 179, 99 180, 89 180, 80 179, 76 178, 74 176, 73 171, 73 100, 85 99, 91 99, 102 99, 112 100, 121 102, 128 104, 134 107, 139 110, 143 114, 147 118, 149 123, 151 128, 153 141, 152 147))'
));
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_triangulatepolygon01.png"/>
</imageobject>
<caption><para>Polygon Triangulation</para></caption>
</mediaobject>
</informalfigure>
</refsection>
<refsection><title>Same example as ST_Tesselate</title>
<programlisting>SELECT ST_TriangulatePolygon(
'POLYGON (( 10 190, 10 70, 80 70, 80 130, 50 160, 120 160, 120 190, 10 190 ))'::geometry
);</programlisting>
<para>ST_AsText output</para>
<screen>GEOMETRYCOLLECTION(POLYGON((50 160,120 190,120 160,50 160))
,POLYGON((10 70,80 130,80 70,10 70))
,POLYGON((50 160,10 70,10 190,50 160))
,POLYGON((120 190,50 160,10 190,120 190))
,POLYGON((80 130,10 70,50 160,80 130)))</screen>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_tesselate03.png"/>
</imageobject>
<caption><para>Original polygon</para></caption>
</mediaobject>
</informalfigure></para>
</entry>
<entry>
<para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_triangulatepolygon02.png"/>
</imageobject>
<caption><para>Triangulated Polygon</para></caption>
</mediaobject>
</informalfigure></para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_ConstrainedDelaunayTriangles"/>,
<xref linkend="ST_DelaunayTriangles"/>,
<xref linkend="ST_Tesselate"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_VoronoiLines">
<refnamediv>
<refname>ST_VoronoiLines</refname>
<refpurpose>Returns the boundaries of the Voronoi diagram of the vertices of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_VoronoiLines</function></funcdef>
<paramdef>
<type>geometry</type> <parameter>geom</parameter>
</paramdef>
<paramdef choice="opt">
<type>float8</type> <parameter>tolerance = 0.0</parameter>
</paramdef>
<paramdef choice="opt">
<type>geometry</type> <parameter>extend_to = NULL</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Computes a two-dimensional <link xlink:href="https://en.wikipedia.org/wiki/Voronoi_diagram">Voronoi diagram</link> from the vertices of
the supplied geometry and returns the boundaries between cells in the diagram as a MultiLineString.
Returns null if input geometry is null. Returns an empty geometry collection if the input geometry contains only one vertex.
Returns an empty geometry collection if the <varname>extend_to</varname> envelope has zero area.
</para>
<para>
Optional parameters:
<itemizedlist>
<listitem>
<para> <varname>tolerance</varname>: The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0)</para>
</listitem>
<listitem>
<para> <varname>extend_to</varname>: If present, the diagram is extended to cover the envelope of the supplied geometry,
unless smaller than the default envelope (default = NULL, default envelope is the bounding box of the input expanded by about 50%).
</para>
</listitem>
</itemizedlist>
</para>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
</refsection>
<!-- Examples -->
<refsection>
<title>Examples</title>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_voronoi03.png"/>
</imageobject>
<caption><para>Voronoi diagram lines, with tolerance of 30 units</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_VoronoiLines(
'MULTIPOINT (50 30, 60 30, 100 100,10 150, 110 120)'::geometry,
30) AS geom;
</programlisting>
<screen><lineannotation>ST_AsText output</lineannotation>
MULTILINESTRING((135.555555555556 270,36.8181818181818 92.2727272727273),(36.8181818181818 92.2727272727273,-110 43.3333333333333),(230 -45.7142857142858,36.8181818181818 92.2727272727273))
</screen>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_DelaunayTriangles"/>,
<xref linkend="ST_VoronoiPolygons"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_VoronoiPolygons">
<refnamediv>
<refname>ST_VoronoiPolygons</refname>
<refpurpose>Returns the cells of the Voronoi diagram of the vertices of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_VoronoiPolygons</function></funcdef>
<paramdef>
<type>geometry</type> <parameter>geom</parameter>
</paramdef>
<paramdef choice="opt">
<type>float8</type> <parameter>tolerance = 0.0</parameter>
</paramdef>
<paramdef choice="opt">
<type>geometry</type> <parameter>extend_to = NULL</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Computes a two-dimensional <link xlink:href="https://en.wikipedia.org/wiki/Voronoi_diagram">Voronoi diagram</link> from the vertices of
the supplied geometry.
The result is a GEOMETRYCOLLECTION of POLYGONs that covers an envelope larger than the extent of the input vertices.
Returns null if input geometry is null. Returns an empty geometry collection if the input geometry contains only one vertex.
Returns an empty geometry collection if the <varname>extend_to</varname> envelope has zero area.
</para>
<para>
Optional parameters:
<itemizedlist>
<listitem>
<para> <varname>tolerance</varname>: The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0) </para>
</listitem>
<listitem>
<para> <varname>extend_to</varname>: If present, the diagram is extended to cover the envelope of the supplied geometry,
unless smaller than the default envelope (default = NULL, default envelope is the bounding box of the input expanded by about 50%).
</para>
</listitem>
</itemizedlist>
</para>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
</refsection>
<!-- Examples -->
<refsection>
<title>Examples</title>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_voronoi01.png"/>
</imageobject>
<caption><para>Points overlaid on top of Voronoi diagram</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_VoronoiPolygons(
'MULTIPOINT (50 30, 60 30, 100 100,10 150, 110 120)'::geometry
) AS geom;
</programlisting>
<screen><lineannotation>ST_AsText output</lineannotation>
GEOMETRYCOLLECTION(POLYGON((-110 43.3333333333333,-110 270,100.5 270,59.3478260869565 132.826086956522,36.8181818181818 92.2727272727273,-110 43.3333333333333)),
POLYGON((55 -90,-110 -90,-110 43.3333333333333,36.8181818181818 92.2727272727273,55 79.2857142857143,55 -90)),
POLYGON((230 47.5,230 -20.7142857142857,55 79.2857142857143,36.8181818181818 92.2727272727273,59.3478260869565 132.826086956522,230 47.5)),POLYGON((230 -20.7142857142857,230 -90,55 -90,55 79.2857142857143,230 -20.7142857142857)),
POLYGON((100.5 270,230 270,230 47.5,59.3478260869565 132.826086956522,100.5 270)))
</screen>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_voronoi02.png"/>
</imageobject>
<caption><para>Voronoi diagram, with tolerance of 30 units</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_VoronoiPolygons(
'MULTIPOINT (50 30, 60 30, 100 100,10 150, 110 120)'::geometry,
30) AS geom;
</programlisting>
<screen><lineannotation>ST_AsText output</lineannotation>
GEOMETRYCOLLECTION(POLYGON((-110 43.3333333333333,-110 270,100.5 270,59.3478260869565 132.826086956522,36.8181818181818 92.2727272727273,-110 43.3333333333333)),
POLYGON((230 47.5,230 -45.7142857142858,36.8181818181818 92.2727272727273,59.3478260869565 132.826086956522,230 47.5)),POLYGON((230 -45.7142857142858,230 -90,-110 -90,-110 43.3333333333333,36.8181818181818 92.2727272727273,230 -45.7142857142858)),
POLYGON((100.5 270,230 270,230 47.5,59.3478260869565 132.826086956522,100.5 270)))
</screen>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_DelaunayTriangles"/>,
<xref linkend="ST_VoronoiLines"/>
</para>
</refsection>
</refentry>
</section>
|