diff options
| author | Abhinav Dronamraju | 2017-11-30 12:11:52 +0530 |
|---|---|---|
| committer | Abhinav Dronamraju | 2017-11-30 12:11:52 +0530 |
| commit | 61f5e86e353f1332928e716cf9c730b4c5ec357d (patch) | |
| tree | bfb2e64ccc143e3affaa88fea05c72fa1207ab10 /help/en_US/fftn.xml | |
| parent | 78b93a6cdf04aa8c861d4580eec8e4839bb8a255 (diff) | |
| parent | 8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36 (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-61f5e86e353f1332928e716cf9c730b4c5ec357d.tar.gz FOSSEE-Signal-Processing-Toolbox-61f5e86e353f1332928e716cf9c730b4c5ec357d.tar.bz2 FOSSEE-Signal-Processing-Toolbox-61f5e86e353f1332928e716cf9c730b4c5ec357d.zip | |
Merged with master upstream
Diffstat (limited to 'help/en_US/fftn.xml')
| -rw-r--r-- | help/en_US/fftn.xml | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/help/en_US/fftn.xml b/help/en_US/fftn.xml new file mode 100644 index 0000000..26c56c8 --- /dev/null +++ b/help/en_US/fftn.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fftn.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fftn" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>fftn</refname> + <refpurpose>This function computes the N-dimensional discrete Fourier transform of A using a Fast Fourier Transform (FFT) algorithm.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + Y = fftn(A) + Y = fftn(A, size) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>A:</term> + <listitem><para> Matrix</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This function computes the N-dimensional discrete Fourier transform of A using a Fast Fourier Transform (FFT) algorithm. The optional vector argument SIZE may be used specify the dimensions of the array to be used. If an element of SIZE is smaller than the corresponding dimension of A, then the dimension of A is truncated prior to performing the FFT. Otherwise, if an element of SIZE is larger than the corresponding dimension then A is resized and padded with zeros. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fftn([2,3,4]) +ans = +9. - 1.5 + 0.8660254i - 1.5 - 0.8660254i + ]]></programlisting> +</refsection> +</refentry> |