<?xml version="1.0" encoding="UTF-8"?>

<!--
 * 
 * This help file was generated from tfrstft.sci using help_from_sci().
 * 
 -->

<refentry xml:id="tfrstft" 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:scilab="http://www.scilab.org"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <refnamediv>
    <refname>tfrstft</refname><refpurpose>Short time Fourier transform.</refpurpose>
  </refnamediv>



<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   	[TFR,T,F]=tfrstft(X)
   	[TFR,T,F]=tfrstft(X,T)
   	[TFR,T,F]=tfrstft(X,T,N)
   	[TFR,T,F]=tfrstft(X,T,N,H
   	[TFR,T,F]=tfrstft(X,T,N,H,TRACE)
   	[TFR,T,F]=tfrstft(...,'plot')
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry>
     <term>X :</term>
     <listitem>
       <para> A Nx elements vector: the signal.</para>
     </listitem>
   </varlistentry>

   <varlistentry>
     <term> T:</term> 
     <listitem>
        <para>a real Nt vector with elements in [1 Nx] : time instant(s)
        (default: 1:NX).</para>
     </listitem>
   </varlistentry>

   <varlistentry>
     <term> N:</term> 
     <listitem><para> a positive integer: the number of frequency bins
     (default:NX). For faster computation N should be a power of
     2.</para>
   </listitem>
   </varlistentry>

   <varlistentry>
     <term> H:</term> 
     <listitem>
       <para> a real vector with odd length: the analysis window, H
       being normalized so as to be of unit energy.  (default :
       Hamming(N/4)).</para>
   </listitem>
   </varlistentry>

 <varlistentry>
     <term> TRACE :</term> 
     <listitem>
       <para> if nonzero,the progression of the algorithm is shown
       (default : 0).</para>
     </listitem>
   </varlistentry>

   <varlistentry>
     <term>'plot':</term> <listitem><para> if the last input parameter value is
     'plot', <link linkend="tfrqview">tfrqview</link> is called and
     the time-frequency representation will be plotted.</para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term> TFR :</term> 
     <listitem>
       <para> A complex N by Nt array: the time-frequency representation.</para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term> F :</term> 
     <listitem>
       <para> A N vector of normalized frequencies.</para>
     </listitem>
   </varlistentry>
   </variablelist>
</refsection>


<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sig=[fmconst(64,0.2);fmconst(64,0.4)]; 
tfr=tfrstft(sig);
clf;gcf().color_map= jetcolormap(128);
subplot(211); grayplot(1:128,1:128,abs(tfr)');
subplot(212); grayplot(1:128,1:128,atan(imag(tfr),real(tfr))');
   ]]></programlisting>
  <scilab:image><![CDATA[
sig=[fmconst(64,0.2);fmconst(64,0.4)]; 
tfr=tfrstft(sig);
clf;gcf().color_map= jetcolormap(128);
subplot(211); grayplot(1:128,1:128,abs(tfr)');
subplot(212); grayplot(1:128,1:128,atan(imag(tfr),real(tfr))');
    ]]></scilab:image>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt - Aug 2010</member>
   <member>	F. Auger, May-August 1994, July 1995.</member>
   <member>	Copyright (c) 1996 by CNRS (France).</member>
   </simplelist>
</refsection>
</refentry>
