<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the Scilab time frequency toolbox
This file must be used under the terms of the CeCILL.
This source file is licensed as described in the file COPYING, which
you should have received as part of this distribution.  The terms
are also available at
http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
-->

<refentry xml:id="tfrwv" 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>tfrwv</refname>
	<refpurpose>
		Wigner-Ville time-frequency distribution
	</refpurpose>
  </refnamediv>
 
<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   	[TFR,T,F] = tfrwv(X)
   	[TFR,T,F] = tfrwv(X, T)
   	[TFR,T,F] = tfrwv(X, T, N)
   	[TFR,T,F] = tfrwv(X, T, N, TRACE)
   	[TFR,T,F] = tfrwv(...,'plot')
   </synopsis>
</refsynopsisdiv>
<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry>
     <term>X :</term>
     <listitem>
       <para> A Nx elements vector (auto-WV)  or a Nx by 2 array signal (cross-WV).</para>
     </listitem>
   </varlistentry>

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

   <varlistentry>
     <term> N:</term> 
     <listitem><para> a positive integer: the number of frequency bins (default:NX).</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 one input parameter 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 real 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>Description</title>
   <para>
tfrwv computes the Wigner-Ville distribution of a discrete-time signal
 or the cross Wigner-Ville representation between two signals.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
   sig = fmlin(128,0.1,0.4); 
   [TFR,T,F] = tfrwv(sig);
   clf; gcf().color_map = jetcolormap(128);
   Sgrayplot(T,F(1:$/2),TFR(1:$/2,:)');
   ]]></programlisting>
  <scilab:image><![CDATA[
   sig = fmlin(128,0.1,0.4); 
   [TFR,T,F] = tfrwv(sig);
   clf; gcf().color_map = jetcolormap(128);
   Sgrayplot(T,F(1:$/2),TFR(1:$/2,:)');
    ]]></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>
