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
|
<!-- 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_Editors">
<title>Geometry Editors</title><info>
<abstract>
<para>These functions create modified geometries by changing type, structure or vertices.
</para>
</abstract>
</info>
<refentry xml:id="ST_AddPoint">
<refnamediv>
<refname>ST_AddPoint</refname>
<refpurpose>Add a point to a LineString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_AddPoint</function></funcdef>
<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_AddPoint</function></funcdef>
<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
<paramdef><type>integer</type> <parameter>position = -1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Adds a point to a LineString before the index <parameter>position</parameter>
(using a 0-based index).
If the <parameter>position</parameter> parameter is omitted or is -1
the point is appended to the end of the LineString.</para>
<para role="availability" conformance="1.1.0">Availability: 1.1.0</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Add a point to the end of a 3D line</para>
<programlisting>
SELECT ST_AsEWKT(ST_AddPoint('LINESTRING(0 0 1, 1 1 1)', ST_MakePoint(1, 2, 3)));
st_asewkt
----------
LINESTRING(0 0 1,1 1 1,1 2 3)
</programlisting>
<para>Guarantee all lines in a table are closed
by adding the start point of each line to the end of the line
only for those that are not closed.
</para>
<programlisting>
UPDATE sometable
SET geom = ST_AddPoint(geom, ST_StartPoint(geom))
FROM sometable
WHERE ST_IsClosed(geom) = false;
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_RemovePoint"/>, <xref linkend="ST_SetPoint"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_CollectionExtract">
<refnamediv>
<refname>ST_CollectionExtract</refname>
<refpurpose>
Given a geometry collection, returns a multi-geometry containing only elements of a specified type.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_CollectionExtract</function></funcdef>
<paramdef><type>geometry </type> <parameter>collection</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_CollectionExtract</function></funcdef>
<paramdef><type>geometry </type> <parameter>collection</parameter></paramdef>
<paramdef><type>integer </type> <parameter>type</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Given a geometry collection, returns a homogeneous multi-geometry.</para>
<para>If the <parameter>type</parameter> is not specified, returns a multi-geometry containing only geometries of the highest dimension.
So polygons are preferred over lines, which are preferred over points.
</para>
<para>If the <parameter>type</parameter> is specified, returns a multi-geometry containing only that type.
If there are no sub-geometries of the right type, an EMPTY geometry is returned.
Only points, lines and polygons are supported. The type numbers are:</para>
<itemizedlist>
<listitem><para>1 == POINT</para></listitem>
<listitem><para>2 == LINESTRING</para></listitem>
<listitem><para>3 == POLYGON</para></listitem>
</itemizedlist>
<para>For atomic geometry inputs, the geometry is returned unchanged
if the input type matches the requested type.
Otherwise, the result is an EMPTY geometry of the specified type.
If required, these can be converted to multi-geometries using <xref linkend="ST_Multi"/>.
</para>
<warning><para>MultiPolygon results are not checked for validity.
If the polygon components are adjacent or overlapping the result will be invalid.
(For example, this can occur when applying this function to an <xref linkend="ST_Split"/> result.)
This situation can be checked with <xref linkend="ST_IsValid"/> and repaired with <xref linkend="ST_MakeValid"/>.
</para></warning>
<para role="availability" conformance="1.5.0">Availability: 1.5.0</para>
<note><para>
Prior to 1.5.3 this function returned atomic inputs unchanged, no matter type.
In 1.5.3 non-matching single geometries returned a NULL result.
In 2.0.0 non-matching single geometries return an EMPTY result of the requested type.
</para></note>
</refsection>
<refsection>
<title>Examples</title>
<para>Extract highest-dimension type:</para>
<programlisting>
SELECT ST_AsText(ST_CollectionExtract(
'GEOMETRYCOLLECTION( POINT(0 0), LINESTRING(1 1, 2 2) )'));
st_astext
---------------
MULTILINESTRING((1 1, 2 2))
</programlisting>
<para>Extract points (type 1 == POINT):</para>
<programlisting>
SELECT ST_AsText(ST_CollectionExtract(
'GEOMETRYCOLLECTION(GEOMETRYCOLLECTION(POINT(0 0)))',
1 ));
st_astext
---------------
MULTIPOINT((0 0))
</programlisting>
<para>Extract lines (type 2 == LINESTRING):</para>
<programlisting>
SELECT ST_AsText(ST_CollectionExtract(
'GEOMETRYCOLLECTION(GEOMETRYCOLLECTION(LINESTRING(0 0, 1 1)),LINESTRING(2 2, 3 3))',
2 ));
st_astext
---------------
MULTILINESTRING((0 0, 1 1), (2 2, 3 3))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CollectionHomogenize"/>, <xref linkend="ST_Multi"/>,
<xref linkend="ST_IsValid"/>, <xref linkend="ST_MakeValid"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_CollectionHomogenize">
<refnamediv>
<refname>ST_CollectionHomogenize</refname>
<refpurpose>
Returns the simplest representation of a geometry collection.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_CollectionHomogenize</function></funcdef>
<paramdef><type>geometry </type> <parameter>collection</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Given a geometry collection, returns the "simplest" representation of the contents.
</para>
<itemizedlist>
<listitem><para>Homogeneous (uniform) collections are returned as the appropriate multi-geometry.</para></listitem>
<listitem><para>Heterogeneous (mixed) collections are flattened into a single GeometryCollection.</para></listitem>
<listitem><para>Collections containing a single atomic element are returned as that element.</para></listitem>
<listitem><para>Atomic geometries are returned unchanged.
If required, these can be converted to a multi-geometry using <xref linkend="ST_Multi"/>.</para></listitem>
</itemizedlist>
<warning><para>This function does not ensure that the result is valid.
In particular, a collection containing adjacent or overlapping Polygons
will create an invalid MultiPolygon.
This situation can be checked with <xref linkend="ST_IsValid"/> and repaired with <xref linkend="ST_MakeValid"/>.
</para></warning>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Single-element collection converted to an atomic geometry</para>
<programlisting>
SELECT ST_AsText(ST_CollectionHomogenize('GEOMETRYCOLLECTION(POINT(0 0))'));
st_astext
------------
POINT(0 0)
</programlisting>
<para>Nested single-element collection converted to an atomic geometry:</para>
<programlisting>
SELECT ST_AsText(ST_CollectionHomogenize('GEOMETRYCOLLECTION(MULTIPOINT((0 0)))'));
st_astext
------------
POINT(0 0)
</programlisting>
<para>Collection converted to a multi-geometry:</para>
<programlisting>
SELECT ST_AsText(ST_CollectionHomogenize('GEOMETRYCOLLECTION(POINT(0 0),POINT(1 1))'));
st_astext
---------------------
MULTIPOINT((0 0),(1 1))
</programlisting>
<para>Nested heterogeneous collection flattened to a GeometryCollection:</para>
<programlisting>
SELECT ST_AsText(ST_CollectionHomogenize('GEOMETRYCOLLECTION(POINT(0 0), GEOMETRYCOLLECTION( LINESTRING(1 1, 2 2)))'));
st_astext
---------------------
GEOMETRYCOLLECTION(POINT(0 0),LINESTRING(1 1,2 2))
</programlisting>
<para>Collection of Polygons converted to an (invalid) MultiPolygon:</para>
<programlisting>
SELECT ST_AsText(ST_CollectionHomogenize('GEOMETRYCOLLECTION (POLYGON ((10 50, 50 50, 50 10, 10 10, 10 50)), POLYGON ((90 50, 90 10, 50 10, 50 50, 90 50)))'));
st_astext
---------------------
MULTIPOLYGON(((10 50,50 50,50 10,10 10,10 50)),((90 50,90 10,50 10,50 50,90 50)))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CollectionExtract"/>, <xref linkend="ST_Multi"/>,
<xref linkend="ST_IsValid"/>, <xref linkend="ST_MakeValid"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_CurveToLine">
<refnamediv>
<refname>ST_CurveToLine</refname>
<refpurpose>Converts a geometry containing curves to a linear geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_CurveToLine</function></funcdef>
<paramdef><type>geometry</type> <parameter>curveGeom</parameter></paramdef>
<paramdef><type>float</type> <parameter>tolerance</parameter></paramdef>
<paramdef choice="opt"><type>integer</type> <parameter>tolerance_type</parameter></paramdef>
<paramdef choice="opt"><type>integer</type> <parameter>flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Converts a CIRCULAR STRING to regular LINESTRING or CURVEPOLYGON to POLYGON or MULTISURFACE to MULTIPOLYGON. Useful for outputting to devices that can't support CIRCULARSTRING geometry types</para>
<para>Converts a given geometry to a linear geometry.
Each curved geometry or segment is converted into a linear
approximation using the given `tolerance` and options (32 segments per
quadrant and no options by default).</para>
<para>
The 'tolerance_type' argument determines interpretation of the
`tolerance` argument. It can take the following values:
<itemizedlist>
<listitem>
<para>0 (default): Tolerance is max segments per quadrant.</para>
</listitem>
<listitem>
<para>1: Tolerance is max-deviation of line from curve, in source units.</para>
</listitem>
<listitem>
<para>2: Tolerance is max-angle, in radians, between generating radii.</para>
</listitem>
</itemizedlist>
</para>
<para>
The 'flags' argument is a bitfield. 0 by default.
Supported bits are:
<itemizedlist>
<listitem>
<para>1: Symmetric (orientation idependent) output.</para>
</listitem>
<listitem>
<para>2: Retain angle, avoids reducing angles (segment lengths) when producing symmetric output. Has no effect when Symmetric flag is off.</para>
</listitem>
</itemizedlist>
</para>
<para role="availability" conformance="1.3.0">Availability: 1.3.0</para>
<para role="enhanced" conformance="2.4.0">Enhanced: 2.4.0 added support for max-deviation and max-angle tolerance, and for symmetric output.</para>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 implemented a minimum number of segments per linearized arc to prevent topological collapse.</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.1.7</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(ST_CurveToLine(ST_GeomFromText('CIRCULARSTRING(220268 150415,220227 150505,220227 150406)')));
--Result --
LINESTRING(220268 150415,220269.95064912 150416.539364228,220271.823415575 150418.17258804,220273.613787707 150419.895736857,
220275.317452352 150421.704659462,220276.930305234 150423.594998003,220278.448460847 150425.562198489,
220279.868261823 150427.60152176,220281.186287736 150429.708054909,220282.399363347 150431.876723113,
220283.50456625 150434.10230186,220284.499233914 150436.379429536,220285.380970099 150438.702620341,220286.147650624 150441.066277505,
220286.797428488 150443.464706771,220287.328738321 150445.892130112,220287.740300149 150448.342699654,
220288.031122486 150450.810511759,220288.200504713 150453.289621251,220288.248038775 150455.77405574,
220288.173610157 150458.257830005,220287.977398166 150460.734960415,220287.659875492 150463.199479347,
220287.221807076 150465.64544956,220286.664248262 150468.066978495,220285.988542259 150470.458232479,220285.196316903 150472.81345077,
220284.289480732 150475.126959442,220283.270218395 150477.39318505,220282.140985384 150479.606668057,
220280.90450212 150481.762075989,220279.5637474 150483.85421628,220278.12195122 150485.87804878,
220276.582586992 150487.828697901,220274.949363179 150489.701464356,220273.226214362 150491.491836488,
220271.417291757 150493.195501133,220269.526953216 150494.808354014,220267.559752731 150496.326509628,
220265.520429459 150497.746310603,220263.41389631 150499.064336517,220261.245228106 150500.277412127,
220259.019649359 150501.38261503,220256.742521683 150502.377282695,220254.419330878 150503.259018879,
220252.055673714 150504.025699404,220249.657244448 150504.675477269,220247.229821107 150505.206787101,
220244.779251566 150505.61834893,220242.311439461 150505.909171266,220239.832329968 150506.078553494,
220237.347895479 150506.126087555,220234.864121215 150506.051658938,220232.386990804 150505.855446946,
220229.922471872 150505.537924272,220227.47650166 150505.099855856,220225.054972724 150504.542297043,
220222.663718741 150503.86659104,220220.308500449 150503.074365683,
220217.994991777 150502.167529512,220215.72876617 150501.148267175,
220213.515283163 150500.019034164,220211.35987523 150498.7825509,
220209.267734939 150497.441796181,220207.243902439 150496,
220205.293253319 150494.460635772,220203.420486864 150492.82741196,220201.630114732 150491.104263143,
220199.926450087 150489.295340538,220198.313597205 150487.405001997,220196.795441592 150485.437801511,
220195.375640616 150483.39847824,220194.057614703 150481.291945091,220192.844539092 150479.123276887,220191.739336189 150476.89769814,
220190.744668525 150474.620570464,220189.86293234 150472.297379659,220189.096251815 150469.933722495,
220188.446473951 150467.535293229,220187.915164118 150465.107869888,220187.50360229 150462.657300346,
220187.212779953 150460.189488241,220187.043397726 150457.710378749,220186.995863664 150455.22594426,
220187.070292282 150452.742169995,220187.266504273 150450.265039585,220187.584026947 150447.800520653,
220188.022095363 150445.35455044,220188.579654177 150442.933021505,220189.25536018 150440.541767521,
220190.047585536 150438.18654923,220190.954421707 150435.873040558,220191.973684044 150433.60681495,
220193.102917055 150431.393331943,220194.339400319 150429.237924011,220195.680155039 150427.14578372,220197.12195122 150425.12195122,
220198.661315447 150423.171302099,220200.29453926 150421.298535644,220202.017688077 150419.508163512,220203.826610682 150417.804498867,
220205.716949223 150416.191645986,220207.684149708 150414.673490372,220209.72347298 150413.253689397,220211.830006129 150411.935663483,
220213.998674333 150410.722587873,220216.22425308 150409.61738497,220218.501380756 150408.622717305,220220.824571561 150407.740981121,
220223.188228725 150406.974300596,220225.586657991 150406.324522731,220227 150406)
--3d example
SELECT ST_AsEWKT(ST_CurveToLine(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')));
Output
------
LINESTRING(220268 150415 1,220269.95064912 150416.539364228 1.0181172856673,
220271.823415575 150418.17258804 1.03623457133459,220273.613787707 150419.895736857 1.05435185700189,....AD INFINITUM ....
220225.586657991 150406.324522731 1.32611114201132,220227 150406 3)
--use only 2 segments to approximate quarter circle
SELECT ST_AsText(ST_CurveToLine(ST_GeomFromText('CIRCULARSTRING(220268 150415,220227 150505,220227 150406)'),2));
st_astext
------------------------------
LINESTRING(220268 150415,220287.740300149 150448.342699654,220278.12195122 150485.87804878,
220244.779251566 150505.61834893,220207.243902439 150496,220187.50360229 150462.657300346,
220197.12195122 150425.12195122,220227 150406)
-- Ensure approximated line is no further than 20 units away from
-- original curve, and make the result direction-neutral
SELECT ST_AsText(ST_CurveToLine(
'CIRCULARSTRING(0 0,100 -100,200 0)'::geometry,
20, -- Tolerance
1, -- Above is max distance between curve and line
1 -- Symmetric flag
));
st_astext
-------------------------------------------------------------------------------------------
LINESTRING(0 0,50 -86.6025403784438,150 -86.6025403784439,200 -1.1331077795296e-13,200 0)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_LineToCurve"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Scroll">
<refnamediv>
<refname>ST_Scroll</refname>
<refpurpose>Change start point of a closed LineString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Scroll</function></funcdef>
<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Changes the start/end point of a closed LineString to
the given vertex <parameter>point</parameter>.
</para>
<para role="availability" conformance="3.2.0">Availability: 3.2.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Make e closed line start at its 3rd vertex</para>
<programlisting>
SELECT ST_AsEWKT(ST_Scroll('SRID=4326;LINESTRING(0 0 0 1, 10 0 2 0, 5 5 4 2,0 0 0 1)', 'POINT(5 5 4 2)'));
st_asewkt
----------
SRID=4326;LINESTRING(5 5 4 2,0 0 0 1,10 0 2 0,5 5 4 2)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Normalize"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_FlipCoordinates">
<refnamediv>
<refname>ST_FlipCoordinates</refname>
<refpurpose>Returns a version of a geometry with X and Y axis flipped. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_FlipCoordinates</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a version of the given geometry with X and Y axis flipped.
Useful for fixing geometries which contain coordinates expressed as latitude/longitude (Y,X).</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
<para>&M_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Example</title>
<programlisting>
SELECT ST_AsEWKT(ST_FlipCoordinates(GeomFromEWKT('POINT(1 2)')));
st_asewkt
------------
POINT(2 1)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para> <xref linkend="ST_SwapOrdinates"/> </para>
</refsection>
</refentry>
<refentry xml:id="ST_Force2D">
<refnamediv>
<refname>ST_Force2D</refname>
<refpurpose>Force the geometries into a "2-dimensional mode".</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Force2D</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the geometries into a "2-dimensional mode" so that
all output representations will only have the X and Y coordinates.
This is useful for force OGC-compliant output (since OGC only
specifies 2-D geometries).</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_2D.</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsEWKT(ST_Force2D(ST_GeomFromEWKT('CIRCULARSTRING(1 1 2, 2 3 2, 4 5 2, 6 7 2, 5 6 2)')));
st_asewkt
-------------------------------------
CIRCULARSTRING(1 1,2 3,4 5,6 7,5 6)
SELECT ST_AsEWKT(ST_Force2D('POLYGON((0 0 2,0 5 2,5 0 2,0 0 2),(1 1 2,3 1 2,1 3 2,1 1 2))'));
st_asewkt
----------------------------------------------
POLYGON((0 0,0 5,5 0,0 0),(1 1,3 1,1 3,1 1))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Force_3D"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Force_3D">
<refnamediv>
<refname>ST_Force3D</refname>
<refpurpose>Force the geometries into XYZ mode. This is an alias for ST_Force3DZ.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Force3D</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>Zvalue = 0.0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the geometries into XYZ mode. This is an alias for ST_Force3DZ. If a geometry has no Z component, then a <parameter>Zvalue</parameter> Z coordinate is tacked on.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_3D.</para>
<para role="changed" conformance="3.1.0.">Changed: 3.1.0. Added support for supplying a non-zero Z value.</para>
<para>&P_support;</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Nothing happens to an already 3D geometry
SELECT ST_AsEWKT(ST_Force3D(ST_GeomFromEWKT('CIRCULARSTRING(1 1 2, 2 3 2, 4 5 2, 6 7 2, 5 6 2)')));
st_asewkt
-----------------------------------------------
CIRCULARSTRING(1 1 2,2 3 2,4 5 2,6 7 2,5 6 2)
SELECT ST_AsEWKT(ST_Force3D('POLYGON((0 0,0 5,5 0,0 0),(1 1,3 1,1 3,1 1))'));
st_asewkt
--------------------------------------------------------------
POLYGON((0 0 0,0 5 0,5 0 0,0 0 0),(1 1 0,3 1 0,1 3 0,1 1 0))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_Force2D"/>, <xref linkend="ST_Force_3DM"/>, <xref linkend="ST_Force_3DZ"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Force_3DZ">
<refnamediv>
<refname>ST_Force3DZ</refname>
<refpurpose>Force the geometries into XYZ mode.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Force3DZ</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>Zvalue = 0.0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the geometries into XYZ mode. If a geometry has no Z component, then a <parameter>Zvalue</parameter> Z coordinate is tacked on.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_3DZ.</para>
<para role="changed" conformance="3.1.0.">Changed: 3.1.0. Added support for supplying a non-zero Z value.</para>
<para>&P_support;</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Nothing happens to an already 3D geometry
SELECT ST_AsEWKT(ST_Force3DZ(ST_GeomFromEWKT('CIRCULARSTRING(1 1 2, 2 3 2, 4 5 2, 6 7 2, 5 6 2)')));
st_asewkt
-----------------------------------------------
CIRCULARSTRING(1 1 2,2 3 2,4 5 2,6 7 2,5 6 2)
SELECT ST_AsEWKT(ST_Force3DZ('POLYGON((0 0,0 5,5 0,0 0),(1 1,3 1,1 3,1 1))'));
st_asewkt
--------------------------------------------------------------
POLYGON((0 0 0,0 5 0,5 0 0,0 0 0),(1 1 0,3 1 0,1 3 0,1 1 0))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_Force2D"/>, <xref linkend="ST_Force_3DM"/>, <xref linkend="ST_Force_3D"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Force_3DM">
<refnamediv>
<refname>ST_Force3DM</refname>
<refpurpose>Force the geometries into XYM mode.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Force3DM</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>Mvalue = 0.0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the geometries into XYM mode. If a geometry has no M component, then a <parameter>Mvalue</parameter> M coordinate is tacked on. If it has a Z component, then Z is removed</para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_3DM.</para>
<para role="changed" conformance="3.1.0.">Changed: 3.1.0. Added support for supplying a non-zero M value.</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Nothing happens to an already 3D geometry
SELECT ST_AsEWKT(ST_Force3DM(ST_GeomFromEWKT('CIRCULARSTRING(1 1 2, 2 3 2, 4 5 2, 6 7 2, 5 6 2)')));
st_asewkt
------------------------------------------------
CIRCULARSTRINGM(1 1 0,2 3 0,4 5 0,6 7 0,5 6 0)
SELECT ST_AsEWKT(ST_Force3DM('POLYGON((0 0 1,0 5 1,5 0 1,0 0 1),(1 1 1,3 1 1,1 3 1,1 1 1))'));
st_asewkt
---------------------------------------------------------------
POLYGONM((0 0 0,0 5 0,5 0 0,0 0 0),(1 1 0,3 1 0,1 3 0,1 1 0))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_Force2D"/>, <xref linkend="ST_Force_3DM"/>, <xref linkend="ST_Force_3D"/>, <xref linkend="ST_GeomFromEWKT"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Force_4D">
<refnamediv>
<refname>ST_Force4D</refname>
<refpurpose>Force the geometries into XYZM mode. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Force4D</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>Zvalue = 0.0</parameter></paramdef>
<paramdef><type>float </type> <parameter>Mvalue = 0.0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the geometries into XYZM mode. <parameter>Zvalue</parameter> and <parameter>Mvalue</parameter> is tacked on for missing Z and M dimensions, respectively. </para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_4D.</para>
<para role="changed" conformance="3.1.0.">Changed: 3.1.0. Added support for supplying non-zero Z and M values.</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Nothing happens to an already 3D geometry
SELECT ST_AsEWKT(ST_Force4D(ST_GeomFromEWKT('CIRCULARSTRING(1 1 2, 2 3 2, 4 5 2, 6 7 2, 5 6 2)')));
st_asewkt
---------------------------------------------------------
CIRCULARSTRING(1 1 2 0,2 3 2 0,4 5 2 0,6 7 2 0,5 6 2 0)
SELECT ST_AsEWKT(ST_Force4D('MULTILINESTRINGM((0 0 1,0 5 2,5 0 3,0 0 4),(1 1 1,3 1 1,1 3 1,1 1 1))'));
st_asewkt
--------------------------------------------------------------------------------------
MULTILINESTRING((0 0 0 1,0 5 0 2,5 0 0 3,0 0 0 4),(1 1 0 1,3 1 0 1,1 3 0 1,1 1 0 1))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_Force2D"/>, <xref linkend="ST_Force_3DM"/>, <xref linkend="ST_Force_3D"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Force_Collection">
<refnamediv>
<refname>ST_ForceCollection</refname>
<refpurpose>Convert the geometry into a GEOMETRYCOLLECTION.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ForceCollection</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Converts the geometry into a GEOMETRYCOLLECTION. This is
useful for simplifying the WKB representation.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para role="availability" conformance="1.2.2">Availability: 1.2.2, prior to 1.3.4 this function will crash with Curves. This is fixed in 1.3.4+</para>
<para role="changed" conformance="2.1.0.">Changed: 2.1.0. Up to 2.0.x this was called ST_Force_Collection.</para>
<para>&P_support;</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsEWKT(ST_ForceCollection('POLYGON((0 0 1,0 5 1,5 0 1,0 0 1),(1 1 1,3 1 1,1 3 1,1 1 1))'));
st_asewkt
----------------------------------------------------------------------------------
GEOMETRYCOLLECTION(POLYGON((0 0 1,0 5 1,5 0 1,0 0 1),(1 1 1,3 1 1,1 3 1,1 1 1)))
SELECT ST_AsText(ST_ForceCollection('CIRCULARSTRING(220227 150406,2220227 150407,220227 150406)'));
st_astext
--------------------------------------------------------------------------------
GEOMETRYCOLLECTION(CIRCULARSTRING(220227 150406,2220227 150407,220227 150406))
(1 row)
</programlisting>
<programlisting>
-- POLYHEDRAL example --
SELECT ST_AsEWKT(ST_ForceCollection('POLYHEDRALSURFACE(((0 0 0,0 0 1,0 1 1,0 1 0,0 0 0)),
((0 0 0,0 1 0,1 1 0,1 0 0,0 0 0)),
((0 0 0,1 0 0,1 0 1,0 0 1,0 0 0)),
((1 1 0,1 1 1,1 0 1,1 0 0,1 1 0)),
((0 1 0,0 1 1,1 1 1,1 1 0,0 1 0)),
((0 0 1,1 0 1,1 1 1,0 1 1,0 0 1)))'))
st_asewkt
----------------------------------------------------------------------------------
GEOMETRYCOLLECTION(
POLYGON((0 0 0,0 0 1,0 1 1,0 1 0,0 0 0)),
POLYGON((0 0 0,0 1 0,1 1 0,1 0 0,0 0 0)),
POLYGON((0 0 0,1 0 0,1 0 1,0 0 1,0 0 0)),
POLYGON((1 1 0,1 1 1,1 0 1,1 0 0,1 1 0)),
POLYGON((0 1 0,0 1 1,1 1 1,1 1 0,0 1 0)),
POLYGON((0 0 1,1 0 1,1 1 1,0 1 1,0 0 1))
)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_Force2D"/>, <xref linkend="ST_Force_3DM"/>, <xref linkend="ST_Force_3D"/>, <xref linkend="ST_GeomFromEWKT"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ForceCurve">
<refnamediv>
<refname>ST_ForceCurve</refname>
<refpurpose>Upcast a geometry into its curved type, if applicable.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry
<function>ST_ForceCurve</function></funcdef>
<paramdef><type>geometry</type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Turns a geometry into its curved representation, if applicable:
lines become compoundcurves, multilines become multicurves
polygons become curvepolygons multipolygons become multisurfaces. If the geometry input is already a curved representation returns back same as input.
</para>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
<para>&Z_support;</para>
<!-- Optionally mention Circular String Support -->
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(
ST_ForceCurve(
'POLYGON((0 0 2, 5 0 2, 0 5 2, 0 0 2),(1 1 2, 1 3 2, 3 1 2, 1 1 2))'::geometry
)
);
st_astext
----------------------------------------------------------------------
CURVEPOLYGON Z ((0 0 2,5 0 2,0 5 2,0 0 2),(1 1 2,1 3 2,3 1 2,1 1 2))
(1 row)</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_LineToCurve"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ForcePolygonCCW">
<refnamediv>
<refname>
ST_ForcePolygonCCW
</refname>
<refpurpose>
Orients all exterior rings counter-clockwise and all interior rings clockwise.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
geometry
<function>ST_ForcePolygonCCW</function>
</funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Forces (Multi)Polygons to use a counter-clockwise orientation for
their exterior ring, and a clockwise orientation for their interior
rings. Non-polygonal geometries are returned unchanged.
</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ForcePolygonCW"/>,
<xref linkend="ST_IsPolygonCCW"/>,
<xref linkend="ST_IsPolygonCW"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_ForcePolygonCW">
<refnamediv>
<refname>
ST_ForcePolygonCW
</refname>
<refpurpose>
Orients all exterior rings clockwise and all interior rings counter-clockwise.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
geometry
<function>ST_ForcePolygonCW</function>
</funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Forces (Multi)Polygons to use a clockwise orientation for
their exterior ring, and a counter-clockwise orientation for their interior
rings. Non-polygonal geometries are returned unchanged.
</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ForcePolygonCCW"/>,
<xref linkend="ST_IsPolygonCCW"/>,
<xref linkend="ST_IsPolygonCW"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_ForceSFS">
<refnamediv>
<refname>ST_ForceSFS</refname>
<refpurpose>Force the geometries to use SFS 1.1 geometry types only.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ForceSFS</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_ForceSFS</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>text </type> <parameter>version</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>&P_support;</para>
<para>&T_support;</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
</refsection>
</refentry>
<refentry xml:id="ST_ForceRHR">
<refnamediv>
<refname>ST_ForceRHR</refname>
<refpurpose>Force the orientation of the vertices in a polygon to follow the
Right-Hand-Rule.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry
<function>ST_ForceRHR</function></funcdef>
<paramdef><type>geometry</type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Forces the orientation of the vertices in a polygon to follow a
Right-Hand-Rule, in which the area that is bounded by the
polygon is to the right of the boundary. In particular, the exterior ring is
orientated in a clockwise direction and the interior rings in a counter-clockwise
direction. This function is a synonym for <xref linkend="ST_ForcePolygonCW"/></para>
<note>
<para>
The above definition of the Right-Hand-Rule conflicts with definitions used in other contexts. To avoid confusion, it is recommended to use ST_ForcePolygonCW.
</para>
</note>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para>&Z_support;</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsEWKT(
ST_ForceRHR(
'POLYGON((0 0 2, 5 0 2, 0 5 2, 0 0 2),(1 1 2, 1 3 2, 3 1 2, 1 1 2))'
)
);
st_asewkt
--------------------------------------------------------------
POLYGON((0 0 2,0 5 2,5 0 2,0 0 2),(1 1 2,3 1 2,1 3 2,1 1 2))
(1 row)</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ForcePolygonCCW"/>,
<xref linkend="ST_ForcePolygonCW"/>,
<xref linkend="ST_IsPolygonCCW"/>,
<xref linkend="ST_IsPolygonCW"/>,
<xref linkend="ST_BuildArea"/>,
<xref linkend="ST_Polygonize"/>,
<xref linkend="ST_Reverse"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_LineExtend">
<refnamediv>
<refname>ST_LineExtend</refname>
<refpurpose>Returns a line extended forwards and backwards by specified distances.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_LineExtend</function></funcdef>
<paramdef><type>geometry </type>
<parameter>line</parameter></paramdef>
<paramdef><type>float </type>
<parameter>distance_forward</parameter></paramdef>
<paramdef choice="opt"><type>float</type> <parameter>distance_backward=0.0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a line extended forwards and backwards by adding new start (and end) points at the given distance(s).
A distance of zero does not add a point.
Only non-negative distances are allowed.
The direction(s) of the added point(s) is determined by the first (and last) two distinct points of the line.
Duplicate points are ignored.
</para>
<para role="availability" conformance="3.4.0">Availability: 3.4.0</para>
</refsection>
<refsection>
<title>Example: Extends a line 5 units forward and 6 units backward</title>
<programlisting>
SELECT ST_AsText(ST_LineExtend('LINESTRING(0 0, 0 10)'::geometry, 5, 6));
--------------------------------------------
LINESTRING(0 -6,0 0,0 10,0 15)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_LineSubstring"/>, <xref linkend="ST_LocateAlong"/>, <xref linkend="ST_Project"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_LineToCurve">
<refnamediv>
<refname>ST_LineToCurve</refname>
<refpurpose>Converts a linear geometry to a curved geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_LineToCurve</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomANoncircular</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Converts plain LINESTRING/POLYGON to CIRCULAR STRINGs and Curved Polygons. Note much fewer points are needed to describe the curved equivalent.</para>
<note><para>If the input LINESTRING/POLYGON is not curved enough to clearly represent a curve, the function will return the same input geometry.</para></note>
<para role="availability" conformance="1.3.0">Availability: 1.3.0</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting> -- 2D Example
SELECT ST_AsText(ST_LineToCurve(foo.geom)) As curvedastext,ST_AsText(foo.geom) As non_curvedastext
FROM (SELECT ST_Buffer('POINT(1 3)'::geometry, 3) As geom) As foo;
curvedatext non_curvedastext
--------------------------------------------------------------------|-----------------------------------------------------------------
CURVEPOLYGON(CIRCULARSTRING(4 3,3.12132034355964 0.878679656440359, | POLYGON((4 3,3.94235584120969 2.41472903395162,3.77163859753386 1.85194970290473,
1 0,-1.12132034355965 5.12132034355963,4 3)) | 3.49440883690764 1.33328930094119,3.12132034355964 0.878679656440359,
| 2.66671069905881 0.505591163092366,2.14805029709527 0.228361402466141,
| 1.58527096604839 0.0576441587903094,1 0,
| 0.414729033951621 0.0576441587903077,-0.148050297095264 0.228361402466137,
| -0.666710699058802 0.505591163092361,-1.12132034355964 0.878679656440353,
| -1.49440883690763 1.33328930094119,-1.77163859753386 1.85194970290472
| --ETC-- ,3.94235584120969 3.58527096604839,4 3))
--3D example
SELECT ST_AsText(ST_LineToCurve(geom)) As curved, ST_AsText(geom) AS not_curved
FROM (SELECT ST_Translate(ST_Force3D(ST_Boundary(ST_Buffer(ST_Point(1,3), 2,2))),0,0,3) AS geom) AS foo;
curved | not_curved
------------------------------------------------------+---------------------------------------------------------------------
CIRCULARSTRING Z (3 3 3,-1 2.99999999999999 3,3 3 3) | LINESTRING Z (3 3 3,2.4142135623731 1.58578643762691 3,1 1 3,
| -0.414213562373092 1.5857864376269 3,-1 2.99999999999999 3,
| -0.414213562373101 4.41421356237309 3,
| 0.999999999999991 5 3,2.41421356237309 4.4142135623731 3,3 3 3)
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CurveToLine"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Multi">
<refnamediv>
<refname>ST_Multi</refname>
<refpurpose>Return the geometry as a MULTI* geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Multi</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the geometry as a MULTI* geometry collection. If the geometry
is already a collection, it is returned unchanged.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_Multi('POLYGON ((10 30, 30 30, 30 10, 10 10, 10 30))'));
st_astext
-------------------------------------------------
MULTIPOLYGON(((10 30,30 30,30 10,10 10,10 30)))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsText"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Normalize">
<refnamediv>
<refname>ST_Normalize</refname>
<refpurpose>Return the geometry in its canonical form.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Normalize</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns the geometry in its normalized/canonical form.
May reorder vertices in polygon rings, rings in a polygon,
elements in a multi-geometry complex.
</para>
<para>
Mostly only useful for testing purposes (comparing expected
and obtained results).
</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_Normalize(ST_GeomFromText(
'GEOMETRYCOLLECTION(
POINT(2 3),
MULTILINESTRING((0 0, 1 1),(2 2, 3 3)),
POLYGON(
(0 10,0 0,10 0,10 10,0 10),
(4 2,2 2,2 4,4 4,4 2),
(6 8,8 8,8 6,6 6,6 8)
)
)'
)));
st_astext
----------------------------------------------------------------------------------------------------------------------------------------------------
GEOMETRYCOLLECTION(POLYGON((0 0,0 10,10 10,10 0,0 0),(6 6,8 6,8 8,6 8,6 6),(2 2,4 2,4 4,2 4,2 2)),MULTILINESTRING((2 2,3 3),(0 0,1 1)),POINT(2 3))
(1 row)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_Equals"/>,
</para>
</refsection>
</refentry>
<refentry xml:id="ST_Project">
<refnamediv>
<refname>ST_Project</refname>
<refpurpose>Returns a point projected from a start point by a distance and bearing (azimuth).</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Project</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>float </type>
<parameter>distance</parameter></paramdef>
<paramdef><type>float </type>
<parameter>azimuth</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_Project</function></funcdef>
<paramdef><type>geometry </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geometry </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>float </type>
<parameter>distance</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Project</function></funcdef>
<paramdef><type>geography </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>float </type>
<parameter>distance</parameter></paramdef>
<paramdef><type>float </type>
<parameter>azimuth</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Project</function></funcdef>
<paramdef><type>geography </type>
<parameter>g1</parameter></paramdef>
<paramdef><type>geography </type>
<parameter>g2</parameter></paramdef>
<paramdef><type>float </type>
<parameter>distance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a point projected from a point along a geodesic using a given distance and azimuth (bearing). This is known as the direct geodesic problem.</para>
<para>The two-point version uses the path from the first to the second point to implicitly define the azimuth and uses the distance as before.</para>
<para>The distance is given in meters. Negative values are supported.</para>
<para>The azimuth (also known as heading or bearing) is given in radians.
It is measured clockwise from true north.</para>
<itemizedlist>
<listitem><para>North is azimuth zero (0 degrees)</para></listitem>
<listitem><para>East is azimuth π/2 (90 degrees)</para></listitem>
<listitem><para>South is azimuth π (180 degrees)</para></listitem>
<listitem><para>West is azimuth 3π/2 (270 degrees)</para></listitem>
</itemizedlist>
<para>Negative azimuth values and values greater than 2π (360 degrees) are supported.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para role="enhanced" conformance="2.4.0">Enhanced: 2.4.0 Allow negative distance and non-normalized azimuth.</para>
<para role="enhanced" conformance="3.4.0">Enhanced: 3.4.0 Allow geometry arguments and two-point form omitting azimuth.</para>
</refsection>
<refsection>
<title>Example: Projected point at 100,000 meters and bearing 45 degrees </title>
<programlisting>
SELECT ST_AsText(ST_Project('POINT(0 0)'::geography, 100000, radians(45.0)));
--------------------------------------------
POINT(0.635231029125537 0.639472334729198)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Azimuth"/>, <xref linkend="ST_Distance"/>, <link xlink:href="http://www.postgresql.org/docs/current/interactive/functions-math.html">PostgreSQL function radians()</link></para>
</refsection>
</refentry>
<refentry xml:id="ST_QuantizeCoordinates">
<refnamediv>
<refname>
ST_QuantizeCoordinates
</refname>
<refpurpose>
Sets least significant bits of coordinates to zero
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
geometry
<function>ST_QuantizeCoordinates</function>
</funcdef>
<paramdef>
<type>geometry</type>
<parameter>g</parameter>
</paramdef>
<paramdef>
<type>int</type>
<parameter>prec_x</parameter>
</paramdef>
<paramdef>
<type>int</type>
<parameter>prec_y</parameter>
</paramdef>
<paramdef>
<type>int</type>
<parameter>prec_z</parameter>
</paramdef>
<paramdef>
<type>int</type>
<parameter>prec_m</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
<code>ST_QuantizeCoordinates</code> determines the number of bits
(<code>N</code>) required to represent a coordinate value with a
specified number of digits after the decimal point, and then sets
all but the <code>N</code> most significant bits to zero. The
resulting coordinate value will still round to the original value,
but will have improved compressiblity. This can result in a
significant disk usage reduction provided that the geometry column
is using a <link xlink:href="https://www.postgresql.org/docs/current/static/storage-toast.html#STORAGE-TOAST-ONDISK">
compressible storage type</link>. The function allows
specification of a different number of digits after the decimal
point in each dimension; unspecified dimensions are assumed to have
the precision of the <code>x</code> dimension. Negative digits are
interpreted to refer digits to the left of the decimal point, (i.e.,
<code>prec_x=-2</code> will preserve coordinate values to the
nearest 100.
</para>
<para>
The coordinates produced by <code>ST_QuantizeCoordinates</code> are
independent of the geometry that contains those coordinates and the
relative position of those coordinates within the geometry. As a result,
existing topological relationships between geometries are unaffected
by use of this function. The function may produce invalid geometry
when it is called with a number of digits lower than the intrinsic
precision of the geometry.
</para>
<para role="availability" conformance="2.5.0">Availability: 2.5.0</para>
</refsection>
<refsection>
<title>Technical Background</title>
<para>
PostGIS stores all coordinate values as double-precision floating
point integers, which can reliably represent 15 significant digits.
However, PostGIS may be used to manage data that intrinsically has
fewer than 15 significant digits. An example is TIGER data, which is
provided as geographic coordinates with six digits of precision
after the decimal point (thus requiring only nine significant digits
of longitude and eight significant digits of latitude.)
</para>
<para>
When 15 significant digits are available, there are many possible
representations of a number with 9 significant digits. A double
precision floating point number uses 52 explicit bits to represent
the significand (mantissa) of the coordinate. Only 30 bits are needed
to represent a mantissa with 9 significant digits, leaving 22
insignificant bits; we can set their value to anything we like and
still end up with a number that rounds to our input value. For
example, the value 100.123456 can be represented by the floating
point numbers closest to 100.123456000000, 100.123456000001, and
100.123456432199. All are equally valid, in that
<code>ST_AsText(geom, 6)</code> will return the same result with
any of these inputs. As we can set these bits to any value,
<code>ST_QuantizeCoordinates</code> sets the 22 insignificant
bits to zero. For a long coordinate sequence this creates a
pattern of blocks of consecutive zeros that is compressed
by PostgreSQL more efficiently.
</para>
<note>
<para>
Only the on-disk size of the geometry is potentially affected by
<code>ST_QuantizeCoordinates</code>. <xref linkend="ST_MemSize"/>,
which reports the in-memory usage of the geometry, will return the
the same value regardless of the disk space used by a geometry.
</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(ST_QuantizeCoordinates('POINT (100.123456 0)'::geometry, 4));
st_astext
-------------------------
POINT(100.123455047607 0)
</programlisting>
<programlisting>WITH test AS (SELECT 'POINT (123.456789123456 123.456789123456)'::geometry AS geom)
SELECT
digits,
encode(ST_QuantizeCoordinates(geom, digits), 'hex'),
ST_AsText(ST_QuantizeCoordinates(geom, digits))
FROM test, generate_series(15, -15, -1) AS digits;
digits | encode | st_astext
--------+--------------------------------------------+------------------------------------------
15 | 01010000005f9a72083cdd5e405f9a72083cdd5e40 | POINT(123.456789123456 123.456789123456)
14 | 01010000005f9a72083cdd5e405f9a72083cdd5e40 | POINT(123.456789123456 123.456789123456)
13 | 01010000005f9a72083cdd5e405f9a72083cdd5e40 | POINT(123.456789123456 123.456789123456)
12 | 01010000005c9a72083cdd5e405c9a72083cdd5e40 | POINT(123.456789123456 123.456789123456)
11 | 0101000000409a72083cdd5e40409a72083cdd5e40 | POINT(123.456789123456 123.456789123456)
10 | 0101000000009a72083cdd5e40009a72083cdd5e40 | POINT(123.456789123455 123.456789123455)
9 | 0101000000009072083cdd5e40009072083cdd5e40 | POINT(123.456789123418 123.456789123418)
8 | 0101000000008072083cdd5e40008072083cdd5e40 | POINT(123.45678912336 123.45678912336)
7 | 0101000000000070083cdd5e40000070083cdd5e40 | POINT(123.456789121032 123.456789121032)
6 | 0101000000000040083cdd5e40000040083cdd5e40 | POINT(123.456789076328 123.456789076328)
5 | 0101000000000000083cdd5e40000000083cdd5e40 | POINT(123.456789016724 123.456789016724)
4 | 0101000000000000003cdd5e40000000003cdd5e40 | POINT(123.456787109375 123.456787109375)
3 | 0101000000000000003cdd5e40000000003cdd5e40 | POINT(123.456787109375 123.456787109375)
2 | 01010000000000000038dd5e400000000038dd5e40 | POINT(123.45654296875 123.45654296875)
1 | 01010000000000000000dd5e400000000000dd5e40 | POINT(123.453125 123.453125)
0 | 01010000000000000000dc5e400000000000dc5e40 | POINT(123.4375 123.4375)
-1 | 01010000000000000000c05e400000000000c05e40 | POINT(123 123)
-2 | 01010000000000000000005e400000000000005e40 | POINT(120 120)
-3 | 010100000000000000000058400000000000005840 | POINT(96 96)
-4 | 010100000000000000000058400000000000005840 | POINT(96 96)
-5 | 010100000000000000000058400000000000005840 | POINT(96 96)
-6 | 010100000000000000000058400000000000005840 | POINT(96 96)
-7 | 010100000000000000000058400000000000005840 | POINT(96 96)
-8 | 010100000000000000000058400000000000005840 | POINT(96 96)
-9 | 010100000000000000000058400000000000005840 | POINT(96 96)
-10 | 010100000000000000000058400000000000005840 | POINT(96 96)
-11 | 010100000000000000000058400000000000005840 | POINT(96 96)
-12 | 010100000000000000000058400000000000005840 | POINT(96 96)
-13 | 010100000000000000000058400000000000005840 | POINT(96 96)
-14 | 010100000000000000000058400000000000005840 | POINT(96 96)
-15 | 010100000000000000000058400000000000005840 | POINT(96 96)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_SnapToGrid"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_RemovePoint">
<refnamediv>
<refname>ST_RemovePoint</refname>
<refpurpose>Remove a point from a linestring.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_RemovePoint</function></funcdef>
<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
<paramdef><type>integer</type> <parameter>offset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Removes a point from a LineString, given its index (0-based).
Useful for turning a closed line (ring) into an open linestring.
</para>
<para role="enhanced" conformance="3.2.0">Enhanced: 3.2.0</para>
<para role="availability" conformance="1.1.0">Availability: 1.1.0</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Guarantees no lines are closed by removing the end point of closed lines (rings).
Assumes geom is of type LINESTRING</para>
<programlisting>
UPDATE sometable
SET geom = ST_RemovePoint(geom, ST_NPoints(geom) - 1)
FROM sometable
WHERE ST_IsClosed(geom);
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AddPoint"/>, <xref linkend="ST_NPoints"/>, <xref linkend="ST_NumPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_RemoveRepeatedPoints">
<refnamediv>
<refname>ST_RemoveRepeatedPoints</refname>
<refpurpose>Returns a version of a geometry with
duplicate points removed.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_RemoveRepeatedPoints</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>float8</type> <parameter>tolerance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a version of the given geometry with duplicate consecutive points removed.
The function processes only (Multi)LineStrings, (Multi)Polygons and MultiPoints
but it can be called with any kind of geometry.
Elements of GeometryCollections are processed individually.
The endpoints of LineStrings are preserved.
</para>
<para>If the <parameter>tolerance</parameter> parameter is provided, vertices within the tolerance distance
of one another are considered to be duplicates.</para>
<para role="enhanced" conformance="3.2.0">Enhanced: 3.2.0</para>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
<para>&P_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText( ST_RemoveRepeatedPoints( 'MULTIPOINT ((1 1), (2 2), (3 3), (2 2))'));
-------------------------
MULTIPOINT(1 1,2 2,3 3)
</programlisting>
<programlisting>
SELECT ST_AsText( ST_RemoveRepeatedPoints( 'LINESTRING (0 0, 0 0, 1 1, 0 0, 1 1, 2 2)'));
---------------------------------
LINESTRING(0 0,1 1,0 0,1 1,2 2)
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
Collection elements are processed individually.
</para>
<programlisting>
SELECT ST_AsText( ST_RemoveRepeatedPoints( 'GEOMETRYCOLLECTION (LINESTRING (1 1, 2 2, 2 2, 3 3), POINT (4 4), POINT (4 4), POINT (5 5))'));
------------------------------------------------------------------------------
GEOMETRYCOLLECTION(LINESTRING(1 1,2 2,3 3),POINT(4 4),POINT(4 4),POINT(5 5))
</programlisting>
<para><emphasis role="bold">Example:</emphasis>
Repeated point removal with a distance tolerance.
</para>
<programlisting>
SELECT ST_AsText( ST_RemoveRepeatedPoints( 'LINESTRING (0 0, 0 0, 1 1, 5 5, 1 1, 2 2)', 2));
-------------------------
LINESTRING(0 0,5 5,2 2)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Simplify"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_RemoveIrrelevantPointsForView">
<refnamediv>
<refname>ST_RemoveIrrelevantPointsForView</refname>
<refpurpose>Removes points that are irrelevant for rendering a specific rectangluar view of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_RemoveIrrelevantPointsForView</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>box2d </type> <parameter>bounds</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type><parameter>cartesian_hint = false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a <xref linkend="geometry"/> without points being irrelevant for rendering the geometry within a given rectangluar view.</para>
<para>This function can be used to quickly preprocess geometries that should be rendered only within certain bounds.</para>
<para>Only geometries of type (MULTI)POLYGON and (MULTI)LINESTRING are evaluated. Other geometries keep unchanged.</para>
<para>In contrast to <code>ST_ClipByBox2D()</code> this function
<itemizedlist>
<listitem><para>sorts out points without computing new intersection points which avoids rounding errors and usually increases performance,</para></listitem>
<listitem><para>returns a geometry with equal or similar point number,</para></listitem>
<listitem><para>leads to the same rendering result within the specified view, and</para></listitem>
<listitem><para>may introduce self-intersections which would make the resulting geometry invalid (see example below).</para></listitem>
</itemizedlist>
</para>
<para>If <code>cartesian_hint</code> is set to <code>true</code>,
the algorithm applies additional optimizations involving cartesian math
to further reduce the resulting point number.
Please note that using this option might introduce rendering artifacts
if the resulting coordinates are projected into another (non-cartesian)
coordinate system before rendering.
</para>
<warning><para>For polygons, this function does currently not ensure that the result is valid.
This situation can be checked with <xref linkend="ST_IsValid"/> and repaired with <xref linkend="ST_MakeValid"/>.
</para></warning>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_removeirrelevantpointsforview.png"/>
</imageobject>
<caption>
<para>Example: ST_RemoveIrrelevantPointsForView() applied to a polygon. Blue points remain, the rendering result (light-blue area) within the grey view box remains as well.</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_removeirrelevantpointsforview_crossing.png"/>
</imageobject>
<caption>
<para>Example: Due to the fact that points are just sorted out and no new points are computed, the result of ST_RemoveIrrelevantPointsForView() may contain self-intersections.</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<para role="availability" conformance="3.5.0">Availability: 3.5.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(
ST_RemoveIrrelevantPointsForView(
ST_GeomFromText('MULTIPOLYGON(((10 10, 20 10, 30 10, 40 10, 20 20, 10 20, 10 10)),((10 10, 20 10, 20 20, 10 20, 10 10)))'),
ST_MakeEnvelope(12,12,18,18), true));
st_astext
---------
MULTIPOLYGON(((10 10,40 10,20 20,10 20,10 10)),((10 10,20 10,20 20,10 20,10 10)))
</programlisting>
<programlisting>
SELECT ST_AsText(
ST_RemoveIrrelevantPointsForView(
ST_GeomFromText('MULTILINESTRING((0 0, 10 0,20 0,30 0), (0 15, 5 15, 10 15, 15 15, 20 15, 25 15, 30 15, 40 15), (13 13,15 15,17 17))'),
ST_MakeEnvelope(12,12,18,18), true));
st_astext
---------
MULTILINESTRING((10 15,15 15,20 15),(13 13,15 15,17 17))
</programlisting>
<programlisting>
SELECT ST_AsText(
ST_RemoveIrrelevantPointsForView(
ST_GeomFromText('LINESTRING(0 0, 10 0,20 0,30 0)'),
ST_MakeEnvelope(12,12,18,18), true));
st_astext
---------
LINESTRING EMPTY
</programlisting>
<programlisting>
SELECT ST_AsText(
ST_RemoveIrrelevantPointsForView(
ST_GeomFromText('POLYGON((0 30, 15 30, 30 30, 30 0, 0 0, 0 30))'),
ST_MakeEnvelope(12,12,18,18), true));
st_astext
---------
POLYGON((15 30,30 0,0 0,15 30))
</programlisting>
<programlisting>
SELECT ST_AsText(
ST_RemoveIrrelevantPointsForView(
ST_GeomFromText('POLYGON((0 30, 15 30, 30 30, 30 0, 0 0, 0 30))'),
ST_MakeEnvelope(12,12,18,18)));
st_astext
---------
POLYGON((0 30,30 30,30 0,0 0,0 30))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_ClipByBox2D"/>, <xref linkend="ST_Intersection"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_RemoveSmallParts">
<refnamediv>
<refname>ST_RemoveSmallParts</refname>
<refpurpose>Removes small parts (polygon rings or linestrings) of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_RemoveSmallParts</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>double precision </type> <parameter>minSizeX</parameter></paramdef>
<paramdef><type>double precision </type> <parameter>minSizeY</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a <xref linkend="geometry"/> without small parts (exterior or interior polygon rings, or linestrings).</para>
<para>This function can be used as preprocessing step for creating simplified maps, e. g. to remove small islands or holes.</para>
<para>It evaluates only geometries of type (MULTI)POLYGON and (MULTI)LINESTRING. Other geometries remain unchanged.</para>
<para>If <parameter>minSizeX</parameter> is greater than 0, parts are sorted out if their width is smaller than <parameter>minSizeX</parameter>.</para>
<para>If <parameter>minSizeY</parameter> is greater than 0, parts are sorted out if their height is smaller than <parameter>minSizeY</parameter>.</para>
<para>Both <parameter>minSizeX</parameter> and <parameter>minSizeY</parameter> are measured in coordinate system units of the geometry.</para>
<para>For polygon types, evaluation is done separately for each ring which can lead to one of the following results:
<itemizedlist>
<listitem><para>the original geometry,</para></listitem>
<listitem><para>a POLYGON with all rings with less vertices,</para></listitem>
<listitem><para>a POLYGON with a reduced number of interior rings (having possibly less vertices),</para></listitem>
<listitem><para>a POLYGON EMPTY, or</para></listitem>
<listitem><para>a MULTIPOLYGON with a reduced number of polygons (having possibly less interior rings or vertices), or</para></listitem>
<listitem><para>a MULTIPOLYGON EMPTY.</para></listitem>
</itemizedlist>
</para>
<para>For linestring types, evaluation is done for each linestring which can lead to one of the following results:
<itemizedlist>
<listitem><para>the original geometry,</para></listitem>
<listitem><para>a LINESTRING with a reduced number of vertices,</para></listitem>
<listitem><para>a LINESTRING EMPTY,</para></listitem>
<listitem><para>a MULTILINESTRING with a reduced number of linestrings (having possibly less vertices), or</para></listitem>
<listitem><para>a MULTILINESTRING EMPTY.</para></listitem>
</itemizedlist>
</para>
<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_removesmallparts.png"/>
</imageobject>
<caption>
<para>Example: ST_RemoveSmallParts() applied to a multi-polygon. Blue parts remain.</para>
</caption>
</mediaobject>
</informalfigure>
</para>
<para role="availability" conformance="3.5.0">Availability: 3.5.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(
ST_RemoveSmallParts(
ST_GeomFromText('MULTIPOLYGON(
((60 160, 120 160, 120 220, 60 220, 60 160), (70 170, 70 210, 110 210, 110 170, 70 170)),
((85 75, 155 75, 155 145, 85 145, 85 75)),
((50 110, 70 110, 70 130, 50 130, 50 110)))'),
50, 50));
st_astext
---------
MULTIPOLYGON(((60 160,120 160,120 220,60 220,60 160)),((85 75,155 75,155 145,85 145,85 75)))
</programlisting>
<programlisting>
SELECT ST_AsText(
ST_RemoveSmallParts(
ST_GeomFromText('LINESTRING(10 10, 20 20)'),
50, 50));
st_astext
---------
LINESTRING EMPTY
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_Reverse">
<refnamediv>
<refname>ST_Reverse</refname>
<refpurpose>Return the geometry with vertex order reversed.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Reverse</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Can be used on any geometry and reverses the order of the vertices.</para>
<para role="enhanced" conformance="2.4.0">Enhanced: 2.4.0 support for curves was introduced.</para>
<para>&Z_support;</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(geom) as line, ST_AsText(ST_Reverse(geom)) As reverseline
FROM
(SELECT ST_MakeLine(ST_Point(1,2),
ST_Point(1,10)) As geom) as foo;
--result
line | reverseline
---------------------+----------------------
LINESTRING(1 2,1 10) | LINESTRING(1 10,1 2)
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_Segmentize">
<refnamediv>
<refname>ST_Segmentize</refname>
<refpurpose>Returns a modified geometry/geography having no segment longer than a
given distance.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Segmentize</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>float </type> <parameter>max_segment_length</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geography <function>ST_Segmentize</function></funcdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef><type>float </type> <parameter>max_segment_length</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a modified geometry/geography having no segment longer than
<varname>max_segment_length</varname>.
Length is computed in 2D.
Segments are always split into equal-length subsegments.
</para>
<itemizedlist>
<listitem><para>For geometry, the maximum length is in the units of the spatial reference system.
</para></listitem>
<listitem><para>For geography, the maximum length is in meters.
Distances are computed on the sphere.
Added vertices are created along the spherical great-circle arcs
defined by segment endpoints.
</para></listitem>
</itemizedlist>
<note><para>This only shortens long segments.
It does not lengthen segments shorter than the maximum length.
</para></note>
<warning><para>For inputs containing long segments,
specifying a relatively short <varname>max_segment_length</varname>
can cause a very large number of vertices to be added.
This can happen unintentionally if the argument is specified accidentally as a number of segments,
rather than a maximum length.
</para></warning>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
<para role="enhanced" conformance="3.0.0">Enhanced: 3.0.0 Segmentize geometry now produces equal-length subsegments</para>
<para role="enhanced" conformance="2.3.0">Enhanced: 2.3.0 Segmentize geography now produces equal-length subsegments</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 support for geography was introduced.</para>
<para role="changed" conformance="2.1.0">Changed: 2.1.0 As a result of the introduction of geography support,
the usage <code>ST_Segmentize('LINESTRING(1 2, 3 4)', 0.5)</code> causes an ambiguous function error.
The input needs to be properly typed as a geometry or geography.
Use ST_GeomFromText, ST_GeogFromText or a cast to the required type
(e.g. <code>ST_Segmentize('LINESTRING(1 2, 3 4)'::geometry, 0.5) )</code></para>
</refsection>
<refsection>
<title>Examples</title>
<para>Segmentizing a line. Long segments are split evenly, and short segments are not split.</para>
<programlisting>SELECT ST_AsText(ST_Segmentize(
'MULTILINESTRING((0 0, 0 1, 0 9),(1 10, 1 18))'::geometry,
5 ) );
---------------------------------------------------
MULTILINESTRING((0 0,0 1,0 5,0 9),(1 10,1 14,1 18))
</programlisting>
<para>Segmentizing a polygon:</para>
<programlisting>
SELECT ST_AsText(
ST_Segmentize(('POLYGON((0 0, 0 8, 30 0, 0 0))'::geometry), 10));
-------------------------------------------------------
POLYGON((0 0,0 8,7.5 6,15 4,22.5 2,30 0,20 0,10 0,0 0))
</programlisting>
<para>Segmentizing a geographic line, using a maximum segment length of 2000 kilometers.
Vertices are added along the great-circle arc connecting the endpoints.
</para>
<programlisting>
SELECT ST_AsText(
ST_Segmentize(('LINESTRING (0 0, 60 60)'::geography), 2000000));
-------------------------------------------------------------
LINESTRING(0 0,4.252632294621186 8.43596525986862,8.69579947419404 16.824093489701564,13.550465473227048 25.107950473646188,19.1066053508691 33.21091076089908,25.779290201459894 41.01711439406505,34.188839517966954 48.337222885886,45.238153936612264 54.84733442373889,60 60)
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_segmentize01.png"/>
</imageobject>
<caption><para>A geographic line segmentized along a great circle arc</para></caption>
</mediaobject>
</informalfigure>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_LineSubstring"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SetPoint">
<refnamediv>
<refname>ST_SetPoint</refname>
<refpurpose>Replace point of a linestring with a given point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SetPoint</function></funcdef>
<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
<paramdef><type>integer</type> <parameter>zerobasedposition</parameter></paramdef>
<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Replace point N of linestring with given point. Index is
0-based.Negative index are counted backwards, so that -1 is last point.
This is especially useful in triggers when trying to maintain relationship of joints when one vertex moves.</para>
<para role="availability" conformance="1.1.0">Availability: 1.1.0</para>
<para>Updated 2.3.0 : negative indexing</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Change first point in line string from -1 3 to -1 1
SELECT ST_AsText(ST_SetPoint('LINESTRING(-1 2,-1 3)', 0, 'POINT(-1 1)'));
st_astext
-----------------------
LINESTRING(-1 1,-1 3)
---Change last point in a line string (lets play with 3d linestring this time)
SELECT ST_AsEWKT(ST_SetPoint(foo.geom, ST_NumPoints(foo.geom) - 1, ST_GeomFromEWKT('POINT(-1 1 3)')))
FROM (SELECT ST_GeomFromEWKT('LINESTRING(-1 2 3,-1 3 4, 5 6 7)') As geom) As foo;
st_asewkt
-----------------------
LINESTRING(-1 2 3,-1 3 4,-1 1 3)
SELECT ST_AsText(ST_SetPoint(g, -3, p))
FROM ST_GEomFromText('LINESTRING(0 0, 1 1, 2 2, 3 3, 4 4)') AS g
, ST_PointN(g,1) as p;
st_astext
-----------------------
LINESTRING(0 0,1 1,0 0,3 3,4 4)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AddPoint"/>, <xref linkend="ST_NPoints"/>, <xref linkend="ST_NumPoints"/>, <xref linkend="ST_PointN"/>, <xref linkend="ST_RemovePoint"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ShiftLongitude">
<refnamediv>
<refname>ST_ShiftLongitude</refname>
<refpurpose>Shifts the longitude coordinates of a geometry between -180..180 and 0..360.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ShiftLongitude</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Reads every point/vertex in a geometry, and shifts its longitude coordinate from -180..0 to 180..360 and vice versa if between these ranges.
This function is symmetrical so the result is a 0..360 representation of a -180..180 data and a -180..180 representation of a 0..360 data.
</para>
<note><para>This is only useful for data with coordinates in
longitude/latitude; e.g. SRID 4326 (WGS 84 geographic)</para></note>
<warning>
<para>Pre-1.3.4 bug prevented this from working for MULTIPOINT. 1.3.4+ works with MULTIPOINT as well.</para>
</warning>
<para>&Z_support;</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces and TIN was introduced.</para>
<para>NOTE: this function was renamed from "ST_Shift_Longitude" in 2.2.0</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>--single point forward transformation
SELECT ST_AsText(ST_ShiftLongitude('SRID=4326;POINT(270 0)'::geometry))
st_astext
----------
POINT(-90 0)
--single point reverse transformation
SELECT ST_AsText(ST_ShiftLongitude('SRID=4326;POINT(-90 0)'::geometry))
st_astext
----------
POINT(270 0)
--for linestrings the functions affects only to the sufficient coordinates
SELECT ST_AsText(ST_ShiftLongitude('SRID=4326;LINESTRING(174 12, 182 13)'::geometry))
st_astext
----------
LINESTRING(174 12,-178 13)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_WrapX"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_WrapX">
<refnamediv>
<refname>ST_WrapX</refname>
<refpurpose>Wrap a geometry around an X value.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_WrapX</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>float8 </type> <parameter>wrap</parameter></paramdef>
<paramdef><type>float8 </type> <parameter>move</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This function splits the input geometries and then moves every resulting
component falling on the right (for negative 'move') or on the left (for
positive 'move') of given 'wrap' line in the direction specified by the
'move' parameter, finally re-unioning the pieces together.
</para>
<note><para>
This is useful to "recenter" long-lat input to have features
of interest not spawned from one side to the other.
</para></note>
<para role="availability" conformance="2.3.0">Availability: 2.3.0 requires GEOS</para>
<para>&Z_support;</para>
<!-- TODO: check these
<para>&P_support;</para>
<para>&T_support;</para>
-->
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- Move all components of the given geometries whose bounding box
-- falls completely on the left of x=0 to +360
select ST_WrapX(geom, 0, 360);
-- Move all components of the given geometries whose bounding box
-- falls completely on the left of x=-30 to +360
select ST_WrapX(geom, -30, 360);
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_ShiftLongitude"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_SnapToGrid">
<refnamediv>
<refname>ST_SnapToGrid</refname>
<refpurpose>
Snap all points of the input geometry to a regular grid.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SnapToGrid</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>originX</parameter></paramdef>
<paramdef><type>float </type> <parameter>originY</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeX</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeY</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_SnapToGrid</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeX</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeY</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_SnapToGrid</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>float </type> <parameter>size</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_SnapToGrid</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>pointOrigin</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeX</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeY</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeZ</parameter></paramdef>
<paramdef><type>float </type> <parameter>sizeM</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Variant 1,2,3: Snap all points of the input geometry to the grid defined by
its origin and cell size. Remove consecutive points falling on the
same cell, eventually returning NULL if output points are not
enough to define a geometry of the given type. Collapsed
geometries in a collection are stripped from it.
Useful for reducing precision.
</para>
<para>Variant 4: Introduced 1.1.0 - Snap all points of the input geometry to the grid defined by
its origin (the second argument, must be a point) and cell sizes.
Specify 0 as size for any dimension you don't want to snap to a
grid.</para>
<note>
<para>The returned geometry might lose its simplicity (see
<xref linkend="ST_IsSimple"/>).</para>
</note>
<note>
<para>Before release 1.1.0 this function always returned a 2d
geometry. Starting at 1.1.0 the returned geometry will have same
dimensionality as the input one with higher dimension values
untouched. Use the version taking a second geometry argument to
define all grid dimensions.</para>
</note>
<para role="availability" conformance="1.0.0">Availability: 1.0.0RC1</para>
<para role="availability" conformance="1.1.0">Availability: 1.1.0 - Z and M support</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Snap your geometries to a precision grid of 10^-3
UPDATE mytable
SET geom = ST_SnapToGrid(geom, 0.001);
SELECT ST_AsText(ST_SnapToGrid(
ST_GeomFromText('LINESTRING(1.1115678 2.123, 4.111111 3.2374897, 4.11112 3.23748667)'),
0.001)
);
st_astext
-------------------------------------
LINESTRING(1.112 2.123,4.111 3.237)
--Snap a 4d geometry
SELECT ST_AsEWKT(ST_SnapToGrid(
ST_GeomFromEWKT('LINESTRING(-1.1115678 2.123 2.3456 1.11111,
4.111111 3.2374897 3.1234 1.1111, -1.11111112 2.123 2.3456 1.1111112)'),
ST_GeomFromEWKT('POINT(1.12 2.22 3.2 4.4444)'),
0.1, 0.1, 0.1, 0.01) );
st_asewkt
------------------------------------------------------------------------------
LINESTRING(-1.08 2.12 2.3 1.1144,4.12 3.22 3.1 1.1144,-1.08 2.12 2.3 1.1144)
--With a 4d geometry - the ST_SnapToGrid(geom,size) only touches x and y coords but keeps m and z the same
SELECT ST_AsEWKT(ST_SnapToGrid(ST_GeomFromEWKT('LINESTRING(-1.1115678 2.123 3 2.3456,
4.111111 3.2374897 3.1234 1.1111)'),
0.01) );
st_asewkt
---------------------------------------------------------
LINESTRING(-1.11 2.12 3 2.3456,4.11 3.24 3.1234 1.1111)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_Snap"/>,
<xref linkend="ST_AsEWKT"/>,
<xref linkend="ST_AsText"/>,
<xref linkend="ST_GeomFromText"/>,
<xref linkend="ST_GeomFromEWKT"/>,
<xref linkend="ST_Simplify"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_Snap">
<refnamediv>
<refname>ST_Snap</refname>
<refpurpose>
Snap segments and vertices of input geometry
to vertices of a reference geometry.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Snap</function></funcdef>
<paramdef><type>geometry </type> <parameter>input</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>reference</parameter></paramdef>
<paramdef><type>float </type> <parameter>tolerance</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Snaps the vertices and segments of a geometry to
another Geometry's vertices.
A snap distance tolerance is used to control where snapping is performed.
The result geometry is the input geometry with the vertices snapped.
If no snapping occurs then the input geometry is returned unchanged.
</para>
<para>
Snapping one geometry to another can improve
robustness for overlay operations by eliminating
nearly-coincident edges
(which cause problems during noding and intersection calculation).
</para>
<para>
Too much snapping can result in invalid topology
being created, so the number and location of snapped vertices
is decided using heuristics to determine when it
is safe to snap.
This can result in some potential snaps being omitted, however.
</para>
<note>
<para>
The returned geometry might lose its simplicity (see
<xref linkend="ST_IsSimple"/>) and validity (see
<xref linkend="ST_IsValid"/>).
</para>
</note>
<para>Performed by the GEOS module.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<colspec colname="column1"/>
<colspec colname="column2"/>
<spanspec namest="column1" nameend="column2" spanname="span-horiz" align="center"/>
<tbody>
<row>
<entry spanname="span-horiz"><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_snap01.png"/>
</imageobject>
<caption><para>A multipolygon shown with a linestring (before any snapping)</para></caption>
</mediaobject>
</informalfigure></para>
</entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_snap02.png"/>
</imageobject>
<caption><para>A multipolygon snapped to linestring to tolerance: 1.01 of distance.
The new multipolygon is shown with reference linestring</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_Snap(poly,line, ST_Distance(poly,line)*1.01)) AS polysnapped
FROM (SELECT
ST_GeomFromText('MULTIPOLYGON(
((26 125, 26 200, 126 200, 126 125, 26 125 ),
( 51 150, 101 150, 76 175, 51 150 )),
(( 151 100, 151 200, 176 175, 151 100 )))') As poly,
ST_GeomFromText('LINESTRING (5 107, 54 84, 101 100)') As line
) As foo;
polysnapped
---------------------------------------------------------------------
MULTIPOLYGON(((26 125,26 200,126 200,126 125,101 100,26 125),
(51 150,101 150,76 175,51 150)),((151 100,151 200,176 175,151 100)))
</programlisting></para>
</entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_snap04.png"/>
</imageobject>
<caption><para>A multipolygon snapped to linestring to tolerance: 1.25 of distance.
The new multipolygon is shown with reference linestring</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(
ST_Snap(poly,line, ST_Distance(poly,line)*1.25)
) AS polysnapped
FROM (SELECT
ST_GeomFromText('MULTIPOLYGON(
(( 26 125, 26 200, 126 200, 126 125, 26 125 ),
( 51 150, 101 150, 76 175, 51 150 )),
(( 151 100, 151 200, 176 175, 151 100 )))') As poly,
ST_GeomFromText('LINESTRING (5 107, 54 84, 101 100)') As line
) As foo;
polysnapped
---------------------------------------------------------------------
MULTIPOLYGON(((5 107,26 200,126 200,126 125,101 100,54 84,5 107),
(51 150,101 150,76 175,51 150)),((151 100,151 200,176 175,151 100)))
</programlisting></para>
</entry>
</row>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_snap03.png"/>
</imageobject>
<caption><para>The linestring snapped to the original multipolygon at tolerance 1.01 of distance.
The new linestring is shown with reference multipolygon</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(
ST_Snap(line, poly, ST_Distance(poly,line)*1.01)
) AS linesnapped
FROM (SELECT
ST_GeomFromText('MULTIPOLYGON(
((26 125, 26 200, 126 200, 126 125, 26 125),
(51 150, 101 150, 76 175, 51 150 )),
((151 100, 151 200, 176 175, 151 100)))') As poly,
ST_GeomFromText('LINESTRING (5 107, 54 84, 101 100)') As line
) As foo;
linesnapped
----------------------------------------
LINESTRING(5 107,26 125,54 84,101 100)
</programlisting>
</para>
</entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_snap05.png"/>
</imageobject>
<caption><para>The linestring snapped to the original multipolygon at tolerance 1.25 of distance.
The new linestring is shown with reference multipolygon</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(
ST_Snap(line, poly, ST_Distance(poly,line)*1.25)
) AS linesnapped
FROM (SELECT
ST_GeomFromText('MULTIPOLYGON(
(( 26 125, 26 200, 126 200, 126 125, 26 125 ),
(51 150, 101 150, 76 175, 51 150 )),
((151 100, 151 200, 176 175, 151 100 )))') As poly,
ST_GeomFromText('LINESTRING (5 107, 54 84, 101 100)') As line
) As foo;
linesnapped
---------------------------------------
LINESTRING(26 125,54 84,101 100)
</programlisting></para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_SnapToGrid"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_SwapOrdinates">
<refnamediv>
<refname>ST_SwapOrdinates</refname>
<refpurpose>Returns a version of the given geometry with
given ordinate values swapped.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_SwapOrdinates</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef><type>cstring</type> <parameter>ords</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns a version of the given geometry with given ordinates swapped.
</para>
<para>
The <varname>ords</varname> parameter is a 2-characters string naming
the ordinates to swap. Valid names are: x,y,z and m.
</para>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
<para>&M_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Example</title>
<programlisting>
-- Scale M value by 2
SELECT ST_AsText(
ST_SwapOrdinates(
ST_Scale(
ST_SwapOrdinates(g,'xm'),
2, 1
),
'xm')
) FROM ( SELECT 'POINT ZM (0 0 0 2)'::geometry g ) foo;
st_astext
--------------------
POINT ZM (0 0 0 4)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para> <xref linkend="ST_FlipCoordinates"/> </para>
</refsection>
</refentry>
</section>
|