/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-dwt.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 | <!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: dwt</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-cwt.html" title="cwt">
<link rel="next" href="libgwyprocess-elliptic.html" title="elliptic">
<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-dwt.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-cwt.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyprocess-elliptic.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyprocess-dwt"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-dwt.top_of_page"></a>dwt</span></h2>
<p>dwt — Discrete Wavelet Transform</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-dwt.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
<a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * <a class="link" href="libgwyprocess-dwt.html#gwy-dwt-set-coefficients" title="gwy_dwt_set_coefficients ()">gwy_dwt_set_coefficients</a> (<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *dline</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTType" title="enum GwyDWTType"><span class="type">GwyDWTType</span></a> type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-dwt.html#gwy-data-line-dwt" title="gwy_data_line_dwt ()">gwy_data_line_dwt</a> (<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *dline</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-dwt.html#gwy-data-field-xdwt" title="gwy_data_field_xdwt ()">gwy_data_field_xdwt</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-dwt.html#gwy-data-field-ydwt" title="gwy_data_field_ydwt ()">gwy_data_field_ydwt</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-dwt.html#gwy-data-field-dwt" title="gwy_data_field_dwt ()">gwy_data_field_dwt</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-dwt.html#gwy-data-field-dwt-mark-anisotropy" title="gwy_data_field_dwt_mark_anisotropy ()">gwy_data_field_dwt_mark_anisotropy</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</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> ratio</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> lowlimit</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-dwt.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyprocess-dwt.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-dwt-set-coefficients"></a><h3>gwy_dwt_set_coefficients ()</h3>
<pre class="programlisting"><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="returnvalue">GwyDataLine</span></a> * gwy_dwt_set_coefficients (<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *dline</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDWTType" title="enum GwyDWTType"><span class="type">GwyDWTType</span></a> type</code></em>);</pre>
<p>
Fills resampled or nely allocated data line with wavelet coefficients.
</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>dline</code></em> :</span></p></td>
<td>Data line to store wavelet coefficients to (or <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate
a new one).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>Wavelet type.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>resampled or newly allocated GwyDataLine with wavelet coefficients.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-line-dwt"></a><h3>gwy_data_line_dwt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_line_dwt (<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *dline</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);</pre>
<p>
Performs steps of the wavelet decomposition.
</p>
<p>
The smallest low pass coefficients block is equal to <em class="parameter"><code>minsize</code></em>. Run with
<em class="parameter"><code>minsize</code></em> = <em class="parameter"><code>dline->res</code></em>/2 to perform one step of decomposition
or <em class="parameter"><code>minsize</code></em> = 4 to perform full decomposition (or anything between).
</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>dline</code></em> :</span></p></td>
<td>Data line to be transformed, it must have at least four samples.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wt_coefs</code></em> :</span></p></td>
<td>Data line where the wavelet transform coefficients are stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>Transform direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minsize</code></em> :</span></p></td>
<td>size of minimal transform result block</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-xdwt"></a><h3>gwy_data_field_xdwt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_xdwt (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);</pre>
<p>
Performs steps of the X-direction image wavelet decomposition.
</p>
<p>
The smallest low pass coefficients block is equal to <em class="parameter"><code>minsize</code></em>. Run with
<em class="parameter"><code>minsize</code></em> = <em class="parameter"><code>dfield->xres</code></em>/2 to perform one step of decomposition
or <em class="parameter"><code>minsize</code></em> = 4 to perform full decomposition (or anything between).
</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>dfield</code></em> :</span></p></td>
<td>Data field to be transformed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wt_coefs</code></em> :</span></p></td>
<td>Data line where the wavelet transform coefficients are stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>Transform direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minsize</code></em> :</span></p></td>
<td>size of minimal transform result block</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-ydwt"></a><h3>gwy_data_field_ydwt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_ydwt (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);</pre>
<p>
Performs steps of the Y-direction image wavelet decomposition.
</p>
<p>
The smallest low pass coefficients block is equal to <em class="parameter"><code>minsize</code></em>. Run with
<em class="parameter"><code>minsize</code></em> = <em class="parameter"><code>dfield->yres</code></em>/2 to perform one step of decomposition
or <em class="parameter"><code>minsize</code></em> = 4 to perform full decomposition (or anything between).
</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>dfield</code></em> :</span></p></td>
<td>Data field to be transformed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wt_coefs</code></em> :</span></p></td>
<td>Data line where the wavelet transform coefficients are stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>Transform direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minsize</code></em> :</span></p></td>
<td>size of minimal transform result block</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-dwt"></a><h3>gwy_data_field_dwt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_dwt (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyTransformDirection" title="enum GwyTransformDirection"><span class="type">GwyTransformDirection</span></a> direction</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> minsize</code></em>);</pre>
<p>
Performs steps of the 2D image wavelet decomposition.
</p>
<p>
The smallest low pass coefficients block is equal to <em class="parameter"><code>minsize</code></em>. Run with
<em class="parameter"><code>minsize</code></em> = <em class="parameter"><code>dfield->xres</code></em>/2 to perform one step of decomposition
or <em class="parameter"><code>minsize</code></em> = 4 to perform full decomposition (or anything between).
</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>dfield</code></em> :</span></p></td>
<td>Data field to be transformed (must be square).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wt_coefs</code></em> :</span></p></td>
<td>Data line where the wavelet transform coefficients are stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>Transform direction.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minsize</code></em> :</span></p></td>
<td>size of minimal transform result block</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-dwt-mark-anisotropy"></a><h3>gwy_data_field_dwt_mark_anisotropy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_dwt_mark_anisotropy (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *dfield</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *mask</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *wt_coefs</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> ratio</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> lowlimit</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|