<?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  terms of the GNU General Public License 
as published by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

Copyright (c) 1996 by CNRS (France).
-->



<refentry xml:id="tfrrpwv" 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>tfrrpwv</refname><refpurpose>Reassigned  pseudo Wigner-Ville distribution.</refpurpose>
  </refnamediv>



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

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

   <varlistentry>
     <term> T:</term> 
     <listitem>
       <para> a real Nt vector with elements regularly spaced 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> real vector with odd length: the frequency smoothing
       window,(default: window("hm",N/4)).</para>
       <para>It will be normalized such as the middle point equals 1
       to preserve signal energy.</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 real N by Nt array: the time-frequency representation.</para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term> RTFR :</term> 
     <listitem>
       <para> A real N by Nt array: the reassigned time-frequency representation.</para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term> HAT :</term> 
     <listitem>
       <para>AN by Nt complex matrix of the reassignment vectors.</para>
     </listitem>
   </varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
	tfrrpwv computes the pseudo Wigner-Ville distribution
	and its reassigned version.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sig=fmlin(128,0.1,0.4); t=1:2:128;
h=tftb_window("kr",17,3*%pi); tfrrpwv(sig,t,64,h,1,'plot');
   ]]></programlisting>
</refsection>

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