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

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

<refentry version="5.0-subset Scilab" xml:id="tfrqview" 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:db="http://docbook.org/ns/docbook">

  <info>
    <pubdate>$LastChangedDate: 20-August-2010 $</pubdate>
  </info>

  <refnamediv>
    <refname>tfrqview</refname><refpurpose>Quick visualization of time-frequency representations.</refpurpose>
  </refnamediv>



<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   tfrqview(TFR,SIG,T,METHOD,P1,P2,P3,P4,P5)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>TFR     :</term>
      <listitem><para> time-frequency representation (MxN).</para></listitem></varlistentry>
   <varlistentry><term>SIG     :</term>
      <listitem><para> signal in time. If unavailable, put sig=[] as input parameter. (default : []).</para></listitem></varlistentry>
   <varlistentry><term>T       :</term>
      <listitem><para> time instants                 (default : 1:N).</para></listitem></varlistentry>
   <varlistentry><term>METHOD  :</term>
      <listitem><para> name of chosen representation (default : 'TYPE1').</para></listitem></varlistentry>
   <varlistentry><term>tfr*  :</term>
      <listitem><para>  See the help for authorized names.</para></listitem></varlistentry>
   <varlistentry><term>TYPE1 :</term>
      <listitem><para> the representation TFR goes in normalized frequency from -0.5 to 0.5 ;</para></listitem></varlistentry>
   <varlistentry><term>TYPE2 :</term>
      <listitem><para> the representation TFR goes in normalized frequency from 0 to 0.5.</para></listitem></varlistentry>
   <varlistentry><term>P1...P5 :</term>
      <listitem><para> optional parameters of the representation : run the file TFRPARAM(METHOD) to know the meaning of P1..P5 for your method.</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
tfrqview allows a quick visualization of a time-frequency representation.
	When you use the 'save' option in the main menu, you save all your
	variables as well as two strings, TfrQView and TfrView, in a mat
	file. If you load this file and do eval(TfrQView), you will restart
	the display session under tfrqview ; if you do eval(TfrView), you
	will obtain the exact layout of the screen you had when clicking on
	the 'save' button.
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sig=fmsin(128); tfr=tfrwv(sig);
tfrqview(tfr,sig,1:128,'tfrwv');
   ]]></programlisting>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="tfrview">tfrview</link></member>
   <member><link linkend="tfrsave">tfrsave</link></member>
   <member><link linkend="tfrparam">tfrparam</link></member>
   </simplelist>
</refsection>

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