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
|
/*! \page Vector_Library GRASS 6 Vector Architecture
by GRASS Development Team
http://grass.osgeo.org
<h2>Table of contents</h2>
Specifications:
- \subpage background
- \subpage intro
- \subpage libraries
- \subpage vlib_topology_management
- \subpage vlib_spidx
- \subpage vlib_categories_layers
- \subpage vlib_attributes
- \subpage vlibtin
- \subpage grassdglib
- \subpage vlibascii
- \subpage vectmodulesoper
\subpage vlibfunc
- \subpage area
- \subpage array
- \subpage box
- \subpage break_lines
- \subpage break_polygons
- \subpage bridges
- \subpage buffer
- \subpage build
- \subpage build_nat
- \subpage build_ogr
- \subpage cats
- \subpage cindex
- \subpage clean_nodes
- \subpage close
- \subpage constraint
- \subpage dangles
- \subpage dbcolumns
- \subpage error
- \subpage field
- \subpage find
- \subpage graph
- \subpage header
- \subpage hist
- \subpage init_head
- \subpage intersect
- \subpage legal_vname
- \subpage level
- \subpage level_two
- \subpage line
- \subpage list
- \subpage map
- \subpage net
- \subpage open
- \subpage overlay
- \subpage vpoly
- \subpage read
- \subpage remove_areas
- \subpage remove_duplicates
- \subpage rewind
- \subpage select
- \subpage sindex
- \subpage snap
- \subpage tin
- \subpage type
- \subpage delete
- \subpage write
\subpage contacts
\subpage references
\subpage seealso
\section background Background
Generally, the vector data model is used to describe geographic
phenomena which may be represented by geometric entities like points,
lines, and areas. The GRASS vector data model includes the description
of topology, where besides the coordinates describing the location of
the primitives (points, lines, boundaries, centroids, faces, and
kernels), their spatial relations are also stored. In general,
topological GIS require a data structure where the common boundary
between two adjacent areas is stored as a single line, simplifying the
map maintenance.
\section intro Introduction
The GRASS 6 vector format is very similar to old GRASS 4.x (5.0/5.3)
vector format.
This description covers the new GRASS 6 vector library architecture.
This new architecture overcomes the vector limitations of GRASS
4.x-5.4.x by extending the vector support with attributes stored in
external relational databases, and by new 3D capabilities. Besides
internal file based storage the geometry may alternatively be stored
in a PostGIS database. This enables users to maintain large data sets
with simultaneous write access. External GIS formats such as
SHAPE-files may be used directly, without requiring format conversion.
The current implementation includes:
<ul>
<li> multi-layer: features in one vector map may represent more layers and
may be linked to more external tables (see \ref vlib_categories_layers);
<li> 2D and 3D vector geometry with full topology support for 2D and partial topology support for 3D (see \ref vlib_topology_management);
<li> multi-format: external data formats supported (SHAPE-file, OGR sources etc.);
<li> portability: platform independent internal format, read- and writable on 32bit,
64bit etc. computer architectures;
<li> integrated \ref dglib: support for vector network analysis;
<li> spatial index: based on R-tree method for fast vector geometry access (see \ref vlib_spidx).
<li> multi-attribute: attributes saved in external Relational Database Management
System (RDBMS) connected through DBMI library and drivers (\ref vlib_attributes);
</ul>
GRASS vector maps are stored in an arc-node representation,
consisting of curves called arcs. An arc is stored as a series of x,y,z
coordinate pairs. The two endpoints of an arc are called nodes. Two
consecutive x,y,z pairs define an arc segment. The user specifies the
type of input to GRASS; GRASS doesn't decide. GRASS allows for the
line definition which allows for multiple types to co-exist in the
same map. Centroid are assigned to area it is within/inside
(geometrically). An area is identified by an x,y,z centroid point
geometrically inside with a category number (ID). This identifies the
area. Such centroids are stored in the same binary 'coor' file with
other primitives. Each element may have none, one or more categories
(cats). More cats are distinguished by field number (field, called
"layer" at user level). Single and multi-category support on modules
level are implemented. Z-coordinate is optional and both 2D and 3D
files may be written.
<p>
The following vector objects are defined:
<ul>
<li> point: a point;
<li> line: a directed sequence of connected vertices with two endpoints called nodes;
<li> boundary: the border line to describe an area;
<li> centroid: a point within a closed boundary;
<li> area: the topological composition of a closed ring of boundaries and optionally a centroid;
<li> face: a 3D boundary;
<li> kernel: a 3D centroid in a volume;
<li> volume: a 3D corpus, the topological composition of faces and kernel.
</ul>
Note that all lines and boundaries can be polylines (with nodes in
between).
Area topology also holds information about isles. Isles are located within an area, not
touching the boundaries of the outer area. Isles consist of one or more areas
and are used internally by the vector libraries to maintain correct topology of areas.
\section libraries Vector libraries
Besides internal library functions there are two main libraries:
<ul>
<li> Vlib (Vector library), see \ref vlib
<li> DGLib (Directed Graph Library), see \ref dglib
</ul>
For historical reasons, there are two internal libraries for vector:
<ul>
<li> diglib (with dig_*() functions), GRASS 3.x/4.x
<li> Vlib (with V1_*(), V2_*() and Vect_*() functions), since GRASS 4.x (except for the 5.7 interim version)
</ul>
The vector library was introduced in GRASS 4.0 to hide internal vector
files' formats and structures. In GRASS 6, everything is accessed via
Vect_*() functions, for example:
Old 4.x code:
\verbatim
xx = Map.Att[Map.Area[area_num].att].x;
\endverbatim
New 6.x functions:
\verbatim
Vect_get_area_centroid()
Vect_get_centroid_coor()
\endverbatim
In GRASS 6, all internal, mostly non-topological vector functions are
hidden from the modules' API (mainly dig_*(), V1_*() and V2_*()
functions). All available Vect_*() functions are topological vector
functions.
\subsection vlib Introduction to Vlib (Vector library)
<i>Note: For details please read Blazek et al. 2002 (see below) as well as the
references in this document.</i>
\subsubsection Directory_structure Directory structure
Directory structure and file names are changed with respect to
previous GRASS versions. All vector files for one vector map are
stored in one directory:<br>
<b>$MAPSET/vector/vector_name/</b>
<p>
This directory contains these files:
<ul>
<li><b>coor</b> - binary file, coordinates [former dig/ file]
<li><b>topo</b> - binary file, topology [former dig_plus/ file]
<li><b>cidx</b> - binary file, category index
<li><b>head</b> - text file, header information [former part of dig/ file]
<li><b>dbln</b> - text file, link(s) to attribute table(s)
<li><b>hist</b> - text file, vector map change history
</ul>
\subsubsection coor_file_format_specification Coor file format specification
<ol>
<li> In the coor file the following is stored: 'line' (element) type,
number of attributes and layer number for each category.
<li> Coordinates in binary file are stored as double (8 bytes).
</ol>
<b>Head</b>
<TABLE border=2>
<TR><TD><B>Name</B></TD><TD><B>Type</B></TD><TD><B>Number</B></TD><TD><B>Description</B></TD></TR>
<TR><TD>Version_Major</TD> <TD>C</TD> <TD>1</TD> <TD>file version (major)</TD></TR>
<TR><TD>Version_Minor</TD> <TD>C</TD> <TD>1</TD> <TD>file version (minor)</TD></TR>
<TR><TD>Back_Major</TD> <TD>C</TD> <TD>1</TD> <TD>supported from GRASS version (major)</TD></TR>
<TR><TD>Back_Minor</TD> <TD>C</TD> <TD>1</TD> <TD>supported from GRASS version (minor)</TD></TR>
<TR><TD>byte_order</TD> <TD>C</TD> <TD>1</TD> <TD>little or big endian flag</TD></TR>
<TR><TD>head_size</TD> <TD>L</TD> <TD>1</TD> <TD>header size of coor file</TD></TR>
<TR><TD>with_z</TD> <TD>C</TD> <TD>1</TD> <TD>2D or 3D flag; zero for 2D</TD></TR>
<TR><TD>size</TD> <TD>L</TD> <TD>1</TD> <TD>coor file size</TD></TR>
</TABLE>
<p>
<b>Body</b>
The body consists of line records:
<br>
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>record header</TD><TD>C</TD><TD>1</TD><TD>
<UL>
<LI><B>0. bit</B> : 1 - alive, 0 - dead line
<LI><B>1. bit</B> : 1 - categories, 0 - no categories
<LI><B>2.-3. bit</B> : type - one of: GV_POINT, GV_LINE,
GV_BOUNDARY, GV_CENTROID
<LI><B>4.-7. bit</B> : reserved, not used
</UL>
</TD></TR>
<TR><TD>ncats</TD><TD>I</TD><TD>1</TD><TD>number of categories
(written only if categories exist) </TD></TR>
<TR><TD>field</TD><TD>I</TD><TD>ncats</TD><TD>field identifier,
distinguishes between more categories append to one feature (written
only if categories exist; field is called "layer" at user
level)</TD></TR>
<TR><TD>cat</TD><TD>I</TD><TD>ncats</TD><TD>category value (written
only if categories exist)</TD></TR>
<TR><TD>ncoor</TD><TD>I</TD><TD>1</TD><TD>written for GV_LINES and GV_BOUNDARIES
only</TD></TR>
<TR><TD>x</TD><TD>D</TD><TD>ncoor</TD><TD>x coordinate</TD></TR>
<TR><TD>y</TD><TD>D</TD><TD>ncoor</TD><TD>y coordinate</TD></TR>
<TR><TD>z</TD><TD>D</TD><TD>ncoor</TD><TD>z coordinate; present if
with_z in head is set to 1</TD></TR> </TABLE>
<P>
<B>Types used in coor file</B>
<TABLE border=2>
<TR><TD>Type</TD><TD>Name</TD><TD>Size in Bytes</TD></TR>
<TR><TD>D</TD><TD>Double</TD><TD>8</TD></TR>
<TR><TD>L</TD><TD>Long </TD><TD>4</TD></TR>
<TR><TD>I</TD><TD>Int </TD><TD>4</TD></TR>
<TR><TD>S</TD><TD>Short </TD><TD>4</TD></TR>
<TR><TD>C</TD><TD>Char </TD><TD>1</TD></TR>
</TABLE>
\subsubsection head_file_format Head file format
The file is an unordered list of key/value entries. The <i>key</i>
is a string separated from <i>value</i> by a colon and optional
whitespace. Key words are:<br>
\verbatim
ORGANIZATION
DIGIT DATE
DIGIT NAME
MAP NAME
MAP DATE
MAP SCALE
OTHER INFO
ZONE
MAP THRESH
\endverbatim
\section vlib_topology_management Vector library topology management
Topology general characteristics:
- geometry and attributes are stored separately
(don't read both if it is not necessary - usually it is not)
- the format is topological (areas build from boundaries)
- currently only 2D topology is supported
Topology is written for native GRASS vector format; in case of
linked OGR sources (see <tt>v.external</tt> module), only
pseudo-topology (boundaries constructed from polygons) is written.
The following rules apply to the vector data:
- Boundaries should not cross each other (i.e., boundaries which would
cross must be split at their intersection to form distict boundaries).
On the contrary, lines can cross each other, e.g. bridges over rivers.
- Lines and boundaries share nodes only if their endpoints are identical.
Lines or boundaries can be forced to share a common node by snapping
them together. This is particulary important since nodes
are not represented in the coor file, but only implicitly as
endpoints of lines and boundaries.
- Common area boundaries should appear only once (i.e., should not be
double digitized).
- Areas must be explicitly closed. This means that it must be possible
to complete each area by following one or more boundaries that are
connected by common nodes, and that such tracings result in closed
areas.
- It is recommended that area features and linear features be placed
in separate layers. However if area features and linear features
must appear in one layer, common boundaries should be digitized only
once. For example, a boundary that is also a line (e.g., a road which
is also a field boundary), should be digitized as a boundary to
complete the area(s), and a boundary which is functionally also a line
should be labeled as a line by a distinct category number.
Vector map topology can be cleaned at user level by <tt>v.clean</tt>
command.
\subsection vlib_topology_examples Topology examples
<b>Points</b>
\verbatim
One point (nodes: 1, lines: 1, areas: 0, isles: 0)
+ N1/L1
\endverbatim
%Node N1 (see P_Node)
\verbatim
node = 1, n_lines = 1, xyz = 631286.707172, 225105.223577, 0.000000
line = 1, type = 1, angle = -9.000000
\endverbatim
Line L1 (see P_Line)
\verbatim
line = 1, type = 1, offset = 18 n1 = 1, n2 = 1, left/area = 0, right = 0
N,S,E,W,T,B: 225105.223577, 225105.223577, 631286.707172, 631286.707172, 0.000000, 0.000000
\endverbatim
<b>Lines</b>
\verbatim
One line (nodes: 2, lines: 1, areas: 0, isles: 0)
+----L1----+
N1 N2
\endverbatim
%Node N1 (see P_Node)
\verbatim
node = 1, n_lines = 1, xyz = 634624.746450, 223557.302231, 0.000000
line = 1, type = 2, angle = -0.436257
\endverbatim
%Node N2 (see P_Node)
\verbatim
node = 2, n_lines = 1, xyz = 638677.484787, 221667.849899, 0.000000
line = -1, type = 2, angle = 2.705335
\endverbatim
Line L1 (see P_Line)
\verbatim
line = 1, type = 2, offset = 18 n1 = 1, n2 = 2, left/area = 0, right = 0
N,S,E,W,T,B: 223557.302231, 221667.849899, 638677.484787, 634624.746450, 0.000000, 0.000000
\endverbatim
<b>Areas without holes</b>
\verbatim
One line (nodes: 2, lines: 2, areas: 1, isles: 1)
+N1
/ \
/ \
/ \
/ +N2/L2 \
/ \
-------L1------
\endverbatim
%Node N1 (see P_Node)
\verbatim
node = 1, n_lines = 2, xyz = 635720.081136, 225063.387424, 0.000000
line = 1, type = 4, angle = -2.245537
line = -1, type = 4, angle = -0.842926
\endverbatim
%Node N2 (see P_Node)
\verbatim
node = 2, n_lines = 1, xyz = 635779.454021, 223100.127232, 0.000000
line = 2, type = 8, angle = -9.000000
\endverbatim
Line L1 (see P_Line)
\verbatim
line = 1, type = 4, offset = 18 n1 = 1, n2 = 1, left/area = 1, right = -1
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
\endverbatim
Line L2 (see P_Line)
\verbatim
line = 2, type = 8, offset = 87 n1 = 2, n2 = 2, left/area = 1, right = 0
N,S,E,W,T,B: 223100.127232, 223100.127232, 635779.454021, 635779.454021, 0.000000, 0.000000
\endverbatim
Area A1 (see P_Area)
\verbatim
area = 1, n_lines = 1, n_isles = 0 centroid = 2
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
line = -1
\endverbatim
Isle I1 (see \ref P_Isle)
\verbatim
isle = 1, n_lines = 1 area = 0
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
line = 1
\endverbatim
<b>Areas with holes</b>
\verbatim
One line (nodes: 3, lines: 3, areas: 2, isles: 2)
+N1
/ \
/ \
/ \
/ \
/ +N2/L2 \
/ \
/ +N3 \
/ /\ \
/ / \ \
/ / \ \
/ ---L3-- \
/ \
------------L1-------------
\endverbatim
%Node N1 (see P_Node)
\verbatim
node = 1, n_lines = 2, xyz = 635720.081136, 225063.387424, 0.000000
line = 1, type = 4, angle = -2.245537
line = -1, type = 4, angle = -0.842926
\endverbatim
%Node N2 (see P_Node)
\verbatim
node = 2, n_lines = 1, xyz = 635779.454021, 223100.127232, 0.000000
line = 2, type = 8, angle = -9.000000
\endverbatim
%Node N3 (see P_Node)
\verbatim
node = 3, n_lines = 2, xyz = 636788.032454, 223173.935091, 0.000000
line = 3, type = 4, angle = -2.245537
line = -3, type = 4, angle = -0.866302
\endverbatim
Line L1 (see P_Line)
\verbatim
line = 1, type = 4, offset = 18 n1 = 1, n2 = 1, left/area = 1, right = -1
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
\endverbatim
Line L2 (see P_Line)
\verbatim
line = 2, type = 8, offset = 87 n1 = 2, n2 = 2, left/area = 1, right = 0
N,S,E,W,T,B: 223100.127232, 223100.127232, 635779.454021, 635779.454021, 0.000000, 0.000000
\endverbatim
Line L3 (see P_Line)
\verbatim
line = 3, type = 4, offset = 197 n1 = 3, n2 = 3, left/area = 2, right = -2
N,S,E,W,T,B: 223173.935091, 222626.267748, 637253.549696, 636349.898580, 0.000000, 0.000000
\endverbatim
Area A1 (see P_Area)
\verbatim
area = 1, n_lines = 1, n_isles = 1 centroid = 2
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
line = -1
isle = 2
\endverbatim
Area A2 (see P_Area)
\verbatim
area = 2, n_lines = 1, n_isles = 0 centroid = 0
N,S,E,W,T,B: 223173.935091, 222626.267748, 637253.549696, 636349.898580, 0.000000, 0.000000
line = -3
\endverbatim
Isle I1 (see P_Isle)
\verbatim
isle = 1, n_lines = 1 area = 0
N,S,E,W,T,B: 225063.387424, 222188.133874, 638184.584178, 633419.878296, 0.000000, 0.000000
line = 1
\endverbatim
Isle I2 (see P_Isle)
\verbatim
isle = 2, n_lines = 1 area = 1
N,S,E,W,T,B: 223173.935091, 222626.267748, 637253.549696, 636349.898580, 0.000000, 0.000000
line = 3
\endverbatim
\subsection topo_file_format Topo file format
<b>Head</b>
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>Version_Major </TD><TD>C</TD><TD>1</TD><TD>file version (major)</TD></TR>
<TR><TD>Version_Minor </TD><TD>C</TD><TD>1</TD><TD>file version (minor)</TD></TR>
<TR><TD>Back_Major</TD><TD>C</TD><TD>1</TD><TD>supported from GRASS version (major)</TD></TR>
<TR><TD>Back_Minor</TD><TD>C</TD><TD>1</TD><TD>supported from GRASS version (minor)</TD></TR>
<TR><TD>byte_order</TD><TD>C</TD><TD>1</TD><TD>little or big endian
flag; files are written in machine native order but
files in both little and big endian order may be
readl; zero for little endian</TD></TR>
<TR><TD>head_size</TD><TD>L</TD><TD>1</TD><TD>header size</TD></TR>
<TR><TD>with_z</TD><TD>C</TD><TD>1</TD><TD>2D or 3D flag; zero for 2D</TD></TR>
<TR><TD>box</TD><TD>D</TD><TD>6</TD><TD>Bounding box coordinates (N,S,E,W,T,B)</TD></TR>
<TR><TD>n_nodes, n_lines, etc.</TD><TD>I</TD><TD>7</TD><TD>Number of
nodes, edges, lines, areas, isles, volumes and holes</TD></TR>
<TR><TD>n_plines, n_llines, etc.</TD><TD>I</TD><TD>7</TD><TD>Number of
points, lines, boundaries, centroids, faces and kernels</TD></TR>
<TR><TD>Node_offset, Edge_offset,
etc.</TD><TD>L</TD><TD>7</TD><TD>Offset value for nodes, edges, lines,
areas, isles, volumes and holes</TD></TR>
<TR><TD>coor_size</TD><TD>L</TD><TD>1</TD><TD>File size</TD></TR>
</TABLE>
<b>Body</b>
For each node (n_nodes):
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>n_lines</TD><TD>I</TD><TD>1</TD><TD>Number of lines (0 for dead node)</TD></TR>
<TR><TD>lines</TD><TD>I</TD><TD>n_lines</TD><TD>Line ids</TD></TR>
<TR><TD>angles</TD><TD>D</TD><TD>n_lines</TD><TD>Angle value</TD></TR>
<TR><TD>n_edges</TD><TD>I</TD><TD>1</TD><TD>Reserved for edges (only for with_z)</TD></TR>
<TR><TD>x,y</TD><TD>D</TD><TD>2</TD><TD>Coordinate pair</TD></TR>
<TR><TD>z</TD><TD>D</TD><TD>1</TD><TD>Only for with_z</TD></TR>
</TABLE>
For each line (n_lines):
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>feature type</TD><TD>C</TD><TD>1</TD><TD>0 for dead</TD></TR>
<TR><TD>offset</TD><TD>L</TD><TD>1</TD><TD>Line offset</TD></TR>
<TR><TD>N1</TD><TD>I</TD><TD>1</TD><TD>First node id (only if feature type is GV_POINTS, GV_LINES or GV_KERNEL)</TD></TR>
<TR><TD>N2</TD><TD>I</TD><TD>1</TD><TD>Second node id (only if feature type is GV_LINE or GV_BOUNDARY)</TD></TR>
<TR><TD>left</TD><TD>I</TD><TD>1</TD><TD>Left area id for feature type GV_BOUNDARY / Area id for feature type GV_CENTROID</TD></TR>
<TR><TD>right</TD><TD>I</TD><TD>1</TD><TD>Right area id (for feature type GV_BOUNDARY)</TD></TR>
<TR><TD>vol</TD><TD>I</TD><TD>1</TD><TD>Reserved for kernel (volume number, for feature type GV_KERNEL)</TD></TR>
<TR><TD>N,S,E,W</TD><TD>D</TD><TD>4</TD><TD>Line bounding box (for feature type GV_LINE, GV_BOUNDARY or GV_FACE)</TD></TR>
<TR><TD>T,B</TD><TD>D</TD><TD>2</TD><TD>Line bounding box for 3D (only if with_z=1)</TD></TR>
</TABLE>
For each area (n_areas):
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>n_lines</TD><TD>I</TD><TD>1</TD><TD>number of boundaries</TD></TR>
<TR><TD>lines</TD><TD>I</TD><TD>n_lines</TD><TD>Line ids</TD></TR>
<TR><TD>n_isles</TD><TD>I</TD><TD>1</TD><TD>Number of isles</TD></TR>
<TR><TD>isles</TD><TD>I</TD><TD>n_isles</TD><TD>Isle ids</TD></TR>
<TR><TD>centroid</TD><TD>I</TD><TD>1</TD><TD>Centroid id</TD></TR>
<TR><TD>N,S,E,W</TD><TD>D</TD><TD>4</TD><TD>Area bounding box</TD></TR>
<TR><TD>T,B</TD><TD>D</TD><TD>2</TD><TD>Area bounding box for 3D (only if with_z=1)</TD></TR>
</TABLE>
For each isle (n_isle):
<TABLE border=2>
<TR><TD>Name</TD><TD>Type</TD><TD>Number</TD><TD>Description</TD></TR>
<TR><TD>n_lines</TD><TD>I</TD><TD>1</TD><TD>number of boundaries</TD></TR>
<TR><TD>lines</TD><TD>I</TD><TD>n_lines</TD><TD>Line ids</TD></TR>
<TR><TD>area</TD><TD>I</TD><TD>1</TD><TD>Outer area id</TD></TR>
<TR><TD>N,S,E,W</TD><TD>D</TD><TD>4</TD><TD>Isle bounding box</TD></TR>
<TR><TD>T,B</TD><TD>D</TD><TD>2</TD><TD>Isle bounding box for 3D (only if with_z=1)</TD></TR>
</TABLE>
<b>Feature types:</b>
\verbatim
/* Vector types used in memory on run time - may change */
#define GV_POINT 0x01
#define GV_LINE 0x02
#define GV_BOUNDARY 0x04
#define GV_CENTROID 0x08
#define GV_FACE 0x10
#define GV_KERNEL 0x20
#define GV_AREA 0x40
#define GV_VOLUME 0x80
\endverbatim
\verbatim
#define GV_POINTS (GV_POINT | GV_CENTROID )
#define GV_LINES (GV_LINE | GV_BOUNDARY )
\endverbatim
Face and kernel are 3D equivalents of boundary and centroid, but there
is no support (yet) for 3D topology (volumes). Faces are used in a
couple of modules including NVIZ to visualize 3D buildings and other
volumetric figures.
\verbatim
/* Topology level details */
#define GV_BUILD_NONE 0
#define GV_BUILD_BASE 1
#define GV_BUILD_AREAS 2
#define GV_BUILD_ATTACH_ISLES 3 /* Attach islands to areas */
#define GV_BUILD_CENTROIDS 4 /* Assign centroids to areas */
#define GV_BUILD_ALL GV_BUILD_CENTROIDS
\endverbatim
GV_BOUNDARY contains geometry and it is used to build areas.
GV_LINE cannot form an area.
\verbatim
struct line_cats
{
int *field; /* pointer to array of fields a.k.a. layer*/
int *cat; /* pointer to array of categories */
int n_cats; /* number of vector categories attached to element */
int alloc_cats; /* allocated space */
};
\endverbatim
\subsection Topology_Example_1 Topology Example 1:
A polygon may be formed by many boundaries (more primitives but connected).
One boundary is shared by adjacent areas.
\verbatim
+--1--+--5--+
| | |
2 A 4 B 6
| | |
+--3--+--7--+
1,2,3,4,5,6,7 = 7 boundaries (primitives)
A,B = 2 areas
\endverbatim
\subsection Topology_Example_2 Topology Example 2:
This is handled correctly in GRASS: A can be filled, B filled differently.
\verbatim
+---------+
| A |
+-----+ |
| B | |
+-----+ |
| |
+---------+
\endverbatim
In GRASS, whenever an 'inner' ring touches the boundary of an outside area, even in
one point, it is no longer an 'inner' ring (Isle in GRASS topology), it is
simply another area. A, B above can never be exported from GRASS as polygon A
with inner ring B because there are only 2 areas A and B and one island
formed by A and B together.
\subsection Topology_Example_3 Topology Example 3:
This is handled correctly in GRASS: Areas A1, A2, and A3 can be filled differently.
\verbatim
+---------------------+
| A1 |
+ +------+------+ |
| | A2 | A3 | |
+ +------+------+ |
| I1 |
+---------------------+
\endverbatim
In GRASS, whenever an 'inner' ring does not touch the boundary of an outside area,
also not in one point, it is an 'inner' ring (Isle). The areas A2 and A3 form a
single Isle I1 located within area A1. The size of Isle I1 is substracted from
the size of Area A1 when calculating the size of Area A1. Any centroids falling
into Isle I1 are excluded when searching for a centroid that can be attached to
Area A1. A1 above can be exported from GRASS as polygon A1 with inner ring I1.
\subsection Topology_Example_4 Topology Example 4:
v.in.ogr/v.clean can identify dangles and change the type from boundary
to line (in TIGER data for example).
Distinction between line and boundary isn't important only for dangles. Example:
\verbatim
+-----+-----+
| . |
| . |
+.....+.....+
| . |
| x . |
+-----+-----+
---- road + boundary of one parcel => type boundary
.... road => type line
x parcel centroid (identifies whole area)
\endverbatim
Because lines are not used to build areas, we have only one area/centroid,
instead of 4 which would be necessary in TIGER.
\subsection vlib_topo_memory Topology memory management
Topology is generated for all kinds of vector types. Memory is not
released by default. The programmer can force the library to release
the memory by using Vect_set_release_support(). But: The programmer
cannot run Vect_set_release_support() in mid process because all
vectors are needed in the spatial index, which is needed to build topology.
Topology is also necessary for points in case of a vector network
because the graph is built using topology information about lines
and points.
The topology structure does not only store the topology but also
the 'line' bounding box and line offset in coor file (index).
The existing spatial index is using line ID in 'topology' structure
to identify lines in 'coor' file. Currently it is not possible to build
spatial index without topology.
\section vlib_spidx Vector library spatial index management
Spatial index (based on R-tree) is generated on the fly.
Spatial index occupies a lot of memory but it is necessary for
topology building. Also, it takes a long time to release the memory
occupied by spatial index (dig_spidx_free()).
The function building topology (Vect_build()) is usually called
at the end of modules (before Vect_close()) so it is faster to call
exit() and operating system releases all the memory much faster.
By default the memory is not released.
It is possible to call Vect_set_release_support() before Vect_close()
to enforce memory release, but it takes a long time on large files.
Currently most of the modules do not release the memory occupied for
spatial index and work like this (pseudocode):
\verbatim
int main
{
Vect_open_new();
//writing new vector
Vect_build();
Vect_close(); // memory is not released
}
\endverbatim
In general it is possible to free the memory with Vect_set_release_support()
such as:
\verbatim
int main
{
Vect_open_new();
// writing new vector
Vect_build();
Vect_set_release_support();
Vect_close(); // memory is released
}
\endverbatim
but it takes longer.
<P>
It make sense to release the spatial index if it is used only at the beginning
of a module or in permanently running programs like QGIS.
For example:
\verbatim
int main
{
Vect_open_old();
// select features using spatial index, e.g. Vect_select_lines_by_box()
Vect_set_release_support();
Vect_close(); // memory is released
// do some processing which needs memory
}
\endverbatim
\section vlib_categories_layers Vector library categories and layers
<P>
<i>Note: "layer" was called "field" in earlier version.</i>
<P>
In GRASS, a "category" or "category number" is a vector feature ID
used to link geometry to attributes which are stored in one or several
(external) database table(s). This category number is stored into the
vector geometry as well as a "cat" column (integer type) in each
attribute database table. The category number is used to lookup an
attribute assigned to a vector object. At user level, category numbers
can be assigned to vector objects with the v.category command.
In order to assign multiple attributes in different tables to vector
objects, each map can hold multiple category numbers. This is achieved
by assigning more than one "layer" to the map (v.db.connect
command). The layer number determines which table to be used for
attribute queries. For example, a cadastrial vector area map can be
assigned on layer 1 to an attribute table containing landuse
descriptions which are maintained by department A while layer 2 is
assigned to an attribute table containing owner descriptions which are
maintained by department B.
Each vector feature inside a vector map has zero, one or more
<layer,category> tuple(s). A user can (but not must) create
attribute tables which are referenced by the layer, and rows which are
essentially referenced by the <layer,category> pair. <P>
Categories start with 1. Categories do not have to be continuous.
\section vlib_cidx Vector library category index
The category index (stored in the cidx file) improves the performance of all
selections by cats/attributes (SQL, e.g. 'd.vect cats=27591', 'v.extract list=20000-21000').
This avoids that all selections have to be made by looping through all vector lines.
Category index is also essential for simple feature representation of GRASS vectors.
Category index is created for each field. In memory, it is stored in
\verbatim
struct Cat_index {
int field; /* field number a.k.a. layer*/
int n_cats; /* number of items in cat array */
int a_cats; /* allocated space in cat array */
int (*cat)[3]; /* array of cats (cat,type, lines/area) */
int n_ucats; /* number of unique cats (not updated) */
int n_types; /* number of types in type */
int type[7][2];/* number of elements for each type (point, line, boundary, centroid, area, face, kernel) */
long offset; /* offset of the beginning of this index in cidx file */
};
\endverbatim
Category index is built with topology, but it is <b>not updated</b> if vector is edited on level 2.
Category index is stored in 'cidx' file, 'cat' array is written/read by one call of
dig__fwrite_port_I( (int *)ci->cat, 3 * ci->n_cats, fp) or
dig__fread_port_I( (int *)ci->cat, 3 * ci->n_cats, fp).
Stored values can be retrieved either by index in 'cat' array
(if all features of given field are required) or by category value
(one or few features), always by Vect_cidx_*() functions.
To create category index, it will be necessary to rebuild topology for all existing vectors.
This is an opportunity to make (hopefully) last changes in 'topo', 'cidx' formats.
\section vlibtin Vector TINs
TINs are simply created as 2D/3D vector polygons consisting of
3 vertices. See Vect_tin_get_z().
\section vlib_attributes Vector library and attributes
The old GRASS 4.x 'dig_cats' files are not used any more and vectors'
attributes are stored in external database. Connection with the
database is done through drivers based on DBMI library (DBF, SQLite,
PostgreSQL, MySQL and ODBC drivers are available at this
time). Records in a table are linked to vector entities by layer and
category number. The layer identifies table and the category
identifies record. I.e., for any unique combination
map+mapset+layer+category, there exists one unique combination
driver+database+table+row.
The general DBMI settings are defined in the "MAPSET/VAR" text file
(maintained with db.connect command at user level).
Each vector maps has its own DBMI settings stored in the
"MAPSET/vector/vector_name/dbln" text file. For each pair <B>map +
layer</B>, all of <B>table, key column, database, driver</B> must be
defined in a new row. This definition must be written to
"MAPSET/vector/vector_name/dbln" text file. Each row in the "dbln"
file contains names separated by spaces in following order ([] -
optional): <BR><BR>
\verbatim
map[@mapset] layer table [key [database [driver]]]
\endverbatim
If key, database or driver are omitted (on second and higher row only)
the last definition is used. When reading a vector map from another
mapset (if mapset is specified along with map name), definitions in
the related "dbln" file may overwrite the DBMI definition in the
current mapset. This means that the map-wise definition is always
"stronger".
<P>
Wild cards <B>*</B> and <B>?</B> may be used in map and mapset names.
<P>
Variables <B>$GISDBASE, $LOCATION_NAME, $MAPSET, $MAP</B> may be used
in table, key, database and driver names (function
Vect_subst_var()). Note that $MAPSET is not the current mapset but
mapset of the map the rule is defined for.
<P>
Note that vector features in GRASS vector maps may have attributes
in different tables or may be without attributes. Boundaries
form areas but it may happen that some boundaries are not closed
(such boundaries would not appear in polygon layer).
Boundaries may have attributes. All types may be mixed in one vector map.
<P>
The link to the table is permanent and it is stored in 'dbln' file
in vector directory. Tables are considered to be a part of the vector
and the command g.remove, for example, deletes linked tables of the vector.
Attributes must be joined with geometry.
<P>
<B>Examples:</B>
Examples are written mostly for the DBF driver, where database is full path to
the directory with dbf files and table name is the name of dbf file without
.dbf extension:
<P>
\verbatim
* 1 mytable id $GISDBASE/$LOCATION_NAME/$MAPSET/vector/$MAP dbf
\endverbatim
This definition says that entities with category of layer 1 are linked
to dbf tables with names "mytable.dbf" saved in vector directories of
each map. The attribute column containing the category numbers is
called "id".
\verbatim
* 1 $MAP id $GISDBASE/$LOCATION_NAME/$MAPSET/dbf dbf
\endverbatim
Similar as above but all dbf files are in one directory dbf/ in mapset
and names of dbf files are $MAP.dbf
\verbatim
water* 1 rivers id /home/grass/dbf dbf
water* 2 lakes lakeid /home/guser/mydb
trans* 1 roads key basedb odbc
trans* 5 rails
\endverbatim
These definitions define more layers (called "field" in the API) for one map
i.e. in one map may be more features linked to more tables. Definitions on
first 2 rows are applied for example on maps water1, water2, ... so that more
maps may share one table.<BR><BR>
\verbatim
water@PERMANENT 1 myrivers id /home/guser/mydbf dbf
\endverbatim
This definion overwrites the definition saved in PERMANENT/VAR and
links the water map from PERMANENT mapset to the user's table.
<P>
Modules should be written so that connections to databases for each
vector layer are independent. It should be possible to read attributes
of an input map from one database and write to some other and even with
some other driver (should not be a problem).
<P>
There are open questions, however. For one, how does one distinguish when
new tables should be written and when not? For example, definitions:<BR>
\verbatim
river 1 river id water odbc
river.backup* 1 NONE
\endverbatim
could be used to say that tables should not be copied for backups of
map river because table is stored in a reliable RDBMS.
\section grassdglib DGLib (Directed Graph Library)
The Directed Graph Library or DGLib (Micarelli 2002, \ref dglib ,
http://grass.osgeo.org/dglib/) provides functionality for vector network
analysis. This library released under GPL is hosted by the GRASS
project (within the GRASS source code). As a stand-alone library it
may also be used by other software projects.
The Directed Graph Library library provides functionality to assign costs to
lines and/or nodes. That means that costs can be accumulated while traveling
along polylines. The user can assign individual costs to all lines and/or
nodes of a vector map and later calculate shortest path connections based on
the accumulated costs. Applications are transport analysis, connectivity and
more. Implemented applications cover Shortest path, Traveling salesman (round trip),
Allocation of sources (creation of subnetworks), Minimum Steiner trees
(star-like connections), and iso-distances (from centers).
For details, please read Blazek et al. 2002 (see below).
Related vector functions are:
Vect_graph_add_edge(),
Vect_graph_init(),
Vect_graph_set_node_costs(),
Vect_graph_shortest_path(),
Vect_net_build_graph(),
Vect_net_nearest_nodes(),
Vect_net_shortest_path(), and
Vect_net_shortest_path_coor().
\section vlibascii Vector ASCII Format Specifications
The ASCII format is (currently) explained in the
manual page of v.in.ascii, which is defined in the file:
vector/v.in.ascii/description.html
\section vectmodules Vector modules and their parameters/flags
See also grass5/documents/parameter_proposal.txt
<P>
<I>A module is a GRASS command invoked by the user.</I>
</P>
\subsection vectmodulesoper Modules operation
Each module which modifies and writes data must read from input= and
write to output= so that data may not be lost. For example v.spag
works on map= at in grass5.0 but if program (system) crashes or threshold was
specified incorrectly and vector was not backuped, data were lost.
In this case map= option should be replaced by input= and output=
<P>
Topology is always built by default if the coor file was modified.
<P>
Dimensionality is generally kept. Input 2D vector is written as 2D, 3D as 3D.
There are a few modules which change the dimension on purpose.
\subsection vectmodulesopt Modules parameters/flags
<B>-b</B> do not build topo file; by default topo file is written <BR>
<B>-t</B> create new table, default<BR>
<B>-u</B> don't create new table<BR>
<B>-z</B> write 3D vector map (if input was 2D) <BR>
<BR>
<B>map=</B> input vector map for modules without output <BR>
<B>input=</B> input vector map <BR>
<B>output=</B> output vector map <BR>
<B>type=</B> type of elements: point,line,boundary,centroid,area <BR>
<B>cat=</B> category or category list (example: 1,5,9-13,35) <BR>
<B>layer=</B> layer number <BR>
<B>where=</B> condition of SQL statement for selection of records <BR>
<B>column=</B> column name (in external table)
\section vlibfunc List of vector library functions
The Vect_*() functions are the programmer's API for GRASS vector
programming.
\section area Vector area functions
- Vect_get_area_area()
- Vect_get_area_boundaries()
- Vect_get_area_centroid()
- Vect_get_area_isle()
- Vect_get_area_num_isles()
- Vect_area_perimeter()
- Vect_get_area_points()
- Vect_get_isle_area()
- Vect_get_isle_boundaries()
- Vect_get_isle_points()
- Vect_point_in_area()
\section array Vector array functions
- Vect_new_varray()
- Vect_set_varray_from_cat_list()
- Vect_set_varray_from_cat_string()
- Vect_set_varray_from_db()
\section box Vector bounding box functions
- Vect_box_copy()
- Vect_box_clip()
- Vect_box_extend()
- Vect_box_overlap()
- Vect_get_area_box()
- Vect_get_isle_box()
- Vect_get_line_box()
- Vect_get_map_box()
- Vect_point_in_box()
- Vect_region_box()
\section break_lines Vector break lines functions
- Vect_break_lines()
- Vect_break_lines_list()
\section break_polygons Vector break polygons functions
- Vect_break_polygons()
\section bridges Vector bridges functions
- Vect_chtype_bridges()
- Vect_remove_bridges()
\section buffer Vector buffer functions
- Vect_line_buffer()
- Vect_line_parallel()
\section build Vector build functions
- Vect_build()
- Vect_build_partial()
- Vect_get_built()
- Vect_save_spatial_index()
- Vect_save_topo()
- Vect_spatial_index_dump()
- Vect_topo_dump()
\subsection build_nat Vector build (native) functions
- Vect_attach_centroids()
- Vect_attach_isle()
- Vect_attach_isles()
- Vect_build_line_area()
- Vect_build_nat()
- Vect_isle_find_area()
\subsection build_ogr Vector build (OGR) functions
- Vect_build_ogr()
\section cats Vector categories functions
- Vect_array_to_cat_list()
- Vect_cat_del()
- Vect_cat_get()
- Vect_cat_in_array()
- Vect_cat_in_cat_list()
- Vect_cat_set()
- Vect_destroy_cat_list()
- Vect_destroy_cats_struct()
- Vect_field_cat_del()
- Vect_get_area_cats()
- Vect_get_area_cat()
- Vect_get_line_cat()
- Vect_new_cat_list()
- Vect_new_cats_struct()
- Vect_reset_cats()
- Vect_str_to_cat_list()
\section cindex Vector category index functions
(note: vector layer is historically called "field")
- Vect_cidx_dump()
- Vect_cidx_find_next()
- Vect_cidx_find_all()
- Vect_cidx_get_cat_by_index()
- Vect_cidx_get_field_index()
- Vect_cidx_get_field_number()
- Vect_cidx_get_num_cats_by_index()
- Vect_cidx_get_num_fields()
- Vect_cidx_get_num_types_by_index()
- Vect_cidx_get_num_unique_cats_by_index()
- Vect_cidx_get_type_count()
- Vect_cidx_get_type_count_by_index()
- Vect_cidx_open()
- Vect_cidx_save()
- Vect_set_category_index_update()
\section clean_nodes Vector clean nodes functions
- Vect_clean_small_angles_at_nodes()
\section close Vector close functions
- Vect_close()
\section constraint Vector constraint functions
- Vect_get_constraint_box()
- Vect_remove_constraints()
- Vect_set_constraint_region()
- Vect_set_constraint_type()
\section dangles Vector dangles functions
- Vect_chtype_dangles()
- Vect_remove_dangles()
- Vect_select_dangles()
\section dbcolumns Vector dbcolumns functions
- Vect_get_column_names()
- Vect_get_column_names_types()
- Vect_get_column_types()
\section error Vector error functions
- Vect_get_fatal_error()
- Vect_set_fatal_error()
\section field Vector field functions
(note: vector layer is historically called "field")
- Vect_add_dblink()
- Vect_check_dblink()
- Vect_default_field_info()
- Vect_get_dblink()
- Vect_get_field()
- Vect_map_add_dblink()
- Vect_map_check_dblink()
- Vect_map_del_dblink()
- Vect_new_dblinks_struct()
- Vect_read_dblinks()
- Vect_reset_dblinks()
- Vect_set_db_updated()
- Vect_subst_var()
- Vect_write_dblinks()
\section find Vector find functions
- Vect_find_area()
- Vect_find_island()
- Vect_find_line()
- Vect_find_line_list()
- Vect_find_node()
\section graph Vector graph functions
- Vect_graph_add_edge()
- Vect_graph_build()
- Vect_graph_init()
- Vect_graph_set_node_costs()
- Vect_graph_shortest_path()
\section header Vector header functions
- Vect_get_comment()
- Vect_get_constraint_box()
- Vect_get_date()
- Vect_get_full_name()
- Vect_get_map_date()
- Vect_get_map_name()
- Vect_get_mapset()
- Vect_get_name()
- Vect_get_organization()
- Vect_get_person()
- Vect_get_proj()
- Vect_get_proj_name()
- Vect_get_scale()
- Vect_get_thresh()
- Vect_get_zone()
- Vect_is_3d()
- Vect_print_header()
- Vect_read_header()
- Vect_set_comment()
- Vect_set_date()
- Vect_set_map_date()
- Vect_set_map_name()
- Vect_set_organization()
- Vect_set_person()
- Vect_set_scale()
- Vect_set_thresh()
- Vect_set_zone()
- Vect_write_header()
\section hist Vector history functions
- Vect_hist_command()
- Vect_hist_copy()
- Vect_hist_read()
- Vect_hist_rewind()
- Vect_hist_write()
\section init_head Vector header functions
- Vect_copy_head_data()
\section intersect Vector intersection functions
- Vect_line_check_intersection()
- Vect_line_intersection()
- Vect_segment_intersection()
\section legal_vname Vector valid map name functions
- Vect_check_input_output_name()
- Vect_legal_filename()
\section level Vector level functions
- Vect_level()
\section level_two Vector topological (level 2) functions
- Vect_get_centroid_area()
- Vect_get_line_areas()
- Vect_get_line_nodes()
- Vect_get_node_coor()
- Vect_get_node_line()
- Vect_get_node_line_angle()
- Vect_get_node_n_lines()
- Vect_get_num_areas()
- Vect_get_num_dblinks()
- Vect_get_num_faces()
- Vect_get_num_islands()
- Vect_get_num_lines()
- Vect_get_num_nodes()
- Vect_get_num_primitives()
- Vect_get_num_updated_lines()
- Vect_get_num_updated_nodes()
- Vect_get_updated_line()
- Vect_get_updated_node()
- Vect_set_release_support()
\section line Vector feature functions
- Vect_append_point()
- Vect_append_points()
- Vect_copy_pnts_to_xyz()
- Vect_copy_xyz_to_pnts()
- Vect_destroy_line_struct()
- Vect_line_box()
- Vect_line_delete_point()
- Vect_line_distance()
- Vect_line_geodesic_length()
- Vect_line_insert_point()
- Vect_line_length()
- Vect_line_prune()
- Vect_line_prune_thresh()
- Vect_line_reverse()
- Vect_line_segment()
- Vect_new_line_struct()
- Vect_point_on_line()
- Vect_points_distance()
- Vect_reset_line()
\section list Vector list functions
- Vect_destroy_list()
- Vect_list_append()
- Vect_list_append_list()
- Vect_list_delete()
- Vect_list_delete_list()
- Vect_new_list()
- Vect_reset_list()
- Vect_val_in_list()
\section map Vector map functions
- Vect_copy()
- Vect_copy_map_lines()
- Vect_copy_table()
- Vect_copy_table_by_cats()
- Vect_copy_tables()
- Vect_delete()
- Vect_rename()
\section net Vector network functions
- Vect_net_build_graph()
- Vect_net_get_line_cost()
- Vect_net_get_node_cost()
- Vect_net_nearest_nodes()
- Vect_net_shortest_path()
- Vect_net_shortest_path_coor()
\section open Vector open functions
- Vect_coor_info()
- Vect_maptype_info()
- Vect_open_new()
- Vect__open_old()
- Vect_open_old()
- Vect_open_old_head()
- Vect_open_spatial_index()
- Vect_open_topo()
- Vect_open_update()
- Vect_open_update_head()
- Vect_set_open_level()
\section overlay Vector overlay functions
- Vect_overlay()
- Vect_overlay_str_to_operator()
\section vpoly Vector polygon functions
- Vect_find_poly_centroid()
- Vect_get_point_in_area()
- Vect_point_in_area_outer_ring()
- Vect_point_in_island()
- Vect_get_point_in_poly()
- Vect_get_point_in_poly_isl()
\section read Vector read functions
\subsection read1_2 Level 1 and 2
- Vect_read_next_line()
\subsection read2 Level 2 only
- Vect_area_alive()
- Vect_isle_alive()
- Vect_line_alive()
- Vect_node_alive()
- Vect_read_line()
\section remove_areas Vector remove areas functions
- Vect_remove_small_areas()
\section remove_duplicates Vector remove duplicates functions
- Vect_line_check_duplicate()
- Vect_remove_duplicates()
\section rewind Vector rewind functions
- Vect_rewind()
\section select Vector select functions
- Vect_select_areas_by_box()
- Vect_select_areas_by_polygon()
- Vect_select_isles_by_box()
- Vect_select_lines_by_box()
- Vect_select_lines_by_polygon()
- Vect_select_nodes_by_box()
\section sindex Vector spatial index functions
- Vect_build_sidx_from_topo()
- Vect_build_spatial_index()
- Vect_spatial_index_add_item()
- Vect_spatial_index_del_item()
- Vect_spatial_index_destroy()
- Vect_spatial_index_init()
- Vect_spatial_index_select()
\section snap Vector snap functions
- Vect_snap_lines()
- Vect_snap_lines_list()
\section tin Vector TIN functions
- Vect_tin_get_z()
\section type Vector type option functions
- Vect_option_to_types()
\section delete Vector delete functions
\subsection delete2 Level 2 only
- Vect_delete_line()
\section write Vector write functions
\subsection write1_2 Level 1 and 2
- Vect_write_line()
\subsection write2 Level 2 only
- Vect_rewrite_line()
\section vlibAuthors Authors
- Radim Blazek (vector architecture) <radim.blazek gmail.com>
- Roberto Micarelli (DGLib) <mi.ro iol.it>
Updates:
- Markus Metz
- Martin Landa <landa.martin gmail.com>
\section references References
Text based on: R. Blazek, M. Neteler, and R. Micarelli. The new GRASS 5.1
vector architecture. In Open source GIS - GRASS users conference 2002,
Trento, Italy, 11-13 September 2002. University of Trento, Italy, 2002.
<a href="http://www.ing.unitn.it/~grass/conferences/GRASS2002/proceedings/proceedings/pdfs/Blazek_Radim.pdf">http://www.ing.unitn.it/~grass/conferences/GRASS2002/proceedings/proceedings/pdfs/Blazek_Radim.pdf</a>
\section seealso See Also
- \ref dglib
- \ref dbmilib
- \ref Vedit_Library
Last change: $Date: 2011-12-22 23:26:23 +0100 (Thu, 22 Dec 2011) $
*/
|