/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-elliptic.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>elliptic</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-dwt.html" title="dwt">
<link rel="next" href="libgwyprocess-filters.html" title="filters">
<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-dwt.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-filters.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-elliptic.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyprocess-elliptic.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyprocess-elliptic"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-elliptic.top_of_page"></a>elliptic</span></h2>
<p>elliptic — Functions to work with elliptic areas</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-elliptic.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
<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-elliptic.html#gwy-data-field-circular-area-extract" title="gwy_data_field_circular_area_extract ()">gwy_data_field_circular_area_extract</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="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#gdouble"><span class="type">gdouble</span></a> radius</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> *data</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-elliptic.html#gwy-data-field-circular-area-extract-with-pos" title="gwy_data_field_circular_area_extract_with_pos ()">gwy_data_field_circular_area_extract_with_pos</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="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#gdouble"><span class="type">gdouble</span></a> radius</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> *data</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> *xpos</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> *ypos</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-elliptic.html#gwy-data-field-circular-area-fill" title="gwy_data_field_circular_area_fill ()">gwy_data_field_circular_area_fill</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="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#gdouble"><span class="type">gdouble</span></a> radius</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> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-unextract" title="gwy_data_field_circular_area_unextract ()">gwy_data_field_circular_area_unextract</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#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#gdouble"><span class="type">gdouble</span></a> radius</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</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-elliptic.html#gwy-data-field-elliptic-area-extract" title="gwy_data_field_elliptic_area_extract ()">gwy_data_field_elliptic_area_extract</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#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> *data</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-elliptic.html#gwy-data-field-elliptic-area-fill" title="gwy_data_field_elliptic_area_fill ()">gwy_data_field_elliptic_area_fill</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#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> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-elliptic-area-unextract" title="gwy_data_field_elliptic_area_unextract ()">gwy_data_field_elliptic_area_unextract</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#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>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</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-elliptic.html#gwy-data-field-get-circular-area-size" title="gwy_data_field_get_circular_area_size ()">gwy_data_field_get_circular_area_size</a>
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius</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-elliptic.html#gwy-data-field-get-elliptic-area-size" title="gwy_data_field_get_elliptic_area_size ()">gwy_data_field_get_elliptic_area_size</a>
(<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>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-elliptic.description"></a><h2>Description</h2>
<p>
Method for extraction and putting back data from/to elliptic and circular
areas can be used to implement sample-wise operations, that is operations
that depend only on sample value not on its position, on these areas:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">gdouble</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">data</span><span class="symbol">;</span>
<span class="usertype">gint</span><span class="normal"> n</span><span class="symbol">,</span><span class="normal"> i</span><span class="symbol">;</span>
<span class="normal">data </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-new">g_new</a></span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble">gdouble</a></span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">*</span><span class="normal">height</span><span class="symbol">);</span>
<span class="normal">n </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-data-field-elliptic-area-extract">gwy_data_field_elliptic_area_extract</a></span><span class="symbol">(</span><span class="normal">data_field</span><span class="symbol">,</span>
<span class="normal"> col</span><span class="symbol">,</span><span class="normal"> row</span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">,</span><span class="normal"> height</span><span class="symbol">,</span>
<span class="normal"> data</span><span class="symbol">);</span>
<span class="keyword">for</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">i </span><span class="symbol">=</span><span class="normal"> </span><span class="number">0</span><span class="symbol">;</span><span class="normal"> i </span><span class="symbol"><</span><span class="normal"> n</span><span class="symbol">;</span><span class="normal"> i</span><span class="symbol">++)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="symbol">...</span><span class="normal"> </span><span class="keyword">do</span><span class="normal"> something </span><span class="usertype">with</span><span class="normal"> data</span><span class="symbol">[</span><span class="normal">i</span><span class="symbol">]</span><span class="normal"> </span><span class="symbol">...</span>
<span class="cbracket">}</span>
<span class="function"><a href="#gwy-data-field-elliptic-area-unextract">gwy_data_field_elliptic_area_unextract</a></span><span class="symbol">(</span><span class="normal">data_field</span><span class="symbol">,</span>
<span class="normal"> col</span><span class="symbol">,</span><span class="normal"> row</span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">,</span><span class="normal"> height</span><span class="symbol">,</span>
<span class="normal"> data</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
Another possibility is to use <a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> methods on the extracted data
(in practice one would use the same data line repeatedly, of course):
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GwyDataLine</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">data_line</span><span class="symbol">;</span>
<span class="usertype">gdouble</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">data</span><span class="symbol">;</span>
<span class="usertype">gint</span><span class="normal"> n</span><span class="symbol">;</span>
<span class="normal">n </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="#gwy-data-field-get-elliptic-area-size">gwy_data_field_get_elliptic_area_size</a></span><span class="symbol">(</span><span class="normal">data_field</span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">,</span><span class="normal"> height</span><span class="symbol">);</span>
<span class="normal">data_line </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GwyDataLine.html#gwy-data-line-new">gwy_data_line_new</a></span><span class="symbol">(</span><span class="normal">n</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1.0</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">);</span>
<span class="normal">data </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GwyDataLine.html#gwy-data-line-get-data">gwy_data_line_get_data</a></span><span class="symbol">(</span><span class="normal">data_line</span><span class="symbol">);</span>
<span class="function"><a href="#gwy-data-field-elliptic-area-extract">gwy_data_field_elliptic_area_extract</a></span><span class="symbol">(</span><span class="normal">data_field</span><span class="symbol">,</span>
<span class="normal"> col</span><span class="symbol">,</span><span class="normal"> row</span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">,</span><span class="normal"> height</span><span class="symbol">,</span>
<span class="normal"> data</span><span class="symbol">);</span>
<span class="function">gwy_data_line_pixelwise_filter</span><span class="symbol">(</span><span class="normal">data_line</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">...);</span>
<span class="function"><a href="#gwy-data-field-elliptic-area-unextract">gwy_data_field_elliptic_area_unextract</a></span><span class="symbol">(</span><span class="normal">data_field</span><span class="symbol">,</span>
<span class="normal"> col</span><span class="symbol">,</span><span class="normal"> row</span><span class="symbol">,</span><span class="normal"> width</span><span class="symbol">,</span><span class="normal"> height</span><span class="symbol">,</span>
<span class="normal"> data</span><span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="symbol">(</span><span class="normal">data_line</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="libgwyprocess-elliptic.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-data-field-circular-area-extract"></a><h3>gwy_data_field_circular_area_extract ()</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_circular_area_extract
(<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> 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#gdouble"><span class="type">gdouble</span></a> radius</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> *data</code></em>);</pre>
<p>
Extracts values from a circular region of a 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>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Row index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Column index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Circular area radius (in pixels). See
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-extract-with-pos" title="gwy_data_field_circular_area_extract_with_pos ()"><code class="function">gwy_data_field_circular_area_extract_with_pos()</code></a> for caveats.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Location to store the extracted values to. See
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-extract-with-pos" title="gwy_data_field_circular_area_extract_with_pos ()"><code class="function">gwy_data_field_circular_area_extract_with_pos()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of extracted values. It can be zero when the inside of
the circle does not intersect with the data field.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-circular-area-extract-with-pos"></a><h3>gwy_data_field_circular_area_extract_with_pos ()</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_circular_area_extract_with_pos
(<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> 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#gdouble"><span class="type">gdouble</span></a> radius</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> *data</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> *xpos</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> *ypos</code></em>);</pre>
<p>
Extracts values with positions from a circular region of a data field.
</p>
<p>
The row and column indices stored to <em class="parameter"><code>xpos</code></em> and <em class="parameter"><code>ypos</code></em> are relative to the
area centre, i.e. to (<em class="parameter"><code>col</code></em>, <em class="parameter"><code>row</code></em>). The central pixel will therefore have
0 at the corresponding position in both <em class="parameter"><code>xpos</code></em> and <em class="parameter"><code>ypos</code></em>.
</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>col</code></em> :</span></p></td>
<td>Row index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Column index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Circular area radius (in pixels). Any value is allowed, although
to get areas that do not deviate from true circles after
pixelization too much, half-integer values are recommended,
integer radii are NOT recommended.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Location to store the extracted values to. Its size has to be
sufficient to contain all the extracted values. As a conservative
estimate (2*floor(<em class="parameter"><code>radius</code></em>)+1)^2 can be used, or the size can be
calculated with <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-get-circular-area-size" title="gwy_data_field_get_circular_area_size ()"><code class="function">gwy_data_field_get_circular_area_size()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xpos</code></em> :</span></p></td>
<td>Location to store relative column indices of values in <em class="parameter"><code>data</code></em> to,
the size requirements are the same as for <em class="parameter"><code>data</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ypos</code></em> :</span></p></td>
<td>Location to store relative tow indices of values in <em class="parameter"><code>data</code></em> to,
the size requirements are the same as for <em class="parameter"><code>data</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of extracted values. It can be zero when the inside of
the circle does not intersect with the data field.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-circular-area-fill"></a><h3>gwy_data_field_circular_area_fill ()</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_circular_area_fill (<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> 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#gdouble"><span class="type">gdouble</span></a> radius</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> value</code></em>);</pre>
<p>
Fills an elliptic region of a data field with given 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>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Row index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Column index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Circular area radius (in pixels). Any value is allowed, although
to get areas that do not deviate from true circles after
pixelization too much, half-integer values are recommended,
integer values are NOT recommended.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Value to be entered.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of filled values.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-circular-area-unextract"></a><h3>gwy_data_field_circular_area_unextract ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_circular_area_unextract
(<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> 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#gdouble"><span class="type">gdouble</span></a> radius</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>
Puts values back to a circular region of a data field.
</p>
<p>
This method does the reverse of <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-extract" title="gwy_data_field_circular_area_extract ()"><code class="function">gwy_data_field_circular_area_extract()</code></a>
allowing to implement pixel-wise filters on circular areas. Values from
<em class="parameter"><code>data</code></em> are put back to the same positions
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-extract" title="gwy_data_field_circular_area_extract ()"><code class="function">gwy_data_field_circular_area_extract()</code></a> took them from.
</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>col</code></em> :</span></p></td>
<td>Row index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Column index of circular area centre.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Circular area radius (in pixels).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The values to put back. It must be the same array as in previous
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-circular-area-unextract" title="gwy_data_field_circular_area_unextract ()"><code class="function">gwy_data_field_circular_area_unextract()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-elliptic-area-extract"></a><h3>gwy_data_field_elliptic_area_extract ()</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_elliptic_area_extract
(<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> 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> *data</code></em>);</pre>
<p>
Extracts values from an elliptic region of a data field.
</p>
<p>
The elliptic region is defined by its bounding box which must be completely
contained in the 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>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Upper-left bounding box column coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left bounding box row coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Bounding box width (number of columns).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Bounding box height (number of rows).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Location to store the extracted values to. Its size has to be
sufficient to contain all the extracted values. As a conservative
estimate <em class="parameter"><code>width</code></em>*<em class="parameter"><code>height</code></em> can be used, or the
size can be calculated with <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-get-elliptic-area-size" title="gwy_data_field_get_elliptic_area_size ()"><code class="function">gwy_data_field_get_elliptic_area_size()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of extracted values.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-elliptic-area-fill"></a><h3>gwy_data_field_elliptic_area_fill ()</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_elliptic_area_fill (<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> 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> value</code></em>);</pre>
<p>
Fills an elliptic region of a data field with given value.
</p>
<p>
The elliptic region is defined by its bounding box which must be completely
contained in the 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>data_field</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Upper-left bounding box column coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left bounding box row coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Bounding box width (number of columns).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Bounding box height (number of rows).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Value to be entered.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of filled values.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-elliptic-area-unextract"></a><h3>gwy_data_field_elliptic_area_unextract ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_elliptic_area_unextract
(<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> 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>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>
Puts values back to an elliptic region of a data field.
</p>
<p>
The elliptic region is defined by its bounding box which must be completely
contained in the data field.
</p>
<p>
This method does the reverse of <a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-elliptic-area-extract" title="gwy_data_field_elliptic_area_extract ()"><code class="function">gwy_data_field_elliptic_area_extract()</code></a>
allowing to implement pixel-wise filters on elliptic areas. Values from
<em class="parameter"><code>data</code></em> are put back to the same positions
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-elliptic-area-extract" title="gwy_data_field_elliptic_area_extract ()"><code class="function">gwy_data_field_elliptic_area_extract()</code></a> took them from.
</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>col</code></em> :</span></p></td>
<td>Upper-left bounding box column coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left bounding box row coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Bounding box width (number of columns).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Bounding box height (number of rows).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The values to put back. It must be the same array as in previous
<a class="link" href="libgwyprocess-elliptic.html#gwy-data-field-elliptic-area-extract" title="gwy_data_field_elliptic_area_extract ()"><code class="function">gwy_data_field_elliptic_area_extract()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-get-circular-area-size"></a><h3>gwy_data_field_get_circular_area_size ()</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_circular_area_size
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius</code></em>);</pre>
<p>
Calculates an upper bound of the number of samples in a circular region.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
<td>Circular area radius (in pixels).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of pixels in a circular region with given rectangular
bounds (or its upper bound).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-get-elliptic-area-size"></a><h3>gwy_data_field_get_elliptic_area_size ()</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_elliptic_area_size
(<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>);</pre>
<p>
Calculates an upper bound of the number of samples in an elliptic region.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>Bounding box width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>Bounding box height.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of pixels in an elliptic region with given rectangular
bounds (or its upper bound).</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|