summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/fftw1.html
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/scilab_en_US_help/fftw1.html')
-rw-r--r--help/en_US/scilab_en_US_help/fftw1.html98
1 files changed, 0 insertions, 98 deletions
diff --git a/help/en_US/scilab_en_US_help/fftw1.html b/help/en_US/scilab_en_US_help/fftw1.html
deleted file mode 100644
index 4c3322c..0000000
--- a/help/en_US/scilab_en_US_help/fftw1.html
+++ /dev/null
@@ -1,98 +0,0 @@
-<html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <title>fftw1</title>
- <style type="text/css" media="all">
- @import url("scilab_code.css");
- @import url("xml_code.css");
- @import url("c_code.css");
- @import url("style.css");
- </style>
- </head>
- <body>
- <div class="manualnavbar">
- <table width="100%"><tr>
- <td width="30%">
- <span class="previous"><a href="fftshift1.html">&lt;&lt; fftshift1</a></span>
-
- </td>
- <td width="40%" class="center">
- <span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>
-
- </td>
- <td width="30%" class="next">
- <span class="next"><a href="fht.html">fht &gt;&gt;</a></span>
-
- </td>
- </tr></table>
- <hr />
- </div>
-
-
-
- <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a> &gt; fftw1</span>
-
- <br /><br />
- <div class="refnamediv"><h1 class="refname">fftw1</h1>
- <p class="refpurpose">Manage FFTW wisdom data.</p></div>
-
-
-<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
- <div class="synopsis"><pre><span class="default">method</span><span class="default"> = </span><span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">planner</span>&#0034;<span class="default">)</span>
-<span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">planner</span>&#0034;<span class="default">, </span><span class="default">method</span><span class="default">)</span>
-<span class="default">wisdom</span><span class="default"> = </span><span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">dwisdom</span>&#0034;<span class="default">)</span>
-<span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">dwisdom</span>&#0034;<span class="default">, </span><span class="default">wisdom</span><span class="default">)</span>
-<span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">threads</span>&#0034;<span class="default">, </span><span class="default">nthreads</span><span class="default">)</span>
-<span class="default">nthreads</span><span class="default"> = </span><span class="default">fftw</span><span class="default"> (</span>&#0034;<span class="default">threads</span>&#0034;<span class="default">)</span></pre></div></div>
-
-<div class="refsection"><h3 class="title">Parameters</h3>
- <dl></dl></div>
-
-<div class="refsection"><h3 class="title">Description</h3>
- <p class="para">This is an Octave function.
-Wisdom data can be used to significantly accelerate the calculation of the FFTs, but implies an initial cost in its calculation. When the FFTW libraries are initialized, they read a system wide wisdom
-file (typically in /etc/fftw/wisdom), allowing wisdom to be shared between applications other than Octave. Alternatively, the fftw function can be used to import wisdom. For example,</p>
- <p class="para">wisdom = fftw (&#0034;dwisdom&#0034;)
-will save the existing wisdom used by Octave to the string wisdom. This string can then be saved to a file and restored using the save and load commands respectively. This existing wisdom can be re
-imported as follows</p>
- <p class="para">fftw (&#0034;dwisdom&#0034;, wisdom)
-If wisdom is an empty string, then the wisdom used is cleared.</p>
- <p class="para">During the calculation of Fourier transforms further wisdom is generated. The fashion in which this wisdom is generated is also controlled by the fftw function. There are five different manners in which
-the wisdom can be treated:</p>
- <p class="para">&#0034;estimate&#0034;
-Specifies that no run-time measurement of the optimal means of calculating a particular is performed, and a simple heuristic is used to pick a (probably sub-optimal) plan. The advantage of this method
-is that there is little or no overhead in the generation of the plan, which is appropriate for a Fourier transform that will be calculated once.</p>
- <p class="para">&#0034;measure&#0034;
-In this case a range of algorithms to perform the transform is considered and the best is selected based on their execution time.</p>
- <p class="para">&#0034;patient&#0034;
-Similar to &#0034;measure&#0034;, but a wider range of algorithms is considered.</p>
- <p class="para">&#0034;exhaustive&#0034;
-Like &#0034;measure&#0034;, but all possible algorithms that may be used to treat the transform are considered.</p>
- <p class="para">&#0034;hybrid&#0034;
-As run-time measurement of the algorithm can be expensive, this is a compromise where &#0034;measure&#0034; is used for transforms up to the size of 8192 and beyond that the &#0034;estimate&#0034; method is used.</p>
- <p class="para">The default method is &#0034;estimate&#0034;. The current method can be queried with</p>
- <p class="para">method = fftw (&#0034;planner&#0034;)
-or set by using</p>
- <p class="para">fftw (&#0034;planner&#0034;, method)</p></div>
- <br />
-
- <div class="manualnavbar">
- <table width="100%">
- <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
-<tr>
- <td width="30%">
- <span class="previous"><a href="fftshift1.html">&lt;&lt; fftshift1</a></span>
-
- </td>
- <td width="40%" class="center">
- <span class="top"><a href="section_e54aa8aac34aa55341e8b4b782fe1a74.html">FOSSEE Signal Processing Toolbox</a></span>
-
- </td>
- <td width="30%" class="next">
- <span class="next"><a href="fht.html">fht &gt;&gt;</a></span>
-
- </td>
- </tr></table>
- <hr />
- </div>
- </body>
-</html>