<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mfft">
- <refnamediv>
- <refname>mfft</refname>
- <refpurpose> multi-dimensional fft</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <title>Calling Sequence</title>
- <synopsis>[xk]=mfft(x,flag,dim)</synopsis>
- </refsynopsisdiv>
- <refsection>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term>x</term>
- <listitem>
- <para>
- <literal>x(i,j,k,...)</literal> input signal in the form of a row vector whose values are arranged so that the i index runs the quickest, followed by the j index, etc.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>flag</term>
- <listitem>
- <para>(-1) FFT or (1) inverse FFT</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>dim</term>
- <listitem>
- <para>
- dimension vector which gives the number of values of <literal>x</literal> for each of its indices
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>xk</term>
- <listitem>
- <para>
- output of multidimensional fft in same format as for <literal>x</literal>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsection>
- <refsection>
- <title>Description</title>
- <para>
- FFT for a multi-dimensional signal
- </para>
- <para>
- For example for a three dimensional vector which has three points
- along its first dimension, two points along its second
- dimension and three points along its third dimension the row
- vector is arranged as follows
- </para>
- <programlisting role=""><![CDATA[
+ <refnamediv>
+ <refname>mfft</refname>
+ <refpurpose> multi-dimensional fft</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>[xk]=mfft(x,flag,dim)</synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Arguments</title>
+ <variablelist>
+ <varlistentry>
+ <term>x</term>
+ <listitem>
+ <para>
+ <literal>x(i,j,k,...)</literal> input signal in the form of a row vector whose values are arranged so that the i index runs the quickest, followed by the j index, etc.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>flag</term>
+ <listitem>
+ <para>(-1) FFT or (1) inverse FFT</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>dim</term>
+ <listitem>
+ <para>
+ dimension vector which gives the number of values of <literal>x</literal> for each of its indices
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>xk</term>
+ <listitem>
+ <para>
+ output of multidimensional fft in same format as for <literal>x</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Description</title>
+ <para>
+ FFT for a multi-dimensional signal
+ </para>
+ <para>
+ For example for a three dimensional vector which has three points
+ along its first dimension, two points along its second
+ dimension and three points along its third dimension the row
+ vector is arranged as follows
+ </para>
+ <programlisting role="no-scilab-exec"><![CDATA[
x=[x(1,1,1),x(2,1,1),x(3,1,1),
x(1,2,1),x(2,2,1),x(3,2,1),
x(1,1,2),x(2,1,2),x(3,1,2),
x(1,1,3),x(2,1,3),x(3,1,3),
x(1,2,3),x(2,2,3),x(3,2,3)]
]]></programlisting>
- <para>
- and the <literal>dim</literal> vector is: <literal>dim=[3,2,3]</literal>
- </para>
- </refsection>
+ <para>
+ and the <literal>dim</literal> vector is: <literal>dim=[3,2,3]</literal>
+ </para>
+ </refsection>
+ <refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+y1=matrix(1:6,2,3)
+y2=matrix(7:12,2,3)
+y=matrix([y1,y2],1,12)
+yf=mfft(y,-1,[2 3 2])
+ ]]></programlisting>
+ </refsection>
+
</refentry>