/usr/share/gtk-doc/html/libgwyprocess/GwySpectra.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwySpectra</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="GwyDataField.html" title="GwyDataField">
<link rel="next" href="GwyCalibration.html" title="GwyCalibration">
<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="GwyDataField.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="GwyCalibration.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GwySpectra.synopsis" class="shortcut">Top</a>
|
<a href="#GwySpectra.description" class="shortcut">Description</a>
|
<a href="#GwySpectra.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwySpectra.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GwySpectra.properties" class="shortcut">Properties</a>
|
<a href="#GwySpectra.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GwySpectra"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwySpectra.top_of_page"></a>GwySpectra</span></h2>
<p>GwySpectra — Collection of dataline representing point spectra.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwySpectra.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
struct <a class="link" href="GwySpectra.html#GwySpectra-struct" title="struct GwySpectra">GwySpectra</a>;
struct <a class="link" href="GwySpectra.html#GwySpectraClass" title="struct GwySpectraClass">GwySpectraClass</a>;
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-add-spectrum" title="gwy_spectra_add_spectrum ()">gwy_spectra_add_spectrum</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *new_spectrum</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> x</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> y</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-clear" title="gwy_spectra_clear ()">gwy_spectra_clear</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-data-changed" title="gwy_spectra_data_changed ()">gwy_spectra_data_changed</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);
#define <a class="link" href="GwySpectra.html#gwy-spectra-duplicate" title="gwy_spectra_duplicate()">gwy_spectra_duplicate</a> (spectra)
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-find-nearest" title="gwy_spectra_find_nearest ()">gwy_spectra_find_nearest</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> x</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> y</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *ilist</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GwySpectra.html#gwy-spectra-get-n-spectra" title="gwy_spectra_get_n_spectra ()">gwy_spectra_get_n_spectra</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);
<a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="returnvalue">GwySIUnit</span></a> * <a class="link" href="GwySpectra.html#gwy-spectra-get-si-unit-xy" title="gwy_spectra_get_si_unit_xy ()">gwy_spectra_get_si_unit_xy</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);
<a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * <a class="link" href="GwySpectra.html#gwy-spectra-get-spectrum" title="gwy_spectra_get_spectrum ()">gwy_spectra_get_spectrum</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> i</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="GwySpectra.html#gwy-spectra-get-spectrum-selected" title="gwy_spectra_get_spectrum_selected ()">gwy_spectra_get_spectrum_selected</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</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="GwySpectra.html#gwy-spectra-get-title" title="gwy_spectra_get_title ()">gwy_spectra_get_title</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-itoxy" title="gwy_spectra_itoxy ()">gwy_spectra_itoxy</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</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> *x</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> *y</code></em>);
<a class="link" href="GwySpectra.html" title="GwySpectra"><span class="returnvalue">GwySpectra</span></a> * <a class="link" href="GwySpectra.html#gwy-spectra-new" title="gwy_spectra_new ()">gwy_spectra_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GwySpectra.html" title="GwySpectra"><span class="returnvalue">GwySpectra</span></a> * <a class="link" href="GwySpectra.html#gwy-spectra-new-alike" title="gwy_spectra_new_alike ()">gwy_spectra_new_alike</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *model</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-remove-spectrum" title="gwy_spectra_remove_spectrum ()">gwy_spectra_remove_spectrum</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-set-si-unit-xy" title="gwy_spectra_set_si_unit_xy ()">gwy_spectra_set_si_unit_xy</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *si_unit</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-set-spectrum" title="gwy_spectra_set_spectrum ()">gwy_spectra_set_spectrum</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *new_spectrum</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-set-spectrum-selected" title="gwy_spectra_set_spectrum_selected ()">gwy_spectra_set_spectrum_selected</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> selected</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-set-title" title="gwy_spectra_set_title ()">gwy_spectra_set_title</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> *title</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySpectra.html#gwy-spectra-setpos" title="gwy_spectra_setpos ()">gwy_spectra_setpos</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</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> x</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> y</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="GwySpectra.html#gwy-spectra-xytoi" title="gwy_spectra_xytoi ()">gwy_spectra_xytoi</a> (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> x</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> y</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwySpectra.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>
+----GwySpectra
</pre>
</div>
<div class="refsect1">
<a name="GwySpectra.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GwySpectra implements
<a href="./../libgwyddion/libgwyddion/GwySerializable.html">GwySerializable</a>.</p>
</div>
<div class="refsect1">
<a name="GwySpectra.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwySpectra.html#GwySpectra--title" title='The "title" property'>title</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GwySpectra.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GwySpectra.html#GwySpectra-data-changed" title='The "data-changed" signal'>data-changed</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GwySpectra.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> contains an array of <a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a>s and coordinates
representing where in a data field the spectrum was acquired.
</p>
</div>
<div class="refsect1">
<a name="GwySpectra.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwySpectra-struct"></a><h3>struct GwySpectra</h3>
<pre class="programlisting">struct GwySpectra;</pre>
<p>
The <a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> struct contains private data only and should be accessed
using the functions below.
</p>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="GwySpectraClass"></a><h3>struct GwySpectraClass</h3>
<pre class="programlisting">struct GwySpectraClass {
GObjectClass parent_class;
void (*data_changed)(GwySpectra *spectra);
void (*reserved1)(void);
void (*reserved2)(void);
void (*reserved3)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-add-spectrum"></a><h3>gwy_spectra_add_spectrum ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_add_spectrum (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *new_spectrum</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> x</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> y</code></em>);</pre>
<p>
Appends a new_spectrum to the spectra collection with a position of x, y.
gwy_spectra_add takes a refference to the supplied spectrum.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_spectrum</code></em> :</span></p></td>
<td>A GwyDataLine containing the spectrum to append.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>The physical x coordinate of the location of the spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>The physical y coordinate of the location of the spectrum.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-clear"></a><h3>gwy_spectra_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_clear (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Removes all spectra from the collection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-data-changed"></a><h3>gwy_spectra_data_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_data_changed (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Emits signal "data_changed" on a spectra object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-duplicate"></a><h3>gwy_spectra_duplicate()</h3>
<pre class="programlisting">#define gwy_spectra_duplicate(spectra)</pre>
<p>
Convenience macro doing <a href="./../libgwyddion/libgwyddion/GwySerializable.html#gwy-serializable-duplicate"><code class="function">gwy_serializable_duplicate()</code></a> with all the necessary
typecasting.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A Spectra object to duplicate.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-find-nearest"></a><h3>gwy_spectra_find_nearest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_find_nearest (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> x</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> y</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *ilist</code></em>);</pre>
<p>
Gets the list of the indices to spectra ordered by their distance from a
given point.
</p>
<p>
List positions
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Point x-coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Point y-coordinate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>Number of indices to find. Array <em class="parameter"><code>ilist</code></em> must have at least this
number of items.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ilist</code></em> :</span></p></td>
<td>Array to place the spectra indices to. They will be sorted by the
distance from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>). Positions after the number of spectra
in <em class="parameter"><code>spectra</code></em> will be left untouched.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-get-n-spectra"></a><h3>gwy_spectra_get_n_spectra ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gwy_spectra_get_n_spectra (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Gets the number of spectra in a spectra object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of spectra.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-get-si-unit-xy"></a><h3>gwy_spectra_get_si_unit_xy ()</h3>
<pre class="programlisting"><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="returnvalue">GwySIUnit</span></a> * gwy_spectra_get_si_unit_xy (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Gets SI unit used for the location co-ordinates of spectra.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>SI unit corresponding to the the location co-ordinates of spectra
object. Its reference count is not incremented.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-get-spectrum"></a><h3>gwy_spectra_get_spectrum ()</h3>
<pre class="programlisting"><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * gwy_spectra_get_spectrum (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> i</code></em>);</pre>
<p>
Gets a dataline that contains the spectrum at index i.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A Spectra object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Index of a spectrum</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> containing the spectrum, owned by <em class="parameter"><code>spectra</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-get-spectrum-selected"></a><h3>gwy_spectra_get_spectrum_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_spectra_get_spectrum_selected (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>
Gets the selected state of a spectrum in a spectra object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Index of a spectrum.</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 spectrum is selected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-get-title"></a><h3>gwy_spectra_get_title ()</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_spectra_get_title (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>);</pre>
<p>
Gets the title of spectra.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A pointer to the title string (owned by the spectra object).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-itoxy"></a><h3>gwy_spectra_itoxy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_itoxy (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</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> *x</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> *y</code></em>);</pre>
<p>
Gets the coordinates of one spectrum.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Index of a spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Location to store the physical x coordinate of the spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Location to store the physical x coordinate of the spectrum.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-new"></a><h3>gwy_spectra_new ()</h3>
<pre class="programlisting"><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="returnvalue">GwySpectra</span></a> * gwy_spectra_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new Spectra object containing zero spectra.
</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>A newly created spectra.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-new-alike"></a><h3>gwy_spectra_new_alike ()</h3>
<pre class="programlisting"><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="returnvalue">GwySpectra</span></a> * gwy_spectra_new_alike (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *model</code></em>);</pre>
<p>
Creates a new Spectra object similar to an existing one, but containing zero
spectra.
</p>
<p>
Use <a class="link" href="GwySpectra.html#gwy-spectra-duplicate" title="gwy_spectra_duplicate()"><code class="function">gwy_spectra_duplicate()</code></a> if you want to copy a spectra object including
the spectra in it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>A Spectra object to take units from.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created Spectra object.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-remove-spectrum"></a><h3>gwy_spectra_remove_spectrum ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_remove_spectrum (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-set-si-unit-xy"></a><h3>gwy_spectra_set_si_unit_xy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_set_si_unit_xy (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwySIUnit.html"><span class="type">GwySIUnit</span></a> *si_unit</code></em>);</pre>
<p>
Sets the SI unit corresponding to the location co-ordinates of the spectra
object.
</p>
<p>
It does not assume a reference on <em class="parameter"><code>si_unit</code></em>, instead it adds its own
reference.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A Spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>si_unit</code></em> :</span></p></td>
<td>SI unit to be set.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-set-spectrum"></a><h3>gwy_spectra_set_spectrum ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_set_spectrum (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *new_spectrum</code></em>);</pre>
<p>
Replaces the ith spectrum in the spectra object with a the
supplied spectrum, new_spectrum. It takes its own reference
to the New_Spectrum dataline.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Index of a spectrum to replace</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_spectrum</code></em> :</span></p></td>
<td>A <a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> Object containing the new spectrum.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-set-spectrum-selected"></a><h3>gwy_spectra_set_spectrum_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_set_spectrum_selected (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> selected</code></em>);</pre>
<p>
Sets selected state of a spectrum in a spectra object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Index of a spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selected</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to make the spectrum selected, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to deselect it.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-set-title"></a><h3>gwy_spectra_set_title ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_set_title (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> *title</code></em>);</pre>
<p>
Sets the title of the spectra collection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>The new title string.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-setpos"></a><h3>gwy_spectra_setpos ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_spectra_setpos (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</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> x</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> y</code></em>);</pre>
<p>
Sets the location coordinates of a spectrum.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>The index of a spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>The new x coordinate of the location of the spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>The new y coordinate of the location of the spectrum.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-spectra-xytoi"></a><h3>gwy_spectra_xytoi ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_spectra_xytoi (<em class="parameter"><code><a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *spectra</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> x</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> y</code></em>);</pre>
<p>
Finds the index of the spectrum closest to the location specified by
the coordinates x and y.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>spectra</code></em> :</span></p></td>
<td>A spectra object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>The x coordinate of the location of the spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>The y coordinate of the location of the spectrum.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The index of the nearest spectrum. If there are no curves in the
spectra, -1 is returned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
</div>
<div class="refsect1">
<a name="GwySpectra.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwySpectra--title"></a><h3>The <code class="literal">"title"</code> property</h3>
<pre class="programlisting"> "title" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>The spectra title.</p>
<p>Default value: "New spectra"</p>
</div>
</div>
<div class="refsect1">
<a name="GwySpectra.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwySpectra-data-changed"></a><h3>The <code class="literal">"data-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> *gwyspectra,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
The ::data-changed signal is never emitted by the spectra itself. It
is intended as a means to notify other spectra users they should
update themselves.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gwyspectra</code></em> :</span></p></td>
<td>The <a class="link" href="GwySpectra.html" title="GwySpectra"><span class="type">GwySpectra</span></a> which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|