/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-gwyprocessenums.html is in libgwyddion20-doc 2.34-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Data Processing Library Reference Manual: gwyprocessenums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="prev" href="libgwyprocess-gwyprocess.html" title="gwyprocess">
<link rel="next" href="api-index-full.html" title="Index of all symbols">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#libgwyprocess-gwyprocessenums.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyprocess-gwyprocess.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyprocess-gwyprocessenums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-gwyprocessenums.top_of_page"></a>gwyprocessenums</span></h2>
<p>gwyprocessenums — Common enumerations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-gwyprocessenums.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyMergeType" title="enum GwyMergeType">GwyMergeType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyMaskingType" title="enum GwyMaskingType">GwyMaskingType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyWatershedStateType" title="enum GwyWatershedStateType">GwyWatershedStateType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyPlaneSymmetry" title="enum GwyPlaneSymmetry">GwyPlaneSymmetry</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#Gwy2DCWTWaveletType" title="enum Gwy2DCWTWaveletType">Gwy2DCWTWaveletType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyOrientation" title="enum GwyOrientation">GwyOrientation</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection">GwyTransformDirection</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataFieldCached" title="enum GwyDataFieldCached">GwyDataFieldCached</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationStateType" title="enum GwyComputationStateType">GwyComputationStateType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTType" title="enum GwyDWTType">GwyDWTType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTDenoiseType" title="enum GwyDWTDenoiseType">GwyDWTDenoiseType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyInterpolationType" title="enum GwyInterpolationType">GwyInterpolationType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyPlaneFitQuantity" title="enum GwyPlaneFitQuantity">GwyPlaneFitQuantity</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyWindowingType" title="enum GwyWindowingType">GwyWindowingType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTipType" title="enum GwyTipType">GwyTipType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyCorrelationType" title="enum GwyCorrelationType">GwyCorrelationType</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity">GwyGrainQuantity</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags">GwyDataCompatibilityFlags</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyLineStatQuantity" title="enum GwyLineStatQuantity">GwyLineStatQuantity</a>;
enum <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyExteriorType" title="enum GwyExteriorType">GwyExteriorType</a>;
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-merge-type-get-enum" title="gwy_merge_type_get_enum ()">gwy_merge_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-masking-type-get-enum" title="gwy_masking_type_get_enum ()">gwy_masking_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-plane-symmetry-get-enum" title="gwy_plane_symmetry_get_enum ()">gwy_plane_symmetry_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-2d-cwt-wavelet-type-get-enum" title="gwy_2d_cwt_wavelet_type_get_enum ()">gwy_2d_cwt_wavelet_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-orientation-get-enum" title="gwy_orientation_get_enum ()">gwy_orientation_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-dwt-type-get-enum" title="gwy_dwt_type_get_enum ()">gwy_dwt_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-dwt-denoise-type-get-enum" title="gwy_dwt_denoise_type_get_enum ()">gwy_dwt_denoise_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-interpolation-type-get-enum" title="gwy_interpolation_type_get_enum ()">gwy_interpolation_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-windowing-type-get-enum" title="gwy_windowing_type_get_enum ()">gwy_windowing_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * <a class="link" href="libgwyprocess-gwyprocessenums.html#gwy-correlation-type-get-enum" title="gwy_correlation_type_get_enum ()">gwy_correlation_type_get_enum</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState">GwyComputationState</a>;
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-gwyprocessenums.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyprocess-gwyprocessenums.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyMergeType"></a><h3>enum GwyMergeType</h3>
<pre class="programlisting">typedef enum {
GWY_MERGE_UNION,
GWY_MERGE_INTERSECTION
} GwyMergeType;
</pre>
<p>
Mask merge type (namely used in grain processing).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-MERGE-UNION:CAPS"></a><span class="term"><code class="literal">GWY_MERGE_UNION</code></span></p></td>
<td>Union (logical or) merging.
</td>
</tr>
<tr>
<td><p><a name="GWY-MERGE-INTERSECTION:CAPS"></a><span class="term"><code class="literal">GWY_MERGE_INTERSECTION</code></span></p></td>
<td>Intersection (logical and) merging.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyMaskingType"></a><h3>enum GwyMaskingType</h3>
<pre class="programlisting">typedef enum {
GWY_MASK_EXCLUDE = 0,
GWY_MASK_INCLUDE = 1,
GWY_MASK_IGNORE = 2,
} GwyMaskingType;
</pre>
<p>
Mask handling in procedures that can apply masking.
</p>
<p>
Note at present many procedures do not have a masking argument and hence
cannot apply masks in exclude mode.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-MASK-EXCLUDE:CAPS"></a><span class="term"><code class="literal">GWY_MASK_EXCLUDE</code></span></p></td>
<td>Exclude data under mask, i.e. take into account only
data not covered by the mask.
</td>
</tr>
<tr>
<td><p><a name="GWY-MASK-INCLUDE:CAPS"></a><span class="term"><code class="literal">GWY_MASK_INCLUDE</code></span></p></td>
<td>Take into account only data under the mask.
</td>
</tr>
<tr>
<td><p><a name="GWY-MASK-IGNORE:CAPS"></a><span class="term"><code class="literal">GWY_MASK_IGNORE</code></span></p></td>
<td>Ignore mask, if present, and use all data.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyWatershedStateType"></a><h3>enum GwyWatershedStateType</h3>
<pre class="programlisting">typedef enum {
GWY_WATERSHED_STATE_INIT,
GWY_WATERSHED_STATE_LOCATE,
GWY_WATERSHED_STATE_MIN,
GWY_WATERSHED_STATE_WATERSHED,
GWY_WATERSHED_STATE_MARK,
GWY_WATERSHED_STATE_FINISHED
} GwyWatershedStateType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-INIT:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_INIT</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-LOCATE:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_LOCATE</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-MIN:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_MIN</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-WATERSHED:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_WATERSHED</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-MARK:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_MARK</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-WATERSHED-STATE-FINISHED:CAPS"></a><span class="term"><code class="literal">GWY_WATERSHED_STATE_FINISHED</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyPlaneSymmetry"></a><h3>enum GwyPlaneSymmetry</h3>
<pre class="programlisting">typedef enum {
GWY_SYMMETRY_AUTO,
GWY_SYMMETRY_PARALLEL,
GWY_SYMMETRY_TRIANGULAR,
GWY_SYMMETRY_SQUARE,
GWY_SYMMETRY_RHOMBIC,
GWY_SYMMETRY_HEXAGONAL,
GWY_SYMMETRY_LAST
} GwyPlaneSymmetry;
</pre>
<p>
Plane symmetry types for rotation correction.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-SYMMETRY-AUTO:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_AUTO</code></span></p></td>
<td>Automatic symmetry selection.
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-PARALLEL:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_PARALLEL</code></span></p></td>
<td>Parallel symmetry, there is one prevalent direction
(bilateral).
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-TRIANGULAR:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_TRIANGULAR</code></span></p></td>
<td>Triangular symmetry, there are three prevalent
directions (unilateral) by 120 degrees.
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-SQUARE:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_SQUARE</code></span></p></td>
<td>Square symmetry, two prevalent directions (bilateral)
oriented approximately along image sides.
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-RHOMBIC:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_RHOMBIC</code></span></p></td>
<td>Rhombic symmetry, two prevalent directions
(bilateral) oriented approximately along diagonals.
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-HEXAGONAL:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_HEXAGONAL</code></span></p></td>
<td>Hexagonal symmetry, three prevalent directions
(bilateral) by 120 degrees.
</td>
</tr>
<tr>
<td><p><a name="GWY-SYMMETRY-LAST:CAPS"></a><span class="term"><code class="literal">GWY_SYMMETRY_LAST</code></span></p></td>
<td>The number of symmetries.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="Gwy2DCWTWaveletType"></a><h3>enum Gwy2DCWTWaveletType</h3>
<pre class="programlisting">typedef enum {
/*< lowercase_name=gwy_2d_cwt_wavelet_type >*/
GWY_2DCWT_GAUSS,
GWY_2DCWT_HAT
} Gwy2DCWTWaveletType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-2DCWT-GAUSS:CAPS"></a><span class="term"><code class="literal">GWY_2DCWT_GAUSS</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-2DCWT-HAT:CAPS"></a><span class="term"><code class="literal">GWY_2DCWT_HAT</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyOrientation"></a><h3>enum GwyOrientation</h3>
<pre class="programlisting">typedef enum {
GWY_ORIENTATION_HORIZONTAL,
GWY_ORIENTATION_VERTICAL
} GwyOrientation;
</pre>
<p>
Orientation type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-ORIENTATION-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">GWY_ORIENTATION_HORIZONTAL</code></span></p></td>
<td>Horizontal orientation.
</td>
</tr>
<tr>
<td><p><a name="GWY-ORIENTATION-VERTICAL:CAPS"></a><span class="term"><code class="literal">GWY_ORIENTATION_VERTICAL</code></span></p></td>
<td>Vertical orientation.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyTransformDirection"></a><h3>enum GwyTransformDirection</h3>
<pre class="programlisting">typedef enum {
GWY_TRANSFORM_DIRECTION_BACKWARD = -1,
GWY_TRANSFORM_DIRECTION_FORWARD = 1
} GwyTransformDirection;
</pre>
<p>
Transform (namely integral transform) direction.
</p>
<p>
In FFT, it is equal to sign of the exponent, that is the backward transform
uses -1, the forward transform +1.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-TRANSFORM-DIRECTION-BACKWARD:CAPS"></a><span class="term"><code class="literal">GWY_TRANSFORM_DIRECTION_BACKWARD</code></span></p></td>
<td>Backward (inverse) transform.
</td>
</tr>
<tr>
<td><p><a name="GWY-TRANSFORM-DIRECTION-FORWARD:CAPS"></a><span class="term"><code class="literal">GWY_TRANSFORM_DIRECTION_FORWARD</code></span></p></td>
<td>Forward (direct) transform.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyDataFieldCached"></a><h3>enum GwyDataFieldCached</h3>
<pre class="programlisting">typedef enum {
GWY_DATA_FIELD_CACHE_MIN = 0,
GWY_DATA_FIELD_CACHE_MAX,
GWY_DATA_FIELD_CACHE_SUM,
GWY_DATA_FIELD_CACHE_RMS,
GWY_DATA_FIELD_CACHE_MED,
GWY_DATA_FIELD_CACHE_ARF,
GWY_DATA_FIELD_CACHE_ART,
GWY_DATA_FIELD_CACHE_ARE,
GWY_DATA_FIELD_CACHE_SIZE = 30
} GwyDataFieldCached;
</pre>
<p>
Cached data field quantity type.
</p>
<p>
There should be little need to this enum directly except in libgwyprocess
methods.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-MIN:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_MIN</code></span></p></td>
<td>Overall minimum.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-MAX:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_MAX</code></span></p></td>
<td>Overall maximum.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-SUM:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_SUM</code></span></p></td>
<td>Sum of all values.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-RMS:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_RMS</code></span></p></td>
<td>Root mean square.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-MED:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_MED</code></span></p></td>
<td>Median.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-ARF:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_ARF</code></span></p></td>
<td>Auto-range from.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-ART:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_ART</code></span></p></td>
<td>Auto-range to.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-ARE:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_ARE</code></span></p></td>
<td>Surface area.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-FIELD-CACHE-SIZE:CAPS"></a><span class="term"><code class="literal">GWY_DATA_FIELD_CACHE_SIZE</code></span></p></td>
<td>The size of statistics cache.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyComputationStateType"></a><h3>enum GwyComputationStateType</h3>
<pre class="programlisting">typedef enum {
GWY_COMPUTATION_STATE_INIT,
GWY_COMPUTATION_STATE_ITERATE,
GWY_COMPUTATION_STATE_FINISHED
} GwyComputationStateType;
</pre>
<p>
Common iterative computation iterator state type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-COMPUTATION-STATE-INIT:CAPS"></a><span class="term"><code class="literal">GWY_COMPUTATION_STATE_INIT</code></span></p></td>
<td>Iterator was set up, the next step will
actually create temporary data structures
and precalculate values.
</td>
</tr>
<tr>
<td><p><a name="GWY-COMPUTATION-STATE-ITERATE:CAPS"></a><span class="term"><code class="literal">GWY_COMPUTATION_STATE_ITERATE</code></span></p></td>
<td>Iteration is in progress, the <em class="parameter"><code>fraction</code></em>
field of state struct holds the fraction
completed.
</td>
</tr>
<tr>
<td><p><a name="GWY-COMPUTATION-STATE-FINISHED:CAPS"></a><span class="term"><code class="literal">GWY_COMPUTATION_STATE_FINISHED</code></span></p></td>
<td>Calculation has been finished, further
calls to the iterator will be no-op.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyDWTType"></a><h3>enum GwyDWTType</h3>
<pre class="programlisting">typedef enum {
GWY_DWT_HAAR,
GWY_DWT_DAUB4,
GWY_DWT_DAUB6,
GWY_DWT_DAUB8,
GWY_DWT_DAUB12,
GWY_DWT_DAUB20
} GwyDWTType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-DWT-HAAR:CAPS"></a><span class="term"><code class="literal">GWY_DWT_HAAR</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DAUB4:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DAUB4</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DAUB6:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DAUB6</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DAUB8:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DAUB8</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DAUB12:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DAUB12</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DAUB20:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DAUB20</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyDWTDenoiseType"></a><h3>enum GwyDWTDenoiseType</h3>
<pre class="programlisting">typedef enum {
GWY_DWT_DENOISE_UNIVERSAL,
GWY_DWT_DENOISE_SCALE_ADAPTIVE,
GWY_DWT_DENOISE_SPACE_ADAPTIVE
} GwyDWTDenoiseType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-DWT-DENOISE-UNIVERSAL:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DENOISE_UNIVERSAL</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DENOISE-SCALE-ADAPTIVE:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DENOISE_SCALE_ADAPTIVE</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-DWT-DENOISE-SPACE-ADAPTIVE:CAPS"></a><span class="term"><code class="literal">GWY_DWT_DENOISE_SPACE_ADAPTIVE</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyInterpolationType"></a><h3>enum GwyInterpolationType</h3>
<pre class="programlisting">typedef enum {
GWY_INTERPOLATION_NONE = 0,
GWY_INTERPOLATION_ROUND = 1,
GWY_INTERPOLATION_LINEAR = 2,
GWY_INTERPOLATION_BILINEAR = GWY_INTERPOLATION_LINEAR,
GWY_INTERPOLATION_KEY = 3,
GWY_INTERPOLATION_BSPLINE = 4,
GWY_INTERPOLATION_OMOMS = 5,
GWY_INTERPOLATION_NNA = 6,
GWY_INTERPOLATION_SCHAUM = 7
} GwyInterpolationType;
</pre>
<p>
Interpolation types.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-INTERPOLATION-NONE:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_NONE</code></span></p></td>
<td>No interpolation at all, resulting values are not
defined, it must not be used for interpolation.
It can be used in resize operations discarding
original data.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-ROUND:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_ROUND</code></span></p></td>
<td>Round interpolation (more precisely symmetric
nearest neighbour interpolation).
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-LINEAR:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_LINEAR</code></span></p></td>
<td>Linear interpolation.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-BILINEAR:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_BILINEAR</code></span></p></td>
<td>Old name for <a class="link" href="libgwyprocess-gwyprocessenums.html#GWY-INTERPOLATION-LINEAR:CAPS"><code class="literal">GWY_INTERPOLATION_LINEAR</code></a>. This
is a misnomer because it in fact denotes linear
interpolation of arbitrary dimension. Use
<a class="link" href="libgwyprocess-gwyprocessenums.html#GWY-INTERPOLATION-LINEAR:CAPS"><code class="literal">GWY_INTERPOLATION_LINEAR</code></a> instead.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-KEY:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_KEY</code></span></p></td>
<td>Cubic Key's interpolation (with a=-1/2).
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-BSPLINE:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_BSPLINE</code></span></p></td>
<td>B-spline interpolation.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-OMOMS:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_OMOMS</code></span></p></td>
<td>Omoms interpolation.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-NNA:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_NNA</code></span></p></td>
<td>Nearest neighbour approximation.
</td>
</tr>
<tr>
<td><p><a name="GWY-INTERPOLATION-SCHAUM:CAPS"></a><span class="term"><code class="literal">GWY_INTERPOLATION_SCHAUM</code></span></p></td>
<td>Cubic Schaum interpolation.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyPlaneFitQuantity"></a><h3>enum GwyPlaneFitQuantity</h3>
<pre class="programlisting">typedef enum {
GWY_PLANE_FIT_A = 1,
GWY_PLANE_FIT_BX,
GWY_PLANE_FIT_BY,
GWY_PLANE_FIT_ANGLE,
GWY_PLANE_FIT_SLOPE,
GWY_PLANE_FIT_S0,
GWY_PLANE_FIT_S0_REDUCED
} GwyPlaneFitQuantity;
</pre>
<p>
Local plane fitting quantity to request from
<a class="link" href="libgwyprocess-level.html#gwy-data-field-area-fit-local-planes" title="gwy_data_field_area_fit_local_planes ()"><code class="function">gwy_data_field_area_fit_local_planes()</code></a> and similar functions.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-PLANE-FIT-A:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_A</code></span></p></td>
<td>Constant coefficient (mean value).
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-BX:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_BX</code></span></p></td>
<td>Linear coefficient in x, if x in in pixel coordinates.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-BY:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_BY</code></span></p></td>
<td>Linear coefficient in y, if y is in pixel coordinates.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-ANGLE:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_ANGLE</code></span></p></td>
<td>Slope orientation in (x,y) plane (in radians).
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-SLOPE:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_SLOPE</code></span></p></td>
<td>Absolute slope value (that is sqrt(bx*bx + by*by)).
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-S0:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_S0</code></span></p></td>
<td>Residual sum of squares.
</td>
</tr>
<tr>
<td><p><a name="GWY-PLANE-FIT-S0-REDUCED:CAPS"></a><span class="term"><code class="literal">GWY_PLANE_FIT_S0_REDUCED</code></span></p></td>
<td>Slope-reduced residual sum of squares.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyWindowingType"></a><h3>enum GwyWindowingType</h3>
<pre class="programlisting">typedef enum {
GWY_WINDOWING_NONE = 0,
GWY_WINDOWING_HANN = 1,
GWY_WINDOWING_HAMMING = 2,
GWY_WINDOWING_BLACKMANN = 3,
GWY_WINDOWING_LANCZOS = 4,
GWY_WINDOWING_WELCH = 5,
GWY_WINDOWING_RECT = 6,
GWY_WINDOWING_NUTTALL = 7,
GWY_WINDOWING_FLAT_TOP = 8,
GWY_WINDOWING_KAISER25 = 9
} GwyWindowingType;
</pre>
<p>
Frequency windowing type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-WINDOWING-NONE:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_NONE</code></span></p></td>
<td>No windowing is applied.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-HANN:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_HANN</code></span></p></td>
<td>Hann window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-HAMMING:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_HAMMING</code></span></p></td>
<td>Hamming window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-BLACKMANN:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_BLACKMANN</code></span></p></td>
<td>Blackmann window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-LANCZOS:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_LANCZOS</code></span></p></td>
<td>Lanczos window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-WELCH:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_WELCH</code></span></p></td>
<td>Welch window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-RECT:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_RECT</code></span></p></td>
<td>Rectangular window.
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-NUTTALL:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_NUTTALL</code></span></p></td>
<td>Nuttall window (Since: 2.7).
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-FLAT-TOP:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_FLAT_TOP</code></span></p></td>
<td>Flat-top window (Since: 2.7).
</td>
</tr>
<tr>
<td><p><a name="GWY-WINDOWING-KAISER25:CAPS"></a><span class="term"><code class="literal">GWY_WINDOWING_KAISER25</code></span></p></td>
<td>Kaiser window with β=2.5 (Since: 2.7).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyTipType"></a><h3>enum GwyTipType</h3>
<pre class="programlisting">typedef enum {
GWY_TIP_PYRAMIDE = 0,
GWY_TIP_CONTACT = 1,
GWY_TIP_NONCONTACT = 2,
GWY_TIP_DELTA = 3
} GwyTipType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-TIP-PYRAMIDE:CAPS"></a><span class="term"><code class="literal">GWY_TIP_PYRAMIDE</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-TIP-CONTACT:CAPS"></a><span class="term"><code class="literal">GWY_TIP_CONTACT</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-TIP-NONCONTACT:CAPS"></a><span class="term"><code class="literal">GWY_TIP_NONCONTACT</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-TIP-DELTA:CAPS"></a><span class="term"><code class="literal">GWY_TIP_DELTA</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyCorrelationType"></a><h3>enum GwyCorrelationType</h3>
<pre class="programlisting">typedef enum {
GWY_CORRELATION_NORMAL = 0,
GWY_CORRELATION_FFT = 1,
GWY_CORRELATION_POC = 2
} GwyCorrelationType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-CORRELATION-NORMAL:CAPS"></a><span class="term"><code class="literal">GWY_CORRELATION_NORMAL</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-CORRELATION-FFT:CAPS"></a><span class="term"><code class="literal">GWY_CORRELATION_FFT</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-CORRELATION-POC:CAPS"></a><span class="term"><code class="literal">GWY_CORRELATION_POC</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyGrainQuantity"></a><h3>enum GwyGrainQuantity</h3>
<pre class="programlisting">typedef enum {
GWY_GRAIN_VALUE_PROJECTED_AREA = 0,
GWY_GRAIN_VALUE_EQUIV_SQUARE_SIDE = 1,
GWY_GRAIN_VALUE_EQUIV_DISC_RADIUS = 2,
GWY_GRAIN_VALUE_SURFACE_AREA = 3,
GWY_GRAIN_VALUE_MAXIMUM = 4,
GWY_GRAIN_VALUE_MINIMUM = 5,
GWY_GRAIN_VALUE_MEAN = 6,
GWY_GRAIN_VALUE_MEDIAN = 7,
GWY_GRAIN_VALUE_HALF_HEIGHT_AREA = 9,
GWY_GRAIN_VALUE_FLAT_BOUNDARY_LENGTH = 10,
GWY_GRAIN_VALUE_MINIMUM_BOUND_SIZE = 12,
GWY_GRAIN_VALUE_MINIMUM_BOUND_ANGLE = 13,
GWY_GRAIN_VALUE_MAXIMUM_BOUND_SIZE = 14,
GWY_GRAIN_VALUE_MAXIMUM_BOUND_ANGLE = 15,
GWY_GRAIN_VALUE_CENTER_X = 16,
GWY_GRAIN_VALUE_CENTER_Y = 17,
GWY_GRAIN_VALUE_VOLUME_0 = 18,
GWY_GRAIN_VALUE_VOLUME_MIN = 19,
GWY_GRAIN_VALUE_VOLUME_LAPLACE = 20,
GWY_GRAIN_VALUE_SLOPE_THETA = 23,
GWY_GRAIN_VALUE_SLOPE_PHI = 24,
GWY_GRAIN_VALUE_BOUNDARY_MAXIMUM = 25,
GWY_GRAIN_VALUE_BOUNDARY_MINIMUM = 26,
GWY_GRAIN_VALUE_CURVATURE_CENTER_X = 27,
GWY_GRAIN_VALUE_CURVATURE_CENTER_Y = 28,
GWY_GRAIN_VALUE_CURVATURE_CENTER_Z = 29,
GWY_GRAIN_VALUE_CURVATURE1 = 30,
GWY_GRAIN_VALUE_CURVATURE2 = 31,
GWY_GRAIN_VALUE_CURVATURE_ANGLE1 = 32,
GWY_GRAIN_VALUE_CURVATURE_ANGLE2 = 33,
GWY_GRAIN_VALUE_INSCRIBED_DISC_R = 34,
GWY_GRAIN_VALUE_INSCRIBED_DISC_X = 35,
GWY_GRAIN_VALUE_INSCRIBED_DISC_Y = 36,
GWY_GRAIN_VALUE_CONVEX_HULL_AREA = 37,
GWY_GRAIN_VALUE_CIRCUMCIRCLE_R = 38,
GWY_GRAIN_VALUE_CIRCUMCIRCLE_X = 39,
GWY_GRAIN_VALUE_CIRCUMCIRCLE_Y = 40,
GWY_GRAIN_VALUE_MEAN_RADIUS = 41,
} GwyGrainQuantity;
</pre>
<p>
Grain quantity to request from <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-distribution" title="gwy_data_field_grains_get_distribution ()"><code class="function">gwy_data_field_grains_get_distribution()</code></a>
and similar functions.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-PROJECTED-AREA:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_PROJECTED_AREA</code></span></p></td>
<td>Projected (flat) grain area.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-EQUIV-SQUARE-SIDE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_EQUIV_SQUARE_SIDE</code></span></p></td>
<td>Side of a square with the same area
as the grain.
Future changes:
This quantity can be trivially
calculated from
<em class="parameter"><code>GWY_GRAIN_VALUE_PROJECTED_AREA</code></em>
and will be likely removed in 3.0.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-EQUIV-DISC-RADIUS:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_EQUIV_DISC_RADIUS</code></span></p></td>
<td>Radius of a disc with the same area
as the grain.
Future changes:
This quantity can be trivially
calculated from
<em class="parameter"><code>GWY_GRAIN_VALUE_PROJECTED_AREA</code></em>
and will be likely removed in 3.0.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-SURFACE-AREA:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_SURFACE_AREA</code></span></p></td>
<td>Surface area.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MAXIMUM:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MAXIMUM</code></span></p></td>
<td>Minimum value.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MINIMUM:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MINIMUM</code></span></p></td>
<td>Maximum value.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MEAN:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MEAN</code></span></p></td>
<td>Mean value.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MEDIAN:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MEDIAN</code></span></p></td>
<td>Median value.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-HALF-HEIGHT-AREA:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_HALF_HEIGHT_AREA</code></span></p></td>
<td>Projected area of the part of grain
that is above the half-height, i.e.
the height between the minimum and
maximum (Since: 2.8).
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-FLAT-BOUNDARY-LENGTH:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_FLAT_BOUNDARY_LENGTH</code></span></p></td>
<td>Length of projected grain boundary.
Note for grains not topologically
equivalent to disc, only the length
of the outer boundary is calculated.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MINIMUM-BOUND-SIZE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MINIMUM_BOUND_SIZE</code></span></p></td>
<td>Minimum lateral bounding size, in other
words the minimum length of grain
projection to any line in the
horizontal plane.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MINIMUM-BOUND-ANGLE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MINIMUM_BOUND_ANGLE</code></span></p></td>
<td>Direction of the minimum lateral
bounding size (arbitrary one if the
minimum is not unique).
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MAXIMUM-BOUND-SIZE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MAXIMUM_BOUND_SIZE</code></span></p></td>
<td>Maximum lateral bounding size, in other
words the maximum length of grain
projection to any line in the
horizontal plane.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MAXIMUM-BOUND-ANGLE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MAXIMUM_BOUND_ANGLE</code></span></p></td>
<td>Direction of the maximum lateral
bounding size (arbitrary one if the
maximum is not unique).
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CENTER-X:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CENTER_X</code></span></p></td>
<td>Grain centre horizontal position,
i.e. the mean value of its physical x-coordinates.
(Since: 2.7)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CENTER-Y:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CENTER_Y</code></span></p></td>
<td>Grain centre vertical position,
i.e. the mean value of its physical y-coordinates.
(Since: 2.7)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-VOLUME-0:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_VOLUME_0</code></span></p></td>
<td>Grain volume calculated with grain basis at
z=0 (therefore it is just an integral it can be
negative). (Since: 2.3)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-VOLUME-MIN:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_VOLUME_MIN</code></span></p></td>
<td>Grain volume calculated with grain basis at
grain minimum value. This value is a lower
bound. (Since: 2.3)
Future changes:
This quantity can be trivially calculated from
<em class="parameter"><code>GWY_GRAIN_VALUE_VOLUME_0</code></em>,
<em class="parameter"><code>GWY_GRAIN_VALUE_PROJECTED_AREA</code></em>
and <em class="parameter"><code>GWY_GRAIN_VALUE_MINIMUM</code></em>
and will be likely removed in 3.0.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-VOLUME-LAPLACE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_VOLUME_LAPLACE</code></span></p></td>
<td>Grain volume calculated with grain basis
calculated by laplacian interpolation of
surrounding values. (Since: 2.3)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-SLOPE-THETA:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_SLOPE_THETA</code></span></p></td>
<td>Spherical angle theta of grain normal (0 is
upwards). (Since: 2.7)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-SLOPE-PHI:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_SLOPE_PHI</code></span></p></td>
<td>Spherical angle phi of grain normal (0 is
in positive x direction). (Since: 2.7)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-BOUNDARY-MAXIMUM:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_BOUNDARY_MAXIMUM</code></span></p></td>
<td>Maximum value in the grain inner
boundary. (Since: 2.12)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-BOUNDARY-MINIMUM:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_BOUNDARY_MINIMUM</code></span></p></td>
<td>Minimum value on the grain inner
boundary. (Since: 2.12)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE-CENTER-X:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE_CENTER_X</code></span></p></td>
<td>Grain curvature centre horizontal
position. For too small or flat grains
it reduces to the horizontal position
of geometrical centre.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE-CENTER-Y:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE_CENTER_Y</code></span></p></td>
<td>Grain curvature centre vertical
position. For too small or flat grains
it reduces to the vertical position
of geometrical centre.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE-CENTER-Z:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE_CENTER_Z</code></span></p></td>
<td>The value at curvature centre. Note
this is the value in the origin of the
fitted quadratic surface, not at the
real surface.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE1:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE1</code></span></p></td>
<td>Smaller grain curvature.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE2:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE2</code></span></p></td>
<td>Larger grain curvature.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE-ANGLE1:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE_ANGLE1</code></span></p></td>
<td>Direction of the smaller grain curvature
radius. If the grain is flat or too
small the angle is reported as 0.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CURVATURE-ANGLE2:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CURVATURE_ANGLE2</code></span></p></td>
<td>Direction of the larger grain curvature
radius. If the grain is flat or too
small the angle is reported as π/2.
(Since: 2.22)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-INSCRIBED-DISC-R:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_INSCRIBED_DISC_R</code></span></p></td>
<td>Radius of maximum disc
that fits inside the grain (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-INSCRIBED-DISC-X:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_INSCRIBED_DISC_X</code></span></p></td>
<td>Real X-coordinate of the centre of the
maximum inscribed disc. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-INSCRIBED-DISC-Y:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_INSCRIBED_DISC_Y</code></span></p></td>
<td>Real Y-coordinate of the centre of the
maximum inscribed disc. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CONVEX-HULL-AREA:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CONVEX_HULL_AREA</code></span></p></td>
<td>Projected (flat) area of grain convex
hull. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CIRCUMCIRCLE-R:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CIRCUMCIRCLE_R</code></span></p></td>
<td>Radius of minimum circle containing the
grain. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CIRCUMCIRCLE-X:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CIRCUMCIRCLE_X</code></span></p></td>
<td>Real X-coordinate of the centre of the
minimum circumcircle. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-CIRCUMCIRCLE-Y:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_CIRCUMCIRCLE_Y</code></span></p></td>
<td>Real Y-coordinate of the centre of the
minimum circumcircle. (Since: 2.30)
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-MEAN-RADIUS:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_MEAN_RADIUS</code></span></p></td>
<td>Mean distance from boundary to the grain
centre as defined by
<em class="parameter"><code>GWY_GRAIN_VALUE_CENTER_X</code></em> and
<em class="parameter"><code>GWY_GRAIN_VALUE_CENTER_Y</code></em>. (Since: 2.30)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyDataCompatibilityFlags"></a><h3>enum GwyDataCompatibilityFlags</h3>
<pre class="programlisting">typedef enum {
GWY_DATA_COMPATIBILITY_RES = 1 << 0,
GWY_DATA_COMPATIBILITY_REAL = 1 << 1,
GWY_DATA_COMPATIBILITY_MEASURE = 1 << 2,
GWY_DATA_COMPATIBILITY_LATERAL = 1 << 3,
GWY_DATA_COMPATIBILITY_VALUE = 1 << 4,
GWY_DATA_COMPATIBILITY_ALL = 0x001f
} GwyDataCompatibilityFlags;
</pre>
<p>
Data line and field compatibility flags.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-RES:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_RES</code></span></p></td>
<td>Pixel sizes.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-REAL:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_REAL</code></span></p></td>
<td>Real (physical) dimensions.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-MEASURE:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_MEASURE</code></span></p></td>
<td>Real to pixel ratios.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-LATERAL:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_LATERAL</code></span></p></td>
<td>Units of lateral dimensions.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-VALUE:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_VALUE</code></span></p></td>
<td>Units of values.
</td>
</tr>
<tr>
<td><p><a name="GWY-DATA-COMPATIBILITY-ALL:CAPS"></a><span class="term"><code class="literal">GWY_DATA_COMPATIBILITY_ALL</code></span></p></td>
<td>Mask of all defined flags.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyLineStatQuantity"></a><h3>enum GwyLineStatQuantity</h3>
<pre class="programlisting">typedef enum {
GWY_LINE_STAT_MEAN,
GWY_LINE_STAT_MEDIAN,
GWY_LINE_STAT_MINIMUM,
GWY_LINE_STAT_MAXIMUM,
GWY_LINE_STAT_RMS,
GWY_LINE_STAT_LENGTH,
GWY_LINE_STAT_SLOPE,
GWY_LINE_STAT_TAN_BETA0,
GWY_LINE_STAT_RA,
GWY_LINE_STAT_RZ,
GWY_LINE_STAT_RT,
GWY_LINE_STAT_SKEW,
GWY_LINE_STAT_KURTOSIS
} GwyLineStatQuantity;
</pre>
<p>
Line statistical quantities to be requested with
<a class="link" href="libgwyprocess-stats.html#gwy-data-field-area-get-line-stats" title="gwy_data_field_area_get_line_stats ()"><code class="function">gwy_data_field_area_get_line_stats()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-LINE-STAT-MEAN:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_MEAN</code></span></p></td>
<td>Mean value.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-MEDIAN:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_MEDIAN</code></span></p></td>
<td>Median.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-MINIMUM:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_MINIMUM</code></span></p></td>
<td>Minimum value.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-MAXIMUM:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_MAXIMUM</code></span></p></td>
<td>Maximum value.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-RMS:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_RMS</code></span></p></td>
<td>Root mean square of deviations from the mean value.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-LENGTH:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_LENGTH</code></span></p></td>
<td>Line length.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-SLOPE:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_SLOPE</code></span></p></td>
<td>Overall line slope.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-TAN-BETA0:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_TAN_BETA0</code></span></p></td>
<td>Root mean square slope.
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-RA:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_RA</code></span></p></td>
<td>Arithmetic mean surface roughness
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-RZ:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_RZ</code></span></p></td>
<td>Maximum height of the roughness profile
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-RT:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_RT</code></span></p></td>
<td>Total height of the roughness profile
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-SKEW:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_SKEW</code></span></p></td>
<td>Line skew
</td>
</tr>
<tr>
<td><p><a name="GWY-LINE-STAT-KURTOSIS:CAPS"></a><span class="term"><code class="literal">GWY_LINE_STAT_KURTOSIS</code></span></p></td>
<td>Line kurtosis
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyExteriorType"></a><h3>enum GwyExteriorType</h3>
<pre class="programlisting">typedef enum {
GWY_EXTERIOR_UNDEFINED,
GWY_EXTERIOR_BORDER_EXTEND,
GWY_EXTERIOR_MIRROR_EXTEND,
GWY_EXTERIOR_PERIODIC,
GWY_EXTERIOR_FIXED_VALUE
} GwyExteriorType;
</pre>
<p>
Methods to handle pixels outside data.
</p>
<p>
Many methods currently use a fixed metod of handling of exterior pixels,
for example area calculation uses extension (border and mirror coincide),
convolution uses mirror extension, rotation fills exterior with
a fixed value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-EXTERIOR-UNDEFINED:CAPS"></a><span class="term"><code class="literal">GWY_EXTERIOR_UNDEFINED</code></span></p></td>
<td>The values corresponding to or calculated from
exterior data values are undefined, they may be
left unset or set to bogus values. The caller
must handle them itself afterwards, for instance
by resizing the result to consist of valid data
only.
</td>
</tr>
<tr>
<td><p><a name="GWY-EXTERIOR-BORDER-EXTEND:CAPS"></a><span class="term"><code class="literal">GWY_EXTERIOR_BORDER_EXTEND</code></span></p></td>
<td>Values of exterior pixels are considered to be
equal to the values of the nearest interior
pixels.
</td>
</tr>
<tr>
<td><p><a name="GWY-EXTERIOR-MIRROR-EXTEND:CAPS"></a><span class="term"><code class="literal">GWY_EXTERIOR_MIRROR_EXTEND</code></span></p></td>
<td>The data is considered to be periodically
repeated, with odd instances reflected
(the total period is thus twice the size of
the data).
</td>
</tr>
<tr>
<td><p><a name="GWY-EXTERIOR-PERIODIC:CAPS"></a><span class="term"><code class="literal">GWY_EXTERIOR_PERIODIC</code></span></p></td>
<td>The data is considered to be periodically repeated.
</td>
</tr>
<tr>
<td><p><a name="GWY-EXTERIOR-FIXED-VALUE:CAPS"></a><span class="term"><code class="literal">GWY_EXTERIOR_FIXED_VALUE</code></span></p></td>
<td>Values of exterior pixels are considered to
be all equal to a user-specified value.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-merge-type-get-enum"></a><h3>gwy_merge_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_merge_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyMergeType" title="enum GwyMergeType"><span class="type">GwyMergeType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-masking-type-get-enum"></a><h3>gwy_masking_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_masking_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyMaskingType" title="enum GwyMaskingType"><span class="type">GwyMaskingType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.18</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-plane-symmetry-get-enum"></a><h3>gwy_plane_symmetry_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_plane_symmetry_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyPlaneSymmetry" title="enum GwyPlaneSymmetry"><span class="type">GwyPlaneSymmetry</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-2d-cwt-wavelet-type-get-enum"></a><h3>gwy_2d_cwt_wavelet_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_2d_cwt_wavelet_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#Gwy2DCWTWaveletType" title="enum Gwy2DCWTWaveletType"><span class="type">Gwy2DCWTWaveletType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-orientation-get-enum"></a><h3>gwy_orientation_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_orientation_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyOrientation" title="enum GwyOrientation"><span class="type">GwyOrientation</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-dwt-type-get-enum"></a><h3>gwy_dwt_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_dwt_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTType" title="enum GwyDWTType"><span class="type">GwyDWTType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-dwt-denoise-type-get-enum"></a><h3>gwy_dwt_denoise_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_dwt_denoise_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTDenoiseType" title="enum GwyDWTDenoiseType"><span class="type">GwyDWTDenoiseType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-interpolation-type-get-enum"></a><h3>gwy_interpolation_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_interpolation_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyInterpolationType" title="enum GwyInterpolationType"><span class="type">GwyInterpolationType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-windowing-type-get-enum"></a><h3>gwy_windowing_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_windowing_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> for <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyWindowingType" title="enum GwyWindowingType"><span class="type">GwyWindowingType</span></a> enum type.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated <a href="../libgwyddion/GwyEnum.html"><span class="type">GwyEnum</span></a> which must not be modified nor freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-correlation-type-get-enum"></a><h3>gwy_correlation_type_get_enum ()</h3>
<pre class="programlisting">const <a href="../libgwyddion/GwyEnum.html"><span class="returnvalue">GwyEnum</span></a> * gwy_correlation_type_get_enum (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyComputationState"></a><h3>GwyComputationState</h3>
<pre class="programlisting">typedef struct {
guint state;
gdouble fraction;
} GwyComputationState;
</pre>
<p>
State of iterative computation.
</p>
<p>
Iterators usually append their own private state data, therefore it must
not be assumed the public fields <em class="parameter"><code>state</code></em> and <em class="parameter"><code>fraction</code></em> are the only fields.
</p>
<p>
A typical iteration, assuming an iterative computation `foo' with the
default <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationStateType" title="enum GwyComputationStateType"><span class="type">GwyComputationStateType</span></a> state could be:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GwyComputationStateType</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">state</span><span class="symbol">;</span>
<span class="normal">state </span><span class="symbol">=</span><span class="normal"> </span><span class="function">gwy_data_field_foo_init</span><span class="symbol">(</span><span class="usertype">GwyDataField</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">data_field</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">...);</span>
<span class="keyword">do</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="function">gwy_data_field_foo_iteration</span><span class="symbol">(</span><span class="normal">state</span><span class="symbol">);</span>
<span class="normal"> </span><span class="comment">/* Update progress using state->fraction,</span>
<span class="comment"> let Gtk+ main loop run, check for abort, ... */</span>
<span class="normal"> </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">aborted</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="function">gwy_data_field_foo_finalize</span><span class="symbol">(</span><span class="normal">state</span><span class="symbol">);</span>
<span class="normal"> </span><span class="keyword">return</span><span class="normal"> <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">;</span>
<span class="normal"> </span><span class="cbracket">}</span>
<span class="cbracket">}</span><span class="normal"> </span><span class="keyword">while</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">state</span><span class="symbol">-></span><span class="normal">state </span><span class="symbol">!=</span><span class="normal"> <a href="#GWY-COMPUTATION-STATE-FINISHED:CAPS">GWY_COMPUTATION_STATE_FINISHED</a></span><span class="symbol">);</span>
<span class="function">gwy_data_field_foo_finalize</span><span class="symbol">(</span><span class="normal">state</span><span class="symbol">);</span>
<span class="keyword">return</span><span class="normal"> <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">;</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GwyComputationState.state"></a>state</code></em>;</span></p></td>
<td>Current computation state, usually of <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationStateType" title="enum GwyComputationStateType"><span class="type">GwyComputationStateType</span></a>, but
particular iterators can define their own types.</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> <em class="structfield"><code><a name="GwyComputationState.fraction"></a>fraction</code></em>;</span></p></td>
<td>Fraction of computation completed. For staged algorithms,
the fraction refers to the current stage only.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|