/usr/share/gtk-doc/html/libgwyprocess/GwyGrainValue.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyGrainValue</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-grains.html" title="grains">
<link rel="next" href="libgwyprocess-hough.html" title="hough">
<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-grains.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="libgwyprocess-hough.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GwyGrainValue.synopsis" class="shortcut">Top</a>
|
<a href="#GwyGrainValue.description" class="shortcut">Description</a>
|
<a href="#GwyGrainValue.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GwyGrainValue"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyGrainValue.top_of_page"></a>GwyGrainValue</span></h2>
<p>GwyGrainValue — Grain value resource type</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyGrainValue.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
struct <a class="link" href="GwyGrainValue.html#GwyGrainValue-struct" title="struct GwyGrainValue">GwyGrainValue</a>;
struct <a class="link" href="GwyGrainValue.html#GwyGrainValueClass" title="struct GwyGrainValueClass">GwyGrainValueClass</a>;
<a class="link" href="GwyGrainValue.html#GwyGrainValueData" title="GwyGrainValueData">GwyGrainValueData</a>;
enum <a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags">GwyGrainValueFlags</a>;
enum <a class="link" href="GwyGrainValue.html#GwyGrainValueGroup" title="enum GwyGrainValueGroup">GwyGrainValueGroup</a>;
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-expression" title="gwy_grain_value_get_expression ()">gwy_grain_value_get_expression</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
<a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags"><span class="returnvalue">GwyGrainValueFlags</span></a> <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-flags" title="gwy_grain_value_get_flags ()">gwy_grain_value_get_flags</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
<a class="link" href="GwyGrainValue.html#GwyGrainValueGroup" title="enum GwyGrainValueGroup"><span class="returnvalue">GwyGrainValueGroup</span></a> <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-group" title="gwy_grain_value_get_group ()">gwy_grain_value_get_group</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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="GwyGrainValue.html#gwy-grain-value-get-power-xy" title="gwy_grain_value_get_power_xy ()">gwy_grain_value_get_power_xy</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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="GwyGrainValue.html#gwy-grain-value-get-power-z" title="gwy_grain_value_get_power_z ()">gwy_grain_value_get_power_z</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="returnvalue">GwyGrainQuantity</span></a> <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-quantity" title="gwy_grain_value_get_quantity ()">gwy_grain_value_get_quantity</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-symbol" title="gwy_grain_value_get_symbol ()">gwy_grain_value_get_symbol</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-symbol-markup" title="gwy_grain_value_get_symbol_markup ()">gwy_grain_value_get_symbol_markup</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-value-group-name" title="gwy_grain_value_group_name ()">gwy_grain_value_group_name</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html#GwyGrainValueGroup" title="enum GwyGrainValueGroup"><span class="type">GwyGrainValueGroup</span></a> group</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-expression" title="gwy_grain_value_set_expression ()">gwy_grain_value_set_expression</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-flags" title="gwy_grain_value_set_flags ()">gwy_grain_value_set_flags</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code><a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags"><span class="type">GwyGrainValueFlags</span></a> flags</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-power-xy" title="gwy_grain_value_set_power_xy ()">gwy_grain_value_set_power_xy</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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> power_xy</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-power-z" title="gwy_grain_value_set_power_z ()">gwy_grain_value_set_power_z</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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> power_z</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-symbol" title="gwy_grain_value_set_symbol ()">gwy_grain_value_set_symbol</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-value-set-symbol-markup" title="gwy_grain_value_set_symbol_markup ()">gwy_grain_value_set_symbol_markup</a> (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);
<a href="./../libgwyddion/libgwyddion/GwyInventory.html"><span class="returnvalue">GwyInventory</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-values" title="gwy_grain_values ()">gwy_grain_values</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyGrainValue.html#gwy-grain-values-calculate" title="gwy_grain_values_calculate ()">gwy_grain_values_calculate</a> (<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> nvalues</code></em>,
<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> **gvalues</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> **results</code></em>,
<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="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>);
<a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="returnvalue">GwyGrainValue</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-values-get-builtin-grain-value" title="gwy_grain_values_get_builtin_grain_value ()">gwy_grain_values_get_builtin_grain_value</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>);
<a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="returnvalue">GwyGrainValue</span></a> * <a class="link" href="GwyGrainValue.html#gwy-grain-values-get-grain-value" title="gwy_grain_values_get_grain_value ()">gwy_grain_values_get_grain_value</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyGrainValue.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="./../libgwyddion/libgwyddion/GwyResource.html">GwyResource</a>
+----GwyGrainValue
</pre>
</div>
<div class="refsect1">
<a name="GwyGrainValue.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GwyGrainValue.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyGrainValue-struct"></a><h3>struct GwyGrainValue</h3>
<pre class="programlisting">struct GwyGrainValue;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyGrainValueClass"></a><h3>struct GwyGrainValueClass</h3>
<pre class="programlisting">struct GwyGrainValueClass {
GwyResourceClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyGrainValueData"></a><h3>GwyGrainValueData</h3>
<pre class="programlisting">typedef struct {
GwyGrainValueGroup group;
gchar *symbol_markup;
gchar *symbol;
gchar *reserveds;
gint power_xy;
gint power_z;
guint flags;
gint reservedi;
} GwyGrainValueData;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyGrainValueFlags"></a><h3>enum GwyGrainValueFlags</h3>
<pre class="programlisting">typedef enum {
GWY_GRAIN_VALUE_SAME_UNITS = 1 << 0,
GWY_GRAIN_VALUE_IS_ANGLE = 1 << 1
} GwyGrainValueFlags;
</pre>
<p>
Special attributes of grain values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-SAME-UNITS:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_SAME_UNITS</code></span></p></td>
<td>Certain grain quantities, such as the surface
area or absolute inclination, are only
meaningful if value (height) is the same
physical quantity as lateral dimensions. These
have this flag set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</td>
</tr>
<tr>
<td><p><a name="GWY-GRAIN-VALUE-IS-ANGLE:CAPS"></a><span class="term"><code class="literal">GWY_GRAIN_VALUE_IS_ANGLE</code></span></p></td>
<td>Angular quantities are internally always
calculated in radians, however they can be
presented in degrees in the user interface.
To enable such special handling, set this
flag to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyGrainValueGroup"></a><h3>enum GwyGrainValueGroup</h3>
<pre class="programlisting">typedef enum {
GWY_GRAIN_VALUE_GROUP_ID = 0,
GWY_GRAIN_VALUE_GROUP_POSITION,
GWY_GRAIN_VALUE_GROUP_VALUE,
GWY_GRAIN_VALUE_GROUP_AREA,
GWY_GRAIN_VALUE_GROUP_VOLUME,
GWY_GRAIN_VALUE_GROUP_BOUNDARY,
GWY_GRAIN_VALUE_GROUP_SLOPE,
GWY_GRAIN_VALUE_GROUP_CURVATURE,
GWY_GRAIN_VALUE_GROUP_USER = 30
} GwyGrainValueGroup;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-expression"></a><h3>gwy_grain_value_get_expression ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_grain_value_get_expression (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the expression of a user-defined grain value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The expression as a string owned by <em class="parameter"><code>gvalue</code></em>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>gvalue</code></em>
is a built-in grain value.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-flags"></a><h3>gwy_grain_value_get_flags ()</h3>
<pre class="programlisting"><a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags"><span class="returnvalue">GwyGrainValueFlags</span></a> gwy_grain_value_get_flags (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Obtains the special attributes 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>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The special attribute flags set on <em class="parameter"><code>gvalue</code></em>. See
<a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags"><span class="type">GwyGrainValueFlags</span></a> for their description.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-group"></a><h3>gwy_grain_value_get_group ()</h3>
<pre class="programlisting"><a class="link" href="GwyGrainValue.html#GwyGrainValueGroup" title="enum GwyGrainValueGroup"><span class="returnvalue">GwyGrainValueGroup</span></a> gwy_grain_value_get_group (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the group of a grain value.
</p>
<p>
All user-defined grain values belong to <code class="literal">GWY_GRAIN_VALUE_GROUP_USER</code> group,
built-in grain values belong to other groups.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The group of <em class="parameter"><code>gvalue</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-power-xy"></a><h3>gwy_grain_value_get_power_xy ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_grain_value_get_power_xy (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the power of lateral dimensions in a grain value.
</p>
<p>
The units of a grain value are determined as the product of lateral units
and value units, raised to certain powers. For instance lengths in the
horizontal plane have xy power of 1 and areas have 2, whereas volumes have
xy power of 2 and value power of 1.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The power of lateral dimensions.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-power-z"></a><h3>gwy_grain_value_get_power_z ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_grain_value_get_power_z (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the power of value (height) in a grain value.
</p>
<p>
See <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-power-xy" title="gwy_grain_value_get_power_xy ()"><code class="function">gwy_grain_value_get_power_xy()</code></a> for details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The power of value (height).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-quantity"></a><h3>gwy_grain_value_get_quantity ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="returnvalue">GwyGrainQuantity</span></a> gwy_grain_value_get_quantity (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the built-in grain quantity corresponding to a grain value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The corresponding built-in <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> if <em class="parameter"><code>gvalue</code></em> is a
built-it grain value, -1 if <em class="parameter"><code>gvalue</code></em> is an user-defined grain value.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-symbol"></a><h3>gwy_grain_value_get_symbol ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_grain_value_get_symbol (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the plain symbol representing a grain value.
</p>
<p>
The plain symbol is used in expressions. It has to be a valid
identifier and it should be easy to type. (Note currently it is not
possible to use user-defined grain quantities in expressions for other
user-defined grain quantities.)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Plain symbol of <em class="parameter"><code>gvalue</code></em>, owned by <em class="parameter"><code>gvalue</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-get-symbol-markup"></a><h3>gwy_grain_value_get_symbol_markup ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_grain_value_get_symbol_markup (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>);</pre>
<p>
Gets the rich text symbol representing a grain value.
</p>
<p>
The returned value can contain Pango markup and is suitable for instance
for graph axis labels.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Rich text symbol of <em class="parameter"><code>gvalue</code></em>, owned by <em class="parameter"><code>gvalue</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-group-name"></a><h3>gwy_grain_value_group_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_grain_value_group_name (<em class="parameter"><code><a class="link" href="GwyGrainValue.html#GwyGrainValueGroup" title="enum GwyGrainValueGroup"><span class="type">GwyGrainValueGroup</span></a> group</code></em>);</pre>
<p>
Obtains the name of a grain value group.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>Grain value group.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The grain value group name as a constant untranslated string,
owned by the library.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-expression"></a><h3>gwy_grain_value_set_expression ()</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_value_set_expression (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *expression</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Sets the expression of a user-defined grain value.
</p>
<p>
It is an error to call this function on a built-in quantity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expression</code></em> :</span></p></td>
<td>New grain value expression.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for the error, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore errors.</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 the expression is compilable and references only known
grain quantities. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is the expression is not calculable,
in this case the <em class="parameter"><code>gvalue</code></em>'s expression is unchanged.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-flags"></a><h3>gwy_grain_value_set_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_value_set_flags (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code><a class="link" href="GwyGrainValue.html#GwyGrainValueFlags" title="enum GwyGrainValueFlags"><span class="type">GwyGrainValueFlags</span></a> flags</code></em>);</pre>
<p>
Sets the special attributes of a grain quantity.
</p>
<p>
The value of <em class="parameter"><code>flags</code></em> determines the complete new set of flags. To set
individual flags, obtain the current set with <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-flags" title="gwy_grain_value_get_flags ()"><code class="function">gwy_grain_value_get_flags()</code></a>
first and then set/unset individual flags.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>The special attributes to set on <em class="parameter"><code>gvalue</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-power-xy"></a><h3>gwy_grain_value_set_power_xy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_value_set_power_xy (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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> power_xy</code></em>);</pre>
<p>
Sets the power of lateral dimensions in a grain value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>power_xy</code></em> :</span></p></td>
<td>The new lateral dimensions power.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-power-z"></a><h3>gwy_grain_value_set_power_z ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_value_set_power_z (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</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> power_z</code></em>);</pre>
<p>
Sets the power of value (height) in a grain value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>power_z</code></em> :</span></p></td>
<td>The new value (height) power.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-symbol"></a><h3>gwy_grain_value_set_symbol ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_value_set_symbol (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);</pre>
<p>
Sets the plain symbol representing a grain value.
</p>
<p>
See <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-symbol" title="gwy_grain_value_get_symbol ()"><code class="function">gwy_grain_value_get_symbol()</code></a> for details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>The new symbol.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-value-set-symbol-markup"></a><h3>gwy_grain_value_set_symbol_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_value_set_symbol_markup (<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> *gvalue</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);</pre>
<p>
Sets the rich text symbol representing a grain value.
</p>
<p>
See <a class="link" href="GwyGrainValue.html#gwy-grain-value-get-symbol-markup" title="gwy_grain_value_get_symbol_markup ()"><code class="function">gwy_grain_value_get_symbol_markup()</code></a> for details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
<td>A grain value object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>The new symbol.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-values"></a><h3>gwy_grain_values ()</h3>
<pre class="programlisting"><a href="./../libgwyddion/libgwyddion/GwyInventory.html"><span class="returnvalue">GwyInventory</span></a> * gwy_grain_values (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the inventory with all the grain values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Grain value inventory.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-values-calculate"></a><h3>gwy_grain_values_calculate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_grain_values_calculate (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nvalues</code></em>,
<em class="parameter"><code><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="type">GwyGrainValue</span></a> **gvalues</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> **results</code></em>,
<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#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>);</pre>
<p>
Calculates a set of grain values.
</p>
<p>
See also <a class="link" href="libgwyprocess-grains.html#gwy-data-field-grains-get-quantities" title="gwy_data_field_grains_get_quantities ()"><code class="function">gwy_data_field_grains_get_quantities()</code></a> for a simplier function
for built-in grain values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nvalues</code></em> :</span></p></td>
<td>Number of items in <em class="parameter"><code>gvalues</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gvalues</code></em> :</span></p></td>
<td>Array of grain value objects.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td>
<td>Array of length <em class="parameter"><code>nvalues</code></em> of arrays of length <em class="parameter"><code>ngrains</code></em>+1 of doubles
to put the calculated values to.</td>
</tr>
<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 values 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>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>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-values-get-builtin-grain-value"></a><h3>gwy_grain_values_get_builtin_grain_value ()</h3>
<pre class="programlisting"><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="returnvalue">GwyGrainValue</span></a> * gwy_grain_values_get_builtin_grain_value
(<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>
Obtains the built-in grain value corresponding to given enum value.
</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 <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyGrainQuantity" title="enum GwyGrainQuantity"><span class="type">GwyGrainQuantity</span></a> value.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The built-in grain value corresponding to <em class="parameter"><code>quantity</code></em>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there
is no such grain value.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-grain-values-get-grain-value"></a><h3>gwy_grain_values_get_grain_value ()</h3>
<pre class="programlisting"><a class="link" href="GwyGrainValue.html" title="GwyGrainValue"><span class="returnvalue">GwyGrainValue</span></a> * gwy_grain_values_get_grain_value (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Convenience function to get a grain quantity from <a class="link" href="GwyGrainValue.html#gwy-grain-values" title="gwy_grain_values ()"><code class="function">gwy_grain_values()</code></a> by
name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Grain quantity name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Grain quantity identified by <em class="parameter"><code>name</code></em> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no such
grain quantity.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|