/usr/share/doc/libcpl-doc/html/group__cpl__fft.html is in libcpl-doc 7.0-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>Common Pipeline Library Reference Manual: FFTW wrappers</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="cpl.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Common Pipeline Library Reference Manual
 <span id="projectnumber">7.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">FFTW wrappers</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0e8af79ab4043e2c155fabee69638642"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__cpl__fft.html#gaf4977fcc075d168e548ce14f74f360c7">_cpl_fft_mode_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a></td></tr>
<tr class="memdesc:ga0e8af79ab4043e2c155fabee69638642"><td class="mdescLeft"> </td><td class="mdescRight">The CPL fft mode. <a href="#ga0e8af79ab4043e2c155fabee69638642">More...</a><br /></td></tr>
<tr class="separator:ga0e8af79ab4043e2c155fabee69638642"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaf4977fcc075d168e548ce14f74f360c7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__fft.html#gaf4977fcc075d168e548ce14f74f360c7">_cpl_fft_mode_</a> { <br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7af1568ab43143f7d60907368c845a5743">CPL_FFT_FORWARD</a>,
<br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7ae9f1621be882a15f5663c57a44b21c32">CPL_FFT_BACKWARD</a>,
<br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7ae9ba450ed521d17e987952497be5bfa5">CPL_FFT_NOSCALE</a>,
<br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7a3dc5402998de2916ca15ae6cc356a474">CPL_FFT_FIND_MEASURE</a>,
<br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7a6088b3d08d6496386d13b4a581155129">CPL_FFT_FIND_PATIENT</a>,
<br />
  <a class="el" href="group__cpl__fft.html#ggaf4977fcc075d168e548ce14f74f360c7a46e7f1204ffa084f8fb4944e9200cf3f">CPL_FFT_FIND_EXHAUSTIVE</a>
<br />
}<tr class="memdesc:gaf4977fcc075d168e548ce14f74f360c7"><td class="mdescLeft"> </td><td class="mdescRight">The supported values of the CPL fft mode. <a href="group__cpl__fft.html#gaf4977fcc075d168e548ce14f74f360c7">More...</a><br /></td></tr>
<tr class="separator:gaf4977fcc075d168e548ce14f74f360c7"><td class="memSeparator" colspan="2"> </td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3ffe0771d5a27f8ca1e719d634ae2529"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__fft.html#ga3ffe0771d5a27f8ca1e719d634ae2529">cpl_fft_image</a> (cpl_image *self, const cpl_image *other, <a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a> mode)</td></tr>
<tr class="memdesc:ga3ffe0771d5a27f8ca1e719d634ae2529"><td class="mdescLeft"> </td><td class="mdescRight">Perform a FFT operation on an image. <a href="#ga3ffe0771d5a27f8ca1e719d634ae2529">More...</a><br /></td></tr>
<tr class="separator:ga3ffe0771d5a27f8ca1e719d634ae2529"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9069809ff245c2d02acdae6991129cab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__fft.html#ga9069809ff245c2d02acdae6991129cab">cpl_fft_imagelist</a> (cpl_imagelist *self, const cpl_imagelist *other, <a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a> mode)</td></tr>
<tr class="memdesc:ga9069809ff245c2d02acdae6991129cab"><td class="mdescLeft"> </td><td class="mdescRight">Perform a FFT operation on the images in an imagelist. <a href="#ga9069809ff245c2d02acdae6991129cab">More...</a><br /></td></tr>
<tr class="separator:ga9069809ff245c2d02acdae6991129cab"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module provides FFTW wrappers</p>
<dl class="section user"><dt>Synopsis:</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include "cpl_fft.h"</span></div>
</div><!-- fragment --> </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga0e8af79ab4043e2c155fabee69638642"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__cpl__fft.html#gaf4977fcc075d168e548ce14f74f360c7">_cpl_fft_mode_</a> <a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The CPL fft mode. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaf4977fcc075d168e548ce14f74f360c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__cpl__fft.html#gaf4977fcc075d168e548ce14f74f360c7">_cpl_fft_mode_</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The supported values of the CPL fft mode. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7af1568ab43143f7d60907368c845a5743"></a>CPL_FFT_FORWARD </td><td class="fielddoc">
<p>The forward transform </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7ae9f1621be882a15f5663c57a44b21c32"></a>CPL_FFT_BACKWARD </td><td class="fielddoc">
<p>The backward transform </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7ae9ba450ed521d17e987952497be5bfa5"></a>CPL_FFT_NOSCALE </td><td class="fielddoc">
<p>Transform without scaling (has no effect on forward transform) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7a3dc5402998de2916ca15ae6cc356a474"></a>CPL_FFT_FIND_MEASURE </td><td class="fielddoc">
<p>Spend time finding the best transform </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7a6088b3d08d6496386d13b4a581155129"></a>CPL_FFT_FIND_PATIENT </td><td class="fielddoc">
<p>Spend more time finding the best transform </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf4977fcc075d168e548ce14f74f360c7a46e7f1204ffa084f8fb4944e9200cf3f"></a>CPL_FFT_FIND_EXHAUSTIVE </td><td class="fielddoc">
<p>Spend even more time finding the best transform </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3ffe0771d5a27f8ca1e719d634ae2529"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> cpl_fft_image </td>
<td>(</td>
<td class="paramtype">cpl_image * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const cpl_image * </td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform a FFT operation on an image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>Pre-allocated output image to transform to </td></tr>
<tr><td class="paramname">other</td><td>Input image to transform from, use self for in-place transform </td></tr>
<tr><td class="paramname">mode</td><td>CPL_FFT_FORWARD or CPL_FFT_BACKWARD, optionally CPL_FFT_NOSCALE </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CPL_ERROR_NONE or the corresponding <a class="el" href="group__cpl__error.html#ga49a0c316d52d2afbfd9fd94b95344900" title="Available error codes. ">_cpl_error_code_</a> on error</dd></dl>
<p>This function performs an FFT on an image, using FFTW. CPL may be configured without this library, in this case an otherwise valid call will set and return the error CPL_ERROR_UNSUPPORTED_MODE.</p>
<p>The input and output images must match in precision level. Integer images are not supported.</p>
<p>In a forward transform the input image may be non-complex. In this case a real-to-complex transform is performed. This will only compute the first ny/2 + 1 columns of the transform. In this transform it is allowed to pass an output image with ny/2 + 1 columns.</p>
<p>Similarly, in a backward transform the output image may be non-complex. In this case a complex-to-real transform is performed. This will only transform the first ny/2 + 1 columns of the input. In this transform it is allowed to pass an input image with ny/2 + 1 columns.</p>
<p>Per default the backward transform scales (divides) the result with the number of elements transformed (i.e. the number of pixels in the result image). This scaling can be turned off with CPL_FFT_NOSCALE.</p>
<p>If many transformations in the same direction are to be done on data of the same size and type, a reduction in the time required to perform the transformations can be achieved by adding the flag CPL_FFT_FIND_MEASURE to the first transformation. For a larger number of transformations a further reduction may be achived with the flag CPL_FFT_FIND_PATIENT and for an even larger number of transformations a further reduction may be achived with the flag CPL_FFT_FIND_EXHAUSTIVE.</p>
<p>If many transformations are to be done then a reduction in the time required to perform the transformations can be achieved by using <a class="el" href="group__cpl__fft.html#ga9069809ff245c2d02acdae6991129cab" title="Perform a FFT operation on the images in an imagelist. ">cpl_fft_imagelist()</a>.</p>
<p>Possible <a class="el" href="group__cpl__error.html#ga49a0c316d52d2afbfd9fd94b95344900" title="Available error codes. ">_cpl_error_code_</a> set in this function:</p><ul>
<li>CPL_ERROR_NULL_INPUT if an image is NULL</li>
<li>CPL_ERROR_ILLEGAL_INPUT if the mode is illegal</li>
<li>CPL_ERROR_INCOMPATIBLE_INPUT if the image sizes do not match</li>
<li>CPL_ERROR_TYPE_MISMATCH if the image types are incompatible with each other or with the transform</li>
<li>CPL_ERROR_UNSUPPORTED_MODE if FFTW has not been installed </li>
</ul>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a0239c1c63e9d21e98e45221a3ad60406">CPL_ERROR_NONE</a>.</p>
</div>
</div>
<a class="anchor" id="ga9069809ff245c2d02acdae6991129cab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> cpl_fft_imagelist </td>
<td>(</td>
<td class="paramtype">cpl_imagelist * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const cpl_imagelist * </td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__fft.html#ga0e8af79ab4043e2c155fabee69638642">cpl_fft_mode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform a FFT operation on the images in an imagelist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>Pre-allocated output imagelist to transform to </td></tr>
<tr><td class="paramname">other</td><td>Input imagelist to transform from </td></tr>
<tr><td class="paramname">mode</td><td>CPL_FFT_FORWARD or CPL_FFT_BACKWARD, optionally CPL_FFT_NOSCALE </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CPL_ERROR_NONE or the corresponding <a class="el" href="group__cpl__error.html#ga49a0c316d52d2afbfd9fd94b95344900" title="Available error codes. ">_cpl_error_code_</a> on error </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__cpl__fft.html#ga3ffe0771d5a27f8ca1e719d634ae2529" title="Perform a FFT operation on an image. ">cpl_fft_image()</a> </dd></dl>
<p>References <a class="el" href="group__cpl__error.html#gaf18e95fbc6fc2cfde2a2cc8a0920b12d">cpl_ensure_code</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a67b9f44eb1db1ab12f0575dbb878c0fd">CPL_ERROR_INCOMPATIBLE_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a0239c1c63e9d21e98e45221a3ad60406">CPL_ERROR_NONE</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__imagelist.html#ga5b5bd24a860e34bbfad8ba0af48a1cdf">cpl_imagelist_get()</a>, <a class="el" href="group__cpl__imagelist.html#ga54748d0bd9b59fed18bf798fd6d6c7dc">cpl_imagelist_get_const()</a>, and <a class="el" href="group__cpl__imagelist.html#ga004ae3644840b042152887fb93fdd0ed">cpl_imagelist_get_size()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
|