/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-correlation.html is in libgwyddion20-doc 2.34-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Data Processing Library Reference Manual: correlation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="prev" href="libgwyprocess-correct.html" title="correct">
<link rel="next" href="libgwyprocess-cwt.html" title="cwt">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#libgwyprocess-correlation.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyprocess-correct.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyprocess-cwt.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyprocess-correlation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-correlation.top_of_page"></a>correlation</span></h2>
<p>correlation — Correlation and crosscorrelation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-correlation.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#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-get-correlation-score" title="gwy_data_field_get_correlation_score ()">gwy_data_field_get_correlation_score</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> *kernel_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#gint"><span class="type">gint</span></a> kernel_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> kernel_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> kernel_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> kernel_height</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate" title="gwy_data_field_crosscorrelate ()">gwy_data_field_crosscorrelate</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *x_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *y_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</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> search_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> search_height</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> window_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> window_height</code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate-init" title="gwy_data_field_crosscorrelate_init ()">gwy_data_field_crosscorrelate_init</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *x_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *y_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</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> search_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> search_height</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> window_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> window_height</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate-iteration" title="gwy_data_field_crosscorrelate_iteration ()">gwy_data_field_crosscorrelate_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>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate-finalize" title="gwy_data_field_crosscorrelate_finalize ()">gwy_data_field_crosscorrelate_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>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate" title="gwy_data_field_correlate ()">gwy_data_field_correlate</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> *kernel_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyCorrelationType" title="enum GwyCorrelationType"><span class="type">GwyCorrelationType</span></a> method</code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate-init" title="gwy_data_field_correlate_init ()">gwy_data_field_correlate_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> *kernel_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate-iteration" title="gwy_data_field_correlate_iteration ()">gwy_data_field_correlate_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>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate-finalize" title="gwy_data_field_correlate_finalize ()">gwy_data_field_correlate_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>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-correlation.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyprocess-correlation.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-data-field-get-correlation-score"></a><h3>gwy_data_field_get_correlation_score ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_data_field_get_correlation_score
(<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> *kernel_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> kernel_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> kernel_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> kernel_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> kernel_height</code></em>);</pre>
<p>
Calculates a correlation score in one point.
</p>
<p>
Correlation window size is given
by <em class="parameter"><code>kernel_col</code></em>, <em class="parameter"><code>kernel_row</code></em>, <em class="parameter"><code>kernel_width</code></em>, <em class="parameter"><code>kernel_height</code></em>,
postion of the correlation window on data is given by
<em class="parameter"><code>col</code></em>, <em class="parameter"><code>row</code></em>.
</p>
<p>
If anything fails (data too close to boundary, etc.),
function returns -1.0 (none correlation)..
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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>kernel_field</code></em> :</span></p></td>
<td>Kernel to correlate data field with.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>col</code></em> :</span></p></td>
<td>Upper-left column position in the data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td>
<td>Upper-left row position in the data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kernel_col</code></em> :</span></p></td>
<td>Upper-left column position in kernel field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kernel_row</code></em> :</span></p></td>
<td>Upper-left row position in kernel field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kernel_width</code></em> :</span></p></td>
<td>Width of kernel field area.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kernel_height</code></em> :</span></p></td>
<td>Heigh of kernel field area.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Correlation score (between -1.0 and 1.0). Value 1.0 denotes
maximum correlation, -1.0 none correlation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-crosscorrelate"></a><h3>gwy_data_field_crosscorrelate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_crosscorrelate (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *x_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *y_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</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> search_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> search_height</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> window_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> window_height</code></em>);</pre>
<p>
Algorithm for matching two different images of the same object under changes.
</p>
<p>
It does not use any special features
for matching. It simply searches for all points (with their neighbourhood)
of <em class="parameter"><code>data_field1</code></em> within <em class="parameter"><code>data_field2</code></em>. Parameters <em class="parameter"><code>search_width</code></em> and
<em class="parameter"><code>search_height</code></em>
determine maimum area where to search for points. The area is cenetered
in the <em class="parameter"><code>data_field2</code></em> at former position of points at <em class="parameter"><code>data_field1</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field1</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field2</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x_dist</code></em> :</span></p></td>
<td>A data field to store x-distances to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y_dist</code></em> :</span></p></td>
<td>A data field to store y-distances to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
<td>Data field to store correlation scores to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>search_width</code></em> :</span></p></td>
<td>Search area width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>search_height</code></em> :</span></p></td>
<td>Search area height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window_width</code></em> :</span></p></td>
<td>Correlation window width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window_height</code></em> :</span></p></td>
<td>Correlation window height.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-crosscorrelate-init"></a><h3>gwy_data_field_crosscorrelate_init ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * gwy_data_field_crosscorrelate_init
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *x_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *y_dist</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</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> search_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> search_height</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> window_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> window_height</code></em>);</pre>
<p>
Initializes a cross-correlation iterator.
</p>
<p>
This iterator reports its state as <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationStateType" title="enum GwyComputationStateType"><span class="type">GwyComputationStateType</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field1</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field2</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x_dist</code></em> :</span></p></td>
<td>A data field to store x-distances to, or <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>y_dist</code></em> :</span></p></td>
<td>A data field to store y-distances to, or <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>score</code></em> :</span></p></td>
<td>Data field to store correlation scores to, or <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>search_width</code></em> :</span></p></td>
<td>Search area width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>search_height</code></em> :</span></p></td>
<td>Search area height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window_width</code></em> :</span></p></td>
<td>Correlation window width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window_height</code></em> :</span></p></td>
<td>Correlation window height.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new cross-correlation iterator.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-crosscorrelate-iteration"></a><h3>gwy_data_field_crosscorrelate_iteration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_crosscorrelate_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 cross-correlation.
</p>
<p>
Cross-correlation matches two different images of the same object under
changes.
</p>
<p>
It does not use any special features
for matching. It simply searches for all points (with their neighbourhood)
of <em class="parameter"><code>data_field1</code></em> within <em class="parameter"><code>data_field2</code></em>. Parameters <em class="parameter"><code>search_width</code></em> and
<em class="parameter"><code>search_height</code></em> determine maimum area where to search for points.
The area is cenetered in the <em class="parameter"><code>data_field2</code></em> at former position of points at
<em class="parameter"><code>data_field1</code></em>.
</p>
<p>
A cross-correlation iterator can be created with
<a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate-init" title="gwy_data_field_crosscorrelate_init ()"><code class="function">gwy_data_field_crosscorrelate_init()</code></a>. When iteration ends, either
by finishing or being aborted, <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-crosscorrelate-finalize" title="gwy_data_field_crosscorrelate_finalize ()"><code class="function">gwy_data_field_crosscorrelate_finalize()</code></a>
must be called to release allocated resources.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Cross-correlation iterator.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-crosscorrelate-finalize"></a><h3>gwy_data_field_crosscorrelate_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_crosscorrelate_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 cross-correlation iterator, freeing all resources.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Cross-correlation iterator.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-correlate"></a><h3>gwy_data_field_correlate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_correlate (<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> *kernel_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyCorrelationType" title="enum GwyCorrelationType"><span class="type">GwyCorrelationType</span></a> method</code></em>);</pre>
<p>
Computes correlation score for all positions in a data field.
</p>
<p>
Correlation score is compute for all points in data field <em class="parameter"><code>data_field</code></em>
and full size of correlation kernel <em class="parameter"><code>kernel_field</code></em>.
</p>
<p>
The points in <em class="parameter"><code>score</code></em> correspond to centers of kernel. More precisely, the
point ((<em class="parameter"><code>kxres</code></em>-1)/2, (<em class="parameter"><code>kyres</code></em>-1)/2) in <em class="parameter"><code>score</code></em> corresponds to kernel field
top left corner coincident with data field top left corner. Points outside
the area where the kernel field fits into the data field completely are
set to -1 for <a class="link" href="libgwyprocess-gwyprocessenums.html#GWY-CORRELATION-NORMAL:CAPS"><code class="literal">GWY_CORRELATION_NORMAL</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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>kernel_field</code></em> :</span></p></td>
<td>Correlation kernel.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
<td>Data field to store correlation scores to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>Correlation score calculation method.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-correlate-init"></a><h3>gwy_data_field_correlate_init ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationState" title="GwyComputationState"><span class="returnvalue">GwyComputationState</span></a> * gwy_data_field_correlate_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> *kernel_field</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *score</code></em>);</pre>
<p>
Creates a new correlation iterator.
</p>
<p>
This iterator reports its state as <a class="link" href="libgwyprocess-gwyprocessenums.html#GwyComputationStateType" title="enum GwyComputationStateType"><span class="type">GwyComputationStateType</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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>kernel_field</code></em> :</span></p></td>
<td>Kernel to correlate data field with.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>score</code></em> :</span></p></td>
<td>Data field to store correlation scores to.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new correlation iterator.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-correlate-iteration"></a><h3>gwy_data_field_correlate_iteration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_correlate_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 correlation.
</p>
<p>
An iterator can be created with <a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate-init" title="gwy_data_field_correlate_init ()"><code class="function">gwy_data_field_correlate_init()</code></a>.
When iteration ends, either by finishing or being aborted,
<a class="link" href="libgwyprocess-correlation.html#gwy-data-field-correlate-finalize" title="gwy_data_field_correlate_finalize ()"><code class="function">gwy_data_field_correlate_finalize()</code></a> must be called to release allocated
resources.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Correlation iterator.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-correlate-finalize"></a><h3>gwy_data_field_correlate_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_correlate_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 correlation iterator, freeing all resources.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>Correlation iterator.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|