/usr/share/gtk-doc/html/libgwyprocess/GwyCalibration.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 | <!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: GwyCalibration</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="GwyBrick.html" title="GwyBrick">
<link rel="next" href="GwyCalData.html" title="GwyCalData">
<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="#GwyCalibration.description" class="shortcut">Description</a>
|
<a href="#GwyCalibration.object-hierarchy" class="shortcut">Object Hierarchy</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="GwyBrick.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyCalData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyCalibration"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyCalibration.top_of_page"></a>GwyCalibration</span></h2>
<p>GwyCalibration — Resource for managing calibrations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyCalibration.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
struct <a class="link" href="GwyCalibration.html#GwyCalibration-struct" title="struct GwyCalibration">GwyCalibration</a>;
struct <a class="link" href="GwyCalibration.html#GwyCalibrationClass" title="struct GwyCalibrationClass">GwyCalibrationClass</a>;
<a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="returnvalue">GwyCalibration</span></a> * <a class="link" href="GwyCalibration.html#gwy-calibration-new" title="gwy_calibration_new ()">gwy_calibration_new</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</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="GwyCalibration.html#gwy-calibration-get-filename" title="gwy_calibration_get_filename ()">gwy_calibration_get_filename</a> (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</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="GwyCalibration.html#gwy-calibration-get-ndata" title="gwy_calibration_get_ndata ()">gwy_calibration_get_ndata</a> (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</code></em>);
<a href="../libgwyddion/GwyInventory.html"><span class="returnvalue">GwyInventory</span></a> * <a class="link" href="GwyCalibration.html#gwy-calibrations" title="gwy_calibrations ()">gwy_calibrations</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="returnvalue">GwyCalibration</span></a> * <a class="link" href="GwyCalibration.html#gwy-calibrations-get-calibration" title="gwy_calibrations_get_calibration ()">gwy_calibrations_get_calibration</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a class="link" href="GwyCalData.html" title="GwyCalData"><span class="returnvalue">GwyCalData</span></a> * <a class="link" href="GwyCalibration.html#gwy-calibration-get-data" title="gwy_calibration_get_data ()">gwy_calibration_get_data</a> (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyCalibration.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="../libgwyddion/GwyResource.html">GwyResource</a>
+----GwyCalibration
</pre>
</div>
<div class="refsect1">
<a name="GwyCalibration.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> is a resource used for managing calibration data. These
resources are stored separately from calibration data and contain namely
filename of connected calibration data file.
</p>
</div>
<div class="refsect1">
<a name="GwyCalibration.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyCalibration-struct"></a><h3>struct GwyCalibration</h3>
<pre class="programlisting">struct GwyCalibration;</pre>
<p>
The <a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> struct contains private data only and should be accessed
using the functions below.
</p>
<p class="since">Since 2.23</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyCalibrationClass"></a><h3>struct GwyCalibrationClass</h3>
<pre class="programlisting">struct GwyCalibrationClass {
GwyResourceClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibration-new"></a><h3>gwy_calibration_new ()</h3>
<pre class="programlisting"><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="returnvalue">GwyCalibration</span></a> * gwy_calibration_new (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>
Creates new calibration resource.
</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>name</code></em> :</span></p></td>
<td>Name of resource</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>Filename of associated calibration data</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created calibration resource.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibration-get-filename"></a><h3>gwy_calibration_get_filename ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_calibration_get_filename (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</code></em>);</pre>
<p>
Get filename of associated calibration data.
</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>calibration</code></em> :</span></p></td>
<td>Calibration resource</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Filename of associated calibration data.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibration-get-ndata"></a><h3>gwy_calibration_get_ndata ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_calibration_get_ndata (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibrations"></a><h3>gwy_calibrations ()</h3>
<pre class="programlisting"><a href="../libgwyddion/GwyInventory.html"><span class="returnvalue">GwyInventory</span></a> * gwy_calibrations (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets inventory with all the calibrations.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Calibration inventory.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibrations-get-calibration"></a><h3>gwy_calibrations_get_calibration ()</h3>
<pre class="programlisting"><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="returnvalue">GwyCalibration</span></a> * gwy_calibrations_get_calibration (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Convenience function to get a calibration from <a class="link" href="GwyCalibration.html#gwy-calibrations" title="gwy_calibrations ()"><code class="function">gwy_calibrations()</code></a> by name.
</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>name</code></em> :</span></p></td>
<td>Calibration name. May be <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to get the default calibration.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Calibration identified by <em class="parameter"><code>name</code></em> or the default calibration if <em class="parameter"><code>name</code></em>
does not exist.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.23</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-calibration-get-data"></a><h3>gwy_calibration_get_data ()</h3>
<pre class="programlisting"><a class="link" href="GwyCalData.html" title="GwyCalData"><span class="returnvalue">GwyCalData</span></a> * gwy_calibration_get_data (<em class="parameter"><code><a class="link" href="GwyCalibration.html" title="GwyCalibration"><span class="type">GwyCalibration</span></a> *calibration</code></em>);</pre>
<p>
Obtains the data related to calibration.
</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>calibration</code></em> :</span></p></td>
<td>A calibration.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The data related to <em class="parameter"><code>calibration</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.23</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|