/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-grains.html is in libgwyddion20-doc 2.26-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>grains</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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-fractals.html" title="fractals">
<link rel="next" href="GwyGrainValue.html" title="GwyGrainValue">
<meta name="generator" content="GTK-Doc V1.8 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgwyprocess-fractals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Data Processing Library Reference Manual</th>
<td><a accesskey="n" href="GwyGrainValue.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyprocess-grains.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyprocess-grains.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyprocess-grains"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-grains.top_of_page"></a>grains</span></h2>
<p>grains — Grain detection and processing</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-grains.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-area-grains-tgnd" title="gwy_data_field_area_grains_tgnd ()">gwy_data_field_area_grains_tgnd</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *target_line</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-area-grains-tgnd-range" title="gwy_data_field_area_grains_tgnd_range ()">gwy_data_field_area_grains_tgnd_range</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *target_line</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> min</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> max</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> * <a class="link" href="libgwyprocess-grains.html#gwy-data-field-get-grain-bounding-boxes" title="gwy_data_field_get_grain_bounding_boxes ()">gwy_data_field_get_grain_bounding_boxes</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask_field</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *bboxes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-add" title="gwy_data_field_grains_add ()">gwy_data_field_grains_add</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *add_field</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-extract-grain" title="gwy_data_field_grains_extract_grain ()">gwy_data_field_grains_extract_grain</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);
<a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-distribution" title="gwy_data_field_grains_get_distribution ()">gwy_data_field_grains_get_distribution</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *distribution</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> ** <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-quantities" title="gwy_data_field_grains_get_quantities ()">gwy_data_field_grains_get_quantities</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> **values</code></em>,
<em class="parameter"><code>const <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> *quantities</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nquantities</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> * <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-values" title="gwy_data_field_grains_get_values ()">gwy_data_field_grains_get_values</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *values</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-intersect" title="gwy_data_field_grains_intersect ()">gwy_data_field_grains_intersect</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *intersect_field</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-mark-curvature" title="gwy_data_field_grains_mark_curvature ()">gwy_data_field_grains_mark_curvature</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-mark-height" title="gwy_data_field_grains_mark_height ()">gwy_data_field_grains_mark_height</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-mark-slope" title="gwy_data_field_grains_mark_slope ()">gwy_data_field_grains_mark_slope</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-mark-watershed" title="gwy_data_field_grains_mark_watershed ()">gwy_data_field_grains_mark_watershed</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_thresh</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> wshed_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> wshed_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> prefilter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-remove-by-height" title="gwy_data_field_grains_remove_by_height ()">gwy_data_field_grains_remove_by_height</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-remove-by-size" title="gwy_data_field_grains_remove_by_size ()">gwy_data_field_grains_remove_by_size</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-remove-grain" title="gwy_data_field_grains_remove_grain ()">gwy_data_field_grains_remove_grain</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-splash-water" title="gwy_data_field_grains_splash_water ()">gwy_data_field_grains_splash_water</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *minima</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-watershed-finalize" title="gwy_data_field_grains_watershed_finalize ()">gwy_data_field_grains_watershed_finalize</a>
(<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="type">GwyComputationState</span></a> *state</code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-watershed-init" title="gwy_data_field_grains_watershed_init ()">gwy_data_field_grains_watershed_init</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_thresh</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> wshed_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> wshed_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> prefilter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-watershed-iteration" title="gwy_data_field_grains_watershed_iteration ()">gwy_data_field_grains_watershed_iteration</a>
(<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="type">GwyComputationState</span></a> *state</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()">gwy_data_field_number_grains</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>);
<a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="returnvalue">GwySIUnit</span></a> * <a class="link" href="libgwyprocess-grains.html#gwy-grain-quantity-get-units" title="gwy_grain_quantity_get_units ()">gwy_grain_quantity_get_units</a> (<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *siunitxy</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *siunitz</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *result</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyprocess-grains.html#gwy-grain-quantity-needs-same-units" title="gwy_grain_quantity_needs_same_units ()">gwy_grain_quantity_needs_same_units</a> (<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-grains.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyprocess-grains.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-data-field-area-grains-tgnd"></a><h3>gwy_data_field_area_grains_tgnd ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_area_grains_tgnd (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *target_line</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);</pre>
<p>
Calculates threshold grain number distribution.
</p>
<p>
This function is a simple <a class="link" href="libgwyprocess-grains.html#gwy-data-field-area-grains-tgnd-range" title="gwy_data_field_area_grains_tgnd_range ()"><code class="function">gwy_data_field_area_grains_tgnd_range()</code></a> that
calculates the distribution in the full range.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_line</code></em> :</span></p></td>
<td>A data line to store the distribution to. It will be
resampled to the requested width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Upper-left column coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left row coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Area width (number of columns).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Area height (number of rows).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, valleys are marked, otherwise mountains are marked.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nstats</code></em> :</span></p></td>
<td>The number of samples to take on the distribution function. If
nonpositive, a suitable resolution is determined automatically.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-area-grains-tgnd-range"></a><h3>gwy_data_field_area_grains_tgnd_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_area_grains_tgnd_range
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *target_line</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> min</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> max</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);</pre>
<p>
Calculates threshold grain number distribution in given height range.
</p>
<p>
This is the number of grains for each of <em class="parameter"><code>nstats</code></em> equidistant height
threshold levels. For large <em class="parameter"><code>nstats</code></em> this function is much faster than the
equivalent number of <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-mark-height" title="gwy_data_field_grains_mark_height ()"><code class="function">gwy_data_field_grains_mark_height()</code></a> calls.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_line</code></em> :</span></p></td>
<td>A data line to store the distribution to. It will be
resampled to the requested width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Upper-left column coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left row coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Area width (number of columns).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Area height (number of rows).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td>Minimum threshold value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>Maximum threshold value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, valleys are marked, otherwise mountains are marked.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nstats</code></em> :</span></p></td>
<td>The number of samples to take on the distribution function. If
nonpositive, a suitable resolution is determined automatically.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-get-grain-bounding-boxes"></a><h3>gwy_data_field_get_grain_bounding_boxes ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> * gwy_data_field_get_grain_bounding_boxes
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *bboxes</code></em>);</pre>
<p>
Find bounding boxes of all grains.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_field</code></em> :</span></p></td>
<td>Data field containing positive values in grains, nonpositive
in free space. However its contents is ignored as all
grain information is taken from <em class="parameter"><code>grains</code></em> (its dimensions
determine the dimensions of <em class="parameter"><code>grains</code></em>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ngrains</code></em> :</span></p></td>
<td>The number of grains as returned by
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grains</code></em> :</span></p></td>
<td>Grain numbers filled with <a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bboxes</code></em> :</span></p></td>
<td>Array of size at least 4*(<em class="parameter"><code>ngrains</code></em>+1) to fill with grain bounding
boxes (as usual zero does not correspond to any grain, grains
start from 1). The bounding boxes are stored as quadruples of
indices: (xmin, ymin, width, height). It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate
a new array.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Either <code class="literal">bboxes</code> (if it was not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>), or a newly allocated array
of size 4<em class="parameter"><code>ngrains</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-add"></a><h3>gwy_data_field_grains_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_add (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *add_field</code></em>);</pre>
<p>
Adds <em class="parameter"><code>add_field</code></em> grains to <em class="parameter"><code>grain_field</code></em>.
</p>
<p>
Note: This function is equivalent to
<code class="literal">gwy_data_field_max_of_fields(grain_field, grain_field, add_field);</code>
and it will be probably removed someday.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Field of marked grains (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>add_field</code></em> :</span></p></td>
<td>Field of marked grains (mask) to be added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-extract-grain"></a><h3>gwy_data_field_grains_extract_grain ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_data_field_grains_extract_grain (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);</pre>
<p>
Removes all grains except that one at given position.
</p>
<p>
If there is no grain at (<em class="parameter"><code>col</code></em>, <em class="parameter"><code>row</code></em>), all grains are removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Field of marked grains (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Column inside a grain.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Row inside a grain.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a grain remained (i.e., (<em class="parameter"><code>col</code></em>,<em class="parameter"><code>row</code></em>) was inside a grain).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-get-distribution"></a><h3>gwy_data_field_grains_get_distribution ()</h3>
<pre class="programlisting"><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * gwy_data_field_grains_get_distribution
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *distribution</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nstats</code></em>);</pre>
<p>
Computes distribution of requested grain characteristics.
</p>
<p>
Puts number of grains vs. grain value data into <em class="parameter"><code>distribution</code></em>, units, scales
and offsets of <em class="parameter"><code>distribution</code></em> are updated accordingly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data field used for marking. For some quantities its values
are not used, but units and physical dimensions are always
taken from it.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Data field (mask) of marked grains. Note if you pass
non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>grains</code></em> all grain information is taken from it and
<em class="parameter"><code>grain_field</code></em> can be even <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>distribution</code></em> :</span></p></td>
<td>Data line to store grain distribution to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ngrains</code></em> :</span></p></td>
<td>The number of grains as returned by
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>. Ignored in <em class="parameter"><code>grains</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grains</code></em> :</span></p></td>
<td>Grain numbers filled with <a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a> if you
have it, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (the function then finds grain numbers itself
which is not efficient for repeated use on the same grain field).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>quantity</code></em> :</span></p></td>
<td>The quantity to calculate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nstats</code></em> :</span></p></td>
<td>The number of samples to take on the distribution function. If
nonpositive, a suitable resolution is determined automatically.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A data line with the distribution: <em class="parameter"><code>distribution</code></em> itself if it was
not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, otherwise a newly created <a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> caller must
destroy. If there are no grains, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned and
<em class="parameter"><code>distribution</code></em> is not changed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-get-quantities"></a><h3>gwy_data_field_grains_get_quantities ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> ** gwy_data_field_grains_get_quantities
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> **values</code></em>,
<em class="parameter"><code>const <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> *quantities</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nquantities</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>);</pre>
<p>
Calculates multiple characteristics of grains simultaneously.
</p>
<p>
See <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-values" title="gwy_data_field_grains_get_values ()"><code class="function">gwy_data_field_grains_get_values()</code></a> for some discussion. This function
is more efficient if several grain quantities need to be calculated since
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-values" title="gwy_data_field_grains_get_values ()"><code class="function">gwy_data_field_grains_get_values()</code></a> can do lot of repeated work in such case.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data field used for marking. For some quantities its values
are not used, but its dimensions determine the dimensions of
<em class="parameter"><code>grains</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
<td>Array of <em class="parameter"><code>nquantities</code></em> pointers to blocks of length <em class="parameter"><code>ngrains</code></em>+1 to
put the calculated grain values to. Each block corresponds to one
requested quantity. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> can be passed to allocate and return a
new array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>quantities</code></em> :</span></p></td>
<td>Array of <em class="parameter"><code>nquantities</code></em> items that specify the requested
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> to put to corresponding items in <em class="parameter"><code>values</code></em>.
Quantities can repeat.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nquantities</code></em> :</span></p></td>
<td>The number of requested different grain values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ngrains</code></em> :</span></p></td>
<td>The number of grains as returned by
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grains</code></em> :</span></p></td>
<td>Grain numbers filled with <a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>values</code></em> itself if it was not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, otherwise a newly allocated
array that caller has to free with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>, including the
contained arrays.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-get-values"></a><h3>gwy_data_field_grains_get_values ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> * gwy_data_field_grains_get_values (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *values</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ngrains</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>);</pre>
<p>
Calculates characteristics of grains.
</p>
<p>
This is a bit low-level function, see also
<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>.
</p>
<p>
The array <em class="parameter"><code>values</code></em> will be filled with the requested grain value for each
individual grain (0th item of <em class="parameter"><code>values</code></em> which does not correspond to any grain
will be overwritten with an arbitrary value and should be ignored).
</p>
<p>
The grain numbers serve as indices in <em class="parameter"><code>values</code></em>. Therefore as long as the
same <em class="parameter"><code>grains</code></em> is used, the same position in <em class="parameter"><code>values</code></em> corresponds to the same
particular grain. This enables one for instance to calculate grain sizes
and grain heights and then correlate them.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data field used for marking. For some quantities its values
are not used, but its dimensions determine the dimensions of
<em class="parameter"><code>grains</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
<td>Array of size <em class="parameter"><code>ngrains</code></em>+1 to put grain values to. It can be
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate and return a new array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ngrains</code></em> :</span></p></td>
<td>The number of grains as returned by
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grains</code></em> :</span></p></td>
<td>Grain numbers filled with <a class="link" href="libgwyprocess-grains.html#gwy-data-field-number-grains" title="gwy_data_field_number_grains ()"><code class="function">gwy_data_field_number_grains()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>quantity</code></em> :</span></p></td>
<td>The quantity to calculate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>values</code></em> itself if it was not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, otherwise a newly allocated
array that caller has to free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-intersect"></a><h3>gwy_data_field_grains_intersect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_intersect (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *intersect_field</code></em>);</pre>
<p>
Performs intersection betweet two grain fields,
result is stored in <em class="parameter"><code>grain_field</code></em>.
</p>
<p>
Note: This function is equivalent to
<code class="literal">gwy_data_field_min_of_fields(grain_field, grain_field, intersect_field);</code>
and it will be probably removed someday.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>field of marked grains (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>intersect_field</code></em> :</span></p></td>
<td>Field of marked grains (mask).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-mark-curvature"></a><h3>gwy_data_field_grains_mark_curvature ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_mark_curvature
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Marks data that are above/below curvature threshold.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Data field to store the resulting mask to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>threshval</code></em> :</span></p></td>
<td>Relative curvature threshold, in percents.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, data below threshold are marked, otherwise data above
threshold are marked.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-mark-height"></a><h3>gwy_data_field_grains_mark_height ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_mark_height (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Marks data that are above/below height threshold.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Data field to store the resulting mask to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>threshval</code></em> :</span></p></td>
<td>Relative height threshold, in percents.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, data below threshold are marked, otherwise data above
threshold are marked.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-mark-slope"></a><h3>gwy_data_field_grains_mark_slope ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_mark_slope (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Marks data that are above/below slope threshold.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Data field to store the resulting mask to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>threshval</code></em> :</span></p></td>
<td>Relative slope threshold, in percents.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, data below threshold are marked, otherwise data above
threshold are marked.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-mark-watershed"></a><h3>gwy_data_field_grains_mark_watershed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_mark_watershed
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_thresh</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> wshed_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> wshed_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> prefilter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Performs watershed algorithm.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Result of marking (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_steps</code></em> :</span></p></td>
<td>Locating algorithm steps.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_thresh</code></em> :</span></p></td>
<td>Locating algorithm threshold.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_dropsize</code></em> :</span></p></td>
<td>Locating drop size.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wshed_steps</code></em> :</span></p></td>
<td>Watershed steps.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wshed_dropsize</code></em> :</span></p></td>
<td>Watershed drop size.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefilter</code></em> :</span></p></td>
<td>Use prefiltering.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, valleys are marked, otherwise mountains are marked.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-remove-by-height"></a><h3>gwy_data_field_grains_remove_by_height ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_remove_by_height
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> threshval</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Removes grains that are higher/lower than given threshold value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Field of marked grains (mask)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>threshval</code></em> :</span></p></td>
<td>Relative height threshold, in percents.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, grains below threshold are removed, otherwise grains above
threshold are removed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-remove-by-size"></a><h3>gwy_data_field_grains_remove_by_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_remove_by_size
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);</pre>
<p>
Removes all grain below specified area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Field of marked grains (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>Grain area threshold, in square pixels.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-remove-grain"></a><h3>gwy_data_field_grains_remove_grain ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_data_field_grains_remove_grain (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> col</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);</pre>
<p>
Removes one grain at given position.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Field of marked grains (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Column inside a grain.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Row inside a grain.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a grain was actually removed (i.e., (<em class="parameter"><code>col</code></em>,<em class="parameter"><code>row</code></em>) was
inside a grain).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-splash-water"></a><h3>gwy_data_field_grains_splash_water ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_splash_water (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *minima</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-watershed-finalize"></a><h3>gwy_data_field_grains_watershed_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_watershed_finalize
(<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="type">GwyComputationState</span></a> *state</code></em>);</pre>
<p>
Destroys a watershed iterator, freeing all resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Watershed iterator.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-watershed-init"></a><h3>gwy_data_field_grains_watershed_init ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * gwy_data_field_grains_watershed_init
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *grain_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> locate_thresh</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> locate_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> wshed_steps</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> wshed_dropsize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> prefilter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> below</code></em>);</pre>
<p>
Initializes the watershed algorithm.
</p>
<p>
This iterator reports its state as <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyWatershedStateType" title="enum GwyWatershedStateType"><span class="type">GwyWatershedStateType</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>Data to be used for marking.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grain_field</code></em> :</span></p></td>
<td>Result of marking (mask).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_steps</code></em> :</span></p></td>
<td>Locating algorithm steps.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_thresh</code></em> :</span></p></td>
<td>Locating algorithm threshold.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locate_dropsize</code></em> :</span></p></td>
<td>Locating drop size.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wshed_steps</code></em> :</span></p></td>
<td>Watershed steps.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wshed_dropsize</code></em> :</span></p></td>
<td>Watershed drop size.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefilter</code></em> :</span></p></td>
<td>Use prefiltering.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>below</code></em> :</span></p></td>
<td>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, valleys are marked, otherwise mountains are marked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new watershed iterator.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-grains-watershed-iteration"></a><h3>gwy_data_field_grains_watershed_iteration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_grains_watershed_iteration
(<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="type">GwyComputationState</span></a> *state</code></em>);</pre>
<p>
Performs one iteration of the watershed algorithm.
</p>
<p>
Fields <em class="parameter"><code>state</code></em> and progress <em class="parameter"><code>fraction</code></em> of watershed state are updated
(fraction is calculated for each phase individually). Once <em class="parameter"><code>state</code></em>
becomes <code class="literal">GWY_WATERSHED_STATE_FINISHED</code>, the calculation is finised.
</p>
<p>
A watershed iterator can be created with
<a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-watershed-init" title="gwy_data_field_grains_watershed_init ()"><code class="function">gwy_data_field_grains_watershed_init()</code></a>. When iteration ends, either
by finishing or being aborted, <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-watershed-finalize" title="gwy_data_field_grains_watershed_finalize ()"><code class="function">gwy_data_field_grains_watershed_finalize()</code></a>
must be called to release allocated resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Watershed iterator.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-number-grains"></a><h3>gwy_data_field_number_grains ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_data_field_number_grains (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask_field</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *grains</code></em>);</pre>
<p>
Numbers grains in a mask data field.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_field</code></em> :</span></p></td>
<td>Data field containing positive values in grains, nonpositive
in free space.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grains</code></em> :</span></p></td>
<td>Zero-filled array of integers of equal size to <em class="parameter"><code>mask_field</code></em> to put
grain numbers to. Empty space will be left 0, pixels inside a
grain will be set to grain number. Grains are numbered
sequentially 1, 2, 3, ...</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of last grain (note they are numbered from 1).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-quantity-get-units"></a><h3>gwy_grain_quantity_get_units ()</h3>
<pre class="programlisting"><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="returnvalue">GwySIUnit</span></a> * gwy_grain_quantity_get_units (<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *siunitxy</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *siunitz</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *result</code></em>);</pre>
<p>
Calculates the units of a grain quantity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>quantity</code></em> :</span></p></td>
<td>A grain quantity.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>siunitxy</code></em> :</span></p></td>
<td>Lateral SI unit of data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>siunitz</code></em> :</span></p></td>
<td>Value SI unit of data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>An SI unit to set to the units of <em class="parameter"><code>quantity</code></em>.
It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a new SI unit is created then and returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>When <em class="parameter"><code>result</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a newly creates SI unit that has to be
dereferenced when no longer used later. Otherwise <em class="parameter"><code>result</code></em> itself
is simply returned, its reference count is NOT increased.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-quantity-needs-same-units"></a><h3>gwy_grain_quantity_needs_same_units ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_grain_quantity_needs_same_units (<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> quantity</code></em>);</pre>
<p>
Tests whether a grain quantity is defined only when lateral and value
units match.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>quantity</code></em> :</span></p></td>
<td>A grain quantity.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>quantity</code></em> is meaningless when lateral and value units
differ, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is always defined.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|